Broker
Broker
Create Broker Sub-Account
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
Create Broker Sub-Account › Request Parameters
subaccountNameSub-account username.
labellabel
up to a maximum of 50 characters.
Create Broker Sub-Account › Response Parameters
Successful response
codemsgrequestTimesubUidSub-account UID
subaccountNameSub-account username
subaccountEmailSub-account email
By default a system-generated virtual email; if an email has been bound separately, the bound email will be displayed
statusSub-account status
normal
freeze
permListPermission list
withdraw
transfer
spot_trade spot trading
contract_trade futures trading
margin_trade margin trading
deposit deposit permission
labelLabel
cTimeAccount creation time
Unix timestamp in milliseconds
Create Broker Sub-Account API Key
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
Create Broker Sub-Account API Key › Request Parameters
subUidSub-account UID
passphrasePassphrase
Required to call the API. If lost, please create a new API key.
labellabel
ipListIP whitelist
Up to 30 entries can be provided
permTypePermission type:
read_write read & write
read_only read-only
permListPermission list:
uta_trade UTA trading
uta_mgt UTA management
withdraw (permType must be read_write)
Create Broker Sub-Account API Key › Response Parameters
Successful response
codemsgrequestTimesubUidSub-account UID
labelLabel
apiKeyAPI Key
secretKeySecret Key
permTypePermission type:
read_write read & write
read_only read-only
permListPermission list:
uta_trade UTA trading
uta_mgt UTA management
withdraw (permType must be read_write)
ipListIP whitelist
Delete Broker Sub-Account API Key
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
-
This endpoint has no response parameters.
-
It returns the deletion result synchronously.
-
Determine whether the deletion succeeded or failed (and the failure reason) based on the returned
codeandmsg.
Delete Broker Sub-Account API Key › Request Parameters
subUidSub-account UID
apiKeyAPI Key
Delete Broker Sub-Account API Key › Response Parameters
Successful response
codeCode
msgMessage
requestTimeRequest Time
Get All Broker Sub-Account Deposit Withdrawal
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
Request Parameters
startTimeRecord start time
Unix timestamp in milliseconds. If both startTime and endTime are empty, the default query time range is yesterday 00:00–23:59 (UTC+0). The time range between startTime and endTime cannot exceed 7 days.
endTimeRecord end time
Unix timestamp in milliseconds. If both startTime and endTime are empty, the default query time range is yesterday 00:00–23:59 (UTC+0). The time range between startTime and endTime cannot exceed 7 days.
limitNumber of items per page
default 100, maximum 100.
cursorCursor ID.
statusStatus
pending Confirming
fail Failed
success Successful
Get All Broker Sub-Account Deposit Withdrawal › Response Parameters
Successful response
codemsgrequestTimeRecord list
uidSub-account UID
txIdDeposit/withdraw/transfer ID
coinCoin name
typeDeposit/withdraw type:
deposit deposit record
withdrawal withdrawal record
subTypeSub-type:
onchain on-chain deposit or regular withdrawal;
internal internal transfer;
fast fast deposit/withdraw (on-chain + internal address)
amountDeposit/withdraw amount
statusStatus
pending Confirming
fail Failed
success Successful
tsRecord update time
Unix timestamp in milliseconds
endIdCursor ID for next page (the smallest record ID in current page)
Get Broker Commission
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
Request Parameters
startTimeQuery start time
Unix timestamp in milliseconds. If both startTime and endTime are omitted, the default query range is yesterday 00:00–23:59 (UTC+0). The interval between startTime and endTime for a single query cannot exceed 30 days.
endTimeQuery end time
Unix timestamp in milliseconds. If both startTime and endTime are omitted, the default query range is yesterday 00:00–23:59 (UTC+0). The interval between startTime and endTime for a single query cannot exceed 30 days.
pageSizeNumber of items per page
default 100, maximum 1000
pageNoPage number
default 1.
bizTypeBusiness type
spot
futures
If not provided, commission data for all types will be returned.
subBizTypeBusiness sub-type:
spot_trade spot trading
spot_margin spot margin
usdt_futures USDT futures
usdc_futures USDC futures
coin_futures coin-margin futures
When bizType=spot, this parameter can be spot_trade or spot_margin. When bizType=futures, this parameter can be usdt_futures, usdc_futures, or coin_futures.
Get Broker Commission › Response Parameters
Successful response
codemsgrequestTimeuidUser ID
coinCommission currency
symbolSymbol
dealtAmountTraded amount
totalFeeTotal fee
deductedFeeDeducted fee
paidFeeFee paid
markUpFeeMarkup fee
totalCommissionTotal commission
Get Broker Sub-Account API Key
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
Request Parameters
subUidSub-account UID
Get Broker Sub-Account API Key › Response Parameters
Successful response
codemsgrequestTimesubUidSub-account UID
labelLabel
apiKeyAPI Key
secretKeySecret Key
permTypePermission type:
read_write read & write
read_only read-only
permListPermission list:
uta_trade UTA trading
uta_mgt UTA management
withdraw (permType must be read_write)
ipListIP whitelist
Get Broker Sub-Account List
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
Request Parameters
limitNumber of items per page
default 10, maximum 100.
cursorCursor ID
Used for pagination. Omit it on the first call. For subsequent calls, pass in the last subUid returned by the previous query.
statusAccount status:
normal normal
freeze frozen
Get Broker Sub-Account List › Response Parameters
Successful response
codemsgrequestTimeSub-account list
subUidSub-account UID
subaccountNameSub-account username
subaccountEmailSub-account email
statusSub-account status:
normal
freeze
permListPermission list
withdraw
transfer
spot_trade spot trading
contract_trade futures trading
margin_trade margin trading
deposit deposit permission
labelLabel
cTimeAccount creation time
Unix timestamp in milliseconds
uTimeAccount update time
Unix timestamp in milliseconds
languageSub-account language.
en_US
zh_CN
ja_JP
vi_VN
zh_TW
ru_RU
es_ES
tr_TR
fr_FR
de_DE
pt_PT
th_TH
Modify Broker Sub-Account API Key
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
Modify Broker Sub-Account API Key › Request Parameters
subUidSub-account UID
passphrasePassphrase
Required to call the API; if lost, please recreate the API key
apiKeyAPI Key
labellabel
ipListIP whitelist
Up to 30 entries
permTypePermission type:
read_write read & write
read_only read-only
permListPermission list:
uta_trade UTA trading
uta_mgt UTA management
withdraw (permType must be read_write)
Modify Broker Sub-Account API Key › Response Parameters
Successful response
codemsgrequestTimesubUidSub-account UID
labelLabel
apiKeyAPI Key
permTypePermission type:
read_write read & write
read_only read-only
permListPermission list:
uta_trade UTA trading
uta_mgt UTA management
withdraw (permType must be read_write)
ipListIP whitelist
Modify Broker Sub-Account
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
Modify Broker Sub-Account › Request Parameters
subUidSub-account UID
statusSub-account status:
normal
freeze
permListPermission list
withdraw
transfer
spot_trade spot trading
contract_trade futures trading
margin_trade margin trading
deposit deposit permission
Modify Broker Sub-Account › Response Parameters
Successful response
codemsgrequestTimesubUidSub-account UID
statusSub-account status:
normal
freeze
subaccountNameSub-account username
labelLabel
permListPermission list
withdraw
transfer
spot_trade spot trading
contract_trade futures trading
margin_trade margin trading
deposit deposit permission
cTimeAccount creation time
Unix timestamp in milliseconds
uTimeAccount update time
Unix timestamp in milliseconds
languageSub-account language.
en_US
zh_CN
ja_JP
vi_VN
zh_TW
ru_RU
es_ES
tr_TR
fr_FR
de_DE
pt_PT
th_TH
Get Broker Sub-Account Deposit Address
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
Get Broker Sub-Account Deposit Address › Request Parameters
subUidSub-account UID
coinCoin name
chainChain name
If this parameter is not provided, the default will be the coin's primary (main) chain
Get Broker Sub-Account Deposit Address › Response Parameters
Successful response
codemsgrequestTimesubUidSub-account UID
coinCoin name
chainChain name
addressDeposit address
tagTag
Used for some chains (e.g., EOS memo, TON comment)
urlCustom order ID
cTimeCreation time
Broker Sub-Account Withdrawal
Rate limit: 20/sec/UID
Only the master account with a user type of ND Broker can call this API endpoint.
Broker sub-account withdrawal API has restrictions and currently supports only the following currencies:
BTC, ETH, USDT, USDC, TRX, XRP, LTC, SOL, BNB, FTM, DOGE, ADA, SHIB, UNI, SEI, SUI, POL, FIL, LINK, GRAM, ARB, OP, DOT, AVAX, BGB
Broker Sub-Account Withdrawal › Request Parameters
subUidSub-account UID
coinCoin name
destWithdrawal method:
on_chain on-chain withdrawal
internal_transfer internal transfer
addressWithdrawal address
When using on-chain withdrawal, enter the on-chain address; when using internal transfer, enter the UID
amountWithdrawal amount
chainChain name
If this parameter is not provided, it defaults to the coin's main chain
tagTag
Used for some chains (e.g., EOS memo, GRAM comment)
clientOidCustom order ID
Broker Sub-Account Withdrawal › Response Parameters
Successful response
codemsgrequestTimeorderIdOrder ID
clientOidCustom order ID
Modify Subaccount Email
Rate limit: 10/sec/UID
Modify the email bound to a sub-account.
Modify Subaccount Email › Request Parameters
subUidSubaccount user id
subaccountEmailSubaccount email
Modify Subaccount Email › Response Parameters
Successful response
codemsgrequestTimedataGet Subaccount Email
Rate limit: 10/sec/UID
Get subaccount email
Request Parameters
subUidSubaccount user id
Get Subaccount Email › Response Parameters
Successful response
codemsgrequestTimesubUidSubaccount user id
subaccountNameUsername in email format generated by subaccountName as the prefix
subaccountEmailSubaccount email
cTimeCreation time
Unix millisecond timestamp, e.g. 1690196141868
uTimeUpdate time
Unix millisecond timestamp, e.g. 1690196141868
Get Broker Trade Volume
Rate limit: 5/sec/UID
Please contact your BD or RM to apply for access permissions
Request Parameters
startTimeStart timestamp, milliseconds. If both start and end time are empty, the default time is yesterday 00:00-23:59 (UTC+0). StartTime and endTime can only be filled in at the same time or not. If it exceeds 30 days, an error will be reported.
endTimeEnd timestamp, milliseconds. If both start and end time are empty, the default time is yesterday 00:00-23:59 (UTC+0). StartTime and endTime can only be filled in at the same time or not. If it exceeds 30 days, an error will be reported.
pageSizeNumber of items per page, default is 100, maximum is 1000, if more than 1000 items are returned, 100 items will be returned by default
pageNoPagination page number, default is 1
Get Broker Trade Volume › Response Parameters
Successful response
codemsgrequestTimeuidUser ID
volumeTransaction amount, with 8 digits of precision
spotVolumeSpot transaction amount, with 8-digit precision
futureVolumeContract transaction amount, with 8-digit precision
Get Total Commission
Rate limit: 20/sec/UID
Data retention: 365 days
Historical data available from: 2025/6/1
Data granularity: daily
Data update granularity: daily, previous day’s data is updated on the current day
Time zone: UTC+8
startTime and endTime should either both be set or both left unset
This API supports retrieving data within the past 365 days (data is available starting from 2025/6/1 at the earliest)
If startTime and endTime are not set in the request, the default returned information will be for yesterday (00:00-23:
59 UTC+8)
Data update frequency: T+1 (UTC+8)
Request Parameters
startTimeStart timestamp in milliseconds. If both startTime and endTime are empty, the default time range is yesterday 00:00–23:59 (UTC+8). startTime and endTime must either both be set or both left unset. An error will be returned if the range exceeds 180 days.
endTimeEnd timestamp in milliseconds. If both startTime and endTime are empty, the default time range is yesterday 00:00–23:59 (UTC+8). startTime and endTime must either both be set or both left unset. An error will be returned if the range exceeds 180 days.
Get Total Commission › Response Parameters
Successful response
codemsgrequestTimedateCommission date
totalTradingVolumeBroker’s total trading volume for the day
totalActiveTradersNumber of active traders for the broker that day
totalCommissionTotal commission earned by the broker (USDT)
Spot data
spotTradingVolumeSpot trading volume (USDT)
spotTradingFeeActual spot trading fee collected (USDT)
spotPureTradingFeeNet spot trading fee (USDT) (after deducting negative maker, etc.; used as the base for commission calculation)
spotCommissionSpot commission (USDT)
Futures data
futuresTradingVolumeFutures trading volume (USDT)
futuresTradingFeeActual futures trading fee collected (USDT)
futuresPureTradingFeeNet futures trading fee (USDT) (after deducting negative maker, etc.; used as the base for commission calculation)
futuresCommissionFutures commission (USDT)
Get Order Commission
Rate limit: 20/sec/UID
Data storage: 30 days
Historical data backtracking: 2025/9/1
Data granularity: daily
Data update frequency: daily, previous day's data is updated on the current day
Time zone: UTC+8
startTime and endTime should either both be set or both not set
The maximum time span supported for startTime and endTime is 30 days
This API supports retrieving data within the past 30 days
If startTime and endTime are not set in the request, the default return will be information for yesterday (00:00-23:59
UTC+8)
This API data is updated on a T+1 basis
Transaction details only show those marked with broker channel id
Request Parameters
startTimeStart timestamp in milliseconds. If both startTime and endTime are empty, the default time range is yesterday 00:00–23:59 (UTC+8). startTime and endTime must either both be filled or both be empty. An error will be returned if the range exceeds 180 days.
endTimeEnd timestamp in milliseconds. If both startTime and endTime are empty, the default time range is yesterday 00:00–23:59 (UTC+8). startTime and endTime must either both be filled or both be empty. An error will be returned if the range exceeds 180 days.
limitPagination limit. Maximum: 500, Default: 500
uidUID
orderidOrder ID
idLessThanCursor ID for pagination. Do not pass this parameter for the first request; for subsequent requests, use the endId value from the previous response to paginate.
Get Order Commission › Response Parameters
Successful response
codemsgrequestTimeRebate (commission) list
fillIdFill ID
orderIdOrder ID
tsFill timestamp
clientOidCustom order ID
bizTypeTransaction type
spotSpot
futuresFutures
subBizTypeSub-transaction type
spot_tradeSpot trading
spot_marginSpot margin
usdt_futuresusdt futures
coin_futurescoin futures
usdc_futuresusdc futures
symbolSymbol
volumeTrade amount
unit: USDT, with full precision
feeTotal fee
unit: USDT, with full precision
pureFeeNet fee
unit: USDT, with full precision
rebateAmountBroker commission
unit: USDT, with full precision
endIdCursor ID
Get Rebate Info
Rate limit: 20/sec/UID
Data retention: 30 days
Real-time data
Request Parameters
uidUID
Get Rebate Info › Response Parameters
Successful response
codemsgrequestTimeaffiliationTypeType of rebate relationship
affiliateClient channel
official Official (website) channel
userLevelUser level
VIP0
VIP1
...
VIP7
PRO1
...
PRO6
clientSpotRebateRatioSpot trading rebate ratio available to the user
clientFuturesRebateRatioFutures trading rebate ratio available to the user
