Merge pull request #434 from JJ-Cro/spreadTrading

feat(v4.1.4): full spread trading support
This commit is contained in:
Tiago
2025-04-17 10:51:22 +01:00
committed by GitHub
19 changed files with 793 additions and 186 deletions

View File

@@ -48,185 +48,197 @@ This table includes all endpoints from the official Exchange API docs and corres
| Function | AUTH | HTTP Method | Endpoint | | Function | AUTH | HTTP Method | Endpoint |
| -------- | :------: | :------: | -------- | | -------- | :------: | :------: | -------- |
| [fetchServerTime()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L305) | | GET | `/v5/market/time` | | [fetchServerTime()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L318) | | GET | `/v5/market/time` |
| [requestDemoTradingFunds()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L316) | :closed_lock_with_key: | POST | `/v5/account/demo-apply-money` | | [requestDemoTradingFunds()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L335) | :closed_lock_with_key: | POST | `/v5/account/demo-apply-money` |
| [getKline()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L331) | | GET | `/v5/market/kline` | | [createDemoAccount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L348) | :closed_lock_with_key: | POST | `/v5/user/create-demo-member` |
| [getMarkPriceKline()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L346) | | GET | `/v5/market/mark-price-kline` | | [getSpreadInstrumentsInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L361) | | GET | `/v5/spread/instrument` |
| [getIndexPriceKline()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L361) | | GET | `/v5/market/index-price-kline` | | [getSpreadOrderbook()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L373) | | GET | `/v5/spread/orderbook` |
| [getPremiumIndexPriceKline()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L376) | | GET | `/v5/market/premium-index-price-kline` | | [getSpreadTickers()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L383) | | GET | `/v5/spread/tickers` |
| [getOrderbook()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L402) | | GET | `/v5/market/orderbook` | | [getSpreadRecentTrades()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L394) | | GET | `/v5/spread/recent-trade` |
| [getTickers()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L408) | | GET | `/v5/market/tickers` | | [submitSpreadOrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L405) | :closed_lock_with_key: | POST | `/v5/spread/order/create` |
| [getFundingRateHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L446) | | GET | `/v5/market/funding/history` | | [amendSpreadOrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L418) | :closed_lock_with_key: | POST | `/v5/spread/order/amend` |
| [getPublicTradingHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L461) | | GET | `/v5/market/recent-trade` | | [cancelSpreadOrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L430) | :closed_lock_with_key: | POST | `/v5/spread/order/cancel` |
| [getOpenInterest()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L474) | | GET | `/v5/market/open-interest` | | [cancelAllSpreadOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L448) | :closed_lock_with_key: | POST | `/v5/spread/order/cancel-all` |
| [getHistoricalVolatility()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L484) | | GET | `/v5/market/historical-volatility` | | [getSpreadOpenOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L467) | :closed_lock_with_key: | GET | `/v5/spread/order/realtime` |
| [getInsurance()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L495) | | GET | `/v5/market/insurance` | | [getSpreadOrderHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L484) | :closed_lock_with_key: | GET | `/v5/spread/order/history` |
| [getRiskLimit()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L506) | | GET | `/v5/market/risk-limit` | | [getSpreadTradeHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L500) | :closed_lock_with_key: | GET | `/v5/spread/execution/list` |
| [getOptionDeliveryPrice()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L521) | | GET | `/v5/market/delivery-price` | | [getKline()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L520) | | GET | `/v5/market/kline` |
| [getDeliveryPrice()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L534) | | GET | `/v5/market/delivery-price` | | [getMarkPriceKline()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L535) | | GET | `/v5/market/mark-price-kline` |
| [getLongShortRatio()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L540) | | GET | `/v5/market/account-ratio` | | [getIndexPriceKline()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L550) | | GET | `/v5/market/index-price-kline` |
| [submitOrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L552) | :closed_lock_with_key: | POST | `/v5/order/create` | | [getPremiumIndexPriceKline()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L565) | | GET | `/v5/market/premium-index-price-kline` |
| [amendOrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L558) | :closed_lock_with_key: | POST | `/v5/order/amend` | | [getOrderbook()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L591) | | GET | `/v5/market/orderbook` |
| [cancelOrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L564) | :closed_lock_with_key: | POST | `/v5/order/cancel` | | [getTickers()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L597) | | GET | `/v5/market/tickers` |
| [getActiveOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L573) | :closed_lock_with_key: | GET | `/v5/order/realtime` | | [getFundingRateHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L635) | | GET | `/v5/market/funding/history` |
| [cancelAllOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L579) | :closed_lock_with_key: | POST | `/v5/order/cancel-all` | | [getPublicTradingHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L650) | | GET | `/v5/market/recent-trade` |
| [getHistoricOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L592) | :closed_lock_with_key: | GET | `/v5/order/history` | | [getOpenInterest()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L663) | | GET | `/v5/market/open-interest` |
| [getExecutionList()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L604) | :closed_lock_with_key: | GET | `/v5/execution/list` | | [getHistoricalVolatility()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L673) | | GET | `/v5/market/historical-volatility` |
| [batchSubmitOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L622) | :closed_lock_with_key: | POST | `/v5/order/create-batch` | | [getInsurance()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L684) | | GET | `/v5/market/insurance` |
| [batchAmendOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L642) | :closed_lock_with_key: | POST | `/v5/order/amend-batch` | | [getRiskLimit()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L695) | | GET | `/v5/market/risk-limit` |
| [batchCancelOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L662) | :closed_lock_with_key: | POST | `/v5/order/cancel-batch` | | [getOptionDeliveryPrice()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L710) | | GET | `/v5/market/delivery-price` |
| [getSpotBorrowCheck()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L679) | :closed_lock_with_key: | GET | `/v5/order/spot-borrow-check` | | [getDeliveryPrice()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L723) | | GET | `/v5/market/delivery-price` |
| [setDisconnectCancelAllWindow()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L700) | :closed_lock_with_key: | POST | `/v5/order/disconnected-cancel-all` | | [getLongShortRatio()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L729) | | GET | `/v5/market/account-ratio` |
| [setDisconnectCancelAllWindowV2()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L718) | :closed_lock_with_key: | POST | `/v5/order/disconnected-cancel-all` | | [submitOrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L741) | :closed_lock_with_key: | POST | `/v5/order/create` |
| [getPositionInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L742) | :closed_lock_with_key: | GET | `/v5/position/list` | | [amendOrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L747) | :closed_lock_with_key: | POST | `/v5/order/amend` |
| [setLeverage()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L757) | :closed_lock_with_key: | POST | `/v5/position/set-leverage` | | [cancelOrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L753) | :closed_lock_with_key: | POST | `/v5/order/cancel` |
| [switchIsolatedMargin()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L770) | :closed_lock_with_key: | POST | `/v5/position/switch-isolated` | | [getActiveOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L762) | :closed_lock_with_key: | GET | `/v5/order/realtime` |
| [setTPSLMode()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L784) | :closed_lock_with_key: | POST | `/v5/position/set-tpsl-mode` | | [cancelAllOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L768) | :closed_lock_with_key: | POST | `/v5/order/cancel-all` |
| [switchPositionMode()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L799) | :closed_lock_with_key: | POST | `/v5/position/switch-mode` | | [getHistoricOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L781) | :closed_lock_with_key: | GET | `/v5/order/history` |
| [setRiskLimit()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L813) | :closed_lock_with_key: | POST | `/v5/position/set-risk-limit` | | [getExecutionList()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L793) | :closed_lock_with_key: | GET | `/v5/execution/list` |
| [setTradingStop()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L828) | :closed_lock_with_key: | POST | `/v5/position/trading-stop` | | [batchSubmitOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L811) | :closed_lock_with_key: | POST | `/v5/order/create-batch` |
| [setAutoAddMargin()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L839) | :closed_lock_with_key: | POST | `/v5/position/set-auto-add-margin` | | [batchAmendOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L831) | :closed_lock_with_key: | POST | `/v5/order/amend-batch` |
| [addOrReduceMargin()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L851) | :closed_lock_with_key: | POST | `/v5/position/add-margin` | | [batchCancelOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L851) | :closed_lock_with_key: | POST | `/v5/order/cancel-batch` |
| [getClosedPnL()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L863) | :closed_lock_with_key: | GET | `/v5/position/closed-pnl` | | [getSpotBorrowCheck()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L868) | :closed_lock_with_key: | GET | `/v5/order/spot-borrow-check` |
| [movePosition()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L882) | :closed_lock_with_key: | POST | `/v5/position/move-positions` | | [setDisconnectCancelAllWindow()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L889) | :closed_lock_with_key: | POST | `/v5/order/disconnected-cancel-all` |
| [getMovePositionHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L893) | :closed_lock_with_key: | GET | `/v5/position/move-history` | | [setDisconnectCancelAllWindowV2()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L907) | :closed_lock_with_key: | POST | `/v5/order/disconnected-cancel-all` |
| [confirmNewRiskLimit()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L912) | :closed_lock_with_key: | POST | `/v5/position/confirm-pending-mmr` | | [getPositionInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L931) | :closed_lock_with_key: | GET | `/v5/position/list` |
| [getPreUpgradeOrderHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L932) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/order/history` | | [setLeverage()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L946) | :closed_lock_with_key: | POST | `/v5/position/set-leverage` |
| [getPreUpgradeTradeHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L947) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/execution/list` | | [switchIsolatedMargin()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L959) | :closed_lock_with_key: | POST | `/v5/position/switch-isolated` |
| [getPreUpgradeClosedPnl()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L958) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/position/closed-pnl` | | [setTPSLMode()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L973) | :closed_lock_with_key: | POST | `/v5/position/set-tpsl-mode` |
| [getPreUpgradeTransactions()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L972) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/account/transaction-log` | | [switchPositionMode()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L988) | :closed_lock_with_key: | POST | `/v5/position/switch-mode` |
| [getPreUpgradeOptionDeliveryRecord()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L989) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/asset/delivery-record` | | [setRiskLimit()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1002) | :closed_lock_with_key: | POST | `/v5/position/set-risk-limit` |
| [getPreUpgradeUSDCSessionSettlements()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1003) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/asset/settlement-record` | | [setTradingStop()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1017) | :closed_lock_with_key: | POST | `/v5/position/trading-stop` |
| [getWalletBalance()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1024) | :closed_lock_with_key: | GET | `/v5/account/wallet-balance` | | [setAutoAddMargin()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1028) | :closed_lock_with_key: | POST | `/v5/position/set-auto-add-margin` |
| [getTransferableAmount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1035) | :closed_lock_with_key: | GET | `/v5/account/withdrawal` | | [addOrReduceMargin()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1040) | :closed_lock_with_key: | POST | `/v5/position/add-margin` |
| [upgradeToUnifiedAccount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1048) | :closed_lock_with_key: | POST | `/v5/account/upgrade-to-uta` | | [getClosedPnL()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1052) | :closed_lock_with_key: | GET | `/v5/position/closed-pnl` |
| [getBorrowHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1059) | :closed_lock_with_key: | GET | `/v5/account/borrow-history` | | [movePosition()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1071) | :closed_lock_with_key: | POST | `/v5/position/move-positions` |
| [repayLiability()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1073) | :closed_lock_with_key: | POST | `/v5/account/quick-repayment` | | [getMovePositionHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1082) | :closed_lock_with_key: | GET | `/v5/position/move-history` |
| [setCollateralCoin()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1082) | :closed_lock_with_key: | POST | `/v5/account/set-collateral-switch` | | [confirmNewRiskLimit()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1101) | :closed_lock_with_key: | POST | `/v5/position/confirm-pending-mmr` |
| [batchSetCollateralCoin()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1088) | :closed_lock_with_key: | POST | `/v5/account/set-collateral-switch-batch` | | [getPreUpgradeOrderHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1121) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/order/history` |
| [getCollateralInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1098) | :closed_lock_with_key: | GET | `/v5/account/collateral-info` | | [getPreUpgradeTradeHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1136) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/execution/list` |
| [getCoinGreeks()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1107) | :closed_lock_with_key: | GET | `/v5/asset/coin-greeks` | | [getPreUpgradeClosedPnl()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1147) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/position/closed-pnl` |
| [getFeeRate()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1120) | :closed_lock_with_key: | GET | `/v5/account/fee-rate` | | [getPreUpgradeTransactions()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1161) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/account/transaction-log` |
| [getAccountInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1129) | :closed_lock_with_key: | GET | `/v5/account/info` | | [getPreUpgradeOptionDeliveryRecord()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1178) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/asset/delivery-record` |
| [getDCPInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1142) | :closed_lock_with_key: | GET | `/v5/account/query-dcp-info` | | [getPreUpgradeUSDCSessionSettlements()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1192) | :closed_lock_with_key: | GET | `/v5/pre-upgrade/asset/settlement-record` |
| [getTransactionLog()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1149) | :closed_lock_with_key: | GET | `/v5/account/transaction-log` | | [getWalletBalance()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1213) | :closed_lock_with_key: | GET | `/v5/account/wallet-balance` |
| [getClassicTransactionLogs()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1160) | :closed_lock_with_key: | GET | `/v5/account/contract-transaction-log` | | [getTransferableAmount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1224) | :closed_lock_with_key: | GET | `/v5/account/withdrawal` |
| [getSMPGroup()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1171) | :closed_lock_with_key: | GET | `/v5/account/smp-group` | | [upgradeToUnifiedAccount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1237) | :closed_lock_with_key: | POST | `/v5/account/upgrade-to-uta` |
| [setMarginMode()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1184) | :closed_lock_with_key: | POST | `/v5/account/set-margin-mode` | | [getBorrowHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1248) | :closed_lock_with_key: | GET | `/v5/account/borrow-history` |
| [setSpotHedging()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1201) | :closed_lock_with_key: | POST | `/v5/account/set-hedging-mode` | | [repayLiability()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1262) | :closed_lock_with_key: | POST | `/v5/account/quick-repayment` |
| [setMMP()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1210) | :closed_lock_with_key: | POST | `/v5/account/mmp-modify` | | [setCollateralCoin()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1271) | :closed_lock_with_key: | POST | `/v5/account/set-collateral-switch` |
| [resetMMP()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1217) | :closed_lock_with_key: | POST | `/v5/account/mmp-reset` | | [batchSetCollateralCoin()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1277) | :closed_lock_with_key: | POST | `/v5/account/set-collateral-switch-batch` |
| [getMMPState()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1224) | :closed_lock_with_key: | GET | `/v5/account/mmp-state` | | [getCollateralInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1287) | :closed_lock_with_key: | GET | `/v5/account/collateral-info` |
| [getDeliveryRecord()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1241) | :closed_lock_with_key: | GET | `/v5/asset/delivery-record` | | [getCoinGreeks()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1296) | :closed_lock_with_key: | GET | `/v5/asset/coin-greeks` |
| [getSettlementRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1252) | :closed_lock_with_key: | GET | `/v5/asset/settlement-record` | | [getFeeRate()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1309) | :closed_lock_with_key: | GET | `/v5/account/fee-rate` |
| [getCoinExchangeRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1265) | :closed_lock_with_key: | GET | `/v5/asset/exchange/order-record` | | [getAccountInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1318) | :closed_lock_with_key: | GET | `/v5/account/info` |
| [getCoinInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1277) | :closed_lock_with_key: | GET | `/v5/asset/coin/query-info` | | [getDCPInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1331) | :closed_lock_with_key: | GET | `/v5/account/query-dcp-info` |
| [getSubUID()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1291) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-sub-member-list` | | [getTransactionLog()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1338) | :closed_lock_with_key: | GET | `/v5/account/transaction-log` |
| [getAssetInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1306) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-asset-info` | | [getClassicTransactionLogs()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1349) | :closed_lock_with_key: | GET | `/v5/account/contract-transaction-log` |
| [getAllCoinsBalance()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1317) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-account-coins-balance` | | [getSMPGroup()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1360) | :closed_lock_with_key: | GET | `/v5/account/smp-group` |
| [getCoinBalance()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1331) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-account-coin-balance` | | [setMarginMode()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1373) | :closed_lock_with_key: | POST | `/v5/account/set-margin-mode` |
| [getWithdrawableAmount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1343) | :closed_lock_with_key: | GET | `/v5/asset/withdraw/withdrawable-amount` | | [setSpotHedging()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1390) | :closed_lock_with_key: | POST | `/v5/account/set-hedging-mode` |
| [getTransferableCoinList()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1352) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-transfer-coin-list` | | [setMMP()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1399) | :closed_lock_with_key: | POST | `/v5/account/mmp-modify` |
| [createInternalTransfer()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1368) | :closed_lock_with_key: | POST | `/v5/asset/transfer/inter-transfer` | | [resetMMP()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1406) | :closed_lock_with_key: | POST | `/v5/account/mmp-reset` |
| [getInternalTransferRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1387) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-inter-transfer-list` | | [getMMPState()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1413) | :closed_lock_with_key: | GET | `/v5/account/mmp-state` |
| [enableUniversalTransferForSubUIDs()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1407) | :closed_lock_with_key: | POST | `/v5/asset/transfer/save-transfer-sub-member` | | [getDeliveryRecord()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1430) | :closed_lock_with_key: | GET | `/v5/asset/delivery-record` |
| [createUniversalTransfer()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1418) | :closed_lock_with_key: | POST | `/v5/asset/transfer/universal-transfer` | | [getSettlementRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1441) | :closed_lock_with_key: | GET | `/v5/asset/settlement-record` |
| [getUniversalTransferRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1430) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-universal-transfer-list` | | [getCoinExchangeRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1454) | :closed_lock_with_key: | GET | `/v5/asset/exchange/order-record` |
| [getAllowedDepositCoinInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1443) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-allowed-list` | | [getCoinInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1466) | :closed_lock_with_key: | GET | `/v5/asset/coin/query-info` |
| [setDepositAccount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1457) | :closed_lock_with_key: | POST | `/v5/asset/deposit/deposit-to-account` | | [getSubUID()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1480) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-sub-member-list` |
| [getDepositRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1473) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-record` | | [getAssetInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1495) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-asset-info` |
| [getSubAccountDepositRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1488) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-sub-member-record` | | [getAllCoinsBalance()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1506) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-account-coins-balance` |
| [getInternalDepositRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1504) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-internal-record` | | [getCoinBalance()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1520) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-account-coin-balance` |
| [getMasterDepositAddress()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1516) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-address` | | [getWithdrawableAmount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1532) | :closed_lock_with_key: | GET | `/v5/asset/withdraw/withdrawable-amount` |
| [getSubDepositAddress()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1534) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-sub-member-address` | | [getTransferableCoinList()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1541) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-transfer-coin-list` |
| [querySubMemberAddress()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1559) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-sub-member-address` | | [createInternalTransfer()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1557) | :closed_lock_with_key: | POST | `/v5/asset/transfer/inter-transfer` |
| [getWithdrawalRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1579) | :closed_lock_with_key: | GET | `/v5/asset/withdraw/query-record` | | [getInternalTransferRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1576) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-inter-transfer-list` |
| [getExchangeEntities()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1590) | :closed_lock_with_key: | GET | `/v5/asset/withdraw/vasp/list` | | [enableUniversalTransferForSubUIDs()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1596) | :closed_lock_with_key: | POST | `/v5/asset/transfer/save-transfer-sub-member` |
| [submitWithdrawal()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1603) | :closed_lock_with_key: | POST | `/v5/asset/withdraw/create` | | [createUniversalTransfer()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1607) | :closed_lock_with_key: | POST | `/v5/asset/transfer/universal-transfer` |
| [cancelWithdrawal()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1614) | :closed_lock_with_key: | POST | `/v5/asset/withdraw/cancel` | | [getUniversalTransferRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1619) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-universal-transfer-list` |
| [getConvertCoins()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1623) | :closed_lock_with_key: | GET | `/v5/asset/exchange/query-coin-list` | | [getAllowedDepositCoinInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1632) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-allowed-list` |
| [requestConvertQuote()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1634) | :closed_lock_with_key: | POST | `/v5/asset/exchange/quote-apply` | | [setDepositAccount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1646) | :closed_lock_with_key: | POST | `/v5/asset/deposit/deposit-to-account` |
| [confirmConvertQuote()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1643) | :closed_lock_with_key: | POST | `/v5/asset/exchange/convert-execute` | | [getDepositRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1662) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-record` |
| [getConvertStatus()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1655) | :closed_lock_with_key: | GET | `/v5/asset/exchange/convert-result-query` | | [getSubAccountDepositRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1677) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-sub-member-record` |
| [getConvertHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1674) | :closed_lock_with_key: | GET | `/v5/asset/exchange/query-convert-history` | | [getInternalDepositRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1693) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-internal-record` |
| [createSubMember()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1694) | :closed_lock_with_key: | POST | `/v5/user/create-sub-member` | | [getMasterDepositAddress()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1705) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-address` |
| [createSubUIDAPIKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1706) | :closed_lock_with_key: | POST | `/v5/user/create-sub-api` | | [getSubDepositAddress()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1723) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-sub-member-address` |
| [getSubUIDList()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1715) | :closed_lock_with_key: | GET | `/v5/user/query-sub-members` | | [querySubMemberAddress()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1748) | :closed_lock_with_key: | GET | `/v5/asset/deposit/query-sub-member-address` |
| [getSubUIDListUnlimited()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1724) | :closed_lock_with_key: | GET | `/v5/user/submembers` | | [getWithdrawalRecords()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1768) | :closed_lock_with_key: | GET | `/v5/asset/withdraw/query-record` |
| [setSubUIDFrozenState()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1742) | :closed_lock_with_key: | POST | `/v5/user/frozen-sub-member` | | [getExchangeEntities()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1779) | :closed_lock_with_key: | GET | `/v5/asset/withdraw/vasp/list` |
| [getQueryApiKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1755) | :closed_lock_with_key: | GET | `/v5/user/query-api` | | [submitWithdrawal()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1792) | :closed_lock_with_key: | POST | `/v5/asset/withdraw/create` |
| [getSubAccountAllApiKeys()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1762) | :closed_lock_with_key: | GET | `/v5/user/sub-apikeys` | | [cancelWithdrawal()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1803) | :closed_lock_with_key: | POST | `/v5/asset/withdraw/cancel` |
| [getUIDWalletType()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1771) | :closed_lock_with_key: | GET | `/v5/user/get-member-type` | | [getConvertCoins()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1812) | :closed_lock_with_key: | GET | `/v5/asset/exchange/query-coin-list` |
| [updateMasterApiKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1788) | :closed_lock_with_key: | POST | `/v5/user/update-api` | | [requestConvertQuote()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1823) | :closed_lock_with_key: | POST | `/v5/asset/exchange/quote-apply` |
| [updateSubApiKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1802) | :closed_lock_with_key: | POST | `/v5/user/update-sub-api` | | [confirmConvertQuote()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1832) | :closed_lock_with_key: | POST | `/v5/asset/exchange/convert-execute` |
| [deleteSubMember()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1815) | :closed_lock_with_key: | POST | `/v5/user/del-submember` | | [getConvertStatus()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1844) | :closed_lock_with_key: | GET | `/v5/asset/exchange/convert-result-query` |
| [deleteMasterApiKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1830) | :closed_lock_with_key: | POST | `/v5/user/delete-api` | | [getConvertHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1863) | :closed_lock_with_key: | GET | `/v5/asset/exchange/query-convert-history` |
| [deleteSubApiKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1844) | :closed_lock_with_key: | POST | `/v5/user/delete-sub-api` | | [createSubMember()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1883) | :closed_lock_with_key: | POST | `/v5/user/create-sub-member` |
| [getAffiliateUserList()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1864) | :closed_lock_with_key: | GET | `/v5/affiliate/aff-user-list` | | [createSubUIDAPIKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1895) | :closed_lock_with_key: | POST | `/v5/user/create-sub-api` |
| [getAffiliateUserInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1883) | :closed_lock_with_key: | GET | `/v5/user/aff-customer-info` | | [getSubUIDList()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1904) | :closed_lock_with_key: | GET | `/v5/user/query-sub-members` |
| [getLeveragedTokenInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1898) | | GET | `/v5/spot-lever-token/info` | | [getSubUIDListUnlimited()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1913) | :closed_lock_with_key: | GET | `/v5/user/submembers` |
| [getLeveragedTokenMarket()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1907) | | GET | `/v5/spot-lever-token/reference` | | [setSubUIDFrozenState()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1931) | :closed_lock_with_key: | POST | `/v5/user/frozen-sub-member` |
| [purchaseSpotLeveragedToken()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1916) | :closed_lock_with_key: | POST | `/v5/spot-lever-token/purchase` | | [getQueryApiKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1944) | :closed_lock_with_key: | GET | `/v5/user/query-api` |
| [redeemSpotLeveragedToken()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1925) | :closed_lock_with_key: | POST | `/v5/spot-lever-token/redeem` | | [getSubAccountAllApiKeys()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1951) | :closed_lock_with_key: | GET | `/v5/user/sub-apikeys` |
| [getSpotLeveragedTokenOrderHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1934) | :closed_lock_with_key: | GET | `/v5/spot-lever-token/order-record` | | [getUIDWalletType()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1960) | :closed_lock_with_key: | GET | `/v5/user/get-member-type` |
| [getVIPMarginData()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1956) | | GET | `/v5/spot-margin-trade/data` | | [updateMasterApiKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1977) | :closed_lock_with_key: | POST | `/v5/user/update-api` |
| [getHistoricalInterestRate()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1967) | :closed_lock_with_key: | GET | `/v5/spot-margin-trade/interest-rate-history` | | [updateSubApiKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1991) | :closed_lock_with_key: | POST | `/v5/user/update-sub-api` |
| [toggleSpotMarginTrade()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L1994) | :closed_lock_with_key: | POST | `/v5/spot-margin-trade/switch-mode` | | [deleteSubMember()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2004) | :closed_lock_with_key: | POST | `/v5/user/del-submember` |
| [setSpotMarginLeverage()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2006) | :closed_lock_with_key: | POST | `/v5/spot-margin-trade/set-leverage` | | [deleteMasterApiKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2019) | :closed_lock_with_key: | POST | `/v5/user/delete-api` |
| [getSpotMarginState()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2015) | :closed_lock_with_key: | GET | `/v5/spot-margin-trade/state` | | [deleteSubApiKey()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2033) | :closed_lock_with_key: | POST | `/v5/user/delete-sub-api` |
| [getSpotMarginCoinInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2028) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/pledge-token` | | [getAffiliateUserList()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2053) | :closed_lock_with_key: | GET | `/v5/affiliate/aff-user-list` |
| [getSpotMarginBorrowableCoinInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2045) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/borrow-token` | | [getAffiliateUserInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2072) | :closed_lock_with_key: | GET | `/v5/user/aff-customer-info` |
| [getSpotMarginInterestAndQuota()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2062) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/loan-info` | | [getLeveragedTokenInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2087) | | GET | `/v5/spot-lever-token/info` |
| [getSpotMarginLoanAccountInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2080) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/account` | | [getLeveragedTokenMarket()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2096) | | GET | `/v5/spot-lever-token/reference` |
| [spotMarginBorrow()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2104) | :closed_lock_with_key: | POST | `/v5/spot-cross-margin-trade/loan` | | [purchaseSpotLeveragedToken()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2105) | :closed_lock_with_key: | POST | `/v5/spot-lever-token/purchase` |
| [spotMarginRepay()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2115) | :closed_lock_with_key: | POST | `/v5/spot-cross-margin-trade/repay` | | [redeemSpotLeveragedToken()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2114) | :closed_lock_with_key: | POST | `/v5/spot-lever-token/redeem` |
| [getSpotMarginBorrowOrderDetail()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2130) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/orders` | | [getSpotLeveragedTokenOrderHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2123) | :closed_lock_with_key: | GET | `/v5/spot-lever-token/order-record` |
| [getSpotMarginRepaymentOrderDetail()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2159) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/repay-history` | | [getVIPMarginData()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2145) | | GET | `/v5/spot-margin-trade/data` |
| [toggleSpotCrossMarginTrade()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2188) | :closed_lock_with_key: | POST | `/v5/spot-cross-margin-trade/switch` | | [getHistoricalInterestRate()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2156) | :closed_lock_with_key: | GET | `/v5/spot-margin-trade/interest-rate-history` |
| [getCollateralCoins()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2205) | | GET | `/v5/crypto-loan/collateral-data` | | [toggleSpotMarginTrade()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2183) | :closed_lock_with_key: | POST | `/v5/spot-margin-trade/switch-mode` |
| [getBorrowableCoins()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2221) | | GET | `/v5/crypto-loan/loanable-data` | | [setSpotMarginLeverage()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2195) | :closed_lock_with_key: | POST | `/v5/spot-margin-trade/set-leverage` |
| [getAccountBorrowCollateralLimit()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2238) | :closed_lock_with_key: | GET | `/v5/crypto-loan/borrowable-collateralisable-number` | | [getSpotMarginState()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2204) | :closed_lock_with_key: | GET | `/v5/spot-margin-trade/state` |
| [borrowCryptoLoan()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2257) | :closed_lock_with_key: | POST | `/v5/crypto-loan/borrow` | | [getSpotMarginCoinInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2217) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/pledge-token` |
| [repayCryptoLoan()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2276) | :closed_lock_with_key: | POST | `/v5/crypto-loan/repay` | | [getSpotMarginBorrowableCoinInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2234) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/borrow-token` |
| [getUnpaidLoanOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2290) | :closed_lock_with_key: | GET | `/v5/crypto-loan/ongoing-orders` | | [getSpotMarginInterestAndQuota()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2251) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/loan-info` |
| [getRepaymentHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2309) | :closed_lock_with_key: | GET | `/v5/crypto-loan/repayment-history` | | [getSpotMarginLoanAccountInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2269) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/account` |
| [getCompletedLoanOrderHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2327) | :closed_lock_with_key: | GET | `/v5/crypto-loan/borrow-history` | | [spotMarginBorrow()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2293) | :closed_lock_with_key: | POST | `/v5/spot-cross-margin-trade/loan` |
| [getMaxAllowedReductionCollateralAmount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2344) | :closed_lock_with_key: | GET | `/v5/crypto-loan/max-collateral-amount` | | [spotMarginRepay()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2304) | :closed_lock_with_key: | POST | `/v5/spot-cross-margin-trade/repay` |
| [adjustCollateralAmount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2361) | :closed_lock_with_key: | POST | `/v5/crypto-loan/adjust-ltv` | | [getSpotMarginBorrowOrderDetail()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2319) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/orders` |
| [getLoanLTVAdjustmentHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2383) | :closed_lock_with_key: | GET | `/v5/crypto-loan/adjustment-history` | | [getSpotMarginRepaymentOrderDetail()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2348) | :closed_lock_with_key: | GET | `/v5/spot-cross-margin-trade/repay-history` |
| [getInstitutionalLendingProductInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2403) | | GET | `/v5/ins-loan/product-infos` | | [toggleSpotCrossMarginTrade()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2377) | :closed_lock_with_key: | POST | `/v5/spot-cross-margin-trade/switch` |
| [getInstitutionalLendingMarginCoinInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2413) | | GET | `/v5/ins-loan/ensure-tokens` | | [getCollateralCoins()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2394) | | GET | `/v5/crypto-loan/collateral-data` |
| [getInstitutionalLendingMarginCoinInfoWithConversionRate()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2422) | | GET | `/v5/ins-loan/ensure-tokens-convert` | | [getBorrowableCoins()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2410) | | GET | `/v5/crypto-loan/loanable-data` |
| [getInstitutionalLendingLoanOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2431) | :closed_lock_with_key: | GET | `/v5/ins-loan/loan-order` | | [getAccountBorrowCollateralLimit()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2427) | :closed_lock_with_key: | GET | `/v5/crypto-loan/borrowable-collateralisable-number` |
| [getInstitutionalLendingRepayOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2443) | :closed_lock_with_key: | GET | `/v5/ins-loan/repaid-history` | | [borrowCryptoLoan()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2446) | :closed_lock_with_key: | POST | `/v5/crypto-loan/borrow` |
| [getInstitutionalLendingLTV()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2455) | :closed_lock_with_key: | GET | `/v5/ins-loan/ltv` | | [repayCryptoLoan()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2465) | :closed_lock_with_key: | POST | `/v5/crypto-loan/repay` |
| [getInstitutionalLendingLTVWithLadderConversionRate()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2464) | :closed_lock_with_key: | GET | `/v5/ins-loan/ltv-convert` | | [getUnpaidLoanOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2479) | :closed_lock_with_key: | GET | `/v5/crypto-loan/ongoing-orders` |
| [bindOrUnbindUID()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2479) | :closed_lock_with_key: | POST | `/v5/ins-loan/association-uid` | | [getRepaymentHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2498) | :closed_lock_with_key: | GET | `/v5/crypto-loan/repayment-history` |
| [getExchangeBrokerEarnings()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2503) | :closed_lock_with_key: | GET | `/v5/broker/earnings-info` | | [getCompletedLoanOrderHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2516) | :closed_lock_with_key: | GET | `/v5/crypto-loan/borrow-history` |
| [getExchangeBrokerAccountInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2516) | :closed_lock_with_key: | GET | `/v5/broker/account-info` | | [getMaxAllowedReductionCollateralAmount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2533) | :closed_lock_with_key: | GET | `/v5/crypto-loan/max-collateral-amount` |
| [getBrokerSubAccountDeposits()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2532) | :closed_lock_with_key: | GET | `/v5/broker/asset/query-sub-member-deposit-record` | | [adjustCollateralAmount()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2550) | :closed_lock_with_key: | POST | `/v5/crypto-loan/adjust-ltv` |
| [getBrokerVoucherSpec()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2547) | :closed_lock_with_key: | POST | `/v5/broker/award/info` | | [getLoanLTVAdjustmentHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2572) | :closed_lock_with_key: | GET | `/v5/crypto-loan/adjustment-history` |
| [issueBrokerVoucher()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2559) | :closed_lock_with_key: | POST | `/v5/broker/award/distribute-award` | | [getInstitutionalLendingProductInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2592) | | GET | `/v5/ins-loan/product-infos` |
| [getBrokerIssuedVoucher()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2571) | :closed_lock_with_key: | POST | `/v5/broker/award/distribution-record` | | [getInstitutionalLendingMarginCoinInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2602) | | GET | `/v5/ins-loan/ensure-tokens` |
| [getEarnProduct()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2588) | | GET | `/v5/earn/product` | | [getInstitutionalLendingMarginCoinInfoWithConversionRate()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2611) | | GET | `/v5/ins-loan/ensure-tokens-convert` |
| [submitStakeRedeem()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2606) | :closed_lock_with_key: | POST | `/v5/earn/place-order` | | [getInstitutionalLendingLoanOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2620) | :closed_lock_with_key: | GET | `/v5/ins-loan/loan-order` |
| [getEarnOrderHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2623) | :closed_lock_with_key: | GET | `/v5/earn/order` | | [getInstitutionalLendingRepayOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2632) | :closed_lock_with_key: | GET | `/v5/ins-loan/repaid-history` |
| [getEarnPosition()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2638) | :closed_lock_with_key: | GET | `/v5/earn/position` | | [getInstitutionalLendingLTV()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2644) | :closed_lock_with_key: | GET | `/v5/ins-loan/ltv` |
| [getP2PAccountCoinsBalance()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2662) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-account-coins-balance` | | [getInstitutionalLendingLTVWithLadderConversionRate()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2653) | :closed_lock_with_key: | GET | `/v5/ins-loan/ltv-convert` |
| [getP2POnlineAds()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2679) | | POST | `/v5/p2p/item/online` | | [bindOrUnbindUID()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2668) | :closed_lock_with_key: | POST | `/v5/ins-loan/association-uid` |
| [createP2PAd()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2688) | :closed_lock_with_key: | POST | `/v5/p2p/item/create` | | [getExchangeBrokerEarnings()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2692) | :closed_lock_with_key: | GET | `/v5/broker/earnings-info` |
| [cancelP2PAd()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2697) | :closed_lock_with_key: | POST | `/v5/p2p/item/cancel` | | [getExchangeBrokerAccountInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2705) | :closed_lock_with_key: | GET | `/v5/broker/account-info` |
| [updateP2PAd()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2711) | :closed_lock_with_key: | POST | `/v5/p2p/item/update` | | [getBrokerSubAccountDeposits()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2721) | :closed_lock_with_key: | GET | `/v5/broker/asset/query-sub-member-deposit-record` |
| [getP2PPersonalAds()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2721) | :closed_lock_with_key: | POST | `/v5/p2p/item/personal/list` | | [getBrokerVoucherSpec()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2736) | :closed_lock_with_key: | POST | `/v5/broker/award/info` |
| [getP2PAdDetail()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2730) | :closed_lock_with_key: | POST | `/v5/p2p/item/info` | | [issueBrokerVoucher()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2748) | :closed_lock_with_key: | POST | `/v5/broker/award/distribute-award` |
| [getP2POrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2745) | :closed_lock_with_key: | POST | `/v5/p2p/order/simplifyList` | | [getBrokerIssuedVoucher()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2760) | :closed_lock_with_key: | POST | `/v5/broker/award/distribution-record` |
| [getP2POrderDetail()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2755) | :closed_lock_with_key: | POST | `/v5/p2p/order/info` | | [getEarnProduct()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2777) | | GET | `/v5/earn/product` |
| [getP2PPendingOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2764) | :closed_lock_with_key: | POST | `/v5/p2p/order/pending/simplifyList` | | [submitStakeRedeem()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2795) | :closed_lock_with_key: | POST | `/v5/earn/place-order` |
| [markP2POrderAsPaid()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2773) | :closed_lock_with_key: | POST | `/v5/p2p/order/pay` | | [getEarnOrderHistory()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2812) | :closed_lock_with_key: | GET | `/v5/earn/order` |
| [releaseP2POrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2782) | :closed_lock_with_key: | POST | `/v5/p2p/order/finish` | | [getEarnPosition()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2827) | :closed_lock_with_key: | GET | `/v5/earn/position` |
| [sendP2POrderMessage()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2791) | :closed_lock_with_key: | POST | `/v5/p2p/order/message/send` | | [getP2PAccountCoinsBalance()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2851) | :closed_lock_with_key: | GET | `/v5/asset/transfer/query-account-coins-balance` |
| [uploadP2PChatFile()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2800) | :closed_lock_with_key: | POST | `/v5/p2p/oss/upload_file` | | [getP2POnlineAds()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2868) | | POST | `/v5/p2p/item/online` |
| [getP2POrderMessages()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2809) | :closed_lock_with_key: | POST | `/v5/p2p/order/message/listpage` | | [createP2PAd()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2877) | :closed_lock_with_key: | POST | `/v5/p2p/item/create` |
| [getP2PUserInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2823) | :closed_lock_with_key: | POST | `/v5/p2p/user/personal/info` | | [cancelP2PAd()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2886) | :closed_lock_with_key: | POST | `/v5/p2p/item/cancel` |
| [getP2PCounterpartyUserInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2830) | :closed_lock_with_key: | POST | `/v5/p2p/user/order/personal/info` | | [updateP2PAd()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2900) | :closed_lock_with_key: | POST | `/v5/p2p/item/update` |
| [getP2PUserPayments()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2839) | :closed_lock_with_key: | POST | `/v5/p2p/user/payment/list` | | [getP2PPersonalAds()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2910) | :closed_lock_with_key: | POST | `/v5/p2p/item/personal/list` |
| [getP2PAdDetail()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2919) | :closed_lock_with_key: | POST | `/v5/p2p/item/info` |
| [getP2POrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2934) | :closed_lock_with_key: | POST | `/v5/p2p/order/simplifyList` |
| [getP2POrderDetail()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2944) | :closed_lock_with_key: | POST | `/v5/p2p/order/info` |
| [getP2PPendingOrders()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2953) | :closed_lock_with_key: | POST | `/v5/p2p/order/pending/simplifyList` |
| [markP2POrderAsPaid()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2962) | :closed_lock_with_key: | POST | `/v5/p2p/order/pay` |
| [releaseP2POrder()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2971) | :closed_lock_with_key: | POST | `/v5/p2p/order/finish` |
| [sendP2POrderMessage()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2980) | :closed_lock_with_key: | POST | `/v5/p2p/order/message/send` |
| [uploadP2PChatFile()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2989) | :closed_lock_with_key: | POST | `/v5/p2p/oss/upload_file` |
| [getP2POrderMessages()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L2998) | :closed_lock_with_key: | POST | `/v5/p2p/order/message/listpage` |
| [getP2PUserInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L3012) | :closed_lock_with_key: | POST | `/v5/p2p/user/personal/info` |
| [getP2PCounterpartyUserInfo()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L3019) | :closed_lock_with_key: | POST | `/v5/p2p/user/order/personal/info` |
| [getP2PUserPayments()](https://github.com/tiagosiebler/bybit-api/blob/master/src/rest-client-v5.ts#L3028) | :closed_lock_with_key: | POST | `/v5/p2p/user/payment/list` |

View File

@@ -0,0 +1,21 @@
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
key: 'apiKey',
secret: 'apiSecret',
});
client
.amendSpreadOrder({
symbol: 'SOLUSDT_SOL/USDT',
orderLinkId: '1744072052193428475',
price: '14',
qty: '0.2',
})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});

