Futures Trader (Public/Private)
Futures Trader (Public/Private)
Get Position Summary
Rate limit: 5/sec/UID
Permission: Unified Account — Futures Copy-Trading Positions — Read-only
Get position summary
Get Position Summary › Response Parameters
Successful response
codemsgrequestTimeunrealizedPnlUnrealized PnL
unit: USDT
realizedPnlRealized PnL
unit: USDT
holdSizePosition size
avgPriceAverage entry price
symbolSymbol name
leverageLeverage multiplier
positive integer
marginModeMargin mode:
isolated isolated
cross cross
liqPriceLiquidation price
marginMargin
holdSidePosition side:
long long
short short
roiReturn on investment (ROI)
markPriceMark price
positionValuePosition value
unit: USDT
Get Trading Pairs
Rate limit: 5/sec/UID
Permission: Unified Account — Futures Copy-Trading Orders — Read-only
Get copy-trading symbol
Get Trading Pairs › Response Parameters
Successful response
codemsgrequestTimesymbolSymbol name
leverageLeverage multiplier
Margin details list
marginCoinMargin currency
e.g., USDT
maxLongCountMaximum long position size
remainingLongCountRemaining long position size
maxShortCountMaximum short position size
remainingShortCountRemaining short position size
Get Max Transferable
Rate limit: 1/sec/UID
Permission: Unified Account — Futures Copy-Trading Orders — Read-only
Get the maximum transferable amount and available balance for a copy-trading lead account.
Request Parameters
coinCoin name, e.g. USDT
Get Max Transferable › Response Parameters
Successful response
codemsgrequestTimemaxTransferableMaximum transferable amount
availableAvailable balance
Transfer
Rate limit: 1/sec/UID
Permission: Unified Account — Futures Copy-Trading Orders — Read-write
Transfer funds into or out of a copy-trading lead account. Only transfers between the spot/funding account and the lead account are supported.
Transfer › Request Parameters
typeTransfer direction
in Transfer in (spot/funding account -> lead account)
out Transfer out (lead account -> spot/funding account)
coinTransfer coin
amountTransfer amount
inAccountTypeSource account type for transfer-in. Multiple types supported, separated by commas (,).
funding Spot/funding account
uta Unified account
otc OTC account
If not specified, all account types are selected by default.
Deduction order: funding account -> OTC account -> unified account.
Classic account mode only supports funding (spot account) as the source.
Transfer › Response Parameters
Successful response
codemsgrequestTimetransferIdTransfer ID
Get Transfer Record
Rate limit: 1/sec/UID
Permission: Unified Account — Futures Copy-Trading Orders — Read-only
Query transfer history for a copy-trading lead account.
Request Parameters
startTimeStart timestamp (Unix ms, e.g. 1597026383085)
endTimeEnd timestamp (Unix ms, e.g. 1597026383085)
limitNumber of results. Default: 20, max: 100
cursorCursor ID. Pass the nextCursor returned from the previous call to paginate forward (newer records).
Get Transfer Record › Response Parameters
Successful response
codemsgrequestTimeTransfer record list
transferIdTransfer order ID
fromTypeSource account type. Multiple values may be returned, separated by commas.
spot Spot/funding account
uta Unified account
otc OTC account
lead Lead account
toTypeDestination account type. Multiple values may be returned, separated by commas.
spot Spot/funding account
uta Unified account
otc OTC account
lead Lead account
amountTransfer amount
coinTransfer coin
statusTransfer status
Successful Success
Failed Failed
Processing Processing
createdTimeTransfer creation time (Unix ms)
nextCursorNext page cursor
Get Current Followers
Rate limit: 1/sec/UID
Permission: Unified Account — Futures Copy-Trading Orders — Read-only
Get the list of current active followers for a copy-trading lead account.
Request Parameters
limitNumber of results. Default: 20, max: 100
cursorCursor ID. Pass the nextCursor returned from the previous call to paginate forward (newer records).
Get Current Followers › Response Parameters
Successful response
codemsgrequestTimeFollower list
followerNameFollower nickname
estimateAssetsEstimated asset value (USDT)
totalProfitTotal profit (USDT)
totalShareProfitTotal profit share (USDT)
totalInvestmentTotal investment (USDT)
canRemoveWhether the follower can be removed
yes Yes
no No
followDaysNumber of days following (positive integer)
totalAssetsAccount equity (USDT)
startTimeFollow start time (Unix ms)
nextCursorNext page cursor
Get History Followers
Rate limit: 1/sec/UID
Permission: Unified Account — Futures Copy-Trading Orders — Read-only
Get the list of historical followers for a copy-trading lead account.
Request Parameters
limitNumber of results. Default: 20, max: 100
cursorCursor ID. Pass the nextCursor returned from the previous call to paginate forward (newer records).
Get History Followers › Response Parameters
Successful response
codemsgrequestTimeHistorical follower list
followerNameFollower nickname
totalProfitTotal profit (USDT)
totalShareProfitTotal profit share (USDT)
totalInvestmentTotal investment (USDT)
startTimeFollow start time (Unix ms)
endTimeFollow end time (Unix ms)
nextCursorNext page cursor
Get Profit Summary
Rate limit: 1/sec/UID
Permission: Unified Account — Futures Copy-Trading Orders — Read-only
Get the profit-sharing summary for a copy-trading lead account.
Get Profit Summary › Response Parameters
Successful response
codemsgrequestTimetotalProfitCumulative profit (USDT)
totalAllocatedProfitCumulative allocated profit share (USDT)
totalPendingProfitCumulative pending profit share (USDT)
Get Profit Details
Rate limit: 1/sec/UID
Permission: Unified Account — Futures Copy-Trading Orders — Read-only
Get the profit-sharing detail records for a copy-trading lead account.
Request Parameters
startTimeStart timestamp (Unix ms, e.g. 1597026383085)
endTimeEnd timestamp (Unix ms, e.g. 1597026383085)
limitNumber of results. Default: 20, max: 100
cursorCursor ID. Pass the nextCursor returned from the previous call to paginate forward (newer records).
Get Profit Details › Response Parameters
Successful response
codemsgrequestTimeProfit detail list
followerNameFollower name
profitFollower's profit and loss
allocatedPnlAllocated profit and loss
pendingPnlPending profit and loss
shareRatioProfit-sharing ratio (decimal form)
shareProfitProfit-sharing amount
reasonReason
period Periodic settlement
unfollow Settlement upon unfollow
settleTimeSettlement time (Unix ms)
nextCursorCursor ID
Get Portfolio Overview
Rate limit: 1/sec/UID
Permission: Unified Account — Futures Copy-Trading Orders — Read-only
Get a portfolio overview of the lead trading project.
Request Parameters
period7D/30D/90D/180D
Get Portfolio Overview › Response Parameters
Successful response
codemsgrequestTimeprojectIdProject ID
assetAssets under management
roiReturn on investment
totalProfitTotal profit
followerProfitFollower profit
maxDrawdownMaximum drawdown