From cec5e66de21b2b07ed72cc5fe626aa71d702727f Mon Sep 17 00:00:00 2001 From: "Isaac.Tang" Date: Tue, 11 Mar 2025 17:32:27 +0800 Subject: [PATCH 01/20] api(meta): update api collection --- spec/apis.csv | 68 +- spec/original/meta.json | 8770 ++++++++++------- spec/rest/api/openapi-account-account.json | 253 +- spec/rest/api/openapi-account-deposit.json | 185 +- spec/rest/api/openapi-account-fee.json | 36 +- spec/rest/api/openapi-account-subaccount.json | 155 +- spec/rest/api/openapi-account-transfer.json | 133 +- spec/rest/api/openapi-account-withdrawal.json | 130 +- .../rest/api/openapi-affiliate-affiliate.json | 8 +- spec/rest/api/openapi-broker-apibroker.json | 8 +- spec/rest/api/openapi-broker-ndbroker.json | 160 +- .../rest/api/openapi-copytrading-futures.json | 215 +- spec/rest/api/openapi-earn-earn.json | 1363 ++- .../rest/api/openapi-futures-fundingfees.json | 66 +- spec/rest/api/openapi-futures-market.json | 320 +- spec/rest/api/openapi-futures-order.json | 284 +- spec/rest/api/openapi-futures-positions.json | 105 +- spec/rest/api/openapi-margin-credit.json | 138 +- spec/rest/api/openapi-margin-debit.json | 46 +- spec/rest/api/openapi-margin-market.json | 48 +- spec/rest/api/openapi-margin-order.json | 333 +- spec/rest/api/openapi-margin-risklimit.json | 22 +- spec/rest/api/openapi-spot-market.json | 675 +- spec/rest/api/openapi-spot-order.json | 1346 +-- .../api/openapi-viplending-viplending.json | 111 +- spec/rest/entry/openapi-account.json | 892 +- spec/rest/entry/openapi-affiliate.json | 8 +- spec/rest/entry/openapi-broker.json | 168 +- spec/rest/entry/openapi-copytrading.json | 215 +- spec/rest/entry/openapi-earn.json | 1363 ++- spec/rest/entry/openapi-futures.json | 775 +- spec/rest/entry/openapi-margin.json | 587 +- spec/rest/entry/openapi-spot.json | 1897 ++-- spec/rest/entry/openapi-viplending.json | 111 +- spec/ws.csv | 5 +- spec/ws/openapi-futures-private.json | 144 +- spec/ws/openapi-futures-public.json | 20 +- spec/ws/openapi-margin-private.json | 8 +- spec/ws/openapi-margin-public.json | 4 +- spec/ws/openapi-spot-private.json | 287 +- spec/ws/openapi-spot-public.json | 251 +- 41 files changed, 12589 insertions(+), 9124 deletions(-) diff --git a/spec/apis.csv b/spec/apis.csv index 24dd148b..67fad85e 100644 --- a/spec/apis.csv +++ b/spec/apis.csv @@ -14,36 +14,36 @@ account,account,/api/v1/transaction-history,get,Get Account Ledgers - Futures account,account,/api/v1/margin/account,get,Get Account Detail - Margin account,account,/api/v1/isolated/accounts,get,Get Account List - Isolated Margin - V1 account,account,/api/v1/isolated/account/{symbol},get,Get Account Detail - Isolated Margin - V1 -account,subaccount,/api/v2/sub/user/created,post,Add SubAccount -account,subaccount,/api/v3/sub/user/margin/enable,post,Add SubAccount Margin Permission -account,subaccount,/api/v3/sub/user/futures/enable,post,Add SubAccount Futures Permission -account,subaccount,/api/v2/sub/user,get,Get SubAccount List - Summary Info -account,subaccount,/api/v1/sub-accounts/{subUserId},get,Get SubAccount Detail - Balance -account,subaccount,/api/v2/sub-accounts,get,Get SubAccount List - Spot Balance(V2) -account,subaccount,/api/v1/account-overview-all,get,Get SubAccount List - Futures Balance(V2) -account,subaccount,/api/v1/sub/api-key,post,Add SubAccount API -account,subaccount,/api/v1/sub/api-key/update,post,Modify SubAccount API -account,subaccount,/api/v1/sub/api-key,get,Get SubAccount API List -account,subaccount,/api/v1/sub/api-key,delete,Delete SubAccount API -account,subaccount,/api/v1/sub/user,get,Get SubAccount List - Summary Info(V1) -account,subaccount,/api/v1/sub-accounts,get,Get SubAccount List - Spot Balance(V1) -account,deposit,/api/v3/deposit-address/create,post,Add Deposit Address(V3) -account,deposit,/api/v3/deposit-addresses,get,Get Deposit Address(V3) +account,subaccount,/api/v2/sub/user/created,post,Add sub-account +account,subaccount,/api/v3/sub/user/margin/enable,post,Add sub-account Margin Permission +account,subaccount,/api/v3/sub/user/futures/enable,post,Add sub-account Futures Permission +account,subaccount,/api/v2/sub/user,get,Get sub-account List - Summary Info +account,subaccount,/api/v1/sub-accounts/{subUserId},get,Get sub-account Detail - Balance +account,subaccount,/api/v2/sub-accounts,get,Get sub-account List - Spot Balance (V2) +account,subaccount,/api/v1/account-overview-all,get,Get sub-account List - Futures Balance (V2) +account,subaccount,/api/v1/sub/api-key,post,Add sub-account API +account,subaccount,/api/v1/sub/api-key/update,post,Modify sub-account API +account,subaccount,/api/v1/sub/api-key,get,Get sub-account API List +account,subaccount,/api/v1/sub/api-key,delete,Delete sub-account API +account,subaccount,/api/v1/sub/user,get,Get sub-account List - Summary Info (V1) +account,subaccount,/api/v1/sub-accounts,get,Get sub-account List - Spot Balance (V1) +account,deposit,/api/v3/deposit-address/create,post,Add Deposit Address (V3) +account,deposit,/api/v3/deposit-addresses,get,Get Deposit Address (V3) account,deposit,/api/v1/deposits,get,Get Deposit History -account,deposit,/api/v2/deposit-addresses,get,Get Deposit Addresses(V2) +account,deposit,/api/v2/deposit-addresses,get,Get Deposit Addresses (V2) account,deposit,/api/v1/deposit-addresses,get,Get Deposit Addresses - V1 account,deposit,/api/v1/hist-deposits,get,Get Deposit History - Old account,deposit,/api/v1/deposit-addresses,post,Add Deposit Address - V1 account,withdrawal,/api/v1/withdrawals/quotas,get,Get Withdrawal Quotas -account,withdrawal,/api/v3/withdrawals,post,Withdraw(V3) +account,withdrawal,/api/v3/withdrawals,post,Withdraw (V3) account,withdrawal,/api/v1/withdrawals/{withdrawalId},delete,Cancel Withdrawal account,withdrawal,/api/v1/withdrawals,get,Get Withdrawal History account,withdrawal,/api/v1/hist-withdrawals,get,Get Withdrawal History - Old account,withdrawal,/api/v1/withdrawals,post,Withdraw - V1 account,transfer,/api/v1/accounts/transferable,get,Get Transfer Quotas account,transfer,/api/v3/accounts/universal-transfer,post,Flex Transfer -account,transfer,/api/v2/accounts/sub-transfer,post,SubAccount Transfer -account,transfer,/api/v2/accounts/inner-transfer,post,Inner Transfer +account,transfer,/api/v2/accounts/sub-transfer,post,Sub-account Transfer +account,transfer,/api/v2/accounts/inner-transfer,post,Internal Transfer account,transfer,/api/v3/transfer-out,post,Futures Account Transfer Out account,transfer,/api/v1/transfer-in,post,Futures Account Transfer In account,transfer,/api/v1/transfer-list,get,Get Futures Account Transfer Out Ledger @@ -61,9 +61,12 @@ spot,market,/api/v1/market/histories,get,Get Trade History spot,market,/api/v1/market/candles,get,Get Klines spot,market,/api/v1/market/orderbook/level2_{size},get,Get Part OrderBook spot,market,/api/v3/market/orderbook/level2,get,Get Full OrderBook +spot,market,/api/v1/market/orderbook/callauction/level2_{size},get,Get Call Auction Part OrderBook +spot,market,/api/v1/market/callauctionData,get,Get Call Auction Info spot,market,/api/v1/prices,get,Get Fiat Price -spot,market,/api/v1/market/stats,get,Get 24hr Stats +spot,market,/api/v1/market/stats,get,Get 24hr stats spot,market,/api/v1/markets,get,Get Market List +spot,market,/api/v1/my-ip,get,Get Client IP Address spot,market,/api/v1/timestamp,get,Get Server Time spot,market,/api/v1/status,get,Get Service Status spot,market,/api/v1/bullet-public,post,Get Public Token - Spot/Margin @@ -139,7 +142,7 @@ margin,debit,/api/v3/margin/borrow,post,Borrow margin,debit,/api/v3/margin/borrow,get,Get Borrow History margin,debit,/api/v3/margin/repay,post,Repay margin,debit,/api/v3/margin/repay,get,Get Repay History -margin,debit,/api/v3/margin/interest,get,Get Interest History +margin,debit,/api/v3/margin/interest,get,Get Interest History. margin,debit,/api/v3/position/update-user-leverage,post,Modify Leverage margin,credit,/api/v3/project/list,get,Get Loan Market margin,credit,/api/v3/project/marketInterestRate,get,Get Loan Market Interest Rate @@ -161,7 +164,7 @@ futures,market,/api/v1/mark-price/{symbol}/current,get,Get Mark Price futures,market,/api/v1/index/query,get,Get Spot Index Price futures,market,/api/v1/interest/query,get,Get Interest Rate Index futures,market,/api/v1/premium/query,get,Get Premium Index -futures,market,/api/v1/trade-statistics,get,Get 24hr Stats +futures,market,/api/v1/trade-statistics,get,Get 24hr stats futures,market,/api/v1/timestamp,get,Get Server Time futures,market,/api/v1/status,get,Get Service Status futures,market,/api/v1/bullet-public,post,Get Public Token - Futures @@ -198,29 +201,30 @@ futures,positions,/api/v1/margin/withdrawMargin,post,Remove Isolated Margin futures,positions,/api/v1/contracts/risk-limit/{symbol},get,Get Isolated Margin Risk Limit futures,positions,/api/v1/position/risk-limit-level/change,post,Modify Isolated Margin Risk Limit futures,positions,/api/v1/position/margin/auto-deposit-status,post,Modify Isolated Margin Auto-Deposit Status -futures,fundingfees,/api/v1/funding-rate/{symbol}/current,get,Get Current Funding Rate +futures,fundingfees,/api/v1/funding-rate/{symbol}/current,get,Get Current Funding Rate. futures,fundingfees,/api/v1/contract/funding-rates,get,Get Public Funding History futures,fundingfees,/api/v1/funding-history,get,Get Private Funding History -earn,earn,/api/v1/earn/orders,post,purchase +earn,earn,/api/v1/earn/orders,post,Purchase earn,earn,/api/v1/earn/redeem-preview,get,Get Redeem Preview earn,earn,/api/v1/earn/orders,delete,Redeem earn,earn,/api/v1/earn/saving/products,get,Get Savings Products earn,earn,/api/v1/earn/promotion/products,get,Get Promotion Products -earn,earn,/api/v1/earn/hold-assets,get,Get Account Holding earn,earn,/api/v1/earn/staking/products,get,Get Staking Products earn,earn,/api/v1/earn/kcs-staking/products,get,Get KCS Staking Products earn,earn,/api/v1/earn/eth-staking/products,get,Get ETH Staking Products -viplending,viplending,/api/v1/otc-loan/loan,get,Get Account Detail +earn,earn,/api/v1/earn/hold-assets,get,Get Account Holding +viplending,viplending,/api/v1/otc-loan/discount-rate-configs,get,Get Discount Rate Configs +viplending,viplending,/api/v1/otc-loan/loan,get,Get Loan Info viplending,viplending,/api/v1/otc-loan/accounts,get,Get Accounts affiliate,affiliate,/api/v2/affiliate/inviter/statistics,get,Get Account broker,apibroker,/api/v1/broker/api/rebase/download,get,Get Broker Rebate broker,ndbroker,/api/v1/broker/nd/info,get,Get Broker Info -broker,ndbroker,/api/v1/broker/nd/account,post,Add SubAccount -broker,ndbroker,/api/v1/broker/nd/account,get,Get SubAccount -broker,ndbroker,/api/v1/broker/nd/account/apikey,post,Add SubAccount API -broker,ndbroker,/api/v1/broker/nd/account/apikey,get,Get SubAccount API -broker,ndbroker,/api/v1/broker/nd/account/update-apikey,post,Modify SubAccount API -broker,ndbroker,/api/v1/broker/nd/account/apikey,delete,Delete SubAccount API +broker,ndbroker,/api/v1/broker/nd/account,post,Add sub-account +broker,ndbroker,/api/v1/broker/nd/account,get,Get sub-account +broker,ndbroker,/api/v1/broker/nd/account/apikey,post,Add sub-account API +broker,ndbroker,/api/v1/broker/nd/account/apikey,get,Get sub-account API +broker,ndbroker,/api/v1/broker/nd/account/update-apikey,post,Modify sub-account API +broker,ndbroker,/api/v1/broker/nd/account/apikey,delete,Delete sub-account API broker,ndbroker,/api/v1/broker/nd/transfer,post,Transfer broker,ndbroker,/api/v3/broker/nd/transfer/detail,get,Get Transfer History broker,ndbroker,/api/v1/asset/ndbroker/deposit/list,get,Get Deposit List diff --git a/spec/original/meta.json b/spec/original/meta.json index c22b0515..4cbff169 100644 --- a/spec/original/meta.json +++ b/spec/original/meta.json @@ -79,27 +79,27 @@ }, "maxSubQuantity": { "type": "integer", - "description": "Max number of sub-accounts = maxDefaultSubQuantity + maxSpotSubQuantity" + "description": "Max. number of sub-accounts = maxDefaultSubQuantity + maxSpotSubQuantity" }, "maxDefaultSubQuantity": { "type": "integer", - "description": "Max number of default open sub-accounts (according to VIP level)" + "description": "Max. number of default open sub-accounts (according to VIP level)" }, "maxSpotSubQuantity": { "type": "integer", - "description": "Max number of sub-accounts with additional Spot trading permissions" + "description": "Max. number of sub-accounts with additional spot trading permissions" }, "maxMarginSubQuantity": { "type": "integer", - "description": "Max number of sub-accounts with additional margin trading permissions" + "description": "Max. number of sub-accounts with additional margin trading permissions" }, "maxFuturesSubQuantity": { "type": "integer", - "description": "Max number of sub-accounts with additional futures trading permissions" + "description": "Max. number of sub-accounts with additional futures trading permissions" }, "maxOptionSubQuantity": { "type": "integer", - "description": "Max number of sub-accounts with additional Option trading permissions" + "description": "Max. number of sub-accounts with additional option trading permissions" } }, "required": [ @@ -146,7 +146,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to obtain account summary information.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getAccountInfo\",\"sdk-method-description\":\"This endpoint can be used to obtain account summary information.\",\"api-rate-limit\":20}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getAccountInfo\",\"sdk-method-description\":\"This endpoint can be used to obtain account summary information.\",\"api-rate-limit-weight\":20}" } }, { @@ -252,8 +252,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nGet the information of the api key. Use the api key pending to be checked to call the endpoint. Both master and sub user's api key are applicable.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getApikeyInfo\",\"sdk-method-description\":\"Get the information of the api key. Use the api key pending to be checked to call the endpoint. Both master and sub user's api key are applicable.\",\"api-rate-limit\":20}" + "description": ":::info[Description]\nGet the api key information. Use the api key awaiting checking to call the endpoint. Both master and sub user's api key are applicable.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getApikeyInfo\",\"sdk-method-description\":\"Get the api key information. Use the api key awaiting checking to call the endpoint. Both master and sub user's api key are applicable.\",\"api-rate-limit-weight\":20}" } }, { @@ -263,8 +263,8 @@ "method": "get", "path": "/api/v1/hf/accounts/opened", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -312,8 +312,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis interface determines whether the current user is a spot high-frequency user or a spot low-frequency user.\n:::\n\n:::tip[Tips]\nThis interface is a compatibility interface left over from the old version upgrade. Only some old users need to use it (high frequency will be opened before 2024 and trade_hf has been used). Most user do not need to use this interface. When the return is true, you need to use trade_hf to transfer assets and query assets When the return is false, you need to use trade to transfer assets and query assets.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getSpotAccountType\",\"sdk-method-description\":\"This interface determines whether the current user is a spot high-frequency user or a spot low-frequency user.\",\"api-rate-limit\":30}" + "description": ":::info[Description]\nThis interface determines whether the current user is a spot high-frequency user or a spot low-frequency user.\n:::\n\n:::tip[Tips]\nThis interface is a compatibility interface left over from the old version upgrade. Only some old users need to use it (high frequency will be opened before 2024 and trade_hf has been used). Most users do not need to use this interface. When the return is true, you need to use trade_hf to transfer assets and query assets. When the return is false, you need to use trade to transfer assets and query assets.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getSpotAccountType\",\"sdk-method-description\":\"This interface determines whether the current user is a spot high-frequency user or a spot low-frequency user.\",\"api-rate-limit-weight\":30}" } }, { @@ -337,14 +337,15 @@ "id": "RHGp3FAE9z", "name": "type", "required": false, - "description": "Account type main、trade", + "description": "Account type", "example": "main", "type": "string", "schema": { "type": "string", "enum": [ "main", - "trade" + "trade", + "option" ], "x-api-enum": [ { @@ -356,6 +357,11 @@ "value": "trade", "name": "trade", "description": "Spot account" + }, + { + "value": "option", + "name": "option", + "description": "Option account" } ] }, @@ -462,8 +468,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nGet a list of accounts. Please Deposit to the main account firstly, then transfer the funds to the trade account via Inner Transfer before transaction.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getSpotAccountList\",\"sdk-method-description\":\"Get a list of accounts. Please Deposit to the main account firstly, then transfer the funds to the trade account via Inner Transfer before transaction.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nGet a list of accounts. Please deposit funds into the **main** account first, then use the Transfer function to move them to the trade account before trading.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getSpotAccountList\",\"sdk-method-description\":\"Get a list of accounts. Please deposit funds into the main account first, then use the Transfer function to move them to the trade account before trading.\",\"api-rate-limit-weight\":5}" } }, { @@ -473,6 +479,7 @@ "method": "get", "path": "/api/v1/accounts/{accountId}", "parameters": { + "query": [], "path": [ { "id": "accountId#0", @@ -480,10 +487,10 @@ "required": true, "description": "Path parameter. Account ID", "example": "548674591753", - "type": "string" + "type": "string", + "enable": true } ], - "query": [], "cookie": [], "header": [] }, @@ -554,8 +561,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nget Information for a single spot account. Use this endpoint when you know the accountId.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getSpotAccountDetail\",\"sdk-method-description\":\"get Information for a single spot account. Use this endpoint when you know the accountId.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nGet information for a single spot account. Use this endpoint when you know the accountId.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getSpotAccountDetail\",\"sdk-method-description\":\"Get information for a single spot account. Use this endpoint when you know the accountId.\",\"api-rate-limit-weight\":5}" } }, { @@ -565,7 +572,6 @@ "method": "get", "path": "/api/v3/margin/accounts", "parameters": { - "path": [], "query": [ { "id": "PjWvwo4LmP", @@ -599,7 +605,8 @@ "description": "" } ] - } + }, + "enable": true }, { "id": "waIqv5MOOW", @@ -633,9 +640,11 @@ "description": "" } ] - } + }, + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -668,7 +677,7 @@ }, "status": { "type": "string", - "description": "Position status; EFFECTIVE-effective, BANKRUPTCY-bankruptcy liquidation, LIQUIDATION-closing, REPAY-repayment, BORROW borrowing", + "description": "Position status; EFFECTIVE-effective, BANKRUPTCY-bankruptcy liquidation, LIQUIDATION-closing, REPAY-repayment, BORROW-borrowing", "enum": [ "EFFECTIVE", "BANKRUPTCY", @@ -792,8 +801,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the info of the cross margin account.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getCrossMarginAccount\",\"sdk-method-description\":\"Request via this endpoint to get the info of the cross margin account.\",\"api-rate-limit\":15}" + "description": ":::info[Description]\nRequest cross margin account info via this endpoint.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getCrossMarginAccount\",\"sdk-method-description\":\"Request cross margin account info via this endpoint.\",\"api-rate-limit-weight\":15}" } }, { @@ -926,7 +935,7 @@ }, "status": { "type": "string", - "description": "Position status; EFFECTIVE-effective, BANKRUPTCY-bankruptcy liquidation, LIQUIDATION-closing, REPAY-repayment, BORROW borrowing", + "description": "Position status; EFFECTIVE-effective, BANKRUPTCY-bankruptcy liquidation, LIQUIDATION-closing, REPAY-repayment, BORROW-borrowing", "enum": [ "EFFECTIVE", "BANKRUPTCY", @@ -1108,8 +1117,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the info of the isolated margin account.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getIsolatedMarginAccount\",\"sdk-method-description\":\"Request via this endpoint to get the info of the isolated margin account.\",\"api-rate-limit\":15}" + "description": ":::info[Description]\nRequest isolated margin account info via this endpoint.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getIsolatedMarginAccount\",\"sdk-method-description\":\"Request isolated margin account info via this endpoint.\",\"api-rate-limit-weight\":15}" } }, { @@ -1124,7 +1133,7 @@ "id": "0GJu6LYq3T", "name": "currency", "required": false, - "description": "Currecny, Default XBT", + "description": "Currency, Default XBT", "example": "", "type": "string", "schema": { @@ -1132,6 +1141,8 @@ "default": "XBT", "examples": [ "USDT", + "USDC", + "XBT", "ETH" ] }, @@ -1159,15 +1170,15 @@ "properties": { "accountEquity": { "type": "number", - "description": "Account equity = marginBalance + Unrealised PNL" + "description": "Account equity = marginBalance + unrealizedPNL" }, "unrealisedPNL": { "type": "number", - "description": "Unrealised profit and loss" + "description": "Unrealized profit and loss" }, "marginBalance": { "type": "number", - "description": "Margin balance = positionMargin + orderMargin + frozenFunds + availableBalance - unrealisedPNL" + "description": "Margin balance = positionMargin + orderMargin + frozenFunds + availableBalance - unrealizedPNL" }, "positionMargin": { "type": "number", @@ -1197,6 +1208,10 @@ "riskRatio": { "type": "number", "description": "Cross margin risk rate" + }, + "maxWithdrawAmount": { + "type": "number", + "description": "Maximum amount that can be withdrawn/transferred." } }, "required": [ @@ -1208,7 +1223,8 @@ "frozenFunds", "availableBalance", "currency", - "riskRatio" + "riskRatio", + "maxWithdrawAmount" ] } }, @@ -1225,7 +1241,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"currency\": \"USDT\",\n \"accountEquity\": 48.921913718,\n \"unrealisedPNL\": 1.59475,\n \"marginBalance\": 47.548728628,\n \"positionMargin\": 34.1577964733,\n \"orderMargin\": 0,\n \"frozenFunds\": 0,\n \"availableBalance\": 14.7876172447,\n \"riskRatio\": 0.0090285199\n }\n}", + "data": "{\r\n \"code\": \"200000\",\r\n \"data\": {\r\n \"accountEquity\": 394.439280806,\r\n \"unrealisedPNL\": 20.15278,\r\n \"marginBalance\": 371.394298816,\r\n \"positionMargin\": 102.20664159,\r\n \"orderMargin\": 10.06002012,\r\n \"frozenFunds\": 0.0,\r\n \"availableBalance\": 290.326799096,\r\n \"currency\": \"USDT\",\r\n \"riskRatio\": 0.0065289525,\r\n \"maxWithdrawAmount\": 290.326419096\r\n }\r\n}", "responseId": 10093, "ordering": 1 } @@ -1239,8 +1255,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the info of the futures account.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getFuturesAccount\",\"sdk-method-description\":\"Request via this endpoint to get the info of the futures account.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nRequest futures account info via this endpoint.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getFuturesAccount\",\"sdk-method-description\":\"Request futures account info via this endpoint.\",\"api-rate-limit-weight\":5}" } }, { @@ -1255,7 +1271,7 @@ "id": "8YpRjfgiQY", "name": "currency", "required": false, - "description": "Currency ( you can choose more than one currency). You can specify 10 currencies at most for one time. If not specified, all currencies will be inquired by default.", + "description": "Currency (you can choose more than one currency). You can specify a max. of 10 currencies in one go. If not specified, all currencies will be queried by default.", "example": "BTC", "type": "string", "enable": true @@ -1276,13 +1292,13 @@ "x-api-enum": [ { "value": "in", - "name": "", - "description": "" + "name": "in", + "description": "Funds in" }, { "value": "out", - "name": "", - "description": "" + "name": "out", + "description": "Funds out" } ] }, @@ -1292,7 +1308,7 @@ "id": "79t7ddnYAv", "name": "bizType", "required": false, - "description": "Type: DEPOSIT -deposit, WITHDRAW -withdraw, TRANSFER -transfer, SUB_TRANSFER -subaccount transfer,TRADE_EXCHANGE -trade, MARGIN_EXCHANGE -margin trade, KUCOIN_BONUS -bonus, BROKER_TRANSFER -Broker transfer record", + "description": "Type: DEPOSIT-deposit, WITHDRAW-withdraw, TRANSFER-transfer, SUB_TRANSFER-sub-account transfer, TRADE_EXCHANGE-trade, MARGIN_EXCHANGE-margin trade, KUCOIN_BONUS-bonus, BROKER_TRANSFER-Broker transfer record", "example": "TRANSFER", "type": "string", "schema": { @@ -1304,7 +1320,7 @@ "id": "nRkUqJX2U6", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "example": "1728663338000", "type": "integer", "schema": { @@ -1317,7 +1333,7 @@ "id": "rqSOV202LJ", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "example": "1728692138000", "type": "integer", "schema": { @@ -1388,7 +1404,7 @@ }, "totalPage": { "type": "integer", - "description": "total page" + "description": "total pages" }, "items": { "type": "array", @@ -1401,11 +1417,11 @@ }, "currency": { "type": "string", - "description": "The currency of an account" + "description": "Currency" }, "amount": { "type": "string", - "description": "The total amount of assets (fees included) involved in assets changes such as transaction, withdrawal and bonus distribution." + "description": "The total amount of assets (fees included) involved in assets changes such as transactions, withdrawals and bonus distributions." }, "fee": { "type": "string", @@ -1417,11 +1433,11 @@ }, "accountType": { "type": "string", - "description": "The account type of the master user: MAIN, TRADE, MARGIN or CONTRACT." + "description": "Master user account types: MAIN, TRADE, MARGIN or CONTRACT." }, "bizType": { "type": "string", - "description": "Business type leading to the changes in funds, such as exchange, withdrawal, deposit, KUCOIN_BONUS, REFERRAL_BONUS, Lendings etc." + "description": "Business type leading to changes in funds, such as exchange, withdrawal, deposit, KUCOIN_BONUS, REFERRAL_BONUS, Lendings etc." }, "direction": { "type": "string", @@ -1429,12 +1445,12 @@ }, "createdAt": { "type": "integer", - "description": "Time of the event", + "description": "Time of event", "format": "int64" }, "context": { "type": "string", - "description": "Business related information such as order ID, serial No., etc." + "description": "Business related information such as order ID, serial no., etc." } } } @@ -1476,8 +1492,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis interface is for transaction records from all types of your accounts, supporting inquiry of various currencies. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::\n\n:::tip[Tips]\nthe start and end time range cannot exceed 24 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.\n:::\n\n:::tip[Tips]\nSupport to obtain 1 year historical data, if need to obtain longer historical data, please submit a ticket: https://kucoin.zendesk.com/hc/en-us/requests/new\n:::\n\n**context**\n\nIf the returned value under bizType is “trade exchange”, the additional info. (such as order ID and trade ID, trading pair, etc.) of the trade will be returned in field context.\n\n**BizType Description**\n\n| Field | Description |\n| ------ | ---------- |\n| Assets Transferred in After Upgrading | Assets Transferred in After V1 to V2 Upgrading |\n| Deposit | Deposit |\n| Withdrawal | Withdrawal |\n| Transfer | Transfer |\n| Trade_Exchange | Trade |\n| Vote for Coin | Vote for Coin |\n| KuCoin Bonus | KuCoin Bonus |\n| Referral Bonus | Referral Bonus |\n| Rewards | Activities Rewards |\n| Distribution | Distribution, such as get GAS by holding NEO |\n| Airdrop/Fork | Airdrop/Fork |\n| Other rewards | Other rewards, except Vote, Airdrop, Fork |\n| Fee Rebate | Fee Rebate |\n| Buy Crypto | Use credit card to buy crypto |\n| Sell Crypto | Use credit card to sell crypto |\n| Public Offering Purchase | Public Offering Purchase for Spotlight |\n| Send red envelope | Send red envelope |\n| Open red envelope | Open red envelope |\n| Staking | Staking |\n| LockDrop Vesting | LockDrop Vesting |\n| Staking Profits | Staking Profits |\n| Redemption | Redemption |\n| Refunded Fees | Refunded Fees |\n| KCS Pay Fees | KCS Pay Fees |\n| Margin Trade | Margin Trade |\n| Loans | Loans |\n| Borrowings | Borrowings |\n| Debt Repayment | Debt Repayment |\n| Loans Repaid | Loans Repaid |\n| Lendings | Lendings |\n| Pool transactions | Pool-X transactions |\n| Instant Exchange | Instant Exchange |\n| Sub Account Transfer | Sub-account transfer |\n| Liquidation Fees | Liquidation Fees |\n| Soft Staking Profits | Soft Staking Profits |\n| Voting Earnings | Voting Earnings on Pool-X |\n| Redemption of Voting | Redemption of Voting on Pool-X |\n| Convert to KCS | Convert to KCS |\n| BROKER_TRANSFER | Broker transfer record |\n\n\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getSpotLedger\",\"sdk-method-description\":\"This interface is for transaction records from all types of your accounts, supporting inquiry of various currencies. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nThis interface is for transaction records from all your account types, supporting various currency inquiries. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::\n\n:::tip[Tips]\nThe start and end time range cannot exceed 24 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.\n:::\n\n:::tip[Tips]\nSupport to obtain 1-year historical data. If you need to obtain longer historical data, please submit a ticket: https://kucoin.zendesk.com/hc/en-us/requests/new\n:::\n\n**context**\n\nIf the returned value under bizType is “trade exchange”, the additional trade info (such as order ID, trade ID, trading pair, etc.) will be returned in field context.\n\n**BizType Description**\n\n| Field | Description |\n| ------ | ---------- |\n| Assets Transferred in After Upgrading | Assets Transferred in After V1 to V2 Upgrading |\n| Deposit | Deposit |\n| Withdrawal | Withdrawal |\n| Transfer | Transfer |\n| Trade_Exchange | Trade |\n| Vote for Coin | Vote for Coin |\n| KuCoin Bonus | KuCoin Bonus |\n| Referral Bonus | Referral Bonus |\n| Rewards | Activities Rewards |\n| Distribution | Distribution, such as get GAS by holding NEO |\n| Airdrop/Fork | Airdrop/Fork |\n| Other rewards | Other rewards, except Vote, Airdrop, Fork |\n| Fee Rebate | Fee Rebate |\n| Buy Crypto | Use credit card to buy crypto |\n| Sell Crypto | Use credit card to sell crypto |\n| Public Offering Purchase | Public Offering Purchase for Spotlight |\n| Send red envelope | Send red envelope |\n| Open red envelope | Open red envelope |\n| Staking | Staking |\n| LockDrop Vesting | LockDrop Vesting |\n| Staking Profits | Staking Profits |\n| Redemption | Redemption |\n| Refunded Fees | Refunded Fees |\n| KCS Pay Fees | KCS Pay Fees |\n| Margin Trade | Margin Trade |\n| Loans | Loans |\n| Borrowings | Borrowings |\n| Debt Repayment | Debt Repayment |\n| Loans Repaid | Loans Repaid |\n| Lendings | Lendings |\n| Pool transactions | Pool-X transactions |\n| Instant Exchange | Instant Exchange |\n| Sub Account Transfer | Sub-account transfer |\n| Liquidation Fees | Liquidation Fees |\n| Soft Staking Profits | Soft Staking Profits |\n| Voting Earnings | Voting Earnings on Pool-X |\n| Redemption of Voting | Redemption of Voting on Pool-X |\n| Convert to KCS | Convert to KCS |\n| BROKER_TRANSFER | Broker transfer record |", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getSpotLedger\",\"sdk-method-description\":\"This interface is for transaction records from all your account types, supporting various currency inquiries. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\",\"api-rate-limit-weight\":2}" } }, { @@ -1492,7 +1508,7 @@ "id": "8YpRjfgiQY", "name": "currency", "required": false, - "description": "Currency ( you can choose more than one currency). You can specify 10 currencies at most for one time. If not specified, all currencies will be inquired by default.", + "description": "Currency (you can choose more than one currency). You can specify a max. of 10 currencies in one go. If not specified, all currencies will be queried by default.", "example": "BTC", "type": "string", "enable": true @@ -1529,281 +1545,53 @@ "id": "79t7ddnYAv", "name": "bizType", "required": false, - "description": "Transaction type: TRANSFER-transfer funds,TRADE_EXCHANGE-Trade", + "description": "Transaction type", "example": "TRANSFER", "type": "string", "schema": { "type": "string", "enum": [ "TRADE_EXCHANGE", - "TRANSFER" + "TRANSFER", + "RETURNED_FEES", + "DEDUCTION_FEES", + "OTHER" ], "x-api-enum": [ { "value": "TRADE_EXCHANGE", - "name": "", - "description": "" + "name": "TRADE_EXCHANGE", + "description": "trade exchange" }, { "value": "TRANSFER", - "name": "", - "description": "" - } - ] - }, - "enable": true - }, - { - "id": "pPnKFH2DlI", - "name": "lastId", - "required": false, - "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.", - "example": "254062248624417", - "type": "integer", - "schema": { - "type": "integer", - "format": "int64" - }, - "enable": true - }, - { - "id": "TJwaZEZ59O", - "name": "limit", - "required": false, - "description": "Default100，Max200", - "example": "100", - "type": "integer", - "schema": { - "type": "integer", - "default": 100, - "maximum": 200, - "minimum": 1 - }, - "enable": true - }, - { - "id": "nRkUqJX2U6", - "name": "startAt", - "required": false, - "description": "Start time (milisecond)", - "example": "1728663338000", - "type": "integer", - "schema": { - "type": "integer", - "format": "int64" - }, - "enable": true - }, - { - "id": "rqSOV202LJ", - "name": "endAt", - "required": false, - "description": "End time (milisecond)", - "example": "1728692138000", - "type": "integer", - "schema": { - "type": "integer", - "format": "int64" - }, - "enable": true - } - ], - "path": [], - "cookie": [], - "header": [] - }, - "responses": [ - { - "id": "10086", - "code": 200, - "name": "OK", - "headers": [], - "jsonSchema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique id" - }, - "currency": { - "type": "string", - "description": "currency" - }, - "amount": { - "type": "string", - "description": "Change in funds balance" - }, - "fee": { - "type": "string", - "description": "Deposit or withdrawal fee" - }, - "tax": { - "type": "string" - }, - "balance": { - "type": "string", - "description": "Total balance of funds after change" - }, - "accountType": { - "type": "string", - "description": "Master account type TRADE_HF" - }, - "bizType": { - "type": "string", - "description": "Trnasaction type，such as TRANSFER, TRADE_EXCHANGE, etc." - }, - "direction": { - "type": "string", - "description": "Direction of transfer( out or in)", - "enum": [ - "in", - "out" - ], - "x-api-enum": [ - { - "value": "in", - "name": "", - "description": "" - }, - { - "value": "out", - "name": "", - "description": "" - } - ] - }, - "createdAt": { - "type": "string", - "description": "Created time" - }, - "context": { - "type": "string", - "description": "Core transaction parameter" - } - }, - "required": [ - "id", - "currency", - "amount", - "fee", - "tax", - "balance", - "accountType", - "bizType", - "direction", - "createdAt", - "context" - ] - } - } - }, - "required": [ - "code", - "data" - ] - }, - "description": "", - "contentType": "json", - "mediaType": "" - } - ], - "responseExamples": [ - { - "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"254062248624417\",\n \"currency\": \"USDT\",\n \"amount\": \"1.59760080\",\n \"fee\": \"0.00159920\",\n \"tax\": \"0\",\n \"balance\": \"26.73759503\",\n \"accountType\": \"TRADE_HF\",\n \"bizType\": \"TRADE_EXCHANGE\",\n \"direction\": \"in\",\n \"createdAt\": \"1728443957539\",\n \"context\": \"{\\\"symbol\\\":\\\"KCS-USDT\\\",\\\"orderId\\\":\\\"6705f6350dc7210007d6a36d\\\",\\\"tradeId\\\":\\\"10046097631627265\\\"}\"\n }\n ]\n}", - "responseId": 10086, - "ordering": 1 - }, - { - "name": "KCS DEDUCTION FEES", - "data": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"284494946713889\",\n \"currency\": \"BTC\",\n \"amount\": \"0.00004585\",\n \"fee\": \"0.00000000\",\n \"tax\": \"0\",\n \"balance\": \"0.00092103\",\n \"accountType\": \"TRADE_HF\",\n \"bizType\": \"TRADE_EXCHANGE\",\n \"direction\": \"in\",\n \"createdAt\": \"1729004451665\",\n \"context\": \"{\\\"symbol\\\":\\\"BTC-USDT\\\",\\\"orderId\\\":\\\"670e83a3640ce3000736aace\\\",\\\"tradeId\\\":\\\"10946063166095361\\\"}\"\n },\n {\n \"id\": \"284494946713888\",\n \"currency\": \"USDT\",\n \"amount\": \"3.00023007\",\n \"fee\": \"0.00299723\",\n \"tax\": \"0\",\n \"balance\": \"31.40074009\",\n \"accountType\": \"TRADE_HF\",\n \"bizType\": \"TRADE_EXCHANGE\",\n \"direction\": \"out\",\n \"createdAt\": \"1729004451665\",\n \"context\": \"{\\\"symbol\\\":\\\"BTC-USDT\\\",\\\"orderId\\\":\\\"670e83a3640ce3000736aace\\\",\\\"tradeId\\\":\\\"10946063166095361\\\"}\"\n },\n {\n \"id\": \"284494428832032\",\n \"currency\": \"USDT\",\n \"amount\": \"0.00499782\",\n \"fee\": \"0.00000000\",\n \"tax\": \"0\",\n \"balance\": \"34.40097016\",\n \"accountType\": \"TRADE_HF\",\n \"bizType\": \"RETURNED_FEES\",\n \"direction\": \"in\",\n \"createdAt\": \"1729004444549\",\n \"context\": \"{}\"\n },\n {\n \"id\": \"284494423736608\",\n \"currency\": \"KCS\",\n \"amount\": \"0.00047428\",\n \"fee\": \"0.00000000\",\n \"tax\": \"0\",\n \"balance\": \"17.36207049\",\n \"accountType\": \"TRADE_HF\",\n \"bizType\": \"DEDUCTION_FEES\",\n \"direction\": \"out\",\n \"createdAt\": \"1729004444468\",\n \"context\": \"{}\"\n }\n ]\n}", - "responseId": 10086, - "ordering": 2 - } - ], - "requestBody": { - "type": "none", - "parameters": [], - "jsonSchema": { - "type": "object", - "properties": {} - }, - "mediaType": "" - }, - "description": ":::info[Description]\nThis API endpoint returns all transfer (in and out) records in high-frequency trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id.\n:::\n\n\n\n:::tip[Tips]\nIf lastId is configured, the information obtained < lastId. Otherwise, it will go back to the latest information.\n\nYou can only obtain data from within a 3 _ 24 hour time range (i.e., from 3 _ 24 hours ago up to now) If you specify a time range that exceeds this limit, the system will default to data from within 3 * 24 hours.\n:::\n\n**context**\n\nIf the bizType is TRADE_EXCHANGE, the context field will include additional transaction information (order id, transaction id, and trading pair).\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getSpotHFLedger\",\"sdk-method-description\":\"This API endpoint returns all transfer (in and out) records in high-frequency trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id.\",\"api-rate-limit\":2}" - } - }, - { - "name": "Get Account Ledgers - Margin_hf", - "api": { - "id": "3470123", - "method": "get", - "path": "/api/v3/hf/margin/account/ledgers", - "parameters": { - "query": [ - { - "id": "8YpRjfgiQY", - "name": "currency", - "required": false, - "description": "currency, optional，can select more than one，separate with commas，select no more than 10 currencys，the default will be to query for all currencys if left empty", - "example": "BTC", - "type": "string", - "enable": true - }, - { - "id": "iwlQIVyBkb", - "name": "direction", - "required": false, - "description": "direction: in, out", - "example": "in", - "type": "string", - "schema": { - "type": "string", - "enum": [ - "in", - "out" - ], - "x-api-enum": [ + "name": "TRANSFER", + "description": "transffer" + }, { - "value": "in", - "name": "", - "description": "" + "value": "RETURNED_FEES", + "name": "RETURNED_FEES", + "description": "returned fees" }, { - "value": "out", - "name": "", - "description": "" + "value": "DEDUCTION_FEES", + "name": "DEDUCTION_FEES", + "description": "deduction fees" + }, + { + "value": "OTHER", + "name": "OTHER", + "description": "Other" } ] }, "enable": true }, - { - "id": "79t7ddnYAv", - "name": "bizType", - "required": false, - "description": "Transaction type: TRANSFER- transfer funds, MARGIN_EXCHANGE - cross margin trade, ISOLATED_EXCHANGE - isolated margin trade, LIQUIDATION - liquidation, ASSERT_RETURN - forced liquidation asset return", - "example": "TRANSFER", - "type": "string", - "schema": { - "type": "string" - }, - "enable": true - }, { "id": "pPnKFH2DlI", "name": "lastId", "required": false, - "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.", + "description": "The ID of the last set of data from the previous data batch. By default, the latest information is given.", "example": "254062248624417", "type": "integer", "schema": { @@ -1816,7 +1604,7 @@ "id": "TJwaZEZ59O", "name": "limit", "required": false, - "description": "Default100，Max200", + "description": "Default100, Max200", "example": "100", "type": "integer", "schema": { @@ -1831,7 +1619,257 @@ "id": "nRkUqJX2U6", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", + "example": "1728663338000", + "type": "integer", + "schema": { + "type": "integer", + "format": "int64", + "maximum": 9999999999999, + "minimum": 0 + }, + "enable": true + }, + { + "id": "rqSOV202LJ", + "name": "endAt", + "required": false, + "description": "End time (milliseconds)", + "example": "1728692138000", + "type": "integer", + "schema": { + "type": "integer", + "format": "int64", + "maximum": 9999999999999, + "minimum": 0 + }, + "enable": true + } + ], + "path": [], + "cookie": [], + "header": [] + }, + "responses": [ + { + "id": "10086", + "code": 200, + "name": "OK", + "headers": [], + "jsonSchema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique ID" + }, + "currency": { + "type": "string", + "description": "currency" + }, + "amount": { + "type": "string", + "description": "Change in funds balance" + }, + "fee": { + "type": "string", + "description": "Transaction, Deposit or withdrawal fee" + }, + "tax": { + "type": "string" + }, + "balance": { + "type": "string", + "description": "Total balance of funds after change" + }, + "accountType": { + "type": "string", + "description": "Master account type TRADE_HF" + }, + "bizType": { + "type": "string", + "description": "Trnasaction type, such as TRANSFER, TRADE_EXCHANGE, etc." + }, + "direction": { + "type": "string", + "description": "Direction of transfer (out or in)", + "enum": [ + "in", + "out" + ], + "x-api-enum": [ + { + "value": "in", + "name": "", + "description": "" + }, + { + "value": "out", + "name": "", + "description": "" + } + ] + }, + "createdAt": { + "type": "string", + "description": "Created time" + }, + "context": { + "type": "string", + "description": "Core transaction parameter" + } + }, + "required": [ + "id", + "currency", + "amount", + "fee", + "tax", + "balance", + "accountType", + "bizType", + "direction", + "createdAt", + "context" + ] + } + } + }, + "required": [ + "code", + "data" + ] + }, + "description": "", + "contentType": "json", + "mediaType": "" + } + ], + "responseExamples": [ + { + "name": "Success", + "data": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"254062248624417\",\n \"currency\": \"USDT\",\n \"amount\": \"1.59760080\",\n \"fee\": \"0.00159920\",\n \"tax\": \"0\",\n \"balance\": \"26.73759503\",\n \"accountType\": \"TRADE_HF\",\n \"bizType\": \"TRADE_EXCHANGE\",\n \"direction\": \"in\",\n \"createdAt\": \"1728443957539\",\n \"context\": \"{\\\"symbol\\\":\\\"KCS-USDT\\\",\\\"orderId\\\":\\\"6705f6350dc7210007d6a36d\\\",\\\"tradeId\\\":\\\"10046097631627265\\\"}\"\n }\n ]\n}", + "responseId": 10086, + "ordering": 1 + }, + { + "name": "KCS DEDUCTION FEES", + "data": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"284494946713889\",\n \"currency\": \"BTC\",\n \"amount\": \"0.00004585\",\n \"fee\": \"0.00000000\",\n \"tax\": \"0\",\n \"balance\": \"0.00092103\",\n \"accountType\": \"TRADE_HF\",\n \"bizType\": \"TRADE_EXCHANGE\",\n \"direction\": \"in\",\n \"createdAt\": \"1729004451665\",\n \"context\": \"{\\\"symbol\\\":\\\"BTC-USDT\\\",\\\"orderId\\\":\\\"670e83a3640ce3000736aace\\\",\\\"tradeId\\\":\\\"10946063166095361\\\"}\"\n },\n {\n \"id\": \"284494946713888\",\n \"currency\": \"USDT\",\n \"amount\": \"3.00023007\",\n \"fee\": \"0.00299723\",\n \"tax\": \"0\",\n \"balance\": \"31.40074009\",\n \"accountType\": \"TRADE_HF\",\n \"bizType\": \"TRADE_EXCHANGE\",\n \"direction\": \"out\",\n \"createdAt\": \"1729004451665\",\n \"context\": \"{\\\"symbol\\\":\\\"BTC-USDT\\\",\\\"orderId\\\":\\\"670e83a3640ce3000736aace\\\",\\\"tradeId\\\":\\\"10946063166095361\\\"}\"\n },\n {\n \"id\": \"284494428832032\",\n \"currency\": \"USDT\",\n \"amount\": \"0.00499782\",\n \"fee\": \"0.00000000\",\n \"tax\": \"0\",\n \"balance\": \"34.40097016\",\n \"accountType\": \"TRADE_HF\",\n \"bizType\": \"RETURNED_FEES\",\n \"direction\": \"in\",\n \"createdAt\": \"1729004444549\",\n \"context\": \"{}\"\n },\n {\n \"id\": \"284494423736608\",\n \"currency\": \"KCS\",\n \"amount\": \"0.00047428\",\n \"fee\": \"0.00000000\",\n \"tax\": \"0\",\n \"balance\": \"17.36207049\",\n \"accountType\": \"TRADE_HF\",\n \"bizType\": \"DEDUCTION_FEES\",\n \"direction\": \"out\",\n \"createdAt\": \"1729004444468\",\n \"context\": \"{}\"\n }\n ]\n}", + "responseId": 10086, + "ordering": 2 + } + ], + "requestBody": { + "type": "none", + "parameters": [], + "jsonSchema": { + "type": "object", + "properties": {} + }, + "mediaType": "" + }, + "description": ":::info[Description]\nThis API endpoint returns all transfer (in and out) records in high-frequency trading accounts and supports multi-coin queries. The query results are sorted in descending order by createdAt and ID.\n:::\n\n\n\n:::tip[Tips]\nIf lastId is configured, the information obtained < lastId. Otherwise, it will revert to the latest information.\n\nYou can only obtain data from within a 3 * 24 hour time range (i.e., from 3 * 24 hours ago up to now). If you specify a time range that exceeds this limit, the system will default to data from within 3 * 24 hours.\n:::\n\n**context**\n\nIf the bizType is TRADE_EXCHANGE, the context field will include additional transaction information (order ID, transaction ID, and trading pair).", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getSpotHFLedger\",\"sdk-method-description\":\"This API endpoint returns all transfer (in and out) records in high-frequency trading accounts and supports multi-coin queries. The query results are sorted in descending order by createdAt and ID.\",\"api-rate-limit-weight\":2}" + } + }, + { + "name": "Get Account Ledgers - Margin_hf", + "api": { + "id": "3470123", + "method": "get", + "path": "/api/v3/hf/margin/account/ledgers", + "parameters": { + "query": [ + { + "id": "8YpRjfgiQY", + "name": "currency", + "required": false, + "description": "Currency optional; more than one can be selected; separate using commas; select no more than 10 currencies; the default will be to query for all currencies if left empty", + "example": "BTC", + "type": "string", + "enable": true + }, + { + "id": "iwlQIVyBkb", + "name": "direction", + "required": false, + "description": "direction: in, out", + "example": "in", + "type": "string", + "schema": { + "type": "string", + "enum": [ + "in", + "out" + ], + "x-api-enum": [ + { + "value": "in", + "name": "", + "description": "" + }, + { + "value": "out", + "name": "", + "description": "" + } + ] + }, + "enable": true + }, + { + "id": "79t7ddnYAv", + "name": "bizType", + "required": false, + "description": "Transaction type: TRANSFER- transfer funds, MARGIN_EXCHANGE-cross margin trade, ISOLATED_EXCHANGE-isolated margin trade, LIQUIDATION-liquidation, ASSERT_RETURN-forced liquidation asset return", + "example": "TRANSFER", + "type": "string", + "schema": { + "type": "string" + }, + "enable": true + }, + { + "id": "pPnKFH2DlI", + "name": "lastId", + "required": false, + "description": "The ID of the last set of data from the previous data batch. By default, the latest information is given.", + "example": "254062248624417", + "type": "integer", + "schema": { + "type": "integer", + "format": "int64" + }, + "enable": true + }, + { + "id": "TJwaZEZ59O", + "name": "limit", + "required": false, + "description": "Default100, Max200", + "example": "100", + "type": "integer", + "schema": { + "type": "integer", + "default": 100, + "maximum": 200, + "minimum": 1 + }, + "enable": true + }, + { + "id": "nRkUqJX2U6", + "name": "startAt", + "required": false, + "description": "Start time (milliseconds)", "example": "1728663338000", "type": "integer", "schema": { @@ -1844,7 +1882,7 @@ "id": "rqSOV202LJ", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "example": "1728692138000", "type": "integer", "schema": { @@ -1889,7 +1927,7 @@ }, "fee": { "type": "string", - "description": "Deposit or withdrawal fee" + "description": "Transaction, Deposit or withdrawal fee" }, "balance": { "type": "string", @@ -1901,11 +1939,11 @@ }, "bizType": { "type": "string", - "description": "Trnasaction type，such as TRANSFER, TRADE_EXCHANGE, etc." + "description": "Trnasaction type, such as TRANSFER, TRADE_EXCHANGE, etc." }, "direction": { "type": "string", - "description": "Direction of transfer( out or in)" + "description": "Direction of transfer (out or in)" }, "createdAt": { "type": "integer", @@ -1950,8 +1988,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis API endpoint returns all transfer (in and out) records in high-frequency margin trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id.\n:::\n\n\n:::tip[Tips]\nIf lastId is configured, the information obtained < lastId. Otherwise, it will go back to the latest information.\n\nYou can only obtain data from within a 3 _ 24 hour time range (i.e., from 3 _ 24 hours ago up to now) If you specify a time range that exceeds this limit, the system will default to data from within 3 * 24 hours.\n\nIf bizType is MARGIN_EXCHANGE or ISOLATED_EXCHANGE, the context field will contain additional information about the transaction (order id, transaction id, transaction pair).\n:::\n\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getMarginHFLedger\",\"sdk-method-description\":\"This API endpoint returns all transfer (in and out) records in high-frequency margin trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id.\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nThis API endpoint returns all transfer (in and out) records in high-frequency margin trading accounts and supports multi-coin queries. The query results are sorted in descending order by createdAt and ID.\n:::\n\n\n:::tip[Tips]\nIf lastId is configured, the information obtained < lastId. Otherwise, it will revert to the latest information.\n\nYou can only obtain data from within a 3 * 24 hour time range (i.e., from 3 * 24 hours ago up to now). If you specify a time range that exceeds this limit, the system will default to data from within 3 * 24 hours.\n\nIf bizType is MARGIN_EXCHANGE or ISOLATED_EXCHANGE, the context field will contain additional information about the transaction (order ID, transaction ID, transaction pair).\n:::\n\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getMarginHFLedger\",\"sdk-method-description\":\"This API endpoint returns all transfer (in and out) records in high-frequency margin trading accounts and supports multi-coin queries. The query results are sorted in descending order by createdAt and ID.\",\"api-rate-limit-weight\":2}" } }, { @@ -1975,7 +2013,7 @@ "id": "79t7ddnYAv", "name": "type", "required": false, - "description": "Type RealisedPNL-Realised profit and loss, Deposit-Deposit, Withdrawal-withdraw, Transferin-Transfer in, TransferOut-Transfer out", + "description": "Type RealizedPNL-Realized profit and loss, Deposit-Deposit, Withdrawal-withdraw, Transferin-Transfer in, TransferOut-Transfer out", "example": "Transferin", "type": "string", "schema": { @@ -1987,7 +2025,7 @@ "id": "pPnKFH2DlI", "name": "offset", "required": false, - "description": "Start offset. Generally, the only attribute of the last returned result of the previous request is used, and the first page is returned by default", + "description": "Start offset. Generally, only the attributes of the last returned result of the previous request are used, and the first page is returned by default", "example": "254062248624417", "type": "integer", "schema": { @@ -2000,7 +2038,7 @@ "id": "Y9kMltt1Nl", "name": "forward", "required": false, - "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default", + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default.", "example": "false", "type": "boolean", "schema": { @@ -2027,7 +2065,7 @@ "id": "nRkUqJX2U6", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "example": "1728663338000", "type": "integer", "schema": { @@ -2040,7 +2078,7 @@ "id": "rqSOV202LJ", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "example": "1728692138000", "type": "integer", "schema": { @@ -2076,7 +2114,7 @@ "properties": { "time": { "type": "integer", - "description": "ledger time", + "description": "Ledger time", "format": "int64" }, "type": { @@ -2127,7 +2165,7 @@ }, "hasMore": { "type": "boolean", - "description": "Is it the last page. If it is false, it means it is the last page, and if it is true, it means need to turn the page." + "description": "Is it the last page? If it is false, it means it is the last page, and if it is true, it means you need to move to the next page." } }, "required": [ @@ -2163,8 +2201,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis interface can query the ledger records of the futures business line\n:::\n\n\n\n:::tip[Tips]\nIf there are open positions, the status of the first page returned will be Pending, indicating the realised profit and loss in the current 8-hour settlement period. Please specify the minimum offset number of the current page into the offset field to turn the page.\n:::\n\n:::tip[Tips]\nSupplementary instructions for startAt and endAt: startAt must be less than endAt; and the interval cannot exceed 1 day; only one field is allowed, and if only one field is passed, another field will be automatically added or subtracted by the system 1 day to complete\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getFuturesLedger\",\"sdk-method-description\":\"This interface can query the ledger records of the futures business line\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nThis interface can query the ledger records of the futures business line.\n:::\n\n:::tip[Tips]\nIf there are open positions, the status of the first page returned will be Pending, indicating the realized profit and loss in the current 8-hour settlement period. Please specify the minimum offset number of the current page into the offset field to move to the next page.\n:::\n\n:::tip[Tips]\nSupplementary instructions for startAt and endAt: startAt must be less than endAt; and the interval cannot exceed 1 day; only one field is allowed, and if only one field is passed, another field will be automatically added or subtracted by the system 1 day to complete\n:::\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Account\",\"sdk-method-name\":\"getFuturesLedger\",\"sdk-method-description\":\"This interface can query the ledger records of the futures business line.\",\"api-rate-limit-weight\":2}" } } ] @@ -2175,7 +2213,7 @@ "description": "", "items": [ { - "name": "Add SubAccount", + "name": "Add sub-account", "api": { "id": "3470135", "method": "post", @@ -2253,15 +2291,15 @@ "properties": { "password": { "type": "string", - "description": "Password(7-24 characters, must contain letters and numbers, cannot only contain numbers or include special characters)" + "description": "Password (7–24 characters, must contain letters and numbers, cannot only contain numbers or include special characters)" }, "remarks": { "type": "string", - "description": "Remarks(1~24 characters)" + "description": "Remarks (1–24 characters)" }, "subName": { "type": "string", - "description": "Sub-account name(must contain 7-32 characters, at least one number and one letter. Cannot contain any spaces.)" + "description": "Sub-account name (must contain 7–32 characters, at least one number and one letter. Cannot contain any spaces.)" }, "access": { "type": "string", @@ -2300,11 +2338,11 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to create sub-accounts.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"addSubAccount\",\"sdk-method-description\":\"This endpoint can be used to create sub-accounts.\",\"api-rate-limit\":15}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"addSubAccount\",\"sdk-method-description\":\"This endpoint can be used to create sub-accounts.\",\"api-rate-limit-weight\":15}" } }, { - "name": "Add SubAccount Margin Permission", + "name": "Add sub-account Margin Permission", "api": { "id": "3470331", "method": "post", @@ -2368,12 +2406,12 @@ "example": "{\n \"uid\": \"169579801\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can be used to add sub-accounts Margin permission. Before using this endpoints, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"addSubAccountMarginPermission\",\"sdk-method-description\":\"This endpoint can be used to add sub-accounts Margin permission. Before using this endpoints, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated.\",\"api-rate-limit\":15}" + "description": ":::info[Description]\nThis endpoint can be used to add sub-account Margin permissions. Before using this endpoint, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated.\n:::\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"addSubAccountMarginPermission\",\"sdk-method-description\":\"This endpoint can be used to add sub-account Margin permissions. Before using this endpoint, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated.\",\"api-rate-limit-weight\":15}" } }, { - "name": "Add SubAccount Futures Permission", + "name": "Add sub-account Futures Permission", "api": { "id": "3470332", "method": "post", @@ -2437,12 +2475,12 @@ "example": "{\n \"uid\": \"169579801\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can be used to add sub-accounts Futures permission. Before using this endpoints, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"addSubAccountFuturesPermission\",\"sdk-method-description\":\"This endpoint can be used to add sub-accounts Futures permission. Before using this endpoints, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated.\",\"api-rate-limit\":15}" + "description": ":::info[Description]\nThis endpoint can be used to add sub-account Futures permissions. Before using this endpoint, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated.\n:::\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"addSubAccountFuturesPermission\",\"sdk-method-description\":\"This endpoint can be used to add sub-account Futures permissions. Before using this endpoint, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated.\",\"api-rate-limit-weight\":15}" } }, { - "name": "Get SubAccount List - Summary Info", + "name": "Get sub-account List - Summary Info", "api": { "id": "3470131", "method": "get", @@ -2508,7 +2546,7 @@ }, "totalPage": { "type": "integer", - "description": "Total number of page" + "description": "Total number of pages" }, "items": { "type": "array", @@ -2517,7 +2555,7 @@ "properties": { "userId": { "type": "string", - "description": "Sub-account User Id" + "description": "Sub-account User ID" }, "uid": { "type": "integer", @@ -2560,12 +2598,12 @@ { "value": 0, "name": "NORMAL", - "description": "Normal subaccount" + "description": "Normal sub-account" }, { "value": 1, "name": "ROBOT", - "description": "Robot subaccount" + "description": "Robot sub-account" }, { "value": 2, @@ -2575,7 +2613,7 @@ { "value": 5, "name": "HOSTED", - "description": "Asset management subaccount" + "description": "Asset management sub-account" } ] }, @@ -2585,7 +2623,7 @@ }, "createdAt": { "type": "integer", - "description": "Time of the event", + "description": "Time of event", "format": "int64" }, "remarks": { @@ -2597,14 +2635,14 @@ "items": { "type": "string" }, - "description": "Subaccount Permissions" + "description": "Sub-account Permissions" }, "openedTradeTypes": { "type": "array", "items": { "type": "string" }, - "description": "Subaccount active permissions,If do not have the corresponding permissions, need to log in to the sub-account and go to the corresponding web page to activate" + "description": "Sub-account active permissions: If you do not have the corresponding permissions, you must log in to the sub-account and go to the corresponding web page to activate." }, "hostedStatus": { "type": "string" @@ -2663,37 +2701,56 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to get a paginated list of sub-accounts. Pagination is required.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"getSpotSubAccountsSummaryV2\",\"sdk-method-description\":\"This endpoint can be used to get a paginated list of sub-accounts. Pagination is required.\",\"api-rate-limit\":20}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"getSpotSubAccountsSummaryV2\",\"sdk-method-description\":\"This endpoint can be used to get a paginated list of sub-accounts. Pagination is required.\",\"api-rate-limit-weight\":20}" } }, { - "name": "Get SubAccount Detail - Balance", + "name": "Get sub-account Detail - Balance", "api": { "id": "3470132", "method": "get", "path": "/api/v1/sub-accounts/{subUserId}", "parameters": { - "path": [ - { - "id": "subUserId#0", - "name": "subUserId", - "required": true, - "description": "the userID of a sub-account.", - "example": "63743f07e0c5230001761d08", - "type": "string" - } - ], "query": [ { "id": "iIrspuNh6x", "name": "includeBaseAmount", - "required": true, + "required": false, "description": "false: do not display the currency which asset is 0, true: display all currency", - "example": "false", + "example": "", "type": "boolean", "schema": { - "type": "boolean" - } + "type": "boolean", + "default": false + }, + "enable": true + }, + { + "required": false, + "description": "Specify the currency used to convert assets", + "type": "string", + "id": "Gi62c8xnBW", + "enable": true, + "name": "baseCurrency" + }, + { + "required": false, + "description": "Specify the currency balance must be greater than or equal to the amount", + "type": "string", + "id": "GIUrXa6OZV", + "enable": true, + "name": "baseAmount" + } + ], + "path": [ + { + "id": "subUserId#0", + "name": "subUserId", + "required": true, + "description": "the userID of a sub-account.", + "example": "63743f07e0c5230001761d08", + "type": "string", + "enable": true } ], "cookie": [], @@ -2888,17 +2945,16 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint returns the account info of a sub-user specified by the subUserId.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"getSpotSubAccountDetail\",\"sdk-method-description\":\"This endpoint returns the account info of a sub-user specified by the subUserId.\",\"api-rate-limit\":15}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"getSpotSubAccountDetail\",\"sdk-method-description\":\"This endpoint returns the account info of a sub-user specified by the subUserId.\",\"api-rate-limit-weight\":15}" } }, { - "name": "Get SubAccount List - Spot Balance(V2)", + "name": "Get sub-account List - Spot Balance (V2)", "api": { "id": "3470133", "method": "get", "path": "/api/v2/sub-accounts", "parameters": { - "path": [], "query": [ { "id": "iIrspuNh6x", @@ -2913,7 +2969,8 @@ "examples": [ 1 ] - } + }, + "enable": true }, { "id": "hHqVIyqcpo", @@ -2930,9 +2987,11 @@ "default": 10, "minimum": 10, "maximum": 100 - } + }, + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -3152,11 +3211,11 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to get paginated Spot sub-account information. Pagination is required.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"getSpotSubAccountListV2\",\"sdk-method-description\":\"This endpoint can be used to get paginated Spot sub-account information. Pagination is required.\",\"api-rate-limit\":20}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"getSpotSubAccountListV2\",\"sdk-method-description\":\"This endpoint can be used to get paginated Spot sub-account information. Pagination is required.\",\"api-rate-limit-weight\":20}" } }, { - "name": "Get SubAccount List - Futures Balance(V2)", + "name": "Get sub-account List - Futures Balance (V2)", "api": { "id": "3470134", "method": "get", @@ -3167,7 +3226,7 @@ "id": "iIrspuNh6x", "name": "currency", "required": false, - "description": "Currecny, Default XBT", + "description": "Currency, Default XBT", "example": "USDT", "type": "string", "schema": { @@ -3209,7 +3268,7 @@ }, "unrealisedPNLTotal": { "type": "number", - "description": "Total unrealisedPNL" + "description": "Total unrealizedPNL" }, "marginBalanceTotal": { "type": "number", @@ -3228,7 +3287,7 @@ }, "availableBalanceTotal": { "type": "number", - "description": "total available balance" + "description": "Total available balance" }, "currency": { "type": "string" @@ -3332,7 +3391,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to get Futures sub-account information. \n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"getFuturesSubAccountListV2\",\"sdk-method-description\":\"This endpoint can be used to get Futures sub-account information. \",\"api-rate-limit\":6}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"getFuturesSubAccountListV2\",\"sdk-method-description\":\"This endpoint can be used to get Futures sub-account information. \",\"api-rate-limit-weight\":6}" } } ] @@ -3343,7 +3402,7 @@ "description": "", "items": [ { - "name": "Add SubAccount API", + "name": "Add sub-account API", "api": { "id": "3470138", "method": "post", @@ -3403,7 +3462,7 @@ }, "createdAt": { "type": "integer", - "description": "Time of the event", + "description": "Time of event", "format": "int64" } }, @@ -3446,15 +3505,15 @@ "properties": { "passphrase": { "type": "string", - "description": "Password(Must contain 7-32 characters. Cannot contain any spaces.)" + "description": "Password (Must contain 7–32 characters. Cannot contain any spaces.)" }, "remark": { "type": "string", - "description": "Remarks(1~24 characters)" + "description": "Remarks (1–24 characters)" }, "permission": { "type": "string", - "description": "[Permissions](apidog://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")", + "description": "[Permissions](apidog://link/pages/338144)(Only General, Spot, Futures, Margin, InnerTransfer (Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")", "default": "General", "examples": [ "General, Trade" @@ -3462,11 +3521,11 @@ }, "ipWhitelist": { "type": "string", - "description": "IP whitelist(You may add up to 20 IPs. Use a halfwidth comma to each IP)" + "description": "IP whitelist (You may add up to 20 IPs. Use a halfwidth comma to each IP)" }, "expire": { "type": "string", - "description": "API expiration time; Never expire(default)-1，30Day30，90Day90，180Day180，360Day360", + "description": "API expiration time: Never expire(default)-1, 30Day30, 90Day90, 180Day180, 360Day360", "default": "-1", "enum": [ "-1", @@ -3521,11 +3580,11 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to create APIs for sub-accounts.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"addSubAccountApi\",\"sdk-method-description\":\"This endpoint can be used to create APIs for sub-accounts.\",\"api-rate-limit\":20}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"addSubAccountApi\",\"sdk-method-description\":\"This endpoint can be used to create APIs for sub-accounts.\",\"api-rate-limit-weight\":20}" } }, { - "name": "Modify SubAccount API", + "name": "Modify sub-account API", "api": { "id": "3470139", "method": "post", @@ -3602,11 +3661,11 @@ "properties": { "passphrase": { "type": "string", - "description": "Password(Must contain 7-32 characters. Cannot contain any spaces.)" + "description": "Password (Must contain 7–32 characters. Cannot contain any spaces.)" }, "permission": { "type": "string", - "description": "[Permissions](apidog://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")", + "description": "[Permissions](apidog://link/pages/338144)(Only General, Spot, Futures, Margin, InnerTransfer (Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")", "examples": [ "General,Trade" ], @@ -3614,11 +3673,11 @@ }, "ipWhitelist": { "type": "string", - "description": "IP whitelist(You may add up to 20 IPs. Use a halfwidth comma to each IP)" + "description": "IP whitelist (You may add up to 20 IPs. Use a halfwidth comma to each IP)" }, "expire": { "type": "string", - "description": "API expiration time; Never expire(default)-1，30Day30，90Day90，180Day180，360Day360", + "description": "API expiration time: Never expire(default)-1, 30Day30, 90Day90, 180Day180, 360Day360", "default": "-1", "enum": [ "-1", @@ -3664,7 +3723,7 @@ }, "apiKey": { "type": "string", - "description": "API-Key(Sub-account APIKey)" + "description": "API-Key (Sub-account APIKey)" } }, "required": [ @@ -3677,11 +3736,11 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to modify sub-account APIs.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"modifySubAccountApi\",\"sdk-method-description\":\"This endpoint can be used to modify sub-account APIs.\",\"api-rate-limit\":30}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"modifySubAccountApi\",\"sdk-method-description\":\"This endpoint can be used to modify sub-account APIs.\",\"api-rate-limit-weight\":30}" } }, { - "name": "Get SubAccount API List", + "name": "Get sub-account API List", "api": { "id": "3470136", "method": "get", @@ -3799,18 +3858,17 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can be used to obtain a list of APIs pertaining to a sub-account.(Not contain ND Broker Sub Account)\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"getSubAccountApiList\",\"sdk-method-description\":\"This endpoint can be used to obtain a list of APIs pertaining to a sub-account.(Not contain ND Broker Sub Account)\",\"api-rate-limit\":20}" + "description": ":::info[Description]\nThis endpoint can be used to obtain a list of APIs pertaining to a sub-account (not including ND broker sub-accounts).\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"getSubAccountApiList\",\"sdk-method-description\":\"This endpoint can be used to obtain a list of APIs pertaining to a sub-account (not including ND broker sub-accounts).\",\"api-rate-limit-weight\":20}" } }, { - "name": "Delete SubAccount API", + "name": "Delete sub-account API", "api": { "id": "3470137", "method": "delete", "path": "/api/v1/sub/api-key", "parameters": { - "path": [], "query": [ { "id": "iIrspuNh6x", @@ -3821,7 +3879,8 @@ "type": "string", "schema": { "type": "string" - } + }, + "enable": true }, { "id": "ZHD0fezlqh", @@ -3829,17 +3888,20 @@ "required": true, "description": "Sub-account name.", "example": "testapi6", - "type": "string" + "type": "string", + "enable": true }, { "id": "BcPTs91zPK", "name": "passphrase", "required": true, - "description": "Password(Password of the API key)", + "description": "Password (password of the API key)", "example": "11223344", - "type": "string" + "type": "string", + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -3901,7 +3963,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to delete sub-account APIs.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"deleteSubAccountApi\",\"sdk-method-description\":\"This endpoint can be used to delete sub-account APIs.\",\"api-rate-limit\":30}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"SubAccount\",\"sdk-method-name\":\"deleteSubAccountApi\",\"sdk-method-description\":\"This endpoint can be used to delete sub-account APIs.\",\"api-rate-limit-weight\":30}" } } ] @@ -3912,7 +3974,7 @@ "description": "", "items": [ { - "name": "Add Deposit Address(V3)", + "name": "Add Deposit Address (V3)", "api": { "id": "3470142", "method": "post", @@ -3944,7 +4006,7 @@ }, "memo": { "type": "string", - "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious." + "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to KuCoin, you need to fill in memo(tag). Be careful: If you do not fill in memo(tag), your deposit may not be available." }, "chainId": { "type": "string", @@ -3963,11 +4025,11 @@ }, "to": { "type": "string", - "description": "Deposit account type: main (funding account), trade (spot trading account)" + "description": "Deposit account type: MAIN (funding account), TRADE (spot trading account)" }, "expirationDate": { "type": "integer", - "description": "Expiration time, Lightning network expiration time, non-Lightning network this field is invalid" + "description": "Expiration time; Lightning network expiration time; this field is not applicable to non-Lightning networks" }, "currency": { "type": "string", @@ -4030,7 +4092,7 @@ }, "chain": { "type": "string", - "description": "The chainId of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20, default is ERC20. The available value for BTC are Native, Segwit, TRC20, the parameters are bech32, btc, trx, default is Native. This only apply for multi-chain currency, and there is no need for single chain currency.", + "description": "The chainId of currency, e.g. the available values for USDT are OMNI, ERC20, and TRC20; default is ERC20. The available values for BTC are Native, Segwit, TRC20; the parameters are bech32, btc, trx; default is Native. ", "default": "eth", "examples": [ "eth", @@ -4046,22 +4108,22 @@ }, "to": { "type": "string", - "description": "Deposit account type: main (funding account), trade (spot trading account), the default is main", + "description": "Deposit account type: MAIN (funding account), TRADE (spot trading account); the default is MAIN", "enum": [ "main", "trade" ], - "default": "main", + "default": "MAIN", "x-api-enum": [ { "value": "main", - "name": "", - "description": "" + "name": "main", + "description": "Funding account" }, { "value": "trade", - "name": "", - "description": "" + "name": "trade", + "description": "Spot account" } ] }, @@ -4071,18 +4133,19 @@ } }, "required": [ - "currency" + "currency", + "chain" ] }, "example": "{\n \"currency\": \"TON\",\n \"chain\": \"ton\",\n \"to\": \"trade\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to create a deposit address for a currency you intend to deposit.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Deposit\",\"sdk-method-name\":\"addDepositAddressV3\",\"sdk-method-description\":\"Request via this endpoint to create a deposit address for a currency you intend to deposit.\",\"api-rate-limit\":20}" + "description": ":::info[Description]\nRequest via this endpoint the creation of a deposit address for a currency you intend to deposit.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Deposit\",\"sdk-method-name\":\"addDepositAddressV3\",\"sdk-method-description\":\"Request via this endpoint the creation of a deposit address for a currency you intend to deposit.\",\"api-rate-limit-weight\":20}" } }, { - "name": "Get Deposit Address(V3)", + "name": "Get Deposit Address (V3)", "api": { "id": "3470140", "method": "get", @@ -4120,7 +4183,21 @@ "required": false, "description": "The chain Id of currency.", "type": "string", - "enable": true + "enable": true, + "schema": { + "type": "string", + "examples": [ + "eth", + "bech32", + "btc", + "kcc", + "trx", + "bsc", + "arbitrum", + "ton", + "optimism" + ] + } } ], "path": [], @@ -4150,7 +4227,7 @@ }, "memo": { "type": "string", - "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious." + "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to KuCoin, you need to fill in memo(tag). Be careful: If you do not fill in memo(tag), your deposit may not be available." }, "chainId": { "type": "string", @@ -4169,11 +4246,27 @@ }, "to": { "type": "string", - "description": "Deposit account type: main (funding account), trade (spot trading account)" + "description": "Deposit account type: MAIN(funding account), TRADE (spot trading account)", + "enum": [ + "MAIN", + "TRADE" + ], + "x-api-enum": [ + { + "value": "MAIN", + "name": "MAIN", + "description": "Funding account" + }, + { + "value": "TRADE", + "name": "TRADE", + "description": "Spot account" + } + ] }, "expirationDate": { "type": "integer", - "description": "Expiration time, Lightning network expiration time, non-Lightning network this field is invalid" + "description": "Expiration time; Lightning network expiration time; this field is not applicable to non-Lightning networks" }, "currency": { "type": "string", @@ -4233,8 +4326,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nGet all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Deposit\",\"sdk-method-name\":\"getDepositAddressV3\",\"sdk-method-description\":\"Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nGet all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to add the deposit address first.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Deposit\",\"sdk-method-name\":\"getDepositAddressV3\",\"sdk-method-description\":\"Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to add the deposit address first.\",\"api-rate-limit-weight\":5}" } }, { @@ -4279,18 +4372,18 @@ "x-api-enum": [ { "value": "PROCESSING", - "name": "", - "description": "" + "name": "PROCESSING", + "description": "Deposit processing" }, { "value": "SUCCESS", - "name": "", - "description": "" + "name": "SUCCESS", + "description": "Deposit success" }, { "value": "FAILURE", - "name": "", - "description": "" + "name": "FAILURE", + "description": "Deposit fail" } ] }, @@ -4300,7 +4393,7 @@ "id": "5Lwpfvg7zz", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "example": "1728663338000", "type": "integer", "schema": { @@ -4313,7 +4406,7 @@ "id": "WvwRPqp0J5", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "example": "1728692138000", "type": "integer", "schema": { @@ -4517,8 +4610,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::\n\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Deposit\",\"sdk-method-name\":\"getDepositHistory\",\"sdk-method-description\":\"Request via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nRequest a deposit list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::\n\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Deposit\",\"sdk-method-name\":\"getDepositHistory\",\"sdk-method-description\":\"Request a deposit list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\",\"api-rate-limit-weight\":5}" } } ] @@ -4535,7 +4628,6 @@ "method": "get", "path": "/api/v1/withdrawals/quotas", "parameters": { - "path": [], "query": [ { "id": "iIrspuNh6x", @@ -4551,13 +4643,14 @@ "ETH", "USDT" ] - } + }, + "enable": true }, { "id": "Dn0j2ITQMe", "name": "chain", "required": false, - "description": "The chainId of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20, default is ERC20. The available value for BTC are Native, Segwit, TRC20, the parameters are bech32, btc, trx, default is Native. This only apply for multi-chain currency, and there is no need for single chain currency.", + "description": "The chainId of currency, e.g. the available values for USDT are OMNI, ERC20, and TRC20; default is ERC20. The available values for BTC are Native, Segwit, TRC20; the parameters are bech32, btc, trx; default is Native. This only applies to multi-chain currencies; no need for single-chain currencies.", "type": "string", "schema": { "type": "string", @@ -4573,9 +4666,11 @@ "ton", "optimism" ] - } + }, + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -4605,15 +4700,15 @@ }, "quotaCurrency": { "type": "string", - "description": "withdrawal limit currency" + "description": "Withdrawal limit currency" }, "limitQuotaCurrencyAmount": { "type": "string", - "description": "The intraday available withdrawal amount(withdrawal limit currency)" + "description": "The intraday available withdrawal amount (withdrawal limit currency)" }, "usedQuotaCurrencyAmount": { "type": "string", - "description": "The intraday cumulative withdrawal amount(withdrawal limit currency)" + "description": "The intraday cumulative withdrawal amount (withdrawal limit currency)" }, "remainAmount": { "type": "string", @@ -4637,7 +4732,7 @@ }, "isWithdrawEnabled": { "type": "boolean", - "description": "Is the withdraw function enabled or not" + "description": "Is the withdraw function enabled?" }, "precision": { "type": "integer", @@ -4660,7 +4755,7 @@ }, "reason": { "type": "string", - "description": "Reasons for restriction, Usually empty" + "description": "Reasons for restriction. Usually empty." }, "lockedAmount": { "type": "string", @@ -4714,12 +4809,12 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis interface can obtain the withdrawal quotas information of this currency.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Withdrawal\",\"sdk-method-name\":\"getWithdrawalQuotas\",\"sdk-method-description\":\"This interface can obtain the withdrawal quotas information of this currency.\",\"api-rate-limit\":20}" + "description": ":::info[Description]\nThis interface can obtain the withdrawal quota information of this currency.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Withdrawal\",\"sdk-method-name\":\"getWithdrawalQuotas\",\"sdk-method-description\":\"This interface can obtain the withdrawal quota information of this currency.\",\"api-rate-limit-weight\":20}" } }, { - "name": "Withdraw(V3)", + "name": "Withdraw (V3)", "api": { "id": "3470146", "method": "post", @@ -4791,7 +4886,7 @@ }, "chain": { "type": "string", - "description": "The chainId of currency, For a currency with multiple chains, it is recommended to specify chain parameter instead of using the default chain; you can query the chainId through the response of the GET /api/v3/currencies/{currency} interface.", + "description": "The chainId of currency, For a currency with multiple chains, it is recommended to specify the chain parameter instead of using the default chain; you can query the chainId through the response of the GET /api/v3/currencies/{currency} interface.", "default": "eth", "examples": [ "eth", @@ -4812,20 +4907,20 @@ }, "memo": { "type": "string", - "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious." + "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to KuCoin, you need to fill in memo(tag). Be careful: If you do not fill in memo(tag), your deposit may not be available." }, "isInner": { "type": "boolean", - "description": "Internal withdrawal or not. Default : false", + "description": "Internal withdrawal or not. Default: False", "default": false }, "remark": { "type": "string", - "description": "remark" + "description": "Remark" }, "feeDeductType": { "type": "string", - "description": "Withdrawal fee deduction type: INTERNAL or EXTERNAL or not specified\n\n1. INTERNAL- deduct the transaction fees from your withdrawal amount\n2. EXTERNAL- deduct the transaction fees from your main account\n3. If you don't specify the feeDeductType parameter, when the balance in your main account is sufficient to support the withdrawal, the system will initially deduct the transaction fees from your main account. But if the balance in your main account is not sufficient to support the withdrawal, the system will deduct the fees from your withdrawal amount. For example: Suppose you are going to withdraw 1 BTC from the KuCoin platform (transaction fee: 0.0001BTC), if the balance in your main account is insufficient, the system will deduct the transaction fees from your withdrawal amount. In this case, you will be receiving 0.9999BTC." + "description": "Withdrawal fee deduction type: INTERNAL, EXTERNAL, or not specified\n\n1. INTERNAL: Deduct the transaction fees from your withdrawal amount\n2. EXTERNAL: Deduct the transaction fees from your main account\n3. If you don't specify the feeDeductType parameter, when the balance in your main account is sufficient to support the withdrawal, the system will initially deduct the transaction fees from your main account. But if the balance in your main account is not sufficient to support the withdrawal, the system will deduct the fees from your withdrawal amount. For example: Suppose you are going to withdraw 1 BTC from the KuCoin platform (transaction fee: 0.0001BTC), if the balance in your main account is insufficient, the system will deduct the transaction fees from your withdrawal amount. In this case, you will be receiving 0.9999BTC." }, "toAddress": { "type": "string", @@ -4839,7 +4934,7 @@ }, "withdrawType": { "type": "string", - "description": "Withdrawal type, ADDRESS (withdrawal address), UID, MAIL (email), PHONE (mobile phone number). Note: If you withdraw by uid/mail/phone, there will have rate limited: 3 times/10 seconds, 50 times/24 hours (calculated on a rolling basis based on the first request time)", + "description": "Withdrawal type, ADDRESS (withdrawal address), UID, MAIL (email), PHONE (mobile phone number). Note: If you withdraw by uid/mail/phone, there will be rate limits: 3 times/10 seconds, 50 times/24 hours (calculated on a rolling basis based on the first request time)", "enum": [ "ADDRESS", "UID", @@ -4880,8 +4975,8 @@ "example": "{\n \"currency\": \"USDT\",\n \"toAddress\": \"TKFRQXSDcY****GmLrjJggwX8\",\n \"amount\": 3,\n \"withdrawType\": \"ADDRESS\",\n \"chain\": \"trx\",\n \"isInner\": true,\n \"remark\": \"this is Remark\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nUse this interface to withdraw the specified currency\n:::\n\n:::tip[Tips]\nOn the WEB end, you can open the switch of specified favorite addresses for withdrawal, and when it is turned on, it will verify whether your withdrawal address(including chain) is a favorite address(it is case sensitive); if it fails validation, it will respond with the error message {\"msg\":\"Already set withdraw whitelist, this address is not favorite address\",\"code\":\"260325\"}.\n:::\n\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Withdrawal\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Withdrawal\",\"sdk-method-name\":\"withdrawalV3\",\"sdk-method-description\":\"Use this interface to withdraw the specified currency\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nUse this interface to withdraw the specified currency.\n:::\n\n:::tip[Tips]\nOn the WEB end, you can open the switch of specified favorite addresses for withdrawal, and when it is turned on, it will verify whether your withdrawal address (including chain) is a favorite address (it is case sensitive); if it fails validation, it will respond with the error message {\"msg\":\"Already set withdraw whitelist, this address is not favorite address\",\"code\":\"260325\"}.\n:::\n\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Withdrawal\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Withdrawal\",\"sdk-method-name\":\"withdrawalV3\",\"sdk-method-description\":\"Use this interface to withdraw the specified currency.\",\"api-rate-limit-weight\":5}" } }, { @@ -4891,6 +4986,7 @@ "method": "delete", "path": "/api/v1/withdrawals/{withdrawalId}", "parameters": { + "query": [], "path": [ { "id": "withdrawalId#0", @@ -4898,10 +4994,10 @@ "required": true, "description": "Path parameter, a unique ID for a withdrawalId", "example": "670b891f7e0f440007730692", - "type": "string" + "type": "string", + "enable": true } ], - "query": [], "cookie": [], "header": [] }, @@ -4948,8 +5044,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis interface can cancel the withdrawal, Only withdrawals requests of PROCESSING status could be canceled.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Withdrawal\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Withdrawal\",\"sdk-method-name\":\"cancelWithdrawal\",\"sdk-method-description\":\"This interface can cancel the withdrawal, Only withdrawals requests of PROCESSING status could be canceled.\",\"api-rate-limit\":20}" + "description": ":::info[Description]\nThis interface can cancel the withdrawal. Only withdrawal requests with PROCESSING status can be canceled.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Withdrawal\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Withdrawal\",\"sdk-method-name\":\"cancelWithdrawal\",\"sdk-method-description\":\"This interface can cancel the withdrawal. Only withdrawal requests with PROCESSING status can be canceled.\",\"api-rate-limit-weight\":20}" } }, { @@ -4981,13 +5077,14 @@ "id": "0cGmW3GSC0", "name": "status", "required": false, - "description": "Status. Available value: PROCESSING, WALLET_PROCESSING, SUCCESS, and FAILURE", + "description": "Status. Available value: REVIEW, PROCESSING, WALLET_PROCESSING, SUCCESS and FAILURE", "example": "SUCCESS", "type": "string", "schema": { "type": "string", "enum": [ "PROCESSING", + "REVIEW", "WALLET_PROCESSING", "SUCCESS", "FAILURE" @@ -4995,22 +5092,27 @@ "x-api-enum": [ { "value": "PROCESSING", - "name": "", + "name": "PROCESSING", + "description": "" + }, + { + "value": "REVIEW", + "name": "REVIEW", "description": "" }, { "value": "WALLET_PROCESSING", - "name": "", + "name": "WALLET_PROCESSING", "description": "" }, { "value": "SUCCESS", - "name": "", + "name": "SUCCESS", "description": "" }, { "value": "FAILURE", - "name": "", + "name": "FAILURE", "description": "" } ] @@ -5021,7 +5123,7 @@ "id": "5Lwpfvg7zz", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "example": "1728663338000", "type": "integer", "schema": { @@ -5034,7 +5136,7 @@ "id": "WvwRPqp0J5", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "example": "1728692138000", "type": "integer", "schema": { @@ -5114,7 +5216,7 @@ "properties": { "id": { "type": "string", - "description": "Unique id" + "description": "Unique ID" }, "currency": { "type": "string", @@ -5137,32 +5239,38 @@ }, "status": { "type": "string", - "description": "Status", "enum": [ + "REVIEW", "PROCESSING", "WALLET_PROCESSING", - "SUCCESS", - "FAILURE" + "FAILURE", + "SUCCESS" ], + "description": "Status. Available value: REVIEW, PROCESSING, WALLET_PROCESSING, SUCCESS and FAILURE", "x-api-enum": [ + { + "value": "REVIEW", + "name": "REVIEW", + "description": "" + }, { "value": "PROCESSING", - "name": "", + "name": "PROCESSING", "description": "" }, { "value": "WALLET_PROCESSING", - "name": "", + "name": "WALLET_PROCESSING", "description": "" }, { - "value": "SUCCESS", - "name": "", + "value": "FAILURE", + "name": "FAILURE", "description": "" }, { - "value": "FAILURE", - "name": "", + "value": "SUCCESS", + "name": "SUCCESS", "description": "" } ] @@ -5193,7 +5301,7 @@ }, "createdAt": { "type": "integer", - "description": "Creation time of the database record", + "description": "Database record creation time", "format": "int64" }, "updatedAt": { @@ -5203,7 +5311,7 @@ }, "remark": { "type": "string", - "description": "remark" + "description": "Remark" } } } @@ -5245,8 +5353,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get withdrawal list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Withdrawal\",\"sdk-method-name\":\"getWithdrawalHistory\",\"sdk-method-description\":\"Request via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\",\"api-rate-limit\":20}" + "description": ":::info[Description]\nRequest a withdrawal list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Withdrawal\",\"sdk-method-name\":\"getWithdrawalHistory\",\"sdk-method-description\":\"Request a withdrawal list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\",\"api-rate-limit-weight\":20}" } } ] @@ -5285,7 +5393,7 @@ "id": "Dn0j2ITQMe", "name": "type", "required": true, - "description": "The account type:MAIN、TRADE、MARGIN、ISOLATED", + "description": "The account type:MAIN, TRADE, MARGIN, ISOLATED, MARGIN_V2, ISOLATED_V2", "type": "string", "schema": { "type": "string", @@ -5294,7 +5402,9 @@ "TRADE", "MARGIN", "ISOLATED", - "OPTION" + "OPTION", + "MARGIN_V2", + "ISOLATED_V2" ], "x-api-enum": [ { @@ -5310,17 +5420,27 @@ { "value": "MARGIN", "name": "MARGIN", - "description": "Cross margin account" + "description": "Spot cross margin account" }, { "value": "ISOLATED", "name": "ISOLATED", - "description": "Isolated margin account" + "description": "Spot isolated margin account" }, { "value": "OPTION", "name": "OPTION", "description": "Option account" + }, + { + "value": "MARGIN_V2", + "name": "MARGIN_V2", + "description": "Spot cross margin HF account" + }, + { + "value": "ISOLATED_V2", + "name": "ISOLATED_V2", + "description": "Spot isolated margin HF account" } ] }, @@ -5331,7 +5451,7 @@ "id": "pU2UVFoaY6", "name": "tag", "required": false, - "description": "Trading pair, required when the account type is ISOLATED; other types are not passed, e.g.: BTC-USDT", + "description": "Trading pair required when the account type is ISOLATED; other types do not pass, e.g.: BTC-USDT", "type": "string", "schema": { "type": "string", @@ -5421,7 +5541,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint returns the transferable balance of a specified account.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Transfer\",\"sdk-method-name\":\"getTransferQuotas\",\"sdk-method-description\":\"This endpoint returns the transferable balance of a specified account.\",\"api-rate-limit\":20}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Transfer\",\"sdk-method-name\":\"getTransferQuotas\",\"sdk-method-description\":\"This endpoint returns the transferable balance of a specified account.\",\"api-rate-limit-weight\":20}" } }, { @@ -5488,7 +5608,7 @@ "properties": { "clientOid": { "type": "string", - "description": "Unique order id created by users to identify their orders, e.g. UUID, with a maximum length of 128 bits" + "description": "Unique order ID created by users to identify their orders, e.g. UUID, with a maximum length of 128 bits" }, "currency": { "type": "string", @@ -5496,15 +5616,15 @@ }, "amount": { "type": "string", - "description": "Transfer amount, the amount is a positive integer multiple of the currency precision." + "description": "Transfer amount: The amount is a positive integer multiple of the currency precision." }, "fromUserId": { "type": "string", - "description": "Transfer out UserId， This is required when transferring sub-account to master-account. It is optional for internal transfers." + "description": "Transfer out UserId: This is required when transferring from sub-account to master-account. It is optional for internal transfers." }, "fromAccountType": { "type": "string", - "description": "Account type：MAIN、TRADE、CONTRACT、MARGIN、ISOLATED、MARGIN_V2、ISOLATED_V2", + "description": "Account type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED, MARGIN_V2, ISOLATED_V2", "enum": [ "MAIN", "TRADE", @@ -5560,11 +5680,11 @@ }, "fromAccountTag": { "type": "string", - "description": "Symbol, required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT" + "description": "Symbol: Required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT" }, "type": { "type": "string", - "description": "Transfer type：INTERNAL(Transfer within account)、PARENT_TO_SUB(Transfer from master-account to sub-account)，SUB_TO_PARENT(Transfer from sub-account to master-account)", + "description": "Transfer type: INTERNAL (Transfer within account), PARENT_TO_SUB (Transfer from master-account to sub-account), SUB_TO_PARENT (Transfer from sub-account to master-account)", "enum": [ "INTERNAL", "PARENT_TO_SUB", @@ -5590,11 +5710,11 @@ }, "toUserId": { "type": "string", - "description": "Transfer in UserId， This is required when transferring master-account to sub-account. It is optional for internal transfers." + "description": "Transfer in UserId: This is required when transferring master-account to sub-account. It is optional for internal transfers." }, "toAccountType": { "type": "string", - "description": "Account type：MAIN、TRADE、CONTRACT、MARGIN、ISOLATED、MARGIN_V2、ISOLATED_V2", + "description": "Account type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED, MARGIN_V2, ISOLATED_V2", "enum": [ "MAIN", "TRADE", @@ -5650,7 +5770,7 @@ }, "toAccountTag": { "type": "string", - "description": "Symbol, required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT" + "description": "Symbol: Required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT" } }, "required": [ @@ -5665,8 +5785,8 @@ "example": "//transfer from master-account to sub-account\n{\n \"clientOid\": \"64ccc0f164781800010d8c09\",\n \"type\": \"PARENT_TO_SUB\",\n \"currency\": \"USDT\",\n \"amount\": \"0.01\",\n \"fromAccountType\": \"TRADE\",\n \"toUserId\": \"63743f07e0c5230001761d08\",\n \"toAccountType\": \"TRADE\"\n}\n\n//transfer from sub-account to master-account\n// {\n// \"clientOid\": \"64ccc0f164781800010d8c09\",\n// \"type\": \"SUB_TO_PARENT\",\n// \"currency\": \"BTC\",\n// \"amount\": 1,\n// \"fromUserId\": \"62f5f5d4d72aaf000122707e\",\n// \"fromAccountType\": \"TRADE\",\n// \"toAccountType\": \"CONTRACT\"\n// }\n\n// internal transfer\n// {\n// \"clientOid\": \"53666633336123\",\n// \"type\": \"INTERNAL\",\n// \"currency\": \"BTC\",\n// \"amount\": 0.0003,\n// \"fromAccountType\": \"TRADE\",\n// \"toAccountType\": \"MAIN\"\n// }\n\n\n\n\n\n", "mediaType": "" }, - "description": ":::info[Description]\nThis interface can be used for transfers between master and sub accounts and inner transfers\n:::\n\n\n\nThe API Key needs to have universal transfer permission when calling.\n\nSupport internal transfer,do not support transfers between sub-accounts.\n\nSupport transfer between master and sub accounts (only applicable to master account APIKey).\n\nMARGIN_V2 only supports internal transfers between MARGIN and does not support transfers between master and sub accounts.\n\nISOLATED_V2 only supports internal transfers between ISOLATED and does not support transfers between master and sub accounts.", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"FlexTransfers\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Transfer\",\"sdk-method-name\":\"flexTransfer\",\"sdk-method-description\":\"This interface can be used for transfers between master and sub accounts and inner transfers\",\"api-rate-limit\":4}" + "description": ":::info[Description]\nThis interface can be used for transfers between master- and sub-accounts and transfers\n:::\n\nThe API Key needs universal transfer permission when calling.\n\nIt supports transfers between master account and sub-accounts, and also supports transfers between different types of accounts.\n\nIt supports transfer between master account and sub-accounts (only applicable to master account APIKey).\n\nMARGIN_V2 only supports internal transfers between MARGIN and does not support transfers between master- and sub-accounts.\n\nISOLATED_V2 only supports internal transfers between ISOLATED and does not support transfers between master- and sub-accounts.", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"FlexTransfers\",\"api-rate-limit-pool\":\"Management\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Transfer\",\"sdk-method-name\":\"flexTransfer\",\"sdk-method-description\":\"This interface can be used for transfers between master- and sub-accounts and transfers\",\"api-rate-limit-weight\":4}" } } ] @@ -5688,7 +5808,7 @@ "id": "iIrspuNh6x", "name": "currencyType", "required": false, - "description": "Currency type: 0-crypto currency, 1-fiat currency. default is 0-crypto currency\n", + "description": "Currency type: 0-crypto currency, 1-fiat currency. Default is 0-crypto currency", "example": "", "type": "integer", "schema": { @@ -5778,8 +5898,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis interface is for the spot/margin basic fee rate of users\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Fee\",\"sdk-method-name\":\"getBasicFee\",\"sdk-method-description\":\"This interface is for the spot/margin basic fee rate of users\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nThis interface is for the user’s spot/margin basic fee rate.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Fee\",\"sdk-method-name\":\"getBasicFee\",\"sdk-method-description\":\"This interface is for the user’s spot/margin basic fee rate.\",\"api-rate-limit-weight\":3}" } }, { @@ -5789,13 +5909,12 @@ "method": "get", "path": "/api/v1/trade-fees", "parameters": { - "path": [], "query": [ { "id": "iIrspuNh6x", "name": "symbols", "required": true, - "description": "Trading pair (optional, you can inquire fee rates of 10 trading pairs each time at most)", + "description": "Trading pair (optional; you can inquire fee rates of 10 trading pairs each time at most)", "example": "", "type": "string", "schema": { @@ -5804,9 +5923,11 @@ "BTC-USDT,ETH-USDT", "KCS-USDT" ] - } + }, + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -5829,7 +5950,7 @@ "properties": { "symbol": { "type": "string", - "description": "The unique identity of the trading pair and will not change even if the trading pair is renamed" + "description": "The unique identity of the trading pair; will not change even if the trading pair is renamed" }, "takerFeeRate": { "type": "string", @@ -5838,6 +5959,14 @@ "makerFeeRate": { "type": "string", "description": "Actual maker fee rate of the symbol" + }, + "sellTaxRate": { + "type": "string", + "description": "Buy tax rate, This field is visible to users in certain countries" + }, + "buyTaxRate": { + "type": "string", + "description": "Sell tax rate, This field is visible to users in certain countries" } }, "required": [ @@ -5875,8 +6004,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis interface is for the actual fee rate of the trading pair. You can inquire about fee rates of 10 trading pairs each time at most. The fee rate of your sub-account is the same as that of the master account.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Fee\",\"sdk-method-name\":\"getSpotActualFee\",\"sdk-method-description\":\"This interface is for the actual fee rate of the trading pair. You can inquire about fee rates of 10 trading pairs each time at most. The fee rate of your sub-account is the same as that of the master account.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nThis interface is for the trading pair’s actual fee rate. You can inquire about fee rates of 10 trading pairs each time at most. The fee rate of your sub-account is the same as that of the master account.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Fee\",\"sdk-method-name\":\"getSpotActualFee\",\"sdk-method-description\":\"This interface is for the trading pair’s actual fee rate. You can inquire about fee rates of 10 trading pairs each time at most. The fee rate of your sub-account is the same as that of the master account.\",\"api-rate-limit-weight\":3}" } }, { @@ -5886,13 +6015,12 @@ "method": "get", "path": "/api/v1/trade-fees", "parameters": { - "path": [], "query": [ { "id": "iIrspuNh6x", "name": "symbol", "required": true, - "description": "Trading pair", + "description": "The unique identity of the trading pair; will not change even if the trading pair is renamed", "example": "", "type": "string", "schema": { @@ -5902,9 +6030,11 @@ "XBTUSDM", "ETHUSDTM" ] - } + }, + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -5925,7 +6055,7 @@ "properties": { "symbol": { "type": "string", - "description": "The unique identity of the trading pair and will not change even if the trading pair is renamed" + "description": "The unique identity of the trading pair; will not change even if the trading pair is renamed" }, "takerFeeRate": { "type": "string", @@ -5970,8 +6100,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis interface is for the actual futures fee rate of the trading pair. The fee rate of your sub-account is the same as that of the master account.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Fee\",\"sdk-method-name\":\"getFuturesActualFee\",\"sdk-method-description\":\"This interface is for the actual futures fee rate of the trading pair. The fee rate of your sub-account is the same as that of the master account.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nThis interface is for the trading pair’s actual futures fee rate. The fee rate of your sub-account is the same as that of the master account.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Account\",\"sdk-sub-service\":\"Fee\",\"sdk-method-name\":\"getFuturesActualFee\",\"sdk-method-description\":\"This interface is for the trading pair’s actual futures fee rate. The fee rate of your sub-account is the same as that of the master account.\",\"api-rate-limit-weight\":3}" } } ] @@ -6000,33 +6130,33 @@ "id": "j3zlyFZAZT", "name": "currentPage", "required": false, - "description": "page number", + "description": "Page number", + "example": "1", "type": "integer", "schema": { "type": "integer", "format": "int64" }, - "enable": true, - "example": "1" + "enable": true }, { "id": "35MLManAOr", "name": "pageSize", "required": false, - "description": "page Size", + "description": "Page Size", + "example": "50", "type": "integer", "schema": { "type": "integer", "format": "int64" }, - "enable": true, - "example": "50" + "enable": true }, { "id": "c9UEoOtAzp", "name": "annType", "required": false, - "description": "Announcement types: latest-announcements , activities (latest activities), new-listings (new currency online), product-updates (product updates), vip (institutions and VIPs), maintenance-updates (system maintenance), product -updates (product news), delistings (currency offline), others, api-campaigns (API user activities), default : latest-announcements", + "description": "Announcement types: latest-announcements, activities (latest activities), new-listings (new currency online), product-updates (product updates), vip (institutions and VIPs), maintenance-updates (system maintenance), product-updates (product news), delistings (currency offline), others, api-campaigns (API user activities), default: latest-announcements", "example": "latest-announcements", "type": "string", "schema": { @@ -6061,7 +6191,7 @@ }, { "value": "vip ", - "name": "VIPS", + "name": "VIPs", "description": "institutions and VIPs" }, { @@ -6097,7 +6227,8 @@ "id": "ncGIEDsZtk", "name": "lang", "required": false, - "description": "Language type, the default is en_US, the specific value parameters are as follows", + "description": "Language type: The default is en_US, the specific value parameters are as follows", + "example": "en_US", "type": "string", "schema": { "type": "string", @@ -6239,34 +6370,33 @@ } ] }, - "enable": true, - "example": "en_US" + "enable": true }, { "id": "7mBb3WnnJZ", "name": "startTime", "required": false, "description": "Announcement online start time (milliseconds)", + "example": "1729594043000", "type": "integer", "schema": { "type": "integer", "format": "int64" }, - "enable": true, - "example": "1729594043000" + "enable": true }, { "id": "r87zURGF3N", "name": "endTime", "required": false, "description": "Announcement online end time (milliseconds)", + "example": "1729697729000", "type": "integer", "schema": { "type": "integer", "format": "int64" }, - "enable": true, - "example": "1729697729000" + "enable": true } ], "path": [], @@ -6323,7 +6453,7 @@ }, "language": { "type": "string", - "description": "language type" + "description": "Language type" }, "annUrl": { "type": "string", @@ -6351,7 +6481,7 @@ }, "totalPage": { "type": "integer", - "description": "Total Page" + "description": "Total Pages" } }, "required": [ @@ -6376,7 +6506,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"totalNum\": 195,\n \"totalPage\": 13,\n \"currentPage\": 1,\n \"pageSize\": 15,\n \"items\": [\n {\n \"annId\": 129045,\n \"annTitle\": \"KuCoin Isolated Margin Adds the Scroll (SCR) Trading Pair\",\n \"annType\": [\n \"latest-announcements\"\n ],\n \"annDesc\": \"To enrich the variety of assets available, KuCoin’s Isolated Margin Trading platform has added the Scroll (SCR) asset and trading pair.\",\n \"cTime\": 1729594043000,\n \"language\": \"en_US\",\n \"annUrl\": \"https://www.kucoin.com/announcement/kucoin-isolated-margin-adds-scr?lang=en_US\"\n },\n {\n \"annId\": 129001,\n \"annTitle\": \"DAPP-30D Fixed Promotion, Enjoy an APR of 200%!​\",\n \"annType\": [\n \"latest-announcements\",\n \"activities\"\n ],\n \"annDesc\": \"KuCoin Earn will be launching the DAPP Fixed Promotion at 10:00:00 on October 22, 2024 (UTC). The available product is “DAPP-30D'' with an APR of 200%.\",\n \"cTime\": 1729588460000,\n \"language\": \"en_US\",\n \"annUrl\": \"https://www.kucoin.com/announcement/dapp-30d-fixed-promotion-enjoy?lang=en_US\"\n },\n {\n \"annId\": 128581,\n \"annTitle\": \"NAYM (NAYM) Gets Listed on KuCoin! World Premiere!\",\n \"annType\": [\n \"latest-announcements\",\n \"new-listings\"\n ],\n \"annDesc\": \"Trading: 11:00 on October 22, 2024 (UTC)\",\n \"cTime\": 1729497729000,\n \"language\": \"en_US\",\n \"annUrl\": \"https://www.kucoin.com/announcement/en-naym-naym-gets-listed-on-kucoin-world-premiere?lang=en_US\"\n }\n ]\n }\n}", + "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"totalNum\": 195,\n \"totalPage\": 13,\n \"currentPage\": 1,\n \"pageSize\": 15,\n \"items\": [\n {\n \"annId\": 129045,\n \"annTitle\": \"KuCoin Isolated Margin Adds the Scroll (SCR) Trading Pair\",\n \"annType\": [\n \"latest-announcements\"\n ],\n \"annDesc\": \"To enrich the variety of assets available, KuCoin’s Isolated Margin Trading platform has added the Scroll (SCR) asset and trading pair.\",\n \"cTime\": 1729594043000,\n \"language\": \"en_US\",\n \"annUrl\": \"https://www.kucoin.com/announcement/kucoin-isolated-margin-adds-scr?lang=en_US\"\n },\n {\n \"annId\": 129001,\n \"annTitle\": \"DAPP-30D Fixed Promotion, Enjoy an APR of 200%!​\",\n \"annType\": [\n \"latest-announcements\",\n \"activities\"\n ],\n \"annDesc\": \"KuCoin Earn will be launching the DAPP Fixed Promotion at 10:00:00 on October 22, 2024 (UTC). The available product is “DAPP-30D'' with an APR of 200%.\",\n \"cTime\": 1729588460000,\n \"language\": \"en_US\",\n \"annUrl\": \"https://www.kucoin.com/announcement/dapp-30d-fixed-promotion-enjoy?lang=en_US\"\n },\n {\n \"annId\": 128581,\n \"annTitle\": \"NAYM (NAYM) Gets Listed on KuCoin! World Premiere!\",\n \"annType\": [\n \"latest-announcements\",\n \"new-listings\"\n ],\n \"annDesc\": \"Trading: 11:00 on October 22, 2024 (UTC)\",\n \"cTime\": 1729497729000,\n \"language\": \"en_US\",\n \"annUrl\": \"https://www.kucoin.com/announcement/en-naym-naym-gets-listed-on-kucoin-world-premiere?lang=en_US\"\n }\n ]\n }\n}", "responseId": 10321, "ordering": 1 } @@ -6391,7 +6521,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis interface can obtain the latest news announcements, and the default page search is for announcements within a month.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getAnnouncements\",\"sdk-method-description\":\"This interface can obtain the latest news announcements, and the default page search is for announcements within a month.\",\"api-rate-limit\":20}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getAnnouncements\",\"sdk-method-description\":\"This interface can obtain the latest news announcements, and the default page search is for announcements within a month.\",\"api-rate-limit-weight\":20}" } }, { @@ -6401,30 +6531,12 @@ "method": "get", "path": "/api/v3/currencies/{currency}", "parameters": { - "path": [ - { - "id": "currency#0", - "name": "currency", - "required": true, - "description": "Path parameter, Currency", - "example": "BTC", - "type": "string", - "schema": { - "type": "string", - "examples": [ - "BTC", - "ETH", - "USDT" - ] - } - } - ], "query": [ { "id": "nSUWM8eRPB", "name": "chain", "required": false, - "description": "Support for querying the chain of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20. This only apply for multi-chain currency, and there is no need for single chain currency.", + "description": "Support for querying the chain of currency, e.g. the available values for USDT are OMNI, ERC20, TRC20. This only applies to multi-chain currencies; no need for single-chain currencies.", "example": "", "type": "string", "schema": { @@ -6440,7 +6552,27 @@ "ton", "optimism" ] - } + }, + "enable": true + } + ], + "path": [ + { + "id": "currency#0", + "name": "currency", + "required": true, + "description": "Path parameter, Currency", + "example": "BTC", + "type": "string", + "schema": { + "type": "string", + "examples": [ + "BTC", + "ETH", + "USDT" + ] + }, + "enable": true } ], "cookie": [], @@ -6467,11 +6599,11 @@ }, "name": { "type": "string", - "description": "Currency name, will change after renaming" + "description": "Currency name; will change after renaming" }, "fullName": { "type": "string", - "description": "Full name of a currency, will change after renaming" + "description": "Full currency name; will change after renaming" }, "precision": { "type": "integer", @@ -6487,11 +6619,11 @@ }, "isMarginEnabled": { "type": "boolean", - "description": "Support margin or not" + "description": "Margin support or not" }, "isDebitEnabled": { "type": "boolean", - "description": "Support debit or not" + "description": "Debit support or not" }, "chains": { "type": "array", @@ -6500,7 +6632,7 @@ "properties": { "chainName": { "type": "string", - "description": "chain name of currency" + "description": "Chain name of currency" }, "withdrawalMinSize": { "type": "string", @@ -6512,7 +6644,7 @@ }, "withdrawFeeRate": { "type": "string", - "description": "withdraw fee rate" + "description": "Withdraw fee rate" }, "withdrawalMinFee": { "type": "string", @@ -6520,11 +6652,11 @@ }, "isWithdrawEnabled": { "type": "boolean", - "description": "Support withdrawal or not" + "description": "Withdrawal support or not" }, "isDepositEnabled": { "type": "boolean", - "description": "Support deposit or not" + "description": "Deposit support or not" }, "confirms": { "type": "integer", @@ -6552,11 +6684,11 @@ }, "needTag": { "type": "boolean", - "description": "whether memo/tag is needed" + "description": "Need for memo/tag or not" }, "chainId": { "type": "string", - "description": "chain id of currency" + "description": "Chain id of currency" } }, "required": [ @@ -6577,7 +6709,7 @@ "chainId" ] }, - "description": "chain list" + "description": "Chain list" } }, "required": [ @@ -6620,8 +6752,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the currency details of a specified currency\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getCurrency\",\"sdk-method-description\":\"Request via this endpoint to get the currency details of a specified currency\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nRequest the currency details of a specified currency via this endpoint.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getCurrency\",\"sdk-method-description\":\"Request the currency details of a specified currency via this endpoint.\",\"api-rate-limit-weight\":3}" } }, { @@ -6631,8 +6763,8 @@ "method": "get", "path": "/api/v3/currencies", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -6659,11 +6791,11 @@ }, "name": { "type": "string", - "description": "Currency name, will change after renaming" + "description": "Currency name; will change after renaming" }, "fullName": { "type": "string", - "description": "Full name of a currency, will change after renaming" + "description": "Full currency name; will change after renaming" }, "precision": { "type": "integer", @@ -6679,11 +6811,11 @@ }, "isMarginEnabled": { "type": "boolean", - "description": "Support margin or not" + "description": "Margin support or not" }, "isDebitEnabled": { "type": "boolean", - "description": "Support debit or not" + "description": "Debit support or not" }, "chains": { "type": "array", @@ -6692,7 +6824,7 @@ "properties": { "chainName": { "type": "string", - "description": "chain name of currency" + "description": "Chain name of currency" }, "withdrawalMinSize": { "type": "string", @@ -6704,7 +6836,7 @@ }, "withdrawFeeRate": { "type": "string", - "description": "withdraw fee rate" + "description": "Withdraw fee rate" }, "withdrawalMinFee": { "type": "string", @@ -6712,11 +6844,11 @@ }, "isWithdrawEnabled": { "type": "boolean", - "description": "Support withdrawal or not" + "description": "Withdrawal support or not" }, "isDepositEnabled": { "type": "boolean", - "description": "Support deposit or not" + "description": "Deposit support or not" }, "confirms": { "type": "integer", @@ -6744,19 +6876,19 @@ }, "needTag": { "type": "boolean", - "description": "whether memo/tag is needed" + "description": "Need for memo/tag or not" }, "chainId": { "type": "string", - "description": "chain id of currency" + "description": "Chain id of currency" }, "depositFeeRate": { "type": "string", - "description": "deposit fee rate (some currencies have this param, the default is empty)" + "description": "Deposit fee rate (some currencies have this param; the default is empty)" }, "withdrawMaxFee": { "type": "string", - "description": "withdraw max fee(some currencies have this param, the default is empty)" + "description": "Withdraw max. fee (some currencies have this param; the default is empty)" }, "depositTierFee": { "type": "string" @@ -6780,7 +6912,7 @@ "chainId" ] }, - "description": "chain list" + "description": "Chain list" } }, "required": [ @@ -6824,8 +6956,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the currency list. Not all currencies currently can be used for trading.\n:::\n\n:::tip[Tips]\n**CURRENCY CODES**\n\nCurrency codes will conform to the ISO 4217 standard where possible. Currencies which have or had no representation in ISO 4217 may use a custom code.\n\n\n| Code | Description |\n| --- | --- |\n| BTC | Bitcoin |\n| ETH | Ethereum |\n| KCS | Kucoin Shares |\n\nFor a coin, the \"**currency**\" is a fixed value and works as the only recognized identity of the coin. As the \"**name**\", \"**fullnane**\" and \"**precision**\" of a coin are modifiable values, when the \"name\" of a coin is changed, you should use \"**currency**\" to get the coin.\n\nFor example: The \"**currency**\" of XRB is \"XRB\", if the \"**name**\" of XRB is changed into \"**Nano**\", you should use \"XRB\" (the currency of XRB) to search the coin.\n:::\n\n\n\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getAllCurrencies\",\"sdk-method-description\":\"Request via this endpoint to get the currency list.Not all currencies currently can be used for trading.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nRequest a currency list via this endpoint. Not all currencies currently can be used for trading.\n:::\n\n:::tip[Tips]\n**CURRENCY CODES**\n\nCurrency codes will conform to the ISO 4217 standard where possible. Currencies which have or had no representation in ISO 4217 may use a custom code.\n\n\n| Code | Description |\n| --- | --- |\n| BTC | Bitcoin |\n| ETH | Ethereum |\n| KCS | Kucoin Shares |\n\nFor a coin, the \"**currency**\" is a fixed value and works as the only recognized identity of the coin. As the \"**name**\", \"**fullnane**\" and \"**precision**\" of a coin are modifiable values, when the \"name\" of a coin is changed, you should use \"**currency**\" to get the coin.\n\nFor example: The \"**currency**\" of XRB is \"XRB\"; if the \"**name**\" of XRB is changed into \"**Nano**\", you should use \"XRB\" (the currency of XRB) to search the coin.\n:::\n\n\n\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getAllCurrencies\",\"sdk-method-description\":\"Request a currency list via this endpoint. Not all currencies can currently be used for trading.\",\"api-rate-limit-weight\":3}" } }, { @@ -6835,6 +6967,7 @@ "method": "get", "path": "/api/v2/symbols/{symbol}", "parameters": { + "query": [], "path": [ { "id": "symbol#0", @@ -6845,10 +6978,10 @@ "type": "string", "schema": { "type": "string" - } + }, + "enable": true } ], - "query": [], "cookie": [], "header": [] }, @@ -6869,7 +7002,7 @@ "properties": { "symbol": { "type": "string", - "description": "unique code of a symbol, it would not change after renaming", + "description": "Unique code of a symbol; it will not change after renaming", "examples": [ "BTC-USDT", "BCHSV-USDT" @@ -6877,7 +7010,7 @@ }, "name": { "type": "string", - "description": "Name of trading pairs, it would change after renaming", + "description": "Name of trading pairs, it will change after renaming", "examples": [ "BTC-USDT", "BSV-USDT" @@ -6885,11 +7018,11 @@ }, "baseCurrency": { "type": "string", - "description": "Base currency,e.g. BTC." + "description": "Base currency, e.g. BTC." }, "quoteCurrency": { "type": "string", - "description": "Quote currency,e.g. USDT." + "description": "Quote currency, e.g. USDT." }, "feeCurrency": { "type": "string", @@ -6906,7 +7039,7 @@ }, "baseMinSize": { "type": "string", - "description": "The minimum order quantity requried to place an order." + "description": "The minimum order quantity required to place an order." }, "quoteMinSize": { "type": "string", @@ -6934,11 +7067,11 @@ }, "priceLimitRate": { "type": "string", - "description": "Threshold for price portection" + "description": "Threshold for price protection" }, "minFunds": { "type": "string", - "description": "the minimum trading amounts" + "description": "The minimum trading amounts" }, "isMarginEnabled": { "type": "boolean", @@ -6983,7 +7116,58 @@ "description": "The taker fee coefficient. The actual fee needs to be multiplied by this coefficient to get the final fee. Most currencies have a coefficient of 1. If set to 0, it means no fee" }, "st": { - "type": "boolean" + "type": "boolean", + "description": "Whether it is a [Special Treatment](https://www.kucoin.com/legal/special-treatment) symbol" + }, + "callauctionIsEnabled": { + "type": "boolean", + "description": "The [call auction](https://www.kucoin.com/support/40999744334105) status returns true/false" + }, + "callauctionPriceFloor": { + "type": "string", + "description": "The lowest price declared in the call auction", + "examples": [ + "0.00001" + ] + }, + "callauctionPriceCeiling": { + "type": "string", + "description": "The highest bid price in the call auction\n", + "examples": [ + "0.6" + ] + }, + "callauctionFirstStageStartTime": { + "type": "integer", + "description": "The first phase of the call auction starts at (Allow add orders, allow cancel orders)", + "format": "int64", + "examples": [ + 1740470400000 + ] + }, + "callauctionSecondStageStartTime": { + "type": "integer", + "description": "The second phase of the call auction starts at (Allow add orders, don't allow cancel orders)", + "format": "int64", + "examples": [ + 1740473400000 + ] + }, + "callauctionThirdStageStartTime": { + "type": "integer", + "description": "The third phase of the call auction starts at (Don't allow add orders, don't allow cancel orders)", + "format": "int64", + "examples": [ + 1740473700000 + ] + }, + "tradingStartTime": { + "type": "integer", + "description": "Official opening time (end time of the third phase of call auction)", + "format": "int64", + "examples": [ + 1740474000000 + ] } }, "required": [ @@ -7007,7 +7191,14 @@ "feeCategory", "makerFeeCoefficient", "takerFeeCoefficient", - "st" + "st", + "callauctionIsEnabled", + "callauctionPriceFloor", + "callauctionPriceCeiling", + "callauctionFirstStageStartTime", + "callauctionSecondStageStartTime", + "callauctionThirdStageStartTime", + "tradingStartTime" ] } }, @@ -7024,7 +7215,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\"code\":\"200000\",\"data\":{\"symbol\":\"BTC-USDT\",\"name\":\"BTC-USDT\",\"baseCurrency\":\"BTC\",\"quoteCurrency\":\"USDT\",\"feeCurrency\":\"USDT\",\"market\":\"USDS\",\"baseMinSize\":\"0.00001\",\"quoteMinSize\":\"0.1\",\"baseMaxSize\":\"10000000000\",\"quoteMaxSize\":\"99999999\",\"baseIncrement\":\"0.00000001\",\"quoteIncrement\":\"0.000001\",\"priceIncrement\":\"0.1\",\"priceLimitRate\":\"0.1\",\"minFunds\":\"0.1\",\"isMarginEnabled\":true,\"enableTrading\":true,\"feeCategory\":1,\"makerFeeCoefficient\":\"1.00\",\"takerFeeCoefficient\":\"1.00\",\"st\":false}}", + "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"BTC-USDT\",\n \"name\": \"BTC-USDT\",\n \"baseCurrency\": \"BTC\",\n \"quoteCurrency\": \"USDT\",\n \"feeCurrency\": \"USDT\",\n \"market\": \"USDS\",\n \"baseMinSize\": \"0.00001\",\n \"quoteMinSize\": \"0.1\",\n \"baseMaxSize\": \"10000000000\",\n \"quoteMaxSize\": \"99999999\",\n \"baseIncrement\": \"0.00000001\",\n \"quoteIncrement\": \"0.000001\",\n \"priceIncrement\": \"0.1\",\n \"priceLimitRate\": \"0.1\",\n \"minFunds\": \"0.1\",\n \"isMarginEnabled\": true,\n \"enableTrading\": true,\n \"feeCategory\": 1,\n \"makerFeeCoefficient\": \"1.00\",\n \"takerFeeCoefficient\": \"1.00\",\n \"st\": false,\n \"callauctionIsEnabled\": false,\n \"callauctionPriceFloor\": null,\n \"callauctionPriceCeiling\": null,\n \"callauctionFirstStageStartTime\": null,\n \"callauctionSecondStageStartTime\": null,\n \"callauctionThirdStageStartTime\": null,\n \"tradingStartTime\": null\n }\n}", "responseId": 10323, "ordering": 1 } @@ -7038,8 +7229,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get detail currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers.\n:::\n\n\n- The baseMinSize and baseMaxSize fields define the min and max order size.\n- The priceIncrement field specifies the min order price as well as the price increment.This also applies to quote currency.\n\nThe order price must be a positive integer multiple of this priceIncrement (i.e. if the increment is 0.01, the 0.001 and 0.021 order prices would be rejected).\n\npriceIncrement and quoteIncrement may be adjusted in the future. We will notify you by email and site notifications before adjustment.\n\n| Order Type | Follow the rules of minFunds |\n| ------ | ---------- |\n| Limit Buy\t | [Order Amount * Order Price] >= minFunds |\n| Limit Sell | [Order Amount * Order Price] >= minFunds |\n| Market Buy | Order Value >= minFunds |\n| Market Sell | [Order Amount * Last Price of Base Currency] >= minFunds |\n\nNote:\n- API market buy orders (by amount) valued at (Order Amount * Last Price of Base Currency) < minFunds will be rejected.\n- API market sell orders (by value) valued at < minFunds will be rejected.\n- Take profit and stop loss orders at market or limit prices will be rejected when triggered.", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getSymbol\",\"sdk-method-description\":\"Request via this endpoint to get detail currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers.\",\"api-rate-limit\":4}" + "description": ":::info[Description]\nRequest detailed currency pairs for trading via this endpoint. If you want to get the market information of the trading symbol, please use Get All Tickers.\n:::\n\n\n- The baseMinSize and baseMaxSize fields define the min. and max. order size.\n- The priceIncrement field specifies the min. order price as well as the price increment. This also applies to quote currency.\n\nThe order price must be a positive integer multiple of this priceIncrement (i.e., if the increment is 0.01, the 0.001 and 0.021 order prices will be rejected).\n\npriceIncrement and quoteIncrement may be adjusted in the future. We will notify you by email and site notifications before adjustments.\n\n| Order Type | Follow the rules of minFunds |\n| ------ | ---------- |\n| Limit Buy | [Order Amount * Order Price] >= minFunds |\n| Limit Sell | [Order Amount * Order Price] >= minFunds |\n| Market Buy | Order Value >= minFunds |\n| Market Sell | [Order Amount * Last Price of Base Currency] >= minFunds |\n\nNote:\n- API market buy orders (by amount) valued at (Order Amount * Last Price of Base Currency) < minFunds will be rejected.\n- API market sell orders (by value) valued at < minFunds will be rejected.\n- Take profit and stop loss orders at market or limit prices will be rejected when triggered.", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getSymbol\",\"sdk-method-description\":\"Request detailed currency pairs for trading via this endpoint. If you want to get the market information of the trading symbol, please use Get All Tickers.\",\"api-rate-limit-weight\":4}" } }, { @@ -7049,7 +7240,6 @@ "method": "get", "path": "/api/v2/symbols", "parameters": { - "path": [], "query": [ { "id": "4oM4tRz9wb", @@ -7065,9 +7255,11 @@ "USDS", "ETF" ] - } + }, + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -7090,7 +7282,7 @@ "properties": { "symbol": { "type": "string", - "description": "unique code of a symbol, it would not change after renaming", + "description": "Unique code of a symbol; it will not change after renaming", "examples": [ "BTC-USDT", "BCHSV-USDT" @@ -7098,7 +7290,7 @@ }, "name": { "type": "string", - "description": "Name of trading pairs, it would change after renaming", + "description": "Name of trading pairs, it will change after renaming", "examples": [ "BTC-USDT", "BSV-USDT" @@ -7106,11 +7298,11 @@ }, "baseCurrency": { "type": "string", - "description": "Base currency,e.g. BTC." + "description": "Base currency, e.g. BTC." }, "quoteCurrency": { "type": "string", - "description": "Quote currency,e.g. USDT." + "description": "Quote currency, e.g. USDT." }, "feeCurrency": { "type": "string", @@ -7127,7 +7319,7 @@ }, "baseMinSize": { "type": "string", - "description": "The minimum order quantity requried to place an order." + "description": "The minimum order quantity required to place an order." }, "quoteMinSize": { "type": "string", @@ -7151,15 +7343,15 @@ }, "priceIncrement": { "type": "string", - "description": "Price increment: The price of an order must be a positive integer multiple of this increment. For example, for the ETH-USDT trading pair, if the priceIncrement is 0.01, the order price can be 3000.01 but not 3000.001.\n\nspecifies the min order price as well as the price increment.This also applies to quote currency." + "description": "Price increment: The price of an order must be a positive integer multiple of this increment. For example, for the ETH-USDT trading pair, if the priceIncrement is 0.01, the order price can be 3000.01 but not 3000.001.\n\nSpecifies the min. order price as well as the price increment.This also applies to quote currency." }, "priceLimitRate": { "type": "string", - "description": "Threshold for price portection" + "description": "Threshold for price protection" }, "minFunds": { "type": "string", - "description": "the minimum trading amounts" + "description": "The minimum trading amounts" }, "isMarginEnabled": { "type": "boolean", @@ -7205,7 +7397,57 @@ }, "st": { "type": "boolean", - "description": "Whether it is an [Special Treatment](https://www.kucoin.com/legal/special-treatment) symbol" + "description": "Whether it is a [Special Treatment](https://www.kucoin.com/legal/special-treatment) symbol" + }, + "callauctionIsEnabled": { + "type": "boolean", + "description": "The [call auction](https://www.kucoin.com/support/40999744334105) status returns true/false" + }, + "callauctionPriceFloor": { + "type": "string", + "description": "The lowest price declared in the call auction", + "examples": [ + "0.00001" + ] + }, + "callauctionPriceCeiling": { + "type": "string", + "description": "The highest bid price in the call auction\n", + "examples": [ + "0.6" + ] + }, + "callauctionFirstStageStartTime": { + "type": "integer", + "description": "The first phase of the call auction starts at (Allow add orders, allow cancel orders)", + "format": "int64", + "examples": [ + 1740470400000 + ] + }, + "callauctionSecondStageStartTime": { + "type": "integer", + "description": "The second phase of the call auction starts at (Allow add orders, don't allow cancel orders)", + "format": "int64", + "examples": [ + 1740473400000 + ] + }, + "callauctionThirdStageStartTime": { + "type": "integer", + "description": "The third phase of the call auction starts at (Don't allow add orders, don't allow cancel orders)", + "format": "int64", + "examples": [ + 1740473700000 + ] + }, + "tradingStartTime": { + "type": "integer", + "description": "Official opening time (end time of the third phase of call auction)", + "format": "int64", + "examples": [ + 1740474000000 + ] } }, "required": [ @@ -7229,7 +7471,14 @@ "feeCategory", "makerFeeCoefficient", "takerFeeCoefficient", - "st" + "st", + "callauctionIsEnabled", + "callauctionPriceFloor", + "callauctionPriceCeiling", + "callauctionFirstStageStartTime", + "callauctionSecondStageStartTime", + "callauctionThirdStageStartTime", + "tradingStartTime" ] } } @@ -7247,7 +7496,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"BTC-USDT\",\n \"name\": \"BTC-USDT\",\n \"baseCurrency\": \"BTC\",\n \"quoteCurrency\": \"USDT\",\n \"feeCurrency\": \"USDT\",\n \"market\": \"USDS\",\n \"baseMinSize\": \"0.00001\",\n \"quoteMinSize\": \"0.1\",\n \"baseMaxSize\": \"10000000000\",\n \"quoteMaxSize\": \"99999999\",\n \"baseIncrement\": \"0.00000001\",\n \"quoteIncrement\": \"0.000001\",\n \"priceIncrement\": \"0.1\",\n \"priceLimitRate\": \"0.1\",\n \"minFunds\": \"0.1\",\n \"isMarginEnabled\": true,\n \"enableTrading\": true,\n \"feeCategory\": 1,\n \"makerFeeCoefficient\": \"1.00\",\n \"takerFeeCoefficient\": \"1.00\",\n \"st\": false\n }\n ]\n}", + "data": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"BTC-USDT\",\n \"name\": \"BTC-USDT\",\n \"baseCurrency\": \"BTC\",\n \"quoteCurrency\": \"USDT\",\n \"feeCurrency\": \"USDT\",\n \"market\": \"USDS\",\n \"baseMinSize\": \"0.00001\",\n \"quoteMinSize\": \"0.1\",\n \"baseMaxSize\": \"10000000000\",\n \"quoteMaxSize\": \"99999999\",\n \"baseIncrement\": \"0.00000001\",\n \"quoteIncrement\": \"0.000001\",\n \"priceIncrement\": \"0.1\",\n \"priceLimitRate\": \"0.1\",\n \"minFunds\": \"0.1\",\n \"isMarginEnabled\": true,\n \"enableTrading\": true,\n \"feeCategory\": 1,\n \"makerFeeCoefficient\": \"1.00\",\n \"takerFeeCoefficient\": \"1.00\",\n \"st\": false,\n \"callauctionIsEnabled\": false,\n \"callauctionPriceFloor\": null,\n \"callauctionPriceCeiling\": null,\n \"callauctionFirstStageStartTime\": null,\n \"callauctionSecondStageStartTime\": null,\n \"callauctionThirdStageStartTime\": null,\n \"tradingStartTime\": null\n }\n ]\n}", "responseId": 10318, "ordering": 1 } @@ -7261,8 +7510,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get a list of available currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers.\n:::\n\n\n:::tip[Tips]\npriceIncrement and quoteIncrement may be adjusted in the future. We will notify you by email and site notifications before adjustment.\n:::\n\n| Order Type | Follow the rules of minFunds |\n| --- | --- |\n| Limit Buy | [Order Amount * Order Price] >= minFunds |\n| Limit Sell | [Order Amount * Order Price] >= minFunds |\n| Market Buy | Order Value >= minFunds |\n| Market Sell | [Order Amount * Last Price of Base Currency] >= minFunds |\n\nNote:\n\n- API market buy orders (by amount) valued at [Order Amount * Last Price of Base Currency] < minFunds will be rejected.\n- API market sell orders (by value) valued at < minFunds will be rejected.\n- Take profit and stop loss orders at market or limit prices will be rejected when triggered.\n\n\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getAllSymbols\",\"sdk-method-description\":\"Request via this endpoint to get a list of available currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers.\",\"api-rate-limit\":4}" + "description": ":::info[Description]\nRequest a list of available currency pairs for trading via this endpoint. If you want to get the market information of the trading symbol, please use Get All Tickers.\n:::\n\n\n:::tip[Tips]\npriceIncrement and quoteIncrement may be adjusted in the future. We will notify you by email and site notifications before adjustments.\n:::\n\n| Order Type | Follow the rules of minFunds |\n| --- | --- |\n| Limit Buy | [Order Amount * Order Price] >= minFunds |\n| Limit Sell | [Order Amount * Order Price] >= minFunds |\n| Market Buy | Order Value >= minFunds |\n| Market Sell | [Order Amount * Last Price of Base Currency] >= minFunds |\n\nNote:\n\n- API market buy orders (by amount) valued at [Order Amount * Last Price of Base Currency] < minFunds will be rejected.\n- API market sell orders (by value) valued at < minFunds will be rejected.\n- Take profit and stop loss orders at market or limit prices will be rejected when triggered.\n\n\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getAllSymbols\",\"sdk-method-description\":\"Request a list of available currency pairs for trading via this endpoint. If you want to get the market information of the trading symbol, please use Get All Tickers.\",\"api-rate-limit-weight\":4}" } }, { @@ -7272,7 +7521,6 @@ "method": "get", "path": "/api/v1/market/orderbook/level1", "parameters": { - "path": [], "query": [ { "id": "AwnkwQxRMq", @@ -7280,9 +7528,11 @@ "required": true, "description": "symbol", "example": "BTC-USDT", - "type": "string" + "type": "string", + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -7374,8 +7624,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get Level 1 Market Data. The returned value includes the best bid price and size, the best ask price and size as well as the last traded price and the last traded size.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getTicker\",\"sdk-method-description\":\"Request via this endpoint to get Level 1 Market Data. The returned value includes the best bid price and size, the best ask price and size as well as the last traded price and the last traded size.\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nRequest Level 1 Market Data via this endpoint. The returned value includes the best bid price and size, the best ask price and size, as well as the last traded price and the last traded size.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getTicker\",\"sdk-method-description\":\"Request Level 1 Market Data via this endpoint. The returned value includes the best bid price and size, the best ask price and size, as well as the last traded price and the last traded size.\",\"api-rate-limit-weight\":2}" } }, { @@ -7385,8 +7635,8 @@ "method": "get", "path": "/api/v1/market/allTickers", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -7421,7 +7671,7 @@ }, "symbolName": { "type": "string", - "description": "Name of trading pairs, it would change after renaming" + "description": "Name of trading pairs, it will change after renaming" }, "buy": { "type": "string", @@ -7490,12 +7740,12 @@ { "value": "1", "name": "1", - "description": "the taker fee coefficient is 1" + "description": "The taker fee coefficient is 1" }, { "value": "0", - "name": "0", - "description": "no fee" + "name": "", + "description": "No fee" } ] }, @@ -7510,12 +7760,12 @@ { "value": "1", "name": "1", - "description": "the maker fee coefficient is 1" + "description": "The maker fee coefficient is 1" }, { "value": "0", - "name": "0", - "description": "no fee" + "name": "", + "description": "No fee" } ] } @@ -7576,8 +7826,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest market tickers for all the trading pairs in the market (including 24h volume), takes a snapshot every 2 seconds.\n\nOn the rare occasion that we will change the currency name, if you still want the changed symbol name, you can use the symbolName field instead of the symbol field via “Get Symbols List” endpoint.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getAllTickers\",\"sdk-method-description\":\"Request market tickers for all the trading pairs in the market (including 24h volume), takes a snapshot every 2 seconds. On the rare occasion that we will change the currency name, if you still want the changed symbol name, you can use the symbolName field instead of the symbol field via “Get all tickers” endpoint.\",\"api-rate-limit\":15}" + "description": ":::info[Description]\nRequest market tickers for all the trading pairs in the market (including 24h volume); takes a snapshot every 2 seconds.\n\nOn the rare occasion that we change the currency name, if you still want the changed symbol name, you can use the symbolName field instead of the symbol field via “Get Symbols List” endpoint.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getAllTickers\",\"sdk-method-description\":\"Request market tickers for all the trading pairs in the market (including 24h volume); takes a snapshot every 2 seconds. On the rare occasion that we change the currency name, if you still want the changed symbol name, you can use the symbolName field instead of the symbol field via “Get all tickers” endpoint.\",\"api-rate-limit-weight\":15}" } }, { @@ -7633,7 +7883,7 @@ }, "side": { "type": "string", - "description": "Filled side, The trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book.", + "description": "Filled side; the trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book.", "enum": [ "buy", "sell" @@ -7654,7 +7904,7 @@ "time": { "type": "integer", "format": "int64", - "description": "Filled timestamp(nanosecond)" + "description": "Filled timestamp (nanosecond)" } }, "required": [ @@ -7694,8 +7944,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getTradeHistory\",\"sdk-method-description\":\"Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nRequest the trade history of the specified symbol via this endpoint. The returned quantity is the last 100 transaction records.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getTradeHistory\",\"sdk-method-description\":\"Request the trade history of the specified symbol via this endpoint. The returned quantity is the last 100 transaction records.\",\"api-rate-limit-weight\":3}" } }, { @@ -7719,7 +7969,7 @@ "id": "FcaM2YvA6p", "name": "type", "required": true, - "description": "Type of candlestick patterns: 1min, 3min, 5min, 15min, 30min, 1hour, 2hour, 4hour, 6hour, 8hour, 12hour, 1day, 1week, 1month", + "description": "Types of candlestick pattern: 1min, 3min, 5min, 15min, 30min, 1hour, 2hour, 4hour, 6hour, 8hour, 12hour, 1day, 1week, 1month", "example": "1min", "type": "string", "schema": { @@ -7819,7 +8069,7 @@ "id": "LNMS5qTAS3", "name": "startAt", "required": false, - "description": "Start time (second), default is 0", + "description": "Start time (seconds), default is 0", "example": "1566703297", "type": "integer", "schema": { @@ -7833,7 +8083,7 @@ "id": "gziaY6i2V1", "name": "endAt", "required": false, - "description": "End time (second), default is 0", + "description": "End time (seconds), default is 0", "example": "1566789757", "type": "integer", "schema": { @@ -7866,7 +8116,7 @@ "type": "array", "items": { "type": "string", - "description": "Start time of the candle cycle, opening price, closing price, highest price, Lowest price, Transaction amount, Transaction volume" + "description": "Start time of the candle cycle, opening price, closing price, highest price, lowest price, transaction amount, transaction volume" } } } @@ -7898,8 +8148,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nGet the Kline of the symbol. Data are returned in grouped buckets based on requested type.\nFor each query, the system would return at most 1500 pieces of data. To obtain more data, please page the data by time.\n:::\n\n:::tip[Tips]\nKlines data may be incomplete. No data is published for intervals where there are no ticks.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getKlines\",\"sdk-method-description\":\"Get the Kline of the symbol. Data are returned in grouped buckets based on requested type. For each query, the system would return at most 1500 pieces of data. To obtain more data, please page the data by time.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nGet the symbol’s candlestick chart. Data are returned in grouped buckets based on requested type.\nFor each query, the system will return at most 1500 pieces of data. To obtain more data, please page the data by time.\n:::\n\n:::tip[Tips]\nCandlestick chart data may be incomplete. No data is published for intervals where there are no ticks.\n:::\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getKlines\",\"sdk-method-description\":\"Get the symbol’s candlestick chart. Data are returned in grouped buckets based on requested type. For each query, the system will return at most 1500 pieces of data. To obtain more data, please page the data by time.\",\"api-rate-limit-weight\":3}" } }, { @@ -7971,7 +8221,7 @@ "properties": { "time": { "type": "integer", - "description": "Timestamp(millisecond)", + "description": "Timestamp (milliseconds)", "format": "int64" }, "sequence": { @@ -8036,8 +8286,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nQuery for part orderbook depth data. (aggregated by price)\n\nYou are recommended to request via this endpoint as the system reponse would be faster and cosume less traffic.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getPartOrderBook\",\"sdk-method-description\":\"Query for part orderbook depth data. (aggregated by price) You are recommended to request via this endpoint as the system reponse would be faster and cosume less traffic.\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nQuery for part orderbook depth data (aggregated by price).\n\nIt is recommended that you submit requests via this endpoint as the system response will be faster and consume less traffic.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getPartOrderBook\",\"sdk-method-description\":\"Query for part orderbook depth data. (aggregated by price). It is recommended that you request via this endpoint, as the system response will be faster and consume less traffic.\",\"api-rate-limit-weight\":2}" } }, { @@ -8079,7 +8329,7 @@ "properties": { "time": { "type": "integer", - "description": "Timestamp(millisecond)", + "description": "Timestamp (milliseconds)", "format": "int64" }, "sequence": { @@ -8144,8 +8394,263 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nQuery for Full orderbook depth data. (aggregated by price)\n\nIt is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control.\n\nTo maintain up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getFullOrderBook\",\"sdk-method-description\":\"Query for Full orderbook depth data. (aggregated by price) It is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control. To maintain up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nQuery for Full orderbook depth data (aggregated by price)\n\nIt is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit controls.\n\nTo maintain an up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getFullOrderBook\",\"sdk-method-description\":\"Query for Full orderbook depth data (aggregated by price). It is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control. To maintain an up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.\",\"api-rate-limit-weight\":3}" + } + }, + { + "name": "Get Call Auction Part OrderBook", + "api": { + "id": "3471564", + "method": "get", + "path": "/api/v1/market/orderbook/callauction/level2_{size}", + "parameters": { + "query": [ + { + "id": "AwnkwQxRMq", + "name": "symbol", + "required": true, + "description": "symbol", + "example": "BTC-USDT", + "type": "string", + "enable": true + } + ], + "path": [ + { + "id": "size#0", + "name": "size", + "required": true, + "description": "Get the depth layer, optional value: 20, 100", + "example": "20", + "type": "integer", + "schema": { + "type": "integer", + "enum": [ + 20, + 100 + ], + "format": "int32", + "x-api-enum": [ + { + "value": 20, + "name": "size", + "description": "size" + }, + { + "value": 100, + "name": "size", + "description": "size" + } + ] + }, + "enable": true + } + ], + "cookie": [], + "header": [] + }, + "responses": [ + { + "id": "11851", + "code": 200, + "name": "OK", + "headers": [], + "jsonSchema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "time": { + "type": "integer", + "description": "Timestamp (milliseconds)", + "format": "int64" + }, + "sequence": { + "type": "string", + "description": "Sequence number" + }, + "bids": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "description": "Price, Size" + } + }, + "description": "bids, from high to low" + }, + "asks": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "description": "Price, Size" + } + }, + "description": "asks, from low to high" + } + }, + "required": [ + "sequence", + "bids", + "asks", + "time" + ] + } + }, + "required": [ + "code", + "data" + ] + }, + "description": "", + "contentType": "json", + "mediaType": "" + } + ], + "responseExamples": [ + { + "name": "Success", + "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"time\": 1729176273859,\n \"sequence\": \"14610502970\",\n \"bids\": [\n [\n \"66976.4\",\n \"0.69109872\"\n ],\n [\n \"66976.3\",\n \"0.14377\"\n ]\n ],\n \"asks\": [\n [\n \"66976.5\",\n \"0.05408199\"\n ],\n [\n \"66976.8\",\n \"0.0005\"\n ]\n ]\n }\n}", + "responseId": 11851, + "ordering": 1 + } + ], + "requestBody": { + "type": "none", + "parameters": [], + "jsonSchema": { + "type": "object", + "properties": {} + }, + "mediaType": "" + }, + "description": ":::info[Description]\nQuery for [call auction](https://www.kucoin.com/support/40999744334105) part orderbook depth data (aggregated by price).\n\nIt is recommended that you submit requests via this endpoint as the system response will be faster and consume less traffic.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getCallAuctionPartOrderBook\",\"sdk-method-description\":\"Query for call auction part orderbook depth data. (aggregated by price). It is recommended that you request via this endpoint, as the system response will be faster and consume less traffic.\",\"api-rate-limit-weight\":2}" + } + }, + { + "name": "Get Call Auction Info", + "api": { + "id": "3471565", + "method": "get", + "path": "/api/v1/market/callauctionData", + "parameters": { + "query": [ + { + "id": "AwnkwQxRMq", + "name": "symbol", + "required": true, + "description": "symbol", + "example": "BTC-USDT", + "type": "string", + "enable": true + } + ], + "path": [], + "cookie": [], + "header": [] + }, + "responses": [ + { + "id": "11901", + "code": 200, + "name": "OK", + "headers": [], + "jsonSchema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "symbol": { + "type": "string", + "description": "Symbol", + "examples": [ + "BTC-USDT" + ] + }, + "estimatedPrice": { + "type": "string", + "description": "Estimated price" + }, + "estimatedSize": { + "type": "string", + "description": "Estimated size" + }, + "sellOrderRangeLowPrice": { + "type": "string", + "description": "Sell ​​order minimum price" + }, + "sellOrderRangeHighPrice": { + "type": "string", + "description": "Sell ​​order maximum price" + }, + "buyOrderRangeLowPrice": { + "type": "string", + "description": "Bell ​​order minimum price" + }, + "buyOrderRangeHighPrice": { + "type": "string", + "description": "Buy ​​order maximum price" + }, + "time": { + "type": "integer", + "format": "int64", + "description": "Timestamp (ms)" + } + }, + "required": [ + "symbol", + "estimatedPrice", + "estimatedSize", + "sellOrderRangeLowPrice", + "sellOrderRangeHighPrice", + "buyOrderRangeLowPrice", + "buyOrderRangeHighPrice", + "time" + ] + } + }, + "required": [ + "code", + "data" + ] + }, + "description": "", + "contentType": "json", + "mediaType": "" + } + ], + "responseExamples": [ + { + "name": "Success", + "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"BTC-USDT\",\n \"estimatedPrice\": \"0.17\",\n \"estimatedSize\": \"0.03715004\",\n \"sellOrderRangeLowPrice\": \"1.788\",\n \"sellOrderRangeHighPrice\": \"2.788\",\n \"buyOrderRangeLowPrice\": \"1.788\",\n \"buyOrderRangeHighPrice\": \"2.788\",\n \"time\": 1550653727731\n }\n}", + "responseId": 11901, + "ordering": 1 + } + ], + "requestBody": { + "type": "none", + "parameters": [], + "jsonSchema": { + "type": "object", + "properties": {} + }, + "mediaType": "" + }, + "description": ":::info[Description]\nGet [call auction](https://www.kucoin.com/support/40999744334105) data, This endpoint will return the following information for the specified symbol during the call auction phase: estimated transaction price, estimated transaction quantity, bid price range, and ask price range.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getCallAuctionInfo\",\"sdk-method-description\":\"Get call auction data, This interface will return the following information for the specified symbol during the call auction phase: estimated transaction price, estimated transaction quantity, bid price range, and ask price range.\",\"api-rate-limit-weight\":2}" } }, { @@ -8155,13 +8660,12 @@ "method": "get", "path": "/api/v1/prices", "parameters": { - "path": [], "query": [ { "id": "awyky894vh", "name": "base", "required": false, - "description": "Ticker symbol of a base currency,eg.USD,EUR. Default is USD", + "description": "Ticker symbol of a base currency, e.g. USD, EUR. Default is USD", "example": "", "type": "string", "schema": { @@ -8171,7 +8675,8 @@ "USD", "EUR" ] - } + }, + "enable": true }, { "id": "Ak1pifFhEW", @@ -8179,9 +8684,11 @@ "required": false, "description": "Comma-separated cryptocurrencies to be converted into fiat, e.g.: BTC,ETH, etc. Default to return the fiat price of all currencies.", "example": "", - "type": "string" + "type": "string", + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -11816,18 +12323,17 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the fiat price of the currencies for the available trading pairs.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getFiatPrice\",\"sdk-method-description\":\"Request via this endpoint to get the fiat price of the currencies for the available trading pairs.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nRequest the fiat price of the currencies for the available trading pairs via this endpoint.\n:::\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getFiatPrice\",\"sdk-method-description\":\"Request the fiat price of the currencies for the available trading pairs via this endpoint.\",\"api-rate-limit-weight\":3}" } }, { - "name": "Get 24hr Stats", + "name": "Get 24hr stats", "api": { "id": "3470161", "method": "get", "path": "/api/v1/market/stats", "parameters": { - "path": [], "query": [ { "id": "AwnkwQxRMq", @@ -11835,9 +12341,11 @@ "required": true, "description": "symbol", "example": "BTC-USDT", - "type": "string" + "type": "string", + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -11969,8 +12477,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the statistics of the specified ticker in the last 24 hours.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"get24hrStats\",\"sdk-method-description\":\"Request via this endpoint to get the statistics of the specified ticker in the last 24 hours.\",\"api-rate-limit\":15}" + "description": ":::info[Description]\nRequest the statistics of the specified ticker in the last 24 hours via this endpoint.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"get24hrStats\",\"sdk-method-description\":\"Request the statistics of the specified ticker in the last 24 hours via this endpoint.\",\"api-rate-limit-weight\":15}" } }, { @@ -11980,8 +12488,8 @@ "method": "get", "path": "/api/v1/markets", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -12031,8 +12539,67 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the transaction currency for the entire trading market.\n:::\n\n:::tip[Tips]\nSC has been changed to USDS, but you can still use SC as a query parameter\n\nThe three markets of ETH, NEO and TRX are merged into the ALTS market. You can query the trading pairs of the ETH, NEO and TRX markets through the ALTS trading area.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getMarketList\",\"sdk-method-description\":\"Request via this endpoint to get the transaction currency for the entire trading market.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nRequest via this endpoint the transaction currency for the entire trading market.\n:::\n\n:::tip[Tips]\nSC has been changed to USDS, but you can still use SC as a query parameter\n\nThe three markets of ETH, NEO and TRX are merged into the ALTS market. You can query the trading pairs of the ETH, NEO and TRX markets through the ALTS trading area.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getMarketList\",\"sdk-method-description\":\"Request via this endpoint the transaction currency for the entire trading market.\",\"api-rate-limit-weight\":3}" + } + }, + { + "name": "Get Client IP Address", + "api": { + "id": "3471123", + "method": "get", + "path": "/api/v1/my-ip", + "parameters": { + "query": [], + "path": [], + "cookie": [], + "header": [] + }, + "responses": [ + { + "id": "11751", + "code": 200, + "name": "OK", + "headers": [], + "jsonSchema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "data": { + "type": "string" + } + }, + "required": [ + "code", + "data" + ] + }, + "description": "", + "contentType": "json", + "mediaType": "" + } + ], + "responseExamples": [ + { + "name": "Success", + "data": "{\"code\":\"200000\",\"data\":\"20.***.***.128\"}", + "responseId": 11751, + "ordering": 1 + } + ], + "requestBody": { + "type": "none", + "parameters": [], + "jsonSchema": { + "type": "object", + "properties": {} + }, + "mediaType": "" + }, + "description": ":::info[Description]\nGet the client side ip address.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getClientIPAddress\",\"sdk-method-description\":\"Get the server time.\",\"api-rate-limit-weight\":0}" } }, { @@ -12042,8 +12609,8 @@ "method": "get", "path": "/api/v1/timestamp", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -12062,7 +12629,7 @@ "data": { "type": "integer", "format": "int64", - "description": "ServerTime(millisecond)" + "description": "ServerTime (milliseconds)" } }, "required": [ @@ -12093,7 +12660,7 @@ "mediaType": "" }, "description": ":::info[Description]\nGet the server time.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getServerTime\",\"sdk-method-description\":\"Get the server time.\",\"api-rate-limit\":3}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getServerTime\",\"sdk-method-description\":\"Get the server time.\",\"api-rate-limit-weight\":3}" } }, { @@ -12103,8 +12670,8 @@ "method": "get", "path": "/api/v1/status", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -12125,7 +12692,7 @@ "properties": { "status": { "type": "string", - "description": "Status of service: open：normal transaction, close：Stop Trading/Maintenance, cancelonly：can only cancel the order but not place order", + "description": "Status of service: open: normal transaction; close: Stop Trading/Maintenance; cancelonly: can only cancel the order but not place order", "enum": [ "open", "close", @@ -12187,8 +12754,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nGet the service status\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getServiceStatus\",\"sdk-method-description\":\"Get the service status\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nGet the service status.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getServiceStatus\",\"sdk-method-description\":\"Get the service status.\",\"api-rate-limit-weight\":3}" } } ] @@ -12428,12 +12995,35 @@ }, "cancelAfter": { "type": "integer", + "description": "Cancel after n seconds, the order timing strategy is GTT, -1 means it will not be cancelled automatically, the default value is -1\n", "format": "int64", - "description": "Cancel after n seconds，the order timing strategy is GTT" + "default": -1, + "minimum": 0, + "exclusiveMinimum": 0, + "maximum": 2592000, + "exclusiveMaximum": 2592000 }, "funds": { "type": "string", - "description": "When **type** is market, select one out of two: size or funds" + "description": "When **type** is market, select one out of two: size or funds\n\nWhen placing a market order, the funds field refers to the funds for the priced asset (the asset name written latter) of the trading pair. The funds must be based on the quoteIncrement of the trading pair. The quoteIncrement represents the precision of the trading pair. The funds value for an order must be a multiple of quoteIncrement and must be between quoteMinSize and quoteMaxSize." + }, + "allowMaxTimeWindow": { + "type": "integer", + "description": "Order failed after timeout of specified milliseconds, If clientTimestamp + allowMaxTimeWindow < the server reaches time, this order will fail.", + "format": "int64", + "examples": [ + 10, + 20, + 30 + ] + }, + "clientTimestamp": { + "type": "integer", + "description": "Equal to KC-API-TIMESTAMP, Need to be defined if iceberg is specified.", + "format": "int64", + "examples": [ + 1740711735178 + ] } }, "required": [ @@ -12446,7 +13036,7 @@ "mediaType": "" }, "description": ":::info[Description]\nPlace order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type `limit` and `market` |\n| side | String | Yes | `buy` or `sell` |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| tags | String | No | Order tag, length cannot exceed `20` characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed `20` characters (ASCII) |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrder\",\"sdk-method-description\":\"Place order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\",\"api-rate-limit\":1}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrder\",\"sdk-method-description\":\"Place order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\",\"api-rate-limit-weight\":1}" } }, { @@ -12478,11 +13068,11 @@ "properties": { "orderId": { "type": "string", - "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." + "description": "The unique order ID generated by the trading system, which can be used later for further actions such as canceling the order." }, "clientOid": { "type": "string", - "description": "The user self-defined order id." + "description": "The user self-defined order ID." }, "orderTime": { "type": "integer", @@ -12490,15 +13080,15 @@ }, "originSize": { "type": "string", - "description": "original order size" + "description": "Original order size" }, "dealSize": { "type": "string", - "description": "deal size" + "description": "Deal size" }, "remainSize": { "type": "string", - "description": "remain size" + "description": "Remain size" }, "canceledSize": { "type": "string", @@ -12506,7 +13096,7 @@ }, "status": { "type": "string", - "description": "Order Status. open：order is active; done：order has been completed", + "description": "Order Status. open: order is active; done: order has been completed", "enum": [ "open", "done" @@ -12560,6 +13150,280 @@ "ordering": 1 } ], + "requestBody": { + "type": "application/json", + "parameters": [], + "jsonSchema": { + "type": "object", + "properties": { + "clientOid": { + "type": "string", + "description": "Client Order ID: The ClientOid field is a unique ID created by the user (we recommend using a UUID), and can only contain numbers, letters, underscores (_), and hyphens (-). This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.\n\nPlease remember the orderId created by the service provider, it used to check for updates in order status.", + "examples": [ + "5c52e11203aa677f33e493fb" + ] + }, + "side": { + "type": "string", + "description": "Specify if the order is to 'buy' or 'sell'.", + "enum": [ + "buy", + "sell" + ], + "examples": [ + "buy" + ], + "x-api-enum": [ + { + "value": "buy", + "name": "", + "description": "" + }, + { + "value": "sell", + "name": "", + "description": "" + } + ] + }, + "symbol": { + "type": "string", + "description": "symbol", + "examples": [ + "BTC-USDT", + "ETH-USDT", + "KCS-USDT" + ] + }, + "type": { + "type": "string", + "description": "Specify if the order is a 'limit' order or 'market' order. \n\nThe type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.\n\nWhen placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.\n\nUnlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price; you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged.", + "enum": [ + "limit", + "market" + ], + "examples": [ + "limit" + ], + "x-api-enum": [ + { + "value": "limit", + "name": "", + "description": "" + }, + { + "value": "market", + "name": "", + "description": "" + } + ] + }, + "remark": { + "type": "string", + "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" + }, + "stp": { + "type": "string", + "description": "[Self Trade Prevention](apidog://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "enum": [ + "DC", + "CO", + "CN", + "CB" + ], + "x-api-enum": [ + { + "value": "DC", + "name": "", + "description": "" + }, + { + "value": "CO", + "name": "", + "description": "" + }, + { + "value": "CN", + "name": "", + "description": "" + }, + { + "value": "CB", + "name": "", + "description": "" + } + ] + }, + "price": { + "type": "string", + "description": "Specify price for order\n\nWhen placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error." + }, + "size": { + "type": "string", + "description": "Specify quantity for order.\n\nWhen **type** is limited, size refers to the amount of trading targets (the asset name written in front) for the trading pair. The Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.\n\nWhen **type** is market, select one out of two: size or funds" + }, + "timeInForce": { + "type": "string", + "description": "[Time in force](apidog://link/pages/338146) is a special strategy used during trading", + "enum": [ + "GTC", + "GTT", + "IOC", + "FOK" + ], + "default": "GTC", + "x-api-enum": [ + { + "value": "GTC", + "name": "", + "description": "" + }, + { + "value": "GTT", + "name": "", + "description": "" + }, + { + "value": "IOC", + "name": "", + "description": "" + }, + { + "value": "FOK", + "name": "", + "description": "" + } + ] + }, + "postOnly": { + "type": "boolean", + "default": false, + "description": "passive order labels, this is disabled when the order timing strategy is IOC or FOK" + }, + "hidden": { + "type": "boolean", + "description": "[Hidden order](apidog://link/pages/338146) or not (not shown in order book)", + "default": false + }, + "iceberg": { + "type": "boolean", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](apidog://link/pages/338146)", + "default": false + }, + "visibleSize": { + "type": "string", + "description": "Maximum visible quantity in iceberg orders" + }, + "tags": { + "type": "string", + "description": "Order tag, length cannot exceed 20 characters (ASCII)" + }, + "cancelAfter": { + "type": "integer", + "description": "Cancel after n seconds, the order timing strategy is GTT, -1 means it will not be cancelled automatically, the default value is -1\n", + "format": "int64", + "default": -1, + "minimum": 0, + "exclusiveMinimum": 0, + "maximum": 2592000, + "exclusiveMaximum": 2592000 + }, + "funds": { + "type": "string", + "description": "When **type** is market, select one out of two: size or funds" + }, + "allowMaxTimeWindow": { + "type": "integer", + "description": "Order failed after timeout of specified milliseconds, If clientTimestamp + allowMaxTimeWindow < the server reaches time, this order will fail.", + "format": "int64", + "examples": [ + 10, + 20, + 30 + ] + }, + "clientTimestamp": { + "type": "integer", + "description": "Equal to KC-API-TIMESTAMP, Need to be defined if iceberg is specified.", + "format": "int64", + "examples": [ + 1740711735178 + ] + } + }, + "required": [ + "symbol", + "type", + "side" + ] + }, + "example": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493f\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\",\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\",\n// }\n", + "mediaType": "" + }, + "description": ":::info[Description]\nPlace order in the spot trading system\n\nThe difference between this interface and \"Add order\" is that this interface will synchronously return the order information after the order matching is completed.\n\nFor higher latency requirements, please select the \"Add order\" interface. If there is a requirement for returning data integrity, please select this interface.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order ID, unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type ‘limit’ and ‘market’ |\n| side | String | Yes | ‘buy’ or ‘sell’ |\n| stp | String | No | self trade prevention is divided into four strategies: ‘CN’, ‘CO’, ‘CB’, and ‘DC’ |\n| tags | String | No | Order tag, length cannot exceed ‘20’ characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed ‘20’ characters (ASCII) |\n\n**Additional Request Parameters Required by ‘limit’ Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy ‘GTC’, ‘GTT’, ‘IOC’, ‘FOK’ (the default is ‘GTC’) |\n| cancelAfter | long | No | Cancel after ‘n’ seconds, the order timing strategy is ‘GTT’ |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is ‘IOC’ or ‘FOK’ |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by ‘market’ orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: ‘size’ or ‘funds’) |\n| funds | String | No | (Select one out of two: ‘size’ or ‘funds’) |\n\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or canceled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled (already canceled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID (orderId) and client ID (clientOid) to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value (the threshold value can be obtained using the symbol API endpoint);\n\n- If it is exceeded, for limit orders, the order will be directly canceled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: If the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: This feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrderSync\",\"sdk-method-description\":\"Place order in the spot trading system The difference between this interface and \\\"Add order\\\" is that this interface will synchronously return the order information after the order matching is completed. For higher latency requirements, please select the \\\"Add order\\\" interface. If there is a requirement for returning data integrity, please select this interface.\",\"api-rate-limit-weight\":1}" + } + }, + { + "name": "Add Order Test", + "api": { + "id": "3470187", + "method": "post", + "path": "/api/v1/hf/orders/test", + "parameters": { + "query": [], + "path": [], + "cookie": [], + "header": [] + }, + "responses": [ + { + "id": "10351", + "code": 200, + "name": "OK", + "headers": [], + "jsonSchema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "orderId": { + "type": "string", + "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." + }, + "clientOid": { + "type": "string", + "description": "The user self-defined order id." + } + }, + "required": [ + "orderId", + "clientOid" + ] + } + }, + "required": [ + "code", + "data" + ] + }, + "description": "", + "contentType": "json", + "mediaType": "" + } + ], + "responseExamples": [ + { + "name": "Success", + "data": "{\"code\":\"200000\",\"data\":{\"orderId\":\"670fd33bf9406e0007ab3945\",\"clientOid\":\"5c52e11203aa677f33e493fb\"}}", + "responseId": 10351, + "ordering": 1 + } + ], "requestBody": { "type": "application/json", "parameters": [], @@ -12730,263 +13594,35 @@ }, "cancelAfter": { "type": "integer", + "description": "Cancel after n seconds, the order timing strategy is GTT, -1 means it will not be cancelled automatically, the default value is -1\n", "format": "int64", - "description": "Cancel after n seconds，the order timing strategy is GTT" + "default": -1, + "minimum": 0, + "exclusiveMinimum": 0, + "maximum": 2592000, + "exclusiveMaximum": 2592000 }, "funds": { "type": "string", "description": "When **type** is market, select one out of two: size or funds" - } - }, - "required": [ - "symbol", - "type", - "side" - ] - }, - "example": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493f\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\",\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\",\n// }\n", - "mediaType": "" - }, - "description": ":::info[Description]\nPlace order to the spot trading system\n\nThe difference between this interface and \"Add order\" is that this interface will synchronously return the order information after the order matching is completed.\n\nFor higher latency requirements, please select the \"Add order\" interface. If there is a requirement for returning data integrity, please select this interface\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type `limit` and `market` |\n| side | String | Yes | `buy` or `sell` |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| tags | String | No | Order tag, length cannot exceed `20` characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed `20` characters (ASCII) |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrderSync\",\"sdk-method-description\":\"Place order to the spot trading system The difference between this interface and \\\"Add order\\\" is that this interface will synchronously return the order information after the order matching is completed. For higher latency requirements, please select the \\\"Add order\\\" interface. If there is a requirement for returning data integrity, please select this interface\",\"api-rate-limit\":1}" - } - }, - { - "name": "Add Order Test", - "api": { - "id": "3470187", - "method": "post", - "path": "/api/v1/hf/orders/test", - "parameters": { - "query": [], - "path": [], - "cookie": [], - "header": [] - }, - "responses": [ - { - "id": "10351", - "code": 200, - "name": "OK", - "headers": [], - "jsonSchema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "data": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." - }, - "clientOid": { - "type": "string", - "description": "The user self-defined order id." - } - }, - "required": [ - "orderId", - "clientOid" - ] - } - }, - "required": [ - "code", - "data" - ] - }, - "description": "", - "contentType": "json", - "mediaType": "" - } - ], - "responseExamples": [ - { - "name": "Success", - "data": "{\"code\":\"200000\",\"data\":{\"orderId\":\"670fd33bf9406e0007ab3945\",\"clientOid\":\"5c52e11203aa677f33e493fb\"}}", - "responseId": 10351, - "ordering": 1 - } - ], - "requestBody": { - "type": "application/json", - "parameters": [], - "jsonSchema": { - "type": "object", - "properties": { - "clientOid": { - "type": "string", - "description": "Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.\n\nPlease remember the orderId created by the service provider, it used to check for updates in order status.", - "examples": [ - "5c52e11203aa677f33e493fb" - ] }, - "side": { - "type": "string", - "description": "specify if the order is to 'buy' or 'sell'", - "enum": [ - "buy", - "sell" - ], - "examples": [ - "buy" - ], - "x-api-enum": [ - { - "value": "buy", - "name": "", - "description": "" - }, - { - "value": "sell", - "name": "", - "description": "" - } - ] - }, - "symbol": { - "type": "string", - "description": "symbol", - "examples": [ - "BTC-USDT", - "ETH-USDT", - "KCS-USDT" - ] - }, - "type": { - "type": "string", - "description": "specify if the order is an 'limit' order or 'market' order. \n\nThe type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.\n\nWhen placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.\n\nUnlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged.", - "enum": [ - "limit", - "market" - ], + "allowMaxTimeWindow": { + "type": "integer", + "description": "Order failed after timeout of specified milliseconds, If clientTimestamp + allowMaxTimeWindow < the server reaches time, this order will fail.", + "format": "int64", "examples": [ - "limit" - ], - "x-api-enum": [ - { - "value": "limit", - "name": "", - "description": "" - }, - { - "value": "market", - "name": "", - "description": "" - } - ] - }, - "remark": { - "type": "string", - "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" - }, - "stp": { - "type": "string", - "description": "[Self Trade Prevention](apidog://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", - "enum": [ - "DC", - "CO", - "CN", - "CB" - ], - "x-api-enum": [ - { - "value": "DC", - "name": "", - "description": "" - }, - { - "value": "CO", - "name": "", - "description": "" - }, - { - "value": "CN", - "name": "", - "description": "" - }, - { - "value": "CB", - "name": "", - "description": "" - } - ] - }, - "price": { - "type": "string", - "description": "Specify price for order\n\nWhen placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error." - }, - "size": { - "type": "string", - "description": "Specify quantity for order\n\nWhen **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.\n\nWhen **type** is market, select one out of two: size or funds" - }, - "timeInForce": { - "type": "string", - "description": "[Time in force](apidog://link/pages/338146) is a special strategy used during trading", - "enum": [ - "GTC", - "GTT", - "IOC", - "FOK" - ], - "default": "GTC", - "x-api-enum": [ - { - "value": "GTC", - "name": "", - "description": "" - }, - { - "value": "GTT", - "name": "", - "description": "" - }, - { - "value": "IOC", - "name": "", - "description": "" - }, - { - "value": "FOK", - "name": "", - "description": "" - } + 10, + 20, + 30 ] }, - "postOnly": { - "type": "boolean", - "default": false, - "description": "passive order labels, this is disabled when the order timing strategy is IOC or FOK" - }, - "hidden": { - "type": "boolean", - "description": "[Hidden order](apidog://link/pages/338146) or not (not shown in order book)", - "default": false - }, - "iceberg": { - "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](apidog://link/pages/338146)", - "default": false - }, - "visibleSize": { - "type": "string", - "description": "Maximum visible quantity in iceberg orders" - }, - "tags": { - "type": "string", - "description": "Order tag, length cannot exceed 20 characters (ASCII)" - }, - "cancelAfter": { + "clientTimestamp": { "type": "integer", + "description": "Equal to KC-API-TIMESTAMP, Need to be defined if iceberg is specified.", "format": "int64", - "description": "Cancel after n seconds，the order timing strategy is GTT" - }, - "funds": { - "type": "string", - "description": "When **type** is market, select one out of two: size or funds" + "examples": [ + 1740711735178 + ] } }, "required": [ @@ -12999,7 +13635,7 @@ "mediaType": "" }, "description": ":::info[Description]\nOrder test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type `limit` and `market` |\n| side | String | Yes | `buy` or `sell` |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| tags | String | No | Order tag, length cannot exceed `20` characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed `20` characters (ASCII) |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrderTest\",\"sdk-method-description\":\"Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\",\"api-rate-limit\":1}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrderTest\",\"sdk-method-description\":\"Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\",\"api-rate-limit-weight\":1}" } }, { @@ -13033,11 +13669,11 @@ "properties": { "orderId": { "type": "string", - "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." + "description": "The unique order ID generated by the trading system, which can be used later for further actions such as canceling the order." }, "clientOid": { "type": "string", - "description": "The user self-defined order id." + "description": "The user self-defined order ID." }, "success": { "type": "boolean", @@ -13045,7 +13681,7 @@ }, "failMsg": { "type": "string", - "description": "error message" + "description": "Error message" } }, "required": [ @@ -13085,7 +13721,7 @@ "properties": { "clientOid": { "type": "string", - "description": "Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.\n" + "description": "Client Order ID: The ClientOid field is a unique ID created by the user (we recommend using a UUID), and can only contain numbers, letters, underscores (_), and hyphens (-). This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.\n" }, "symbol": { "type": "string", @@ -13098,7 +13734,7 @@ }, "type": { "type": "string", - "description": "Specify if the order is an 'limit' order or 'market' order. ", + "description": "Specify if the order is a 'limit' order or 'market' order. ", "enum": [ "limit" ], @@ -13145,7 +13781,7 @@ }, "side": { "type": "string", - "description": "Specify if the order is to 'buy' or 'sell'", + "description": "Specify if the order is to 'buy' or 'sell'.", "enum": [ "buy", "sell" @@ -13169,7 +13805,7 @@ }, "size": { "type": "string", - "description": "Specify quantity for order\n\nWhen **type** is limit, select one out of two: size or funds, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.\n\nWhen **type** is market, select one out of two: size or funds" + "description": "Specify quantity for order.\n\nWhen **type** is limited, select one out of two: size or funds. Size refers to the amount of trading targets (the asset name written in front) for the trading pair. The Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.\n\nWhen **type** is market, select one out of two: size or funds" }, "stp": { "type": "string", @@ -13205,8 +13841,13 @@ }, "cancelAfter": { "type": "integer", - "description": "Cancel after n seconds，the order timing strategy is GTT", - "format": "int64" + "description": "Cancel after n seconds, the order timing strategy is GTT, -1 means it will not be cancelled automatically, the default value is -1\n", + "format": "int64", + "default": -1, + "minimum": 0, + "exclusiveMinimum": 0, + "maximum": 2592000, + "exclusiveMaximum": 2592000 }, "postOnly": { "type": "boolean", @@ -13238,6 +13879,24 @@ "funds": { "type": "string", "description": "When **type** is market, select one out of two: size or funds" + }, + "clientTimestamp": { + "type": "integer", + "description": "Equal to KC-API-TIMESTAMP, Need to be defined if iceberg is specified.", + "format": "int64", + "examples": [ + 1740711735178 + ] + }, + "allowMaxTimeWindow": { + "type": "integer", + "description": "Order failed after timeout of specified milliseconds, If clientTimestamp + allowMaxTimeWindow < the server reaches time, this order will fail.", + "format": "int64", + "examples": [ + 10, + 20, + 30 + ] } }, "required": [ @@ -13257,8 +13916,8 @@ "example": "{\n \"orderList\": [\n {\n \"clientOid\": \"client order id 12\",\n \"symbol\": \"BTC-USDT\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"30000\",\n \"size\": \"0.00001\"\n },\n {\n \"clientOid\": \"client order id 13\",\n \"symbol\": \"ETH-USDT\",\n \"type\": \"limit\",\n \"side\": \"sell\",\n \"price\": \"2000\",\n \"size\": \"0.00001\"\n }\n ]\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.\n:::\n\n\n\n:::tip[Tips]\nThis endpoint only supports order placement requests. To obtain the results of the order placement, you will need to check the order status or subscribe to websocket to obtain information about he order.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type `limit` and `market` |\n| side | String | Yes | `buy` or `sell` |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| tags | String | No | Order tag, length cannot exceed `20` characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed `20` characters (ASCII) |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchAddOrders\",\"sdk-method-description\":\"This endpoint supports sequential batch order placement from a single endpoint. A maximum of 5orders can be placed simultaneously. The order types must be limit orders of the same trading pair\",\"api-rate-limit\":1}" + "description": ":::info[Description]\nThis endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.\n:::\n\n\n\n:::tip[Tips]\nThis endpoint only supports order placement requests. To obtain the results of the order placement, you will need to check the order status or subscribe to Websocket to obtain information about the order.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order ID, unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type ‘limit’ and ‘market’ |\n| side | String | Yes | ‘buy’ or ‘sell’ |\n| stp | String | No | self trade prevention is divided into four strategies: ‘CN’, ‘CO’, ‘CB’, and ‘DC’ |\n| tags | String | No | Order tag, length cannot exceed ‘20’ characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed ‘20’ characters (ASCII) |\n\n**Additional Request Parameters Required by ‘limit’ Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy ‘GTC’, ‘GTT’, ‘IOC’, ‘FOK’ (the default is ‘GTC’) |\n| cancelAfter | long | No | Cancel after ‘n’ seconds, the order timing strategy is ‘GTT’ |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is ‘IOC’ or ‘FOK’ |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by ‘market’ orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: ‘size’ or ‘funds’) |\n| funds | String | No | (Select one out of two: ‘size’ or ‘funds’) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or canceled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled (already canceled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID (orderId) and client ID (clientOid) to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value (the threshold value can be obtained using the symbol API endpoint);\n\n- If it is exceeded, for limit orders, the order will be directly canceled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: If the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: This feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchAddOrders\",\"sdk-method-description\":\"This endpoint supports sequential batch order placement from a single endpoint. A maximum of 5 orders can be placed simultaneously. The order types must be limit orders of the same trading pair\",\"api-rate-limit-weight\":1}" } }, { @@ -13292,11 +13951,11 @@ "properties": { "orderId": { "type": "string", - "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." + "description": "The unique order ID generated by the trading system, which can be used later for further actions such as canceling the order." }, "clientOid": { "type": "string", - "description": "The user self-defined order id." + "description": "The user self-defined order ID." }, "orderTime": { "type": "integer", @@ -13304,15 +13963,15 @@ }, "originSize": { "type": "string", - "description": "original order size" + "description": "Original order size" }, "dealSize": { "type": "string", - "description": "deal size" + "description": "Deal size" }, "remainSize": { "type": "string", - "description": "remain size" + "description": "Remain size" }, "canceledSize": { "type": "string", @@ -13320,7 +13979,7 @@ }, "status": { "type": "string", - "description": "Order Status. open：order is active; done：order has been completed", + "description": "Order Status. open: order is active; done: order has been completed", "enum": [ "open", "done" @@ -13348,7 +14007,7 @@ }, "failMsg": { "type": "string", - "description": "error message" + "description": "Error message" } }, "required": [ @@ -13388,7 +14047,7 @@ "properties": { "clientOid": { "type": "string", - "description": "Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.\n" + "description": "Client Order ID: The ClientOid field is a unique ID created by the user (we recommend using a UUID), and can only contain numbers, letters, underscores (_), and hyphens (-). This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.\n" }, "symbol": { "type": "string", @@ -13401,7 +14060,7 @@ }, "type": { "type": "string", - "description": "Specify if the order is an 'limit' order or 'market' order. ", + "description": "Specify if the order is a 'limit' order or 'market' order. ", "enum": [ "limit" ], @@ -13448,7 +14107,7 @@ }, "side": { "type": "string", - "description": "Specify if the order is to 'buy' or 'sell'", + "description": "Specify if the order is to 'buy' or 'sell'.", "enum": [ "buy", "sell" @@ -13472,7 +14131,7 @@ }, "size": { "type": "string", - "description": "Specify quantity for order\n\nWhen **type** is limit, select one out of two: size or funds, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.\n\nWhen **type** is market, select one out of two: size or funds" + "description": "Specify quantity for order.\n\nWhen **type** is limited, select one out of two: size or funds. Size refers to the amount of trading targets (the asset name written in front) for the trading pair. The Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.\n\nWhen **type** is market, select one out of two: size or funds" }, "stp": { "type": "string", @@ -13508,8 +14167,13 @@ }, "cancelAfter": { "type": "integer", - "description": "Cancel after n seconds，the order timing strategy is GTT", - "format": "int64" + "description": "Cancel after n seconds, the order timing strategy is GTT, -1 means it will not be cancelled automatically, the default value is -1\n", + "format": "int64", + "default": -1, + "minimum": 0, + "exclusiveMinimum": 0, + "maximum": 2592000, + "exclusiveMaximum": 2592000 }, "postOnly": { "type": "boolean", @@ -13541,6 +14205,24 @@ "funds": { "type": "string", "description": "When **type** is market, select one out of two: size or funds" + }, + "allowMaxTimeWindow": { + "type": "integer", + "description": "Order failed after timeout of specified milliseconds, If clientTimestamp + allowMaxTimeWindow < the server reaches time, this order will fail.", + "format": "int64", + "examples": [ + 10, + 20, + 30 + ] + }, + "clientTimestamp": { + "type": "integer", + "description": "Equal to KC-API-TIMESTAMP, Need to be defined if iceberg is specified.", + "format": "int64", + "examples": [ + 1740711735178 + ] } }, "required": [ @@ -13560,8 +14242,8 @@ "example": "{\n \"orderList\": [\n {\n \"clientOid\": \"client order id 13\",\n \"symbol\": \"BTC-USDT\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"30000\",\n \"size\": \"0.00001\"\n },\n {\n \"clientOid\": \"client order id 14\",\n \"symbol\": \"ETH-USDT\",\n \"type\": \"limit\",\n \"side\": \"sell\",\n \"price\": \"2000\",\n \"size\": \"0.00001\"\n }\n ]\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.\n\nThe difference between this interface and \"Batch Add Orders\" is that this interface will synchronously return the order information after the order matching is completed.\n\nFor higher latency requirements, please select the \"Batch Add Orders\" interface. If there is a requirement for returning data integrity, please select this interface\n:::\n\n\n\n:::tip[Tips]\nThis endpoint only supports order placement requests. To obtain the results of the order placement, you will need to check the order status or subscribe to websocket to obtain information about he order.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type `limit` and `market` |\n| side | String | Yes | `buy` or `sell` |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| tags | String | No | Order tag, length cannot exceed `20` characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed `20` characters (ASCII) |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchAddOrdersSync\",\"sdk-method-description\":\"This endpoint supports sequential batch order placement from a single endpoint. A maximum of 5orders can be placed simultaneously. The order types must be limit orders of the same trading pair\",\"api-rate-limit\":1}" + "description": ":::info[Description]\nThis endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.\n\nThe difference between this interface and \"Batch Add Orders\" is that this interface will synchronously return the order information after the order matching is completed.\n\nFor higher latency requirements, please select the \"Batch Add Orders\" interface. If there is a requirement for returning data integrity, please select this interface.\n:::\n\n\n\n:::tip[Tips]\nThis endpoint only supports order placement requests. To obtain the results of the order placement, you will need to check the order status or subscribe to Websocket to obtain information about the order.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order ID, unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type ‘limit’ and ‘market’ |\n| side | String | Yes | ‘buy’ or ‘sell’ |\n| stp | String | No | self trade prevention is divided into four strategies: ‘CN’, ‘CO’, ‘CB’, and ‘DC’ |\n| tags | String | No | Order tag, length cannot exceed ‘20’ characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed ‘20’ characters (ASCII) |\n\n**Additional Request Parameters Required by ‘limit’ Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy ‘GTC’, ‘GTT’, ‘IOC’, ‘FOK’ (the default is ‘GTC’) |\n| cancelAfter | long | No | Cancel after ‘n’ seconds, the order timing strategy is ‘GTT’ |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is ‘IOC’ or ‘FOK’ |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by ‘market’ orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: ‘size’ or ‘funds’) |\n| funds | String | No | (Select one out of two: ‘size’ or ‘funds’) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or canceled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled (already canceled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID (orderId) and client ID (clientOid) to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value (the threshold value can be obtained using the symbol API endpoint);\n\n- If it is exceeded, for limit orders, the order will be directly canceled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: If the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: This feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchAddOrdersSync\",\"sdk-method-description\":\"This endpoint supports sequential batch order placement from a single endpoint. A maximum of 5 orders can be placed simultaneously. The order types must be limit orders of the same trading pair\",\"api-rate-limit-weight\":1}" } }, { @@ -13571,16 +14253,6 @@ "method": "delete", "path": "/api/v1/hf/orders/{orderId}", "parameters": { - "path": [ - { - "id": "orderId#0", - "name": "orderId", - "required": true, - "description": "The unique order id generated by the trading system", - "example": "671124f9365ccb00073debd4", - "type": "string" - } - ], "query": [ { "id": "KXIxHhD4qw", @@ -13596,7 +14268,19 @@ "ETH-USDT", "KCS-USDT" ] - } + }, + "enable": true + } + ], + "path": [ + { + "id": "orderId#0", + "name": "orderId", + "required": true, + "description": "The unique order id generated by the trading system", + "example": "671124f9365ccb00073debd4", + "type": "string", + "enable": true } ], "cookie": [], @@ -13619,7 +14303,7 @@ "properties": { "orderId": { "type": "string", - "description": "order id" + "description": "Order id" } }, "required": [ @@ -13655,8 +14339,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can be used to cancel a spot order by orderId.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit\":1}" + "description": ":::info[Description]\nThis endpoint can be used to cancel a spot order by orderId.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to Websocket.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to Websocket.\",\"api-rate-limit-weight\":1}" } }, { @@ -13666,16 +14350,6 @@ "method": "delete", "path": "/api/v1/hf/orders/sync/{orderId}", "parameters": { - "path": [ - { - "id": "orderId#0", - "name": "orderId", - "required": true, - "description": "The unique order id generated by the trading system", - "example": "671128ee365ccb0007534d45", - "type": "string" - } - ], "query": [ { "id": "KXIxHhD4qw", @@ -13691,7 +14365,19 @@ "ETH-USDT", "KCS-USDT" ] - } + }, + "enable": true + } + ], + "path": [ + { + "id": "orderId#0", + "name": "orderId", + "required": true, + "description": "The unique order id generated by the trading system", + "example": "671128ee365ccb0007534d45", + "type": "string", + "enable": true } ], "cookie": [], @@ -13742,13 +14428,13 @@ "x-api-enum": [ { "value": "open", - "name": "", - "description": "" + "name": "open", + "description": "order is active" }, { "value": "done", - "name": "", - "description": "" + "name": "done", + "description": "order has been completed" } ] } @@ -13792,7 +14478,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to cancel a spot order by orderId.\n\nThe difference between this interface and \"Cancel Order By OrderId\" is that this interface will synchronously return the order information after the order canceling is completed.\n\nFor higher latency requirements, please select the \"Cancel Order By OrderId\" interface. If there is a requirement for returning data integrity, please select this interface\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByOrderIdSync\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot order by orderId.\",\"api-rate-limit\":1}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByOrderIdSync\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot order by orderId.\",\"api-rate-limit-weight\":1}" } }, { @@ -13887,7 +14573,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to cancel a spot order by clientOid.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByClientOid\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit\":1}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByClientOid\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit-weight\":1}" } }, { @@ -13897,16 +14583,6 @@ "method": "delete", "path": "/api/v1/hf/orders/sync/client-order/{clientOid}", "parameters": { - "path": [ - { - "id": "clientOid#0", - "name": "clientOid", - "required": true, - "description": "Client Order Id，unique identifier created by the user", - "example": "5c52e11203aa677f33e493fb", - "type": "string" - } - ], "query": [ { "id": "KXIxHhD4qw", @@ -13922,7 +14598,19 @@ "ETH-USDT", "KCS-USDT" ] - } + }, + "enable": true + } + ], + "path": [ + { + "id": "clientOid#0", + "name": "clientOid", + "required": true, + "description": "Client Order Id，unique identifier created by the user", + "example": "5c52e11203aa677f33e493fb", + "type": "string", + "enable": true } ], "cookie": [], @@ -13973,13 +14661,13 @@ "x-api-enum": [ { "value": "open", - "name": "", - "description": "" + "name": "open", + "description": "order is active" }, { "value": "done", - "name": "", - "description": "" + "name": "done", + "description": "order has been completed" } ] } @@ -14023,7 +14711,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to cancel a spot order by clientOid.\n\nThe difference between this interface and \"Cancel Order By ClientOid\" is that this interface will synchronously return the order information after the order canceling is completed.\n\nFor higher latency requirements, please select the \"Cancel Order By ClientOid\" interface. If there is a requirement for returning data integrity, please select this interface\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByClientOidSync\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot order by orderId.\",\"api-rate-limit\":1}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByClientOidSync\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot order by orderId.\",\"api-rate-limit-weight\":1}" } }, { @@ -14131,7 +14819,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis interface can cancel the specified quantity of the order according to the orderId.\nThe order execution order is: price first, time first, this interface will not change the queue order\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelPartialOrder\",\"sdk-method-description\":\"This interface can cancel the specified quantity of the order according to the orderId. The order execution order is: price first, time first, this interface will not change the queue order\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelPartialOrder\",\"sdk-method-description\":\"This interface can cancel the specified quantity of the order according to the orderId. The order execution order is: price first, time first, this interface will not change the queue order\",\"api-rate-limit-weight\":2}" } }, { @@ -14208,7 +14896,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can cancel all spot orders for specific symbol.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllOrdersBySymbol\",\"sdk-method-description\":\"This endpoint can cancel all spot orders for specific symbol. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllOrdersBySymbol\",\"sdk-method-description\":\"This endpoint can cancel all spot orders for specific symbol. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit-weight\":2}" } }, { @@ -14303,7 +14991,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can cancel all spot orders for all symbol.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllOrders\",\"sdk-method-description\":\"This endpoint can cancel all spot orders for all symbol. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit\":30}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllOrders\",\"sdk-method-description\":\"This endpoint can cancel all spot orders for all symbol. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit-weight\":30}" } }, { @@ -14335,11 +15023,11 @@ "properties": { "newOrderId": { "type": "string", - "description": "The new order id" + "description": "The new order ID" }, "clientOid": { "type": "string", - "description": "The original client order id" + "description": "The original client order ID" } }, "required": [ @@ -14374,7 +15062,7 @@ "properties": { "clientOid": { "type": "string", - "description": "The old client order id,orderId and clientOid must choose one", + "description": "One must be chose out of the old client order ID, orderId and clientOid", "examples": [ "5c52e11203aa677f33e493fb" ] @@ -14390,15 +15078,15 @@ }, "orderId": { "type": "string", - "description": "The old order id, orderId and clientOid must choose one" + "description": "One must be chosen out of the old order id, orderId and clientOid" }, "newPrice": { "type": "string", - "description": "The modified price of the new order, newPrice and newSize must choose one" + "description": "One must be chosen out of the modified price of the new order, newPrice and newSize" }, "newSize": { "type": "string", - "description": "The modified size of the new order, newPrice and newSize must choose one" + "description": "One must be chosen out of the modified size of the new order, newPrice and newSize" } }, "required": [ @@ -14408,8 +15096,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis interface can modify the price and quantity of the order according to orderId or clientOid.\n\nThe implementation of this interface is: cancel the order and place a new order on the same trading pair, and return the modification result to the client synchronously\n\nWhen the quantity of the new order updated by the user is less than the filled quantity of this order, the order will be considered as completed, and the order will be cancelled, and no new order will be placed\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"modifyOrder\",\"sdk-method-description\":\"This interface can modify the price and quantity of the order according to orderId or clientOid. The implementation of this interface is: cancel the order and place a new order on the same trading pair, and return the modification result to the client synchronously When the quantity of the new order updated by the user is less than the filled quantity of this order, the order will be considered as completed, and the order will be cancelled, and no new order will be placed\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nThis interface can modify the price and quantity of the order according to orderId or clientOid.\n\nThe implementation of this interface is: Cancel the order and place a new order on the same trading pair, and return the modification result to the client synchronously.\n\nWhen the quantity of the new order updated by the user is less than the filled quantity of this order, the order will be considered as completed, and the order will be canceled, and no new order will be placed.\n:::\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"modifyOrder\",\"sdk-method-description\":\"This interface can modify the price and quantity of the order according to orderId or clientOid. The implementation of this interface is: Cancel the order and place a new order on the same trading pair, and return the modification result to the client synchronously. When the quantity of the new order updated by the user is less than the filled quantity of this order, the order will be considered as completed, and the order will be canceled, and no new order will be placed.\",\"api-rate-limit-weight\":3}" } }, { @@ -14633,7 +15321,8 @@ }, "cancelAfter": { "type": "integer", - "description": "A GTT timeInForce that expires in n seconds" + "description": "A GTT timeInForce that expires in n seconds", + "format": "int64" }, "channel": { "type": "string" @@ -14759,7 +15448,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to obtain information for a single Spot order using the order id.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to obtain information for a single Spot order using the order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to obtain information for a single Spot order using the order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit-weight\":2}" } }, { @@ -14983,7 +15672,8 @@ }, "cancelAfter": { "type": "integer", - "description": "A GTT timeInForce that expires in n seconds" + "description": "A GTT timeInForce that expires in n seconds", + "format": "int64" }, "channel": { "type": "string" @@ -15109,7 +15799,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to obtain information for a single Spot order using the client order id.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByClientOid\",\"sdk-method-description\":\"This endpoint can be used to obtain information for a single Spot order using the client order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByClientOid\",\"sdk-method-description\":\"This endpoint can be used to obtain information for a single Spot order using the client order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit-weight\":2}" } }, { @@ -15181,7 +15871,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis interface can query all spot symbol that has active orders\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getSymbolsWithOpenOrder\",\"sdk-method-description\":\"This interface can query all spot symbol that has active orders\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getSymbolsWithOpenOrder\",\"sdk-method-description\":\"This interface can query all spot symbol that has active orders\",\"api-rate-limit-weight\":2}" } }, { @@ -15397,7 +16087,8 @@ }, "cancelAfter": { "type": "integer", - "description": "A GTT timeInForce that expires in n seconds" + "description": "A GTT timeInForce that expires in n seconds", + "format": "int64" }, "channel": { "type": "string" @@ -15524,7 +16215,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis interface is to obtain all Spot active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nFor high-frequency trading users, we recommend locally caching, maintaining your own order records, and using market data streams to update your order information in real time.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOpenOrders\",\"sdk-method-description\":\"This interface is to obtain all Spot active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOpenOrders\",\"sdk-method-description\":\"This interface is to obtain all Spot active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit-weight\":2}" } }, { @@ -15615,7 +16306,9 @@ "type": "integer", "schema": { "type": "integer", - "format": "int64" + "format": "int64", + "minimum": 0, + "exclusiveMinimum": 0 }, "enable": true }, @@ -15643,7 +16336,11 @@ "type": "integer", "schema": { "type": "integer", - "format": "int64" + "format": "int64", + "minimum": 1000000000000, + "maximum": 9999999999999, + "exclusiveMinimum": 1000000000000, + "exclusiveMaximum": 9999999999999 }, "enable": true }, @@ -15683,7 +16380,9 @@ "lastId": { "type": "integer", "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page.", - "format": "int64" + "format": "int64", + "minimum": 0, + "exclusiveMinimum": 0 }, "items": { "type": "array", @@ -15989,7 +16688,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis interface is to obtain all Spot Closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getClosedOrders\",\"sdk-method-description\":\"This interface is to obtain all Spot closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getClosedOrders\",\"sdk-method-description\":\"This interface is to obtain all Spot closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit-weight\":2}" } }, { @@ -16023,7 +16722,12 @@ "required": false, "description": "The unique order id generated by the trading system\n(If orderId is specified，please ignore the other query parameters)", "type": "string", - "enable": true + "enable": true, + "schema": { + "type": "string", + "maxLength": 24, + "minLength": 24 + } }, { "id": "sTtMCE9Jhf", @@ -16088,7 +16792,9 @@ "type": "integer", "schema": { "type": "integer", - "format": "int64" + "format": "int64", + "minimum": 0, + "exclusiveMinimum": 0 }, "enable": true }, @@ -16116,7 +16822,11 @@ "type": "integer", "schema": { "type": "integer", - "format": "int64" + "format": "int64", + "minimum": 1000000000000, + "maximum": 9999999999999, + "exclusiveMinimum": 1000000000000, + "exclusiveMaximum": 9999999999999 }, "enable": true }, @@ -16129,7 +16839,11 @@ "type": "integer", "schema": { "type": "integer", - "format": "int64" + "format": "int64", + "maximum": 9999999999999, + "exclusiveMaximum": 9999999999999, + "minimum": 1000000000000, + "exclusiveMinimum": 1000000000000 }, "enable": true } @@ -16358,7 +17072,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to obtain a list of the latest Spot transaction details. \nThe returned data is sorted in descending order according to the latest update time of the order.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getTradeHistory\",\"sdk-method-description\":\"This endpoint can be used to obtain a list of the latest Spot transaction details. The returned data is sorted in descending order according to the latest update time of the order.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getTradeHistory\",\"sdk-method-description\":\"This endpoint can be used to obtain a list of the latest Spot transaction details. The returned data is sorted in descending order according to the latest update time of the order.\",\"api-rate-limit-weight\":2}" } }, { @@ -16368,8 +17082,8 @@ "method": "get", "path": "/api/v1/hf/orders/dead-cancel-all/query", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -16390,19 +17104,21 @@ "properties": { "timeout": { "type": "integer", - "description": "Auto cancel order trigger setting time, the unit is second. range: timeout=-1 (meaning unset) or 5 <= timeout <= 86400" + "description": "Auto cancel order trigger setting time, the unit is second. Range: timeout=-1 (meaning unset) or 5 <= timeout <= 86400" }, "symbols": { "type": "string", - "description": "List of trading pairs. Separated by commas, empty means all trading pairs" + "description": "List of trading pairs. Separated by commas; empty means all trading pairs" }, "currentTime": { "type": "integer", - "description": "System current time (in seconds)" + "description": "System current time (in seconds)", + "format": "int64" }, "triggerTime": { "type": "integer", - "description": "Trigger cancellation time (in seconds)" + "description": "Trigger cancellation time (in seconds)", + "format": "int64" } }, "description": "If the data is empty, it means that DCP is not set.", @@ -16437,8 +17153,8 @@ "example": "{\n \"timeout\": 5,\n \"symbols\": \"BTC-USDT,ETH-USDT\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nGet Disconnection Protect(Deadman Swich)Through this interface, you can query the settings of automatic order cancellation\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getDCP\",\"sdk-method-description\":\"Get Disconnection Protect(Deadman Swich)Through this interface, you can query the settings of automatic order cancellation\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nGet Disconnection Protect (Deadman Switch). Through this interface, you can query the settings of automatic order cancellation.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getDCP\",\"sdk-method-description\":\"Get Disconnection Protect (Deadman Switch). Through this interface, you can query the settings of automatic order cancellation.\",\"api-rate-limit-weight\":2}" } }, { @@ -16470,11 +17186,13 @@ "properties": { "currentTime": { "type": "integer", - "description": "System current time (in seconds)" + "description": "System current time (in seconds)", + "format": "int64" }, "triggerTime": { "type": "integer", - "description": "Trigger cancellation time (in seconds)" + "description": "Trigger cancellation time (in seconds)", + "format": "int64" } }, "required": [ @@ -16510,7 +17228,7 @@ "properties": { "timeout": { "type": "integer", - "description": "Auto cancel order trigger setting time, the unit is second. range: timeout=-1 (meaning unset) or 5 <= timeout <= 86400. For example, timeout=5 means that the order will be automatically canceled if no user request is received for more than 5 seconds. When this parameter is changed, the previous setting will be overwritten." + "description": "Auto cancel order trigger setting time, the unit is second. Range: timeout=-1 (meaning unset) or 5 <= timeout <= 86400. For example, timeout=5 means that the order will be automatically canceled if no user request is received for more than 5 seconds. When this parameter is changed, the previous setting will be overwritten." }, "symbols": { "type": "string", @@ -16527,8 +17245,8 @@ "example": "{\n \"timeout\": 5,\n \"symbols\": \"BTC-USDT,ETH-USDT\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nSet Disconnection Protect(Deadman Swich)Through this interface, Call this interface to automatically cancel all orders of the set trading pair after the specified time. If this interface is not called again for renewal or cancellation before the set time, the system will help the user to cancel the order of the corresponding trading pair. Otherwise it will not.\n:::\n\n:::tip[Tips]\nThe order cancellation delay is between 0 and 10 seconds, and the order will not be canceled in real time. When the system cancels the order, if the transaction pair status is no longer operable to cancel the order, it will not cancel the order\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"setDCP\",\"sdk-method-description\":\"Set Disconnection Protect(Deadman Swich)Through this interface, Call this interface to automatically cancel all orders of the set trading pair after the specified time. If this interface is not called again for renewal or cancellation before the set time, the system will help the user to cancel the order of the corresponding trading pair. Otherwise it will not.\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nSet Disconnection Protect (Deadman Switch). Through this interface, call this interface to automatically cancel all orders of the set trading pair after the specified time. If this interface is not called again for renewal or cancellation before the set time, the system will help the user to cancel the order of the corresponding trading pair. Otherwise it will not.\n:::\n\n:::tip[Tips]\nThe order cancellation delay is between 0 and 10 seconds, and the order will not be canceled in real time. When the system cancels the order, if the transaction pair status is no longer operable to cancel the order, it will not cancel the order\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"setDCP\",\"sdk-method-description\":\"Set Disconnection Protect (Deadman Switch). Through this interface, call this interface to automatically cancel all orders of the set trading pair after the specified time. If this interface is not called again for renewal or cancellation before the set time, the system will help the user to cancel the order of the corresponding trading pair. Otherwise it will not.\",\"api-rate-limit-weight\":2}" } }, { @@ -16561,15 +17279,10 @@ "orderId": { "type": "string", "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." - }, - "clientOid": { - "type": "string", - "description": "The user self-defined order id." } }, "required": [ - "orderId", - "clientOid" + "orderId" ] } }, @@ -16586,7 +17299,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\"code\":\"200000\",\"data\":{\"orderId\":\"670fd33bf9406e0007ab3945\",\"clientOid\":\"5c52e11203aa677f33e493fb\"}}", + "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"670fd33bf9406e0007ab3945\"\n }\n}", "responseId": 10651, "ordering": 1 } @@ -16757,8 +17470,13 @@ }, "cancelAfter": { "type": "integer", - "description": "Cancel after n seconds，the order timing strategy is GTT when **type** is limit.", - "format": "int64" + "description": "Cancel after n seconds, the order timing strategy is GTT, -1 means it will not be cancelled automatically, the default value is -1\n", + "format": "int64", + "default": -1, + "minimum": 0, + "exclusiveMinimum": 0, + "maximum": 2592000, + "exclusiveMaximum": 2592000 }, "funds": { "type": "string", @@ -16780,11 +17498,11 @@ "stopPrice" ] }, - "example": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", + "example": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"stopPrice\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", "mediaType": "" }, "description": ":::info[Description]\nPlace stop order to the Spot trading system. The maximum untriggered stop orders for a single trading pair in one account is 20.\n:::\n\n", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addStopOrder\",\"sdk-method-description\":\"Place stop order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\",\"api-rate-limit\":1}" + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addStopOrder\",\"sdk-method-description\":\"Place stop order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\",\"api-rate-limit-weight\":1}" } }, { @@ -16885,7 +17603,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint can be used to cancel a spot order by clientOid.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelStopOrderByClientOid\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot stop order by clientOid. \",\"api-rate-limit\":5}" + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelStopOrderByClientOid\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot stop order by clientOid. \",\"api-rate-limit-weight\":5}" } }, { @@ -16930,7 +17648,7 @@ "items": { "type": "string" }, - "description": "order id array" + "description": "order ID array" } }, "required": [ @@ -16966,8 +17684,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to cancel a single stop order previously placed.\n\nYou will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the websocket pushes.\n:::", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelStopOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot stop order by orderId. \",\"api-rate-limit\":3}" + "description": ":::info[Description]\nRequest via this endpoint the cancellation of a single stop order previously placed.\n\nYou will receive canceledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the Websocket pushes.\n:::", + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelStopOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot stop order by orderId. \",\"api-rate-limit-weight\":3}" } }, { @@ -16988,7 +17706,7 @@ }, { "required": false, - "description": "The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE", + "description": "The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin).", "type": "string", "id": "WL2a8vOzaG", "enable": true, @@ -17064,7 +17782,7 @@ "mediaType": "" }, "description": ":::info[Description]\nRequest via this interface to cancel a batch of stop orders.\n\nThe count of orderId in the parameter now is not limited.\n\nAn example is:\n ```/api/v1/stop-order/cancel?symbol=ETH-BTC&tradeType=TRADE&orderIds=5bd6e9286d99522a52e458de,5bd6e9286d99522a52e458df```\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchCancelStopOrder\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot stop orders by batch.\",\"api-rate-limit\":3}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchCancelStopOrder\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot stop orders by batch.\",\"api-rate-limit-weight\":3}" } }, { @@ -17074,7 +17792,126 @@ "method": "get", "path": "/api/v1/stop-order", "parameters": { - "query": [], + "query": [ + { + "required": false, + "description": "Only list orders for a specific symbol", + "type": "string", + "id": "W6Bi86Rm6P", + "enable": true, + "name": "symbol" + }, + { + "required": false, + "description": "buy or sell", + "type": "string", + "id": "ekEMQ8NSZ2", + "enable": true, + "name": "side" + }, + { + "required": false, + "description": "limit, market", + "type": "string", + "id": "ZF6PJFgbt2", + "enable": true, + "name": "type", + "schema": { + "type": "string", + "enum": [ + "limit", + "market" + ], + "x-api-enum": [ + { + "value": "limit", + "name": "limit", + "description": "limit order" + }, + { + "value": "market", + "name": "market", + "description": "market order" + } + ] + } + }, + { + "required": false, + "description": "The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE", + "type": "string", + "id": "YRGK62kb6v", + "enable": true, + "name": "tradeType" + }, + { + "required": false, + "description": "Start time (milisecond)", + "type": "integer", + "id": "QdqyNOkHn0", + "enable": true, + "name": "startAt", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "required": false, + "description": "End time (milisecond)", + "type": "integer", + "id": "q7wtuVo2tz", + "enable": true, + "name": "endAt", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "required": false, + "description": "Current page\n", + "type": "integer", + "id": "1buH72SI1q", + "enable": true, + "name": "currentPage", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + } + }, + { + "required": false, + "description": "Comma seperated order ID list", + "type": "string", + "id": "qZ5VGIVBEF", + "enable": true, + "name": "orderIds" + }, + { + "required": false, + "description": "Page size", + "type": "integer", + "id": "KXUUzMCgWC", + "enable": true, + "name": "pageSize", + "schema": { + "type": "integer", + "default": 50, + "minimum": 10, + "maximum": 500 + } + }, + { + "required": false, + "description": "Order type: stop: stop loss order, oco: oco order", + "type": "string", + "id": "Wx4hROA55E", + "enable": true, + "name": "stop" + } + ], "path": [], "cookie": [], "header": [] @@ -17132,7 +17969,23 @@ }, "type": { "type": "string", - "description": "Order type,limit, market, limit_stop or market_stop" + "description": "Order type", + "enum": [ + "limit", + "market" + ], + "x-api-enum": [ + { + "value": "limit", + "name": "limit", + "description": "Limit order" + }, + { + "value": "market", + "name": "market", + "description": "Market order" + } + ] }, "side": { "type": "string", @@ -17195,8 +18048,7 @@ }, "orderTime": { "type": "integer", - "description": "Time of place a stop order, accurate to nanoseconds", - "format": "int64" + "description": "Time of place a stop order, accurate to nanoseconds" }, "domainId": { "type": "string", @@ -17224,8 +18076,7 @@ }, "createdAt": { "type": "integer", - "description": "order creation time", - "format": "int64" + "description": "order creation time" }, "stop": { "type": "string", @@ -17233,21 +18084,68 @@ }, "stopTriggerTime": { "type": "integer", - "description": "The trigger time of the stop order", - "format": "int64" + "description": "The trigger time of the stop order" }, "stopPrice": { "type": "string", "description": "stop price" + }, + "relatedNo": { + "type": "string" + }, + "limitPrice": { + "type": "string" + }, + "pop": { + "type": "string" + }, + "activateCondition": { + "type": "string" } - } + }, + "required": [ + "id", + "symbol", + "userId", + "status", + "type", + "side", + "price", + "size", + "timeInForce", + "cancelAfter", + "postOnly", + "hidden", + "iceberg", + "channel", + "clientOid", + "remark", + "orderTime", + "domainId", + "tradeSource", + "tradeType", + "feeCurrency", + "takerFeeRate", + "makerFeeRate", + "createdAt", + "stop", + "stopPrice" + ] }, "description": "the list of stop orders" } - } + }, + "required": [ + "currentPage", + "pageSize", + "totalNum", + "totalPage", + "items" + ] } }, "required": [ + "code", "data" ] }, @@ -17259,130 +18157,23 @@ "responseExamples": [ { "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"id\": \"vs8hoo8kqjnklv4m0038lrfq\",\n \"symbol\": \"KCS-USDT\",\n \"userId\": \"60fe4956c43cbc0006562c2c\",\n \"status\": \"NEW\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.01000000000000000000\",\n \"size\": \"0.01000000000000000000\",\n \"funds\": null,\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": -1,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"clientOid\": \"404814a0fb4311eb9098acde48001122\",\n \"remark\": null,\n \"tags\": null,\n \"orderTime\": 1628755183702150100,\n \"domainId\": \"kucoin\",\n \"tradeSource\": \"USER\",\n \"tradeType\": \"TRADE\",\n \"feeCurrency\": \"USDT\",\n \"takerFeeRate\": \"0.00200000000000000000\",\n \"makerFeeRate\": \"0.00200000000000000000\",\n \"createdAt\": 1628755183704,\n \"stop\": \"loss\",\n \"stopTriggerTime\": null,\n \"stopPrice\": \"10.00000000000000000000\"\n }\n ]\n }\n}", + "data": "{\r\n \"code\": \"200000\",\r\n \"data\": {\r\n \"currentPage\": 1,\r\n \"pageSize\": 50,\r\n \"totalNum\": 2,\r\n \"totalPage\": 1,\r\n \"items\": [\r\n {\r\n \"id\": \"vs93gptvr9t2fsql003l8k5p\",\r\n \"symbol\": \"BTC-USDT\",\r\n \"userId\": \"633559791e1cbc0001f319bc\",\r\n \"status\": \"NEW\",\r\n \"type\": \"limit\",\r\n \"side\": \"buy\",\r\n \"price\": \"50000.00000000000000000000\",\r\n \"size\": \"0.00001000000000000000\",\r\n \"funds\": null,\r\n \"stp\": null,\r\n \"timeInForce\": \"GTC\",\r\n \"cancelAfter\": -1,\r\n \"postOnly\": false,\r\n \"hidden\": false,\r\n \"iceberg\": false,\r\n \"visibleSize\": null,\r\n \"channel\": \"API\",\r\n \"clientOid\": \"5c52e11203aa677f222233e493fb\",\r\n \"remark\": \"order remarks\",\r\n \"tags\": null,\r\n \"relatedNo\": null,\r\n \"orderTime\": 1740626554883000024,\r\n \"domainId\": \"kucoin\",\r\n \"tradeSource\": \"USER\",\r\n \"tradeType\": \"TRADE\",\r\n \"feeCurrency\": \"USDT\",\r\n \"takerFeeRate\": \"0.00100000000000000000\",\r\n \"makerFeeRate\": \"0.00100000000000000000\",\r\n \"createdAt\": 1740626554884,\r\n \"stop\": \"loss\",\r\n \"stopTriggerTime\": null,\r\n \"stopPrice\": \"60000.00000000000000000000\",\r\n \"limitPrice\": null,\r\n \"pop\": null,\r\n \"activateCondition\": null\r\n }\r\n ]\r\n }\r\n}", "responseId": 10568, "ordering": 1 } ], "requestBody": { - "type": "application/json", + "type": "none", "parameters": [], "jsonSchema": { "type": "object", - "properties": { - "symbol": { - "type": "string", - "description": "Only list orders for a specific symbol" - }, - "side": { - "type": "string", - "enum": [ - "buy", - "sell" - ], - "description": "buy or sell", - "x-api-enum": [ - { - "value": "buy", - "name": "buy", - "description": "" - }, - { - "value": "sell", - "name": "sell", - "description": "" - } - ] - }, - "type": { - "type": "string", - "description": "limit, market, limit_stop or market_stop", - "enum": [ - "limit", - "market", - "limit_stop", - "market_stop" - ], - "x-api-enum": [ - { - "value": "limit", - "name": "limit", - "description": "" - }, - { - "value": "market", - "name": "market", - "description": "" - }, - { - "value": "limit_stop", - "name": "limit_stop", - "description": "" - }, - { - "value": "market_stop", - "name": "market_stop", - "description": "" - } - ] - }, - "tradeType": { - "type": "string", - "description": "The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE", - "enum": [ - "TRADE", - "MARGIN_TRADE", - "MARGIN_ISOLATED_TRADE" - ], - "x-api-enum": [ - { - "value": "TRADE", - "name": "TRADE", - "description": "" - }, - { - "value": "MARGIN_TRADE", - "name": "MARGIN_TRADE", - "description": "" - }, - { - "value": "MARGIN_ISOLATED_TRADE", - "name": "MARGIN_ISOLATED_TRADE", - "description": "" - } - ] - }, - "startAt": { - "type": "number", - "description": "Start time (milisecond)" - }, - "endAt": { - "type": "number", - "description": "End time (milisecond)" - }, - "currentPage": { - "type": "integer", - "description": "current page" - }, - "orderIds": { - "type": "string", - "description": "comma seperated order ID list" - }, - "pageSize": { - "type": "integer", - "description": "page size" - }, - "stop": { - "type": "string", - "description": "Order type: stop: stop loss order, oco: oco order" - } - } + "properties": {} }, - "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", + "example": "", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get your current untriggered stop order list. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n\n:::\n\n\n:::tip[Example]\n```json\n{\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"id\": \"vs8hoo8kqjnklv4m0038lrfq\",\n \"symbol\": \"KCS-USDT\",\n \"userId\": \"60fe4956c43cbc0006562c2c\",\n \"status\": \"NEW\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.01000000000000000000\",\n \"size\": \"0.01000000000000000000\",\n \"funds\": null,\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": -1,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"clientOid\": \"404814a0fb4311eb9098acde48001122\",\n \"remark\": null,\n \"tags\": null,\n \"orderTime\": 1628755183702150167,\n \"domainId\": \"kucoin\",\n \"tradeSource\": \"USER\",\n \"tradeType\": \"TRADE\",\n \"feeCurrency\": \"USDT\",\n \"takerFeeRate\": \"0.00200000000000000000\",\n \"makerFeeRate\": \"0.00200000000000000000\",\n \"createdAt\": 1628755183704,\n \"stop\": \"loss\",\n \"stopTriggerTime\": null,\n \"stopPrice\": \"10.00000000000000000000\"\n }\n ]\n}\n```\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getStopOrdersList\",\"sdk-method-description\":\"This interface is to obtain all Spot active stop order lists\",\"api-rate-limit\":8}" + "description": ":::info[Description]\nRequest via this endpoint to get your current untriggered stop order list. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n\n:::\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getStopOrdersList\",\"sdk-method-description\":\"This interface is to obtain all Spot active stop order lists\",\"api-rate-limit-weight\":8}" } }, { @@ -17436,7 +18227,23 @@ }, "type": { "type": "string", - "description": "Order type,limit, market, limit_stop or market_stop" + "description": "Order type", + "enum": [ + "limit", + "market" + ], + "x-api-enum": [ + { + "value": "limit", + "name": "limit", + "description": "Limit order" + }, + { + "value": "market", + "name": "market", + "description": "Market order" + } + ] }, "side": { "type": "string", @@ -17688,8 +18495,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this interface to get a stop order information via the order ID.\n\n:::\n\n\n:::tip[Example]\n```json\n{\n \"id\": \"vs8hoo8q2ceshiue003b67c0\",\n \"symbol\": \"KCS-USDT\",\n \"userId\": \"60fe4956c43cbc0006562c2c\",\n \"status\": \"NEW\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.01000000000000000000\",\n \"size\": \"0.01000000000000000000\",\n \"funds\": null,\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": -1,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"clientOid\": \"40e0eb9efe6311eb8e58acde48001122\",\n \"remark\": null,\n \"tags\": null,\n \"orderTime\": 1629098781127530345,\n \"domainId\": \"kucoin\",\n \"tradeSource\": \"USER\",\n \"tradeType\": \"TRADE\",\n \"feeCurrency\": \"USDT\",\n \"takerFeeRate\": \"0.00200000000000000000\",\n \"makerFeeRate\": \"0.00200000000000000000\",\n \"createdAt\": 1629098781128,\n \"stop\": \"loss\",\n \"stopTriggerTime\": null,\n \"stopPrice\": \"10.00000000000000000000\"\n}\n```\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getStopOrderByOrderId\",\"sdk-method-description\":\"This interface is to obtain Spot stop order details by orderId\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nRequest via this interface to get a stop order information via the order ID.\n\n:::\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getStopOrderByOrderId\",\"sdk-method-description\":\"This interface is to obtain Spot stop order details by orderId\",\"api-rate-limit-weight\":3}" } }, { @@ -17757,7 +18564,23 @@ }, "type": { "type": "string", - "description": "Order type,limit, market, limit_stop or market_stop" + "description": "Order type", + "enum": [ + "limit", + "market" + ], + "x-api-enum": [ + { + "value": "limit", + "name": "limit", + "description": "Limit order" + }, + { + "value": "market", + "name": "market", + "description": "Market order" + } + ] }, "side": { "type": "string", @@ -18008,8 +18831,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this interface to get a stop order information via the clientOid.\n\n:::\n\n\n:::tip[Example]\n```json\n{\n \"id\": \"vs8hoo8q2ceshiue003b67c0\",\n \"symbol\": \"KCS-USDT\",\n \"userId\": \"60fe4956c43cbc0006562c2c\",\n \"status\": \"NEW\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.01000000000000000000\",\n \"size\": \"0.01000000000000000000\",\n \"funds\": null,\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": -1,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"clientOid\": \"40e0eb9efe6311eb8e58acde48001122\",\n \"remark\": null,\n \"tags\": null,\n \"orderTime\": 1629098781127530345,\n \"domainId\": \"kucoin\",\n \"tradeSource\": \"USER\",\n \"tradeType\": \"TRADE\",\n \"feeCurrency\": \"USDT\",\n \"takerFeeRate\": \"0.00200000000000000000\",\n \"makerFeeRate\": \"0.00200000000000000000\",\n \"createdAt\": 1629098781128,\n \"stop\": \"loss\",\n \"stopTriggerTime\": null,\n \"stopPrice\": \"10.00000000000000000000\"\n}\n```\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getStopOrderByClientOid\",\"sdk-method-description\":\"This interface is to obtain Spot stop order details by orderId\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nRequest via this interface to get a stop order information via the clientOid.\n\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getStopOrderByClientOid\",\"sdk-method-description\":\"This interface is to obtain Spot stop order details by orderId\",\"api-rate-limit-weight\":3}" } }, { @@ -18161,7 +18984,7 @@ "mediaType": "" }, "description": ":::info[Description]\nPlace OCO order to the Spot trading system\n:::\n\n:::tip[Tips]\nThe maximum untriggered stop orders for a single trading pair in one account is 20.\n:::\n", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOcoOrder\",\"sdk-method-description\":\"Place OCO order to the Spot trading system\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOcoOrder\",\"sdk-method-description\":\"Place OCO order to the Spot trading system\",\"api-rate-limit-weight\":2}" } }, { @@ -18242,8 +19065,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to cancel a single oco order previously placed.\n\nYou will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\n:::", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOcoOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nRequest via this endpoint the cancellation of a single OCO order previously placed.\n\nYou will receive canceledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\n:::", + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOcoOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to Websocket.\",\"api-rate-limit-weight\":3}" } }, { @@ -18325,7 +19148,7 @@ "mediaType": "" }, "description": ":::info[Description]\nRequest via this interface to cancel a stop order via the clientOid.\n\nYou will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\n:::", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOcoOrderByClientOid\",\"sdk-method-description\":\"Request via this interface to cancel a stop order via the clientOid. You will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\",\"api-rate-limit\":3}" + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOcoOrderByClientOid\",\"sdk-method-description\":\"Request via this interface to cancel a stop order via the clientOid. You will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\",\"api-rate-limit-weight\":3}" } }, { @@ -18337,22 +19160,22 @@ "parameters": { "query": [ { - "required": false, - "description": "Specify the order id, there can be multiple orders, separated by commas. If not passed, all oco orders will be canceled by default.", - "type": "string", "id": "k4wDZR9oG9", - "enable": true, "name": "orderIds", - "example": "674c388172cf2800072ee746,674c38bdfd8300000795167e" - }, - { "required": false, - "description": "trading pair. If not passed, the oco orders of all symbols will be canceled by default.", + "description": "Specify the order ID; there can be multiple orders, separated by commas. If not passed, all OCO orders will be canceled by default.", + "example": "674c388172cf2800072ee746,674c38bdfd8300000795167e", "type": "string", + "enable": true + }, + { "id": "VGVVOaGkpz", - "enable": true, "name": "symbol", - "example": "BTC-USDT" + "required": false, + "description": "Trading pair. If not passed, the OCO orders of all symbols will be canceled by default.", + "example": "BTC-USDT", + "type": "string", + "enable": true } ], "path": [], @@ -18415,8 +19238,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis interface can batch cancel OCO orders through orderIds.\n\nYou will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\n:::", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchCancelOcoOrders\",\"sdk-method-description\":\"This interface can batch cancel OCO orders through orderIds. You will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nThis interface can batch cancel OCO orders through orderIds.\n\nYou will receive canceledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\n:::", + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Spot\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchCancelOcoOrders\",\"sdk-method-description\":\"This interface can batch cancel OCO orders through orderIds. You will receive canceledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\",\"api-rate-limit-weight\":3}" } }, { @@ -18433,9 +19256,9 @@ "name": "orderId", "required": true, "description": "The unique order id generated by the trading system", + "example": "674c3b6e688dea0007c7bab2", "type": "string", - "enable": true, - "example": "674c3b6e688dea0007c7bab2" + "enable": true } ], "cookie": [], @@ -18462,11 +19285,11 @@ }, "clientOid": { "type": "string", - "description": "Client Order Id" + "description": "Client Order ID" }, "orderId": { "type": "string", - "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." + "description": "The unique order ID generated by the trading system, which can be used later for further actions such as canceling the order." }, "orderTime": { "type": "integer", @@ -18475,7 +19298,7 @@ }, "status": { "type": "string", - "description": "Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELLED: Cancelled", + "description": "Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELED: Canceled", "enum": [ "NEW", "DONE", @@ -18500,8 +19323,8 @@ }, { "value": "CANCELLED", - "name": "CANCELLED", - "description": "Cancelled" + "name": "CANCELED", + "description": "Canceled" } ] } @@ -18543,8 +19366,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this interface to get a oco order information via the order ID.\n:::", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOcoOrderByOrderId\",\"sdk-method-description\":\"Request via this interface to get a oco order information via the order ID.\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nRequest via this interface an OCO order information via the order ID.\n:::", + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOcoOrderByOrderId\",\"sdk-method-description\":\"Request via this interface an OCO order information via the order ID.\",\"api-rate-limit-weight\":2}" } }, { @@ -18644,7 +19467,7 @@ "mediaType": "" }, "description": ":::info[Description]\nRequest via this interface to get a oco order information via the client order ID.\n:::", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOcoOrderByClientOid\",\"sdk-method-description\":\"Request via this interface to get a oco order information via the client order ID.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOcoOrderByClientOid\",\"sdk-method-description\":\"Request via this interface to get a oco order information via the client order ID.\",\"api-rate-limit-weight\":2}" } }, { @@ -18783,7 +19606,7 @@ "mediaType": "" }, "description": ":::info[Description]\nRequest via this interface to get a oco order detail via the order ID.\n:::", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOcoOrderDetailByOrderId\",\"sdk-method-description\":\"Request via this interface to get a oco order detail via the order ID.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOcoOrderDetailByOrderId\",\"sdk-method-description\":\"Request via this interface to get a oco order detail via the order ID.\",\"api-rate-limit-weight\":2}" } }, { @@ -18795,12 +19618,11 @@ "parameters": { "query": [ { + "id": "k5kTqKOh1U", + "name": "symbol", "required": false, "description": "symbol", "type": "string", - "id": "k5kTqKOh1U", - "enable": true, - "name": "symbol", "schema": { "type": "string", "examples": [ @@ -18808,65 +19630,66 @@ "ETH-USDT", "KCS-USDT" ] - } + }, + "enable": true }, { + "id": "3gEHqfvq1R", + "name": "startAt", "required": false, "description": "Start time (milliseconds)", "type": "integer", - "id": "3gEHqfvq1R", - "enable": true, - "name": "startAt", "schema": { "type": "integer", "format": "int64" - } + }, + "enable": true }, { + "id": "qfsVt7qQe8", + "name": "endAt", "required": false, "description": "End time (milliseconds)", "type": "integer", - "id": "qfsVt7qQe8", - "enable": true, - "name": "endAt", "schema": { "type": "integer", "format": "int64" - } + }, + "enable": true }, { + "id": "ZFIKYx3RJH", + "name": "orderIds", "required": false, "description": "Specify orderId collection, up to 500 orders\n", "type": "string", - "id": "ZFIKYx3RJH", - "enable": true, - "name": "orderIds" + "enable": true }, { + "id": "FJH8SIb2XY", + "name": "pageSize", "required": false, "description": "Size per page, minimum value 10, maximum value 500", "type": "integer", - "id": "FJH8SIb2XY", - "enable": true, - "name": "pageSize", "schema": { "type": "integer", "minimum": 10, "maximum": 500, "default": 50 - } + }, + "enable": true }, { + "id": "sSsAg6Hbjc", + "name": "currentPage", "required": false, "description": "Page number, minimum value 1\n", "type": "integer", - "id": "sSsAg6Hbjc", - "enable": true, - "name": "currentPage", "schema": { "type": "integer", "default": 1 - } + }, + "enable": true } ], "path": [], @@ -18907,7 +19730,7 @@ "properties": { "orderId": { "type": "string", - "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." + "description": "The unique order ID generated by the trading system, which can be used later for further actions such as canceling the order." }, "symbol": { "type": "string", @@ -18915,7 +19738,7 @@ }, "clientOid": { "type": "string", - "description": "Client Order Id" + "description": "Client Order ID" }, "orderTime": { "type": "integer", @@ -18924,7 +19747,7 @@ }, "status": { "type": "string", - "description": "Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELLED: Cancelled", + "description": "Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELED: Canceled", "enum": [ "NEW", "DONE", @@ -18949,8 +19772,8 @@ }, { "value": "CANCELLED", - "name": "CANCELLED", - "description": "Cancelled" + "name": "CANCELED", + "description": "Canceled" } ] } @@ -19002,8 +19825,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get your current OCO order list. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOcoOrderList\",\"sdk-method-description\":\"Request via this endpoint to get your current OCO order list. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nRequest your current OCO order list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::", + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Spot\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOcoOrderList\",\"sdk-method-description\":\"Request your current OCO order list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\",\"api-rate-limit-weight\":2}" } } ] @@ -19079,11 +19902,11 @@ }, "name": { "type": "string", - "description": "symbol name" + "description": "Symbol name" }, "enableTrading": { "type": "boolean", - "description": "Whether trading is enabled: true for enabled, false for disabled" + "description": "Whether trading is enabled: True for enabled; false for disabled" }, "market": { "type": "string", @@ -19091,11 +19914,11 @@ }, "baseCurrency": { "type": "string", - "description": "Base currency,e.g. BTC." + "description": "Base currency, e.g. BTC." }, "quoteCurrency": { "type": "string", - "description": "Quote currency,e.g. USDT." + "description": "Quote currency, e.g. USDT." }, "baseIncrement": { "type": "string", @@ -19103,7 +19926,7 @@ }, "baseMinSize": { "type": "string", - "description": "The minimum order quantity requried to place an order." + "description": "The minimum order quantity required to place an order." }, "quoteIncrement": { "type": "string", @@ -19123,7 +19946,7 @@ }, "priceIncrement": { "type": "string", - "description": "Price increment: The price of an order must be a positive integer multiple of this increment. For example, for the ETH-USDT trading pair, if the priceIncrement is 0.01, the order price can be 3000.01 but not 3000.001.\n\nspecifies the min order price as well as the price increment.This also applies to quote currency." + "description": "Price increment: The price of an order must be a positive integer multiple of this increment. For example, for the ETH-USDT trading pair, if the priceIncrement is 0.01, the order price can be 3000.01 but not 3000.001.\n\nSpecifies the min. order price as well as the price increment.This also applies to quote currency." }, "feeCurrency": { "type": "string", @@ -19131,11 +19954,11 @@ }, "priceLimitRate": { "type": "string", - "description": "Threshold for price portection" + "description": "Threshold for price protection" }, "minFunds": { "type": "string", - "description": "the minimum trading amounts" + "description": "The minimum trading amounts" } }, "required": [ @@ -19194,7 +20017,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint allows querying the configuration of cross margin symbol.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getCrossMarginSymbols\",\"sdk-method-description\":\"This endpoint allows querying the configuration of cross margin symbol.\",\"api-rate-limit\":3}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getCrossMarginSymbols\",\"sdk-method-description\":\"This endpoint allows querying the configuration of cross margin symbol.\",\"api-rate-limit-weight\":3}" } }, { @@ -19204,8 +20027,8 @@ "method": "get", "path": "/api/v1/margin/config", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -19233,7 +20056,7 @@ }, "maxLeverage": { "type": "integer", - "description": "Max leverage available" + "description": "Max. leverage available" }, "warningDebtRatio": { "type": "string", @@ -19280,8 +20103,8 @@ "example": "{\n \"currency\": \"USDT\",\n \"size\": 10,\n \"timeInForce\": \"FOK\",\n \"isIsolated\": false,\n \"isHf\": false\n}", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the configure info of the cross margin.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getMarginConfig\",\"sdk-method-description\":\"Request via this endpoint to get the configure info of the cross margin.\",\"api-rate-limit\":25}" + "description": ":::info[Description]\nRequest the configure info of the cross margin via this endpoint.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getMarginConfig\",\"sdk-method-description\":\"Request the configure info of the cross margin via this endpoint.\",\"api-rate-limit-weight\":25}" } }, { @@ -19296,7 +20119,7 @@ "id": "Hf2SMe6sum", "name": "currency", "required": false, - "description": "ETF Currency, if empty query all currencies\n", + "description": "ETF Currency: If empty, query all currencies\n", "example": "BTCUP", "type": "string", "schema": { @@ -19390,8 +20213,8 @@ "example": "{\n \"currency\": \"USDT\",\n \"size\": 10,\n \"timeInForce\": \"FOK\",\n \"isIsolated\": false,\n \"isHf\": false\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis interface returns leveraged token information\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getETFInfo\",\"sdk-method-description\":\"This interface returns leveraged token information\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nThis interface returns leveraged token information.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getETFInfo\",\"sdk-method-description\":\"This interface returns leveraged token information.\",\"api-rate-limit-weight\":3}" } }, { @@ -19474,7 +20297,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint returns the current Mark price for all margin trading pairs.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getMarkPriceList\",\"sdk-method-description\":\"This endpoint returns the current Mark price for all margin trading pairs.\",\"api-rate-limit\":10}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getMarkPriceList\",\"sdk-method-description\":\"This endpoint returns the current Mark price for all margin trading pairs.\",\"api-rate-limit-weight\":10}" } }, { @@ -19564,7 +20387,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint returns the current Mark price for specified margin trading pairs.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getMarkPriceDetail\",\"sdk-method-description\":\"This endpoint returns the current Mark price for specified margin trading pairs.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getMarkPriceDetail\",\"sdk-method-description\":\"This endpoint returns the current Mark price for specified margin trading pairs.\",\"api-rate-limit-weight\":2}" } }, { @@ -19602,19 +20425,19 @@ }, "symbolName": { "type": "string", - "description": "symbol name" + "description": "Symbol name" }, "baseCurrency": { "type": "string", - "description": "Base currency,e.g. BTC." + "description": "Base currency, e.g. BTC." }, "quoteCurrency": { "type": "string", - "description": "Quote currency,e.g. USDT." + "description": "Quote currency, e.g. USDT." }, "maxLeverage": { "type": "integer", - "description": "Max leverage of this symbol" + "description": "Max. leverage of this symbol" }, "flDebtRatio": { "type": "string" @@ -19692,7 +20515,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint allows querying the configuration of isolated margin symbol.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getIsolatedMarginSymbols\",\"sdk-method-description\":\"This endpoint allows querying the configuration of isolated margin symbol.\",\"api-rate-limit\":3}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getIsolatedMarginSymbols\",\"sdk-method-description\":\"This endpoint allows querying the configuration of isolated margin symbol.\",\"api-rate-limit-weight\":3}" } } ] @@ -19731,11 +20554,11 @@ "properties": { "orderId": { "type": "string", - "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." + "description": "The unique order ID generated by the trading system, which can be used later for further actions such as canceling the order." }, "loanApplyId": { "type": "string", - "description": "Borrow order id. The field is returned only after placing the order under the mode of Auto-Borrow." + "description": "Borrow order ID. The field is returned only after placing the order under the mode of Auto-Borrow." }, "borrowSize": { "type": "string", @@ -19743,7 +20566,7 @@ }, "clientOid": { "type": "string", - "description": "The user self-defined order id." + "description": "The user self-defined order ID." } }, "required": [ @@ -19780,14 +20603,14 @@ "properties": { "clientOid": { "type": "string", - "description": "Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.\n\nPlease remember the orderId created by the service provider, it used to check for updates in order status.", + "description": "Client Order ID: The ClientOid field is a unique ID created by the user (we recommend using a UUID), and can only contain numbers, letters, underscores (_), and hyphens (-). This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.\n\nPlease remember the orderId created by the service provider, it used to check for updates in order status.", "examples": [ "5c52e11203aa677f33e493fb" ] }, "side": { "type": "string", - "description": "specify if the order is to 'buy' or 'sell'", + "description": "Specify if the order is to 'buy' or 'sell'.", "enum": [ "buy", "sell" @@ -19819,7 +20642,7 @@ }, "type": { "type": "string", - "description": "specify if the order is an 'limit' order or 'market' order. \n\nThe type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.\n\nWhen placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.\n\nUnlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged.", + "description": "Specify if the order is a 'limit' order or 'market' order. \n\nThe type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.\n\nWhen placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.\n\nUnlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price; you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged.", "enum": [ "limit", "market" @@ -19876,7 +20699,7 @@ }, "size": { "type": "string", - "description": "Specify quantity for order\n\nWhen **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.\n\nWhen **type** is market, select one out of two: size or funds" + "description": "Specify quantity for order.\n\nWhen **type** is limited, size refers to the amount of trading targets (the asset name written in front) for the trading pair. The Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.\n\nWhen **type** is market, select one out of two: size or funds" }, "timeInForce": { "type": "string", @@ -19933,7 +20756,7 @@ "cancelAfter": { "type": "integer", "format": "int64", - "description": "Cancel after n seconds，the order timing strategy is GTT" + "description": "Cancel after n seconds, the order timing strategy is GTT" }, "funds": { "type": "string", @@ -19941,7 +20764,7 @@ }, "isIsolated": { "type": "boolean", - "description": "true - isolated margin ,false - cross margin. defult as false", + "description": "True - isolated margin; false - cross margin. Default is false", "default": false }, "autoBorrow": { @@ -19951,7 +20774,7 @@ }, "autoRepay": { "type": "boolean", - "description": "AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount.", + "description": "AutoPay allows the return of borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount.", "default": false } }, @@ -19964,8 +20787,8 @@ "example": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", "mediaType": "" }, - "description": ":::info[Description]\nPlace order to the Cross-margin or Isolated-margin trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | Yes | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| side | String | Yes | `buy` or `sell` |\n| type | String | No | Order type `limit` and `market`, defult is limit |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| isIsolated | boolean | No | true - isolated margin ,false - cross margin. defult as false |\n| autoBorrow | boolean | No | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | No | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrder\",\"sdk-method-description\":\"Place order to the Cross-margin or Isolated-margin trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nPlace order in the Cross-margin or Isolated-margin trading system. You can place two major types of order: Limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | Yes | Client Order ID, unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| side | String | Yes | ‘buy’ or ‘sell’ |\n| type | String | No | Order type ‘limit’ and ‘market’, default is limit |\n| stp | String | No | self trade prevention is divided into four strategies: ‘CN’, ‘CO’, ‘CB’, and ‘DC’ |\n| isIsolated | boolean | No | true - isolated margin, false - cross margin. Default is false |\n| autoBorrow | boolean | No | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | No | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n\n**Additional Request Parameters Required by ‘limit’ Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy ‘GTC’, ‘GTT’, ‘IOC’, ‘FOK’ (the default is ‘GTC’) |\n| cancelAfter | long | No | Cancel after ‘n’ seconds, the order timing strategy is ‘GTT’ |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is ‘IOC’ or ‘FOK’ |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by ‘market’ orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: ‘size’ or ‘funds’) |\n| funds | String | No | (Select one out of two: ‘size’ or ‘funds’) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or canceled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled (already canceled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID (orderId) and client ID (clientOid) to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value (the threshold value can be obtained using the symbol API endpoint);\n\n- If it is exceeded, for limit orders, the order will be directly canceled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: If the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: This feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrder\",\"sdk-method-description\":\"Place order in the Cross-margin or Isolated-margin trading system. You can place two major types of order: Limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\",\"api-rate-limit-weight\":5}" } }, { @@ -19997,7 +20820,7 @@ "properties": { "orderId": { "type": "string", - "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." + "description": "The unique order ID generated by the trading system, which can be used later for further actions such as canceling the order." }, "loanApplyId": { "type": "string", @@ -20009,7 +20832,7 @@ }, "clientOid": { "type": "string", - "description": "The user self-defined order id." + "description": "The user self-defined order ID." } }, "required": [ @@ -20046,14 +20869,14 @@ "properties": { "clientOid": { "type": "string", - "description": "Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.\n\nPlease remember the orderId created by the service provider, it used to check for updates in order status.", + "description": "Client Order ID: The ClientOid field is a unique ID created by the user (we recommend using a UUID), and can only contain numbers, letters, underscores (_), and hyphens (-). This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.\n\nPlease remember the orderId created by the service provider, it used to check for updates in order status.", "examples": [ "5c52e11203aa677f33e493fb" ] }, "side": { "type": "string", - "description": "specify if the order is to 'buy' or 'sell'", + "description": "Specify if the order is to 'buy' or 'sell'.", "enum": [ "buy", "sell" @@ -20085,7 +20908,7 @@ }, "type": { "type": "string", - "description": "specify if the order is an 'limit' order or 'market' order. \n\nThe type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.\n\nWhen placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.\n\nUnlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged.", + "description": "Specify if the order is a 'limit' order or 'market' order. \n\nThe type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.\n\nWhen placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.\n\nUnlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price; you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged.", "enum": [ "limit", "market" @@ -20142,7 +20965,7 @@ }, "size": { "type": "string", - "description": "Specify quantity for order\n\nWhen **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.\n\nWhen **type** is market, select one out of two: size or funds" + "description": "Specify quantity for order.\n\nWhen **type** is limited, size refers to the amount of trading targets (the asset name written in front) for the trading pair. The Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.\n\nWhen **type** is market, select one out of two: size or funds" }, "timeInForce": { "type": "string", @@ -20199,7 +21022,7 @@ "cancelAfter": { "type": "integer", "format": "int64", - "description": "Cancel after n seconds，the order timing strategy is GTT" + "description": "Cancel after n seconds, the order timing strategy is GTT" }, "funds": { "type": "string", @@ -20207,7 +21030,7 @@ }, "isIsolated": { "type": "boolean", - "description": "true - isolated margin ,false - cross margin. defult as false", + "description": "True - isolated margin; false - cross margin. Default is false", "default": false }, "autoBorrow": { @@ -20217,7 +21040,7 @@ }, "autoRepay": { "type": "boolean", - "description": "AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount.", + "description": "AutoPay allows the return of borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount.", "default": false } }, @@ -20230,8 +21053,8 @@ "example": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", "mediaType": "" }, - "description": ":::info[Description]\nOrder test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | Yes | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| side | String | Yes | `buy` or `sell` |\n| type | String | No | Order type `limit` and `market`, defult is limit |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| isIsolated | boolean | No | true - isolated margin ,false - cross margin. defult as false |\n| autoBorrow | boolean | No | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | No | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrderTest\",\"sdk-method-description\":\" Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nOrder test endpoint: This endpoint’s request and return parameters are identical to the order endpoint, and can be used to verify whether the signature is correct, among other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | Yes | Client Order ID, unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| side | String | Yes | ‘buy’ or ‘sell’ |\n| type | String | No | Order type ‘limit’ and ‘market’, default is limit |\n| stp | String | No | self trade prevention is divided into four strategies: ‘CN’, ‘CO’, ‘CB’, and ‘DC’ |\n| isIsolated | boolean | No | true - isolated margin, false - cross margin. Default is false |\n| autoBorrow | boolean | No | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | No | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n\n**Additional Request Parameters Required by ‘limit’ Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy ‘GTC’, ‘GTT’, ‘IOC’, ‘FOK’ (the default is ‘GTC’) |\n| cancelAfter | long | No | Cancel after ‘n’ seconds, the order timing strategy is ‘GTT’ |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is ‘IOC’ or ‘FOK’ |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by ‘market’ orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: ‘size’ or ‘funds’) |\n| funds | String | No | (Select one out of two: ‘size’ or ‘funds’) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or canceled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled (already canceled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID (orderId) and client ID (clientOid) to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value (the threshold value can be obtained using the symbol API endpoint);\n\n- If it is exceeded, for limit orders, the order will be directly canceled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: If the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: This feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrderTest\",\"sdk-method-description\":\" Order test endpoint: This endpoint’s request and return parameters are identical to the order endpoint, and can be used to verify whether the signature is correct, among other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\",\"api-rate-limit-weight\":5}" } }, { @@ -20241,16 +21064,6 @@ "method": "delete", "path": "/api/v3/hf/margin/orders/{orderId}", "parameters": { - "path": [ - { - "id": "orderId#0", - "name": "orderId", - "required": true, - "description": "The unique order id generated by the trading system", - "example": "671663e02188630007e21c9c", - "type": "string" - } - ], "query": [ { "id": "KXIxHhD4qw", @@ -20266,7 +21079,19 @@ "ETH-USDT", "KCS-USDT" ] - } + }, + "enable": true + } + ], + "path": [ + { + "id": "orderId#0", + "name": "orderId", + "required": true, + "description": "The unique order id generated by the trading system", + "example": "671663e02188630007e21c9c", + "type": "string", + "enable": true } ], "cookie": [], @@ -20289,7 +21114,7 @@ "properties": { "orderId": { "type": "string", - "description": "order id" + "description": "Order id" } }, "required": [ @@ -20325,8 +21150,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can be used to cancel a margin order by orderId.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to cancel a margin order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis endpoint can be used to cancel a margin order by orderId.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to Websocket.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to cancel a margin order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to Websocket.\",\"api-rate-limit-weight\":5}" } }, { @@ -20336,16 +21161,6 @@ "method": "delete", "path": "/api/v3/hf/margin/orders/client-order/{clientOid}", "parameters": { - "path": [ - { - "id": "clientOid#0", - "name": "clientOid", - "required": true, - "description": "Client Order Id，unique identifier created by the user", - "example": "5c52e11203aa677f33e1493fb", - "type": "string" - } - ], "query": [ { "id": "KXIxHhD4qw", @@ -20361,7 +21176,19 @@ "ETH-USDT", "KCS-USDT" ] - } + }, + "enable": true + } + ], + "path": [ + { + "id": "clientOid#0", + "name": "clientOid", + "required": true, + "description": "Client Order Id, unique identifier created by the user", + "example": "5c52e11203aa677f33e1493fb", + "type": "string", + "enable": true } ], "cookie": [], @@ -20384,7 +21211,7 @@ "properties": { "clientOid": { "type": "string", - "description": "Client Order Id，unique identifier created by the user" + "description": "Client Order Id, unique identifier created by the user" } }, "required": [ @@ -20420,8 +21247,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can be used to cancel a margin order by clientOid.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByClientOid\",\"sdk-method-description\":\"This endpoint can be used to cancel a margin order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis endpoint can be used to cancel a margin order by clientOid.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to Websocket.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByClientOid\",\"sdk-method-description\":\"This endpoint can be used to cancel a margin order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to Websocket.\",\"api-rate-limit-weight\":5}" } }, { @@ -20431,7 +21258,6 @@ "method": "delete", "path": "/api/v3/hf/margin/orders", "parameters": { - "path": [], "query": [ { "id": "KXIxHhD4qw", @@ -20447,7 +21273,8 @@ "ETH-USDT", "KCS-USDT" ] - } + }, + "enable": true }, { "id": "diFMZqfTZb", @@ -20474,9 +21301,11 @@ "description": "" } ] - } + }, + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -20524,8 +21353,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis interface can cancel all open Margin orders by symbol\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllOrdersBySymbol\",\"sdk-method-description\":\"This interface can cancel all open Margin orders by symbol This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\",\"api-rate-limit\":10}" + "description": ":::info[Description]\nThis interface can cancel all open Margin orders by symbol.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to Websocket.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllOrdersBySymbol\",\"sdk-method-description\":\"This interface can cancel all open Margin orders by symbol. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to Websocket.\",\"api-rate-limit-weight\":10}" } }, { @@ -20629,8 +21458,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis interface can query all Margin symbol that has active orders\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getSymbolsWithOpenOrder\",\"sdk-method-description\":\"This interface can query all Margin symbol that has active orders\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nThis interface can query all Margin symbols that have active orders.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getSymbolsWithOpenOrder\",\"sdk-method-description\":\"This interface can query all Margin symbols that have active orders.\"}" } }, { @@ -20726,7 +21555,7 @@ }, "type": { "type": "string", - "description": "Specify if the order is an 'limit' order or 'market' order. ", + "description": "Specify if the order is a 'limit' order or 'market' order. ", "enum": [ "limit", "market" @@ -20766,11 +21595,11 @@ }, "price": { "type": "string", - "description": "Order price" + "description": "Order Price" }, "size": { "type": "string", - "description": "Order size" + "description": "Order Size" }, "funds": { "type": "string", @@ -20786,11 +21615,11 @@ }, "fee": { "type": "string", - "description": "trading fee" + "description": "Trading fee" }, "feeCurrency": { "type": "string", - "description": "currency used to calculate trading fee" + "description": "Currency used to calculate trading fee" }, "stp": { "type": "string", @@ -20867,15 +21696,15 @@ }, "postOnly": { "type": "boolean", - "description": "Whether its a postOnly order." + "description": "Whether it’s a postOnly order." }, "hidden": { "type": "boolean", - "description": "Whether its a hidden order." + "description": "Whether it’s a hidden order." }, "iceberg": { "type": "boolean", - "description": "Whether its a iceberg order." + "description": "Whether it’s a iceberg order." }, "visibleSize": { "type": "string", @@ -20890,7 +21719,7 @@ }, "clientOid": { "type": "string", - "description": "Client Order Id，unique identifier created by the user" + "description": "Client Order Id, unique identifier created by the user" }, "remark": { "type": "string", @@ -20918,7 +21747,7 @@ }, "inOrderBook": { "type": "boolean", - "description": "Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook" + "description": "Whether to enter the orderbook: True: enter the orderbook; False: do not enter the orderbook" }, "cancelledSize": { "type": "string", @@ -20938,11 +21767,11 @@ }, "tax": { "type": "string", - "description": "Users in some regions need query this field" + "description": "Users in some regions have this field" }, "active": { "type": "boolean", - "description": "Order status: true-The status of the order isactive; false-The status of the order is done" + "description": "Order status: true-The status of the order is active; false-The status of the order is done" } }, "required": [ @@ -20975,10 +21804,10 @@ "cancelledFunds", "remainSize", "remainFunds", - "tax", "active", "createdAt", - "lastUpdatedAt" + "lastUpdatedAt", + "tax" ] } } @@ -21011,8 +21840,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis interface is to obtain all Margin active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nFor high-frequency trading users, we recommend locally caching, maintaining your own order records, and using market data streams to update your order information in real time.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOpenOrders\",\"sdk-method-description\":\"This interface is to obtain all Margin active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit\":4}" + "description": ":::info[Description]\nThis interface is to obtain all Margin active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.\n\nAfter the user successfully places an order, the order is in the Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nFor high-frequency trading users, we recommend caching locally, maintaining your own order records, and using market data streams to update your order information in real time.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOpenOrders\",\"sdk-method-description\":\"This interface is to obtain all Margin active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in the Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit-weight\":4}" } }, { @@ -21072,7 +21901,7 @@ "id": "sTtMCE9Jhf", "name": "side", "required": false, - "description": "specify if the order is to 'buy' or 'sell'", + "description": "Specify if the order is to 'buy' or 'sell'.", "type": "string", "schema": { "type": "string", @@ -21099,7 +21928,7 @@ "id": "QaBSxyasEm", "name": "type", "required": false, - "description": "specify if the order is an 'limit' order or 'market' order. ", + "description": "Specify if the order is a 'limit' order or 'market' order. ", "type": "string", "schema": { "type": "string", @@ -21126,7 +21955,7 @@ "id": "kkvuIGVxs6", "name": "lastId", "required": false, - "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page.", + "description": "The ID of the last set of data from the previous data batch. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId, which can be used as a query parameter to look up new data from the next page.", "example": "254062248624417", "type": "integer", "schema": { @@ -21139,7 +21968,7 @@ "id": "heQ8W6yKwm", "name": "limit", "required": false, - "description": "Default20，Max100", + "description": "Default20, Max100", "example": "20", "type": "integer", "schema": { @@ -21154,7 +21983,7 @@ "id": "Djtx6oC9gm", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "example": "1728663338000", "type": "integer", "schema": { @@ -21167,7 +21996,7 @@ "id": "K9IMpKw8u2", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "example": "1728692138000", "type": "integer", "schema": { @@ -21198,7 +22027,7 @@ "properties": { "lastId": { "type": "integer", - "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page.", + "description": "The ID of the last set of data from the previous data batch. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId, which can be used as a query parameter to look up new data from the next page.", "format": "int64" }, "items": { @@ -21224,7 +22053,7 @@ }, "type": { "type": "string", - "description": "Specify if the order is an 'limit' order or 'market' order. ", + "description": "Specify if the order is a 'limit' order or 'market' order. ", "enum": [ "limit", "market" @@ -21248,11 +22077,11 @@ }, "price": { "type": "string", - "description": "Order price" + "description": "Order Price" }, "size": { "type": "string", - "description": "Order size" + "description": "Order Size" }, "funds": { "type": "string", @@ -21272,7 +22101,7 @@ }, "feeCurrency": { "type": "string", - "description": "currency used to calculate trading fee" + "description": "Currency used to calculate trading fee" }, "stp": { "type": "string", @@ -21349,15 +22178,15 @@ }, "postOnly": { "type": "boolean", - "description": "Whether its a postOnly order." + "description": "Whether it’s a postOnly order." }, "hidden": { "type": "boolean", - "description": "Whether its a hidden order." + "description": "Whether it’s a hidden order." }, "iceberg": { "type": "boolean", - "description": "Whether its a iceberg order." + "description": "Whether it’s a iceberg order." }, "visibleSize": { "type": "string", @@ -21372,7 +22201,7 @@ }, "clientOid": { "type": "string", - "description": "Client Order Id，unique identifier created by the user" + "description": "Client Order Id, unique identifier created by the user" }, "remark": { "type": "string", @@ -21400,7 +22229,7 @@ }, "inOrderBook": { "type": "boolean", - "description": "Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook" + "description": "Whether to enter the orderbook: True: enter the orderbook; False: do not enter the orderbook" }, "cancelledSize": { "type": "string", @@ -21420,11 +22249,11 @@ }, "tax": { "type": "string", - "description": "Users in some regions need query this field" + "description": "Users in some regions have this field" }, "active": { "type": "boolean", - "description": "Order status: true-The status of the order isactive; false-The status of the order is done" + "description": "Order status: true-The status of the order is active; false-The status of the order is done" } }, "required": [ @@ -21499,8 +22328,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis interface is to obtain all Margin Closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getClosedOrders\",\"sdk-method-description\":\"This interface is to obtain all Margin closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit\":10}" + "description": ":::info[Description]\nThis interface is to obtain all Margin Closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.\n\nAfter the user successfully places an order, the order is in the Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 * 24 hours (i.e.: from the current time to 3 * 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getClosedOrders\",\"sdk-method-description\":\"This interface is to obtain all Margin closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in the Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit-weight\":10}" } }, { @@ -21560,7 +22389,7 @@ "id": "Bc6ZDrZFdp", "name": "orderId", "required": false, - "description": "The unique order id generated by the trading system\n(If orderId is specified，please ignore the other query parameters)", + "description": "The unique order id generated by the trading system\n(If orderId is specified, please ignore the other query parameters)", "type": "string", "enable": true }, @@ -21568,7 +22397,7 @@ "id": "sTtMCE9Jhf", "name": "side", "required": false, - "description": "specify if the order is to 'buy' or 'sell'", + "description": "Specify if the order is to 'buy' or 'sell'.", "type": "string", "schema": { "type": "string", @@ -21595,7 +22424,7 @@ "id": "QaBSxyasEm", "name": "type", "required": false, - "description": "specify if the order is an 'limit' order or 'market' order. ", + "description": "Specify if the order is a 'limit' order or 'market' order. ", "type": "string", "schema": { "type": "string", @@ -21622,7 +22451,7 @@ "id": "kkvuIGVxs6", "name": "lastId", "required": false, - "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page.", + "description": "The ID of the last set of data from the previous data batch. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId, which can be used as a query parameter to look up new data from the next page.", "example": "254062248624417", "type": "integer", "schema": { @@ -21635,14 +22464,14 @@ "id": "heQ8W6yKwm", "name": "limit", "required": false, - "description": "Default100，Max200", + "description": "Default20, Max100", "example": "100", "type": "integer", "schema": { "type": "integer", "default": 20, "minimum": 1, - "maximum": 200 + "maximum": 100 }, "enable": true }, @@ -21650,7 +22479,7 @@ "id": "Djtx6oC9gm", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "example": "1728663338000", "type": "integer", "schema": { @@ -21663,7 +22492,7 @@ "id": "K9IMpKw8u2", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "example": "1728692138000", "type": "integer", "schema": { @@ -21699,7 +22528,7 @@ "properties": { "id": { "type": "integer", - "description": "Id of transaction detail", + "description": "ID of transaction detail", "format": "int64" }, "symbol": { @@ -21713,7 +22542,7 @@ }, "tradeId": { "type": "integer", - "description": "Trade Id, symbol latitude increment", + "description": "Trade ID, symbol latitude increment", "format": "int64" }, "orderId": { @@ -21722,7 +22551,7 @@ }, "counterOrderId": { "type": "string", - "description": "Counterparty order Id" + "description": "Counterparty order ID" }, "side": { "type": "string", @@ -21769,11 +22598,11 @@ }, "price": { "type": "string", - "description": "Order price" + "description": "Order Price" }, "size": { "type": "string", - "description": "Order size" + "description": "Order Size" }, "funds": { "type": "string", @@ -21789,7 +22618,7 @@ }, "feeCurrency": { "type": "string", - "description": "currency used to calculate trading fee" + "description": "Currency used to calculate trading fee" }, "stop": { "type": "string", @@ -21801,15 +22630,15 @@ }, "tax": { "type": "string", - "description": "Users in some regions need query this field" + "description": "Users in some regions have this field" }, "taxRate": { "type": "string", - "description": "Tax Rate, Users in some regions need query this field" + "description": "Tax Rate: Users in some regions must query this field" }, "type": { "type": "string", - "description": "Specify if the order is an 'limit' order or 'market' order. ", + "description": "Specify if the order is a 'limit' order or 'market' order. ", "enum": [ "limit", "market" @@ -21858,7 +22687,7 @@ }, "lastId": { "type": "integer", - "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page.", + "description": "The ID of the last set of data from the previous data batch. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId, which can be used as a query parameter to look up new data from the next page.", "format": "int64" } }, @@ -21896,8 +22725,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can be used to obtain a list of the latest Margin transaction details. \nThe returned data is sorted in descending order according to the latest update time of the order.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getTradeHistory\",\"sdk-method-description\":\"This endpoint can be used to obtain a list of the latest Margin transaction details. The returned data is sorted in descending order according to the latest update time of the order.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis endpoint can be used to obtain a list of the latest Margin transaction details. \nThe returned data is sorted in descending order according to the latest update time of the order.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 * 24 hours (i.e.: from the current time to 3 * 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getTradeHistory\",\"sdk-method-description\":\"This endpoint can be used to obtain a list of the latest Margin transaction details. The returned data is sorted in descending order according to the latest update time of the order.\",\"api-rate-limit-weight\":5}" } }, { @@ -21973,7 +22802,7 @@ }, "type": { "type": "string", - "description": "Specify if the order is an 'limit' order or 'market' order. ", + "description": "Specify if the order is a 'limit' order or 'market' order. ", "enum": [ "limit", "market" @@ -22013,11 +22842,11 @@ }, "price": { "type": "string", - "description": "Order price" + "description": "Order Price" }, "size": { "type": "string", - "description": "Order size" + "description": "Order Size" }, "funds": { "type": "string", @@ -22037,7 +22866,7 @@ }, "feeCurrency": { "type": "string", - "description": "currency used to calculate trading fee" + "description": "Currency used to calculate trading fee" }, "stp": { "type": "string", @@ -22114,15 +22943,15 @@ }, "postOnly": { "type": "boolean", - "description": "Whether its a postOnly order." + "description": "Whether it’s a postOnly order." }, "hidden": { "type": "boolean", - "description": "Whether its a hidden order." + "description": "Whether it’s a hidden order." }, "iceberg": { "type": "boolean", - "description": "Whether its a iceberg order." + "description": "Whether it’s a iceberg order." }, "visibleSize": { "type": "string", @@ -22137,7 +22966,7 @@ }, "clientOid": { "type": "string", - "description": "Client Order Id，unique identifier created by the user" + "description": "Client Order Id, unique identifier created by the user" }, "remark": { "type": "string", @@ -22165,7 +22994,7 @@ }, "inOrderBook": { "type": "boolean", - "description": "Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook" + "description": "Whether to enter the orderbook: True: enter the orderbook; False: do not enter the orderbook" }, "cancelledSize": { "type": "string", @@ -22185,11 +23014,11 @@ }, "tax": { "type": "string", - "description": "Users in some regions need query this field" + "description": "Users in some regions have this field" }, "active": { "type": "boolean", - "description": "Order status: true-The status of the order isactive; false-The status of the order is done" + "description": "Order status: true-The status of the order is active; false-The status of the order is done" } }, "required": [ @@ -22258,8 +23087,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can be used to obtain information for a single Margin order using the order id.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to obtain information for a single Margin order using the order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis endpoint can be used to obtain information for a single Margin order using the order ID.\n\nAfter the user successfully places an order, the order is in the Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 * 24 hours (i.e.: from the current time to 3 * 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByOrderId\",\"sdk-method-description\":\"This endpoint can be used to obtain information for a single Margin order using the order ID. After the user successfully places an order, the order is in the Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit-weight\":5}" } }, { @@ -22293,7 +23122,7 @@ "id": "clientOid#0", "name": "clientOid", "required": true, - "description": "Client Order Id，unique identifier created by the user", + "description": "Client Order Id, unique identifier created by the user", "example": "5c52e11203aa677f33e493fb", "type": "string", "enable": true @@ -22335,7 +23164,7 @@ }, "type": { "type": "string", - "description": "Specify if the order is an 'limit' order or 'market' order. ", + "description": "Specify if the order is a 'limit' order or 'market' order. ", "enum": [ "limit", "market" @@ -22375,11 +23204,11 @@ }, "price": { "type": "string", - "description": "Order price" + "description": "Order Price" }, "size": { "type": "string", - "description": "Order size" + "description": "Order Size" }, "funds": { "type": "string", @@ -22399,7 +23228,7 @@ }, "feeCurrency": { "type": "string", - "description": "currency used to calculate trading fee" + "description": "Currency used to calculate trading fee" }, "stp": { "type": "string", @@ -22476,15 +23305,15 @@ }, "postOnly": { "type": "boolean", - "description": "Whether its a postOnly order." + "description": "Whether it’s a postOnly order." }, "hidden": { "type": "boolean", - "description": "Whether its a hidden order." + "description": "Whether it’s a hidden order." }, "iceberg": { "type": "boolean", - "description": "Whether its a iceberg order." + "description": "Whether it’s a iceberg order." }, "visibleSize": { "type": "string", @@ -22499,7 +23328,7 @@ }, "clientOid": { "type": "string", - "description": "Client Order Id，unique identifier created by the user" + "description": "Client Order Id, unique identifier created by the user" }, "remark": { "type": "string", @@ -22527,7 +23356,7 @@ }, "inOrderBook": { "type": "boolean", - "description": "Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook" + "description": "Whether to enter the orderbook: True: enter the orderbook; False: do not enter the orderbook" }, "cancelledSize": { "type": "string", @@ -22547,11 +23376,11 @@ }, "tax": { "type": "string", - "description": "Users in some regions need query this field" + "description": "Users in some regions have this field" }, "active": { "type": "boolean", - "description": "Order status: true-The status of the order isactive; false-The status of the order is done" + "description": "Order status: true-The status of the order is active; false-The status of the order is done" } }, "required": [ @@ -22619,8 +23448,8 @@ "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can be used to obtain information for a single Margin order using the client order id.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByClientOid\",\"sdk-method-description\":\"This endpoint can be used to obtain information for a single Margin order using the client order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis endpoint can be used to obtain information for a single Margin order using the client order ID.\n\nAfter the user successfully places an order, the order is in the Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 * 24 hours (i.e.: from the current time to 3 * 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByClientOid\",\"sdk-method-description\":\"This endpoint can be used to obtain information for a single Margin order using the client order ID. After the user successfully places an order, the order is in the Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\",\"api-rate-limit-weight\":5}" } } ] @@ -22637,8 +23466,8 @@ "method": "post", "path": "/api/v3/margin/borrow", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -22659,7 +23488,7 @@ "properties": { "orderNo": { "type": "string", - "description": "Borrow Order Id" + "description": "Borrow Order ID" }, "actualSize": { "type": "string", @@ -22759,7 +23588,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis API endpoint is used to initiate an application for cross or isolated margin borrowing.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"borrow\",\"sdk-method-description\":\"This API endpoint is used to initiate an application for cross or isolated margin borrowing.\",\"api-rate-limit\":15}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"borrow\",\"sdk-method-description\":\"This API endpoint is used to initiate an application for cross or isolated margin borrowing.\",\"api-rate-limit-weight\":15}" } }, { @@ -22818,7 +23647,7 @@ "id": "XPBAwDPLVp", "name": "orderNo", "required": false, - "description": "Borrow Order Id", + "description": "Borrow Order ID", "type": "string", "enable": true }, @@ -22910,7 +23739,7 @@ }, "totalPage": { "type": "integer", - "description": "total page" + "description": "total pages" }, "items": { "type": "array", @@ -22919,7 +23748,7 @@ "properties": { "orderNo": { "type": "string", - "description": "Borrow Order Id" + "description": "Borrow Order ID" }, "symbol": { "type": "string", @@ -22970,7 +23799,7 @@ }, "createdTime": { "type": "integer", - "description": "borrow time", + "description": "Borrow time", "format": "int64" } }, @@ -23024,8 +23853,8 @@ "example": "{\n \"currency\": \"USDT\",\n \"size\": 10,\n \"timeInForce\": \"FOK\",\n \"isIsolated\": false,\n \"isHf\": false\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis API endpoint is used to get the borrowing orders for cross and isolated margin accounts\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"getBorrowHistory\",\"sdk-method-description\":\"This API endpoint is used to get the borrowing orders for cross and isolated margin accounts\",\"api-rate-limit\":15}" + "description": ":::info[Description]\nThis API endpoint is used to get the borrowing orders for cross and isolated margin accounts.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"getBorrowHistory\",\"sdk-method-description\":\"This API endpoint is used to get the borrowing orders for cross and isolated margin accounts.\",\"api-rate-limit-weight\":15}" } }, { @@ -23061,7 +23890,7 @@ }, "orderNo": { "type": "string", - "description": "Repay Order Id" + "description": "Repay order ID" }, "actualSize": { "type": "string", @@ -23141,7 +23970,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis API endpoint is used to initiate an application for cross or isolated margin repayment.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"repay\",\"sdk-method-description\":\"This API endpoint is used to initiate an application for cross or isolated margin repayment.\",\"api-rate-limit\":10}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"repay\",\"sdk-method-description\":\"This API endpoint is used to initiate an application for cross or isolated margin repayment.\",\"api-rate-limit-weight\":10}" } }, { @@ -23200,7 +24029,7 @@ "id": "XPBAwDPLVp", "name": "orderNo", "required": false, - "description": "Repay Order Id", + "description": "Repay order ID", "type": "string", "enable": true }, @@ -23292,7 +24121,7 @@ }, "totalPage": { "type": "integer", - "description": "total page" + "description": "total pages" }, "items": { "type": "array", @@ -23301,7 +24130,7 @@ "properties": { "orderNo": { "type": "string", - "description": "Repay Order Id" + "description": "Repay order ID" }, "symbol": { "type": "string", @@ -23406,12 +24235,12 @@ "example": "{\n \"currency\": \"USDT\",\n \"size\": 10,\n \"timeInForce\": \"FOK\",\n \"isIsolated\": false,\n \"isHf\": false\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis API endpoint is used to get the repayment orders for cross and isolated margin accounts\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"getRepayHistory\",\"sdk-method-description\":\"This API endpoint is used to get the borrowing orders for cross and isolated margin accounts\",\"api-rate-limit\":15}" + "description": ":::info[Description]\nThis API endpoint is used to get the repayment orders for cross and isolated margin accounts.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"getRepayHistory\",\"sdk-method-description\":\"This API endpoint is used to get the borrowing orders for cross and isolated margin accounts.\",\"api-rate-limit-weight\":15}" } }, { - "name": "Get Interest History", + "name": "Get Interest History.", "api": { "id": "3470209", "method": "get", @@ -23550,7 +24379,7 @@ }, "totalPage": { "type": "integer", - "description": "total page" + "description": "total pages" }, "items": { "type": "array", @@ -23622,8 +24451,8 @@ "example": "{\n \"currency\": \"USDT\",\n \"size\": 10,\n \"timeInForce\": \"FOK\",\n \"isIsolated\": false,\n \"isHf\": false\n}", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the interest records of the cross/isolated margin lending.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"getInterestHistory\",\"sdk-method-description\":\"Request via this endpoint to get the interest records of the cross/isolated margin lending.\",\"api-rate-limit\":20}" + "description": ":::info[Description]\nRequest the interest records of the cross/isolated margin lending via this endpoint.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"getInterestHistory\",\"sdk-method-description\":\"Request the interest records of the cross/isolated margin lending via this endpoint.\",\"api-rate-limit-weight\":20}" } }, { @@ -23705,7 +24534,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis endpoint allows modifying the leverage multiplier for cross margin or isolated margin.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"modifyLeverage\",\"sdk-method-description\":\"This endpoint allows modifying the leverage multiplier for cross margin or isolated margin.\",\"api-rate-limit\":5}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Debit\",\"sdk-method-name\":\"modifyLeverage\",\"sdk-method-description\":\"This endpoint allows modifying the leverage multiplier for cross margin or isolated margin.\",\"api-rate-limit-weight\":8}" } } ] @@ -23722,7 +24551,6 @@ "method": "get", "path": "/api/v3/project/list", "parameters": { - "path": [], "query": [ { "id": "l1uItcOfv7", @@ -23737,9 +24565,11 @@ "ETH", "KCS" ] - } + }, + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -23803,7 +24633,7 @@ }, "autoPurchaseEnable": { "type": "boolean", - "description": "Whether to allow automatic purchase: true: on, false: off" + "description": "Whether to allow automatic purchase: True: on; false: off" } } } @@ -23838,7 +24668,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis API endpoint is used to get the information about the currencies available for lending.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"getLoanMarket\",\"sdk-method-description\":\"This API endpoint is used to get the information about the currencies available for lending.\",\"api-rate-limit\":10}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"getLoanMarket\",\"sdk-method-description\":\"This API endpoint is used to get the information about the currencies available for lending.\",\"api-rate-limit-weight\":10}" } }, { @@ -23933,7 +24763,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis API endpoint is used to get the interest rates of the margin lending market over the past 7 days.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"getLoanMarketInterestRate\",\"sdk-method-description\":\"This API endpoint is used to get the interest rates of the margin lending market over the past 7 days.\",\"api-rate-limit\":5}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"getLoanMarketInterestRate\",\"sdk-method-description\":\"This API endpoint is used to get the interest rates of the margin lending market over the past 7 days.\",\"api-rate-limit-weight\":5}" } }, { @@ -23943,8 +24773,8 @@ "method": "post", "path": "/api/v3/purchase", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -23965,7 +24795,7 @@ "properties": { "orderNo": { "type": "string", - "description": "Purchase order id" + "description": "Purchase order ID" } }, "required": [ @@ -24008,11 +24838,11 @@ }, "size": { "type": "string", - "description": "purchase amount" + "description": "Purchase amount" }, "interestRate": { "type": "string", - "description": "purchase interest rate" + "description": "Purchase interest rate" } }, "required": [ @@ -24024,8 +24854,8 @@ "example": "{\n \"currency\": \"BTC\",\n \"size\": \"0.001\",\n \"interestRate\": \"0.1\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nInvest credit in the market and earn interest,Please ensure that the funds are in the main(funding) account\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"purchase\",\"sdk-method-description\":\"Invest credit in the market and earn interest\",\"api-rate-limit\":15}" + "description": ":::info[Description]\nInvest credit in the market and earn interest. Please ensure that the funds are in the main (funding) account.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"purchase\",\"sdk-method-description\":\"Invest credit in the market and earn interest\",\"api-rate-limit-weight\":15}" } }, { @@ -24095,7 +24925,7 @@ }, "purchaseOrderNo": { "type": "string", - "description": "Purchase order id" + "description": "Purchase order ID" } }, "required": [ @@ -24107,8 +24937,8 @@ "example": "{\n \"currency\": \"BTC\",\n \"purchaseOrderNo\": \"671bafa804c26d000773c533\",\n \"interestRate\": \"0.09\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis API endpoint is used to update the interest rates of subscription orders, which will take effect at the beginning of the next hour.,Please ensure that the funds are in the main(funding) account\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"modifyPurchase\",\"sdk-method-description\":\"This API endpoint is used to update the interest rates of subscription orders, which will take effect at the beginning of the next hour.,Please ensure that the funds are in the main(funding) account\",\"api-rate-limit\":10}" + "description": ":::info[Description]\nThis API endpoint is used to update the interest rates of subscription orders, which will take effect at the beginning of the next hour. Please ensure that the funds are in the main (funding) account.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"modifyPurchase\",\"sdk-method-description\":\"This API endpoint is used to update the interest rates of subscription orders, which will take effect at the beginning of the next hour. Please ensure that the funds are in the main (funding) account.\",\"api-rate-limit-weight\":10}" } }, { @@ -24119,22 +24949,6 @@ "path": "/api/v3/purchase/orders", "parameters": { "query": [ - { - "id": "l1uItcOfv7", - "name": "currency", - "required": true, - "description": "currency", - "type": "string", - "schema": { - "type": "string", - "examples": [ - "BTC", - "ETH", - "KCS" - ] - }, - "enable": true - }, { "id": "7dLjr4E9vr", "name": "status", @@ -24150,23 +24964,39 @@ "x-api-enum": [ { "value": "DONE", - "name": "", - "description": "" + "name": "DONE", + "description": "completed" }, { "value": "PENDING", - "name": "", - "description": "" + "name": "PENDING", + "description": "settling" } ] }, "enable": true }, + { + "id": "l1uItcOfv7", + "name": "currency", + "required": false, + "description": "Currency", + "type": "string", + "schema": { + "type": "string", + "examples": [ + "BTC", + "ETH", + "KCS" + ] + }, + "enable": true + }, { "id": "NmPcuh0JUA", "name": "purchaseOrderNo", "required": false, - "description": "", + "description": "Purchase order ID", "type": "string", "enable": true }, @@ -24186,13 +25016,13 @@ "id": "tnMkpHjno4", "name": "pageSize", "required": false, - "description": "Page size; 1<=pageSize<=100; default is 50", + "description": "Page size; 1<=pageSize<=50; default is 50", "type": "integer", "schema": { "type": "integer", "default": 50, "minimum": 1, - "maximum": 100 + "maximum": 50 }, "enable": true } @@ -24230,7 +25060,7 @@ }, "totalPage": { "type": "integer", - "description": "Total Page" + "description": "Total Pages" }, "items": { "type": "array", @@ -24248,7 +25078,7 @@ }, "purchaseOrderNo": { "type": "string", - "description": "Purchase order id" + "description": "Purchase order ID" }, "purchaseSize": { "type": "string", @@ -24342,8 +25172,8 @@ "example": "{\n \"currency\": \"USDT\",\n \"size\": 10,\n \"timeInForce\": \"FOK\",\n \"isIsolated\": false,\n \"isHf\": false\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis API endpoint provides pagination query for the purchase orders.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"getPurchaseOrders\",\"sdk-method-description\":\"This API endpoint provides pagination query for the purchase orders.\",\"api-rate-limit\":10}" + "description": ":::info[Description]\nThis API endpoint provides a pagination query for the purchase orders.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"getPurchaseOrders\",\"sdk-method-description\":\"This API endpoint provides a pagination query for the purchase orders.\",\"api-rate-limit-weight\":10}" } }, { @@ -24353,8 +25183,8 @@ "method": "post", "path": "/api/v3/redeem", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -24375,7 +25205,7 @@ "properties": { "orderNo": { "type": "string", - "description": "Redeem order id" + "description": "Redeem order ID" } }, "required": [ @@ -24422,7 +25252,7 @@ }, "purchaseOrderNo": { "type": "string", - "description": "Purchase order id" + "description": "Purchase order ID" } }, "required": [ @@ -24434,8 +25264,8 @@ "example": "{\n \"currency\": \"BTC\",\n \"size\": \"0.001\",\n \"purchaseOrderNo\": \"671bafa804c26d000773c533\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nRedeem your loan order\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"redeem\",\"sdk-method-description\":\"Redeem your loan order\",\"api-rate-limit\":15}" + "description": ":::info[Description]\nRedeem your loan order.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Margin\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"redeem\",\"sdk-method-description\":\"Redeem your loan order.\",\"api-rate-limit-weight\":15}" } }, { @@ -24445,23 +25275,7 @@ "method": "get", "path": "/api/v3/redeem/orders", "parameters": { - "path": [], "query": [ - { - "id": "l1uItcOfv7", - "name": "currency", - "required": true, - "description": "currency", - "type": "string", - "schema": { - "type": "string", - "examples": [ - "BTC", - "ETH", - "KCS" - ] - } - }, { "id": "7dLjr4E9vr", "name": "status", @@ -24477,23 +25291,42 @@ "x-api-enum": [ { "value": "DONE", - "name": "", - "description": "" + "name": "DONE", + "description": "completed" }, { "value": "PENDING", - "name": "", - "description": "" + "name": "PENDING", + "description": "settling" } ] - } + }, + "enable": true, + "example": "DONE" + }, + { + "id": "l1uItcOfv7", + "name": "currency", + "required": false, + "description": "currency", + "type": "string", + "schema": { + "type": "string", + "examples": [ + "BTC", + "ETH", + "KCS" + ] + }, + "enable": true }, { "id": "NmPcuh0JUA", "name": "redeemOrderNo", "required": false, - "description": "Redeem order id", - "type": "string" + "description": "Redeem order ID", + "type": "string", + "enable": true }, { "id": "ocAreXZaqO", @@ -24504,22 +25337,25 @@ "schema": { "type": "integer", "default": 1 - } + }, + "enable": true }, { "id": "tnMkpHjno4", "name": "pageSize", "required": false, - "description": "Page size; 1<=pageSize<=100; default is 50", + "description": "Page size; 1<=pageSize<=50; default is 50", "type": "integer", "schema": { "type": "integer", "default": 50, "minimum": 1, - "maximum": 100 - } + "maximum": 50 + }, + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -24552,7 +25388,7 @@ }, "totalPage": { "type": "integer", - "description": "Total Page" + "description": "Total Pages" }, "items": { "type": "array", @@ -24570,11 +25406,11 @@ }, "purchaseOrderNo": { "type": "string", - "description": "Purchase order id" + "description": "Purchase order ID" }, "redeemOrderNo": { "type": "string", - "description": "Redeem order id" + "description": "Redeem order ID" }, "redeemSize": { "type": "string", @@ -24643,7 +25479,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis API endpoint provides pagination query for the redeem orders.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"getRedeemOrders\",\"sdk-method-description\":\"This API endpoint provides pagination query for the redeem orders.\",\"api-rate-limit\":10}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"Credit\",\"sdk-method-name\":\"getRedeemOrders\",\"sdk-method-description\":\"This API endpoint provides pagination query for the redeem orders.\",\"api-rate-limit-weight\":10}" } } ] @@ -24664,8 +25500,8 @@ { "id": "hdWkGjjrz0", "name": "isIsolated", - "required": true, - "description": "true-isolated, false-cross", + "required": false, + "description": "True-isolated, false-cross", "example": "false", "type": "boolean", "schema": { @@ -24677,7 +25513,7 @@ "id": "Xmh3RZA5nf", "name": "currency", "required": false, - "description": "currency, This field is only required for cross margin", + "description": "Currency: This field is only required for cross margin", "example": "BTC", "type": "string", "enable": true @@ -24686,7 +25522,7 @@ "id": "AGxfMGvIk6", "name": "symbol", "required": false, - "description": "symbol, This field is only required for isolated margin", + "description": "Symbol: This field is only required for isolated margin", "type": "string", "schema": { "type": "string", @@ -24751,7 +25587,7 @@ }, "precision": { "type": "integer", - "description": "CROSS MARGIN RESPONSES, Currency precision. the minimum repayment amount of a single transaction should be >= currency precision, for example, the precision of ETH is 8, and the minimum repayment amount is 0.00000001" + "description": "CROSS MARGIN RESPONSES, Currency precision. The minimum repayment amount of a single transaction should be >= currency precision. For example, the precision of ETH is 8, and the minimum repayment amount is 0.00000001" }, "borrowMinAmount": { "type": "string", @@ -24759,7 +25595,7 @@ }, "borrowMinUnit": { "type": "string", - "description": "CROSS MARGIN RESPONSES, Minimum unit for borrowing, the borrowed amount must be an integer multiple of this value" + "description": "CROSS MARGIN RESPONSES, Minimum unit for borrowing; the borrowed amount must be an integer multiple of this value" }, "borrowEnabled": { "type": "boolean", @@ -24795,11 +25631,11 @@ }, "basePrecision": { "type": "integer", - "description": "ISOLATED MARGIN RESPONSES, Base currency precision. the minimum repayment amount of a single transaction should be >= currency precision, for example, the precision of ETH is 8, and the minimum repayment amount is 0.00000001" + "description": "ISOLATED MARGIN RESPONSES, Base currency precision. The minimum repayment amount of a single transaction should be >= currency precision. For example, the precision of ETH is 8, and the minimum repayment amount is 0.00000001" }, "quotePrecision": { "type": "integer", - "description": "ISOLATED MARGIN RESPONSES, Quote currency precision. the minimum repayment amount of a single transaction should be >= currency precision, for example, the precision of ETH is 8, and the minimum repayment amount is 0.00000001\n" + "description": "ISOLATED MARGIN RESPONSES, Quote currency precision. The minimum repayment amount of a single transaction should be >= currency precision. For example, the precision of ETH is 8, and the minimum repayment amount is 0.00000001\n" }, "baseBorrowMinAmount": { "type": "string", @@ -24873,8 +25709,8 @@ "example": "{\n \"currency\": \"USDT\",\n \"size\": 10,\n \"timeInForce\": \"FOK\",\n \"isIsolated\": false,\n \"isHf\": false\n}", "mediaType": "" }, - "description": ":::info[Description]\nRequest via this endpoint to get the Configure and Risk limit info of the margin.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"RiskLimit\",\"sdk-method-name\":\"getMarginRiskLimit\",\"sdk-method-description\":\"Request via this endpoint to get the Configure and Risk limit info of the margin.\",\"api-rate-limit\":20}" + "description": ":::info[Description]\nRequest Configure and Risk limit info of the margin via this endpoint.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Spot\",\"sdk-service\":\"Margin\",\"sdk-sub-service\":\"RiskLimit\",\"sdk-method-name\":\"getMarginRiskLimit\",\"sdk-method-description\":\"Request Configure and Risk limit info of the margin via this endpoint.\",\"api-rate-limit-weight\":20}" } } ] @@ -24949,7 +25785,7 @@ }, "type": { "type": "string", - "description": "Type of the contract", + "description": "Type of contract", "enum": [ "FFWCSX", "FFICSX" @@ -24958,7 +25794,7 @@ { "value": "FFWCSX", "name": "FFWCSX", - "description": "Standardized swap contracts standard financial futures on swap, expiration swap funding rate" + "description": "Standardized swap contracts, standard financial futures on swaps, expiration swap funding rates" }, { "value": "FFICSX", @@ -24969,17 +25805,17 @@ }, "firstOpenDate": { "type": "integer", - "description": "First Open Date(millisecond)", + "description": "First Open Date (milliseconds)", "format": "int64" }, "expireDate": { "type": "integer", - "description": "Expiration date(millisecond). Null means it will never expire", + "description": "Expiration date (milliseconds) Null means it will never expire", "format": "int64" }, "settleDate": { "type": "integer", - "description": "Settlement date(millisecond). Null indicates that automatic settlement is not supported", + "description": "Settlement date (milliseconds) Null indicates that automatic settlement is not supported", "format": "int64" }, "baseCurrency": { @@ -25080,13 +25916,13 @@ { "value": "FairPrice", "name": "FairPrice", - "description": "Fair Price" + "description": "FairPrice" } ] }, "fairMethod": { "type": "string", - "description": "Fair price marking method, The Futures contract is null", + "description": "Fair price marking method; the Futures contract is null", "enum": [ "FundingRate" ], @@ -25100,7 +25936,7 @@ }, "fundingBaseSymbol": { "type": "string", - "description": "Ticker symbol of the based currency" + "description": "Ticker symbol of the base currency" }, "fundingQuoteSymbol": { "type": "string", @@ -25116,7 +25952,7 @@ }, "settlementSymbol": { "type": "string", - "description": "Settlement Symbol" + "description": "Settlement symbol" }, "status": { "type": "string", @@ -25144,7 +25980,7 @@ { "value": "BeingSettled", "name": "BeingSettled", - "description": "Setting" + "description": "Settling" }, { "value": "Settled", @@ -25178,11 +26014,11 @@ }, "fundingRateGranularity": { "type": "integer", - "description": "Funding interval(millisecond)" + "description": "Funding interval (milliseconds)" }, "openInterest": { "type": "string", - "description": "Open interest" + "description": "Open interest (unit: lots)" }, "turnoverOf24h": { "type": "number", @@ -25206,7 +26042,7 @@ }, "nextFundingRateTime": { "type": "integer", - "description": "Next funding rate time(millisecond)" + "description": "Next funding rate time (milliseconds)" }, "maxLeverage": { "type": "integer", @@ -25221,19 +26057,19 @@ }, "premiumsSymbol1M": { "type": "string", - "description": "Premium index symbol(1 minute)" + "description": "Premium index symbol (1 minute)" }, "premiumsSymbol8H": { "type": "string", - "description": "Premium index symbol(8 hours)" + "description": "Premium index symbol (8 hours)" }, "fundingBaseSymbol1M": { "type": "string", - "description": "Base currency interest rate symbol(1 minute)" + "description": "Base currency interest rate symbol (1 minute)" }, "fundingQuoteSymbol1M": { "type": "string", - "description": "Quote currency interest rate symbol(1 minute)" + "description": "Quote currency interest rate symbol (1 minute)" }, "lowPrice": { "type": "number", @@ -25245,7 +26081,7 @@ }, "priceChgPct": { "type": "number", - "description": "24-hour price change% " + "description": "24-hour % price change " }, "priceChg": { "type": "number", @@ -25269,6 +26105,14 @@ "supportCross": { "type": "boolean", "description": "Whether support Cross Margin" + }, + "buyLimit": { + "type": "number", + "description": "The current maximum allowed buying price" + }, + "sellLimit": { + "type": "number", + "description": "The current minimum allowed selling price" } }, "required": [ @@ -25333,7 +26177,9 @@ "f", "mmrLimit", "mmrLevConstant", - "supportCross" + "supportCross", + "buyLimit", + "sellLimit" ] } }, @@ -25350,7 +26196,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"XBTUSDM\",\n \"rootSymbol\": \"XBT\",\n \"type\": \"FFWCSX\",\n \"firstOpenDate\": 1552638575000,\n \"expireDate\": null,\n \"settleDate\": null,\n \"baseCurrency\": \"XBT\",\n \"quoteCurrency\": \"USD\",\n \"settleCurrency\": \"XBT\",\n \"maxOrderQty\": 10000000,\n \"maxPrice\": 1000000.0,\n \"lotSize\": 1,\n \"tickSize\": 0.1,\n \"indexPriceTickSize\": 0.1,\n \"multiplier\": -1.0,\n \"initialMargin\": 0.014,\n \"maintainMargin\": 0.007,\n \"maxRiskLimit\": 1,\n \"minRiskLimit\": 1,\n \"riskStep\": 0,\n \"makerFeeRate\": 2.0E-4,\n \"takerFeeRate\": 6.0E-4,\n \"takerFixFee\": 0.0,\n \"makerFixFee\": 0.0,\n \"settlementFee\": null,\n \"isDeleverage\": true,\n \"isQuanto\": false,\n \"isInverse\": true,\n \"markMethod\": \"FairPrice\",\n \"fairMethod\": \"FundingRate\",\n \"fundingBaseSymbol\": \".XBTINT8H\",\n \"fundingQuoteSymbol\": \".USDINT8H\",\n \"fundingRateSymbol\": \".XBTUSDMFPI8H\",\n \"indexSymbol\": \".BXBT\",\n \"settlementSymbol\": null,\n \"status\": \"Open\",\n \"fundingFeeRate\": 1.75E-4,\n \"predictedFundingFeeRate\": 1.76E-4,\n \"fundingRateGranularity\": 28800000,\n \"openInterest\": \"61725904\",\n \"turnoverOf24h\": 209.56303473,\n \"volumeOf24h\": 1.4354731E7,\n \"markPrice\": 68336.7,\n \"indexPrice\": 68335.29,\n \"lastTradePrice\": 68349.3,\n \"nextFundingRateTime\": 17402942,\n \"maxLeverage\": 75,\n \"sourceExchanges\": [\n \"kraken\",\n \"bitstamp\",\n \"crypto\"\n ],\n \"premiumsSymbol1M\": \".XBTUSDMPI\",\n \"premiumsSymbol8H\": \".XBTUSDMPI8H\",\n \"fundingBaseSymbol1M\": \".XBTINT\",\n \"fundingQuoteSymbol1M\": \".USDINT\",\n \"lowPrice\": 67436.7,\n \"highPrice\": 69471.8,\n \"priceChgPct\": 0.0097,\n \"priceChg\": 658.7,\n \"k\": 2645000.0,\n \"m\": 1640000.0,\n \"f\": 1.3,\n \"mmrLimit\": 0.3,\n \"mmrLevConstant\": 75.0,\n \"supportCross\": true\n }\n}", + "data": "{\r\n \"code\": \"200000\",\r\n \"data\": {\r\n \"symbol\": \"XBTUSDTM\",\r\n \"rootSymbol\": \"USDT\",\r\n \"type\": \"FFWCSX\",\r\n \"firstOpenDate\": 1585555200000,\r\n \"expireDate\": null,\r\n \"settleDate\": null,\r\n \"baseCurrency\": \"XBT\",\r\n \"quoteCurrency\": \"USDT\",\r\n \"settleCurrency\": \"USDT\",\r\n \"maxOrderQty\": 1000000,\r\n \"maxPrice\": 1000000.0,\r\n \"lotSize\": 1,\r\n \"tickSize\": 0.1,\r\n \"indexPriceTickSize\": 0.01,\r\n \"multiplier\": 0.001,\r\n \"initialMargin\": 0.008,\r\n \"maintainMargin\": 0.004,\r\n \"maxRiskLimit\": 100000,\r\n \"minRiskLimit\": 100000,\r\n \"riskStep\": 50000,\r\n \"makerFeeRate\": 2.0E-4,\r\n \"takerFeeRate\": 6.0E-4,\r\n \"takerFixFee\": 0.0,\r\n \"makerFixFee\": 0.0,\r\n \"settlementFee\": null,\r\n \"isDeleverage\": true,\r\n \"isQuanto\": true,\r\n \"isInverse\": false,\r\n \"markMethod\": \"FairPrice\",\r\n \"fairMethod\": \"FundingRate\",\r\n \"fundingBaseSymbol\": \".XBTINT8H\",\r\n \"fundingQuoteSymbol\": \".USDTINT8H\",\r\n \"fundingRateSymbol\": \".XBTUSDTMFPI8H\",\r\n \"indexSymbol\": \".KXBTUSDT\",\r\n \"settlementSymbol\": \"\",\r\n \"status\": \"Open\",\r\n \"fundingFeeRate\": 5.2E-5,\r\n \"predictedFundingFeeRate\": 8.3E-5,\r\n \"fundingRateGranularity\": 28800000,\r\n \"openInterest\": \"6748176\",\r\n \"turnoverOf24h\": 1.0346431983265533E9,\r\n \"volumeOf24h\": 12069.225,\r\n \"markPrice\": 86378.69,\r\n \"indexPrice\": 86382.64,\r\n \"lastTradePrice\": 86364,\r\n \"nextFundingRateTime\": 17752926,\r\n \"maxLeverage\": 125,\r\n \"sourceExchanges\": [\r\n \"okex\",\r\n \"binance\",\r\n \"kucoin\",\r\n \"bybit\",\r\n \"bitmart\",\r\n \"gateio\"\r\n ],\r\n \"premiumsSymbol1M\": \".XBTUSDTMPI\",\r\n \"premiumsSymbol8H\": \".XBTUSDTMPI8H\",\r\n \"fundingBaseSymbol1M\": \".XBTINT\",\r\n \"fundingQuoteSymbol1M\": \".USDTINT\",\r\n \"lowPrice\": 82205.2,\r\n \"highPrice\": 89299.9,\r\n \"priceChgPct\": -0.028,\r\n \"priceChg\": -2495.9,\r\n \"k\": 490.0,\r\n \"m\": 300.0,\r\n \"f\": 1.3,\r\n \"mmrLimit\": 0.3,\r\n \"mmrLevConstant\": 125.0,\r\n \"supportCross\": true,\r\n \"buyLimit\": 90700.7115,\r\n \"sellLimit\": 82062.5485\r\n }\r\n}", "responseId": 10385, "ordering": 1 } @@ -25360,8 +26206,8 @@ "parameters": [], "mediaType": "" }, - "description": ":::info[Description]\nGet information of specified contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getSymbol\",\"sdk-method-description\":\"Get information of specified contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nGet information of specified contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price, etc.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getSymbol\",\"sdk-method-description\":\"Get information of specified contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price, etc.\",\"api-rate-limit-weight\":3}" } }, { @@ -25414,7 +26260,7 @@ }, "type": { "type": "string", - "description": "Type of the contract", + "description": "Type of contract", "enum": [ "FFWCSX", "FFICSX" @@ -25423,7 +26269,7 @@ { "value": "FFWCSX", "name": "FFWCSX", - "description": "Standardized swap contracts standard financial futures on swap, expiration swap funding rate" + "description": "Standardized swap contracts, standard financial futures on swaps, expiration swap funding rates" }, { "value": "FFICSX", @@ -25434,17 +26280,17 @@ }, "firstOpenDate": { "type": "integer", - "description": "First Open Date(millisecond)", + "description": "First Open Date (milliseconds)", "format": "int64" }, "expireDate": { "type": "integer", - "description": "Expiration date(millisecond). Null means it will never expire", + "description": "Expiration date (milliseconds) Null means it will never expire", "format": "int64" }, "settleDate": { "type": "integer", - "description": "Settlement date(millisecond). Null indicates that automatic settlement is not supported", + "description": "Settlement date (milliseconds) Null indicates that automatic settlement is not supported", "format": "int64" }, "baseCurrency": { @@ -25545,13 +26391,13 @@ { "value": "FairPrice", "name": "FairPrice", - "description": "Fair Price" + "description": "FairPrice" } ] }, "fairMethod": { "type": "string", - "description": "Fair price marking method, The Futures contract is null", + "description": "Fair price marking method; the Futures contract is null", "enum": [ "FundingRate" ], @@ -25565,7 +26411,7 @@ }, "fundingBaseSymbol": { "type": "string", - "description": "Ticker symbol of the based currency" + "description": "Ticker symbol of the base currency" }, "fundingQuoteSymbol": { "type": "string", @@ -25581,7 +26427,7 @@ }, "settlementSymbol": { "type": "string", - "description": "Settlement Symbol" + "description": "Settlement symbol" }, "status": { "type": "string", @@ -25609,7 +26455,7 @@ { "value": "BeingSettled", "name": "BeingSettled", - "description": "Setting" + "description": "Settling" }, { "value": "Settled", @@ -25643,11 +26489,11 @@ }, "fundingRateGranularity": { "type": "integer", - "description": "Funding interval(millisecond)" + "description": "Funding interval (milliseconds)" }, "openInterest": { "type": "string", - "description": "Open interest" + "description": "Open interest (unit: lots)" }, "turnoverOf24h": { "type": "number", @@ -25671,7 +26517,7 @@ }, "nextFundingRateTime": { "type": "integer", - "description": "Next funding rate time(millisecond)" + "description": "Next funding rate time (milliseconds)" }, "maxLeverage": { "type": "integer", @@ -25686,19 +26532,19 @@ }, "premiumsSymbol1M": { "type": "string", - "description": "Premium index symbol(1 minute)" + "description": "Premium index symbol (1 minute)" }, "premiumsSymbol8H": { "type": "string", - "description": "Premium index symbol(8 hours)" + "description": "Premium index symbol (8 hours)" }, "fundingBaseSymbol1M": { "type": "string", - "description": "Base currency interest rate symbol(1 minute)" + "description": "Base currency interest rate symbol (1 minute)" }, "fundingQuoteSymbol1M": { "type": "string", - "description": "Quote currency interest rate symbol(1 minute)" + "description": "Quote currency interest rate symbol (1 minute)" }, "lowPrice": { "type": "number", @@ -25710,7 +26556,7 @@ }, "priceChgPct": { "type": "number", - "description": "24-hour price change% " + "description": "24-hour % price change " }, "priceChg": { "type": "number", @@ -25734,6 +26580,14 @@ "supportCross": { "type": "boolean", "description": "Whether support Cross Margin" + }, + "buyLimit": { + "type": "number", + "description": "The current maximum allowed buying price" + }, + "sellLimit": { + "type": "number", + "description": "The current minimum allowed selling price" } }, "required": [ @@ -25796,10 +26650,12 @@ "f", "mmrLimit", "mmrLevConstant", - "supportCross" + "supportCross", + "buyLimit", + "sellLimit" ] }, - "description": "the list of all contracts" + "description": "List of all contracts" } }, "required": [ @@ -25815,7 +26671,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"XBTUSDTM\",\n \"rootSymbol\": \"USDT\",\n \"type\": \"FFWCSX\",\n \"firstOpenDate\": 1585555200000,\n \"expireDate\": null,\n \"settleDate\": null,\n \"baseCurrency\": \"XBT\",\n \"quoteCurrency\": \"USDT\",\n \"settleCurrency\": \"USDT\",\n \"maxOrderQty\": 1000000,\n \"maxPrice\": 1000000.0,\n \"lotSize\": 1,\n \"tickSize\": 0.1,\n \"indexPriceTickSize\": 0.01,\n \"multiplier\": 0.001,\n \"initialMargin\": 0.008,\n \"maintainMargin\": 0.004,\n \"maxRiskLimit\": 100000,\n \"minRiskLimit\": 100000,\n \"riskStep\": 50000,\n \"makerFeeRate\": 2.0E-4,\n \"takerFeeRate\": 6.0E-4,\n \"takerFixFee\": 0.0,\n \"makerFixFee\": 0.0,\n \"settlementFee\": null,\n \"isDeleverage\": true,\n \"isQuanto\": true,\n \"isInverse\": false,\n \"markMethod\": \"FairPrice\",\n \"fairMethod\": \"FundingRate\",\n \"fundingBaseSymbol\": \".XBTINT8H\",\n \"fundingQuoteSymbol\": \".USDTINT8H\",\n \"fundingRateSymbol\": \".XBTUSDTMFPI8H\",\n \"indexSymbol\": \".KXBTUSDT\",\n \"settlementSymbol\": \"\",\n \"status\": \"Open\",\n \"fundingFeeRate\": 1.53E-4,\n \"predictedFundingFeeRate\": 8.0E-5,\n \"fundingRateGranularity\": 28800000,\n \"openInterest\": \"6384957\",\n \"turnoverOf24h\": 5.788402220999069E8,\n \"volumeOf24h\": 8274.432,\n \"markPrice\": 69732.33,\n \"indexPrice\": 69732.32,\n \"lastTradePrice\": 69732,\n \"nextFundingRateTime\": 21265941,\n \"maxLeverage\": 125,\n \"sourceExchanges\": [\n \"okex\",\n \"binance\",\n \"kucoin\",\n \"bybit\",\n \"bitmart\",\n \"gateio\"\n ],\n \"premiumsSymbol1M\": \".XBTUSDTMPI\",\n \"premiumsSymbol8H\": \".XBTUSDTMPI8H\",\n \"fundingBaseSymbol1M\": \".XBTINT\",\n \"fundingQuoteSymbol1M\": \".USDTINT\",\n \"lowPrice\": 68817.5,\n \"highPrice\": 71615.8,\n \"priceChgPct\": 6.0E-4,\n \"priceChg\": 48.0,\n \"k\": 490.0,\n \"m\": 300.0,\n \"f\": 1.3,\n \"mmrLimit\": 0.3,\n \"mmrLevConstant\": 125.0,\n \"supportCross\": true\n }\n ]\n}", + "data": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"XBTUSDTM\",\n \"rootSymbol\": \"USDT\",\n \"type\": \"FFWCSX\",\n \"firstOpenDate\": 1585555200000,\n \"expireDate\": null,\n \"settleDate\": null,\n \"baseCurrency\": \"XBT\",\n \"quoteCurrency\": \"USDT\",\n \"settleCurrency\": \"USDT\",\n \"maxOrderQty\": 1000000,\n \"maxPrice\": 1000000,\n \"lotSize\": 1,\n \"tickSize\": 0.1,\n \"indexPriceTickSize\": 0.01,\n \"multiplier\": 0.001,\n \"initialMargin\": 0.008,\n \"maintainMargin\": 0.004,\n \"maxRiskLimit\": 100000,\n \"minRiskLimit\": 100000,\n \"riskStep\": 50000,\n \"makerFeeRate\": 0.0002,\n \"takerFeeRate\": 0.0006,\n \"takerFixFee\": 0,\n \"makerFixFee\": 0,\n \"settlementFee\": null,\n \"isDeleverage\": true,\n \"isQuanto\": true,\n \"isInverse\": false,\n \"markMethod\": \"FairPrice\",\n \"fairMethod\": \"FundingRate\",\n \"fundingBaseSymbol\": \".XBTINT8H\",\n \"fundingQuoteSymbol\": \".USDTINT8H\",\n \"fundingRateSymbol\": \".XBTUSDTMFPI8H\",\n \"indexSymbol\": \".KXBTUSDT\",\n \"settlementSymbol\": \"\",\n \"status\": \"Open\",\n \"fundingFeeRate\": 0.000052,\n \"predictedFundingFeeRate\": 0.000083,\n \"fundingRateGranularity\": 28800000,\n \"openInterest\": \"6748176\",\n \"turnoverOf24h\": 1034643198.3265533,\n \"volumeOf24h\": 12069.225,\n \"markPrice\": 86378.69,\n \"indexPrice\": 86382.64,\n \"lastTradePrice\": 86364,\n \"nextFundingRateTime\": 17752926,\n \"maxLeverage\": 125,\n \"sourceExchanges\": [\n \"okex\",\n \"binance\",\n \"kucoin\",\n \"bybit\",\n \"bitmart\",\n \"gateio\"\n ],\n \"premiumsSymbol1M\": \".XBTUSDTMPI\",\n \"premiumsSymbol8H\": \".XBTUSDTMPI8H\",\n \"fundingBaseSymbol1M\": \".XBTINT\",\n \"fundingQuoteSymbol1M\": \".USDTINT\",\n \"lowPrice\": 82205.2,\n \"highPrice\": 89299.9,\n \"priceChgPct\": -0.028,\n \"priceChg\": -2495.9,\n \"k\": 490,\n \"m\": 300,\n \"f\": 1.3,\n \"mmrLimit\": 0.3,\n \"mmrLevConstant\": 125,\n \"supportCross\": true,\n \"buyLimit\": 90700.7115,\n \"sellLimit\": 82062.5485\n }\n ]\n}", "responseId": 10384, "ordering": 1 } @@ -25825,8 +26681,8 @@ "parameters": [], "mediaType": "" }, - "description": ":::info[Description]\nGet detailed information of all contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"GetAllSymbols\",\"sdk-method-description\":\"Get detailed information of all contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nGet detailed information of all contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price, etc.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"GetAllSymbols\",\"sdk-method-description\":\"Get detailed information of all contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price, etc.\",\"api-rate-limit-weight\":3}" } }, { @@ -25841,7 +26697,7 @@ "id": "poTiPQkaFr", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) \n\n", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) \n\n", "example": "", "type": "string", "schema": { @@ -25877,16 +26733,16 @@ "properties": { "sequence": { "type": "integer", - "description": "Sequence number, used to judge whether the messages pushed by Websocket is continuous.", + "description": "Sequence number, used to judge whether the messages pushed by Websocket are continuous.", "format": "int64" }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "side": { "type": "string", - "description": "Filled side, The trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book.", + "description": "Filled side; the trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book.", "enum": [ "buy", "sell" @@ -25934,7 +26790,7 @@ }, "ts": { "type": "integer", - "description": "Filled time(nanosecond)", + "description": "Filled time (nanoseconds)", "format": "int64" } }, @@ -25976,8 +26832,8 @@ "parameters": [], "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint returns \"last traded price/size\"、\"best bid/ask price/size\" etc. of a single symbol.\nThese messages can also be obtained through Websocket.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getTicker\",\"sdk-method-description\":\"This endpoint returns \\\"last traded price/size\\\"、\\\"best bid/ask price/size\\\" etc. of a single symbol. These messages can also be obtained through Websocket.\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nThis endpoint returns \"last traded price/size\", \"best bid/ask price/size\" etc. of a single symbol.\nThese messages can also be obtained through Websocket.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getTicker\",\"sdk-method-description\":\"This endpoint returns \\\"last traded price/size\\\", \\\"best bid/ask price/size\\\" etc. of a single symbol. These messages can also be obtained through Websocket.\",\"api-rate-limit-weight\":2}" } }, { @@ -26012,7 +26868,7 @@ "properties": { "sequence": { "type": "integer", - "description": "Sequence number, used to judge whether the messages pushed by Websocket is continuous.", + "description": "Sequence number, used to judge whether the messages pushed by Websocket are continuous.", "format": "int64" }, "symbol": { @@ -26041,7 +26897,7 @@ }, "size": { "type": "integer", - "description": "Filled side, The trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book." + "description": "Filled side; the trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book." }, "tradeId": { "type": "string", @@ -26069,7 +26925,7 @@ }, "ts": { "type": "integer", - "description": "Filled time(nanosecond)", + "description": "Filled time (nanoseconds)", "format": "int64" } }, @@ -26112,8 +26968,8 @@ "parameters": [], "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint returns \"last traded price/size\"、\"best bid/ask price/size\" etc. of all symbol.\nThese messages can also be obtained through Websocket.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getAllTickers\",\"sdk-method-description\":\"This endpoint returns \\\"last traded price/size\\\"、\\\"best bid/ask price/size\\\" etc. of a single symbol. These messages can also be obtained through Websocket.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis endpoint returns \"last traded price/size\", \"best bid/ask price/size\" etc. of all symbol.\nThese messages can also be obtained through Websocket.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getAllTickers\",\"sdk-method-description\":\"This endpoint returns \\\"last traded price/size\\\", \\\"best bid/ask price/size\\\" etc. of a single symbol. These messages can also be obtained through Websocket.\",\"api-rate-limit-weight\":5}" } }, { @@ -26128,7 +26984,7 @@ "id": "jVYCLbgfDY", "name": "symbol", "required": false, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) \n", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) \n", "example": "XBTUSDM", "type": "string", "enable": true @@ -26161,7 +27017,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "bids": { "type": "array", @@ -26188,7 +27044,7 @@ "ts": { "type": "integer", "format": "int64", - "description": "Timestamp(nanosecond)" + "description": "Timestamp (nanoseconds)" } }, "required": [ @@ -26223,8 +27079,8 @@ "parameters": [], "mediaType": "" }, - "description": ":::info[Discription]\nQuery for Full orderbook depth data. (aggregated by price)\n\nIt is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control.\n\nTo maintain up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getFullOrderBook\",\"sdk-method-description\":\"Query for Full orderbook depth data. (aggregated by price) It is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control. To maintain up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.\",\"api-rate-limit\":3}" + "description": ":::info[Discription]\nQuery for Full orderbook depth data (aggregated by price)\n\nIt is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit controls.\n\nTo maintain an up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getFullOrderBook\",\"sdk-method-description\":\"Query for Full orderbook depth data (aggregated by price). It is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control. To maintain an up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.\",\"api-rate-limit-weight\":3}" } }, { @@ -26239,7 +27095,7 @@ "id": "jVYCLbgfDY", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "example": "XBTUSDM", "type": "string", "enable": true @@ -26300,7 +27156,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "bids": { "type": "array", @@ -26326,7 +27182,7 @@ }, "ts": { "type": "integer", - "description": "Timestamp(nanosecond)", + "description": "Timestamp (nanoseconds)", "format": "int64" } }, @@ -26362,8 +27218,8 @@ "parameters": [], "mediaType": "" }, - "description": ":::info[Discription]\nQuery for part orderbook depth data. (aggregated by price)\n\nYou are recommended to request via this endpoint as the system reponse would be faster and cosume less traffic.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getPartOrderBook\",\"sdk-method-description\":\"Query for part orderbook depth data. (aggregated by price) You are recommended to request via this endpoint as the system reponse would be faster and cosume less traffic.\",\"api-rate-limit\":5}" + "description": ":::info[Discription]\nQuery for part orderbook depth data (aggregated by price).\n\nIt is recommended that you submit requests via this endpoint as the system response will be faster and consume less traffic.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getPartOrderBook\",\"sdk-method-description\":\"Query for part orderbook depth data. (aggregated by price). It is recommended that you request via this endpoint, as the system response will be faster and consume less traffic.\",\"api-rate-limit-weight\":5}" } }, { @@ -26378,7 +27234,7 @@ "id": "jVYCLbgfDY", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "example": "XBTUSDM", "type": "string", "enable": true @@ -26428,7 +27284,7 @@ }, "ts": { "type": "integer", - "description": "Filled timestamp(nanosecond)", + "description": "Filled timestamp (nanosecond)", "format": "int64" }, "size": { @@ -26441,7 +27297,7 @@ }, "side": { "type": "string", - "description": "Filled side, The trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book.", + "description": "Filled side; the trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book.", "enum": [ "buy", "sell" @@ -26497,8 +27353,8 @@ "parameters": [], "mediaType": "" }, - "description": ":::info[Discription]\nRequest via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getTradeHistory\",\"sdk-method-description\":\"Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.\",\"api-rate-limit\":5}" + "description": ":::info[Discription]\nRequest the trade history of the specified symbol via this endpoint. The returned quantity is the last 100 transaction records.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getTradeHistory\",\"sdk-method-description\":\"Request the trade history of the specified symbol via this endpoint. The returned quantity is the last 100 transaction records.\",\"api-rate-limit-weight\":5}" } }, { @@ -26513,7 +27369,7 @@ "id": "jVYCLbgfDY", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) ", "example": "", "type": "string", "schema": { @@ -26531,7 +27387,7 @@ "id": "jgqzFrzKqc", "name": "granularity", "required": true, - "description": "Type of candlestick patterns(minute)", + "description": "Type of candlestick patterns (minutes)", "example": "", "type": "integer", "schema": { @@ -26614,7 +27470,7 @@ "id": "DyCMyfR0e9", "name": "from", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "example": "1728552342000", "type": "integer", "schema": { @@ -26627,7 +27483,7 @@ "id": "Z1XMrUW1vQ", "name": "to", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "example": "1729243542000", "type": "integer", "schema": { @@ -26659,7 +27515,7 @@ "type": "array", "items": { "type": "number", - "description": "Start time of the candle cycle, opening price, highest price, Lowest price, closing price, Transaction volume" + "description": "Start time of the candle cycle, opening price, highest price, lowest price, closing price, transaction volume" } } } @@ -26687,8 +27543,8 @@ "parameters": [], "mediaType": "" }, - "description": ":::info[Description]\nGet the Kline of the symbol. Data are returned in grouped buckets based on requested type.\nFor each query, the system would return at most 500 pieces of data. To obtain more data, please page the data by time.\n:::\n\n:::tip[Tips]\nKlines data may be incomplete. No data is published for intervals where there are no ticks.\n\nIf the specified start/end time and the time granularity exceeds the maximum size allowed for a single request, the system will only return 500 pieces of data for your request. If you want to get fine-grained data in a larger time range, you will need to specify the time ranges and make multiple requests for multiple times.\n\nIf you’ve specified only the start time in your request, the system will return 500 pieces of data from the specified start time to the current time of the system; If only the end time is specified, the system will return 500 pieces of data closest to the end time; If neither the start time nor the end time is specified, the system will return the 500 pieces of data closest to the current time of the system.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getKlines\",\"sdk-method-description\":\"Get the Kline of the symbol. Data are returned in grouped buckets based on requested type. For each query, the system would return at most 500 pieces of data. To obtain more data, please page the data by time.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nGet the symbol’s candlestick chart. Data are returned in grouped buckets based on requested type.\nFor each query, the system will return at most 500 pieces of data. To obtain more data, please page the data by time.\n:::\n\n:::tip[Tips]\nCandlestick chart data may be incomplete. No data is published for intervals where there are no ticks.\n\nIf the specified start/end time and the time granularity exceed the maximum size allowed for a single request, the system will only return 500 pieces of data for your request. If you want to get fine-grained data in a larger time range, you will need to specify the time ranges and make multiple requests for multiple times.\n\nIf you’ve specified only the start time in your request, the system will return 500 pieces of data from the specified start time to the current time of the system; if only the end time is specified, the system will return 500 pieces of data closest to the end time; if neither the start time nor the end time is specified, the system will return the 500 pieces of data closest to the current time of the system.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getKlines\",\"sdk-method-description\":\"Get the symbol’s candlestick chart. Data are returned in grouped buckets based on requested type. For each query, the system will return at most 500 pieces of data. To obtain more data, please page the data by time.\",\"api-rate-limit-weight\":3}" } }, { @@ -26704,7 +27560,7 @@ "id": "symbol#0", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "example": "XBTUSDTM", "type": "string", "enable": true @@ -26730,15 +27586,15 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "granularity": { "type": "integer", - "description": "Granularity (milisecond)" + "description": "Granularity (milliseconds)" }, "timePoint": { "type": "integer", - "description": "Time point (milisecond)", + "description": "Time point (milliseconds)", "format": "int64" }, "value": { @@ -26782,8 +27638,8 @@ "parameters": [], "mediaType": "" }, - "description": ":::info[Discription]\nGet current mark price\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getMarkPrice\",\"sdk-method-description\":\"Get current mark price\",\"api-rate-limit\":3}" + "description": ":::info[Discription]\nGet the current mark price.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getMarkPrice\",\"sdk-method-description\":\"Get the current mark price.\",\"api-rate-limit-weight\":3}" } }, { @@ -26798,7 +27654,7 @@ "id": "jVYCLbgfDY", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) ", "example": "", "type": "string", "schema": { @@ -26814,7 +27670,7 @@ "id": "rrbcWdUUs7", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "type": "integer", "schema": { "type": "integer", @@ -26826,7 +27682,7 @@ "id": "cfuya1nYZr", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "type": "integer", "schema": { "type": "integer", @@ -26838,7 +27694,7 @@ "id": "hkyyNIwpmM", "name": "reverse", "required": false, - "description": "This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default.", + "description": "This parameter functions to judge whether the lookup is reversed. True means “yes”. False means “no”. This parameter is set as True by default.", "type": "boolean", "schema": { "type": "boolean", @@ -26862,7 +27718,7 @@ "id": "OfBs1uDNny", "name": "forward", "required": false, - "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default", + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default.", "type": "boolean", "schema": { "type": "boolean", @@ -26874,7 +27730,7 @@ "id": "8wMDaYFMRS", "name": "maxCount", "required": false, - "description": "Max record count. The default record count is 10, The maximum length cannot exceed 100", + "description": "Max. record count. The default record count is 10; the maximum length cannot exceed 100", "type": "integer", "schema": { "type": "integer", @@ -26911,15 +27767,15 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) " }, "granularity": { "type": "integer", - "description": "Granularity (milisecond)" + "description": "Granularity (milliseconds)" }, "timePoint": { "type": "integer", - "description": "Timestamp (milisecond)", + "description": "Timestamp (milliseconds)", "format": "int64" }, "value": { @@ -26996,8 +27852,8 @@ "parameters": [], "mediaType": "" }, - "description": ":::info[Discription]\nGet Spot Index price\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getSpotIndexPrice\",\"sdk-method-description\":\"Get Spot Index Price\",\"api-rate-limit\":2}" + "description": ":::info[Discription]\nGet Spot Index price.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getSpotIndexPrice\",\"sdk-method-description\":\"Get Spot Index Price.\",\"api-rate-limit-weight\":2}" } }, { @@ -27012,7 +27868,7 @@ "id": "jVYCLbgfDY", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) ", "example": "", "type": "string", "schema": { @@ -27030,7 +27886,7 @@ "id": "rrbcWdUUs7", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "example": "1728663338000", "type": "integer", "schema": { @@ -27043,7 +27899,7 @@ "id": "cfuya1nYZr", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "example": "1728692138000", "type": "integer", "schema": { @@ -27056,7 +27912,7 @@ "id": "hkyyNIwpmM", "name": "reverse", "required": false, - "description": "This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default.", + "description": "This parameter functions to judge whether the lookup is reversed. True means “yes”. False means “no”. This parameter is set as True by default.", "example": "true", "type": "boolean", "schema": { @@ -27082,7 +27938,7 @@ "id": "OfBs1uDNny", "name": "forward", "required": false, - "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default", + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default.", "example": "true", "type": "boolean", "schema": { @@ -27095,7 +27951,7 @@ "id": "8wMDaYFMRS", "name": "maxCount", "required": false, - "description": "Max record count. The default record count is 10, The maximum length cannot exceed 100", + "description": "Max. record count. The default record count is 10; the maximum length cannot exceed 100", "example": "10", "type": "integer", "schema": { @@ -27133,15 +27989,15 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) " }, "granularity": { "type": "integer", - "description": "Granularity (milisecond)" + "description": "Granularity (milliseconds)" }, "timePoint": { "type": "integer", - "description": "Timestamp(milisecond)", + "description": "Timestamp (milliseconds)", "format": "int64" }, "value": { @@ -27192,7 +28048,7 @@ "mediaType": "" }, "description": ":::info[Discription]\nGet interest rate Index.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getInterestRateIndex\",\"sdk-method-description\":\"Get interest rate Index.\",\"api-rate-limit\":5}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getInterestRateIndex\",\"sdk-method-description\":\"Get interest rate Index.\",\"api-rate-limit-weight\":5}" } }, { @@ -27207,7 +28063,7 @@ "id": "jVYCLbgfDY", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) ", "example": "", "type": "string", "schema": { @@ -27223,7 +28079,7 @@ "id": "rrbcWdUUs7", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "example": "1728663338000", "type": "integer", "schema": { @@ -27236,7 +28092,7 @@ "id": "cfuya1nYZr", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "example": "1728692138000", "type": "integer", "schema": { @@ -27249,7 +28105,7 @@ "id": "hkyyNIwpmM", "name": "reverse", "required": false, - "description": "This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default.", + "description": "This parameter functions to judge whether the lookup is reversed. True means “yes”. False means “no”. This parameter is set as True by default.", "example": "true", "type": "boolean", "schema": { @@ -27275,7 +28131,7 @@ "id": "OfBs1uDNny", "name": "forward", "required": false, - "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default", + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default.", "example": "true", "type": "boolean", "schema": { @@ -27288,7 +28144,7 @@ "id": "8wMDaYFMRS", "name": "maxCount", "required": false, - "description": "Max record count. The default record count is 10, The maximum length cannot exceed 100", + "description": "Max. record count. The default record count is 10; the maximum length cannot exceed 100", "example": "10", "type": "integer", "schema": { @@ -27326,15 +28182,15 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) " }, "granularity": { "type": "integer", - "description": "Granularity(milisecond)" + "description": "Granularity (milliseconds)" }, "timePoint": { "type": "integer", - "description": "Timestamp(milisecond)", + "description": "Timestamp (milliseconds)", "format": "int64" }, "value": { @@ -27385,18 +28241,18 @@ "mediaType": "" }, "description": ":::info[Discription]\nSubmit request to get premium index.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getPremiumIndex\",\"sdk-method-description\":\"Submit request to get premium index.\",\"api-rate-limit\":3}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getPremiumIndex\",\"sdk-method-description\":\"Submit request to get premium index.\",\"api-rate-limit-weight\":3}" } }, { - "name": "Get 24hr Stats", + "name": "Get 24hr stats", "api": { "id": "3470228", "method": "get", "path": "/api/v1/trade-statistics", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -27449,7 +28305,7 @@ "mediaType": "" }, "description": ":::info[Discription]\nGet the statistics of the platform futures trading volume in the last 24 hours.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"get24hrStats\",\"sdk-method-description\":\"Get the statistics of the platform futures trading volume in the last 24 hours.\",\"api-rate-limit\":3}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"get24hrStats\",\"sdk-method-description\":\"Get the statistics of the platform futures trading volume in the last 24 hours.\",\"api-rate-limit-weight\":3}" } }, { @@ -27459,8 +28315,8 @@ "method": "get", "path": "/api/v1/timestamp", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -27479,7 +28335,7 @@ "data": { "type": "integer", "format": "int64", - "description": "ServerTime(millisecond)" + "description": "ServerTime (milliseconds)" } }, "required": [ @@ -27506,7 +28362,7 @@ "mediaType": "" }, "description": ":::info[Discription]\nGet the API server time. This is the Unix timestamp.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getServerTime\",\"sdk-method-description\":\"Get the API server time. This is the Unix timestamp.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getServerTime\",\"sdk-method-description\":\"Get the API server time. This is the Unix timestamp.\",\"api-rate-limit-weight\":2}" } }, { @@ -27541,7 +28397,7 @@ }, "status": { "type": "string", - "description": "Status of service: open：normal transaction, close：Stop Trading/Maintenance, cancelonly：can only cancel the order but not place order", + "description": "Status of service: open: normal transaction; close: Stop Trading/Maintenance; cancelonly: can only cancel the order but not place order", "enum": [ "open", "close", @@ -27596,7 +28452,7 @@ "mediaType": "" }, "description": ":::info[Discription]\nGet the service status.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getServiceStatus\",\"sdk-method-description\":\"Get the service status.\",\"api-rate-limit\":4}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Public\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Market\",\"sdk-method-name\":\"getServiceStatus\",\"sdk-method-description\":\"Get the service status.\",\"api-rate-limit-weight\":4}" } } ] @@ -27622,331 +28478,331 @@ { "id": "10399", "code": 200, - "name": "成功", - "headers": [], - "jsonSchema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "data": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The unique order id generated by the trading system,which can be used later for further actions such as canceling the order." - }, - "clientOid": { - "type": "string", - "description": "The user self-defined order id." - } - }, - "required": [ - "orderId", - "clientOid" - ] - } - }, - "required": [ - "code", - "data" - ] - }, - "description": "", - "contentType": "json", - "mediaType": "" - } - ], - "responseExamples": [ - { - "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"234125150956625920\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\"\n }\n}", - "responseId": 10399, - "ordering": 1 - } - ], - "requestBody": { - "type": "application/json", - "parameters": [], - "jsonSchema": { - "type": "object", - "properties": { - "clientOid": { - "type": "string", - "description": "Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-)", - "examples": [ - "5c52e11203aa677f33e493fb" - ] - }, - "side": { - "type": "string", - "description": "specify if the order is to 'buy' or 'sell'", - "enum": [ - "buy", - "sell" - ], - "examples": [ - "buy" - ], - "x-api-enum": [ - { - "value": "buy", - "name": "", - "description": "" - }, - { - "value": "sell", - "name": "", - "description": "" - } - ] - }, - "symbol": { - "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", - "examples": [ - "XBTUSDTM" - ] - }, - "leverage": { - "type": "integer", - "description": "Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required.", - "examples": [ - 3 - ] - }, - "type": { - "type": "string", - "description": "specify if the order is an 'limit' order or 'market' order", - "enum": [ - "limit", - "market" - ], - "examples": [ - "limit" - ], - "default": "limit", - "x-api-enum": [ - { - "value": "limit", - "name": "", - "description": "" - }, - { - "value": "market", - "name": "", - "description": "" - } - ] - }, - "remark": { - "type": "string", - "description": "remark for the order, length cannot exceed 100 utf8 characters" - }, - "stop": { - "type": "string", - "description": "Either 'down' or 'up'. If stop is used,parameter stopPrice and stopPriceType also need to be provieded.", - "enum": [ - "down", - "up" - ], - "x-api-enum": [ - { - "value": "down", - "name": "down", - "description": "Triggers when the price reaches or goes below the stopPrice." - }, - { - "value": "up", - "name": "up", - "description": "Triggers when the price reaches or goes above the stopPrice" - } - ] - }, - "stopPriceType": { - "type": "string", - "description": "Either 'TP', 'IP' or 'MP', Need to be defined if stop is specified.", - "enum": [ - "TP", - "MP", - "IP" - ], - "x-api-enum": [ - { - "value": "TP", - "name": "trade price", - "description": "TP for trade price, The last trade price is the last price at which an order was filled. This price can be found in the latest match message." - }, - { - "value": "MP", - "name": "mark price", - "description": "MP for mark price, The mark price can be obtained through relevant OPEN API for index services" - }, - { - "value": "IP", - "name": "index price", - "description": "IP for index price, The index price can be obtained through relevant OPEN API for index services" - } - ] - }, - "stopPrice": { - "type": "string", - "description": "Need to be defined if stop is specified. " - }, - "reduceOnly": { - "type": "boolean", - "description": "A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. If set to true, only the orders reducing the position size will be executed. If the reduce-only order size exceeds the position size, the extra size will be canceled.", - "default": false - }, - "closeOrder": { - "type": "boolean", - "description": "A mark to close the position. Set to false by default. If closeOrder is set to true, the system will close the position and the position size will become 0. Side, Size and Leverage fields can be left empty and the system will determine the side and size automatically.", - "default": false - }, - "forceHold": { - "type": "boolean", - "description": "A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order.", - "default": false - }, - "stp": { - "type": "string", - "description": "[Self Trade Prevention](apidog://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", - "enum": [ - "CN", - "CO", - "CB" - ], - "x-api-enum": [ - { - "value": "CN", - "name": "CN", - "description": "Cancel new, Cancel the new order" - }, - { - "value": "CO", - "name": "CO", - "description": "Cancel old, Cancel the old order" - }, - { - "value": "CB", - "name": "CB", - "description": "Cancel both, Cancel both sides" - } - ] - }, - "marginMode": { - "type": "string", - "description": "Margin mode: ISOLATED, CROSS, default: ISOLATED", - "enum": [ - "ISOLATED", - "CROSS" - ], - "default": "ISOLATED", - "x-api-enum": [ - { - "value": "ISOLATED", - "name": "ISOLATED", - "description": "Isolated Margin" - }, - { - "value": "CROSS", - "name": "CROSS", - "description": "Cross Margin" - } - ] - }, - "price": { - "type": "string", - "description": "Required for type is 'limit' order, indicating the operating price", - "examples": [ - "0.1" - ] - }, - "size": { - "type": "integer", - "description": "**Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported." - }, - "timeInForce": { - "type": "string", - "description": "Optional for type is 'limit' order, [Time in force](apidog://link/pages/338146) is a special strategy used during trading, default is GTC", - "enum": [ - "GTC", - "IOC" - ], - "default": "GTC", - "x-api-enum": [ - { - "value": "GTC", - "name": "Good Till Canceled", - "description": "order remains open on the order book until canceled. This is the default type if the field is left empty." - }, - { - "value": "IOC", - "name": "Immediate Or Cancel", - "description": "being matched or not, the remaining size of the order will be instantly canceled instead of entering the order book." - } - ] - }, - "postOnly": { - "type": "boolean", - "description": "Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected.", - "default": false - }, - "hidden": { - "type": "boolean", - "description": "Optional for type is 'limit' order, orders not displaying in order book. When hidden chose, not allowed choose postOnly.", - "default": false - }, - "iceberg": { - "type": "boolean", - "description": "Optional for type is 'limit' order, Only visible portion of the order is displayed in the order book. When iceberg chose, not allowed choose postOnly.", - "default": false - }, - "visibleSize": { - "type": "string", - "description": "Optional for type is 'limit' order, The maximum visible size of an iceberg order. please place order in size (lots), The units of qty (base currency) and valueQty (value) are not supported." - }, - "qty": { - "type": "string", - "description": "**Choose one of size, qty, valueQty**, Order size (Base currency) must be an integer multiple of the multiplier. The unit of the quantity of coin-swap is size(lot), which is not supported" - }, - "valueQty": { - "type": "string", - "description": "**Choose one of size, qty, valueQty**, Order size (Value), USDS-Swap correspond to USDT or USDC. The unit of the quantity of coin-swap is size(lot), which is not supported" - } - }, - "required": [ - "clientOid", - "symbol", - "side", - "leverage" - ] - }, - "example": "{\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"side\": \"buy\",\n \"symbol\": \"XBTUSDTM\",\n \"leverage\": 3,\n \"type\": \"limit\",\n \"remark\": \"order remarks\",\n \"reduceOnly\": false,\n \"marginMode\": \"ISOLATED\",\n \"price\": \"0.1\",\n \"size\": 1,\n \"timeInForce\": \"GTC\"\n}", - "mediaType": "" - }, - "description": ":::info[Description]\nPlace order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n:::\n\n:::tip[Tips]\nThe maximum limit orders for a single contract is 100 per account, and the maximum stop orders for a single contract is 200 per account.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrder\",\"sdk-method-description\":\"Place order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\",\"api-rate-limit\":2}" - } - }, - { - "name": "Add Order Test", - "api": { - "id": "3470238", - "method": "post", - "path": "/api/v1/orders/test", - "parameters": { - "query": [], - "path": [], - "cookie": [], - "header": [] - }, - "responses": [ - { - "id": "10402", - "code": 200, - "name": "成功", + "name": "OK", + "headers": [], + "jsonSchema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "orderId": { + "type": "string", + "description": "The unique order ID generated by the trading system, which can be used later for further actions such as canceling the order." + }, + "clientOid": { + "type": "string", + "description": "The user self-defined order ID." + } + }, + "required": [ + "orderId", + "clientOid" + ] + } + }, + "required": [ + "code", + "data" + ] + }, + "description": "", + "contentType": "json", + "mediaType": "" + } + ], + "responseExamples": [ + { + "name": "Success", + "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"234125150956625920\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\"\n }\n}", + "responseId": 10399, + "ordering": 1 + } + ], + "requestBody": { + "type": "application/json", + "parameters": [], + "jsonSchema": { + "type": "object", + "properties": { + "clientOid": { + "type": "string", + "description": "Unique order ID created by users to identify their orders. The maximum length cannot exceed 40, e.g. UUID only allows numbers, characters, underline(_), and separator (-).", + "examples": [ + "5c52e11203aa677f33e493fb" + ] + }, + "side": { + "type": "string", + "description": "Specify if the order is to 'buy' or 'sell'.", + "enum": [ + "buy", + "sell" + ], + "examples": [ + "buy" + ], + "x-api-enum": [ + { + "value": "buy", + "name": "", + "description": "" + }, + { + "value": "sell", + "name": "", + "description": "" + } + ] + }, + "symbol": { + "type": "string", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "examples": [ + "XBTUSDTM" + ] + }, + "leverage": { + "type": "integer", + "description": "Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required.", + "examples": [ + 3 + ] + }, + "type": { + "type": "string", + "description": "Specify if the order is a 'limit' order or 'market' order", + "enum": [ + "limit", + "market" + ], + "examples": [ + "limit" + ], + "default": "limit", + "x-api-enum": [ + { + "value": "limit", + "name": "", + "description": "" + }, + { + "value": "market", + "name": "", + "description": "" + } + ] + }, + "remark": { + "type": "string", + "description": "Remark for the order: Length cannot exceed 100 utf8 characters" + }, + "stop": { + "type": "string", + "description": "Either 'down' or 'up'. If stop is used, parameter stopPrice and stopPriceType also need to be provided.", + "enum": [ + "down", + "up" + ], + "x-api-enum": [ + { + "value": "down", + "name": "down", + "description": "Triggers when the price reaches or goes below the stopPrice." + }, + { + "value": "up", + "name": "up", + "description": "Triggers when the price reaches or goes above the stopPrice." + } + ] + }, + "stopPriceType": { + "type": "string", + "description": "Either 'TP', 'IP' or 'MP', Need to be defined if stop is specified.", + "enum": [ + "TP", + "MP", + "IP" + ], + "x-api-enum": [ + { + "value": "TP", + "name": "trade price", + "description": "TP for trade price, The last trade price is the last price at which an order was filled. This price can be found in the latest match message." + }, + { + "value": "MP", + "name": "mark price", + "description": "MP for mark price. The mark price can be obtained through relevant OPEN API for index services." + }, + { + "value": "IP", + "name": "index price", + "description": "IP for index price. The index price can be obtained through relevant OPEN API for index services." + } + ] + }, + "stopPrice": { + "type": "string", + "description": "Needs to be defined if stop is specified. " + }, + "reduceOnly": { + "type": "boolean", + "description": "A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. If set to true, only the orders reducing the position size will be executed. If the reduce-only order size exceeds the position size, the extra size will be canceled.", + "default": false + }, + "closeOrder": { + "type": "boolean", + "description": "A mark to close the position. Set to false by default. If closeOrder is set to true, the system will close the position and the position size will become 0. Side, Size and Leverage fields can be left empty and the system will determine the side and size automatically.", + "default": false + }, + "forceHold": { + "type": "boolean", + "description": "A mark to force-hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will force-freeze a certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a way that not enough funds are frozen for the order.", + "default": false + }, + "stp": { + "type": "string", + "description": "[Self Trade Prevention](apidog://link/pages/338146) is divided into these strategies: CN, CO, CB. DC not currently supported.", + "enum": [ + "CN", + "CO", + "CB" + ], + "x-api-enum": [ + { + "value": "CN", + "name": "CN", + "description": "Cancel new, Cancel the new order" + }, + { + "value": "CO", + "name": "CO", + "description": "Cancel old, Cancel the old order" + }, + { + "value": "CB", + "name": "CB", + "description": "Cancel both, Cancel both sides" + } + ] + }, + "marginMode": { + "type": "string", + "description": "Margin mode: ISOLATED, CROSS, default: ISOLATED", + "enum": [ + "ISOLATED", + "CROSS" + ], + "default": "ISOLATED", + "x-api-enum": [ + { + "value": "ISOLATED", + "name": "ISOLATED", + "description": "Isolated Margin" + }, + { + "value": "CROSS", + "name": "CROSS", + "description": "Cross Margin" + } + ] + }, + "price": { + "type": "string", + "description": "Required for type is 'limit' order, indicating the operating price", + "examples": [ + "0.1" + ] + }, + "size": { + "type": "integer", + "description": "**Choose one of size, qty, valueQty**, Order size (lot), must be a positive integer. The quantity unit of coin-swap contracts is size (lot), and other units are not supported." + }, + "timeInForce": { + "type": "string", + "description": "Optional for type is 'limit' order, [Time in force](apidog://link/pages/338146) is a special strategy used during trading, default is GTC", + "enum": [ + "GTC", + "IOC" + ], + "default": "GTC", + "x-api-enum": [ + { + "value": "GTC", + "name": "Good Till Canceled", + "description": "Order remains open on the order book until canceled. This is the default type if the field is left empty." + }, + { + "value": "IOC", + "name": "Immediate Or Cancel", + "description": "Being matched or not, the remaining size of the order will be instantly canceled instead of entering the order book." + } + ] + }, + "postOnly": { + "type": "boolean", + "description": "Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, choosing hidden or iceberg is not allowed. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fees, the order will be fully rejected.", + "default": false + }, + "hidden": { + "type": "boolean", + "description": "Optional for type is 'limit' order, orders not displaying in order book. When hidden is chosen, choosing postOnly is not allowed.", + "default": false + }, + "iceberg": { + "type": "boolean", + "description": "Optional for type is 'limit' order, Only visible portion of the order is displayed in the order book. When iceberg is chosen, choosing postOnly is not allowed.", + "default": false + }, + "visibleSize": { + "type": "string", + "description": "Optional for type is 'limit' order, the maximum visible size of an iceberg order. Please place order in size (lots). The units of qty (base currency) and valueQty (value) are not supported. Need to be defined if iceberg is specified." + }, + "qty": { + "type": "string", + "description": "**Choose one of size, qty, valueQty**. Order size (base currency) must be an integer multiple of the multiplier. The unit of the quantity of coin-swap is size (lot), which is not supported." + }, + "valueQty": { + "type": "string", + "description": "**Choose one of size, qty, valueQty**. Order size (Value), USDS-Swap correspond to USDT or USDC. The unit of the quantity of coin-swap is size (lot), which is not supported." + } + }, + "required": [ + "clientOid", + "symbol", + "side", + "leverage" + ] + }, + "example": "{\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"side\": \"buy\",\n \"symbol\": \"XBTUSDTM\",\n \"leverage\": 3,\n \"type\": \"limit\",\n \"remark\": \"order remarks\",\n \"reduceOnly\": false,\n \"marginMode\": \"ISOLATED\",\n \"price\": \"0.1\",\n \"size\": 1,\n \"timeInForce\": \"GTC\"\n}", + "mediaType": "" + }, + "description": ":::info[Description]\nPlace order in the futures trading system. You can place two major types of order: Limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n:::\n\n:::tip[Tips]\nThe maximum limit orders for a single contract are 100 per account, and the maximum stop orders for a single contract are 200 per account.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrder\",\"sdk-method-description\":\"Place order in the futures trading system. You can place two major types of order: Limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\",\"api-rate-limit-weight\":2}" + } + }, + { + "name": "Add Order Test", + "api": { + "id": "3470238", + "method": "post", + "path": "/api/v1/orders/test", + "parameters": { + "query": [], + "path": [], + "cookie": [], + "header": [] + }, + "responses": [ + { + "id": "10402", + "code": 200, + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -28229,7 +29085,7 @@ }, "visibleSize": { "type": "string", - "description": "Optional for type is 'limit' order, The maximum visible size of an iceberg order. please place order in size (lots), The units of qty (base currency) and valueQty (value) are not supported." + "description": "Optional for type is 'limit' order, The maximum visible size of an iceberg order. please place order in size (lots), The units of qty (base currency) and valueQty (value) are not supported. Need to be defined if iceberg is specified." }, "qty": { "type": "string", @@ -28252,7 +29108,7 @@ "mediaType": "" }, "description": ":::info[Description]\nOrder test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrderTest\",\"sdk-method-description\":\"Place order to the futures trading system just for validation\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addOrderTest\",\"sdk-method-description\":\"Place order to the futures trading system just for validation\",\"api-rate-limit-weight\":2}" } }, { @@ -28271,7 +29127,7 @@ { "id": "10400", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -28586,7 +29442,6 @@ "required": [ "clientOid", "symbol", - "type", "side", "leverage" ] @@ -28596,7 +29451,7 @@ "mediaType": "" }, "description": ":::info[Description]\nPlace multiple order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\nYou can place up to 20 orders at one time, including limit orders, market orders, and stop orders\n\nPlease be noted that the system would hold the fees from the orders entered the orderbook in advance.\n\nDo NOT include extra spaces in JSON strings.\n\nPlace Order Limit\nThe maximum limit orders for a single contract is 100 per account, and the maximum stop orders for a single contract is 50 per account.\n:::\n\n:::tip[Tips]\n- The maximum limit orders for a single contract is 100 per account, and the maximum stop orders for a single contract is 50 per account.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchAddOrders\",\"sdk-method-description\":\"Place multiple order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. You can place up to 20 orders at one time, including limit orders, market orders, and stop orders Please be noted that the system would hold the fees from the orders entered the orderbook in advance.\",\"api-rate-limit\":20}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchAddOrders\",\"sdk-method-description\":\"Place multiple order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. You can place up to 20 orders at one time, including limit orders, market orders, and stop orders Please be noted that the system would hold the fees from the orders entered the orderbook in advance.\",\"api-rate-limit-weight\":20}" } }, { @@ -28615,7 +29470,7 @@ { "id": "10401", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -28874,7 +29729,7 @@ }, "visibleSize": { "type": "string", - "description": "Optional for type is 'limit' order, The maximum visible size of an iceberg order. please place order in size (lots), The units of qty (base currency) and valueQty (value) are not supported." + "description": "Optional for type is 'limit' order, The maximum visible size of an iceberg order. please place order in size (lots), The units of qty (base currency) and valueQty (value) are not supported. Need to be defined if iceberg is specified." }, "triggerStopUpPrice": { "type": "string", @@ -28905,7 +29760,7 @@ "mediaType": "" }, "description": ":::info[Description]\nPlace take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order interface.\n\nYou can place two types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n\nPlease be noted that the system would hold the fees from the orders entered the orderbook in advance. \n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addTPSLOrder\",\"sdk-method-description\":\"Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order interface.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"addTPSLOrder\",\"sdk-method-description\":\"Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order interface.\",\"api-rate-limit-weight\":2}" } }, { @@ -28933,7 +29788,7 @@ { "id": "10403", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -28986,7 +29841,7 @@ "mediaType": "" }, "description": ":::info[Description]\nCancel an order (including a stop order).\n\nYou will receive success message once the system has received the cancellation request. The cancellation request will be processed by matching engine in sequence. To know if the request has been processed, you may check the order status or update message from the websocket pushes.\n\nThe `orderId` is the server-assigned order id, not the specified clientOid.\n\nIf the order can not be canceled (already filled or previously canceled, etc), then an error response will indicate the reason in the message field.\n:::\n\n**API KEY PERMISSIONS**\nThis endpoint requires the Futures Trading permission.\n\n**REQUEST URL**\nThis endpoint support Futures URL\n\n**REQUEST RATE LIMIT**\nFutures weight：1\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderById\",\"sdk-method-description\":\"Cancel order by system generated orderId.\",\"api-rate-limit\":1}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderById\",\"sdk-method-description\":\"Cancel order by system generated orderId.\",\"api-rate-limit-weight\":1}" } }, { @@ -29024,7 +29879,7 @@ { "id": "10404", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -29073,7 +29928,7 @@ "mediaType": "" }, "description": ":::info[Description]\nCancel an order (including a stop order).\n\nYou will receive success message once the system has received the cancellation request. The cancellation request will be processed by matching engine in sequence. To know if the request has been processed, you may check the order status or update message from the pushes.\n\nResponse the ID created by the client (clientOid).\n\nIf the order can not be canceled (already filled or previously canceled, etc), then an error response will indicate the reason in the message field.\n:::\n\n**API KEY PERMISSIONS**\nThis endpoint requires the Futures Trading permission.\n\n**REQUEST URL**\nThis endpoint support Futures URL", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByClientOid\",\"sdk-method-description\":\"Cancel order by client defined orderId.\",\"api-rate-limit\":1}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelOrderByClientOid\",\"sdk-method-description\":\"Cancel order by client defined orderId.\",\"api-rate-limit-weight\":1}" } }, { @@ -29092,7 +29947,7 @@ { "id": "10405", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -29188,7 +30043,7 @@ "mediaType": "" }, "description": ":::info[Description]\nUsing this endpoint, orders can be canceled in batches, If there are both normal orders and conditional orders with the same clientOid (it is not recommended to use the same clientOrderId), when cancelling orders in batches by clientOid, normal orders will be canceled and conditional orders will be retained.\n\nSupports batch cancellation of orders by orderId or clientOid. When orderIdsList and clientOidsList are used at the same time, orderIdsList shall prevail. A maximum of 10 orders can be canceled at a time.\n\nWhen using orderId to cancel order, the response will return the orderId.\nWhen using clientOid to cancel order, the response will return the clientOid.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchCancelOrders\",\"sdk-method-description\":\"Cancel a bach of orders by client defined orderId or system generated orderId\",\"api-rate-limit\":20}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"batchCancelOrders\",\"sdk-method-description\":\"Cancel a bach of orders by client defined orderId or system generated orderId\",\"api-rate-limit-weight\":20}" } }, { @@ -29217,7 +30072,7 @@ { "id": "10406", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -29270,7 +30125,7 @@ "mediaType": "" }, "description": ":::info[Description]\nUsing this endpoint, all open orders (excluding stop orders) can be canceled in batches.\n\nThe response is a list of orderIDs of the canceled orders.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllOrdersV3\",\"sdk-method-description\":\"Cancel all open orders (excluding stop orders). The response is a list of orderIDs of the canceled orders.\",\"api-rate-limit\":10}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllOrdersV3\",\"sdk-method-description\":\"Cancel all open orders (excluding stop orders). The response is a list of orderIDs of the canceled orders.\",\"api-rate-limit-weight\":10}" } }, { @@ -29299,7 +30154,7 @@ { "id": "10407", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -29352,7 +30207,7 @@ "mediaType": "" }, "description": ":::info[Description]\nUsing this endpoint, all untriggered stop orders can be canceled in batches.\n\nSupports batch cancellation of untriggered stop orders by symbol. Cancel all all untriggered stop orders for a specific contract symbol only , If not specified, all the all untriggered stop orders will be canceled.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllStopOrders\",\"sdk-method-description\":\"Cancel all untriggered stop orders. The response is a list of orderIDs of the canceled stop orders. To cancel triggered stop orders, please use 'Cancel Multiple Futures Limit orders'.\",\"api-rate-limit\":15}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllStopOrders\",\"sdk-method-description\":\"Cancel all untriggered stop orders. The response is a list of orderIDs of the canceled stop orders. To cancel triggered stop orders, please use 'Cancel Multiple Futures Limit orders'.\",\"api-rate-limit-weight\":15}" } }, { @@ -29381,7 +30236,7 @@ { "id": "10409", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -29739,7 +30594,7 @@ "mediaType": "" }, "description": ":::info[Description]\nGet a single order by order id (including a stop order).\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByOrderId\",\"sdk-method-description\":\"Get a single order by order id (including a stop order).\",\"api-rate-limit\":5}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByOrderId\",\"sdk-method-description\":\"Get a single order by order id (including a stop order).\",\"api-rate-limit-weight\":5}" } }, { @@ -29751,13 +30606,13 @@ "parameters": { "query": [ { - "required": false, - "description": "The user self-defined order id.", - "type": "string", "id": "hieQtTqErS", - "enable": true, "name": "clientOid", - "example": "5c52e11203aa677f33e493fb" + "required": true, + "description": "The user self-defined order ID.", + "example": "5c52e11203aa677f33e493fb", + "type": "string", + "enable": true } ], "path": [], @@ -29785,7 +30640,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "type": { "type": "string", @@ -29829,7 +30684,7 @@ }, "price": { "type": "string", - "description": "Order price" + "description": "Order Price" }, "size": { "type": "integer", @@ -29849,7 +30704,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](apidog://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](apidog://link/pages/338146) is divided into these strategies: CN, CO, CB. DC not currently supported.", "enum": [ "", "CN", @@ -29906,12 +30761,12 @@ { "value": "MP", "name": "mark price", - "description": "MP for mark price, The mark price can be obtained through relevant OPEN API for index services" + "description": "MP for mark price. The mark price can be obtained through relevant OPEN API for index services." }, { "value": "IP", "name": "index price", - "description": "IP for index price, The index price can be obtained through relevant OPEN API for index services" + "description": "IP for index price. The index price can be obtained through relevant OPEN API for index services." } ] }, @@ -29945,7 +30800,7 @@ }, "forceHold": { "type": "boolean", - "description": "A mark to forcely hold the funds for an order\n" + "description": "A mark to force-hold the funds for an order\n" }, "closeOrder": { "type": "boolean", @@ -29957,7 +30812,7 @@ }, "clientOid": { "type": "string", - "description": "Unique order id created by users to identify their orders\n" + "description": "Unique order ID created by users to identify their orders\n" }, "remark": { "type": "string", @@ -29965,7 +30820,7 @@ }, "tags": { "type": "string", - "description": "tag order source\n" + "description": "Tag order source\n" }, "isActive": { "type": "boolean", @@ -29977,12 +30832,12 @@ }, "createdAt": { "type": "integer", - "description": "Time the order created\n", + "description": "Order creation time\n", "format": "int64" }, "updatedAt": { "type": "integer", - "description": "last update time\n", + "description": "Last update time\n", "format": "int64" }, "endAt": { @@ -29992,12 +30847,12 @@ }, "orderTime": { "type": "integer", - "description": "Order create time in nanosecond\n", + "description": "Order creation time in nanoseconds\n", "format": "int64" }, "settleCurrency": { "type": "string", - "description": "settlement currency\n" + "description": "Settlement currency\n" }, "marginMode": { "type": "string", @@ -30021,7 +30876,7 @@ }, "avgDealPrice": { "type": "string", - "description": "Average transaction price, forward contract average transaction price = sum (transaction value) / sum (transaction quantity), reverse contract average transaction price = sum (transaction quantity) / sum (transaction value). Transaction quantity = lots * multiplier\n" + "description": "Average transaction price, forward contract average transaction price = sum (transaction value) / sum (transaction quantity); reverse contract average transaction price = sum (transaction quantity) / sum (transaction value). Transaction quantity = lots * multiplier\n" }, "filledSize": { "type": "integer", @@ -30126,8 +30981,8 @@ "example": "", "mediaType": "" }, - "description": ":::info[Description]\nGet a single order by client order id (including a stop order).\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByClientOid\",\"sdk-method-description\":\"Get a single order by client order id (including a stop order).\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nGet a single order by client order ID (including a stop order).\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getOrderByClientOid\",\"sdk-method-description\":\"Get a single order by client order ID (including a stop order).\",\"api-rate-limit-weight\":5}" } }, { @@ -30141,7 +30996,7 @@ { "id": "2KbksGFfyd", "name": "status", - "required": true, + "required": false, "description": "active or done, done as default. Only list orders for a specific status", "example": "done", "type": "string", @@ -30177,7 +31032,7 @@ { "id": "uaSHeFQTjq", "name": "side", - "required": true, + "required": false, "description": "buy or sell", "type": "string", "schema": { @@ -30204,25 +31059,49 @@ { "id": "WUcubn1a2F", "name": "type", - "required": true, - "description": "limit, market, limit_stop or market_stop", + "required": false, + "description": "Order Type", "type": "string", "schema": { "type": "string", "enum": [ "limit", - "market" + "market", + "limit_stop", + "market_stop", + "oco_limit", + "oco_stop" ], "x-api-enum": [ { "value": "limit", - "name": "", - "description": "" + "name": "limit", + "description": "Limit order" }, { "value": "market", - "name": "", - "description": "" + "name": "market", + "description": "Market order" + }, + { + "value": "limit_stop", + "name": "limit_stop", + "description": "Stop limit order" + }, + { + "value": "market_stop", + "name": "market_stop", + "description": "Stop market order" + }, + { + "value": "oco_limit", + "name": "oco_limit", + "description": "Oco limit order" + }, + { + "value": "oco_stop", + "name": "oco_stop", + "description": "Oco stop order" } ] }, @@ -30255,22 +31134,25 @@ { "id": "1CHlZrEtu0", "name": "currentPage", - "required": true, + "required": false, "description": "Current request page, The default currentPage is 1", "type": "integer", "schema": { - "type": "integer" + "type": "integer", + "default": 1 }, "enable": true }, { "id": "nlqXQHDnh5", "name": "pageSize", - "required": true, + "required": false, "description": "pageSize, The default pageSize is 50, The maximum cannot exceed 1000", "type": "integer", "schema": { - "type": "integer" + "type": "integer", + "default": 50, + "maximum": 1000 }, "enable": true } @@ -30283,7 +31165,7 @@ { "id": "10408", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -30551,7 +31433,7 @@ "mediaType": "" }, "description": ":::info[Description]\nList your current orders.\n\nAny limit order on the exchange order book is in active status. Orders removed from the order book will be marked with done status. After an order becomes done, there may be a few milliseconds latency before it’s fully settled.\n\nYou can check the orders in any status. If the status parameter is not specified, orders of done status will be returned by default.\n\nWhen you query orders in active status, there is no time limit. However, when you query orders in done status, the start and end time range cannot exceed 24 * 7 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.\n\n**POLLING**\nFor high-volume trading, it is highly recommended that you maintain your own list of open orders and use one of the streaming market data feeds to keep it updated. You should poll the open orders endpoint to obtain the current state of any open order.\n\nIf you need to get your recent trade history with low latency, you may query the endpoint Get List of Orders Completed in 24h.\n:::\n\n**API KEY PERMISSIONS**\nThis endpoint requires the General permission.\n\n**REQUEST URL**\nThis endpoint support Futures URL\n\n**REQUEST RATE LIMIT**\nFutures weight：2", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"GetOrderList\",\"sdk-method-description\":\"List your current orders.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"GetOrderList\",\"sdk-method-description\":\"List your current orders.\",\"api-rate-limit-weight\":2}" } }, { @@ -30580,7 +31462,7 @@ { "id": "10410", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -30822,7 +31704,7 @@ "mediaType": "" }, "description": ":::info[Description]\nGet a list of recent 1000 closed orders in the last 24 hours.\n\nIf you need to get your recent traded order history with low latency, you may query this endpoint.\n\n\nAny limit order on the exchange order book is in active status. Orders removed from the order book will be marked with done status. After an order becomes done, there may be a few milliseconds latency before it’s fully settled.\n\nYou can check the orders in any status. If the status parameter is not specified, orders of done status will be returned by default.\n\nWhen you query orders in active status, there is no time limit. However, when you query orders in done status, the start and end time range cannot exceed 24*7 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.\n\n**POLLING**\nFor high-volume trading, it is highly recommended that you maintain your own list of open orders and use one of the streaming market data feeds to keep it updated. You should poll the open orders endpoint to obtain the current state of any open order.\n\nIf you need to get your recent trade history with low latency, you may query the endpoint Get List of Orders Completed in 24h.\n:::\n\n**API KEY PERMISSIONS**\nThis endpoint requires the General permission.\n\n**REQUEST URL**\nThis endpoint support Futures URL\n\n**REQUEST RATE LIMIT**\nFutures weight：2\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"GetRecentClosedOrders\",\"sdk-method-description\":\"Get a list of recent 1000 closed orders in the last 24 hours. If you need to get your recent traded order history with low latency, you may query this endpoint.\",\"api-rate-limit\":5}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"GetRecentClosedOrders\",\"sdk-method-description\":\"Get a list of recent 1000 closed orders in the last 24 hours. If you need to get your recent traded order history with low latency, you may query this endpoint.\",\"api-rate-limit-weight\":5}" } }, { @@ -30953,7 +31835,7 @@ { "id": "10411", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -31221,7 +32103,7 @@ "mediaType": "" }, "description": ":::info[Description]\nGet the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order interface\n:::\n\nAny limit order on the exchange order book is in active status. Orders removed from the order book will be marked with done status. After an order becomes done, there may be a few milliseconds latency before it’s fully settled.\n\nYou can check the orders in any status. If the status parameter is not specified, orders of done status will be returned by default.\n\nWhen you query orders in active status, there is no time limit. However, when you query orders in done status, the start and end time range cannot exceed 24*7 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.\n\nPOLLING\nFor high-volume trading, it is highly recommended that you maintain your own list of open orders and use one of the streaming market data feeds to keep it updated. You should poll the open orders endpoint to obtain the current state of any open order.\n\nIf you need to get your recent trade history with low latency, you may query the endpoint Get List of Orders Completed in 24h.", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"GetStopOrderList\",\"sdk-method-description\":\"Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order interface\",\"api-rate-limit\":6}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"GetStopOrderList\",\"sdk-method-description\":\"Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order interface\",\"api-rate-limit-weight\":6}" } }, { @@ -31236,7 +32118,7 @@ "id": "4wXlXiQszi", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "example": "XBTUSDTM", "type": "string", "enable": true @@ -31250,7 +32132,7 @@ { "id": "10414", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -31263,23 +32145,23 @@ "properties": { "openOrderBuySize": { "type": "integer", - "description": "Total number of the unexecuted buy orders\n" + "description": "Total number of unexecuted buy orders\n" }, "openOrderSellSize": { "type": "integer", - "description": "Total number of the unexecuted sell orders\n" + "description": "Total number of unexecuted sell orders\n" }, "openOrderBuyCost": { "type": "string", - "description": "Value of all the unexecuted buy orders\n" + "description": "Value of all unexecuted buy orders\n" }, "openOrderSellCost": { "type": "string", - "description": "Value of all the unexecuted sell orders\n" + "description": "Value of all unexecuted sell orders\n" }, "settleCurrency": { "type": "string", - "description": "settlement currency\n" + "description": "Settlement currency\n" } }, "required": [ @@ -31319,8 +32201,8 @@ "example": "", "mediaType": "" }, - "description": ":::info[Description]\nYou can query this endpoint to get the the total number and value of the all your active orders.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"GetOpenOrderValue\",\"sdk-method-description\":\"You can query this endpoint to get the the total number and value of the all your active orders.\",\"api-rate-limit\":10}" + "description": ":::info[Description]\nYou can query this endpoint to get the total number and value of all your active orders.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"GetOpenOrderValue\",\"sdk-method-description\":\"You can query this endpoint to get the total number and value of all your active orders.\",\"api-rate-limit-weight\":10}" } }, { @@ -31330,18 +32212,17 @@ "method": "get", "path": "/api/v1/recentFills", "parameters": { + "path": [], "query": [ { "id": "4wXlXiQszi", "name": "symbol", "required": false, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "example": "XBTUSDTM", - "type": "string", - "enable": true + "type": "string" } ], - "path": [], "cookie": [], "header": [] }, @@ -31349,7 +32230,7 @@ { "id": "10413", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -31364,7 +32245,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "tradeId": { "type": "string", @@ -31396,7 +32277,7 @@ }, "liquidity": { "type": "string", - "description": "Liquidity- taker or maker\n", + "description": "Liquidity-taker or -maker\n", "enum": [ "taker", "maker" @@ -31448,7 +32329,7 @@ }, "fixFee": { "type": "string", - "description": "Fixed fees(Deprecated field, no actual use of the value field)\n" + "description": "Fixed fees (Deprecated field, no actual use of the value field)\n" }, "feeCurrency": { "type": "string", @@ -31456,7 +32337,7 @@ }, "tradeTime": { "type": "integer", - "description": "trade time in nanosecond\n", + "description": "Trade time in nanoseconds\n", "format": "int64" }, "subTradeType": { @@ -31562,7 +32443,7 @@ { "value": "cancel", "name": "cancel", - "description": "Partially filled and cancelled orders" + "description": "Partially filled and canceled orders" }, { "value": "liquid", @@ -31583,7 +32464,7 @@ }, "createdAt": { "type": "integer", - "description": "Time the order created\n", + "description": "Order creation time\n", "format": "int64" } }, @@ -31644,8 +32525,8 @@ "example": "", "mediaType": "" }, - "description": ":::info[Description]\nGet a list of recent 1000 fills in the last 24 hours. If you need to get your recent traded order history with low latency, you may query this endpoint.\n\nIf you need to get your recent traded order history with low latency, you may query this endpoint.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getRecentTradeHistory\",\"sdk-method-description\":\"Get a list of recent 1000 fills in the last 24 hours. If you need to get your recent traded order history with low latency, you may query this endpoint.\",\"api-rate-limit\":3}" + "description": ":::info[Description]\nGet a list of recent 1000 fills in the last 24 hours. If you need to get your recently traded order history with low latency, you may query this endpoint.\n\nIf you need to get your recently traded order history with low latency, you may query this endpoint.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getRecentTradeHistory\",\"sdk-method-description\":\"Get a list of recent 1000 fills in the last 24 hours. If you need to get your recently traded order history with low latency, you may query this endpoint.\"}" } }, { @@ -31660,7 +32541,7 @@ "id": "2KbksGFfyd", "name": "orderId", "required": false, - "description": "List fills for a specific order only (If you specify orderId, other parameters can be ignored)", + "description": "List fills for a specific order only (if you specify orderId, other parameters can be ignored)", "example": "236655147005071361", "type": "string", "enable": true @@ -31669,7 +32550,7 @@ "id": "4wXlXiQszi", "name": "symbol", "required": false, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "type": "string", "enable": true }, @@ -31679,7 +32560,6 @@ "required": false, "description": "Order side", "type": "string", - "enable": true, "schema": { "type": "string", "enum": [ @@ -31698,7 +32578,8 @@ "description": "sell" } ] - } + }, + "enable": true }, { "id": "WUcubn1a2F", @@ -31706,7 +32587,6 @@ "required": false, "description": "Order Type", "type": "string", - "enable": true, "schema": { "type": "string", "enum": [ @@ -31737,15 +32617,15 @@ "description": "Stop Market order" } ] - } + }, + "enable": true }, { - "required": false, - "description": "Transaction type: trade, adl, liquid, settlement. Supports querying multiple types at the same time, separated by commas. Query all type when empty", - "type": "string", "id": "n3uTl3OSFi", - "enable": true, "name": "tradeTypes", + "required": false, + "description": "Transaction type: trade, adl, liquid, settlement. Supports querying multiple types at the same time, separated by commas. Query all types when empty", + "type": "string", "schema": { "type": "string", "examples": [ @@ -31755,13 +32635,14 @@ "settlement", "adl,liquid" ] - } + }, + "enable": true }, { "id": "92p8ibIf57", "name": "startAt", "required": false, - "description": "Start time (milisecond)", + "description": "Start time (milliseconds)", "type": "integer", "schema": { "type": "integer", @@ -31773,7 +32654,7 @@ "id": "xa3hJqPSIi", "name": "endAt", "required": false, - "description": "End time (milisecond)", + "description": "End time (milliseconds)", "type": "integer", "schema": { "type": "integer", @@ -31785,7 +32666,7 @@ "id": "1CHlZrEtu0", "name": "currentPage", "required": false, - "description": "Current request page, The default currentPage is 1", + "description": "Current request page. The default currentPage is 1", "type": "integer", "schema": { "type": "integer", @@ -31797,7 +32678,7 @@ "id": "nlqXQHDnh5", "name": "pageSize", "required": false, - "description": "pageSize, The default pageSize is 50, The maximum cannot exceed 1000", + "description": "pageSize, The default pageSize is 50; the maximum cannot exceed 1000", "type": "integer", "schema": { "type": "integer", @@ -31815,7 +32696,7 @@ { "id": "10412", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -31845,7 +32726,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "tradeId": { "type": "string", @@ -31877,7 +32758,7 @@ }, "liquidity": { "type": "string", - "description": "Liquidity- taker or maker", + "description": "Liquidity-taker or -maker", "enum": [ "taker", "maker" @@ -31929,7 +32810,7 @@ }, "fixFee": { "type": "string", - "description": "Fixed fees(Deprecated field, no actual use of the value field)" + "description": "Fixed fees (Deprecated field, no actual use of the value field)" }, "feeCurrency": { "type": "string", @@ -31937,7 +32818,7 @@ }, "tradeTime": { "type": "integer", - "description": "trade time in nanosecond", + "description": "Trade time in nanoseconds", "format": "int64" }, "subTradeType": { @@ -31955,53 +32836,54 @@ { "value": "ISOLATED", "name": "ISOLATED", - "description": "Isolated Margin" + "description": "Isolated margin" }, { "value": "CROSS", "name": "CROSS", - "description": "Cross Margin" + "description": "Cross margin" } ] }, "settleCurrency": { "type": "string", - "description": "Settle Currency" + "description": "Settle currency" }, "displayType": { "type": "string", + "description": "Order type", "enum": [ "limit", "market", "limit_stop", "market_stop" ], - "description": "Order Type", "x-api-enum": [ { "value": "limit", "name": "limit", - "description": "Limit order" + "description": "limit order" }, { "value": "market", "name": "market", - "description": "Market order" + "description": "market order" }, { "value": "limit_stop", "name": "limit_stop", - "description": "Stop limit order" + "description": "stop limit order" }, { "value": "market_stop", "name": "market_stop", - "description": "Stop Market order" + "description": "stop market order" } ] }, "fee": { - "type": "string" + "type": "string", + "description": "Trading fee" }, "orderType": { "type": "string", @@ -32057,8 +32939,16 @@ }, "createdAt": { "type": "integer", - "description": "Time the order created\n", + "description": "Order creation time\n", "format": "int64" + }, + "openFeeTaxPay": { + "type": "string", + "description": "Opening tax fee (Only kyc users in some regions have this parameter)" + }, + "closeFeeTaxPay": { + "type": "string", + "description": "Close tax fee (Only kyc users in some regions have this parameter)" } }, "required": [ @@ -32080,9 +32970,11 @@ "tradeTime", "subTradeType", "marginMode", - "settleCurrency", + "openFeeTaxPay", + "closeFeeTaxPay", "displayType", "fee", + "settleCurrency", "orderType", "tradeType", "createdAt" @@ -32112,7 +33004,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 2,\n \"totalPage\": 1,\n \"items\": [\n {\n \"symbol\": \"XBTUSDTM\",\n \"tradeId\": \"1784277229880\",\n \"orderId\": \"236317213710184449\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"forceTaker\": false,\n \"price\": \"67430.9\",\n \"size\": 1,\n \"value\": \"67.4309\",\n \"openFeePay\": \"0.04045854\",\n \"closeFeePay\": \"0\",\n \"stop\": \"\",\n \"feeRate\": \"0.00060\",\n \"fixFee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"settleCurrency\": \"USDT\",\n \"fee\": \"0.04045854\",\n \"orderType\": \"market\",\n \"displayType\": \"market\",\n \"tradeType\": \"trade\",\n \"subTradeType\": null,\n \"tradeTime\": 1729155616320000000,\n \"createdAt\": 1729155616493\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"tradeId\": \"1784277132002\",\n \"orderId\": \"236317094436728832\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"forceTaker\": false,\n \"price\": \"67445\",\n \"size\": 1,\n \"value\": \"67.445\",\n \"openFeePay\": \"0\",\n \"closeFeePay\": \"0.040467\",\n \"stop\": \"\",\n \"feeRate\": \"0.00060\",\n \"fixFee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"settleCurrency\": \"USDT\",\n \"fee\": \"0.040467\",\n \"orderType\": \"market\",\n \"displayType\": \"market\",\n \"tradeType\": \"trade\",\n \"subTradeType\": null,\n \"tradeTime\": 1729155587944000000,\n \"createdAt\": 1729155588104\n }\n ]\n }\n}", + "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 2,\n \"totalPage\": 1,\n \"items\": [\n {\n \"symbol\": \"XBTUSDTM\",\n \"tradeId\": \"1828954878212\",\n \"orderId\": \"284486580251463680\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"forceTaker\": false,\n \"price\": \"86275.1\",\n \"size\": 1,\n \"value\": \"86.2751\",\n \"openFeePay\": \"0.05176506\",\n \"closeFeePay\": \"0\",\n \"stop\": \"\",\n \"feeRate\": \"0.00060\",\n \"fixFee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"subTradeType\": null,\n \"marginMode\": \"CROSS\",\n \"openFeeTaxPay\": \"0\",\n \"closeFeeTaxPay\": \"0\",\n \"displayType\": \"market\",\n \"fee\": \"0.05176506\",\n \"settleCurrency\": \"USDT\",\n \"orderType\": \"market\",\n \"tradeType\": \"trade\",\n \"tradeTime\": 1740640088244000000,\n \"createdAt\": 1740640088427\n }\n ]\n }\n}", "responseId": 10412, "ordering": 1 } @@ -32127,8 +33019,8 @@ "example": "", "mediaType": "" }, - "description": ":::info[Description]\nGet a list of recent fills. If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time.\n:::\n\n**Data Time Range**\n\nThe system allows you to retrieve data up to one week (start from the last day by default). If the time period of the queried data exceeds one week (time range from the start time to end time exceeded 24*7 hours), the system will prompt to remind you that you have exceeded the time limit. If you only specified the start time, the system will automatically calculate the end time (end time = start time + 24 hours). On the contrary, if you only specified the end time, the system will calculate the start time (start time= end time - 24 hours) the same way.\n\n**Fee**\n\nOrders on KuCoin Futures platform are classified into two types, taker and maker. A taker order matches other resting orders on the exchange order book, and gets executed immediately after order entry. A maker order, on the contrary, stays on the exchange order book and awaits to be matched. Taker orders will be charged taker fees, while maker orders will receive maker rebates. Please note that market orders, iceberg orders and hidden orders are always charged taker fees.\n\nThe system will pre-freeze a predicted taker fee when you place an order.The liquidity field indicates if the fill was charged taker or maker fees.\n\nThe system will pre-freeze the predicted fees (including the maintenance margin needed for the position, entry fees and fees to close positions) if you added the position, and will not pre-freeze fees if you reduced the position. After the order is executed, if you added positions, the system will deduct entry fees from your balance, if you closed positions, the system will deduct the close fees.", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getTradeHistory\",\"sdk-method-description\":\"Get a list of recent fills. If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nGet a list of recent fills. If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time.\n:::\n\n**Data Time Range**\n\nThe system allows you to retrieve up to one week’s worth of data (starting from the last day by default). If the time period of the queried data exceeds one week (time range from start time to end time exceeding 24 * 7 hours), the system will prompt to remind you that you have exceeded the time limit. If you only specified the start time, the system will automatically calculate the end time (end time = start time + 24 hours). Conversely, if you only specified the end time, the system will calculate the start time (start time = end time - 24 hours) the same way.\n\n**Fee**\n\nOrders on KuCoin Futures platform are classified into two types, taker and maker. A taker order matches other resting orders on the exchange order book, and gets executed immediately after order entry. A maker order, on the other hand, stays on the exchange order book and awaits to be matched. Taker orders will be charged taker fees, while maker orders will receive maker rebates. Please note that market orders, iceberg orders and hidden orders are always charged taker fees.\n\nThe system will pre-freeze a predicted taker fee when you place an order. The liquidity field indicates if the fill was charged taker or maker fees.\n\nThe system will pre-freeze the predicted fees (including the maintenance margin needed for the position, entry fees and fees to close positions) if you added the position, and will not pre-freeze fees if you reduced the position. After the order is executed, if you added positions, the system will deduct entry fees from your balance; if you closed positions, the system will deduct the close fees.", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"getTradeHistory\",\"sdk-method-description\":\"Get a list of recent fills. If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time.\",\"api-rate-limit-weight\":5}" } } ] @@ -32235,7 +33127,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis interface can query the margin mode of the current symbol.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"getMarginMode\",\"sdk-method-description\":\"This interface can query the margin mode of the current symbol.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"getMarginMode\",\"sdk-method-description\":\"This interface can query the margin mode of the current symbol.\",\"api-rate-limit-weight\":2}" } }, { @@ -32359,7 +33251,7 @@ "mediaType": "" }, "description": ":::info[Description]\nModify the margin mode of the current symbol.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"switchMarginMode\",\"sdk-method-description\":\"This interface can modify the margin mode of the current symbol.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"switchMarginMode\",\"sdk-method-description\":\"This interface can modify the margin mode of the current symbol.\",\"api-rate-limit-weight\":2}" } }, { @@ -32374,7 +33266,7 @@ "id": "4wXlXiQszi", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "type": "string", "schema": { "type": "string", @@ -32390,7 +33282,7 @@ "id": "uaSHeFQTjq", "name": "price", "required": true, - "description": "Order price\n", + "description": "Order Price\n", "type": "string", "enable": true }, @@ -32414,7 +33306,7 @@ { "id": "10415", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -32427,7 +33319,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "maxBuyOpenSize": { "type": "integer", @@ -32474,7 +33366,7 @@ "mediaType": "" }, "description": ":::info[Description]\nGet Maximum Open Position Size.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"GetMaxOpenSize\",\"sdk-method-description\":\"Get Maximum Open Position Size.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"GetMaxOpenSize\",\"sdk-method-description\":\"Get Maximum Open Position Size.\",\"api-rate-limit-weight\":2}" } }, { @@ -32787,7 +33679,7 @@ "mediaType": "" }, "description": ":::info[Description]\nGet the position details of a specified position.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"GetPositionDetails\",\"sdk-method-description\":\"Get the position details of a specified position.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"GetPositionDetails\",\"sdk-method-description\":\"Get the position details of a specified position.\",\"api-rate-limit-weight\":2}" } }, { @@ -33111,7 +34003,7 @@ "mediaType": "" }, "description": ":::info[Description]\nGet the position details of a specified position.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"GetPositionList\",\"sdk-method-description\":\"Get the position details of a specified position.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"GetPositionList\",\"sdk-method-description\":\"Get the position details of a specified position.\",\"api-rate-limit-weight\":2}" } }, { @@ -33302,6 +34194,26 @@ "description": "isolated margin" } ] + }, + "realisedGrossCostNew": { + "type": "string" + }, + "tax": { + "type": "string", + "description": "Tax" + }, + "roe": { + "type": "string" + }, + "liquidAmount": { + "type": "string" + }, + "liquidPrice": { + "type": "string" + }, + "side": { + "type": "string", + "description": "Position side" } }, "required": [ @@ -33320,7 +34232,12 @@ "closeTime", "openPrice", "closePrice", - "marginMode" + "marginMode", + "realisedGrossCostNew", + "tax", + "liquidAmount", + "liquidPrice", + "side" ] } } @@ -33347,7 +34264,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 10,\n \"totalNum\": 3,\n \"totalPage\": 1,\n \"items\": [\n {\n \"closeId\": \"500000000027312193\",\n \"userId\": \"633559791e1cbc0001f319bc\",\n \"symbol\": \"XBTUSDTM\",\n \"settleCurrency\": \"USDT\",\n \"leverage\": \"0.0\",\n \"type\": \"CLOSE_SHORT\",\n \"pnl\": \"-3.79237944\",\n \"realisedGrossCost\": \"3.795\",\n \"withdrawPnl\": \"0.0\",\n \"tradeFee\": \"0.078657\",\n \"fundingFee\": \"0.08127756\",\n \"openTime\": 1727073653603,\n \"closeTime\": 1729155587945,\n \"openPrice\": \"63650.0\",\n \"closePrice\": \"67445.0\",\n \"marginMode\": \"ISOLATED\"\n },\n {\n \"closeId\": \"500000000026809668\",\n \"userId\": \"633559791e1cbc0001f319bc\",\n \"symbol\": \"SUIUSDTM\",\n \"settleCurrency\": \"USDT\",\n \"leverage\": \"0.0\",\n \"type\": \"LIQUID_SHORT\",\n \"pnl\": \"-1.10919296\",\n \"realisedGrossCost\": \"1.11297635\",\n \"withdrawPnl\": \"0.0\",\n \"tradeFee\": \"0.00200295\",\n \"fundingFee\": \"0.00578634\",\n \"openTime\": 1726473389296,\n \"closeTime\": 1728738683541,\n \"openPrice\": \"1.1072\",\n \"closePrice\": \"2.22017635\",\n \"marginMode\": \"ISOLATED\"\n },\n {\n \"closeId\": \"500000000026819355\",\n \"userId\": \"633559791e1cbc0001f319bc\",\n \"symbol\": \"XBTUSDTM\",\n \"settleCurrency\": \"USDT\",\n \"leverage\": \"0.0\",\n \"type\": \"LIQUID_SHORT\",\n \"pnl\": \"-5.941896296\",\n \"realisedGrossCost\": \"5.86937042\",\n \"withdrawPnl\": \"0.0\",\n \"tradeFee\": \"0.074020096\",\n \"fundingFee\": \"0.00149422\",\n \"openTime\": 1726490775358,\n \"closeTime\": 1727061049859,\n \"openPrice\": \"58679.6\",\n \"closePrice\": \"64548.97042\",\n \"marginMode\": \"ISOLATED\"\n }\n ]\n }\n}", + "data": "{\r\n \"code\": \"200000\",\r\n \"data\": {\r\n \"currentPage\": 1,\r\n \"pageSize\": 10,\r\n \"totalNum\": 1,\r\n \"totalPage\": 1,\r\n \"items\": [\r\n {\r\n \"closeId\": \"500000000036305465\",\r\n \"userId\": \"633559791e1cbc0001f319bc\",\r\n \"symbol\": \"XBTUSDTM\",\r\n \"settleCurrency\": \"USDT\",\r\n \"leverage\": \"1.0\",\r\n \"type\": \"CLOSE_LONG\",\r\n \"pnl\": \"0.51214413\",\r\n \"realisedGrossCost\": \"-0.5837\",\r\n \"realisedGrossCostNew\": \"-0.5837\",\r\n \"withdrawPnl\": \"0.0\",\r\n \"tradeFee\": \"0.03766066\",\r\n \"fundingFee\": \"-0.03389521\",\r\n \"openTime\": 1735549162120,\r\n \"closeTime\": 1735589352069,\r\n \"openPrice\": \"93859.8\",\r\n \"closePrice\": \"94443.5\",\r\n \"marginMode\": \"CROSS\",\r\n \"tax\": \"0.0\",\r\n \"roe\": null,\r\n \"liquidAmount\": null,\r\n \"liquidPrice\": null,\r\n \"side\": \"LONG\"\r\n }\r\n ]\r\n }\r\n}", "responseId": 10418, "ordering": 1 } @@ -33363,7 +34280,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis interface can query position history information records.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"GetPositionsHistory\",\"sdk-method-description\":\"This interface can query position history information records.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"GetPositionsHistory\",\"sdk-method-description\":\"This interface can query position history information records.\",\"api-rate-limit-weight\":2}" } }, { @@ -33433,7 +34350,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis interface can query the maximum amount of margin that the current position supports withdrawal.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"GetMaxWithdrawMargin\",\"sdk-method-description\":\"This interface can query the maximum amount of margin that the current position supports withdrawal.\",\"api-rate-limit\":10}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"GetMaxWithdrawMargin\",\"sdk-method-description\":\"This interface can query the maximum amount of margin that the current position supports withdrawal.\",\"api-rate-limit-weight\":10}" } }, { @@ -33517,7 +34434,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis interface can query the current symbol’s cross-margin leverage multiple.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"getCrossMarginLeverage\",\"sdk-method-description\":\"This interface can query the current symbol’s cross-margin leverage multiple.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"getCrossMarginLeverage\",\"sdk-method-description\":\"This interface can query the current symbol’s cross-margin leverage multiple.\",\"api-rate-limit-weight\":2}" } }, { @@ -33536,7 +34453,7 @@ { "id": "10425", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -33545,19 +34462,7 @@ "type": "string" }, "data": { - "type": "object", - "properties": { - "symbol": { - "type": "string" - }, - "leverage": { - "type": "string" - } - }, - "required": [ - "symbol", - "leverage" - ] + "type": "boolean" } }, "required": [ @@ -33573,7 +34478,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"XBTUSDTM\",\n \"leverage\": \"3\"\n }\n}", + "data": "{\r\n \"code\": \"200000\",\r\n \"data\": true\r\n}", "responseId": 10425, "ordering": 1 } @@ -33602,7 +34507,7 @@ "mediaType": "" }, "description": ":::info[Description]\nThis interface can modify the current symbol’s cross-margin leverage multiple.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"ModifyMarginLeverage\",\"sdk-method-description\":\"This interface can modify the current symbol’s cross-margin leverage multiple.\",\"api-rate-limit\":2}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"ModifyMarginLeverage\",\"sdk-method-description\":\"This interface can modify the current symbol’s cross-margin leverage multiple.\",\"api-rate-limit-weight\":2}" } }, { @@ -33871,7 +34776,7 @@ "mediaType": "" }, "description": ":::info[Description]\nAdd Isolated Margin Manually.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"AddIsolatedMargin\",\"sdk-method-description\":\"Add Isolated Margin Manually.\",\"api-rate-limit\":4}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"AddIsolatedMargin\",\"sdk-method-description\":\"Add Isolated Margin Manually.\",\"api-rate-limit-weight\":4}" } }, { @@ -33945,7 +34850,7 @@ "mediaType": "" }, "description": ":::info[Description]\nRemove Isolated Margin Manually.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"RemoveIsolatedMargin\",\"sdk-method-description\":\"Remove Isolated Margin Manually.\",\"api-rate-limit\":10}" + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"RemoveIsolatedMargin\",\"sdk-method-description\":\"Remove Isolated Margin Manually.\",\"api-rate-limit-weight\":10}" } }, { @@ -33961,7 +34866,7 @@ "id": "symbol#0", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "example": "XBTUSDTM", "type": "string", "enable": true @@ -33974,7 +34879,7 @@ { "id": "10427", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -33989,15 +34894,15 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "level": { "type": "integer", - "description": "level\n" + "description": "Level\n" }, "maxRiskLimit": { "type": "integer", - "description": "Upper limit USDT(includes)\n" + "description": "Upper limit USDT (included)\n" }, "minRiskLimit": { "type": "integer", @@ -34005,7 +34910,7 @@ }, "maxLeverage": { "type": "integer", - "description": "Max leverage\n" + "description": "Max. leverage\n" }, "initialMargin": { "type": "number", @@ -34056,8 +34961,8 @@ "example": "", "mediaType": "" }, - "description": ":::info[Description]\nThis interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"getIsolatedMarginRiskLimit\",\"sdk-method-description\":\"This interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis interface can be used to obtain information about risk limit level of a specific contract (only valid for Isolated Margin).\n:::\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"NULL\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"getIsolatedMarginRiskLimit\",\"sdk-method-description\":\"This interface can be used to obtain information about risk limit level of a specific contract (only valid for Isolated Margin).\",\"api-rate-limit-weight\":5}" } }, { @@ -34076,7 +34981,7 @@ { "id": "10428", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -34086,7 +34991,7 @@ }, "data": { "type": "boolean", - "description": "To adjust the level will cancel the open order, the response can only indicate whether the submit of the adjustment request is successful or not.\n" + "description": "Adjusting the level will result in the cancellation of any open orders. The response will indicate only whether the adjustment request was successfully submitted.\n" } }, "required": [ @@ -34115,11 +35020,11 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "level": { "type": "integer", - "description": "level" + "description": "Level" } }, "required": [ @@ -34130,8 +35035,8 @@ "example": "{\n \"symbol\" : \"XBTUSDTM\",\n \"level\" : 2\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis interface is for the adjustment of the risk limit level(Only valid for isolated Margin). To adjust the level will cancel the open order, the response can only indicate whether the submit of the adjustment request is successful or not. The result of the adjustment can be achieved by WebSocket information: Position Change Events\n\n:::\n\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"modifyIsolatedMarginRiskLimt\",\"sdk-method-description\":\"This interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis interface is for adjusting the risk limit level (only valid for Isolated Margin). Adjusting the level will result in the cancellation of any open orders. The response will indicate only whether the adjustment request was successfully submitted. The result of the adjustment can be obtained with information from Websocket: Position Change Events.\n\n:::\n\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Positions\",\"sdk-method-name\":\"modifyIsolatedMarginRiskLimt\",\"sdk-method-description\":\"This interface can be used to obtain information about risk limit level of a specific contract (only valid for Isolated Margin).\",\"api-rate-limit-weight\":5}" } } ] @@ -34142,7 +35047,7 @@ "description": "", "items": [ { - "name": "Get Current Funding Rate", + "name": "Get Current Funding Rate.", "api": { "id": "3470265", "method": "get", @@ -34154,7 +35059,7 @@ "id": "symbol#0", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "example": "XBTUSDTM", "type": "string", "enable": true @@ -34184,11 +35089,11 @@ }, "granularity": { "type": "integer", - "description": "Granularity (milisecond)\n" + "description": "Granularity (milliseconds)\n" }, "timePoint": { "type": "integer", - "description": "The funding rate settlement time point of the previous cycle\n(milisecond)\n", + "description": "The funding rate settlement time point of the previous cycle\n(milliseconds)\n", "format": "int64" }, "value": { @@ -34247,8 +35152,8 @@ "example": "", "mediaType": "" }, - "description": ":::info[Description]\nGet Current Funding Rate\n\n\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"FundingFees\",\"sdk-method-name\":\"GetCurrentFundingRate\",\"sdk-method-description\":\"get Current Funding Rate\",\"api-rate-limit\":2}" + "description": ":::info[Description]\nGet Current Funding Rate.\n\n\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"FundingFees\",\"sdk-method-name\":\"getCurrentFundingRate\",\"sdk-method-description\":\"Get Current Funding Rate.\",\"api-rate-limit-weight\":2}" } }, { @@ -34263,7 +35168,7 @@ "id": "6iUCMmMHEI", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "example": "XBTUSDTM", "type": "string", "enable": true @@ -34272,7 +35177,7 @@ "id": "uwjNpV9qGS", "name": "from", "required": true, - "description": "Begin time (milisecond)\n", + "description": "Begin time (milliseconds)\n", "example": "1700310700000", "type": "integer", "schema": { @@ -34285,7 +35190,7 @@ "id": "50Ttxnbf64", "name": "to", "required": true, - "description": "End time (milisecond)\n", + "description": "End time (milliseconds)\n", "example": "1702310700000", "type": "integer", "schema": { @@ -34303,7 +35208,7 @@ { "id": "10430", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -34318,7 +35223,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "fundingRate": { "type": "number", @@ -34326,7 +35231,7 @@ }, "timepoint": { "type": "integer", - "description": "Time point (milisecond)\n\n", + "description": "Time point (milliseconds)\n\n", "format": "int64" } }, @@ -34366,8 +35271,8 @@ "example": "", "mediaType": "" }, - "description": ":::info[Description]\nQuery the funding rate at each settlement time point within a certain time range of the corresponding contract\n\n:::\n\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"FundingFees\",\"sdk-method-name\":\"GetPublicFundingHistory\",\"sdk-method-description\":\"Query the funding rate at each settlement time point within a certain time range of the corresponding contract\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nQuery the funding rate at each settlement time point within a certain time range of the corresponding contract.\n\n:::\n\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Public\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"FundingFees\",\"sdk-method-name\":\"getPublicFundingHistory\",\"sdk-method-description\":\"Query the funding rate at each settlement time point within a certain time range of the corresponding contract.\",\"api-rate-limit-weight\":5}" } }, { @@ -34382,16 +35287,16 @@ "id": "6iUCMmMHEI", "name": "symbol", "required": true, - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", "example": "XBTUSDTM", "type": "string", "enable": true }, { "id": "uwjNpV9qGS", - "name": "from", + "name": "startAt", "required": false, - "description": "Begin time (milisecond)\n", + "description": "Begin time (milliseconds)\n", "example": "1700310700000", "type": "integer", "schema": { @@ -34402,9 +35307,9 @@ }, { "id": "50Ttxnbf64", - "name": "to", + "name": "endAt", "required": false, - "description": "End time (milisecond)\n", + "description": "End time (milliseconds)\n", "example": "1702310700000", "type": "integer", "schema": { @@ -34417,7 +35322,7 @@ "id": "kJsvMJGRDY", "name": "reverse", "required": false, - "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default\n", + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default.\n", "type": "boolean", "schema": { "type": "boolean" @@ -34439,7 +35344,7 @@ "id": "GK7ABGiIOn", "name": "forward", "required": false, - "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default\n", + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default.\n", "type": "boolean", "schema": { "type": "boolean" @@ -34450,7 +35355,7 @@ "id": "pUS4Rwbx6z", "name": "maxCount", "required": false, - "description": "Max record count. The default record count is 10", + "description": "Max. record count. The default record count is 10", "type": "integer", "schema": { "type": "integer" @@ -34466,7 +35371,7 @@ { "id": "10431", "code": 200, - "name": "成功", + "name": "OK", "headers": [], "jsonSchema": { "type": "object", @@ -34484,16 +35389,16 @@ "properties": { "id": { "type": "integer", - "description": "id", + "description": "ID", "format": "int64" }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "description": "Symbol of the contract. Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " }, "timePoint": { "type": "integer", - "description": "Time point (milisecond)\n", + "description": "Time point (milliseconds)\n", "format": "int64" }, "fundingRate": { @@ -34514,15 +35419,15 @@ }, "funding": { "type": "number", - "description": "Settled funding fees. A positive number means that the user received the funding fee, and vice versa.\n" + "description": "Settled funding fees A positive number means that the user received the funding fee, and vice versa.\n" }, "settleCurrency": { "type": "string", - "description": "settlement currency\n" + "description": "Settlement currency\n" }, "context": { "type": "string", - "description": "context" + "description": "Context" }, "marginMode": { "type": "string", @@ -34599,8 +35504,8 @@ "example": "", "mediaType": "" }, - "description": ":::info[Description]\nSubmit request to get the funding history.\n:::\n\n:::tip[Tips]\nThe **from time** and **to time** range cannot exceed 3 month. An error will occur if the specified time window exceeds the range. \n\nIf only **from time** is entered, the default **to time** is the current time. If it exceeds 3 months, an error will be reported.\n\nIf only **to time** is entered, the system will automatically calculate the start time as end time minus 3month.\n:::\n", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"FundingFees\",\"sdk-method-name\":\"getPrivateFundingHistory\",\"sdk-method-description\":\"Submit request to get the funding history.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nSubmit request to get the funding history.\n:::\n\n:::tip[Tips]\nThe **startAt** and **endAt** range cannot exceed 3 months. An error will occur if the specified time window exceeds the range. \n\nIf only **startAt** is entered, the default **endAt** is the current time. If it exceeds 3 months, an error will be reported.\n\nIf only **endAt** is entered, the system will automatically calculate the start time as end time minus 3 months.\n\n**Note:** Because the data changes quickly, if only select offset instead of startAt and endAt, it may cause data inaccuracy or data duplication. It is recommended to page by startAt and endAt\n:::\n\n", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"FundingFees\",\"sdk-method-name\":\"getPrivateFundingHistory\",\"sdk-method-description\":\"Submit request to get the funding history.\",\"api-rate-limit-weight\":5}" } } ] @@ -34613,14 +35518,14 @@ "description": "", "items": [ { - "name": "purchase", + "name": "Purchase", "api": { "id": "3470268", "method": "post", "path": "/api/v1/earn/orders", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -34680,7 +35585,7 @@ "properties": { "productId": { "type": "string", - "description": "Product Id" + "description": "Product ID" }, "amount": { "type": "string", @@ -34716,8 +35621,8 @@ "example": "{\n \"productId\": \"2611\",\n \"amount\": \"1\",\n \"accountType\": \"TRADE\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint allows subscribing earn product\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Earn\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"purchase\",\"sdk-method-description\":\"This endpoint allows subscribing earn product\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis endpoint allows you to subscribe Earn products.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Earn\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"purchase\",\"sdk-method-description\":\"This endpoint allows you to subscribe Earn products.\",\"api-rate-limit-weight\":5}" } }, { @@ -34742,6 +35647,7 @@ "name": "fromAccountType", "required": false, "description": "Account type: MAIN (funding account), TRADE (spot trading account). This parameter is valid only when orderId=ETH2", + "example": "MAIN", "type": "string", "schema": { "type": "string", @@ -34762,8 +35668,7 @@ } ] }, - "enable": true, - "example": "MAIN" + "enable": true } ], "path": [], @@ -34859,8 +35764,8 @@ "example": "{\n \"productId\": \"2611\",\n \"amount\": \"1\",\n \"accountType\": \"TRADE\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can get redemption preview information by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Earn\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getRedeemPreview\",\"sdk-method-description\":\"This endpoint allows subscribing earn products\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis endpoint can get redemption preview information by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it means that the holding does not exist.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Earn\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getRedeemPreview\",\"sdk-method-description\":\"This endpoint allows you to subscribe Earn products.\",\"api-rate-limit-weight\":5}" } }, { @@ -35019,8 +35924,8 @@ "example": "{\n \"productId\": \"2611\",\n \"amount\": \"1\",\n \"accountType\": \"TRADE\"\n}", "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint allows initiating redemption by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Earn\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"redeem\",\"sdk-method-description\":\"This endpoint allows initiating redemption by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nThis endpoint allows you to redeem Earn products by using holding ID. If the current holding is fully redeemed or in the process of being redeemed, it means that the holding does not exist.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"Earn\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"redeem\",\"sdk-method-description\":\"This endpoint allows you to redeem Earn products by using holding ID. If the current holding is fully redeemed or in the process of being redeemed, it means that the holding does not exist.\",\"api-rate-limit-weight\":5}" } }, { @@ -35123,15 +36028,15 @@ }, "productUpperLimit": { "type": "string", - "description": "Products total subscribe amount" + "description": "Products total subscription amount" }, "userUpperLimit": { "type": "string", - "description": "Max user subscribe amount" + "description": "Max. user subscription amount" }, "userLowerLimit": { "type": "string", - "description": "Min user subscribe amount" + "description": "Min. user subscribe amount" }, "redeemPeriod": { "type": "integer", @@ -35192,11 +36097,11 @@ }, "productRemainAmount": { "type": "string", - "description": "Products remain subscribe amount" + "description": "Remaining product subscription amount" }, "status": { "type": "string", - "description": "Product status: ONGOING(Subscription in progress), PENDING(Preheating Subscription), FULL(Subscribed), INTERESTING (Interest in progress)", + "description": "Product status: ONGOING (Subscription in progress), PENDING (Preheating Subscription), FULL (Subscribed), INTERESTING (Interest in progress)", "enum": [ "ONGOING", "PENDING", @@ -35274,7 +36179,7 @@ }, "interestDate": { "type": "integer", - "description": "Most recent interest date(millisecond)", + "description": "Most recent interest date (milliseconds)", "format": "int64" }, "duration": { @@ -35283,7 +36188,7 @@ }, "newUserOnly": { "type": "integer", - "description": "Whether the product is exclusive for new users: 0 (no), 1 (yes)", + "description": "Whether the product is exclusive to new users: 0 (no), 1 (yes)", "enum": [ 0, 1 @@ -35357,8 +36262,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can get available savings products. If no products are available, an empty list is returned.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getSavingsProducts\",\"sdk-method-description\":\"This endpoint can get available savings products. If no products are available, an empty list is returned.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nAvailable savings products can be obtained at this endpoint. If no products are available, an empty list is returned.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getSavingsProducts\",\"sdk-method-description\":\"Available savings products can be obtained at this endpoint. If no products are available, an empty list is returned.\",\"api-rate-limit-weight\":5}" } }, { @@ -35368,6 +36273,7 @@ "method": "get", "path": "/api/v1/earn/promotion/products", "parameters": { + "path": [], "query": [ { "id": "aFTZ2xbIsT", @@ -35383,11 +36289,9 @@ "USDT", "KCS" ] - }, - "enable": true + } } ], - "path": [], "cookie": [], "header": [] }, @@ -35461,15 +36365,15 @@ }, "productUpperLimit": { "type": "string", - "description": "Products total subscribe amount" + "description": "Products total subscription amount" }, "userUpperLimit": { "type": "string", - "description": "Max user subscribe amount" + "description": "Max. user subscription amount" }, "userLowerLimit": { "type": "string", - "description": "Min user subscribe amount" + "description": "Min. user subscribe amount" }, "redeemPeriod": { "type": "integer", @@ -35482,7 +36386,7 @@ }, "lockEndTime": { "type": "integer", - "description": "Product earliest interest end time, in milliseconds", + "description": "Earliest interest end time of product, in milliseconds", "format": "int64" }, "applyStartTime": { @@ -35530,11 +36434,11 @@ }, "productRemainAmount": { "type": "string", - "description": "Products remain subscribe amount" + "description": "Remaining product subscription amount" }, "status": { "type": "string", - "description": "Product status: ONGOING(Subscription in progress), PENDING(Preheating Subscription), FULL(Subscribed), INTERESTING (Interest in progress)", + "description": "Product status: ONGOING (Subscription in progress), PENDING (Preheating Subscription), FULL (Subscribed), INTERESTING (Interest in progress)", "enum": [ "ONGOING", "PENDING", @@ -35612,7 +36516,7 @@ }, "interestDate": { "type": "integer", - "description": "Most recent interest date(millisecond)", + "description": "Most recent interest date (milliseconds)", "format": "int64" }, "duration": { @@ -35621,7 +36525,7 @@ }, "newUserOnly": { "type": "integer", - "description": "Whether the product is exclusive for new users: 0 (no), 1 (yes)", + "description": "Whether the product is exclusive to new users: 0 (no), 1 (yes)", "enum": [ 0, 1 @@ -35695,324 +36599,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can get available limited-time promotion products. If no products are available, an empty list is returned.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getPromotionProducts\",\"sdk-method-description\":\"This endpoint can get available limited-time promotion products. If no products are available, an empty list is returned.\",\"api-rate-limit\":5}" - } - }, - { - "name": "Get Account Holding", - "api": { - "id": "3470273", - "method": "get", - "path": "/api/v1/earn/hold-assets", - "parameters": { - "query": [ - { - "id": "LjYQ1SgidS", - "name": "currency", - "required": false, - "description": "currency", - "example": "KCS", - "type": "string", - "fixedValue": false, - "enable": true - }, - { - "id": "moIoxDU7rD", - "name": "productId", - "required": false, - "description": "Product ID", - "example": "", - "type": "string", - "fixedValue": false, - "enable": true - }, - { - "id": "7zeZoCP06z", - "name": "productCategory", - "required": false, - "description": "Product category", - "example": "", - "type": "string", - "fixedValue": false, - "schema": { - "type": "string", - "enum": [ - "DEMAND", - "ACTIVITY", - "STAKING", - "KCS_STAKING", - "ETH2" - ], - "x-api-enum": [ - { - "value": "DEMAND", - "name": "DEMAND", - "description": "Savings" - }, - { - "value": "ACTIVITY", - "name": "ACTIVITY", - "description": "Activity" - }, - { - "value": "STAKING", - "name": "STAKING", - "description": "Staking" - }, - { - "value": "KCS_STAKING", - "name": "KCS_STAKING", - "description": "KCS Staking" - }, - { - "value": "ETH2", - "name": "ETH2", - "description": "ETHStaking" - } - ] - }, - "enable": true - }, - { - "id": "SW4VBTRIg2", - "name": "currentPage", - "required": false, - "description": "Current request page.", - "example": "1", - "type": "integer", - "fixedValue": false, - "schema": { - "type": "integer", - "default": 1 - }, - "enable": true - }, - { - "id": "6kBGqeIeUR", - "name": "pageSize", - "required": false, - "description": "Number of results per request. Minimum is 10, maximum is 500.", - "example": "10", - "type": "integer", - "fixedValue": false, - "schema": { - "type": "integer", - "default": 15, - "minimum": 10, - "maximum": 500 - }, - "enable": true - } - ], - "path": [], - "cookie": [], - "header": [] - }, - "responses": [ - { - "id": "10437", - "code": 200, - "name": "OK", - "headers": [], - "jsonSchema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "data": { - "type": "object", - "properties": { - "totalNum": { - "type": "integer", - "description": "total number" - }, - "items": { - "type": "array", - "items": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "Holding ID" - }, - "productId": { - "type": "string", - "description": "Product ID" - }, - "productCategory": { - "type": "string", - "description": "Product category" - }, - "productType": { - "type": "string", - "description": "Product sub-type" - }, - "currency": { - "type": "string", - "description": "currency", - "examples": [ - "BTC", - "ETH", - "KCS" - ] - }, - "incomeCurrency": { - "type": "string", - "description": "Income currency", - "examples": [ - "BTC", - "ETH", - "KCS" - ] - }, - "returnRate": { - "type": "string", - "description": "Annualized Rate of Return, for example, 0.035 is equal to 3.5% annualized rate of return" - }, - "holdAmount": { - "type": "string", - "description": "Holding amount" - }, - "redeemedAmount": { - "type": "string", - "description": "Redeemed amount" - }, - "redeemingAmount": { - "type": "string", - "description": "Redeeming amount" - }, - "lockStartTime": { - "type": "integer", - "description": "Product earliest interest start time, in milliseconds", - "format": "int64" - }, - "lockEndTime": { - "type": "integer", - "description": "Product maturity time, in milliseconds", - "format": "int64" - }, - "purchaseTime": { - "type": "integer", - "description": "Most recent subscription time, in milliseconds", - "format": "int64" - }, - "redeemPeriod": { - "type": "integer", - "description": "Redemption waiting period (days)" - }, - "status": { - "type": "string", - "description": "Status: LOCKED (holding), REDEEMING (redeeming)", - "enum": [ - "LOCKED", - "REDEEMING" - ], - "x-api-enum": [ - { - "value": "LOCKED", - "name": "", - "description": "" - }, - { - "value": "REDEEMING", - "name": "", - "description": "" - } - ] - }, - "earlyRedeemSupported": { - "type": "integer", - "description": "Whether the fixed product supports early redemption: 0 (no), 1 (yes)", - "enum": [ - 0, - 1 - ], - "x-api-enum": [ - { - "value": 0, - "name": "", - "description": "" - }, - { - "value": 1, - "name": "", - "description": "" - } - ] - } - }, - "required": [ - "orderId", - "productId", - "productCategory", - "productType", - "currency", - "incomeCurrency", - "returnRate", - "holdAmount", - "redeemedAmount", - "redeemingAmount", - "lockStartTime", - "purchaseTime", - "redeemPeriod", - "status", - "earlyRedeemSupported" - ] - } - }, - "currentPage": { - "type": "integer", - "description": "current page" - }, - "pageSize": { - "type": "integer", - "description": "page size" - }, - "totalPage": { - "type": "integer", - "description": "total page" - } - }, - "required": [ - "totalNum", - "items", - "currentPage", - "pageSize", - "totalPage" - ] - } - }, - "required": [ - "code", - "data" - ] - }, - "description": "", - "contentType": "json", - "mediaType": "" - } - ], - "responseExamples": [ - { - "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"currentPage\": 1,\n \"pageSize\": 15,\n \"items\": [\n {\n \"orderId\": \"2767291\",\n \"productId\": \"2611\",\n \"productCategory\": \"KCS_STAKING\",\n \"productType\": \"DEMAND\",\n \"currency\": \"KCS\",\n \"incomeCurrency\": \"KCS\",\n \"returnRate\": \"0.03471727\",\n \"holdAmount\": \"1\",\n \"redeemedAmount\": \"0\",\n \"redeemingAmount\": \"1\",\n \"lockStartTime\": 1701252000000,\n \"lockEndTime\": null,\n \"purchaseTime\": 1729257513000,\n \"redeemPeriod\": 3,\n \"status\": \"REDEEMING\",\n \"earlyRedeemSupported\": 0\n }\n ]\n }\n}", - "responseId": 10437, - "ordering": 1 - } - ], - "requestBody": { - "type": "none", - "parameters": [], - "jsonSchema": { - "type": "object", - "properties": {} - }, - "mediaType": "" - }, - "description": ":::info[Description]\nThis endpoint can get current holding assets information. If no current holding assets are available, an empty list is returned.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getAccountHolding\",\"sdk-method-description\":\"This endpoint can get current holding assets information. If no current holding assets are available, an empty list is returned.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nAvailable limited-duration products can be obtained at this endpoint. If no products are available, an empty list is returned.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getPromotionProducts\",\"sdk-method-description\":\"Available limited-duration products can be obtained at this endpoint. If no products are available, an empty list is returned.\"}" } }, { @@ -36115,15 +36703,15 @@ }, "productUpperLimit": { "type": "string", - "description": "Products total subscribe amount" + "description": "Products total subscription amount" }, "userUpperLimit": { "type": "string", - "description": "Max user subscribe amount" + "description": "Max. user subscription amount" }, "userLowerLimit": { "type": "string", - "description": "Min user subscribe amount" + "description": "Min. user subscribe amount" }, "redeemPeriod": { "type": "integer", @@ -36184,11 +36772,11 @@ }, "productRemainAmount": { "type": "string", - "description": "Products remain subscribe amount" + "description": "Remaining product subscription amount" }, "status": { "type": "string", - "description": "Product status: ONGOING(Subscription in progress), PENDING(Preheating Subscription), FULL(Subscribed), INTERESTING (Interest in progress)", + "description": "Product status: ONGOING (Subscription in progress), PENDING (Preheating Subscription), FULL (Subscribed), INTERESTING (Interest in progress)", "enum": [ "ONGOING", "PENDING", @@ -36266,7 +36854,7 @@ }, "interestDate": { "type": "integer", - "description": "Most recent interest date(millisecond)", + "description": "Most recent interest date (milliseconds)", "format": "int64" }, "duration": { @@ -36275,7 +36863,7 @@ }, "newUserOnly": { "type": "integer", - "description": "Whether the product is exclusive for new users: 0 (no), 1 (yes)", + "description": "Whether the product is exclusive to new users: 0 (no), 1 (yes)", "enum": [ 0, 1 @@ -36349,8 +36937,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can get available staking products. If no products are available, an empty list is returned.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getStakingProducts\",\"sdk-method-description\":\"This endpoint can get available staking products. If no products are available, an empty list is returned.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nAvailable staking products can be obtained at this endpoint. If no products are available, an empty list is returned.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getStakingProducts\",\"sdk-method-description\":\"Available staking products can be obtained at this endpoint. If no products are available, an empty list is returned.\",\"api-rate-limit-weight\":5}" } }, { @@ -36453,15 +37041,15 @@ }, "productUpperLimit": { "type": "string", - "description": "Products total subscribe amount" + "description": "Products total subscription amount" }, "userUpperLimit": { "type": "string", - "description": "Max user subscribe amount" + "description": "Max. user subscription amount" }, "userLowerLimit": { "type": "string", - "description": "Min user subscribe amount" + "description": "Min. user subscribe amount" }, "redeemPeriod": { "type": "integer", @@ -36522,11 +37110,11 @@ }, "productRemainAmount": { "type": "string", - "description": "Products remain subscribe amount" + "description": "Remaining product subscription amount" }, "status": { "type": "string", - "description": "Product status: ONGOING(Subscription in progress), PENDING(Preheating Subscription), FULL(Subscribed), INTERESTING (Interest in progress)", + "description": "Product status: ONGOING (Subscription in progress), PENDING (Preheating Subscription), FULL (Subscribed), INTERESTING (Interest in progress)", "enum": [ "ONGOING", "PENDING", @@ -36604,7 +37192,7 @@ }, "interestDate": { "type": "integer", - "description": "Most recent interest date(millisecond)", + "description": "Most recent interest date (milliseconds)", "format": "int64" }, "duration": { @@ -36613,7 +37201,7 @@ }, "newUserOnly": { "type": "integer", - "description": "Whether the product is exclusive for new users: 0 (no), 1 (yes)", + "description": "Whether the product is exclusive to new users: 0 (no), 1 (yes)", "enum": [ 0, 1 @@ -36685,8 +37273,8 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can get available KCS staking products. If no products are available, an empty list is returned.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getKcsStakingProducts\",\"sdk-method-description\":\"This endpoint can get available KCS staking products. If no products are available, an empty list is returned.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nAvailable KCS staking products can be obtained at this endpoint. If no products are available, an empty list is returned.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getKcsStakingProducts\",\"sdk-method-description\":\"Available KCS staking products can be obtained at this endpoint. If no products are available, an empty list is returned.\",\"api-rate-limit-weight\":5}" } }, { @@ -36796,19 +37384,19 @@ }, "userLowerLimit": { "type": "string", - "description": "Min user subscribe amount" + "description": "Min. user subscribe amount" }, "userUpperLimit": { "type": "string", - "description": "Max user subscribe amount" + "description": "Max. user subscription amount" }, "productUpperLimit": { "type": "string", - "description": "Products total subscribe amount" + "description": "Products total subscription amount" }, "productRemainAmount": { "type": "string", - "description": "Products remain subscribe amount" + "description": "Remaining product subscription amount" }, "redeemPeriod": { "type": "integer", @@ -36882,12 +37470,12 @@ }, "interestDate": { "type": "integer", - "description": "Most recent interest date(millisecond)", + "description": "Most recent interest date (milliseconds)", "format": "int64" }, "newUserOnly": { "type": "integer", - "description": "Whether the product is exclusive for new users: 0 (no), 1 (yes)", + "description": "Whether the product is exclusive to new users: 0 (no), 1 (yes)", "enum": [ 0, 1 @@ -36931,7 +37519,7 @@ }, "status": { "type": "string", - "description": "Product status: ONGOING(Subscription in progress), PENDING(Preheating Subscription), FULL(Subscribed), INTERESTING (Interest in progress)", + "description": "Product status: ONGOING (Subscription in progress), PENDING (Preheating Subscription), FULL (Subscribed), INTERESTING (Interest in progress)", "enum": [ "ONGOING", "PENDING", @@ -37013,8 +37601,324 @@ }, "mediaType": "" }, - "description": ":::info[Description]\nThis endpoint can get available ETH staking products. If no products are available, an empty list is returned.\n:::", - "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getETHStakingProducts\",\"sdk-method-description\":\"This endpoint can get available ETH staking products. If no products are available, an empty list is returned.\",\"api-rate-limit\":5}" + "description": ":::info[Description]\nAvailable ETH staking products can be obtained at this endpoint. If no products are available, an empty list is returned.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getETHStakingProducts\",\"sdk-method-description\":\"Available ETH staking products can be obtained at this endpoint. If no products are available, an empty list is returned.\",\"api-rate-limit-weight\":5}" + } + }, + { + "name": "Get Account Holding", + "api": { + "id": "3470273", + "method": "get", + "path": "/api/v1/earn/hold-assets", + "parameters": { + "query": [ + { + "id": "LjYQ1SgidS", + "name": "currency", + "required": false, + "description": "currency", + "example": "KCS", + "type": "string", + "fixedValue": false, + "enable": true + }, + { + "id": "moIoxDU7rD", + "name": "productId", + "required": false, + "description": "Product ID", + "example": "", + "type": "string", + "fixedValue": false, + "enable": true + }, + { + "id": "7zeZoCP06z", + "name": "productCategory", + "required": false, + "description": "Product category", + "example": "", + "type": "string", + "fixedValue": false, + "schema": { + "type": "string", + "enum": [ + "DEMAND", + "ACTIVITY", + "STAKING", + "KCS_STAKING", + "ETH2" + ], + "x-api-enum": [ + { + "value": "DEMAND", + "name": "DEMAND", + "description": "Savings" + }, + { + "value": "ACTIVITY", + "name": "ACTIVITY", + "description": "Activity" + }, + { + "value": "STAKING", + "name": "STAKING", + "description": "Staking" + }, + { + "value": "KCS_STAKING", + "name": "KCS_STAKING", + "description": "KCS Staking" + }, + { + "value": "ETH2", + "name": "ETH2", + "description": "ETHStaking" + } + ] + }, + "enable": true + }, + { + "id": "SW4VBTRIg2", + "name": "currentPage", + "required": false, + "description": "Current request page.", + "example": "1", + "type": "integer", + "fixedValue": false, + "schema": { + "type": "integer", + "default": 1 + }, + "enable": true + }, + { + "id": "6kBGqeIeUR", + "name": "pageSize", + "required": false, + "description": "Number of results per request. Minimum is 10, maximum is 500.", + "example": "10", + "type": "integer", + "fixedValue": false, + "schema": { + "type": "integer", + "default": 15, + "minimum": 10, + "maximum": 500 + }, + "enable": true + } + ], + "path": [], + "cookie": [], + "header": [] + }, + "responses": [ + { + "id": "10437", + "code": 200, + "name": "OK", + "headers": [], + "jsonSchema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "data": { + "type": "object", + "properties": { + "totalNum": { + "type": "integer", + "description": "total number" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "orderId": { + "type": "string", + "description": "Holding ID" + }, + "productId": { + "type": "string", + "description": "Product ID" + }, + "productCategory": { + "type": "string", + "description": "Product category" + }, + "productType": { + "type": "string", + "description": "Product sub-type" + }, + "currency": { + "type": "string", + "description": "currency", + "examples": [ + "BTC", + "ETH", + "KCS" + ] + }, + "incomeCurrency": { + "type": "string", + "description": "Income currency", + "examples": [ + "BTC", + "ETH", + "KCS" + ] + }, + "returnRate": { + "type": "string", + "description": "Annualized Rate of Return, for example, 0.035 is equal to 3.5% annualized rate of return" + }, + "holdAmount": { + "type": "string", + "description": "Holding amount" + }, + "redeemedAmount": { + "type": "string", + "description": "Redeemed amount" + }, + "redeemingAmount": { + "type": "string", + "description": "Redeeming amount" + }, + "lockStartTime": { + "type": "integer", + "description": "Product earliest interest start time, in milliseconds", + "format": "int64" + }, + "lockEndTime": { + "type": "integer", + "description": "Product maturity time, in milliseconds", + "format": "int64" + }, + "purchaseTime": { + "type": "integer", + "description": "Most recent subscription time, in milliseconds", + "format": "int64" + }, + "redeemPeriod": { + "type": "integer", + "description": "Redemption waiting period (days)" + }, + "status": { + "type": "string", + "description": "Status: LOCKED (holding), REDEEMING (redeeming)", + "enum": [ + "LOCKED", + "REDEEMING" + ], + "x-api-enum": [ + { + "value": "LOCKED", + "name": "", + "description": "" + }, + { + "value": "REDEEMING", + "name": "", + "description": "" + } + ] + }, + "earlyRedeemSupported": { + "type": "integer", + "description": "Whether the fixed product supports early redemption: 0 (no), 1 (yes)", + "enum": [ + 0, + 1 + ], + "x-api-enum": [ + { + "value": 0, + "name": "", + "description": "" + }, + { + "value": 1, + "name": "", + "description": "" + } + ] + } + }, + "required": [ + "orderId", + "productId", + "productCategory", + "productType", + "currency", + "incomeCurrency", + "returnRate", + "holdAmount", + "redeemedAmount", + "redeemingAmount", + "lockStartTime", + "purchaseTime", + "redeemPeriod", + "status", + "earlyRedeemSupported" + ] + } + }, + "currentPage": { + "type": "integer", + "description": "current page" + }, + "pageSize": { + "type": "integer", + "description": "page size" + }, + "totalPage": { + "type": "integer", + "description": "total pages" + } + }, + "required": [ + "totalNum", + "items", + "currentPage", + "pageSize", + "totalPage" + ] + } + }, + "required": [ + "code", + "data" + ] + }, + "description": "", + "contentType": "json", + "mediaType": "" + } + ], + "responseExamples": [ + { + "name": "Success", + "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"currentPage\": 1,\n \"pageSize\": 15,\n \"items\": [\n {\n \"orderId\": \"2767291\",\n \"productId\": \"2611\",\n \"productCategory\": \"KCS_STAKING\",\n \"productType\": \"DEMAND\",\n \"currency\": \"KCS\",\n \"incomeCurrency\": \"KCS\",\n \"returnRate\": \"0.03471727\",\n \"holdAmount\": \"1\",\n \"redeemedAmount\": \"0\",\n \"redeemingAmount\": \"1\",\n \"lockStartTime\": 1701252000000,\n \"lockEndTime\": null,\n \"purchaseTime\": 1729257513000,\n \"redeemPeriod\": 3,\n \"status\": \"REDEEMING\",\n \"earlyRedeemSupported\": 0\n }\n ]\n }\n}", + "responseId": 10437, + "ordering": 1 + } + ], + "requestBody": { + "type": "none", + "parameters": [], + "jsonSchema": { + "type": "object", + "properties": {} + }, + "mediaType": "" + }, + "description": ":::info[Description]\nInformation on currently held assets can be obtained at this endpoint. If no assets are currently held, an empty list is returned.\n:::", + "customApiFields": "{\"abandon\":\"normal\",\"domain\":\"Spot\",\"api-channel\":\"Private\",\"api-permission\":\"General\",\"api-rate-limit-pool\":\"Earn\",\"sdk-service\":\"Earn\",\"sdk-sub-service\":\"Earn\",\"sdk-method-name\":\"getAccountHolding\",\"sdk-method-description\":\"Information on currently held assets can be obtained at this endpoint. If no assets are currently held, an empty list is returned.\",\"api-rate-limit-weight\":5}" } } ] @@ -37025,14 +37929,117 @@ "description": "", "items": [ { - "name": "Get Account Detail", + "name": "Get Discount Rate Configs", + "api": { + "id": "3471463", + "method": "get", + "path": "/api/v1/otc-loan/discount-rate-configs", + "parameters": { + "query": [], + "path": [], + "cookie": [], + "header": [] + }, + "responses": [ + { + "id": "11801", + "code": 200, + "name": "OK", + "headers": [], + "jsonSchema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "currency": { + "type": "string", + "examples": [ + "BTC", + "ETH" + ], + "description": "Currency" + }, + "usdtLevels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "left": { + "type": "integer", + "description": "Left end point of gradient interval, left