View File

@@ -0,0 +1,16 @@
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
key: 'apiKey',
secret: 'apiSecret',
});
client
.cancelAllSpreadOrders()
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});

View File

@@ -0,0 +1,18 @@
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
key: 'apiKey',
secret: 'apiSecret',
});
client
.cancelSpreadOrder({
orderLinkId: '1744072052193428476',
})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});

View File

@@ -0,0 +1,24 @@
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
key: 'apiKey',
secret: 'apiSecret',
});
client
.submitSpreadOrder({
symbol: 'SOLUSDT_SOL/USDT',
side: 'Buy',
orderType: 'Limit',
qty: '0.1',
price: '21',
orderLinkId: '1744072052193428479',
timeInForce: 'PostOnly',
})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});

View File

@@ -0,0 +1,14 @@
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
});
client
.getSpreadInstrumentsInfo()
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});

View File

@@ -0,0 +1,16 @@
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
key: 'apiKey',
secret: 'apiSecret',
});
client
.getSpreadOpenOrders()
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});

View File

@@ -0,0 +1,18 @@
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
key: 'apiKey',
secret: 'apiSecret',
});
client
.getSpreadOrderHistory({
orderId: '5e010c35-2b44-4f03-8081-8fa31fb73376',
})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});

View File

@@ -0,0 +1,17 @@
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
});
client
.getSpreadOrderbook({
symbol: 'SOLUSDT_SOL/USDT',
limit: 1, // Show 5 levels of depth
})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});

