Account Settings
Account Settings
Get Account Info
Rate limit: 5/sec/UID
Query account information, including user ID, inviter, parent account, channel, IP whitelist, permission type and permissions list.
Permission: No permission required
Get Account Info › Response Parameters
Successful response
codemsgrequestTimeuserIdUser ID
inviterIdInviter UID
parentIdParent account UID.
Only has a value when the calling account is a sub-account.
channelCodeChannel invitation code
channelChannel
ipsIP whitelist
permTypePermission type
read-only Read only
read-and-write Read and write
permissionsPermissions list
uta_mgt UTA management
uta_trade UTA trading
withdraw Withdrawal
copy_futures_position Futures copy trading position
copy_futures_order Futures copy trading order
regisTimeAccount registration time (Unix timestamp in milliseconds)
Get Account Setting
Rate limit: 20/sec/UID
Query account information, including the holding mode, margin mode, leverage multiple, and more.
Permission: UTA mgt. (read)
Get Account Setting › Response Parameters
Successful response
codemsgrequestTimeuidUID
accountModeAccount Mode
unified Unified Mode
hybrid Hybrid Mode
upgrading Unified Account Upgrading
switching Classic Account Switching
accountLevelAccount level
basic Basic mode
advanced Advanced mode
isolated Isolated margin mode
delta Delta-neutral mode
assetModeAsset mode
multi_assets Multi_assets mode
holdModeHolding mode
one_way_mode/hedge_mode
stpModeSTP Mode
none not setting STP
cancel_taker cancel taker order
cancel_maker cancel maker order
cancel_both cancel both of taker and maker orders
deltaSwitchDelta-neutral mode switch
no Delta-neutral mode disabled
yes Delta-neutral mode enabled
Symbol configuration list
Coin configuration list
Pre Set Leverage
Rate limit: 10/sec/UID
Preview the impact of adjusting the leverage of a specified symbol. This endpoint returns the estimated maximum tradable amount and required margin after the leverage change, without actually applying the change.
Permission: UTA mgt. (read)
Request Parameters
categoryProduct type
MARGIN Margin trading
USDT-FUTURES USDT futures
COIN-FUTURES Coin-M futures
USDC-FUTURES USDC futures
marginModePosition mode
isolated Isolated margin
cross Cross margin
symbolSymbol name
Required when changing the leverage of a futures symbol
coinCoin name
Required when changing the leverage for margin trading
leverageLeverage multiple
Applicable to cross margin mode
Applicable to isolated margin one-way position scenario
Applicable to isolated margin two-way position scenario when the same leverage is set for both directions
longLeverageLong position leverage
Only applicable when using isolated margin with two-way position mode and different leverage for each direction
In two-way position mode, if both leverage and longLeverage are passed, longLeverage takes effect and leverage is ignored
shortLeverageShort position leverage
Only applicable when using isolated margin with two-way position mode and different leverage for each direction
In two-way position mode, if both leverage and shortLeverage are passed, shortLeverage takes effect and leverage is ignored
Pre Set Leverage › Response Parameters
Successful response
codemsgrequestTimeestMaxOpenEstimated maximum tradable amount after adjustment
Returned for futures
estMaxBorrowableEstimated maximum borrowable amount after adjustment
Returned for margin trading; denominated in coin
requiredMarginRequired margin, denominated in USD
marginChangeMargin usage change after adjustment
A positive value means an increase, a negative value means a decrease
Set Leverage
Rate limit: 10/sec/UID
This endpoint allows you to set leverage.
Permission: UTA mgt. (read & write)
Set Leverage › Request Parameters
categoryProduct type
MARGIN Margin trading
USDT-FUTURES USDT futures
COIN-FUTURES Coin-M futures
USDC-FUTURES USDC futures
symbolSymbol name
This field is required to set leverage for futures
leverageLeverage multiple
coinCoin name
This field is required to set leverage for margin trading
posSidePosition side
long/short
This field is required to set leverage for isolated margin
marginModeMargin mode
crossed Cross margin
isolated Isolated margin
Defaults to cross margin if not specified. Only futures product lines support isolated margin leverage adjustment in this update.
longLeverageLong position leverage
Only applicable when using isolated margin with two-way position mode and different leverage for each direction.
In two-way position mode, if both leverage and longLeverage are passed, longLeverage takes effect and leverage is ignored.
shortLeverageShort position leverage
Only applicable when using isolated margin with two-way position mode and different leverage for each direction.
In two-way position mode, if both leverage and shortLeverage are passed, shortLeverage takes effect and leverage is ignored.
Set Leverage › Response Parameters
Successful response
codemsgrequestTimedataOperation result
Set Holding Mode
Rate limit: 10/sec/UID
This endpoint allows you to set the position holding mode between one-way and hedge mode.
Permission: UTA mgt. (read & write)
Set Holding Mode › Request Parameters
holdModeHolding mode
one_way_mode This mode allows holding positions in a single direction, either long or short, but not both at the same time
hedge_mode This mode allows holding both long and short positions simultaneously
Set Holding Mode › Response Parameters
Successful response
codemsgrequestTimedataOperation result
Switch Account
Rate limit: 1/sec/UID
- Only supports parent accounts.
- This endpoint is only used for switching to classic account mode.
- Please note that since the account switching process takes approximately 1 minute, the successful response you receive only indicates that the request has been received, and does not mean that the account has been successfully switched to the classic account.
- Please use the query switching status interface to confirm whether the account switching is successful.
Switch Account › Response Parameters
Successful response
codemsgrequestTimedataNo response data
Set Margin
Rate limit: 10/sec/UID
This endpoint allows you to adjust the margin for an isolated margin position.
Permission: UTA mgt. (read & write)
Set Margin › Request Parameters
categoryProduct type
USDT-FUTURES USDT futures
COIN-FUTURES Coin-M futures
USDC-FUTURES USDC futures
symbolSymbol name
posSidePosition side
long Long position
short Short position
operationOperation type
add Add margin
remove Remove margin
amountMargin adjustment amount, denominated in the margin currency
USDT-FUTURES: USDT; USDC-FUTURES: USDC; COIN-FUTURES: base currency
Set Margin › Response Parameters
Successful response
codemsgrequestTimedataOperation result
Get Delta Info
Rate limit: 20/sec/UID
Get delta-neutral mode information for the account, including the delta equity ratio and per-coin contract position ratios. This endpoint is only available when the account has the delta-neutral switch (deltaSwitch) enabled.
Permission: UTA mgt. (read)
Get Delta Info › Response Parameters
Successful response
codemsgrequestTimedeltaEquityRatio(Deprecated, no longer used as a hedge-eligibility criterion) Delta equity ratio (decimal form, e.g. 0.2 represents 20%).
≤ 20%: Account is in a neutral state. If positions also meet the hedge criteria, ADL ranking for contract positions is lower, reducing the risk of auto-deleveraging.
20%: Account is not in a neutral state; contract positions follow normal ADL ranking rules.
deltaThreshold(Deprecated, no longer used as a hedge-eligibility criterion) Delta equity ratio threshold. When both deltaThreshold and positionThreshold are below their respective thresholds, the account is eligible for the ADL priority queue; otherwise it remains in the normal queue.
positionThresholdCoin net position ratio threshold.
Coin position list.
Adjust Account Mode
Rate limit: 1/sec/UID
This endpoint supports the following account-mode switching scenarios. It supports switching between Basic Mode and Advanced Mode under the Unified Account:
- The master account switches its own mode
- A sub-account switches its own mode
- The master account switches the mode for its sub-account(s)
Adjust Account Mode › Request Parameters
modeAccount mode
basic Basic mode
advanced Advanced mode
delta Delta-neutral mode (deprecated, use advanced mode with deltaSwitch instead)
isolated Isolated margin mode
deltaSwitchDelta-neutral switch, only effective when mode is advanced
yes Enable
no Disable
targetUidTarget account UID.
If not provided, it defaults to the currently operated account.
If a sub-account UID is provided, it indicates the master account is operating on the sub-account.
Adjust Account Mode › Response Parameters
Successful response
codemsgrequestTimedataNo response data