Assets & Balance
Assets & Balance
Get Account Assets
Rate limit: 20/sec/UID
Permission: UTA mgt. (read)
Query account information and assets, with only non-zero balances being returned.
Get Account Assets › Response Parameters
Successful response
codemsgrequestTimeaccountEquityAccount equity (USD)
usdtEquityAccount equity (USDT)
btcEquityAccount equity (BTC)
unrealisedPnlUnrealised profit and loss (USD)
usdtUnrealisedPnlUnrealised profit and loss (USDT)
btcUnrealizedPnlUnrealised profit and loss (BTC)
effEquityEffective equity (USD) The net value available for margin in spot and perpetual trades under cross-margin mode, converted to fiat
mmrMaintenance margin (USD) The minimum margin required to maintain the position, converted to fiat
imrInitial margin (USD) Total initial margin of assets in base coin, converted to fiat
mgnRatioMargin ratio
positionMgnRatioPosition MMR
positionValuePosition value (USD)
leverageAccount leverage Non-negative number
Asset list
Get Account Funding Assets
Rate limit: 20/sec/UID
Permission: UTA mgt. (read)
Obtain fund account information and only return the coins with assets.
Note: For Pre-IPO tokens, the coin field uses mixed case, e.g., preSPAX. Please be mindful of case sensitivity. The exact coin value is subject to what is returned by the Get Coin Info API.
Request Parameters
coinCoin name
Get Account Funding Assets › Response Parameters
Successful response
codemsgrequestTimecoinCoin name
balanceBalance Unit: the current asset coin
availableAvailable Unit: the current asset coin
frozenFrozen Unit: the current asset coin
Get Financial Records
Rate limit: 20/sec/UID
Permission: UTA mgt. (read)
Query financial records within the last 90 days.
Request Parameters
categoryProduct type
SPOT Spot trading
MARGIN Margin trading
USDT-FUTURES USDT futures
COIN-FUTURES Coin-M futures
USDC-FUTURES USDC futures
OTHER Other
coinCoin name
e.g.,BTC
typeType
TRANSFER_IN/TRANSFER_OUT......
All enumeration values can be viewed under the Enumeration category.
startTimeStart timestamp
A Unix timestamp in milliseconds e.g.,1597026383085
The access window is 90 days
endTimeEnd timestamp
A Unix timestamp in milliseconds e.g.,1597026383185
The time range between startTime and endTime must not exceed 30 days
limitLimit per page
Default:100. Maximum:100
cursorCursor Pagination is implemented by omitting the cursor in the first query and applying the cursor from the previous query for subsequent pages
Get Financial Records › Response Parameters
Successful response
codemsgrequestTimeList
cursorCursor
Get Funding Financial Records
Rate limit: 10/sec/UID
Permission: UTA mgt. (read)
Query funding account financial records within the last 90 days.
Request Parameters
coinCoin name
e.g.,BTC
typeTypeTRANSFER_IN/TRANSFER_OUT......
All enumeration values can be viewed under the Enumeration category.
startTimeStart timestamp
A Unix timestamp in milliseconds e.g.,1597026383085
The access window is 90 days
endTimeEnd timestamp
A Unix timestamp in milliseconds e.g.,1597026383085
The time range between startTime and endTime must not exceed 30 days
limitLimit per page
Default:100. Maximum:100
cursorCursor
Pagination is implemented by omitting the cursor in the first query and applying the cursor from the previous query for subsequent pages
Get Funding Financial Records › Response Parameters
Successful response
codemsgrequestTimeList
cursorCursor
Get Account Fee Rate
Rate limit: 3/sec/UID
Unified account management read permissions are required
Get Account Fee Rate
Request Parameters
symbolSymbol
e.g.,BTCUSDT
categoryProduct type
SPOT Spot trading
MARGIN Margin trading
USDT-FUTURES USDT futures
COIN-FUTURES Coin-M futures
USDC-FUTURES USDC futures
Get Account Fee Rate › Response Parameters
Successful response
codemsgrequestTimemakerFeeRateMaker fee rate In decimal form, e.g., 0.0002 represents 0.02%
takerFeeRateTaker fee rate In decimal form, e.g., 0.0002 represents 0.02%
Get Max Transferable
Rate limit: 3/sec/UID
Permission: UTA mgt. (read)
Get the maximum transferable amount for the unified account.
Request Parameters
coinCoin name
Get Max Transferable › Response Parameters
Successful response
codemsgrequestTimecoinCoin name
maxTransferMaximum transferable amount Unit: coin.
borrowMaxTransferMaximum transferable amount for borrowed coins Unit: coin.
Get Max Withdrawal
Rate limit: 10/sec/UID
Permission: UTA mgt. (read)
Get the maximum withdrawable amount for the specified coin in the unified account. The amount is calculated in real time based on the account's available balance, open positions, liabilities, and other factors. This can be used to obtain the safe withdrawal limit before initiating a withdrawal to avoid failures due to exceeding the limit.
Note: The returned result is a real-time calculated value with millisecond-level latency. The platform will perform a secondary validation at the time of actual withdrawal; this interface result is for reference only.
Request Parameters
coinCoin name, e.g. USDT
Get Max Withdrawal › Response Parameters
Successful response
codemsgrequestTimecoinCoin name
otcMaxWithdrawalMax withdrawable amount for OTC account
spotMaxWithdrawalMax withdrawable amount for spot account
utaMaxWithdrawalMax withdrawable amount for unified trading account
totalMaxWithdrawalTotal max withdrawable amount
Set Collateral Type
Rate limit: 2/sec/UID
Permission: UTA mgt. (read & write)
Set the collateral type for the unified trading account.
Request Parameters
collateralTypeCollateral type
mainstream Mainstream coins
all All coins
custom Custom
collateralCoinsCollateral coin names
Multiple coins are supported, separated by commas
Required when collateralType=custom
Set Collateral Type › Response Parameters
Successful response
codemsgrequestTimedataOperation result
Get Collateral Type
Rate limit: 10/sec/UID
Permission: UTA mgt. (read)
Query the collateral type configuration of the unified trading account. Three collateral types are supported: mainstream, all, and custom. Under mainstream, USDT, USDC, BTC, DOGE, ETH, and SOL are supported as collateral. Under custom, users can specify the effective collateral coins themselves.
Get Collateral Type › Response Parameters
Successful response
codemsgrequestTimecollateralTypeCollateral type
mainstream Mainstream coins
all All coins
custom Custom
collateralCoinsCollateral coins
Returned only when collateralType=custom. Multiple coins are separated by commas
Get Custom Collateral Coins
Rate limit: 10/sec/IP
Query all coins supported as custom collateral on the platform. This is a public list that returns the full set of coins supported by the platform and is independent of any user-specific configuration.
Get Custom Collateral Coins › Response Parameters
Successful response
codemsgrequestTimecollateralCoinCollateral coin name