View File

@@ -0,0 +1,16 @@
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
});
client
.getSpreadTickers({
symbol: 'SOLUSDT_SOL/USDT',
})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});

View File

@@ -0,0 +1,18 @@
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
key: 'apiKey',
secret: 'apiSecret',
});
client
.getSpreadTradeHistory({
orderId: '5e010c35-2b44-4f03-8081-8fa31fb73376',
})
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{ {
"name": "bybit-api", "name": "bybit-api",
"version": "4.1.3", "version": "4.1.4",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "bybit-api", "name": "bybit-api",
"version": "4.1.3", "version": "4.1.4",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"axios": "^1.7.9", "axios": "^1.7.9",

View File

@@ -1,6 +1,6 @@
{ {
"name": "bybit-api", "name": "bybit-api",
"version": "4.1.3", "version": "4.1.4",
"description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.", "description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
"main": "lib/index.js", "main": "lib/index.js",
"types": "lib/index.d.ts", "types": "lib/index.d.ts",

View File

@@ -16,6 +16,7 @@ import {
AllCoinsBalanceV5, AllCoinsBalanceV5,
AllowedDepositCoinInfoV5, AllowedDepositCoinInfoV5,
AmendOrderParamsV5, AmendOrderParamsV5,
AmendSpreadOrderParamsV5,
ApiKeyInfoV5, ApiKeyInfoV5,
AssetInfoV5, AssetInfoV5,
BatchAmendOrderParamsV5, BatchAmendOrderParamsV5,
@@ -125,6 +126,10 @@ import {
GetRiskLimitParamsV5, GetRiskLimitParamsV5,
GetSettlementRecordParamsV5, GetSettlementRecordParamsV5,
GetSpotLeveragedTokenOrderHistoryParamsV5, GetSpotLeveragedTokenOrderHistoryParamsV5,
GetSpreadInstrumentsInfoParamsV5,
GetSpreadOpenOrdersParamsV5,
GetSpreadOrderHistoryParamsV5,
GetSpreadTradeHistoryParamsV5,
GetSubAccountAllApiKeysParamsV5, GetSubAccountAllApiKeysParamsV5,
GetSubAccountDepositRecordParamsV5, GetSubAccountDepositRecordParamsV5,
GetTickersParamsV5, GetTickersParamsV5,
@@ -196,7 +201,15 @@ import {
SpotBorrowCheckResultV5, SpotBorrowCheckResultV5,
SpotLeveragedTokenOrderHistoryV5, SpotLeveragedTokenOrderHistoryV5,
SpotMarginStateV5, SpotMarginStateV5,
SpreadInstrumentInfoV5,
SpreadOpenOrderV5,
SpreadOrderHistoryV5,
SpreadOrderbookResponseV5,
SpreadRecentTradeV5,
SpreadTickerV5,
SpreadTradeV5,
SubMemberV5, SubMemberV5,
SubmitSpreadOrderParamsV5,
SubmitStakeRedeemParamsV5, SubmitStakeRedeemParamsV5,
SwitchIsolatedMarginParamsV5, SwitchIsolatedMarginParamsV5,
SwitchPositionModeParamsV5, SwitchPositionModeParamsV5,
@@ -336,6 +349,163 @@ export class RestClientV5 extends BaseRestClient {
return this.postPrivate('/v5/user/create-demo-member'); return this.postPrivate('/v5/user/create-demo-member');
} }
/**
*
****** Spread Trading APIs
*
*/
/**
* Get Spread Instruments Info
*/
getSpreadInstrumentsInfo(params?: GetSpreadInstrumentsInfoParamsV5): Promise<
APIResponseV3WithTime<{
list: SpreadInstrumentInfoV5[];
nextPageCursor: string;
}>
> {
return this.get('/v5/spread/instrument', params);
}
/**
* Get Spread Orderbook
*/
getSpreadOrderbook(params: {
symbol: string;
limit?: number;
}): Promise<APIResponseV3WithTime<SpreadOrderbookResponseV5>> {
return this.get('/v5/spread/orderbook', params);
}
/**
* Get Spread Tickers
*/
getSpreadTickers(params: { symbol: string }): Promise<
APIResponseV3WithTime<{
list: SpreadTickerV5[];
}>
> {
return this.get('/v5/spread/tickers', params);
}
/**
* Get Spread Public Recent Trades
*/
getSpreadRecentTrades(params: { symbol: string; limit?: number }): Promise<
APIResponseV3WithTime<{
list: SpreadRecentTradeV5[];
}>
> {
return this.get('/v5/spread/recent-trade', params);
}
/**
* Create Spread Order
*/
submitSpreadOrder(params: SubmitSpreadOrderParamsV5): Promise<
APIResponseV3WithTime<{
orderId: string;
orderLinkId: string;
}>
> {
return this.postPrivate('/v5/spread/order/create', params);
}
/**
* Amend Spread Order
* You can only modify unfilled or partially filled orders.
*/
amendSpreadOrder(params: AmendSpreadOrderParamsV5): Promise<
APIResponseV3WithTime<{
orderId: string;
orderLinkId: string;
}>
> {
return this.postPrivate('/v5/spread/order/amend', params);
}
/**
* Cancel Spread Order
*/
cancelSpreadOrder(params: {
orderId?: string;
orderLinkId?: string;
}): Promise<
APIResponseV3WithTime<{
orderId: string;
orderLinkId: string;
}>
> {
return this.postPrivate('/v5/spread/order/cancel', params);
}
/**
* Cancel All Spread Orders
*
* When a symbol is specified, all orders for that symbol will be canceled regardless of the cancelAll field.
* When symbol is not specified and cancelAll=true, all orders, regardless of the symbol, will be canceled.
*/
cancelAllSpreadOrders(params?: {
symbol?: string;
cancelAll?: boolean;
}): Promise<
APIResponseV3WithTime<{
list: {
orderId: string;
orderLinkId: string;
}[];
success: string;
}>
> {
return this.postPrivate('/v5/spread/order/cancel-all', params);
}
/**
* Get Spread Open Orders
* Query unfilled or partially filled orders in real-time.
*/
getSpreadOpenOrders(params?: GetSpreadOpenOrdersParamsV5): Promise<
APIResponseV3WithTime<{
list: SpreadOpenOrderV5[];
nextPageCursor: string;
}>
> {
return this.getPrivate('/v5/spread/order/realtime', params);
}
/**
* Get Spread Order History
*
* Note:
* - orderId & orderLinkId has a higher priority than startTime & endTime
* - Fully canceled orders are stored for up to 24 hours
* - Single leg orders can also be found with "createType"=CreateByFutureSpread via Get Order History
*/
getSpreadOrderHistory(params?: GetSpreadOrderHistoryParamsV5): Promise<
APIResponseV3WithTime<{
list: SpreadOrderHistoryV5[];
nextPageCursor: string;
}>
> {
return this.getPrivate('/v5/spread/order/history', params);
}
/**
* Get Spread Trade History
*
* Note:
* - In self-trade cases, both the maker and taker single-leg trades will be returned in the same request
* - Single leg executions can also be found with "execType"=FutureSpread via Get Trade History
*/
getSpreadTradeHistory(params?: GetSpreadTradeHistoryParamsV5): Promise<
APIResponseV3WithTime<{
list: SpreadTradeV5[];
nextPageCursor: string;
}>
> {
return this.getPrivate('/v5/spread/execution/list', params);
}
/** /**
* *
****** Market APIs ****** Market APIs

View File

@@ -1,5 +1,8 @@
export * from './response';
export * from './request'; export * from './request';
export * from './request/v5-spreadtrading';
export * from './response';
export * from './response/v5-spreadtrading';
export * from './shared'; export * from './shared';
export * from './shared-v5'; export * from './shared-v5';
export * from './websockets'; export * from './websockets';

View File

@@ -0,0 +1,53 @@
export interface GetSpreadInstrumentsInfoParamsV5 {
symbol?: string;
baseCoin?: string;
limit?: number;
cursor?: string;
}
export interface SubmitSpreadOrderParamsV5 {
symbol: string;
side: 'Buy' | 'Sell';
orderType: 'Limit' | 'Market';
qty: string;
price: string;
orderLinkId: string;
timeInForce: 'IOC' | 'FOK' | 'GTC' | 'PostOnly';
}
export interface AmendSpreadOrderParamsV5 {
symbol: string;
orderId?: string;
orderLinkId?: string;
qty?: string;
price?: string;
}
export interface GetSpreadOpenOrdersParamsV5 {
symbol?: string;
baseCoin?: string;
orderId?: string;
orderLinkId?: string;
limit?: number;
cursor?: string;
}
export interface GetSpreadOrderHistoryParamsV5 {
symbol?: string;
baseCoin?: string;
orderId?: string;
orderLinkId?: string;
startTime?: number;
endTime?: number;
limit?: number;
cursor?: string;
}
export interface GetSpreadTradeHistoryParamsV5 {
symbol?: string;
orderId?: string;
orderLinkId?: string;
startTime?: number;
endTime?: number;
limit?: number;
cursor?: string;
}

View File

@@ -0,0 +1,124 @@
export interface SpreadInstrumentInfoV5 {
symbol: string;
contractType: 'FundingRateArb' | 'CarryTrade' | 'FutureSpread' | 'PerpBasis';
status: 'Trading' | 'Settling';
baseCoin: string;
quoteCoin: string;
settleCoin: string;
tickSize: string;
minPrice: string;
maxPrice: string;
lotSize: string;
minSize: string;
maxSize: string;
launchTime: string;
deliveryTime: string;
legs: {
symbol: string;
contractType: 'LinearPerpetual' | 'LinearFutures' | 'Spot';
}[];
}
export interface SpreadOrderbookResponseV5 {
s: string; // Symbol
b: [string, string][]; // Bids array [price, size]
a: [string, string][]; // Asks array [price, size]
u: number; // Update ID
ts: number; // Timestamp
seq: number; // Sequence
cts: number; // Cross timestamp
}
export interface SpreadTickerV5 {
symbol: string; // Spread combination symbol name
bidPrice: string; // Bid 1 price
bidSize: string; // Bid 1 size
askPrice: string; // Ask 1 price
askSize: string; // Ask 1 size
lastPrice: string; // Last trade price
highPrice24h: string; // The highest price in the last 24 hours
lowPrice24h: string; // The lowest price in the last 24 hours
prevPrice24h: string; // Price 24 hours ago
volume24h: string; // Volume for 24h
}
export interface SpreadRecentTradeV5 {
execId: string; // Execution ID
symbol: string; // Spread combination symbol name
price: string; // Trade price
size: string; // Trade size
side: 'Buy' | 'Sell'; // Side of taker
time: string; // Trade time (ms)
}
export interface SpreadOpenOrderV5 {
symbol: string;
baseCoin: string;
orderType: 'Market' | 'Limit';
orderLinkId: string;
side: 'Buy' | 'Sell';
timeInForce: 'GTC' | 'FOK' | 'IOC' | 'PostOnly';
orderId: string;
leavesQty: string;
orderStatus: 'New' | 'PartiallyFilled';
cumExecQty: string;
price: string;
qty: string;
createdTime: string;
updatedTime: string;
}
export interface SpreadOrderHistoryV5 {
symbol: string;
orderType: 'Market' | 'Limit';
orderLinkId: string;
orderId: string;
contractType: 'FundingRateArb' | 'CarryTrade' | 'FutureSpread' | 'PerpBasis';
orderStatus: 'Rejected' | 'Cancelled' | 'Filled';
price: string;
orderQty: string;
orderPrice: string;
timeInForce: 'GTC' | 'FOK' | 'IOC' | 'PostOnly';
baseCoin: string;
createdAt: string;
updatedAt: string;
side: 'Buy' | 'Sell';
leavesQty: string;
settleCoin: string;
cumExecQty: string;
qty: string;
leg1Symbol: string;
leg1ProdType: 'Futures' | 'Spot';
leg1OrderId: string;
leg1Side: string;
leg2ProdType: 'Futures' | 'Spot';
leg2OrderId: string;
leg2Symbol: string;
leg2Side: string;
}
export interface SpreadTradeLegV5 {
symbol: string;
side: 'Buy' | 'Sell';
execPrice: string;
execTime: string;
execValue: string;
execType: string;
category: 'linear' | 'spot';
execQty: string;
execFee: string;
execId: string;
}
export interface SpreadTradeV5 {
symbol: string;
orderLinkId: string;
side: 'Buy' | 'Sell';
orderId: string;
execPrice: string;
execTime: string;
execType: 'Trade';
execQty: string;
execId: string;
legs: SpreadTradeLegV5[];
}

View File

@@ -258,6 +258,7 @@ export interface PermissionsV5 {
CopyTrading?: string[]; CopyTrading?: string[];
BlockTrade?: string[]; BlockTrade?: string[];
Exchange?: string[]; Exchange?: string[];
/** @deprecated , always returns []*/
NFT?: string[]; NFT?: string[];
} }

View File

@@ -383,3 +383,69 @@ export interface WSGreeksV5 {
} }
export type WSGreeksEventV5 = WSPrivateTopicEventV5<'greeks', WSGreeksV5[]>; export type WSGreeksEventV5 = WSPrivateTopicEventV5<'greeks', WSGreeksV5[]>;
export interface WSSpreadOrderV5 {
category: 'combination' | 'spot_leg' | 'future_leg';
symbol: string;
parentOrderId: string;
orderId: string;
orderLinkId: string;
side: OrderSideV5;
orderStatus: OrderStatusV5;
cancelType: OrderCancelTypeV5;
rejectReason: OrderRejectReasonV5;
timeInForce: OrderTimeInForceV5;
price: string;
qty: string;
avgPrice: string;
leavesQty: string;
leavesValue: string;
cumExecQty: string;
cumExecValue: string;
cumExecFee: string;
orderType: OrderTypeV5;
isLeverage: string;
createdTime: string;
updatedTime: string;
feeCurrency: string;
createType: OrderCreateTypeV5;
closedPnl: string;
}
export type WSSpreadOrderEventV5 = WSPrivateTopicEventV5<
'spread.order',
WSSpreadOrderV5[]
>;
export interface WSSpreadExecutionV5 {
category: 'combination' | 'spot_leg' | 'future_leg';
symbol: string;
isLeverage: string;
orderId: string;
orderLinkId: string;
side: OrderSideV5;
orderPrice: string;
orderQty: string;
leavesQty: string;
createType: OrderCreateTypeV5;
orderType: OrderTypeV5;
execFee: string;
parentExecId: string;
execId: string;
execPrice: string;
execQty: string;
execPnl: string;
execType: ExecTypeV5;
execValue: string;
execTime: string;
isMaker: boolean;
feeRate: string;
markPrice: string;
closedSize: string;
seq: number;
}
export type WSSpreadExecutionEventV5 = WSPrivateTopicEventV5<
'spread.execution',
WSSpreadExecutionV5[]
>;