Skip to content

Latest commit

 

History

History
293 lines (273 loc) · 47.2 KB

endpointFunctionList.md

File metadata and controls

293 lines (273 loc) · 47.2 KB

Endpoint maps

[connector logo][1]

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!

How to use table

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.

rest-client-v2.ts

This table includes all endpoints from the official Exchange API docs and corresponding SDK functions for each endpoint that are found in rest-client-v2.ts.

Function AUTH HTTP Method Endpoint
getAnnouncements() GET /api/v2/public/annoucements
getServerTime() GET /api/v2/public/time
getTradeRate() 🔐 GET /api/v2/common/trade-rate
getSpotTransactionRecords() 🔐 GET /api/v2/tax/spot-record
getFuturesTransactionRecords() 🔐 GET /api/v2/tax/future-record
getMarginTransactionRecords() 🔐 GET /api/v2/tax/margin-record
getP2PTransactionRecords() 🔐 GET /api/v2/tax/p2p-record
getP2PMerchantList() 🔐 GET /api/v2/p2p/merchantList
getP2PMerchantInfo() 🔐 GET /api/v2/p2p/merchantInfo
getP2PMerchantOrders() 🔐 GET /api/v2/p2p/orderList
getP2PMerchantAdvertisementList() 🔐 GET /api/v2/p2p/advList
getSpotWhaleNetFlowData() 🔐 GET /api/v2/spot/market/whale-net-flow
getFuturesActiveTakerBuySellVolumeData() GET /api/v2/mix/market/taker-buy-sell
getFuturesActiveLongShortPositionData() GET /api/v2/mix/market/position-long-short
getFuturesLongShortRatio() GET /api/v2/mix/market/long-short-ratio
getMarginLoanGrowthRate() GET /api/v2/mix/market/loan-growth
getIsolatedMarginBorrowingRatio() GET /api/v2/mix/market/isolated-borrow-rate
getFuturesActiveBuySellVolumeData() GET /api/v2/mix/market/long-short
getSpotFundFlow() GET /api/v2/spot/market/fund-flow
getTradeDataSupportSymbols() GET /api/v2/spot/market/support-symbols
getSpotFundNetFlowData() GET /api/v2/spot/market/fund-net-flow
getFuturesActiveLongShortAccountData() GET /api/v2/mix/market/account-long-short
createVirtualSubaccount() 🔐 POST /api/v2/user/create-virtual-subaccount
modifyVirtualSubaccount() 🔐 POST /api/v2/user/modify-virtual-subaccount
batchCreateVirtualSubaccountAndAPIKey() 🔐 POST /api/v2/user/batch-create-subaccount-and-apikey
getVirtualSubaccounts() 🔐 GET /api/v2/user/virtual-subaccount-list
createVirtualSubaccountAPIKey() 🔐 POST /api/v2/user/create-virtual-subaccount-apikey
modifyVirtualSubaccountAPIKey() 🔐 POST /api/v2/user/modify-virtual-subaccount-apikey
getVirtualSubaccountAPIKeys() 🔐 GET /api/v2/user/virtual-subaccount-apikey-list
getFundingAssets() 🔐 GET /api/v2/account/funding-assets
getBotAccount() 🔐 GET /api/v2/account/bot-assets
getBalances() 🔐 GET /api/v2/account/all-account-balance
getConvertCoins() 🔐 GET /api/v2/convert/currencies
getConvertQuotedPrice() 🔐 GET /api/v2/convert/quoted-price
convert() 🔐 POST /api/v2/convert/trade
getConvertHistory() 🔐 GET /api/v2/convert/convert-record
getConvertBGBCoins() 🔐 GET /api/v2/convert/bgb-convert-coin-list
convertBGB() 🔐 POST /api/v2/convert/bgb-convert
getConvertBGBHistory() 🔐 GET /api/v2/convert/bgb-convert-records
getSpotCoinInfo() 🔐 GET /api/v2/spot/public/coins
getSpotSymbolInfo() 🔐 GET /api/v2/spot/public/symbols
getSpotVIPFeeRate() 🔐 GET /api/v2/spot/market/vip-fee-rate
getSpotTicker() 🔐 GET /api/v2/spot/market/tickers
getSpotMergeDepth() 🔐 GET /api/v2/spot/market/merge-depth
getSpotOrderBookDepth() 🔐 GET /api/v2/spot/market/orderbook
getSpotCandles() 🔐 GET /api/v2/spot/market/candles
getSpotHistoricCandles() 🔐 GET /api/v2/spot/market/history-candles
getSpotRecentTrades() 🔐 GET /api/v2/spot/market/fills
getSpotHistoricTrades() 🔐 GET /api/v2/spot/market/fills-history
spotSubmitOrder() 🔐 POST /api/v2/spot/trade/place-order
spotCancelOrder() 🔐 POST /api/v2/spot/trade/cancel-order
spotBatchSubmitOrders() 🔐 POST /api/v2/spot/trade/batch-orders
spotBatchCancelOrders() 🔐 POST /api/v2/spot/trade/batch-cancel-order
spotCancelSymbolOrder() 🔐 POST /api/v2/spot/trade/cancel-symbol-order
getSpotOrder() 🔐 GET /api/v2/spot/trade/orderInfo
getSpotOpenOrders() 🔐 GET /api/v2/spot/trade/unfilled-orders
getSpotHistoricOrders() 🔐 GET /api/v2/spot/trade/history-orders
getSpotFills() 🔐 GET /api/v2/spot/trade/fills
spotSubmitPlanOrder() 🔐 POST /api/v2/spot/trade/place-plan-order
spotModifyPlanOrder() 🔐 POST /api/v2/spot/trade/modify-plan-order
spotCancelPlanOrder() 🔐 POST /api/v2/spot/trade/cancel-plan-order
getSpotCurrentPlanOrders() 🔐 GET /api/v2/spot/trade/current-plan-order
getSpotPlanSubOrder() 🔐 GET /api/v2/spot/trade/plan-sub-order
getSpotHistoricPlanOrders() 🔐 GET /api/v2/spot/trade/history-plan-order
spotCancelPlanOrders() 🔐 POST /api/v2/spot/trade/batch-cancel-plan-order
getSpotAccount() 🔐 GET /api/v2/spot/account/info
getSpotAccountAssets() 🔐 GET /api/v2/spot/account/assets
getSpotSubAccountAssets() 🔐 GET /api/v2/spot/account/subaccount-assets
spotModifyDepositAccount() 🔐 POST /api/v2/spot/wallet/modify-deposit-account
getSpotAccountBills() 🔐 GET /api/v2/spot/account/bills
spotTransfer() 🔐 POST /api/v2/spot/wallet/transfer
getSpotTransferableCoins() 🔐 GET /api/v2/spot/wallet/transfer-coin-info
spotSubTransfer() 🔐 POST /api/v2/spot/wallet/subaccount-transfer
getSpotTransferHistory() 🔐 GET /api/v2/spot/account/transferRecords
spotSwitchBGBDeduct() 🔐 POST /api/v2/spot/account/switch-deduct
spotWithdraw() 🔐 POST /api/v2/spot/wallet/withdrawal
getSpotDepositAddress() 🔐 GET /api/v2/spot/wallet/deposit-address
getSpotSubDepositAddress() 🔐 GET /api/v2/spot/wallet/subaccount-deposit-address
getSpotDepositHistory() 🔐 GET /api/v2/spot/wallet/deposit-records
getSpotBGBDeductInfo() 🔐 GET /api/v2/spot/account/deduct-info
spotCancelWithdrawal() 🔐 POST /api/v2/spot/wallet/cancel-withdrawal
getSpotWithdrawalHistory() 🔐 GET /api/v2/spot/wallet/withdrawal-records
getSpotMainSubTransferRecord() 🔐 GET /api/v2/spot/account/sub-main-trans-record
getSubAccountDepositRecords() 🔐 GET /api/v2/spot/wallet/subaccount-deposit-records
getFuturesVIPFeeRate() GET /api/v2/mix/market/vip-fee-rate
getFuturesTicker() GET /api/v2/mix/market/ticker
getFuturesAllTickers() GET /api/v2/mix/market/tickers
getFuturesMergeDepth() GET /api/v2/mix/market/merge-depth
getFuturesCandles() GET /api/v2/mix/market/candles
getFuturesHistoricCandles() GET /api/v2/mix/market/history-candles
getFuturesHistoricIndexPriceCandles() GET /api/v2/mix/market/history-index-candles
getFuturesHistoricMarkPriceCandles() GET /api/v2/mix/market/history-mark-candles
getFuturesRecentTrades() GET /api/v2/mix/market/fills
getFuturesHistoricTrades() GET /api/v2/mix/market/fills-history
getFuturesOpenInterest() GET /api/v2/mix/market/open-interest
getFuturesNextFundingTime() GET /api/v2/mix/market/funding-time
getFuturesSymbolPrice() GET /api/v2/mix/market/symbol-price
getFuturesHistoricFundingRates() GET /api/v2/mix/market/history-fund-rate
getFuturesCurrentFundingRate() GET /api/v2/mix/market/current-fund-rate
getFuturesContractConfig() GET /api/v2/mix/market/contracts
getFuturesAccountAsset() 🔐 GET /api/v2/mix/account/account
getFuturesAccountAssets() 🔐 GET /api/v2/mix/account/accounts
getFuturesSubAccountAssets() 🔐 GET /api/v2/mix/account/sub-account-assets
getFuturesOpenCount() 🔐 GET /api/v2/mix/account/open-count
setFuturesLeverage() 🔐 POST /api/v2/mix/account/set-leverage
setFuturesPositionAutoMargin() 🔐 POST /api/v2/mix/account/set-auto-margin
setFuturesPositionMargin() 🔐 POST /api/v2/mix/account/set-margin
setFuturesMarginMode() 🔐 POST /api/v2/mix/account/set-margin-mode
setFuturesPositionMode() 🔐 POST /api/v2/mix/account/set-position-mode
getFuturesAccountBills() 🔐 GET /api/v2/mix/account/bill
getFuturesPositionTier() GET /api/v2/mix/market/query-position-lever
getFuturesPosition() 🔐 GET /api/v2/mix/position/single-position
getFuturesPositions() 🔐 GET /api/v2/mix/position/all-position
getFuturesHistoricPositions() 🔐 GET /api/v2/mix/position/history-position
futuresSubmitOrder() 🔐 POST /api/v2/mix/order/place-order
futuresCancelOrder() 🔐 POST /api/v2/mix/order/cancel-order
futuresSubmitReversal() 🔐 POST /api/v2/mix/order/click-backhand
futuresBatchSubmitOrders() 🔐 POST /api/v2/mix/order/batch-place-order
futuresModifyOrder() 🔐 POST /api/v2/mix/order/modify-order
futuresBatchCancelOrders() 🔐 POST /api/v2/mix/order/batch-cancel-orders
futuresFlashClosePositions() 🔐 POST /api/v2/mix/order/close-positions
getFuturesOrder() 🔐 GET /api/v2/mix/order/detail
getFuturesFills() 🔐 GET /api/v2/mix/order/fills
getFuturesHistoricOrderFills() 🔐 GET /api/v2/mix/order/fill-history
getFuturesOpenOrders() 🔐 GET /api/v2/mix/order/orders-pending
getFuturesHistoricOrders() 🔐 GET /api/v2/mix/order/orders-history
futuresCancelAllOrders() 🔐 POST /api/v2/mix/order/cancel-all-orders
futuresSubmitPlanSubOrder() 🔐 POST /api/v2/mix/order/plan-sub-order
futuresSubmitTPSLOrder() 🔐 POST /api/v2/mix/order/place-tpsl-order
futuresSubmitPlanOrder() 🔐 POST /api/v2/mix/order/place-plan-order
futuresModifyTPSLPOrder() 🔐 POST /api/v2/mix/order/modify-tpsl-order
futuresModifyPlanOrder() 🔐 POST /api/v2/mix/order/modify-plan-order
futuresCancelPlanOrder() 🔐 POST /api/v2/mix/order/cancel-plan-order
getFuturesPlanOrders() 🔐 GET /api/v2/mix/order/orders-plan-pending
getFuturesHistoricPlanOrders() 🔐 GET /api/v2/mix/order/orders-plan-history
modifySubaccountEmail() 🔐 POST /api/v2/broker/account/modify-subaccount-email
getBrokerInfo() 🔐 GET /api/v2/broker/account/info
createSubaccount() 🔐 POST /api/v2/broker/account/create-subaccount
getSubaccounts() 🔐 GET /api/v2/broker/account/subaccount-list
modifySubaccount() 🔐 POST /api/v2/broker/account/modify-subaccount
getSubaccountEmail() 🔐 GET /api/v2/broker/account/subaccount-email
getSubaccountSpotAssets() 🔐 GET /api/v2/broker/account/subaccount-spot-assets
getSubaccountFuturesAssets() 🔐 GET /api/v2/broker/account/subaccount-future-assets
createSubaccountDepositAddress() 🔐 POST /api/v2/broker/account/subaccount-address
subaccountWithdrawal() 🔐 POST /api/v2/broker/account/subaccount-withdrawal
subaccountSetAutoTransfer() 🔐 POST /api/v2/broker/account/set-subaccount-autotransfer
subaccountDepositRecords() 🔐 POST /api/v2/broker/subaccount-deposit
subaccountWithdrawalRecords() 🔐 POST /api/v2/broker/subaccount-withdrawal
createSubaccountApiKey() 🔐 POST /api/v2/broker/manage/create-subaccount-apikey
getSubaccountApiKey() 🔐 GET /api/v2/broker/manage/subaccount-apikey-list
modifySubaccountApiKey() 🔐 POST /api/v2/broker/manage/modify-subaccount-apikey
getMarginCurrencies() GET /api/v2/margin/currencies
getMarginBorrowHistory() 🔐 GET /api/v2/margin/${marginType}/borrow-history
getMarginRepayHistory() 🔐 GET /api/v2/margin/${marginType}/repay-history
getMarginInterestHistory() 🔐 GET /api/v2/margin/${marginType}/interest-history
getMarginLiquidationHistory() 🔐 GET /api/v2/margin/${marginType}/liquidation-history
getMarginFinancialHistory() 🔐 GET /api/v2/margin/${marginType}/financial-records
getMarginAccountAssets() 🔐 GET /api/v2/margin/${marginType}/account/assets
marginBorrow() 🔐 POST /api/v2/margin/${marginType}/account/borrow
marginRepay() 🔐 POST /api/v2/margin/${marginType}/account/repay
getMarginRiskRate() 🔐 GET /api/v2/margin/${marginType}/account/risk-rate
getMarginMaxBorrowable() 🔐 GET /api/v2/margin/${marginType}/account/max-borrowable-amount
getMarginMaxTransferable() 🔐 GET /api/v2/margin/${marginType}/account/max-transfer-out-amount
getMarginInterestRateAndMaxBorrowable() 🔐 GET /api/v2/margin/${marginType}/interest-rate-and-limit
getMarginTierConfiguration() 🔐 GET /api/v2/margin/${marginType}/tier-data
marginFlashRepay() 🔐 POST /api/v2/margin/${marginType}/account/flash-repay
getMarginFlashRepayResult() 🔐 GET /api/v2/margin/${marginType}/account/query-flash-repay-status
marginSubmitOrder() 🔐 POST /api/v2/margin/${marginType}/place-order
marginBatchSubmitOrders() 🔐 POST /api/v2/margin/${marginType}/batch-place-order
marginCancelOrder() 🔐 POST /api/v2/margin/${marginType}/cancel-order
marginBatchCancelOrders() 🔐 POST /api/v2/margin/${marginType}/batch-cancel-order
getMarginOpenOrders() 🔐 GET /api/v2/margin/${marginType}/open-orders
getMarginHistoricOrders() 🔐 GET /api/v2/margin/${marginType}/history-orders
getMarginHistoricOrderFills() 🔐 GET /api/v2/margin/${marginType}/fills
getMarginLiquidationOrders() 🔐 GET /api/v2/margin/${marginType}/liquidation-order
getFuturesTraderCurrentOrder() 🔐 GET /api/v2/copy/mix-trader/order-current-track
getFuturesTraderHistoryOrders() 🔐 GET /api/v2/copy/mix-trader/order-history-track
modifyFuturesTraderOrderTPSL() 🔐 POST /api/v2/copy/mix-trader/order-modify-tpsl
getFuturesTraderOrder() 🔐 GET /api/v2/copy/mix-trader/order-total-detail
getFuturesTraderProfitHistory() 🔐 GET /api/v2/copy/mix-trader/profit-history-summarys
getFuturesTraderProfitShareHistory() 🔐 GET /api/v2/copy/mix-trader/profit-history-details
closeFuturesTraderOrder() 🔐 POST /api/v2/copy/mix-trader/order-close-positions
getFuturesTraderProfitShare() 🔐 GET /api/v2/copy/mix-trader/profit-details
getFuturesTraderProfitShareGroup() 🔐 GET /api/v2/copy/mix-trader/profits-group-coin-date
getFuturesTraderSymbolSettings() 🔐 GET /api/v2/copy/mix-trader/config-query-symbols
updateFuturesTraderSymbolSettings() 🔐 POST /api/v2/copy/mix-trader/config-setting-symbols
updateFuturesTraderGlobalSettings() 🔐 POST /api/v2/copy/mix-trader/config-settings-base
getFuturesTraderFollowers() 🔐 GET /api/v2/copy/mix-trader/config-query-followers
removeFuturesTraderFollower() 🔐 POST /api/v2/copy/mix-trader/config-remove-follower
getFuturesFollowerCurrentOrders() 🔐 GET /api/v2/copy/mix-follower/query-current-orders
getFuturesFollowerHistoryOrders() 🔐 GET /api/v2/copy/mix-follower/query-history-orders
updateFuturesFollowerTPSL() 🔐 POST /api/v2/copy/mix-follower/setting-tpsl
updateFuturesFollowerSettings() 🔐 POST /api/v2/copy/mix-follower/settings
getFuturesFollowerSettings() 🔐 GET /api/v2/copy/mix-follower/query-settings
closeFuturesFollowerPositions() 🔐 POST /api/v2/copy/mix-follower/close-positions
getFuturesFollowerTraders() 🔐 GET /api/v2/copy/mix-follower/query-traders
getFuturesFollowerFollowLimit() 🔐 GET /api/v2/copy/mix-follower/query-quantity-limit
unfollowFuturesTrader() 🔐 POST /api/v2/copy/mix-follower/cancel-trader
getBrokerTraders() 🔐 GET /api/v2/copy/mix-broker/query-traders
getBrokerTradersHistoricalOrders() 🔐 GET /api/v2/copy/mix-broker/query-history-traces
getBrokerTradersPendingOrders() 🔐 GET /api/v2/copy/mix-broker/query-current-traces
getSpotTraderProfit() 🔐 GET /api/v2/copy/spot-trader/profit-summarys
getSpotTraderHistoryProfit() 🔐 GET /api/v2/copy/spot-trader/profit-history-details
getSpotTraderUnrealizedProfit() 🔐 GET /api/v2/copy/spot-trader/profit-details
getSpotTraderOrder() 🔐 GET /api/v2/copy/spot-trader/order-total-detail
modifySpotTraderOrderTPSL() 🔐 POST /api/v2/copy/spot-trader/order-modify-tpsl
getSpotTraderHistoryOrders() 🔐 GET /api/v2/copy/spot-trader/order-history-track
getSpotTraderCurrentOrders() 🔐 GET /api/v2/copy/spot-trader/order-current-track
sellSpotTrader() 🔐 POST /api/v2/copy/spot-trader/order-close-tracking
getSpotTraderSymbolSettings() 🔐 POST /api/v2/copy/spot-trader/config-setting-symbols
removeSpotTraderFollowers() 🔐 POST /api/v2/copy/spot-trader/config-remove-follower
getSpotTraderConfiguration() 🔐 GET /api/v2/copy/spot-trader/config-query-settings
getSpotTraderFollowers() 🔐 GET /api/v2/copy/spot-trader/config-query-followers
cancelSpotFollowerOrder() 🔐 POST /api/v2/copy/spot-follower/stop-order
updateSpotFollowerSettings() 🔐 POST /api/v2/copy/spot-follower/settings
updateSpotFollowerTPSL() 🔐 POST /api/v2/copy/spot-follower/setting-tpsl
getSpotFollowerTraders() 🔐 GET /api/v2/copy/spot-follower/query-traders
getSpotFollowerCurrentTraderSymbols() 🔐 GET /api/v2/copy/spot-follower/query-trader-symbols
getSpotFollowerSettings() 🔐 GET /api/v2/copy/spot-follower/query-settings
getSpotFollowerHistoryOrders() 🔐 GET /api/v2/copy/spot-follower/query-history-orders
getSpotFollowerOpenOrders() 🔐 GET /api/v2/copy/spot-follower/query-current-orders
sellSpotFollower() 🔐 POST /api/v2/copy/spot-follower/order-close-tracking
unfollowSpotTrader() 🔐 POST /api/v2/copy/spot-follower/cancel-trader
getEarnSavingsProducts() 🔐 GET /api/v2/earn/savings/product
getEarnSavingsAccount() 🔐 GET /api/v2/earn/savings/account
getEarnSavingsAssets() 🔐 GET /api/v2/earn/savings/assets
getEarnSavingsRecords() 🔐 GET /api/v2/earn/savings/records
getEarnSavingsSubscription() 🔐 GET /api/v2/earn/savings/subscribe-info
earnSubscribeSavings() 🔐 POST /api/v2/earn/savings/subscribe
getEarnSavingsSubscriptionResult() 🔐 GET /api/v2/earn/savings/subscribe-result
getEarnSavingsRedemptionResult() 🔐 GET /api/v2/earn/savings/redeem-result
getEarnAccount() 🔐 GET /api/v2/earn/account/assets
getSharkfinProducts() 🔐 GET /api/v2/earn/sharkfin/product
getSharkfinAccount() 🔐 GET /api/v2/earn/sharkfin/account
getSharkfinAssets() 🔐 GET /api/v2/earn/sharkfin/assets
getSharkfinRecords() 🔐 GET /api/v2/earn/sharkfin/records
getSharkfinSubscription() 🔐 GET /api/v2/earn/sharkfin/subscribe-info
subscribeSharkfin() 🔐 POST /api/v2/earn/sharkfin/subscribe
getSharkfinSubscriptionResult() 🔐 GET /api/v2/earn/sharkfin/subscribe-result
getLoanCurrencies() GET /api/v2/earn/loan/public/coinInfos
getLoanEstInterestAndBorrowable() GET /api/v2/earn/loan/public/hour-interest
borrowLoan() 🔐 POST /api/v2/earn/loan/borrow
getOngoingLoanOrders() 🔐 GET /api/v2/earn/loan/ongoing-orders
repayLoan() 🔐 POST /api/v2/earn/loan/repay
getRepayHistory() 🔐 GET /api/v2/earn/loan/repay-history
updateLoanPledgeRate() 🔐 POST /api/v2/earn/loan/revise-pledge
getLoanPledgeRateHistory() 🔐 GET /api/v2/earn/loan/revise-history
getLoanHistory() 🔐 GET /api/v2/earn/loan/borrow-history
getLoanDebts() 🔐 GET /api/v2/earn/loan/debts
getLoanLiquidationRecords() 🔐 GET /api/v2/earn/loan/reduces