Each REST client is a JavaScript class, which provides functions individually mapped to each endpoint available in the exchange's API offering.
The following table shows all methods available in each REST client, whether the method requires authentication (automatically handled if API keys are provided), as well as the exact endpoint each method is connected to.
This can be used to easily find which method to call, once you have found which endpoint you're looking to use.
All REST clients are in the src folder. For usage examples, make sure to check the examples folder.
List of clients:
If anything is missing or wrong, please open an issue or let us know in our Node.js Traders telegram group!
Table consists of 4 parts:
- Function name
- AUTH
- HTTP Method
- Endpoint
Function name is the name of the function that can be called through the SDK. Check examples folder in the repo for more help on how to use them!
AUTH is a boolean value that indicates if the function requires authentication - which means you need to pass your API key and secret to the SDK.
HTTP Method shows HTTP method that the function uses to call the endpoint. Sometimes endpoints can have same URL, but different HTTP method so you can use this column to differentiate between them.
Endpoint is the URL that the function uses to call the endpoint. Best way to find exact function you need for the endpoint is to search for URL in this table and find corresponding function name.
This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in main-client.ts.
| Function | AUTH | HTTP Method | Endpoint |
|---|---|---|---|
| testConnectivity() | GET | api/v3/ping |
|
| getExchangeInfo() | GET | api/v3/exchangeInfo |
|
| getOrderBook() | GET | api/v3/depth |
|
| getRecentTrades() | GET | api/v3/trades |
|
| getHistoricalTrades() | GET | api/v3/historicalTrades |
|
| getAggregateTrades() | GET | api/v3/aggTrades |
|
| getKlines() | GET | api/v3/klines |
|
| getUIKlines() | GET | api/v3/uiKlines |
|
| getAvgPrice() | GET | api/v3/avgPrice |
|
| get24hrChangeStatististics() | GET | api/v3/ticker/24hr |
|
| getTradingDayTicker() | GET | api/v3/ticker/tradingDay |
|
| getSymbolPriceTicker() | GET | api/v3/ticker/price |
|
| getSymbolOrderBookTicker() | GET | api/v3/ticker/bookTicker |
|
| getRollingWindowTicker() | GET | api/v3/ticker |
|
| getOrder() | 🔐 | GET | api/v3/order |
| cancelOrder() | 🔐 | DELETE | api/v3/order |
| cancelAllSymbolOrders() | 🔐 | DELETE | api/v3/openOrders |
| getOpenOrders() | 🔐 | GET | api/v3/openOrders |
| getAllOrders() | 🔐 | GET | api/v3/allOrders |
| submitNewOCO() | 🔐 | POST | api/v3/order/oco |
| submitNewOrderListOTO() | 🔐 | POST | api/v3/orderList/oto |
| submitNewOrderListOTOCO() | 🔐 | POST | api/v3/orderList/otoco |
| cancelOCO() | 🔐 | DELETE | api/v3/orderList |
| getOCO() | 🔐 | GET | api/v3/orderList |
| getAllOCO() | 🔐 | GET | api/v3/allOrderList |
| getAllOpenOCO() | 🔐 | GET | api/v3/openOrderList |
| submitNewSOROrder() | 🔐 | POST | api/v3/sor/order |
| testNewSOROrder() | 🔐 | POST | api/v3/sor/order/test |
| getAccountInformation() | 🔐 | GET | api/v3/account |
| getAccountTradeList() | 🔐 | GET | api/v3/myTrades |
| getOrderRateLimit() | 🔐 | GET | api/v3/rateLimit/order |
| getPreventedMatches() | 🔐 | GET | api/v3/myPreventedMatches |
| getAllocations() | 🔐 | GET | api/v3/myAllocations |
| getCommissionRates() | 🔐 | GET | api/v3/account/commission |
| getCrossMarginCollateralRatio() | 🔐 | GET | sapi/v1/margin/crossMarginCollateralRatio |
| getAllCrossMarginPairs() | GET | sapi/v1/margin/allPairs |
|
| getIsolatedMarginAllSymbols() | 🔐 | GET | sapi/v1/margin/isolated/allPairs |
| getAllMarginAssets() | GET | sapi/v1/margin/allAssets |
|
| getMarginDelistSchedule() | 🔐 | GET | sapi/v1/margin/delist-schedule |
| getIsolatedMarginTierData() | 🔐 | GET | sapi/v1/margin/isolatedMarginTier |
| queryMarginPriceIndex() | GET | sapi/v1/margin/priceIndex |
|
| getMarginAvailableInventory() | 🔐 | GET | sapi/v1/margin/available-inventory |
| getLeverageBracket() | 🔐 | GET | sapi/v1/margin/leverageBracket |
| getNextHourlyInterestRate() | 🔐 | GET | sapi/v1/margin/next-hourly-interest-rate |
| getMarginInterestHistory() | 🔐 | GET | sapi/v1/margin/interestHistory |
| submitMarginAccountBorrowRepay() | 🔐 | POST | sapi/v1/margin/borrow-repay |
| getMarginAccountBorrowRepayRecords() | 🔐 | GET | sapi/v1/margin/borrow-repay |
| getMarginInterestRateHistory() | 🔐 | GET | sapi/v1/margin/interestRateHistory |
| queryMaxBorrow() | 🔐 | GET | sapi/v1/margin/maxBorrowable |
| getMarginForceLiquidationRecord() | 🔐 | GET | sapi/v1/margin/forceLiquidationRec |
| getSmallLiabilityExchangeCoins() | 🔐 | GET | sapi/v1/margin/exchange-small-liability |
| getSmallLiabilityExchangeHistory() | 🔐 | GET | sapi/v1/margin/exchange-small-liability-history |
| marginAccountCancelOpenOrders() | 🔐 | DELETE | sapi/v1/margin/openOrders |
| marginAccountCancelOCO() | 🔐 | DELETE | sapi/v1/margin/orderList |
| marginAccountCancelOrder() | 🔐 | DELETE | sapi/v1/margin/order |
| marginAccountNewOCO() | 🔐 | POST | sapi/v1/margin/order/oco |
| getMarginOrderCountUsage() | 🔐 | GET | sapi/v1/margin/rateLimit/order |
| queryMarginAccountAllOCO() | 🔐 | GET | sapi/v1/margin/allOrderList |
| queryMarginAccountAllOrders() | 🔐 | GET | sapi/v1/margin/allOrders |
| queryMarginAccountOCO() | 🔐 | GET | sapi/v1/margin/orderList |
| queryMarginAccountOpenOCO() | 🔐 | GET | sapi/v1/margin/openOrderList |
| queryMarginAccountOpenOrders() | 🔐 | GET | sapi/v1/margin/openOrders |
| queryMarginAccountOrder() | 🔐 | GET | sapi/v1/margin/order |
| queryMarginAccountTradeList() | 🔐 | GET | sapi/v1/margin/myTrades |
| submitSmallLiabilityExchange() | 🔐 | POST | sapi/v1/margin/exchange-small-liability |
| submitManualLiquidation() | 🔐 | POST | sapi/v1/margin/manual-liquidation |
| submitMarginOTOOrder() | 🔐 | POST | sapi/v1/margin/order/oto |
| submitMarginOTOCOOrder() | 🔐 | POST | sapi/v1/margin/order/otoco |
| createMarginSpecialLowLatencyKey() | 🔐 | POST | sapi/v1/margin/apiKey |
| deleteMarginSpecialLowLatencyKey() | 🔐 | DELETE | sapi/v1/margin/apiKey |
| updateMarginIPForSpecialLowLatencyKey() | 🔐 | PUT | sapi/v1/margin/apiKey/ip |
| getMarginSpecialLowLatencyKeys() | 🔐 | GET | sapi/v1/margin/api-key-list |
| getMarginSpecialLowLatencyKey() | 🔐 | GET | sapi/v1/margin/apiKey |
| getCrossMarginTransferHistory() | 🔐 | GET | sapi/v1/margin/transfer |
| queryMaxTransferOutAmount() | 🔐 | GET | sapi/v1/margin/maxTransferable |
| updateCrossMarginMaxLeverage() | 🔐 | POST | sapi/v1/margin/max-leverage |
| disableIsolatedMarginAccount() | 🔐 | DELETE | sapi/v1/margin/isolated/account |
| enableIsolatedMarginAccount() | 🔐 | POST | sapi/v1/margin/isolated/account |
| getBNBBurn() | 🔐 | GET | sapi/v1/bnbBurn |
| getMarginSummary() | 🔐 | GET | sapi/v1/margin/tradeCoeff |
| queryCrossMarginAccountDetails() | 🔐 | GET | sapi/v1/margin/account |
| getCrossMarginFeeData() | 🔐 | GET | sapi/v1/margin/crossMarginData |
| getIsolatedMarginAccountLimit() | 🔐 | GET | sapi/v1/margin/isolated/accountLimit |
| getIsolatedMarginAccountInfo() | 🔐 | GET | sapi/v1/margin/isolated/account |
| getIsolatedMarginFeeData() | 🔐 | GET | sapi/v1/margin/isolatedMarginData |
| toggleBNBBurn() | 🔐 | POST | sapi/v1/bnbBurn |
| getMarginCapitalFlow() | 🔐 | GET | sapi/v1/margin/capital-flow |
| queryLoanRecord() | 🔐 | GET | sapi/v1/margin/loan |
| queryRepayRecord() | 🔐 | GET | sapi/v1/margin/repay |
| isolatedMarginAccountTransfer() | 🔐 | POST | sapi/v1/margin/isolated/transfer |
| getBalances() | 🔐 | GET | sapi/v1/capital/config/getall |
| withdraw() | 🔐 | POST | sapi/v1/capital/withdraw/apply |
| getWithdrawHistory() | 🔐 | GET | sapi/v1/capital/withdraw/history |
| getWithdrawAddresses() | 🔐 | GET | sapi/v1/capital/withdraw/address/list |
| getDepositHistory() | 🔐 | GET | sapi/v1/capital/deposit/hisrec |
| getDepositAddress() | 🔐 | GET | sapi/v1/capital/deposit/address |
| getDepositAddresses() | 🔐 | GET | sapi/v1/capital/deposit/address/list |
| submitDepositCredit() | 🔐 | POST | sapi/v1/capital/deposit/credit-apply |
| getAutoConvertStablecoins() | 🔐 | GET | sapi/v1/capital/contract/convertible-coins |
| setConvertibleCoins() | 🔐 | POST | sapi/v1/capital/contract/convertible-coins |
| getAssetDetail() | 🔐 | GET | sapi/v1/asset/assetDetail |
| getWalletBalances() | 🔐 | GET | sapi/v1/asset/wallet/balance |
| getUserAsset() | 🔐 | POST | sapi/v3/asset/getUserAsset |
| submitUniversalTransfer() | 🔐 | POST | sapi/v1/asset/transfer |
| getUniversalTransferHistory() | 🔐 | GET | sapi/v1/asset/transfer |
| getDust() | 🔐 | POST | sapi/v1/asset/dust-btc |
| convertDustToBnb() | 🔐 | POST | sapi/v1/asset/dust |
| getDustLog() | 🔐 | GET | sapi/v1/asset/dribblet |
| getAssetDividendRecord() | 🔐 | GET | sapi/v1/asset/assetDividend |
| getTradeFee() | 🔐 | GET | sapi/v1/asset/tradeFee |
| getFundingAsset() | 🔐 | POST | sapi/v1/asset/get-funding-asset |
| getCloudMiningHistory() | 🔐 | GET | sapi/v1/asset/ledger-transfer/cloud-mining/queryByPage |
| getDelegationHistory() | 🔐 | GET | sapi/v1/asset/custody/transfer-history |
| submitNewFutureAccountTransfer() | 🔐 | POST | sapi/v1/futures/transfer |
| getFutureAccountTransferHistory() | 🔐 | GET | sapi/v1/futures/transfer |
| getCrossCollateralBorrowHistory() | 🔐 | GET | sapi/v1/futures/loan/borrow/history |
| getCrossCollateralRepaymentHistory() | 🔐 | GET | sapi/v1/futures/loan/repay/history |
| getCrossCollateralWalletV2() | 🔐 | GET | sapi/v2/futures/loan/wallet |
| getAdjustCrossCollateralLTVHistory() | 🔐 | GET | sapi/v1/futures/loan/adjustCollateral/history |
| getCrossCollateralLiquidationHistory() | 🔐 | GET | sapi/v1/futures/loan/liquidationHistory |
| getCrossCollateralInterestHistory() | 🔐 | GET | sapi/v1/futures/loan/interestHistory |
| getAccountInfo() | 🔐 | GET | sapi/v1/account/info |
| getDailyAccountSnapshot() | 🔐 | GET | sapi/v1/accountSnapshot |
| disableFastWithdrawSwitch() | 🔐 | POST | sapi/v1/account/disableFastWithdrawSwitch |
| enableFastWithdrawSwitch() | 🔐 | POST | sapi/v1/account/enableFastWithdrawSwitch |
| getAccountStatus() | 🔐 | GET | sapi/v1/account/status |
| getApiTradingStatus() | 🔐 | GET | sapi/v1/account/apiTradingStatus |
| getApiKeyPermissions() | 🔐 | GET | sapi/v1/account/apiRestrictions |
| getSystemStatus() | GET | sapi/v1/system/status |
|
| getDelistSchedule() | 🔐 | GET | sapi/v1/spot/delist-schedule |
| createVirtualSubAccount() | 🔐 | POST | sapi/v1/sub-account/virtualSubAccount |
| getSubAccountList() | 🔐 | GET | sapi/v1/sub-account/list |
| subAccountEnableFutures() | 🔐 | POST | sapi/v1/sub-account/futures/enable |
| subAccountEnableMargin() | 🔐 | POST | sapi/v1/sub-account/margin/enable |
| enableOptionsForSubAccount() | 🔐 | POST | sapi/v1/sub-account/eoptions/enable |
| subAccountEnableLeverageToken() | 🔐 | POST | sapi/v1/sub-account/blvt/enable |
| getSubAccountStatusOnMarginOrFutures() | 🔐 | GET | sapi/v1/sub-account/status |
| getSubAccountFuturesPositionRisk() | 🔐 | GET | sapi/v1/sub-account/futures/positionRisk |
| getSubAccountFuturesPositionRiskV2() | 🔐 | GET | sapi/v2/sub-account/futures/positionRisk |
| getSubAccountTransactionStatistics() | 🔐 | GET | sapi/v1/sub-account/transaction-statistics |
| getSubAccountIPRestriction() | 🔐 | GET | sapi/v1/sub-account/subAccountApi/ipRestriction |
| subAccountDeleteIPList() | 🔐 | DELETE | sapi/v1/sub-account/subAccountApi/ipRestriction/ipList |
| subAccountAddIPRestriction() | 🔐 | POST | sapi/v2/sub-account/subAccountApi/ipRestriction |
| subAccountAddIPList() | 🔐 | POST | sapi/v1/sub-account/subAccountApi/ipRestriction/ipList |
| subAccountEnableOrDisableIPRestriction() | 🔐 | POST | sapi/v1/sub-account/subAccountApi/ipRestriction |
| subAccountFuturesTransfer() | 🔐 | POST | sapi/v1/sub-account/futures/transfer |
| getSubAccountFuturesAccountDetail() | 🔐 | GET | sapi/v1/sub-account/futures/account |
| getSubAccountDetailOnFuturesAccountV2() | 🔐 | GET | sapi/v2/sub-account/futures/account |
| getSubAccountDetailOnMarginAccount() | 🔐 | GET | sapi/v1/sub-account/margin/account |
| getSubAccountDepositAddress() | 🔐 | GET | sapi/v1/capital/deposit/subAddress |
| getSubAccountDepositHistory() | 🔐 | GET | sapi/v1/capital/deposit/subHisrec |
| getSubAccountFuturesAccountSummary() | 🔐 | GET | sapi/v1/sub-account/futures/accountSummary |
| getSubAccountSummaryOnFuturesAccountV2() | 🔐 | GET | sapi/v2/sub-account/futures/accountSummary |
| getSubAccountsSummaryOfMarginAccount() | 🔐 | GET | sapi/v1/sub-account/margin/accountSummary |
| subAccountMarginTransfer() | 🔐 | POST | sapi/v1/sub-account/margin/transfer |
| getSubAccountAssets() | 🔐 | GET | sapi/v3/sub-account/assets |
| getSubAccountAssetsMaster() | 🔐 | GET | sapi/v4/sub-account/assets |
| getSubAccountFuturesAssetTransferHistory() | 🔐 | GET | sapi/v1/sub-account/futures/internalTransfer |
| getSubAccountSpotAssetTransferHistory() | 🔐 | GET | sapi/v1/sub-account/sub/transfer/history |
| getSubAccountSpotAssetsSummary() | 🔐 | GET | sapi/v1/sub-account/spotSummary |
| getSubAccountUniversalTransferHistory() | 🔐 | GET | sapi/v1/sub-account/universalTransfer |
| subAccountFuturesAssetTransfer() | 🔐 | POST | sapi/v1/sub-account/futures/internalTransfer |
| subAccountTransferHistory() | 🔐 | GET | sapi/v1/sub-account/transfer/subUserHistory |
| subAccountTransferToMaster() | 🔐 | POST | sapi/v1/sub-account/transfer/subToMaster |
| subAccountTransferToSameMaster() | 🔐 | POST | sapi/v1/sub-account/transfer/subToSub |
| subAccountUniversalTransfer() | 🔐 | POST | sapi/v1/sub-account/universalTransfer |
| depositAssetsIntoManagedSubAccount() | 🔐 | POST | sapi/v1/managed-subaccount/deposit |
| getManagedSubAccountDepositAddress() | 🔐 | GET | sapi/v1/managed-subaccount/deposit/address |
| withdrawAssetsFromManagedSubAccount() | 🔐 | POST | sapi/v1/managed-subaccount/withdraw |
| getManagedSubAccountTransfersParent() | 🔐 | GET | sapi/v1/managed-subaccount/queryTransLogForTradeParent |
| getManagedSubAccountTransferLog() | 🔐 | GET | sapi/v1/managed-subaccount/query-trans-log |
| getManagedSubAccountTransfersInvestor() | 🔐 | GET | sapi/v1/managed-subaccount/queryTransLogForInvestor |
| getManagedSubAccounts() | 🔐 | GET | sapi/v1/managed-subaccount/info |
| getManagedSubAccountSnapshot() | 🔐 | GET | sapi/v1/managed-subaccount/accountSnapshot |
| getManagedSubAccountAssetDetails() | 🔐 | GET | sapi/v1/managed-subaccount/asset |
| getManagedSubAccountMarginAssets() | 🔐 | GET | sapi/v1/managed-subaccount/marginAsset |
| getManagedSubAccountFuturesAssets() | 🔐 | GET | sapi/v1/managed-subaccount/fetch-future-asset |
| getAutoInvestAssets() | 🔐 | GET | sapi/v1/lending/auto-invest/all/asset |
| getAutoInvestSourceAssets() | 🔐 | GET | sapi/v1/lending/auto-invest/source-asset/list |
| getAutoInvestTargetAssets() | 🔐 | GET | sapi/v1/lending/auto-invest/target-asset/list |
| getAutoInvestTargetAssetsROI() | 🔐 | GET | sapi/v1/lending/auto-invest/target-asset/roi/list |
| getAutoInvestIndex() | 🔐 | GET | sapi/v1/lending/auto-invest/index/info |
| getAutoInvestPlans() | 🔐 | GET | sapi/v1/lending/auto-invest/plan/list |
| submitAutoInvestOneTimeTransaction() | 🔐 | POST | sapi/v1/lending/auto-invest/one-off |
| updateAutoInvestPlanStatus() | 🔐 | POST | sapi/v1/lending/auto-invest/plan/edit-status |
| updateAutoInvestmentPlanOld() | 🔐 | POST | sapi/v1/lending/auto-invest/plan/edit |
| updateAutoInvestmentPlan() | 🔐 | POST | sapi/v1/lending/auto-invest/plan/edit |
| submitAutoInvestRedemption() | 🔐 | POST | sapi/v1/lending/auto-invest/redeem |
| getAutoInvestSubscriptionTransactions() | 🔐 | GET | sapi/v1/lending/auto-invest/history/list |
| getOneTimeTransactionStatus() | 🔐 | GET | sapi/v1/lending/auto-invest/one-off/status |
| submitAutoInvestmentPlanOld() | 🔐 | POST | sapi/v1/lending/auto-invest/plan/add |
| submitAutoInvestmentPlan() | 🔐 | POST | sapi/v1/lending/auto-invest/plan/add |
| getAutoInvestRedemptionHistory() | 🔐 | GET | sapi/v1/lending/auto-invest/redeem/history |
| getAutoInvestPlan() | 🔐 | GET | sapi/v1/lending/auto-invest/plan/id |
| getAutoInvestUserIndex() | 🔐 | GET | sapi/v1/lending/auto-invest/index/user-summary |
| getAutoInvestRebalanceHistory() | 🔐 | GET | sapi/v1/lending/auto-invest/rebalance/history |
| getConvertPairs() | 🔐 | GET | sapi/v1/convert/exchangeInfo |
| getConvertAssetInfo() | 🔐 | GET | sapi/v1/convert/assetInfo |
| convertQuoteRequest() | 🔐 | POST | sapi/v1/convert/getQuote |
| acceptQuoteRequest() | 🔐 | POST | sapi/v1/convert/acceptQuote |
| getConvertTradeHistory() | 🔐 | GET | sapi/v1/convert/tradeFlow |
| getOrderStatus() | 🔐 | GET | sapi/v1/convert/orderStatus |
| submitConvertLimitOrder() | 🔐 | POST | sapi/v1/convert/limit/placeOrder |
| cancelConvertLimitOrder() | 🔐 | POST | sapi/v1/convert/limit/cancelOrder |
| getConvertLimitOpenOrders() | 🔐 | GET | sapi/v1/convert/limit/queryOpenOrders |
| getEthStakingAccount() | 🔐 | GET | sapi/v1/eth-staking/account |
| getEthStakingAccountV2() | 🔐 | GET | sapi/v2/eth-staking/account |
| getEthStakingQuota() | 🔐 | GET | sapi/v1/eth-staking/eth/quota |
| subscribeEthStakingV1() | 🔐 | POST | sapi/v1/eth-staking/eth/stake |
| subscribeEthStakingV2() | 🔐 | POST | sapi/v2/eth-staking/eth/stake |
| redeemEth() | 🔐 | POST | sapi/v1/eth-staking/eth/redeem |
| wrapBeth() | 🔐 | POST | sapi/v1/eth-staking/wbeth/wrap |
| getEthStakingHistory() | 🔐 | GET | sapi/v1/eth-staking/eth/history/stakingHistory |
| getEthRedemptionHistory() | 🔐 | GET | sapi/v1/eth-staking/eth/history/redemptionHistory |
| getBethRewardsHistory() | 🔐 | GET | sapi/v1/eth-staking/eth/history/rewardsHistory |
| getWbethRewardsHistory() | 🔐 | GET | sapi/v1/eth-staking/eth/history/wbethRewardsHistory |
| getEthRateHistory() | 🔐 | GET | sapi/v1/eth-staking/eth/history/rateHistory |
| getBethWrapHistory() | 🔐 | GET | sapi/v1/eth-staking/wbeth/history/wrapHistory |
| getBethUnwrapHistory() | 🔐 | GET | sapi/v1/eth-staking/wbeth/history/unwrapHistory |
| getStakingProducts() | 🔐 | GET | sapi/v1/staking/productList |
| getStakingProductPosition() | 🔐 | GET | sapi/v1/staking/position |
| getStakingHistory() | 🔐 | GET | sapi/v1/staking/stakingRecord |
| getPersonalLeftQuotaOfStakingProduct() | 🔐 | GET | sapi/v1/staking/personalLeftQuota |
| getSolStakingAccount() | 🔐 | GET | sapi/v1/sol-staking/account |
| getSolStakingQuota() | 🔐 | GET | sapi/v1/sol-staking/sol/quota |
| subscribeSolStaking() | 🔐 | POST | sapi/v1/sol-staking/sol/stake |
| redeemSol() | 🔐 | POST | sapi/v1/sol-staking/sol/redeem |
| getSolStakingHistory() | 🔐 | GET | sapi/v1/sol-staking/sol/history/stakingHistory |
| getSolRedemptionHistory() | 🔐 | GET | sapi/v1/sol-staking/sol/history/redemptionHistory |
| getBnsolRewardsHistory() | 🔐 | GET | sapi/v1/sol-staking/sol/history/bnsolRewardsHistory |
| getBnsolRateHistory() | 🔐 | GET | sapi/v1/sol-staking/sol/history/rateHistory |
| getFuturesLeadTraderStatus() | 🔐 | GET | sapi/v1/copyTrading/futures/userStatus |
| getFuturesLeadTradingSymbolWhitelist() | 🔐 | GET | sapi/v1/copyTrading/futures/leadSymbol |
| getMiningAlgos() | GET | sapi/v1/mining/pub/algoList |
|
| getMiningCoins() | GET | sapi/v1/mining/pub/coinList |
|
| getHashrateResales() | 🔐 | GET | sapi/v1/mining/hash-transfer/config/details/list |
| getMiners() | 🔐 | GET | sapi/v1/mining/worker/list |
| getMinerDetails() | 🔐 | GET | sapi/v1/mining/worker/detail |
| getExtraBonuses() | 🔐 | GET | sapi/v1/mining/payment/other |
| getMiningEarnings() | 🔐 | GET | sapi/v1/mining/payment/list |
| cancelHashrateResaleConfig() | 🔐 | POST | sapi/v1/mining/hash-transfer/config/cancel |
| getHashrateResale() | 🔐 | GET | sapi/v1/mining/hash-transfer/profit/details |
| getMiningAccountEarnings() | 🔐 | GET | sapi/v1/mining/payment/uid |
| getMiningStatistics() | 🔐 | GET | sapi/v1/mining/statistics/user/status |
| submitHashrateResale() | 🔐 | POST | sapi/v1/mining/hash-transfer/config |
| getMiningAccounts() | 🔐 | GET | sapi/v1/mining/statistics/user/list |
| submitVpNewOrder() | 🔐 | POST | sapi/v1/algo/futures/newOrderVp |
| submitTwapNewOrder() | 🔐 | POST | sapi/v1/algo/futures/newOrderTwap |
| cancelAlgoOrder() | 🔐 | DELETE | sapi/v1/algo/futures/order |
| getAlgoSubOrders() | 🔐 | GET | sapi/v1/algo/futures/subOrders |
| getAlgoOpenOrders() | 🔐 | GET | sapi/v1/algo/futures/openOrders |
| getAlgoHistoricalOrders() | 🔐 | GET | sapi/v1/algo/futures/historicalOrders |
| submitSpotAlgoTwapOrder() | 🔐 | POST | sapi/v1/algo/spot/newOrderTwap |
| cancelSpotAlgoOrder() | 🔐 | DELETE | sapi/v1/algo/spot/order |
| getSpotAlgoSubOrders() | 🔐 | GET | sapi/v1/algo/spot/subOrders |
| getSpotAlgoOpenOrders() | 🔐 | GET | sapi/v1/algo/spot/openOrders |
| getSpotAlgoHistoricalOrders() | 🔐 | GET | sapi/v1/algo/spot/historicalOrders |
| getCryptoLoanFlexibleCollateralAssets() | 🔐 | GET | sapi/v2/loan/flexible/collateral/data |
| getCryptoLoanFlexibleAssets() | 🔐 | GET | sapi/v2/loan/flexible/loanable/data |
| borrowCryptoLoanFlexible() | 🔐 | POST | sapi/v2/loan/flexible/borrow |
| repayCryptoLoanFlexible() | 🔐 | POST | sapi/v2/loan/flexible/repay |
| adjustCryptoLoanFlexibleLTV() | 🔐 | POST | sapi/v2/loan/flexible/adjust/ltv |
| getCryptoLoanFlexibleLTVAdjustmentHistory() | 🔐 | GET | sapi/v2/loan/flexible/ltv/adjustment/history |
| getLoanFlexibleBorrowHistory() | 🔐 | GET | sapi/v2/loan/flexible/borrow/history |
| getCryptoLoanFlexibleOngoingOrders() | 🔐 | GET | sapi/v2/loan/flexible/ongoing/orders |
| getLoanFlexibleRepaymentHistory() | 🔐 | GET | sapi/v2/loan/flexible/repay/history |
| getCryptoLoanLoanableAssets() | 🔐 | GET | sapi/v1/loan/loanable/data |
| getCryptoLoanCollateralRepayRate() | 🔐 | GET | sapi/v1/loan/repay/collateral/rate |
| getCryptoLoanCollateralAssetsData() | 🔐 | GET | sapi/v1/loan/collateral/data |
| getCryptoLoansIncomeHistory() | 🔐 | GET | sapi/v1/loan/income |
| borrowCryptoLoan() | 🔐 | POST | sapi/v1/loan/borrow |
| repayCryptoLoan() | 🔐 | POST | sapi/v1/loan/repay |
| adjustCryptoLoanLTV() | 🔐 | POST | sapi/v1/loan/adjust/ltv |
| customizeCryptoLoanMarginCall() | 🔐 | POST | sapi/v1/loan/customize/margin_call |
| getCryptoLoanOngoingOrders() | 🔐 | GET | sapi/v1/loan/ongoing/orders |
| getCryptoLoanBorrowHistory() | 🔐 | GET | sapi/v1/loan/borrow/history |
| getCryptoLoanLTVAdjustmentHistory() | 🔐 | GET | sapi/v1/loan/ltv/adjustment/history |
| getCryptoLoanRepaymentHistory() | 🔐 | GET | sapi/v1/loan/repay/history |
| getSimpleEarnAccount() | 🔐 | GET | sapi/v1/simple-earn/account |
| getFlexibleSavingProducts() | 🔐 | GET | sapi/v1/simple-earn/flexible/list |
| getSimpleEarnLockedProductList() | 🔐 | GET | sapi/v1/simple-earn/locked/list |
| getFlexibleProductPosition() | 🔐 | GET | sapi/v1/simple-earn/flexible/position |
| getLockedProductPosition() | 🔐 | GET | sapi/v1/simple-earn/locked/position |
| getFlexiblePersonalLeftQuota() | 🔐 | GET | sapi/v1/simple-earn/flexible/personalLeftQuota |
| getLockedPersonalLeftQuota() | 🔐 | GET | sapi/v1/simple-earn/locked/personalLeftQuota |
| purchaseFlexibleProduct() | 🔐 | POST | sapi/v1/simple-earn/flexible/subscribe |
| subscribeSimpleEarnLockedProduct() | 🔐 | POST | sapi/v1/simple-earn/locked/subscribe |
| redeemFlexibleProduct() | 🔐 | POST | sapi/v1/simple-earn/flexible/redeem |
| redeemLockedProduct() | 🔐 | POST | sapi/v1/simple-earn/locked/redeem |
| setFlexibleAutoSubscribe() | 🔐 | POST | sapi/v1/simple-earn/flexible/setAutoSubscribe |
| setLockedAutoSubscribe() | 🔐 | POST | sapi/v1/simple-earn/locked/setAutoSubscribe |
| getFlexibleSubscriptionPreview() | 🔐 | GET | sapi/v1/simple-earn/flexible/subscriptionPreview |
| getLockedSubscriptionPreview() | 🔐 | GET | sapi/v1/simple-earn/locked/subscriptionPreview |
| setLockedProductRedeemOption() | 🔐 | POST | sapi/v1/simple-earn/locked/setRedeemOption |
| getFlexibleSubscriptionRecord() | 🔐 | GET | sapi/v1/simple-earn/flexible/history/subscriptionRecord |
| getLockedSubscriptionRecord() | 🔐 | GET | sapi/v1/simple-earn/locked/history/subscriptionRecord |
| getFlexibleRedemptionRecord() | 🔐 | GET | sapi/v1/simple-earn/flexible/history/redemptionRecord |
| getLockedRedemptionRecord() | 🔐 | GET | sapi/v1/simple-earn/locked/history/redemptionRecord |
| getFlexibleRewardsHistory() | 🔐 | GET | sapi/v1/simple-earn/flexible/history/rewardsRecord |
| getLockedRewardsHistory() | 🔐 | GET | sapi/v1/simple-earn/locked/history/rewardsRecord |
| getCollateralRecord() | 🔐 | GET | sapi/v1/simple-earn/flexible/history/collateralRecord |
| getRateHistory() | 🔐 | GET | sapi/v1/simple-earn/flexible/history/rateHistory |
| getVipBorrowInterestRate() | 🔐 | GET | sapi/v1/loan/vip/request/interestRate |
| getVipLoanableAssets() | 🔐 | GET | sapi/v1/loan/vip/loanable/data |
| getVipCollateralAssets() | 🔐 | GET | sapi/v1/loan/vip/collateral/data |
| getVipLoanOpenOrders() | 🔐 | GET | sapi/v1/loan/vip/ongoing/orders |
| getVipLoanRepaymentHistory() | 🔐 | GET | sapi/v1/loan/vip/repay/history |
| checkVipCollateralAccount() | 🔐 | GET | sapi/v1/loan/vip/collateral/account |
| getVipApplicationStatus() | 🔐 | GET | sapi/v1/loan/vip/request/data |
| renewVipLoan() | 🔐 | POST | sapi/v1/loan/vip/renew |
| repayVipLoan() | 🔐 | POST | sapi/v1/loan/vip/repay |
| borrowVipLoan() | 🔐 | POST | sapi/v1/loan/vip/borrow |
| getDualInvestmentProducts() | 🔐 | GET | sapi/v1/dci/product/list |
| subscribeDualInvestmentProduct() | 🔐 | POST | sapi/v1/dci/product/subscribe |
| getDualInvestmentPositions() | 🔐 | GET | sapi/v1/dci/product/positions |
| getDualInvestmentAccounts() | 🔐 | GET | sapi/v1/dci/product/accounts |
| updateAutoCompoundStatus() | 🔐 | POST | sapi/v1/dci/product/auto_compound/edit-status |
| createGiftCard() | 🔐 | POST | sapi/v1/giftcard/createCode |
| createDualTokenGiftCard() | 🔐 | POST | sapi/v1/giftcard/buyCode |
| redeemGiftCard() | 🔐 | POST | sapi/v1/giftcard/redeemCode |
| verifyGiftCard() | 🔐 | GET | sapi/v1/giftcard/verify |
| getTokenLimit() | 🔐 | GET | sapi/v1/giftcard/buyCode/token-limit |
| getRsaPublicKey() | 🔐 | GET | sapi/v1/giftcard/cryptography/rsa-public-key |
| getNftTransactionHistory() | 🔐 | GET | sapi/v1/nft/history/transactions |
| getNftDepositHistory() | 🔐 | GET | sapi/v1/nft/history/deposit |
| getNftWithdrawHistory() | 🔐 | GET | sapi/v1/nft/history/withdraw |
| getNftAsset() | 🔐 | GET | sapi/v1/nft/user/getAsset |
| getC2CTradeHistory() | 🔐 | GET | sapi/v1/c2c/orderMatch/listUserOrderHistory |
| getFiatOrderHistory() | 🔐 | GET | sapi/v1/fiat/orders |
| getFiatPaymentsHistory() | 🔐 | GET | sapi/v1/fiat/payments |
| getSpotRebateHistoryRecords() | 🔐 | GET | sapi/v1/rebate/taxQuery |
| getPortfolioMarginIndexPrice() | GET | sapi/v1/portfolio/asset-index-price |
|
| getPortfolioMarginAssetLeverage() | 🔐 | GET | sapi/v1/portfolio/margin-asset-leverage |
| getPortfolioMarginProCollateralRate() | GET | sapi/v1/portfolio/collateralRate |
|
| getPortfolioMarginProTieredCollateralRate() | GET | sapi/v2/portfolio/collateralRate |
|
| getPortfolioMarginProAccountInfo() | 🔐 | GET | sapi/v1/portfolio/account |
| bnbTransfer() | 🔐 | POST | sapi/v1/portfolio/bnb-transfer |
| submitPortfolioMarginProFullTransfer() | 🔐 | POST | sapi/v1/portfolio/auto-collection |
| submitPortfolioMarginProSpecificTransfer() | 🔐 | POST | sapi/v1/portfolio/asset-collection |
| repayPortfolioMarginProBankruptcyLoan() | 🔐 | POST | sapi/v1/portfolio/repay |
| getPortfolioMarginProBankruptcyLoanAmount() | 🔐 | GET | sapi/v1/portfolio/pmLoan |
| repayFuturesNegativeBalance() | 🔐 | POST | sapi/v1/portfolio/repay-futures-negative-balance |
| updateAutoRepayFuturesStatus() | 🔐 | POST | sapi/v1/portfolio/repay-futures-switch |
| getAutoRepayFuturesStatus() | 🔐 | GET | sapi/v1/portfolio/repay-futures-switch |
| getPortfolioMarginProInterestHistory() | 🔐 | GET | sapi/v1/portfolio/interest-history |
| getFuturesTickLevelOrderbookDataLink() | 🔐 | GET | sapi/v1/futures/histDataLink |
| getBlvtInfo() | GET | sapi/v1/blvt/tokenInfo |
|
| subscribeBlvt() | 🔐 | POST | sapi/v1/blvt/subscribe |
| getBlvtSubscriptionRecord() | 🔐 | GET | sapi/v1/blvt/subscribe/record |
| redeemBlvt() | 🔐 | POST | sapi/v1/blvt/redeem |
| getBlvtRedemptionRecord() | 🔐 | GET | sapi/v1/blvt/redeem/record |
| getBlvtUserLimitInfo() | 🔐 | GET | sapi/v1/blvt/userLimit |
| getPayTransactions() | 🔐 | GET | sapi/v1/pay/transactions |
| createBrokerSubAccount() | 🔐 | POST | sapi/v1/broker/subAccount |
| getBrokerSubAccount() | 🔐 | GET | sapi/v1/broker/subAccount |
| enableMarginBrokerSubAccount() | 🔐 | POST | sapi/v1/broker/subAccount/futures |
| createApiKeyBrokerSubAccount() | 🔐 | POST | sapi/v1/broker/subAccountApi |
| changePermissionApiKeyBrokerSubAccount() | 🔐 | POST | sapi/v1/broker/subAccountApi/permission |
| changeComissionBrokerSubAccount() | 🔐 | POST | sapi/v1/broker/subAccountApi/permission |
| enableUniversalTransferApiKeyBrokerSubAccount() | 🔐 | POST | sapi/v1/broker/subAccountApi/permission/universalTransfer |
| updateIpRestrictionForSubAccountApiKey() | 🔐 | POST | sapi/v2/broker/subAccountApi/ipRestriction |
| deleteIPRestrictionForSubAccountApiKey() | 🔐 | DELETE | sapi/v1/broker/subAccountApi/ipRestriction/ipList |
| deleteApiKeyBrokerSubAccount() | 🔐 | DELETE | sapi/v1/broker/subAccountApi |
| getSubAccountBrokerIpRestriction() | 🔐 | GET | sapi/v1/broker/subAccountApi/ipRestriction |
| getApiKeyBrokerSubAccount() | 🔐 | GET | sapi/v1/broker/subAccountApi |
| getBrokerInfo() | 🔐 | GET | sapi/v1/broker/info |
| updateSubAccountBNBBurn() | 🔐 | POST | sapi/v1/broker/subAccount/bnbBurn/spot |
| updateSubAccountMarginInterestBNBBurn() | 🔐 | POST | sapi/v1/broker/subAccount/bnbBurn/marginInterest |
| getSubAccountBNBBurnStatus() | 🔐 | GET | sapi/v1/broker/subAccount/bnbBurn/status |
| transferBrokerSubAccount() | 🔐 | POST | sapi/v1/broker/transfer |
| getBrokerSubAccountHistory() | 🔐 | GET | sapi/v1/broker/transfer |
| submitBrokerSubFuturesTransfer() | 🔐 | POST | sapi/v1/broker/transfer/futures |
| getSubAccountFuturesTransferHistory() | 🔐 | GET | sapi/v1/broker/transfer/futures |
| getBrokerSubDepositHistory() | 🔐 | GET | sapi/v1/broker/subAccount/depositHist |
| getBrokerSubAccountSpotAssets() | 🔐 | GET | sapi/v1/broker/subAccount/spotSummary |
| getSubAccountMarginAssetInfo() | 🔐 | GET | sapi/v1/broker/subAccount/marginSummary |
| querySubAccountFuturesAssetInfo() | 🔐 | GET | sapi/v3/broker/subAccount/futuresSummary |
| universalTransferBroker() | 🔐 | POST | sapi/v1/broker/universalTransfer |
| getUniversalTransferBroker() | 🔐 | GET | sapi/v1/broker/universalTransfer |
| updateBrokerSubAccountCommission() | 🔐 | POST | sapi/v1/broker/subAccountApi/commission |
| updateBrokerSubAccountFuturesCommission() | 🔐 | POST | sapi/v1/broker/subAccountApi/commission/futures |
| getBrokerSubAccountFuturesCommission() | 🔐 | GET | sapi/v1/broker/subAccountApi/commission/futures |
| updateBrokerSubAccountCoinFuturesCommission() | 🔐 | POST | sapi/v1/broker/subAccountApi/commission/coinFutures |
| getBrokerSubAccountCoinFuturesCommission() | 🔐 | GET | sapi/v1/broker/subAccountApi/commission/coinFutures |
| getBrokerSpotCommissionRebate() | 🔐 | GET | sapi/v1/broker/rebate/recentRecord |
| getBrokerFuturesCommissionRebate() | 🔐 | GET | sapi/v1/broker/rebate/futures/recentRecord |
| getBrokerIfNewSpotUser() | 🔐 | GET | sapi/v1/apiReferral/ifNewUser |
| getBrokerSubAccountDepositHistory() | 🔐 | GET | sapi/v1/bv1/apiReferral/ifNewUser |
| enableFuturesBrokerSubAccount() | 🔐 | POST | sapi/v1/broker/subAccount |
| enableMarginApiKeyBrokerSubAccount() | 🔐 | POST | sapi/v1/broker/subAccount/margin |
| getSpotUserDataListenKey() | POST | api/v3/userDataStream |
|
| keepAliveSpotUserDataListenKey() | PUT | api/v3/userDataStream?listenKey=${listenKey} |
|
| closeSpotUserDataListenKey() | DELETE | api/v3/userDataStream?listenKey=${listenKey} |
|
| getMarginUserDataListenKey() | POST | sapi/v1/userDataStream |
|
| keepAliveMarginUserDataListenKey() | PUT | sapi/v1/userDataStream?listenKey=${listenKey} |
|
| closeMarginUserDataListenKey() | DELETE | sapi/v1/userDataStream?listenKey=${listenKey} |
|
| getIsolatedMarginUserDataListenKey() | POST | sapi/v1/userDataStream/isolated?${serialiseParams(params)} |
|
| keepAliveIsolatedMarginUserDataListenKey() | PUT | sapi/v1/userDataStream/isolated?${serialiseParams(params)} |
|
| closeIsolatedMarginUserDataListenKey() | DELETE | sapi/v1/userDataStream/isolated?${serialiseParams(params)} |
|
| getBSwapLiquidity() | 🔐 | GET | sapi/v1/bswap/liquidity |
| addBSwapLiquidity() | 🔐 | POST | sapi/v1/bswap/liquidityAdd |
| removeBSwapLiquidity() | 🔐 | POST | sapi/v1/bswap/liquidityRemove |
| getBSwapOperations() | 🔐 | GET | sapi/v1/bswap/liquidityOps |
| getLeftDailyPurchaseQuotaFlexibleProduct() | 🔐 | GET | sapi/v1/lending/daily/userLeftQuota |
| getLeftDailyRedemptionQuotaFlexibleProduct() | 🔐 | GET | sapi/v1/lending/daily/userRedemptionQuota |
| purchaseFixedAndActivityProject() | 🔐 | POST | sapi/v1/lending/customizedFixed/purchase |
| getFixedAndActivityProjects() | 🔐 | GET | sapi/v1/lending/project/list |
| getFixedAndActivityProductPosition() | 🔐 | GET | sapi/v1/lending/project/position/list |
| getLendingAccount() | 🔐 | GET | sapi/v1/lending/union/account |
| getPurchaseRecord() | 🔐 | GET | sapi/v1/lending/union/purchaseRecord |
| getRedemptionRecord() | 🔐 | GET | sapi/v1/lending/union/redemptionRecord |
| getInterestHistory() | 🔐 | GET | sapi/v1/lending/union/interestHistory |
| changeFixedAndActivityPositionToDailyPosition() | 🔐 | POST | sapi/v1/lending/positionChanged |
| enableConvertSubAccount() | 🔐 | POST | sapi/v1/broker/subAccount/convert |
| convertBUSD() | 🔐 | POST | sapi/v1/asset/convert-transfer |
| getConvertBUSDHistory() | 🔐 | GET | sapi/v1/asset/convert-transfer/queryByPage |
This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in usdm-client.ts.
| Function | AUTH | HTTP Method | Endpoint |
|---|---|---|---|
| testConnectivity() | GET | fapi/v1/ping |
|
| getExchangeInfo() | GET | fapi/v1/exchangeInfo |
|
| getOrderBook() | GET | fapi/v1/depth |
|
| getRecentTrades() | GET | fapi/v1/trades |
|
| getHistoricalTrades() | GET | fapi/v1/historicalTrades |
|
| getAggregateTrades() | GET | fapi/v1/aggTrades |
|
| getKlines() | GET | fapi/v1/klines |
|
| getContinuousContractKlines() | GET | fapi/v1/continuousKlines |
|
| getIndexPriceKlines() | GET | fapi/v1/indexPriceKlines |
|
| getMarkPriceKlines() | GET | fapi/v1/markPriceKlines |
|
| getPremiumIndexKlines() | GET | fapi/v1/premiumIndexKlines |
|
| getMarkPrice() | GET | fapi/v1/premiumIndex |
|
| getFundingRateHistory() | GET | fapi/v1/fundingRate |
|
| getFundingRates() | GET | fapi/v1/fundingInfo |
|
| get24hrChangeStatististics() | GET | fapi/v1/ticker/24hr |
|
| get24hrChangeStatistics() | GET | fapi/v1/ticker/24hr |
|
| getSymbolPriceTicker() | GET | fapi/v1/ticker/price |
|
| getSymbolPriceTickerV2() | GET | fapi/v2/ticker/price |
|
| getSymbolOrderBookTicker() | GET | fapi/v1/ticker/bookTicker |
|
| getQuarterlyContractSettlementPrices() | GET | futures/data/delivery-price |
|
| getOpenInterest() | GET | fapi/v1/openInterest |
|
| getOpenInterestStatistics() | GET | futures/data/openInterestHist |
|
| getTopTradersLongShortPositionRatio() | GET | futures/data/topLongShortPositionRatio |
|
| getTopTradersLongShortAccountRatio() | GET | futures/data/topLongShortAccountRatio |
|
| getGlobalLongShortAccountRatio() | GET | futures/data/globalLongShortAccountRatio |
|
| getTakerBuySellVolume() | GET | futures/data/takerlongshortRatio |
|
| getHistoricalBlvtNavKlines() | GET | fapi/v1/lvtKlines |
|
| getCompositeSymbolIndex() | GET | fapi/v1/indexInfo |
|
| getMultiAssetsModeAssetIndex() | GET | fapi/v1/assetIndex |
|
| getBasis() | GET | futures/data/basis |
|
| getIndexPriceConstituents() | GET | fapi/v1/constituents |
|
| submitNewOrder() | 🔐 | POST | fapi/v1/order |
| submitMultipleOrders() | 🔐 | POST | fapi/v1/batchOrders |
| modifyOrder() | 🔐 | PUT | fapi/v1/order |
| modifyMultipleOrders() | 🔐 | PUT | fapi/v1/batchOrders |
| getOrderModifyHistory() | 🔐 | GET | fapi/v1/orderAmendment |
| cancelOrder() | 🔐 | DELETE | fapi/v1/order |
| cancelMultipleOrders() | 🔐 | DELETE | fapi/v1/batchOrders |
| cancelAllOpenOrders() | 🔐 | DELETE | fapi/v1/allOpenOrders |
| setCancelOrdersOnTimeout() | 🔐 | POST | fapi/v1/countdownCancelAll |
| getOrder() | 🔐 | GET | fapi/v1/order |
| getAllOrders() | 🔐 | GET | fapi/v1/allOrders |
| getAllOpenOrders() | 🔐 | GET | fapi/v1/openOrders |
| getCurrentOpenOrder() | 🔐 | GET | fapi/v1/openOrder |
| getForceOrders() | 🔐 | GET | fapi/v1/forceOrders |
| getAccountTrades() | 🔐 | GET | fapi/v1/userTrades |
| setMarginType() | 🔐 | POST | fapi/v1/marginType |
| setPositionMode() | 🔐 | POST | fapi/v1/positionSide/dual |
| setLeverage() | 🔐 | POST | fapi/v1/leverage |
| setMultiAssetsMode() | 🔐 | POST | fapi/v1/multiAssetsMargin |
| setIsolatedPositionMargin() | 🔐 | POST | fapi/v1/positionMargin |
| getPositions() | 🔐 | GET | fapi/v2/positionRisk |
| getPositionsV3() | 🔐 | GET | fapi/v3/positionRisk |
| getADLQuantileEstimation() | 🔐 | GET | fapi/v1/adlQuantile |
| getPositionMarginChangeHistory() | 🔐 | GET | fapi/v1/positionMargin/history |
| getBalanceV3() | 🔐 | GET | fapi/v3/balance |
| getBalance() | 🔐 | GET | fapi/v2/balance |
| getAccountInformationV3() | 🔐 | GET | fapi/v3/account |
| getAccountInformation() | 🔐 | GET | fapi/v2/account |
| getAccountComissionRate() | 🔐 | GET | fapi/v1/commissionRate |
| getFuturesAccountConfig() | 🔐 | GET | fapi/v1/accountConfig |
| getFuturesSymbolConfig() | 🔐 | GET | fapi/v1/symbolConfig |
| getUserForceOrders() | 🔐 | GET | fapi/v1/rateLimit/order |
| getNotionalAndLeverageBrackets() | 🔐 | GET | fapi/v1/leverageBracket |
| getMultiAssetsMode() | 🔐 | GET | fapi/v1/multiAssetsMargin |
| getCurrentPositionMode() | 🔐 | GET | fapi/v1/positionSide/dual |
| getIncomeHistory() | 🔐 | GET | fapi/v1/income |
| getApiQuantitativeRulesIndicators() | 🔐 | GET | fapi/v1/apiTradingStatus |
| getFuturesTransactionHistoryDownloadId() | 🔐 | GET | fapi/v1/income/asyn |
| getFuturesTransactionHistoryDownloadLink() | 🔐 | GET | fapi/v1/income/asyn/id |
| getFuturesOrderHistoryDownloadId() | 🔐 | GET | fapi/v1/order/asyn |
| getFuturesOrderHistoryDownloadLink() | 🔐 | GET | fapi/v1/order/asyn/id |
| getFuturesTradeHistoryDownloadId() | 🔐 | GET | fapi/v1/trade/asyn |
| getFuturesTradeDownloadLink() | 🔐 | GET | fapi/v1/trade/asyn/id |
| setBNBBurnEnabled() | 🔐 | POST | fapi/v1/feeBurn |
| getBNBBurnStatus() | 🔐 | GET | fapi/v1/feeBurn |
| testOrder() | 🔐 | POST | fapi/v1/order/test |
| getAllConvertPairs() | GET | fapi/v1/convert/exchangeInfo |
|
| submitConvertQuoteRequest() | 🔐 | POST | fapi/v1/convert/getQuote |
| acceptConvertQuote() | 🔐 | POST | fapi/v1/convert/acceptQuote |
| getConvertOrderStatus() | 🔐 | GET | fapi/v1/convert/orderStatus |
| getPortfolioMarginProAccountInfo() | 🔐 | GET | fapi/v1/pmAccountInfo |
| getBrokerIfNewFuturesUser() | 🔐 | GET | fapi/v1/apiReferral/ifNewUser |
| setBrokerCustomIdForClient() | 🔐 | POST | fapi/v1/apiReferral/customization |
| getBrokerClientCustomIds() | 🔐 | GET | fapi/v1/apiReferral/customization |
| getBrokerUserCustomId() | 🔐 | GET | fapi/v1/apiReferral/userCustomization |
| getBrokerRebateDataOverview() | 🔐 | GET | fapi/v1/apiReferral/overview |
| getBrokerUserTradeVolume() | 🔐 | GET | fapi/v1/apiReferral/tradeVol |
| getBrokerRebateVolume() | 🔐 | GET | fapi/v1/apiReferral/rebateVol |
| getBrokerTradeDetail() | 🔐 | GET | fapi/v1/apiReferral/traderSummary |
| getFuturesUserDataListenKey() | POST | fapi/v1/listenKey |
|
| keepAliveFuturesUserDataListenKey() | PUT | fapi/v1/listenKey |
|
| closeFuturesUserDataListenKey() | DELETE | fapi/v1/listenKey |
This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in coinm-client.ts.
| Function | AUTH | HTTP Method | Endpoint |
|---|---|---|---|
| testConnectivity() | GET | dapi/v1/ping |
|
| getExchangeInfo() | GET | dapi/v1/exchangeInfo |
|
| getOrderBook() | GET | dapi/v1/depth |
|
| getRecentTrades() | GET | dapi/v1/trades |
|
| getHistoricalTrades() | GET | dapi/v1/historicalTrades |
|
| getAggregateTrades() | GET | dapi/v1/aggTrades |
|
| getMarkPrice() | GET | dapi/v1/premiumIndex |
|
| getFundingRateHistory() | GET | dapi/v1/fundingRate |
|
| getFundingRate() | GET | dapi/v1/fundingInfo |
|
| getKlines() | GET | dapi/v1/klines |
|
| getContinuousContractKlines() | GET | dapi/v1/continuousKlines |
|
| getIndexPriceKlines() | GET | dapi/v1/indexPriceKlines |
|
| getMarkPriceKlines() | GET | dapi/v1/markPriceKlines |
|
| getPremiumIndexKlines() | GET | dapi/v1/premiumIndexKlines |
|
| get24hrChangeStatististics() | GET | dapi/v1/ticker/24hr |
|
| get24hrChangeStatistics() | GET | dapi/v1/ticker/24hr |
|
| getSymbolPriceTicker() | GET | dapi/v1/ticker/price |
|
| getSymbolOrderBookTicker() | GET | dapi/v1/ticker/bookTicker |
|
| getOpenInterest() | GET | dapi/v1/openInterest |
|
| getOpenInterestStatistics() | GET | futures/data/openInterestHist |
|
| getTopTradersLongShortAccountRatio() | GET | futures/data/topLongShortAccountRatio |
|
| getTopTradersLongShortPositionRatio() | GET | futures/data/topLongShortPositionRatio |
|
| getGlobalLongShortAccountRatio() | GET | futures/data/globalLongShortAccountRatio |
|
| getTakerBuySellVolume() | GET | futures/data/takerBuySellVol |
|
| getCompositeSymbolIndex() | GET | futures/data/basis |
|
| getIndexPriceConstituents() | GET | dapi/v1/constituents |
|
| getQuarterlyContractSettlementPrices() | GET | futures/data/delivery-price |
|
| submitNewOrder() | 🔐 | POST | dapi/v1/order |
| submitMultipleOrders() | 🔐 | POST | dapi/v1/batchOrders |
| modifyOrder() | 🔐 | PUT | dapi/v1/order |
| modifyMultipleOrders() | 🔐 | PUT | dapi/v1/batchOrders |
| getOrderModifyHistory() | 🔐 | GET | dapi/v1/orderAmendment |
| cancelOrder() | 🔐 | DELETE | dapi/v1/order |
| cancelMultipleOrders() | 🔐 | DELETE | dapi/v1/batchOrders |
| cancelAllOpenOrders() | 🔐 | DELETE | dapi/v1/allOpenOrders |
| setCancelOrdersOnTimeout() | 🔐 | POST | dapi/v1/countdownCancelAll |
| getOrder() | 🔐 | GET | dapi/v1/order |
| getAllOrders() | 🔐 | GET | dapi/v1/allOrders |
| getAllOpenOrders() | 🔐 | GET | dapi/v1/openOrders |
| getCurrentOpenOrder() | 🔐 | GET | dapi/v1/openOrder |
| getForceOrders() | 🔐 | GET | dapi/v1/forceOrders |
| getAccountTrades() | 🔐 | GET | dapi/v1/userTrades |
| getPositions() | 🔐 | GET | dapi/v1/positionRisk |
| setPositionMode() | 🔐 | POST | dapi/v1/positionSide/dual |
| setMarginType() | 🔐 | POST | dapi/v1/marginType |
| setLeverage() | 🔐 | POST | dapi/v1/leverage |
| getADLQuantileEstimation() | 🔐 | GET | dapi/v1/adlQuantile |
| setIsolatedPositionMargin() | 🔐 | POST | dapi/v1/positionMargin |
| getPositionMarginChangeHistory() | 🔐 | GET | dapi/v1/positionMargin/history |
| getBalance() | 🔐 | GET | dapi/v1/balance |
| getAccountComissionRate() | 🔐 | GET | dapi/v1/commissionRate |
| getAccountInformation() | 🔐 | GET | dapi/v1/account |
| getNotionalAndLeverageBrackets() | 🔐 | GET | dapi/v2/leverageBracket |
| getCurrentPositionMode() | 🔐 | GET | dapi/v1/positionSide/dual |
| getIncomeHistory() | 🔐 | GET | dapi/v1/income |
| getClassicPortfolioMarginAccount() | 🔐 | GET | dapi/v1/pmAccountInfo |
| getClassicPortfolioMarginNotionalLimits() | 🔐 | GET | dapi/v1/pmExchangeInfo |
| getBrokerIfNewFuturesUser() | 🔐 | GET | dapi/v1/apiReferral/ifNewUser |
| setBrokerCustomIdForClient() | 🔐 | POST | dapi/v1/apiReferral/customization |
| getBrokerClientCustomIds() | 🔐 | GET | dapi/v1/apiReferral/customization |
| getBrokerUserCustomId() | 🔐 | GET | dapi/v1/apiReferral/userCustomization |
| getBrokerRebateDataOverview() | 🔐 | GET | dapi/v1/apiReferral/overview |
| getBrokerUserTradeVolume() | 🔐 | GET | dapi/v1/apiReferral/tradeVol |
| getBrokerRebateVolume() | 🔐 | GET | dapi/v1/apiReferral/rebateVol |
| getBrokerTradeDetail() | 🔐 | GET | dapi/v1/apiReferral/traderSummary |
| getFuturesUserDataListenKey() | POST | dapi/v1/listenKey |
|
| keepAliveFuturesUserDataListenKey() | PUT | dapi/v1/listenKey |
|
| closeFuturesUserDataListenKey() | DELETE | dapi/v1/listenKey |