diff --git a/docs/changelog/v5.mdx b/docs/changelog/v5.mdx index 6cc165bb42..6fa489e2c2 100644 --- a/docs/changelog/v5.mdx +++ b/docs/changelog/v5.mdx @@ -6,6 +6,23 @@ import '/src/css/changelog.css'; ## 2026-03-24 ### REST API +- [Get Spread Max Qty](../v5/spread/trade/max-qty) [NEW] + - Add a new endpoint to query the available balance for placing a spread order based on symbol ID, side, and order price +- [Get Option Asset Info](../v5/account/option-asset-info) [NEW] + - Add a new endpoint to query option asset P&L information per coin, including delta, realised/unrealised P&L, and margin data +- [Get Portfolio Margin Info](../v5/asset/portfolio-margin) [NEW] + - Add a new endpoint to query portfolio margin account wallet balance and asset P&L range information +- [Get Merge Borrow Info](../v5/account/merge-borrow-info) [NEW] + - Add a new endpoint to query merged borrow information and collateral details for the account +- [Get Pay Info](../v5/account/pay-info) [NEW] + - Add a new endpoint to query repayment collateral information for the account +- [Get Trade Info For Analysis](../v5/account/trade-info-for-analysis) [NEW] + - Add a new endpoint to query aggregated trade statistics for a symbol, including execution values, quantities, fees, and daily breakdown +- [Get Total Members Assets](../v5/asset/total-members-assets) [NEW] + - Add a new endpoint to query total assets across all member accounts with optional coin-denominated valuation +- [Get Trade Behaviour Config](../v5/account/get-user-setting-config) [UPDATE] + - Add new response fields `smsef` and `fmsef` to indicate whether Spot and Futures MNT fee deduction is enabled + - [Manual Repay](../v5/account/repay) [UPDATE] - [Repay Liability](../v5/account/repay-liability) [UPDATE] - [Manual Repay Without Asset Conversion](../v5/account/no-convert-repay) [UPDATE] diff --git a/docs/v5/account/get-user-setting-config.mdx b/docs/v5/account/get-user-setting-config.mdx index 848a2bac65..f132228008 100644 --- a/docs/v5/account/get-user-setting-config.mdx +++ b/docs/v5/account/get-user-setting-config.mdx @@ -38,6 +38,8 @@ None |> lpaSpot |boolean || |> lpaPerp |boolean || |> deltaEnable |boolean |Whether [Delta Neutral mode](/docs/v5/account/set-delta-mode) is enabled. `true`: enabled; `false`: disabled| +|> smsef |boolean |Whether Spot MNT fee deduction is enabled. `true`: enabled; `false`: disabled| +|> fmsef |boolean |Whether Futures MNT fee deduction is enabled. `true`: enabled; `false`: disabled| ### Request Example @@ -87,11 +89,12 @@ print(session.get_user_setting_config()) "retCode": 0, "retMsg": "OK", "result": { - "lpaSpot": true, + "lpaSpot": false, "lpaPerp": false, - "deltaEnable": false + "smsef": false, + "fmsef": false }, "retExtInfo": {}, - "time": 1756794317787 + "time": 1773234932707 } ``` diff --git a/docs/v5/account/merge-borrow-info.mdx b/docs/v5/account/merge-borrow-info.mdx new file mode 100644 index 0000000000..aeac05296f --- /dev/null +++ b/docs/v5/account/merge-borrow-info.mdx @@ -0,0 +1,111 @@ +--- +title: Get Merge Borrow Info +sidebar_label: Get Merge Borrow Info +sidebar_position: 24 +--- + +Query merged borrow information and collateral details for the account. + +### HTTP Request + + +### Request Parameters +| Parameter | Required | Type | Comments| +|:----- |:-------|:-----|------ | +|coin |false |string |Coin name, e.g. `USDT`, `BTC`. Returns all borrow info if not passed| + +### Response Parameters +| Parameter | Type | Comments| +|:----- |:-----|----- | +|borrowInfo |object |Borrow info | +|> coin |string |Borrowed coin | +|> borrowSize |string |Borrow size | +|> borrowValue |string |Borrow value | +|> assetFrozen |string |Frozen asset | +|> availableBalance |string |Available balance | +|> totalLiability |string |Total liability | +|collateralInfo |object |Collateral info | +|> totalAvailable |string |Total available collateral value | +|> fee |string |Fee | +|> collateralList |array<object> |Collateral list | +|>> coin |string |Collateral coin | +|>> availableSize |string |Available size | +|>> availableValue |string |Available value | +|>> coinScale |integer |Coin precision | +|>> spotHedgeAmount |string |Spot hedge amount | +|>> assetFrozen |string |Frozen asset | + +### Request Example + + + + +```http +GET /v5/account/merge-borrow-info?coin=USDT HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### Response Example + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "collateralInfo": { + "totalAvailable": "17.45", + "collateralList": [ + { + "availableValue": "0.02", + "coinScale": 8, + "spotHedgeAmount": "0.00000000", + "assetFrozen": "", + "availableSize": "0.02927721", + "coin": "BTC" + }, + { + "availableValue": "17.42", + "coinScale": 4, + "spotHedgeAmount": "0.0000", + "assetFrozen": "", + "availableSize": "1216139.7497", + "coin": "USDT" + } + ], + "fee": "0.0003007168" + }, + "borrowInfo": { + "borrowSize": "", + "totalLiability": "", + "assetFrozen": "", + "borrowValue": "0.30", + "coin": "", + "availableBalance": "17.15" + } + }, + "retExtInfo": {}, + "time": 1773230926409 +} +``` diff --git a/docs/v5/account/option-asset-info.mdx b/docs/v5/account/option-asset-info.mdx new file mode 100644 index 0000000000..5b5fc6b055 --- /dev/null +++ b/docs/v5/account/option-asset-info.mdx @@ -0,0 +1,83 @@ +--- +title: Get Option Asset Info +sidebar_label: Get Option Asset Info +sidebar_position: 23 +--- + +Query the option asset profit and loss information for each coin under the account. + +### HTTP Request + + +### Request Parameters +None + +### Response Parameters +| Parameter | Type | Comments| +|:----- |:-----|----- | +|result |array<object> |Asset P&L info list | +|> coin |string |Coin name | +|> totalDelta |string |Total delta. Only includes delta from option **positions** | +|> totalRPL |string |Total realised P&L | +|> totalUPL |string |Total unrealised P&L | +|> assetIM |string |Asset initial margin. Includes IM occupied by option **open orders** | +|> assetMM |string |Asset maintenance margin. Includes MM occupied by option **open orders** | +|> version |long |Version number | +|> sendTime |long |Send timestamp (ms) | + +### Request Example + + + + +```http +GET /v5/account/option-asset-info HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### Response Example + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "result": [ + { + "totalDelta": "0.0118", + "assetIM": "0.0000", + "totalUPL": "-47.6318", + "totalRPL": "-0.2790", + "assetMM": "0.0000", + "version": 1600758, + "coin": "BTC", + "sendTime": 1773230923530 + } + ] + }, + "retExtInfo": {}, + "time": 1773230923533 +} +``` diff --git a/docs/v5/account/pay-info.mdx b/docs/v5/account/pay-info.mdx new file mode 100644 index 0000000000..7e6fdc93e5 --- /dev/null +++ b/docs/v5/account/pay-info.mdx @@ -0,0 +1,104 @@ +--- +title: Get Pay Info +sidebar_label: Get Pay Info +sidebar_position: 25 +--- + +Query repayment collateral information for the account. + +### HTTP Request + + +### Request Parameters +| Parameter | Required | Type | Comments| +|:----- |:-------|:-----|------ | +|coin |false |string |Coin name, e.g. `USDT`, `BTC`. Returns all repayment info if not passed| + +### Response Parameters +| Parameter | Type | Comments| +|:----- |:-----|----- | +|collateralInfo |object |Collateral info | +|> collateralList |array<object> |Collateral list | +|>> coin |string |Coin name | +|>> availableSize |string |Available size | +|>> availableValue |string |Available value | +|>> coinScale |integer |Coin precision | +|>> borrowSize |string |Borrow size | +|>> spotHedgeAmount |string |Spot hedge amount | +|>> assetFrozen |string |Frozen asset | + +### Request Example + + + + +```http +GET /v5/account/pay-info?coin=USDT HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### Response Example + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "collateralInfo": { + "collateralList": [ + { + "availableValue": "0", + "coinScale": 6, + "borrowSize": "0", + "spotHedgeAmount": "0", + "assetFrozen": "0", + "availableSize": "0", + "coin": "USDC" + }, + { + "availableValue": "0.3292772100000000000", + "coinScale": 8, + "borrowSize": "0.3", + "spotHedgeAmount": "0", + "assetFrozen": "0", + "availableSize": "0.329277210000000000", + "coin": "BTC" + }, + { + "availableValue": "17.42799911416770180000000000", + "coinScale": 4, + "borrowSize": "50", + "spotHedgeAmount": "0", + "assetFrozen": "0", + "availableSize": "1216139.749700000000000000", + "coin": "USDT" + } + ] + } + }, + "retExtInfo": {}, + "time": 1773230926882 +} +``` diff --git a/docs/v5/account/trade-info-for-analysis.mdx b/docs/v5/account/trade-info-for-analysis.mdx new file mode 100644 index 0000000000..4a27c8a336 --- /dev/null +++ b/docs/v5/account/trade-info-for-analysis.mdx @@ -0,0 +1,105 @@ +--- +title: Get Trade Info For Analysis +sidebar_label: Get Trade Info For Analysis +sidebar_position: 26 +--- + +Query aggregated trade statistics for a symbol, including execution values, quantities, fees, and daily breakdown. This endpoint returns **spot execution volume** data. + +### HTTP Request + + +### Request Parameters +| Parameter | Required | Type | Comments| +|:----- |:-------|:-----|------ | +|symbol |**true** |string |Symbol name, e.g. `BTCUSDT`, `ETHUSDT`| +|startTime |false |long |Query start time (ms)| +|endTime |false |long |Query end time (ms)| + +### Response Parameters +| Parameter | Type | Comments| +|:----- |:-----|----- | +|symbolRnl |string |Symbol realised P&L | +|netExecQty |string |Net execution quantity | +|sumExecValue |string |Total execution value | +|sumExecQty |string |Total execution quantity | +|avgBuyExecPrice |string |Average buy execution price | +|sumBuyExecValue |string |Total buy execution value | +|sumBuyExecQty |string |Total buy execution quantity | +|sumBuyExecFee |string |Total buy execution fee | +|sumBuyOrderQty |string |Total buy order quantity | +|avgSellExecPrice |string |Average sell execution price | +|sumSellExecValue |string |Total sell execution value | +|sumSellExecQty |string |Total sell execution quantity | +|sumSellExecFee |string |Total sell execution fee | +|sumSellOrderQty |string |Total sell order quantity | +|maxMarginVersion |integer |Max margin version number | +|baseCoin |string |Base coin | +|settleCoin |string |Settle coin | +|sumPriceList |array<object> |Daily aggregated price list | +|> day |string |Date | +|> sumBuyExecValue |string |Daily total buy execution value | +|> sumSellExecValue |string |Daily total sell execution value | +|> sumExecValue |string |Daily total execution value | + +### Request Example + + + + +```http +GET /v5/account/trade-info-for-analysis?symbol=ETHUSDT HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### Response Example + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "symbolRnl": "0", + "sumBuyExecValue": "0", + "sumBuyExecQty": "0", + "sumSellExecFee": "0", + "netExecQty": "0", + "sumExecQty": "0", + "settleCoin": "USDT", + "sumExecValue": "0", + "sumSellExecValue": "0", + "sumBuyOrderQty": "0", + "sumSellOrderQty": "0", + "maxMarginVersion": 0, + "avgSellExecPrice": "0", + "avgBuyExecPrice": "0", + "sumBuyExecFee": "0", + "sumSellExecQty": "0", + "baseCoin": "ETH" + }, + "retExtInfo": {}, + "time": 1773230927308 +} +``` diff --git a/docs/v5/asset/portfolio-margin.mdx b/docs/v5/asset/portfolio-margin.mdx new file mode 100644 index 0000000000..dd8545a640 --- /dev/null +++ b/docs/v5/asset/portfolio-margin.mdx @@ -0,0 +1,97 @@ +--- +title: Get Portfolio Margin Info +sidebar_label: Get Portfolio Margin Info +sidebar_position: 14 +--- + +Query portfolio margin account balance and asset P&L range information. + +### HTTP Request + + +### Request Parameters +| Parameter | Required | Type | Comments| +|:----- |:-------|:-----|------ | +|baseCoin |false |string |Base coin, e.g. `BTC`, `ETH`. Returns all if not passed| + +### Response Parameters +| Parameter | Type | Comments| +|:----- |:-----|----- | +|wallet |object |Wallet info | +|> equity |string |Equity | +|> cashBalance |string |Cash balance | +|> marginBalance |string |Margin balance | +|> availableBalance |string |Available balance | +|> totalRPL |string |Total realised P&L | +|> totalSessionRPL |string |Today's realised P&L | +|> totalSessionUPL |string |Today's unrealised P&L | +|> accountIM |string |Account initial margin | +|> accountMM |string |Account maintenance margin | +|> experienceBalance |string |Experience bonus balance | +|> perpUPL |string |Perpetual contract unrealised P&L | +|> accountMMRate |string |Account maintenance margin rate | +|> accountIMRate |string |Account initial margin rate | +|assetPnlRange |array |Asset P&L range list | +|traceId |string |Trace ID | + +### Request Example + + + + +```http +GET /v5/asset/portfolio-margin?baseCoin=BTC HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### Response Example + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "wallet": { + "equity": "0.00000000", + "cashBalance": "0.00000000", + "marginBalance": "0.00000000", + "availableBalance": "0.00000000", + "totalRPL": "0.00000000", + "totalSessionRPL": "0.00000000", + "totalSessionUPL": "0.00000000", + "accountIM": "0.00000000", + "accountMM": "0.00000000", + "experienceBalance": "0.00000000", + "perpUPL": "0.00000000", + "accountMMRate": "0.0000", + "accountIMRate": "0.0000" + }, + "assetPnlRange": [], + "traceId": "455b871a3b266aab5c9adea7131c1f17" + }, + "retExtInfo": {}, + "time": 1773230923610 +} +``` diff --git a/docs/v5/asset/total-members-assets.mdx b/docs/v5/asset/total-members-assets.mdx new file mode 100644 index 0000000000..8a340544a9 --- /dev/null +++ b/docs/v5/asset/total-members-assets.mdx @@ -0,0 +1,109 @@ +--- +title: Get Total Members Assets +sidebar_label: Get Total Members Assets +sidebar_position: 15 +--- + +Query total assets across all member accounts (master and sub-accounts), with optional coin-denominated valuation. + +### HTTP Request + + +### Request Parameters +| Parameter | Required | Type | Comments| +|:----- |:-------|:-----|------ | +|coin |false |string |Coin name, e.g. `BTC`, `USDT`. If not specified, defaults to `BTC`. If specified, total assets will be quoted in this coin| + +### Response Parameters +| Parameter | Type | Comments| +|:----- |:-----|----- | +|total |string |Total asset value | +|quoteTotal |string |Total asset value in quoted coin | +|stat |integer |Status | +|list |array<object> |Account asset list | +|> uid |long |User ID | +|> isM |boolean |Whether it is a master account | +|> stat |integer |Account status | +|> origb |string |Original balance in USD | +|> quoteb |string |Balance in quoted coin (the coin specified in the request parameter) | +|> items |array<object> |Sub-account type breakdown | +|>> type |string |Account type, e.g. `ACCOUNT_TYPE_FUND`, `ACCOUNT_TYPE_UNIFIED` | +|>> origb |string |Original balance in USD | +|>> quoteb |string |Balance in quoted coin (the coin specified in the request parameter) | +|>> stat |integer |Status | + +### Request Example + + + + +```http +GET /v5/asset/total-members-assets?coin=BTC HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### Response Example + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "total": "7369376.9136310276027477088095516543224115696", + "stat": 0, + "quoteTotal": "126.18796084984636306", + "list": [ + { + "origb": "7252396.5385745423203887154762334543224115696", + "uid": 1001796602, + "isM": true, + "stat": 0, + "items": [ + { + "origb": "7180203.788461284230524983", + "stat": 0, + "type": "ACCOUNT_TYPE_FUND", + "quoteb": "122.948695007898702577" + }, + { + "origb": "17.467024256661260423", + "stat": 0, + "type": "ACCOUNT_TYPE_UNIFIED", + "quoteb": "0.000299092881107213" + }, + { + "origb": "17920.161", + "stat": 0, + "type": "ACCOUNT_TYPE_CONTRACT", + "quoteb": "0.306782556651556862" + } + ] + } + ] + }, + "retExtInfo": {}, + "time": 1773230927614 +} +``` diff --git a/docs/v5/spread/trade/max-qty.mdx b/docs/v5/spread/trade/max-qty.mdx new file mode 100644 index 0000000000..d2fce2e04b --- /dev/null +++ b/docs/v5/spread/trade/max-qty.mdx @@ -0,0 +1,47 @@ +--- +title: Get Max Qty +sidebar_label: Get Max Qty +sidebar_position: 8 +--- + +Query the available balance for placing a spread order based on the given symbol, side, and order price. + +### HTTP Request + + +### Request Parameters +| Parameter | Required | Type | Comments| +|:----- |:-------|:-----|------ | +|symbolId |**true** |integer |Spread symbol ID| +|side |**true** |string |Order side. `1`: Buy, `2`: Sell| +|orderPrice |**true** |string |Order price| + +### Response Parameters +| Parameter | Type | Comments| +|:----- |:-----|----- | +|ab |string |Available balance (truncated to 8 decimal places)| + +### Request Example + +```http +GET /v5/spread/max-qty?symbolId=1&side=1&orderPrice=50000 HTTP/1.1 +Host: api-testnet.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: XXXXXX +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +Content-Type: application/json +``` + +### Response Example +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "ab": "0.00000000" + }, + "retExtInfo": {}, + "time": 1773230923211 +} +``` diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/changelog/v5.mdx b/i18n/zh-TW/docusaurus-plugin-content-docs/current/changelog/v5.mdx index 63d908820d..6eb22b8093 100644 --- a/i18n/zh-TW/docusaurus-plugin-content-docs/current/changelog/v5.mdx +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/changelog/v5.mdx @@ -6,6 +6,23 @@ import '/src/css/changelog.css'; ## 2026-03-24 ### REST API +- [查詢價差最大下單數量](../v5/spread/trade/max-qty) [新增] + - 新增接口，根據交易對ID、方向及下單價格查詢下單可用餘額 +- [查詢期權資產信息](../v5/account/option-asset-info) [新增] + - 新增接口，查詢帳戶下各幣種的期權資產盈虧信息，包含Delta、已實現/未實現盈虧及保證金數據 +- [查詢組合保證金信息](../v5/asset/portfolio-margin) [新增] + - 新增接口，查詢組合保證金帳戶的錢包餘額及資產盈虧範圍信息 +- [查詢合併借貸信息](../v5/account/merge-borrow-info) [新增] + - 新增接口，查詢帳戶的合併借貸信息及抵押品詳情 +- [查詢還款信息](../v5/account/pay-info) [新增] + - 新增接口，查詢帳戶的還款抵押品信息 +- [查詢交易分析信息](../v5/account/trade-info-for-analysis) [新增] + - 新增接口，查詢指定交易對的聚合交易統計信息，包括成交金額、數量、手續費及每日明細 +- [查詢全部成員資產](../v5/asset/total-members-assets) [新增] + - 新增接口，查詢所有成員帳戶的總資產，支持指定幣種計價 +- [查詢交易行為設置](../v5/account/get-user-setting-config) [更新] + - 新增響應字段 `smsef` 和 `fmsef`，分別表示現貨及合約MNT手續費抵扣開關狀態 + - [手工還款](../v5/account/repay) [更新] - [一鍵還款](../v5/account/repay-liability) [更新] - [無損手工還款](../v5/account/no-convert-repay) [更新] diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/get-user-setting-config.mdx b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/get-user-setting-config.mdx index 266a21bde8..8298623344 100644 --- a/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/get-user-setting-config.mdx +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/get-user-setting-config.mdx @@ -35,6 +35,8 @@ sidebar_position: 21 |> lpaSpot |boolean |
  • `true`: 若下單價格超出限制範圍，系統會自動將價格調整至允許的最近邊界
  • `false`: 若下單價格超出限制範圍，系統將拒絕該請求
