code/bybit-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

only emoji

Browse Source
This commit is contained in:
Jerko J
2024-08-29 16:14:57 +02:00
parent 3e12a89b5e
commit b4889c4e16
1 changed files with 178 additions and 178 deletions
Download Patch File Download Diff File Expand all files Collapse all files

356
docs/endpointsFunctionList.md
View File

@@ -41,154 +41,154 @@ This table includes all endpoints from the official Exchange API docs and corres
| Function | Authentication | HTTP Method | Endpoint | | Function | Authentication | HTTP Method | Endpoint |
| -------- | :------: | :------: | -------- | | -------- | :------: | :------: | -------- |
| `fetchServerTime()` | no | GET | `/v5/market/time` | | `fetchServerTime()` | | GET | `/v5/market/time` |
| `getServerTime()` | no | GET | `/v5/market/time` | | `getServerTime()` | | GET | `/v5/market/time` |
| `requestDemoTradingFunds()` | :closed_lock_with_key: YES | POST | `/v5/account/demo-apply-money` | | `requestDemoTradingFunds()` | :closed_lock_with_key: | POST | `/v5/account/demo-apply-money` |
| `getKline()` | no | GET | `/v5/market/kline` | | `getKline()` | | GET | `/v5/market/kline` |
| `getMarkPriceKline()` | no | GET | `/v5/market/mark-price-kline` | | `getMarkPriceKline()` | | GET | `/v5/market/mark-price-kline` |
| `getIndexPriceKline()` | no | GET | `/v5/market/index-price-kline` | | `getIndexPriceKline()` | | GET | `/v5/market/index-price-kline` |
| `getPremiumIndexPriceKline()` | no | GET | `/v5/market/premium-index-price-kline` | | `getPremiumIndexPriceKline()` | | GET | `/v5/market/premium-index-price-kline` |
| `getOrderbook()` | no | GET | `/v5/market/orderbook` | | `getOrderbook()` | | GET | `/v5/market/orderbook` |
| `getTickers()` | no | GET | `/v5/market/tickers` | | `getTickers()` | | GET | `/v5/market/tickers` |
| `getTickers()` | no | GET | `/v5/market/tickers` | | `getTickers()` | | GET | `/v5/market/tickers` |
| `getTickers()` | no | GET | `/v5/market/tickers` | | `getTickers()` | | GET | `/v5/market/tickers` |
| `getTickers()` | no | GET | `/v5/market/tickers` | | `getTickers()` | | GET | `/v5/market/tickers` |
| `getFundingRateHistory()` | no | GET | `/v5/market/funding/history` | | `getFundingRateHistory()` | | GET | `/v5/market/funding/history` |
| `getPublicTradingHistory()` | no | GET | `/v5/market/recent-trade` | | `getPublicTradingHistory()` | | GET | `/v5/market/recent-trade` |
| `getOpenInterest()` | no | GET | `/v5/market/open-interest` | | `getOpenInterest()` | | GET | `/v5/market/open-interest` |
| `getHistoricalVolatility()` | no | GET | `/v5/market/historical-volatility` | | `getHistoricalVolatility()` | | GET | `/v5/market/historical-volatility` |
| `getInsurance()` | no | GET | `/v5/market/insurance` | | `getInsurance()` | | GET | `/v5/market/insurance` |
| `getRiskLimit()` | no | GET | `/v5/market/risk-limit` | | `getRiskLimit()` | | GET | `/v5/market/risk-limit` |
| `getOptionDeliveryPrice()` | no | GET | `/v5/market/delivery-price` | | `getOptionDeliveryPrice()` | | GET | `/v5/market/delivery-price` |
| `getDeliveryPrice()` | no | GET | `/v5/market/delivery-price` | | `getDeliveryPrice()` | | GET | `/v5/market/delivery-price` |
| `getLongShortRatio()` | no | GET | `/v5/market/account-ratio` | | `getLongShortRatio()` | | GET | `/v5/market/account-ratio` |
| `submitOrder()` | :closed_lock_with_key: YES | POST | `/v5/order/create` | | `submitOrder()` | :closed_lock_with_key: | POST | `/v5/order/create` |
| `amendOrder()` | :closed_lock_with_key: YES | POST | `/v5/order/amend` | | `amendOrder()` | :closed_lock_with_key: | POST | `/v5/order/amend` |
| `cancelOrder()` | :closed_lock_with_key: YES | POST | `/v5/order/cancel` | | `cancelOrder()` | :closed_lock_with_key: | POST | `/v5/order/cancel` |
| `getActiveOrders()` | :closed_lock_with_key: YES | GET | `/v5/order/realtime` | | `getActiveOrders()` | :closed_lock_with_key: | GET | `/v5/order/realtime` |
| `cancelAllOrders()` | :closed_lock_with_key: YES | POST | `/v5/order/cancel-all` | | `cancelAllOrders()` | :closed_lock_with_key: | POST | `/v5/order/cancel-all` |
| `getHistoricOrders()` | :closed_lock_with_key: YES | GET | `/v5/order/history` | | `getHistoricOrders()` | :closed_lock_with_key: | GET | `/v5/order/history` |
| `batchSubmitOrders()` | :closed_lock_with_key: YES | POST | `/v5/order/create-batch` | | `batchSubmitOrders()` | :closed_lock_with_key: | POST | `/v5/order/create-batch` |
| `batchAmendOrders()` | :closed_lock_with_key: YES | POST | `/v5/order/amend-batch` | | `batchAmendOrders()` | :closed_lock_with_key: | POST | `/v5/order/amend-batch` |
| `batchCancelOrders()` | :closed_lock_with_key: YES | POST | `/v5/order/cancel-batch` | | `batchCancelOrders()` | :closed_lock_with_key: | POST | `/v5/order/cancel-batch` |
| `getSpotBorrowCheck()` | :closed_lock_with_key: YES | GET | `/v5/order/spot-borrow-check` | | `getSpotBorrowCheck()` | :closed_lock_with_key: | GET | `/v5/order/spot-borrow-check` |
| `setDisconnectCancelAllWindow()` | :closed_lock_with_key: YES | POST | `/v5/order/disconnected-cancel-all` | | `setDisconnectCancelAllWindow()` | :closed_lock_with_key: | POST | `/v5/order/disconnected-cancel-all` |
| `setDisconnectCancelAllWindowV2()` | :closed_lock_with_key: YES | POST | `/v5/order/disconnected-cancel-all` | | `setDisconnectCancelAllWindowV2()` | :closed_lock_with_key: | POST | `/v5/order/disconnected-cancel-all` |
| `getPositionInfo()` | :closed_lock_with_key: YES | GET | `/v5/position/list` | | `getPositionInfo()` | :closed_lock_with_key: | GET | `/v5/position/list` |
| `setLeverage()` | :closed_lock_with_key: YES | POST | `/v5/position/set-leverage` | | `setLeverage()` | :closed_lock_with_key: | POST | `/v5/position/set-leverage` |
| `switchIsolatedMargin()` | :closed_lock_with_key: YES | POST | `/v5/position/switch-isolated` | | `switchIsolatedMargin()` | :closed_lock_with_key: | POST | `/v5/position/switch-isolated` |
| `setTPSLMode()` | :closed_lock_with_key: YES | POST | `/v5/position/set-tpsl-mode` | | `setTPSLMode()` | :closed_lock_with_key: | POST | `/v5/position/set-tpsl-mode` |
| `switchPositionMode()` | :closed_lock_with_key: YES | POST | `/v5/position/switch-mode` | | `switchPositionMode()` | :closed_lock_with_key: | POST | `/v5/position/switch-mode` |
| `setRiskLimit()` | :closed_lock_with_key: YES | POST | `/v5/position/set-risk-limit` | | `setRiskLimit()` | :closed_lock_with_key: | POST | `/v5/position/set-risk-limit` |
| `setTradingStop()` | :closed_lock_with_key: YES | POST | `/v5/position/trading-stop` | | `setTradingStop()` | :closed_lock_with_key: | POST | `/v5/position/trading-stop` |
| `setAutoAddMargin()` | :closed_lock_with_key: YES | POST | `/v5/position/set-auto-add-margin` | | `setAutoAddMargin()` | :closed_lock_with_key: | POST | `/v5/position/set-auto-add-margin` |
| `addOrReduceMargin()` | :closed_lock_with_key: YES | POST | `/v5/position/add-margin` | | `addOrReduceMargin()` | :closed_lock_with_key: | POST | `/v5/position/add-margin` |
| `getExecutionList()` | :closed_lock_with_key: YES | GET | `/v5/execution/list` | | `getExecutionList()` | :closed_lock_with_key: | GET | `/v5/execution/list` |
| `getClosedPnL()` | :closed_lock_with_key: YES | GET | `/v5/position/closed-pnl` | | `getClosedPnL()` | :closed_lock_with_key: | GET | `/v5/position/closed-pnl` |
| `movePosition()` | :closed_lock_with_key: YES | POST | `/v5/position/move-positions` | | `movePosition()` | :closed_lock_with_key: | POST | `/v5/position/move-positions` |
| `getMovePositionHistory()` | :closed_lock_with_key: YES | GET | `/v5/position/move-history` | | `getMovePositionHistory()` | :closed_lock_with_key: | GET | `/v5/position/move-history` |
| `confirmNewRiskLimit()` | :closed_lock_with_key: YES | POST | `/v5/position/confirm-pending-mmr` | | `confirmNewRiskLimit()` | :closed_lock_with_key: | POST | `/v5/position/confirm-pending-mmr` |
| `getPreUpgradeOrderHistory()` | :closed_lock_with_key: YES | GET | `/v5/pre-upgrade/order/history` | | `getPreUpgradeOrderHistory()` | :closed_lock_with_key: | GET | `/v5/pre-upgrade/order/history` |
| `getPreUpgradeTradeHistory()` | :closed_lock_with_key: YES | GET | `/v5/pre-upgrade/execution/list` | | `getPreUpgradeTradeHistory()` | :closed_lock_with_key: | GET | `/v5/pre-upgrade/execution/list` |
| `getPreUpgradeClosedPnl()` | :closed_lock_with_key: YES | GET | `/v5/pre-upgrade/position/closed-pnl` | | `getPreUpgradeClosedPnl()` | :closed_lock_with_key: | GET | `/v5/pre-upgrade/position/closed-pnl` |
| `getPreUpgradeTransactions()` | :closed_lock_with_key: YES | GET | `/v5/pre-upgrade/account/transaction-log` | | `getPreUpgradeTransactions()` | :closed_lock_with_key: | GET | `/v5/pre-upgrade/account/transaction-log` |
| `getPreUpgradeOptionDeliveryRecord()` | :closed_lock_with_key: YES | GET | `/v5/pre-upgrade/asset/delivery-record` | | `getPreUpgradeOptionDeliveryRecord()` | :closed_lock_with_key: | GET | `/v5/pre-upgrade/asset/delivery-record` |
| `getPreUpgradeUSDCSessionSettlements()` | :closed_lock_with_key: YES | GET | `/v5/pre-upgrade/asset/settlement-record` | | `getPreUpgradeUSDCSessionSettlements()` | :closed_lock_with_key: | GET | `/v5/pre-upgrade/asset/settlement-record` |
| `getWalletBalance()` | :closed_lock_with_key: YES | GET | `/v5/account/wallet-balance` | | `getWalletBalance()` | :closed_lock_with_key: | GET | `/v5/account/wallet-balance` |
| `upgradeToUnifiedAccount()` | :closed_lock_with_key: YES | POST | `/v5/account/upgrade-to-uta` | | `upgradeToUnifiedAccount()` | :closed_lock_with_key: | POST | `/v5/account/upgrade-to-uta` |
| `getBorrowHistory()` | :closed_lock_with_key: YES | GET | `/v5/account/borrow-history` | | `getBorrowHistory()` | :closed_lock_with_key: | GET | `/v5/account/borrow-history` |
| `repayLiability()` | :closed_lock_with_key: YES | POST | `/v5/account/quick-repayment` | | `repayLiability()` | :closed_lock_with_key: | POST | `/v5/account/quick-repayment` |
| `setCollateralCoin()` | :closed_lock_with_key: YES | POST | `/v5/account/set-collateral-switch` | | `setCollateralCoin()` | :closed_lock_with_key: | POST | `/v5/account/set-collateral-switch` |
| `batchSetCollateralCoin()` | :closed_lock_with_key: YES | POST | `/v5/account/set-collateral-switch-batch` | | `batchSetCollateralCoin()` | :closed_lock_with_key: | POST | `/v5/account/set-collateral-switch-batch` |
| `getCollateralInfo()` | :closed_lock_with_key: YES | GET | `/v5/account/collateral-info` | | `getCollateralInfo()` | :closed_lock_with_key: | GET | `/v5/account/collateral-info` |
| `getCoinGreeks()` | :closed_lock_with_key: YES | GET | `/v5/asset/coin-greeks` | | `getCoinGreeks()` | :closed_lock_with_key: | GET | `/v5/asset/coin-greeks` |
| `getFeeRate()` | :closed_lock_with_key: YES | GET | `/v5/account/fee-rate` | | `getFeeRate()` | :closed_lock_with_key: | GET | `/v5/account/fee-rate` |
| `getAccountInfo()` | :closed_lock_with_key: YES | GET | `/v5/account/info` | | `getAccountInfo()` | :closed_lock_with_key: | GET | `/v5/account/info` |
| `getTransactionLog()` | :closed_lock_with_key: YES | GET | `/v5/account/transaction-log` | | `getTransactionLog()` | :closed_lock_with_key: | GET | `/v5/account/transaction-log` |
| `getClassicTransactionLogs()` | :closed_lock_with_key: YES | GET | `/v5/account/contract-transaction-log` | | `getClassicTransactionLogs()` | :closed_lock_with_key: | GET | `/v5/account/contract-transaction-log` |
| `getSMPGroup()` | :closed_lock_with_key: YES | GET | `/v5/account/smp-group` | | `getSMPGroup()` | :closed_lock_with_key: | GET | `/v5/account/smp-group` |
| `setMarginMode()` | :closed_lock_with_key: YES | POST | `/v5/account/set-margin-mode` | | `setMarginMode()` | :closed_lock_with_key: | POST | `/v5/account/set-margin-mode` |
| `setSpotHedging()` | :closed_lock_with_key: YES | POST | `/v5/account/set-hedging-mode` | | `setSpotHedging()` | :closed_lock_with_key: | POST | `/v5/account/set-hedging-mode` |
| `setMMP()` | :closed_lock_with_key: YES | POST | `/v5/account/mmp-modify` | | `setMMP()` | :closed_lock_with_key: | POST | `/v5/account/mmp-modify` |
| `resetMMP()` | :closed_lock_with_key: YES | POST | `/v5/account/mmp-reset` | | `resetMMP()` | :closed_lock_with_key: | POST | `/v5/account/mmp-reset` |
| `getMMPState()` | :closed_lock_with_key: YES | GET | `/v5/account/mmp-state` | | `getMMPState()` | :closed_lock_with_key: | GET | `/v5/account/mmp-state` |
| `getDCPInfo()` | :closed_lock_with_key: YES | GET | `/v5/account/query-dcp-info` | | `getDCPInfo()` | :closed_lock_with_key: | GET | `/v5/account/query-dcp-info` |
| `getCoinExchangeRecords()` | :closed_lock_with_key: YES | GET | `/v5/asset/exchange/order-record` | | `getCoinExchangeRecords()` | :closed_lock_with_key: | GET | `/v5/asset/exchange/order-record` |
| `getDeliveryRecord()` | :closed_lock_with_key: YES | GET | `/v5/asset/delivery-record` | | `getDeliveryRecord()` | :closed_lock_with_key: | GET | `/v5/asset/delivery-record` |
| `getSettlementRecords()` | :closed_lock_with_key: YES | GET | `/v5/asset/settlement-record` | | `getSettlementRecords()` | :closed_lock_with_key: | GET | `/v5/asset/settlement-record` |
| `getAssetInfo()` | :closed_lock_with_key: YES | GET | `/v5/asset/transfer/query-asset-info` | | `getAssetInfo()` | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-asset-info` |
| `getAllCoinsBalance()` | :closed_lock_with_key: YES | GET | `/v5/asset/transfer/query-account-coins-balance` | | `getAllCoinsBalance()` | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-account-coins-balance` |
| `getCoinBalance()` | :closed_lock_with_key: YES | GET | `/v5/asset/transfer/query-account-coin-balance` | | `getCoinBalance()` | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-account-coin-balance` |
| `getTransferableCoinList()` | :closed_lock_with_key: YES | GET | `/v5/asset/transfer/query-transfer-coin-list` | | `getTransferableCoinList()` | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-transfer-coin-list` |
| `createInternalTransfer()` | :closed_lock_with_key: YES | POST | `/v5/asset/transfer/inter-transfer` | | `createInternalTransfer()` | :closed_lock_with_key: | POST | `/v5/asset/transfer/inter-transfer` |
| `getInternalTransferRecords()` | :closed_lock_with_key: YES | GET | `/v5/asset/transfer/query-inter-transfer-list` | | `getInternalTransferRecords()` | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-inter-transfer-list` |
| `getSubUID()` | :closed_lock_with_key: YES | GET | `/v5/asset/transfer/query-sub-member-list` | | `getSubUID()` | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-sub-member-list` |
| `enableUniversalTransferForSubUIDs()` | :closed_lock_with_key: YES | POST | `/v5/asset/transfer/save-transfer-sub-member` | | `enableUniversalTransferForSubUIDs()` | :closed_lock_with_key: | POST | `/v5/asset/transfer/save-transfer-sub-member` |
| `createUniversalTransfer()` | :closed_lock_with_key: YES | POST | `/v5/asset/transfer/universal-transfer` | | `createUniversalTransfer()` | :closed_lock_with_key: | POST | `/v5/asset/transfer/universal-transfer` |
| `getUniversalTransferRecords()` | :closed_lock_with_key: YES | GET | `/v5/asset/transfer/query-universal-transfer-list` | | `getUniversalTransferRecords()` | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-universal-transfer-list` |
| `getAllowedDepositCoinInfo()` | no | GET | `/v5/asset/deposit/query-allowed-list` | | `getAllowedDepositCoinInfo()` | | GET | `/v5/asset/deposit/query-allowed-list` |
| `setDepositAccount()` | :closed_lock_with_key: YES | POST | `/v5/asset/deposit/deposit-to-account` | | `setDepositAccount()` | :closed_lock_with_key: | POST | `/v5/asset/deposit/deposit-to-account` |
| `getDepositRecords()` | :closed_lock_with_key: YES | GET | `/v5/asset/deposit/query-record` | | `getDepositRecords()` | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-record` |
| `getSubAccountDepositRecords()` | :closed_lock_with_key: YES | GET | `/v5/asset/deposit/query-sub-member-record` | | `getSubAccountDepositRecords()` | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-sub-member-record` |
| `getInternalDepositRecords()` | :closed_lock_with_key: YES | GET | `/v5/asset/deposit/query-internal-record` | | `getInternalDepositRecords()` | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-internal-record` |
| `getMasterDepositAddress()` | :closed_lock_with_key: YES | GET | `/v5/asset/deposit/query-address` | | `getMasterDepositAddress()` | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-address` |
| `getSubDepositAddress()` | :closed_lock_with_key: YES | GET | `/v5/asset/deposit/query-sub-member-address` | | `getSubDepositAddress()` | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-sub-member-address` |
| `querySubMemberAddress()` | :closed_lock_with_key: YES | GET | `/v5/asset/deposit/query-sub-member-address` | | `querySubMemberAddress()` | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-sub-member-address` |
| `getCoinInfo()` | :closed_lock_with_key: YES | GET | `/v5/asset/coin/query-info` | | `getCoinInfo()` | :closed_lock_with_key: | GET | `/v5/asset/coin/query-info` |
| `getWithdrawalRecords()` | :closed_lock_with_key: YES | GET | `/v5/asset/withdraw/query-record` | | `getWithdrawalRecords()` | :closed_lock_with_key: | GET | `/v5/asset/withdraw/query-record` |
| `getWithdrawableAmount()` | :closed_lock_with_key: YES | GET | `/v5/asset/withdraw/withdrawable-amount` | | `getWithdrawableAmount()` | :closed_lock_with_key: | GET | `/v5/asset/withdraw/withdrawable-amount` |
| `getExchangeEntities()` | :closed_lock_with_key: YES | GET | `/v5/asset/withdraw/vasp/list` | | `getExchangeEntities()` | :closed_lock_with_key: | GET | `/v5/asset/withdraw/vasp/list` |
| `submitWithdrawal()` | :closed_lock_with_key: YES | POST | `/v5/asset/withdraw/create` | | `submitWithdrawal()` | :closed_lock_with_key: | POST | `/v5/asset/withdraw/create` |
| `cancelWithdrawal()` | :closed_lock_with_key: YES | POST | `/v5/asset/withdraw/cancel` | | `cancelWithdrawal()` | :closed_lock_with_key: | POST | `/v5/asset/withdraw/cancel` |
| `getConvertCoins()` | :closed_lock_with_key: YES | GET | `/v5/asset/exchange/query-coin-list` | | `getConvertCoins()` | :closed_lock_with_key: | GET | `/v5/asset/exchange/query-coin-list` |
| `requestConvertQuote()` | :closed_lock_with_key: YES | POST | `/v5/asset/exchange/quote-apply` | | `requestConvertQuote()` | :closed_lock_with_key: | POST | `/v5/asset/exchange/quote-apply` |
| `confirmConvertQuote()` | :closed_lock_with_key: YES | POST | `/v5/asset/exchange/convert-execute` | | `confirmConvertQuote()` | :closed_lock_with_key: | POST | `/v5/asset/exchange/convert-execute` |
| `getConvertStatus()` | :closed_lock_with_key: YES | GET | `/v5/asset/exchange/convert-result-query` | | `getConvertStatus()` | :closed_lock_with_key: | GET | `/v5/asset/exchange/convert-result-query` |
| `getConvertHistory()` | :closed_lock_with_key: YES | GET | `/v5/asset/exchange/query-convert-history` | | `getConvertHistory()` | :closed_lock_with_key: | GET | `/v5/asset/exchange/query-convert-history` |
| `createSubMember()` | :closed_lock_with_key: YES | POST | `/v5/user/create-sub-member` | | `createSubMember()` | :closed_lock_with_key: | POST | `/v5/user/create-sub-member` |
| `createSubUIDAPIKey()` | :closed_lock_with_key: YES | POST | `/v5/user/create-sub-api` | | `createSubUIDAPIKey()` | :closed_lock_with_key: | POST | `/v5/user/create-sub-api` |
| `getSubUIDList()` | :closed_lock_with_key: YES | GET | `/v5/user/query-sub-members` | | `getSubUIDList()` | :closed_lock_with_key: | GET | `/v5/user/query-sub-members` |
| `getSubUIDListUnlimited()` | :closed_lock_with_key: YES | GET | `/v5/user/submembers` | | `getSubUIDListUnlimited()` | :closed_lock_with_key: | GET | `/v5/user/submembers` |
| `getSubAccountAllApiKeys()` | :closed_lock_with_key: YES | GET | `/v5/user/sub-apikeys` | | `getSubAccountAllApiKeys()` | :closed_lock_with_key: | GET | `/v5/user/sub-apikeys` |
| `setSubUIDFrozenState()` | :closed_lock_with_key: YES | POST | `/v5/user/frozen-sub-member` | | `setSubUIDFrozenState()` | :closed_lock_with_key: | POST | `/v5/user/frozen-sub-member` |
| `getQueryApiKey()` | :closed_lock_with_key: YES | GET | `/v5/user/query-api` | | `getQueryApiKey()` | :closed_lock_with_key: | GET | `/v5/user/query-api` |
| `getUIDWalletType()` | :closed_lock_with_key: YES | GET | `/v5/user/query-api` | | `getUIDWalletType()` | :closed_lock_with_key: | GET | `/v5/user/query-api` |
| `updateMasterApiKey()` | :closed_lock_with_key: YES | POST | `/v5/user/update-api` | | `updateMasterApiKey()` | :closed_lock_with_key: | POST | `/v5/user/update-api` |
| `updateSubApiKey()` | :closed_lock_with_key: YES | POST | `/v5/user/update-sub-api` | | `updateSubApiKey()` | :closed_lock_with_key: | POST | `/v5/user/update-sub-api` |
| `deleteMasterApiKey()` | :closed_lock_with_key: YES | POST | `/v5/user/delete-api` | | `deleteMasterApiKey()` | :closed_lock_with_key: | POST | `/v5/user/delete-api` |
| `deleteSubApiKey()` | :closed_lock_with_key: YES | POST | `/v5/user/delete-sub-api` | | `deleteSubApiKey()` | :closed_lock_with_key: | POST | `/v5/user/delete-sub-api` |
| `deleteSubMember()` | :closed_lock_with_key: YES | POST | `/v5/user/del-submember` | | `deleteSubMember()` | :closed_lock_with_key: | POST | `/v5/user/del-submember` |
| `getAffiliateUserInfo()` | :closed_lock_with_key: YES | GET | `/v5/user/aff-customer-info` | | `getAffiliateUserInfo()` | :closed_lock_with_key: | GET | `/v5/user/aff-customer-info` |
| `getLeveragedTokenInfo()` | no | GET | `/v5/spot-lever-token/info` | | `getLeveragedTokenInfo()` | | GET | `/v5/spot-lever-token/info` |
| `getLeveragedTokenMarket()` | no | GET | `/v5/spot-lever-token/reference` | | `getLeveragedTokenMarket()` | | GET | `/v5/spot-lever-token/reference` |
| `purchaseSpotLeveragedToken()` | :closed_lock_with_key: YES | POST | `/v5/spot-lever-token/purchase` | | `purchaseSpotLeveragedToken()` | :closed_lock_with_key: | POST | `/v5/spot-lever-token/purchase` |
| `redeemSpotLeveragedToken()` | :closed_lock_with_key: YES | POST | `/v5/spot-lever-token/redeem` | | `redeemSpotLeveragedToken()` | :closed_lock_with_key: | POST | `/v5/spot-lever-token/redeem` |
| `getSpotLeveragedTokenOrderHistory()` | :closed_lock_with_key: YES | GET | `/v5/spot-lever-token/order-record` | | `getSpotLeveragedTokenOrderHistory()` | :closed_lock_with_key: | GET | `/v5/spot-lever-token/order-record` |
| `getVIPMarginData()` | no | GET | `/v5/spot-margin-trade/data` | | `getVIPMarginData()` | | GET | `/v5/spot-margin-trade/data` |
| `getHistoricalInterestRate()` | :closed_lock_with_key: YES | GET | `/v5/spot-margin-trade/interest-rate-history` | | `getHistoricalInterestRate()` | :closed_lock_with_key: | GET | `/v5/spot-margin-trade/interest-rate-history` |
| `toggleSpotMarginTrade()` | :closed_lock_with_key: YES | POST | `/v5/spot-margin-trade/switch-mode` | | `toggleSpotMarginTrade()` | :closed_lock_with_key: | POST | `/v5/spot-margin-trade/switch-mode` |
| `setSpotMarginLeverage()` | :closed_lock_with_key: YES | POST | `/v5/spot-margin-trade/set-leverage` | | `setSpotMarginLeverage()` | :closed_lock_with_key: | POST | `/v5/spot-margin-trade/set-leverage` |
| `getSpotMarginState()` | :closed_lock_with_key: YES | GET | `/v5/spot-margin-trade/state` | | `getSpotMarginState()` | :closed_lock_with_key: | GET | `/v5/spot-margin-trade/state` |
| `getSpotMarginCoinInfo()` | :closed_lock_with_key: YES | GET | `/v5/spot-cross-margin-trade/pledge-token` | | `getSpotMarginCoinInfo()` | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/pledge-token` |
| `getSpotMarginBorrowableCoinInfo()` | :closed_lock_with_key: YES | GET | `/v5/spot-cross-margin-trade/borrow-token` | | `getSpotMarginBorrowableCoinInfo()` | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/borrow-token` |
| `getSpotMarginInterestAndQuota()` | :closed_lock_with_key: YES | GET | `/v5/spot-cross-margin-trade/loan-info` | | `getSpotMarginInterestAndQuota()` | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/loan-info` |
| `getSpotMarginLoanAccountInfo()` | :closed_lock_with_key: YES | GET | `/v5/spot-cross-margin-trade/account` | | `getSpotMarginLoanAccountInfo()` | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/account` |
| `spotMarginBorrow()` | :closed_lock_with_key: YES | POST | `/v5/spot-cross-margin-trade/loan` | | `spotMarginBorrow()` | :closed_lock_with_key: | POST | `/v5/spot-cross-margin-trade/loan` |
| `spotMarginRepay()` | :closed_lock_with_key: YES | POST | `/v5/spot-cross-margin-trade/repay` | | `spotMarginRepay()` | :closed_lock_with_key: | POST | `/v5/spot-cross-margin-trade/repay` |
| `getSpotMarginBorrowOrderDetail()` | :closed_lock_with_key: YES | GET | `/v5/spot-cross-margin-trade/orders` | | `getSpotMarginBorrowOrderDetail()` | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/orders` |
| `getSpotMarginRepaymentOrderDetail()` | :closed_lock_with_key: YES | GET | `/v5/spot-cross-margin-trade/repay-history` | | `getSpotMarginRepaymentOrderDetail()` | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/repay-history` |
| `toggleSpotCrossMarginTrade()` | :closed_lock_with_key: YES | POST | `/v5/spot-cross-margin-trade/switch` | | `toggleSpotCrossMarginTrade()` | :closed_lock_with_key: | POST | `/v5/spot-cross-margin-trade/switch` |
| `getInstitutionalLendingProductInfo()` | no | GET | `/v5/ins-loan/product-infos` | | `getInstitutionalLendingProductInfo()` | | GET | `/v5/ins-loan/product-infos` |
| `getInstitutionalLendingMarginCoinInfo()` | no | GET | `/v5/ins-loan/ensure-tokens` | | `getInstitutionalLendingMarginCoinInfo()` | | GET | `/v5/ins-loan/ensure-tokens` |
| `getInstitutionalLendingMarginCoinInfoWithConversionRate()` | no | GET | `/v5/ins-loan/ensure-tokens-convert` | | `getInstitutionalLendingMarginCoinInfoWithConversionRate()` | | GET | `/v5/ins-loan/ensure-tokens-convert` |
| `getInstitutionalLendingLoanOrders()` | :closed_lock_with_key: YES | GET | `/v5/ins-loan/loan-order` | | `getInstitutionalLendingLoanOrders()` | :closed_lock_with_key: | GET | `/v5/ins-loan/loan-order` |
| `getInstitutionalLendingRepayOrders()` | :closed_lock_with_key: YES | GET | `/v5/ins-loan/repaid-history` | | `getInstitutionalLendingRepayOrders()` | :closed_lock_with_key: | GET | `/v5/ins-loan/repaid-history` |
| `getInstitutionalLendingLTV()` | :closed_lock_with_key: YES | GET | `/v5/ins-loan/ltv` | | `getInstitutionalLendingLTV()` | :closed_lock_with_key: | GET | `/v5/ins-loan/ltv` |
| `getInstitutionalLendingLTVWithLadderConversionRate()` | :closed_lock_with_key: YES | GET | `/v5/ins-loan/ltv-convert` | | `getInstitutionalLendingLTVWithLadderConversionRate()` | :closed_lock_with_key: | GET | `/v5/ins-loan/ltv-convert` |
| `bindOrUnbindUID()` | :closed_lock_with_key: YES | POST | `/v5/ins-loan/association-uid` | | `bindOrUnbindUID()` | :closed_lock_with_key: | POST | `/v5/ins-loan/association-uid` |
| `getExchangeBrokerEarnings()` | :closed_lock_with_key: YES | GET | `/v5/broker/earnings-info` | | `getExchangeBrokerEarnings()` | :closed_lock_with_key: | GET | `/v5/broker/earnings-info` |
| `getExchangeBrokerAccountInfo()` | :closed_lock_with_key: YES | GET | `/v5/broker/account-info` | | `getExchangeBrokerAccountInfo()` | :closed_lock_with_key: | GET | `/v5/broker/account-info` |
| `getBrokerSubAccountDeposits()` | :closed_lock_with_key: YES | GET | `/v5/broker/asset/query-sub-member-deposit-record` | | `getBrokerSubAccountDeposits()` | :closed_lock_with_key: | GET | `/v5/broker/asset/query-sub-member-deposit-record` |
# spot-client-v3.ts # spot-client-v3.ts
@@ -196,33 +196,33 @@ This table includes all endpoints from the official Exchange API docs and corres
| Function | Authentication | HTTP Method | Endpoint | | Function | Authentication | HTTP Method | Endpoint |
| -------- | :------: | :------: | -------- | | -------- | :------: | :------: | -------- |
| `fetchServerTime()` | no | GET | `/spot/v3/public/symbols` | | `fetchServerTime()` | | GET | `/spot/v3/public/symbols` |
| `getSymbols()` | no | GET | `/spot/v3/public/symbols` | | `getSymbols()` | | GET | `/spot/v3/public/symbols` |
| `getOrderBook()` | no | GET | `/spot/v3/public/quote/depth` | | `getOrderBook()` | | GET | `/spot/v3/public/quote/depth` |
| `getMergedOrderBook()` | no | GET | `/spot/v3/public/quote/depth/merged` | | `getMergedOrderBook()` | | GET | `/spot/v3/public/quote/depth/merged` |
| `getTrades()` | no | GET | `/spot/v3/public/quote/trades` | | `getTrades()` | | GET | `/spot/v3/public/quote/trades` |
| `getCandles()` | no | GET | `/spot/v3/public/quote/kline` | | `getCandles()` | | GET | `/spot/v3/public/quote/kline` |
| `get24hrTicker()` | no | GET | `/spot/v3/public/quote/ticker/24hr` | | `get24hrTicker()` | | GET | `/spot/v3/public/quote/ticker/24hr` |
| `getLastTradedPrice()` | no | GET | `/spot/v3/public/quote/ticker/price` | | `getLastTradedPrice()` | | GET | `/spot/v3/public/quote/ticker/price` |
| `getBestBidAskPrice()` | no | GET | `/spot/v3/public/quote/ticker/bookTicker` | | `getBestBidAskPrice()` | | GET | `/spot/v3/public/quote/ticker/bookTicker` |
| `submitOrder()` | :closed_lock_with_key: YES | POST | `/spot/v3/private/order` | | `submitOrder()` | :closed_lock_with_key: | POST | `/spot/v3/private/order` |
| `getOrder()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/order` | | `getOrder()` | :closed_lock_with_key: | GET | `/spot/v3/private/order` |
| `cancelOrder()` | :closed_lock_with_key: YES | POST | `/spot/v3/private/cancel-order` | | `cancelOrder()` | :closed_lock_with_key: | POST | `/spot/v3/private/cancel-order` |
| `cancelOrderBatch()` | :closed_lock_with_key: YES | POST | `/spot/v3/private/cancel-orders` | | `cancelOrderBatch()` | :closed_lock_with_key: | POST | `/spot/v3/private/cancel-orders` |
| `cancelOrderBatchIDs()` | :closed_lock_with_key: YES | POST | `/spot/v3/private/cancel-orders-by-ids` | | `cancelOrderBatchIDs()` | :closed_lock_with_key: | POST | `/spot/v3/private/cancel-orders-by-ids` |
| `getOpenOrders()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/open-orders` | | `getOpenOrders()` | :closed_lock_with_key: | GET | `/spot/v3/private/open-orders` |
| `getPastOrders()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/history-orders` | | `getPastOrders()` | :closed_lock_with_key: | GET | `/spot/v3/private/history-orders` |
| `getMyTrades()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/my-trades` | | `getMyTrades()` | :closed_lock_with_key: | GET | `/spot/v3/private/my-trades` |
| `getBalances()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/account` | | `getBalances()` | :closed_lock_with_key: | GET | `/spot/v3/private/account` |
| `getServerTime()` | no | GET | `/v2/public/time` | | `getServerTime()` | | GET | `/v2/public/time` |
| `getLeveragedTokenAssetInfos()` | no | GET | `/spot/v3/public/infos` | | `getLeveragedTokenAssetInfos()` | | GET | `/spot/v3/public/infos` |
| `getLeveragedTokenMarketInfo()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/reference` | | `getLeveragedTokenMarketInfo()` | :closed_lock_with_key: | GET | `/spot/v3/private/reference` |
| `purchaseLeveragedToken()` | :closed_lock_with_key: YES | POST | `/spot/v3/private/purchase` | | `purchaseLeveragedToken()` | :closed_lock_with_key: | POST | `/spot/v3/private/purchase` |
| `redeemLeveragedToken()` | :closed_lock_with_key: YES | POST | `/spot/v3/private/redeem` | | `redeemLeveragedToken()` | :closed_lock_with_key: | POST | `/spot/v3/private/redeem` |
| `getLeveragedTokenPRHistory()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/record` | | `getLeveragedTokenPRHistory()` | :closed_lock_with_key: | GET | `/spot/v3/private/record` |
| `borrowCrossMarginLoan()` | :closed_lock_with_key: YES | POST | `/spot/v3/private/cross-margin-loan` | | `borrowCrossMarginLoan()` | :closed_lock_with_key: | POST | `/spot/v3/private/cross-margin-loan` |
| `repayCrossMarginLoan()` | :closed_lock_with_key: YES | POST | `/spot/v3/private/cross-margin-repay` | | `repayCrossMarginLoan()` | :closed_lock_with_key: | POST | `/spot/v3/private/cross-margin-repay` |
| `getCrossMarginBorrowingInfo()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/cross-margin-orders` | | `getCrossMarginBorrowingInfo()` | :closed_lock_with_key: | GET | `/spot/v3/private/cross-margin-orders` |
| `getCrossMarginAccountInfo()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/cross-margin-account` | | `getCrossMarginAccountInfo()` | :closed_lock_with_key: | GET | `/spot/v3/private/cross-margin-account` |
| `getCrossMarginInterestQuota()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/cross-margin-loan-info` | | `getCrossMarginInterestQuota()` | :closed_lock_with_key: | GET | `/spot/v3/private/cross-margin-loan-info` |
| `getCrossMarginRepaymentHistory()` | :closed_lock_with_key: YES | GET | `/spot/v3/private/cross-margin-repay-history` | | `getCrossMarginRepaymentHistory()` | :closed_lock_with_key: | GET | `/spot/v3/private/cross-margin-repay-history` |