| |> lpaPerp |boolean |
  • `true`: 若下單價格超出限制範圍，系統將拒絕該請求
  • `false`: 若下單價格超出限制範圍，系統會自動將價格調整至允許的最近邊界
| |> deltaEnable |boolean |[Delta 中性模式](./set-delta-mode) 是否已開啟。`true`: 已開啟；`false`: 已關閉| +|> smsef |boolean |現貨MNT手續費抵扣開關。`true`: 已開啟；`false`: 已關閉| +|> fmsef |boolean |合約MNT手續費抵扣開關。`true`: 已開啟；`false`: 已關閉| ### 請求示例 @@ -84,11 +86,12 @@ print(session.get_user_setting_config()) "retCode": 0, "retMsg": "OK", "result": { - "lpaSpot": true, + "lpaSpot": false, "lpaPerp": false, - "deltaEnable": false + "smsef": false, + "fmsef": false }, "retExtInfo": {}, - "time": 1756794317787 + "time": 1773234932707 } ``` diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/merge-borrow-info.mdx b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/merge-borrow-info.mdx new file mode 100644 index 0000000000..691132fd5c --- /dev/null +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/merge-borrow-info.mdx @@ -0,0 +1,111 @@ +--- +title: 查詢合併借貸信息 +sidebar_label: 查詢合併借貸信息 +sidebar_position: 24 +--- + +查詢帳戶的合併借貸信息及抵押品詳情。 + +### HTTP 請求 + + +### 請求參數 +| 參數 | 是否必需 | 類型 | 說明| +|:----- |:-------|:-----|------ | +|coin |false |string |幣種，如 `USDT`、`BTC`。不傳則返回全部借貸信息| + +### 響應參數 +| 參數 | 類型 | 說明| +|:----- |:-----|----- | +|borrowInfo |object |借貸信息 | +|> coin |string |借貸幣種 | +|> borrowSize |string |借貸數量 | +|> borrowValue |string |借貸價值 | +|> assetFrozen |string |凍結資產 | +|> availableBalance |string |可用餘額 | +|> totalLiability |string |總負債 | +|collateralInfo |object |抵押品信息 | +|> totalAvailable |string |總可用抵押品價值 | +|> fee |string |費用 | +|> collateralList |array<object> |抵押品列表 | +|>> coin |string |抵押品幣種 | +|>> availableSize |string |可用數量 | +|>> availableValue |string |可用價值 | +|>> coinScale |integer |幣種精度 | +|>> spotHedgeAmount |string |現貨對沖數量 | +|>> assetFrozen |string |凍結資產 | + +### 請求示例 + + + + +```http +GET /v5/account/merge-borrow-info?coin=USDT HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### 響應示例 + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "collateralInfo": { + "totalAvailable": "17.45", + "collateralList": [ + { + "availableValue": "0.02", + "coinScale": 8, + "spotHedgeAmount": "0.00000000", + "assetFrozen": "", + "availableSize": "0.02927721", + "coin": "BTC" + }, + { + "availableValue": "17.42", + "coinScale": 4, + "spotHedgeAmount": "0.0000", + "assetFrozen": "", + "availableSize": "1216139.7497", + "coin": "USDT" + } + ], + "fee": "0.0003007168" + }, + "borrowInfo": { + "borrowSize": "", + "totalLiability": "", + "assetFrozen": "", + "borrowValue": "0.30", + "coin": "", + "availableBalance": "17.15" + } + }, + "retExtInfo": {}, + "time": 1773230926409 +} +``` diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/option-asset-info.mdx b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/option-asset-info.mdx new file mode 100644 index 0000000000..624e713485 --- /dev/null +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/option-asset-info.mdx @@ -0,0 +1,83 @@ +--- +title: 查詢期權資產信息 +sidebar_label: 查詢期權資產信息 +sidebar_position: 23 +--- + +查詢帳戶下各幣種的期權資產盈虧信息。 + +### HTTP 請求 + + +### 請求參數 +無 + +### 響應參數 +| 參數 | 類型 | 說明| +|:----- |:-----|----- | +|result |array<object> |資產盈虧信息列表 | +|> coin |string |幣種 | +|> totalDelta |string |總Delta。僅包含期權**持倉**的總Delta | +|> totalRPL |string |總已實現盈虧 | +|> totalUPL |string |總未實現盈虧 | +|> assetIM |string |資產初始保證金。包含期權**掛單**所占用的IM | +|> assetMM |string |資產維持保證金。包含期權**掛單**所占用的MM | +|> version |long |版本號 | +|> sendTime |long |發送時間戳（毫秒） | + +### 請求示例 + + + + +```http +GET /v5/account/option-asset-info HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### 響應示例 + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "result": [ + { + "totalDelta": "0.0118", + "assetIM": "0.0000", + "totalUPL": "-47.6318", + "totalRPL": "-0.2790", + "assetMM": "0.0000", + "version": 1600758, + "coin": "BTC", + "sendTime": 1773230923530 + } + ] + }, + "retExtInfo": {}, + "time": 1773230923533 +} +``` diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/pay-info.mdx b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/pay-info.mdx new file mode 100644 index 0000000000..38f6dc365f --- /dev/null +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/pay-info.mdx @@ -0,0 +1,104 @@ +--- +title: 查詢還款信息 +sidebar_label: 查詢還款信息 +sidebar_position: 25 +--- + +查詢帳戶的還款抵押品信息。 + +### HTTP 請求 + + +### 請求參數 +| 參數 | 是否必需 | 類型 | 說明| +|:----- |:-------|:-----|------ | +|coin |false |string |幣種，如 `USDT`、`BTC`。不傳則返回全部還款信息| + +### 響應參數 +| 參數 | 類型 | 說明| +|:----- |:-----|----- | +|collateralInfo |object |抵押品信息 | +|> collateralList |array<object> |抵押品列表 | +|>> coin |string |幣種 | +|>> availableSize |string |可用數量 | +|>> availableValue |string |可用價值 | +|>> coinScale |integer |幣種精度 | +|>> borrowSize |string |借貸數量 | +|>> spotHedgeAmount |string |現貨對沖數量 | +|>> assetFrozen |string |凍結資產 | + +### 請求示例 + + + + +```http +GET /v5/account/pay-info?coin=USDT HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### 響應示例 + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "collateralInfo": { + "collateralList": [ + { + "availableValue": "0", + "coinScale": 6, + "borrowSize": "0", + "spotHedgeAmount": "0", + "assetFrozen": "0", + "availableSize": "0", + "coin": "USDC" + }, + { + "availableValue": "0.3292772100000000000", + "coinScale": 8, + "borrowSize": "0.3", + "spotHedgeAmount": "0", + "assetFrozen": "0", + "availableSize": "0.329277210000000000", + "coin": "BTC" + }, + { + "availableValue": "17.42799911416770180000000000", + "coinScale": 4, + "borrowSize": "50", + "spotHedgeAmount": "0", + "assetFrozen": "0", + "availableSize": "1216139.749700000000000000", + "coin": "USDT" + } + ] + } + }, + "retExtInfo": {}, + "time": 1773230926882 +} +``` diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/trade-info-for-analysis.mdx b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/trade-info-for-analysis.mdx new file mode 100644 index 0000000000..c2f4ae46c9 --- /dev/null +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/account/trade-info-for-analysis.mdx @@ -0,0 +1,105 @@ +--- +title: 查詢交易分析信息 +sidebar_label: 查詢交易分析信息 +sidebar_position: 26 +--- + +查詢指定交易對的聚合交易統計信息，包括成交金額、數量、手續費及每日明細。此接口統計**現貨成交**交易量數據。 + +### HTTP 請求 + + +### 請求參數 +| 參數 | 是否必需 | 類型 | 說明| +|:----- |:-------|:-----|------ | +|symbol |**true** |string |交易對，如 `BTCUSDT`、`ETHUSDT`| +|startTime |false |long |查詢開始時間（毫秒時間戳）| +|endTime |false |long |查詢結束時間（毫秒時間戳）| + +### 響應參數 +| 參數 | 類型 | 說明| +|:----- |:-----|----- | +|symbolRnl |string |交易對已實現盈虧 | +|netExecQty |string |淨成交數量 | +|sumExecValue |string |總成交金額 | +|sumExecQty |string |總成交數量 | +|avgBuyExecPrice |string |平均買入成交價 | +|sumBuyExecValue |string |買入總成交金額 | +|sumBuyExecQty |string |買入總成交數量 | +|sumBuyExecFee |string |買入總手續費 | +|sumBuyOrderQty |string |買入總委託數量 | +|avgSellExecPrice |string |平均賣出成交價 | +|sumSellExecValue |string |賣出總成交金額 | +|sumSellExecQty |string |賣出總成交數量 | +|sumSellExecFee |string |賣出總手續費 | +|sumSellOrderQty |string |賣出總委託數量 | +|maxMarginVersion |integer |最大保證金版本號 | +|baseCoin |string |基礎幣種 | +|settleCoin |string |結算幣種 | +|sumPriceList |array<object> |每日匯總價格列表 | +|> day |string |日期 | +|> sumBuyExecValue |string |當日買入總成交金額 | +|> sumSellExecValue |string |當日賣出總成交金額 | +|> sumExecValue |string |當日總成交金額 | + +### 請求示例 + + + + +```http +GET /v5/account/trade-info-for-analysis?symbol=ETHUSDT HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### 響應示例 + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "symbolRnl": "0", + "sumBuyExecValue": "0", + "sumBuyExecQty": "0", + "sumSellExecFee": "0", + "netExecQty": "0", + "sumExecQty": "0", + "settleCoin": "USDT", + "sumExecValue": "0", + "sumSellExecValue": "0", + "sumBuyOrderQty": "0", + "sumSellOrderQty": "0", + "maxMarginVersion": 0, + "avgSellExecPrice": "0", + "avgBuyExecPrice": "0", + "sumBuyExecFee": "0", + "sumSellExecQty": "0", + "baseCoin": "ETH" + }, + "retExtInfo": {}, + "time": 1773230927308 +} +``` diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/asset/portfolio-margin.mdx b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/asset/portfolio-margin.mdx new file mode 100644 index 0000000000..19973d4eab --- /dev/null +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/asset/portfolio-margin.mdx @@ -0,0 +1,97 @@ +--- +title: 查詢組合保證金信息 +sidebar_label: 查詢組合保證金信息 +sidebar_position: 14 +--- + +查詢組合保證金帳戶的資產餘額及資產盈虧範圍信息。 + +### HTTP 請求 + + +### 請求參數 +| 參數 | 是否必需 | 類型 | 說明| +|:----- |:-------|:-----|------ | +|baseCoin |false |string |基礎幣種，如 `BTC`、`ETH`。不傳則返回全部| + +### 響應參數 +| 參數 | 類型 | 說明| +|:----- |:-----|----- | +|wallet |object |錢包信息 | +|> equity |string |權益 | +|> cashBalance |string |現金餘額 | +|> marginBalance |string |保證金餘額 | +|> availableBalance |string |可用餘額 | +|> totalRPL |string |總已實現盈虧 | +|> totalSessionRPL |string |當日已實現盈虧 | +|> totalSessionUPL |string |當日未實現盈虧 | +|> accountIM |string |賬戶初始保證金 | +|> accountMM |string |賬戶維持保證金 | +|> experienceBalance |string |體驗金餘額 | +|> perpUPL |string |永續合約未實現盈虧 | +|> accountMMRate |string |賬戶維持保證金率 | +|> accountIMRate |string |賬戶初始保證金率 | +|assetPnlRange |array |資產盈虧範圍列表 | +|traceId |string |追蹤ID | + +### 請求示例 + + + + +```http +GET /v5/asset/portfolio-margin?baseCoin=BTC HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### 響應示例 + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "wallet": { + "equity": "0.00000000", + "cashBalance": "0.00000000", + "marginBalance": "0.00000000", + "availableBalance": "0.00000000", + "totalRPL": "0.00000000", + "totalSessionRPL": "0.00000000", + "totalSessionUPL": "0.00000000", + "accountIM": "0.00000000", + "accountMM": "0.00000000", + "experienceBalance": "0.00000000", + "perpUPL": "0.00000000", + "accountMMRate": "0.0000", + "accountIMRate": "0.0000" + }, + "assetPnlRange": [], + "traceId": "455b871a3b266aab5c9adea7131c1f17" + }, + "retExtInfo": {}, + "time": 1773230923610 +} +``` diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/asset/total-members-assets.mdx b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/asset/total-members-assets.mdx new file mode 100644 index 0000000000..53019fe654 --- /dev/null +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/asset/total-members-assets.mdx @@ -0,0 +1,109 @@ +--- +title: 查詢全部成員資產 +sidebar_label: 查詢全部成員資產 +sidebar_position: 15 +--- + +查詢所有成員帳戶（母帳戶及子帳戶）的總資產，支持指定幣種計價。 + +### HTTP 請求 + + +### 請求參數 +| 參數 | 是否必需 | 類型 | 說明| +|:----- |:-------|:-----|------ | +|coin |false |string |幣種，如 `BTC`、`USDT`。不傳時默認為 `BTC`。指定後總資產以該幣種計價| + +### 響應參數 +| 參數 | 類型 | 說明| +|:----- |:-----|----- | +|total |string |總資產價值 | +|quoteTotal |string |計價後總資產價值 | +|stat |integer |狀態 | +|list |array<object> |帳戶資產列表 | +|> uid |long |用戶ID | +|> isM |boolean |是否為母帳戶 | +|> stat |integer |帳戶狀態 | +|> origb |string |USD 計價的原始餘額 | +|> quoteb |string |請求入參指定幣種計價的餘額 | +|> items |array<object> |子帳戶類型明細 | +|>> type |string |帳戶類型，如 `ACCOUNT_TYPE_FUND`、`ACCOUNT_TYPE_UNIFIED` | +|>> origb |string |USD 計價的原始餘額 | +|>> quoteb |string |請求入參指定幣種計價的餘額 | +|>> stat |integer |狀態 | + +### 請求示例 + + + + +```http +GET /v5/asset/total-members-assets?coin=BTC HTTP/1.1 +Host: api.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +``` + + + + +```python + +``` + + + + + +```n4js + +``` + + + + +### 響應示例 + +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "total": "7369376.9136310276027477088095516543224115696", + "stat": 0, + "quoteTotal": "126.18796084984636306", + "list": [ + { + "origb": "7252396.5385745423203887154762334543224115696", + "uid": 1001796602, + "isM": true, + "stat": 0, + "items": [ + { + "origb": "7180203.788461284230524983", + "stat": 0, + "type": "ACCOUNT_TYPE_FUND", + "quoteb": "122.948695007898702577" + }, + { + "origb": "17.467024256661260423", + "stat": 0, + "type": "ACCOUNT_TYPE_UNIFIED", + "quoteb": "0.000299092881107213" + }, + { + "origb": "17920.161", + "stat": 0, + "type": "ACCOUNT_TYPE_CONTRACT", + "quoteb": "0.306782556651556862" + } + ] + } + ] + }, + "retExtInfo": {}, + "time": 1773230927614 +} +``` diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/spread/trade/max-qty.mdx b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/spread/trade/max-qty.mdx new file mode 100644 index 0000000000..63ad559698 --- /dev/null +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/v5/spread/trade/max-qty.mdx @@ -0,0 +1,47 @@ +--- +title: 查詢最大下單數量 +sidebar_label: 查詢最大下單數量 +sidebar_position: 8 +--- + +根據指定的交易對、方向及下單價格，查詢下單可用餘額。 + +### HTTP請求 + + +### 請求參數 +| 參數 | 是否必需 | 類型 | 說明| +|:----- |:-------|:-----|------ | +|symbolId |**true** |integer |價差交易對ID| +|side |**true** |string |訂單方向. `1`: 買, `2`: 賣| +|orderPrice |**true** |string |下單價格| + +### 響應參數 +| 參數 | 類型 | 說明| +|:----- |:-----|----- | +|ab |string |可用餘額（保留8位小數，向下截斷）| + +### 請求示例 + +```http +GET /v5/spread/max-qty?symbolId=1&side=1&orderPrice=50000 HTTP/1.1 +Host: api-testnet.bybit.com +X-BAPI-SIGN: XXXXXX +X-BAPI-API-KEY: XXXXXX +X-BAPI-TIMESTAMP: 1773230920000 +X-BAPI-RECV-WINDOW: 5000 +Content-Type: application/json +``` + +### 響應示例 +```json +{ + "retCode": 0, + "retMsg": "Success", + "result": { + "ab": "0.00000000" + }, + "retExtInfo": {}, + "time": 1773230923211 +} +``` diff --git a/sidebars.js b/sidebars.js index c75c2a9009..c08bdc56a9 100644 --- a/sidebars.js +++ b/sidebars.js @@ -134,6 +134,8 @@ const sidebars = { 'v5/asset/exchange', 'v5/asset/coin-info', 'v5/asset/sub-uid-list', + 'v5/asset/portfolio-margin', + 'v5/asset/total-members-assets', { type: 'category', label: 'Balances',