{ "openapi": "3.0.1", "info": { "title": "spot", "description": "", "version": "1.0.0" }, "tags": [], "paths": { "/api/v3/announcements": { "get": { "summary": "Get Announcements", "deprecated": false, "description": "This interface can obtain the latest news announcements, and the default page search is for announcements within a month.", "tags": [], "parameters": [ { "name": "currentPage", "in": "query", "description": "page number", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "pageSize", "in": "query", "description": "page Size", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "annType", "in": "query", "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", "required": false, "schema": { "type": "string", "enum": [ "latest-announcements ", "activities ", "product-updates ", "vip ", "maintenance-updates", "delistings ", "others", "api-campaigns ", "new-listings" ], "default": "latest-announcements", "x-api-enum": [ { "value": "latest-announcements ", "name": "LATEST-ANNOUNCEMENTS", "description": "latest-announcements" }, { "value": "activities ", "name": "ACTIVITIES", "description": "latest activities" }, { "value": "product-updates ", "name": "PRODUCT-UPDATES", "description": "product updates" }, { "value": "vip ", "name": "VIPS", "description": "institutions and VIPs" }, { "value": "maintenance-updates", "name": "MAINTENANCE-UPDATE", "description": "system maintenance" }, { "value": "delistings ", "name": "DELISTINGS", "description": "currency offline" }, { "value": "others", "name": "OTHERS", "description": "others" }, { "value": "api-campaigns ", "name": "API-CAMPAIGNS", "description": "API user activities" }, { "value": "new-listings", "name": "NEW-LISTINGS", "description": "new currency online" } ] } }, { "name": "lang", "in": "query", "description": "Language type, the default is en_US, the specific value parameters are as follows", "required": false, "schema": { "type": "string", "default": "en_US", "enum": [ "zh_HK", "ja_JP", "ko_KR", "en_US", "pl_PL", "es_ES", "fr_FR", "ar_AE", "it_IT", "id_ID", "nl_NL", "pt_PT", "vi_VN", "de_DE", "tr_TR", "ms_MY", "ru_RU", "th_TH", "hi_IN", "bn_BD", "fil_PH", "ur_PK" ], "x-api-enum": [ { "value": "zh_HK", "name": "ZH_HK", "description": "Chinese (Hong Kong)" }, { "value": "ja_JP", "name": "JA_JP", "description": "Japanese (Japan)" }, { "value": "ko_KR", "name": "KO_KR", "description": "Korean (Korea)" }, { "value": "en_US", "name": "EN_US", "description": "English" }, { "value": "pl_PL", "name": "PL_PL", "description": "Polish (Poland)" }, { "value": "es_ES", "name": "ES_ES", "description": "Spanish (Spain)" }, { "value": "fr_FR", "name": "FR_FR", "description": "French (France)" }, { "value": "ar_AE", "name": "AR_AE", "description": "Arabic (Egypt)" }, { "value": "it_IT", "name": "IT_IT", "description": "Italian (Italy)" }, { "value": "id_ID", "name": "ID_ID", "description": "Indonesian (Indonesia)" }, { "value": "nl_NL", "name": "NL_NL", "description": "Dutch (Netherlands)" }, { "value": "pt_PT", "name": "PT_PT", "description": "Portuguese (Brazil)" }, { "value": "vi_VN", "name": "VI_VN", "description": "Vietnamese (Vietnam)" }, { "value": "de_DE", "name": "DE_DE", "description": "German (Germany)" }, { "value": "tr_TR", "name": "TR_TR", "description": "Turkish (Turkey)" }, { "value": "ms_MY", "name": "MS_MY", "description": "Malay (Malaysia)" }, { "value": "ru_RU", "name": "RU_RU", "description": "Russian (Russia)" }, { "value": "th_TH", "name": "TH_TH", "description": "Thai (Thailand)" }, { "value": "hi_IN", "name": "HI_IN", "description": "Hindi (India)" }, { "value": "bn_BD", "name": "BN_BD", "description": "Bengali (Bangladesh)" }, { "value": "fil_PH", "name": "FIL_PH", "description": "Filipino (Philippines)" }, { "value": "ur_PK", "name": "UR_PK", "description": "Urdu (Pakistan)" } ] } }, { "name": "startTime", "in": "query", "description": "Announcement online start time (milliseconds)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "endTime", "in": "query", "description": "Announcement online end time (milliseconds)", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "totalNum": { "type": "integer", "description": "Total Number" }, "items": { "type": "array", "items": { "type": "object", "properties": { "annId": { "type": "integer", "description": "Announcement ID" }, "annTitle": { "type": "string", "description": "Announcement title" }, "annType": { "type": "array", "items": { "type": "string" }, "description": "Announcement type" }, "annDesc": { "type": "string", "description": "Announcement description" }, "cTime": { "type": "integer", "description": "Announcement release time, Unix millisecond timestamp format", "format": "int64" }, "language": { "type": "string", "description": "language type" }, "annUrl": { "type": "string", "description": "Announcement link" } }, "required": [ "annId", "annTitle", "annType", "annDesc", "cTime", "language", "annUrl" ] } }, "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" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470157", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getAnnouncements", "x-sdk-method-description": "This interface can obtain the latest news announcements, and the default page search is for announcements within a month.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\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,\\xa0KuCoin\\u2019s Isolated Margin Trading platform has added the Scroll (SCR)\\xa0asset 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%!\\u200b\\\",\\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 \\u201cDAPP-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:\\xa011: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}", "x-request-example": "{\\\"currentPage\\\": 1, \\\"pageSize\\\": 50, \\\"annType\\\": \\\"latest-announcements\\\", \\\"lang\\\": \\\"en_US\\\", \\\"startTime\\\": 1729594043000, \\\"endTime\\\": 1729697729000}", "operationId": "001" } }, "/api/v3/currencies/{currency}": { "get": { "summary": "Get Currency", "deprecated": false, "description": "Request the currency details of a specified currency via this endpoint.", "tags": [], "parameters": [ { "name": "chain", "in": "query", "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.", "required": false, "schema": { "type": "string", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] } }, { "name": "currency", "in": "path", "description": "Path parameter, Currency", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currency": { "type": "string", "description": "A unique currency code that will never change" }, "name": { "type": "string", "description": "Currency name; will change after renaming" }, "fullName": { "type": "string", "description": "Full currency name; will change after renaming" }, "precision": { "type": "integer", "description": "Currency precision" }, "confirms": { "type": "integer", "description": "Number of block confirmations" }, "contractAddress": { "type": "string", "description": "Contract address" }, "isMarginEnabled": { "type": "boolean", "description": "Margin support or not" }, "isDebitEnabled": { "type": "boolean", "description": "Debit support or not" }, "chains": { "type": "array", "items": { "type": "object", "properties": { "chainName": { "type": "string", "description": "Chain name of currency" }, "withdrawalMinSize": { "type": "string", "description": "Minimum withdrawal amount" }, "depositMinSize": { "type": "string", "description": "Minimum deposit amount" }, "withdrawFeeRate": { "type": "string", "description": "Withdraw fee rate" }, "withdrawalMinFee": { "type": "string", "description": "Minimum fees charged for withdrawal" }, "isWithdrawEnabled": { "type": "boolean", "description": "Withdrawal support or not" }, "isDepositEnabled": { "type": "boolean", "description": "Deposit support or not" }, "confirms": { "type": "integer", "description": "Number of block confirmations" }, "preConfirms": { "type": "integer", "description": "The number of blocks (confirmations) for advance on-chain verification" }, "contractAddress": { "type": "string", "description": "Contract address" }, "withdrawPrecision": { "type": "integer", "description": "Withdrawal precision bit, indicating the maximum supported length after the decimal point of the withdrawal amount" }, "maxWithdraw": { "type": "number", "description": "Maximum amount of single withdrawal" }, "maxDeposit": { "type": "string", "description": "Maximum amount of single deposit (only applicable to Lightning Network)" }, "needTag": { "type": "boolean", "description": "Need for memo/tag or not" }, "chainId": { "type": "string", "description": "Chain id of currency" } }, "required": [ "chainName", "withdrawalMinSize", "withdrawFeeRate", "withdrawalMinFee", "isWithdrawEnabled", "isDepositEnabled", "confirms", "preConfirms", "contractAddress", "withdrawPrecision", "needTag", "chainId" ] }, "description": "Chain list" } }, "required": [ "currency", "name", "fullName", "precision", "isMarginEnabled", "isDebitEnabled", "chains" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470155", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getCurrency", "x-sdk-method-description": "Request the currency details of a specified currency via this endpoint.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"currency\\\":\\\"BTC\\\",\\\"name\\\":\\\"BTC\\\",\\\"fullName\\\":\\\"Bitcoin\\\",\\\"precision\\\":8,\\\"confirms\\\":null,\\\"contractAddress\\\":null,\\\"isMarginEnabled\\\":true,\\\"isDebitEnabled\\\":true,\\\"chains\\\":[{\\\"chainName\\\":\\\"BTC\\\",\\\"withdrawalMinSize\\\":\\\"0.001\\\",\\\"depositMinSize\\\":\\\"0.0002\\\",\\\"withdrawFeeRate\\\":\\\"0\\\",\\\"withdrawalMinFee\\\":\\\"0.0005\\\",\\\"isWithdrawEnabled\\\":true,\\\"isDepositEnabled\\\":true,\\\"confirms\\\":3,\\\"preConfirms\\\":1,\\\"contractAddress\\\":\\\"\\\",\\\"withdrawPrecision\\\":8,\\\"maxWithdraw\\\":null,\\\"maxDeposit\\\":null,\\\"needTag\\\":false,\\\"chainId\\\":\\\"btc\\\"},{\\\"chainName\\\":\\\"Lightning Network\\\",\\\"withdrawalMinSize\\\":\\\"0.00001\\\",\\\"depositMinSize\\\":\\\"0.00001\\\",\\\"withdrawFeeRate\\\":\\\"0\\\",\\\"withdrawalMinFee\\\":\\\"0.000015\\\",\\\"isWithdrawEnabled\\\":true,\\\"isDepositEnabled\\\":true,\\\"confirms\\\":1,\\\"preConfirms\\\":1,\\\"contractAddress\\\":\\\"\\\",\\\"withdrawPrecision\\\":8,\\\"maxWithdraw\\\":null,\\\"maxDeposit\\\":\\\"0.03\\\",\\\"needTag\\\":false,\\\"chainId\\\":\\\"btcln\\\"},{\\\"chainName\\\":\\\"KCC\\\",\\\"withdrawalMinSize\\\":\\\"0.0008\\\",\\\"depositMinSize\\\":null,\\\"withdrawFeeRate\\\":\\\"0\\\",\\\"withdrawalMinFee\\\":\\\"0.00002\\\",\\\"isWithdrawEnabled\\\":true,\\\"isDepositEnabled\\\":true,\\\"confirms\\\":20,\\\"preConfirms\\\":20,\\\"contractAddress\\\":\\\"0xfa93c12cd345c658bc4644d1d4e1b9615952258c\\\",\\\"withdrawPrecision\\\":8,\\\"maxWithdraw\\\":null,\\\"maxDeposit\\\":null,\\\"needTag\\\":false,\\\"chainId\\\":\\\"kcc\\\"},{\\\"chainName\\\":\\\"BTC-Segwit\\\",\\\"withdrawalMinSize\\\":\\\"0.0008\\\",\\\"depositMinSize\\\":\\\"0.0002\\\",\\\"withdrawFeeRate\\\":\\\"0\\\",\\\"withdrawalMinFee\\\":\\\"0.0005\\\",\\\"isWithdrawEnabled\\\":false,\\\"isDepositEnabled\\\":true,\\\"confirms\\\":2,\\\"preConfirms\\\":2,\\\"contractAddress\\\":\\\"\\\",\\\"withdrawPrecision\\\":8,\\\"maxWithdraw\\\":null,\\\"maxDeposit\\\":null,\\\"needTag\\\":false,\\\"chainId\\\":\\\"bech32\\\"}]}}", "x-request-example": "{\\\"chain\\\": \\\"eth\\\", \\\"currency\\\": \\\"BTC\\\"}", "operationId": "002" } }, "/api/v3/currencies": { "get": { "summary": "Get All Currencies", "deprecated": false, "description": "Request a currency list via this endpoint. Not all currencies can currently be used for trading.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "A unique currency code that will never change" }, "name": { "type": "string", "description": "Currency name; will change after renaming" }, "fullName": { "type": "string", "description": "Full currency name; will change after renaming" }, "precision": { "type": "integer", "description": "Currency precision" }, "confirms": { "type": "integer", "description": "Number of block confirmations" }, "contractAddress": { "type": "string", "description": "Contract address" }, "isMarginEnabled": { "type": "boolean", "description": "Margin support or not" }, "isDebitEnabled": { "type": "boolean", "description": "Debit support or not" }, "chains": { "type": "array", "items": { "type": "object", "properties": { "chainName": { "type": "string", "description": "Chain name of currency" }, "withdrawalMinSize": { "type": "string", "description": "Minimum withdrawal amount" }, "depositMinSize": { "type": "string", "description": "Minimum deposit amount" }, "withdrawFeeRate": { "type": "string", "description": "Withdraw fee rate" }, "withdrawalMinFee": { "type": "string", "description": "Minimum fees charged for withdrawal" }, "isWithdrawEnabled": { "type": "boolean", "description": "Withdrawal support or not" }, "isDepositEnabled": { "type": "boolean", "description": "Deposit support or not" }, "confirms": { "type": "integer", "description": "Number of block confirmations" }, "preConfirms": { "type": "integer", "description": "The number of blocks (confirmations) for advance on-chain verification" }, "contractAddress": { "type": "string", "description": "Contract address" }, "withdrawPrecision": { "type": "integer", "description": "Withdrawal precision bit, indicating the maximum supported length after the decimal point of the withdrawal amount" }, "maxWithdraw": { "type": "string", "description": "Maximum amount of single withdrawal" }, "maxDeposit": { "type": "string", "description": "Maximum amount of single deposit (only applicable to Lightning Network)" }, "needTag": { "type": "boolean", "description": "Need for memo/tag or not" }, "chainId": { "type": "string", "description": "Chain id of currency" }, "depositFeeRate": { "type": "string", "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)" }, "depositTierFee": { "type": "string" } }, "required": [ "chainName", "withdrawalMinSize", "withdrawalMinFee", "isWithdrawEnabled", "isDepositEnabled", "confirms", "preConfirms", "contractAddress", "withdrawPrecision", "needTag", "chainId", "withdrawFeeRate" ] }, "description": "Chain list" } }, "required": [ "currency", "name", "fullName", "precision", "confirms", "contractAddress", "isMarginEnabled", "isDebitEnabled", "chains" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470152", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getAllCurrencies", "x-sdk-method-description": "Request a currency list via this endpoint. Not all currencies can currently be used for trading.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"currency\\\": \\\"BTC\\\",\\n \\\"name\\\": \\\"BTC\\\",\\n \\\"fullName\\\": \\\"Bitcoin\\\",\\n \\\"precision\\\": 8,\\n \\\"confirms\\\": null,\\n \\\"contractAddress\\\": null,\\n \\\"isMarginEnabled\\\": true,\\n \\\"isDebitEnabled\\\": true,\\n \\\"chains\\\": [\\n {\\n \\\"chainName\\\": \\\"BTC\\\",\\n \\\"withdrawalMinSize\\\": \\\"0.001\\\",\\n \\\"depositMinSize\\\": \\\"0.0002\\\",\\n \\\"withdrawFeeRate\\\": \\\"0\\\",\\n \\\"withdrawalMinFee\\\": \\\"0.0005\\\",\\n \\\"isWithdrawEnabled\\\": true,\\n \\\"isDepositEnabled\\\": true,\\n \\\"confirms\\\": 3,\\n \\\"preConfirms\\\": 1,\\n \\\"contractAddress\\\": \\\"\\\",\\n \\\"withdrawPrecision\\\": 8,\\n \\\"maxWithdraw\\\": null,\\n \\\"maxDeposit\\\": null,\\n \\\"needTag\\\": false,\\n \\\"chainId\\\": \\\"btc\\\"\\n },\\n {\\n \\\"chainName\\\": \\\"Lightning Network\\\",\\n \\\"withdrawalMinSize\\\": \\\"0.00001\\\",\\n \\\"depositMinSize\\\": \\\"0.00001\\\",\\n \\\"withdrawFeeRate\\\": \\\"0\\\",\\n \\\"withdrawalMinFee\\\": \\\"0.000015\\\",\\n \\\"isWithdrawEnabled\\\": true,\\n \\\"isDepositEnabled\\\": true,\\n \\\"confirms\\\": 1,\\n \\\"preConfirms\\\": 1,\\n \\\"contractAddress\\\": \\\"\\\",\\n \\\"withdrawPrecision\\\": 8,\\n \\\"maxWithdraw\\\": null,\\n \\\"maxDeposit\\\": \\\"0.03\\\",\\n \\\"needTag\\\": false,\\n \\\"chainId\\\": \\\"btcln\\\"\\n },\\n {\\n \\\"chainName\\\": \\\"KCC\\\",\\n \\\"withdrawalMinSize\\\": \\\"0.0008\\\",\\n \\\"depositMinSize\\\": null,\\n \\\"withdrawFeeRate\\\": \\\"0\\\",\\n \\\"withdrawalMinFee\\\": \\\"0.00002\\\",\\n \\\"isWithdrawEnabled\\\": true,\\n \\\"isDepositEnabled\\\": true,\\n \\\"confirms\\\": 20,\\n \\\"preConfirms\\\": 20,\\n \\\"contractAddress\\\": \\\"0xfa93c12cd345c658bc4644d1d4e1b9615952258c\\\",\\n \\\"withdrawPrecision\\\": 8,\\n \\\"maxWithdraw\\\": null,\\n \\\"maxDeposit\\\": null,\\n \\\"needTag\\\": false,\\n \\\"chainId\\\": \\\"kcc\\\"\\n },\\n {\\n \\\"chainName\\\": \\\"BTC-Segwit\\\",\\n \\\"withdrawalMinSize\\\": \\\"0.0008\\\",\\n \\\"depositMinSize\\\": \\\"0.0002\\\",\\n \\\"withdrawFeeRate\\\": \\\"0\\\",\\n \\\"withdrawalMinFee\\\": \\\"0.0005\\\",\\n \\\"isWithdrawEnabled\\\": false,\\n \\\"isDepositEnabled\\\": true,\\n \\\"confirms\\\": 2,\\n \\\"preConfirms\\\": 2,\\n \\\"contractAddress\\\": \\\"\\\",\\n \\\"withdrawPrecision\\\": 8,\\n \\\"maxWithdraw\\\": null,\\n \\\"maxDeposit\\\": null,\\n \\\"needTag\\\": false,\\n \\\"chainId\\\": \\\"bech32\\\"\\n }\\n ]\\n },\\n {\\n \\\"currency\\\": \\\"BTCP\\\",\\n \\\"name\\\": \\\"BTCP\\\",\\n \\\"fullName\\\": \\\"Bitcoin Private\\\",\\n \\\"precision\\\": 8,\\n \\\"confirms\\\": null,\\n \\\"contractAddress\\\": null,\\n \\\"isMarginEnabled\\\": false,\\n \\\"isDebitEnabled\\\": false,\\n \\\"chains\\\": [\\n {\\n \\\"chainName\\\": \\\"BTCP\\\",\\n \\\"withdrawalMinSize\\\": \\\"0.100000\\\",\\n \\\"depositMinSize\\\": null,\\n \\\"withdrawFeeRate\\\": \\\"0\\\",\\n \\\"withdrawalMinFee\\\": \\\"0.010000\\\",\\n \\\"isWithdrawEnabled\\\": false,\\n \\\"isDepositEnabled\\\": false,\\n \\\"confirms\\\": 6,\\n \\\"preConfirms\\\": 6,\\n \\\"contractAddress\\\": \\\"\\\",\\n \\\"withdrawPrecision\\\": 8,\\n \\\"maxWithdraw\\\": null,\\n \\\"maxDeposit\\\": null,\\n \\\"needTag\\\": false,\\n \\\"chainId\\\": \\\"btcp\\\"\\n }\\n ]\\n }\\n ]\\n}", "operationId": "003" } }, "/api/v2/symbols/{symbol}": { "get": { "summary": "Get Symbol ", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "path", "description": "Path parameter, Symbol", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "symbol": { "type": "string", "description": "unique code of a symbol, it would not change after renaming", "example": [ "BTC-USDT", "BCHSV-USDT" ] }, "name": { "type": "string", "description": "Name of trading pairs, it would change after renaming", "example": [ "BTC-USDT", "BSV-USDT" ] }, "baseCurrency": { "type": "string", "description": "Base currency,e.g. BTC." }, "quoteCurrency": { "type": "string", "description": "Quote currency,e.g. USDT." }, "feeCurrency": { "type": "string", "description": "The currency of charged fees." }, "market": { "type": "string", "description": "The trading market.", "example": [ "USDS", "BTC", "ALTS" ] }, "baseMinSize": { "type": "string", "description": "The minimum order quantity requried to place an order." }, "quoteMinSize": { "type": "string", "description": "The minimum order funds required to place a market order." }, "baseMaxSize": { "type": "string", "description": "The maximum order size required to place an order." }, "quoteMaxSize": { "type": "string", "description": "The maximum order funds required to place a market order." }, "baseIncrement": { "type": "string", "description": "Quantity increment: The quantity for an order must be a positive integer multiple of this increment. Here, the size refers to the quantity of the base currency for the order. For example, for the ETH-USDT trading pair, if the baseIncrement is 0.0000001, the order quantity can be 1.0000001 but not 1.00000001." }, "quoteIncrement": { "type": "string", "description": "Quote increment: The funds for a market order must be a positive integer multiple of this increment. The funds refer to the quote currency amount. For example, for the ETH-USDT trading pair, if the quoteIncrement is 0.000001, the amount of USDT for the order can be 3000.000001 but not 3000.0000001." }, "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." }, "priceLimitRate": { "type": "string", "description": "Threshold for price portection" }, "minFunds": { "type": "string", "description": "The minimum trading amounts" }, "isMarginEnabled": { "type": "boolean", "description": "Available for margin or not." }, "enableTrading": { "type": "boolean", "description": "Available for transaction or not." }, "feeCategory": { "type": "integer", "description": "[Fee Type](https://www.kucoin.com/vip/privilege)", "enum": [ 1, 2, 3 ], "x-api-enum": [ { "value": 1, "name": "classA", "description": "classA" }, { "value": 2, "name": "classB", "description": "classB" }, { "value": 3, "name": "classC", "description": "classC" } ] }, "makerFeeCoefficient": { "type": "string", "description": "The maker 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" }, "takerFeeCoefficient": { "type": "string", "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", "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", "example": [ "0.00001" ] }, "callauctionPriceCeiling": { "type": "string", "description": "The highest bid price in the call auction\n", "example": [ "0.6" ] }, "callauctionFirstStageStartTime": { "type": "integer", "description": "The first phase of the call auction starts at (Allow add orders, allow cancel orders)", "format": "int64", "example": [ 1740470400000 ] }, "callauctionSecondStageStartTime": { "type": "integer", "description": "The second phase of the call auction starts at (Allow add orders, don't allow cancel orders)", "format": "int64", "example": [ 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", "example": [ 1740473700000 ] }, "tradingStartTime": { "type": "integer", "description": "Official opening time (end time of the third phase of call auction)", "format": "int64", "example": [ 1740474000000 ] } }, "required": [ "symbol", "name", "baseCurrency", "quoteCurrency", "feeCurrency", "market", "baseMinSize", "quoteMinSize", "baseMaxSize", "quoteMaxSize", "baseIncrement", "quoteIncrement", "priceIncrement", "priceLimitRate", "minFunds", "isMarginEnabled", "enableTrading", "feeCategory", "makerFeeCoefficient", "takerFeeCoefficient", "st", "callauctionIsEnabled" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470159", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getSymbol", "x-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.", "x-api-rate-limit-weight": 4, "x-response-example": "{\\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}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "004" } }, "/api/v2/symbols": { "get": { "summary": "Get All Symbols", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "market", "in": "query", "description": "[The trading market](https://www.kucoin.com/docs-new/api-222921786)", "required": false, "schema": { "type": "string", "example": [ "ALTS", "USDS", "ETF" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Unique code of a symbol; it will not change after renaming", "example": [ "BTC-USDT", "BCHSV-USDT" ] }, "name": { "type": "string", "description": "Name of trading pairs, it will change after renaming", "example": [ "BTC-USDT", "BSV-USDT" ] }, "baseCurrency": { "type": "string", "description": "Base currency, e.g. BTC." }, "quoteCurrency": { "type": "string", "description": "Quote currency, e.g. USDT." }, "feeCurrency": { "type": "string", "description": "The currency of charged fees." }, "market": { "type": "string", "description": "The trading market.", "example": [ "USDS", "BTC", "ALTS" ] }, "baseMinSize": { "type": "string", "description": "The minimum order quantity required to place an order." }, "quoteMinSize": { "type": "string", "description": "The minimum order funds required to place a market order." }, "baseMaxSize": { "type": "string", "description": "The maximum order size required to place an order." }, "quoteMaxSize": { "type": "string", "description": "The maximum order funds required to place a market order." }, "baseIncrement": { "type": "string", "description": "Quantity increment: The quantity for an order must be a positive integer multiple of this increment. Here, the size refers to the quantity of the base currency for the order. For example, for the ETH-USDT trading pair, if the baseIncrement is 0.0000001, the order quantity can be 1.0000001 but not 1.00000001." }, "quoteIncrement": { "type": "string", "description": "Quote increment: The funds for a market order must be a positive integer multiple of this increment. The funds refer to the quote currency amount. For example, for the ETH-USDT trading pair, if the quoteIncrement is 0.000001, the amount of USDT for the order can be 3000.000001 but not 3000.0000001." }, "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." }, "priceLimitRate": { "type": "string", "description": "Threshold for price protection" }, "minFunds": { "type": "string", "description": "The minimum trading amounts" }, "isMarginEnabled": { "type": "boolean", "description": "Available for margin or not." }, "enableTrading": { "type": "boolean", "description": "Available for transaction or not." }, "feeCategory": { "type": "integer", "description": "[Fee Type](https://www.kucoin.com/vip/privilege)", "enum": [ 1, 2, 3 ], "x-api-enum": [ { "value": 1, "name": "classA", "description": "classA" }, { "value": 2, "name": "classB", "description": "classB" }, { "value": 3, "name": "classC", "description": "classC" } ] }, "makerFeeCoefficient": { "type": "string", "description": "The maker 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" }, "takerFeeCoefficient": { "type": "string", "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", "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", "example": [ "0.00001" ] }, "callauctionPriceCeiling": { "type": "string", "description": "The highest bid price in the call auction\n", "example": [ "0.6" ] }, "callauctionFirstStageStartTime": { "type": "integer", "description": "The first phase of the call auction starts at (Allow add orders, allow cancel orders)", "format": "int64", "example": [ 1740470400000 ] }, "callauctionSecondStageStartTime": { "type": "integer", "description": "The second phase of the call auction starts at (Allow add orders, don't allow cancel orders)", "format": "int64", "example": [ 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", "example": [ 1740473700000 ] }, "tradingStartTime": { "type": "integer", "description": "Official opening time (end time of the third phase of call auction)", "format": "int64", "example": [ 1740474000000 ] } }, "required": [ "symbol", "name", "baseCurrency", "quoteCurrency", "feeCurrency", "market", "baseMinSize", "quoteMinSize", "baseMaxSize", "quoteMaxSize", "baseIncrement", "quoteIncrement", "priceIncrement", "priceLimitRate", "minFunds", "isMarginEnabled", "enableTrading", "feeCategory", "makerFeeCoefficient", "takerFeeCoefficient", "st", "callauctionIsEnabled" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470154", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getAllSymbols", "x-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.", "x-api-rate-limit-weight": 4, "x-response-example": "{\\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}", "x-request-example": "{\\\"market\\\": \\\"ALTS\\\"}", "operationId": "005" } }, "/api/v1/market/orderbook/level1": { "get": { "summary": "Get Ticker", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "time": { "type": "integer", "description": "timestamp", "format": "int64" }, "sequence": { "type": "string", "description": "Sequence" }, "price": { "type": "string", "description": "Last traded price" }, "size": { "type": "string", "description": "Last traded size" }, "bestBid": { "type": "string", "description": "Best bid price" }, "bestBidSize": { "type": "string", "description": "Best bid size" }, "bestAsk": { "type": "string", "description": "Best ask price" }, "bestAskSize": { "type": "string", "description": "Best ask size" } }, "required": [ "sequence", "price", "size", "bestBid", "bestBidSize", "bestAsk", "bestAskSize", "time" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470160", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getTicker", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"time\\\":1729172965609,\\\"sequence\\\":\\\"14609309753\\\",\\\"price\\\":\\\"67269\\\",\\\"size\\\":\\\"0.000025\\\",\\\"bestBid\\\":\\\"67267.5\\\",\\\"bestBidSize\\\":\\\"0.000025\\\",\\\"bestAsk\\\":\\\"67267.6\\\",\\\"bestAskSize\\\":\\\"1.24808993\\\"}}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "006" } }, "/api/v1/market/allTickers": { "get": { "summary": "Get All Tickers", "deprecated": false, "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.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "time": { "type": "integer", "description": "timestamp", "format": "int64" }, "ticker": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Symbol" }, "symbolName": { "type": "string", "description": "Name of trading pairs, it will change after renaming" }, "buy": { "type": "string", "description": "Best bid price" }, "bestBidSize": { "type": "string", "description": "Best bid size" }, "sell": { "type": "string", "description": "Best ask price" }, "bestAskSize": { "type": "string", "description": "Best ask size" }, "changeRate": { "type": "string", "description": "24h change rate" }, "changePrice": { "type": "string", "description": "24h change price" }, "high": { "type": "string", "description": "Highest price in 24h" }, "low": { "type": "string", "description": "Lowest price in 24h" }, "vol": { "type": "string", "description": "24h volume, executed based on base currency" }, "volValue": { "type": "string", "description": "24h traded amount" }, "last": { "type": "string", "description": "Last traded price" }, "averagePrice": { "type": "string", "description": "Average trading price in the last 24 hours" }, "takerFeeRate": { "type": "string", "description": "Basic Taker Fee" }, "makerFeeRate": { "type": "string", "description": "Basic Maker Fee" }, "takerCoefficient": { "type": "string", "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", "enum": [ "1", "0" ], "x-api-enum": [ { "value": "1", "name": "1", "description": "The taker fee coefficient is 1" }, { "value": "0", "name": "", "description": "No fee" } ] }, "makerCoefficient": { "type": "string", "description": "The maker 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", "enum": [ "1", "0" ], "x-api-enum": [ { "value": "1", "name": "1", "description": "The maker fee coefficient is 1" }, { "value": "0", "name": "", "description": "No fee" } ] } }, "required": [ "symbol", "symbolName", "buy", "bestBidSize", "sell", "bestAskSize", "changeRate", "changePrice", "high", "low", "vol", "volValue", "last", "averagePrice", "takerFeeRate", "makerFeeRate", "takerCoefficient", "makerCoefficient" ] } } }, "required": [ "time", "ticker" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470167", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getAllTickers", "x-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.", "x-api-rate-limit-weight": 15, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"time\\\": 1729173207043,\\n \\\"ticker\\\": [\\n {\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"symbolName\\\": \\\"BTC-USDT\\\",\\n \\\"buy\\\": \\\"67192.5\\\",\\n \\\"bestBidSize\\\": \\\"0.000025\\\",\\n \\\"sell\\\": \\\"67192.6\\\",\\n \\\"bestAskSize\\\": \\\"1.24949204\\\",\\n \\\"changeRate\\\": \\\"-0.0014\\\",\\n \\\"changePrice\\\": \\\"-98.5\\\",\\n \\\"high\\\": \\\"68321.4\\\",\\n \\\"low\\\": \\\"66683.3\\\",\\n \\\"vol\\\": \\\"1836.03034612\\\",\\n \\\"volValue\\\": \\\"124068431.06726933\\\",\\n \\\"last\\\": \\\"67193\\\",\\n \\\"averagePrice\\\": \\\"67281.21437289\\\",\\n \\\"takerFeeRate\\\": \\\"0.001\\\",\\n \\\"makerFeeRate\\\": \\\"0.001\\\",\\n \\\"takerCoefficient\\\": \\\"1\\\",\\n \\\"makerCoefficient\\\": \\\"1\\\"\\n }\\n ]\\n }\\n}", "operationId": "007" } }, "/api/v1/market/histories": { "get": { "summary": "Get Trade History", "deprecated": false, "description": "Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "sequence": { "type": "string", "description": "Sequence number" }, "price": { "type": "string", "description": "Filled price" }, "size": { "type": "string", "description": "Filled amount" }, "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.", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "buy", "description": "buy" }, { "value": "sell", "name": "sell", "description": "sell" } ] }, "time": { "type": "integer", "format": "int64", "description": "Filled timestamp(nanosecond)" } }, "required": [ "sequence", "price", "size", "side", "time" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470162", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getTradeHistory", "x-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.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"sequence\\\": \\\"10976028003549185\\\",\\n \\\"price\\\": \\\"67122\\\",\\n \\\"size\\\": \\\"0.000025\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"time\\\": 1729177117877000000\\n },\\n {\\n \\\"sequence\\\": \\\"10976028003549188\\\",\\n \\\"price\\\": \\\"67122\\\",\\n \\\"size\\\": \\\"0.01792257\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"time\\\": 1729177117877000000\\n },\\n {\\n \\\"sequence\\\": \\\"10976028003549191\\\",\\n \\\"price\\\": \\\"67122.9\\\",\\n \\\"size\\\": \\\"0.05654289\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"time\\\": 1729177117877000000\\n }\\n ]\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "008" } }, "/api/v1/market/candles": { "get": { "summary": "Get Klines", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": " symbol", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of candlestick patterns: 1min, 3min, 5min, 15min, 30min, 1hour, 2hour, 4hour, 6hour, 8hour, 12hour, 1day, 1week, 1month", "required": true, "schema": { "type": "string", "enum": [ "1min", "3min", "5min", "15min", "30min", "1hour", "2hour", "4hour", "6hour", "8hour", "12hour", "1day", "1week", "1month" ], "x-api-enum": [ { "value": "1min", "name": "1min", "description": "1min" }, { "value": "3min", "name": "3min", "description": "3min" }, { "value": "5min", "name": "5min", "description": "5min" }, { "value": "15min", "name": "15min", "description": "15min" }, { "value": "30min", "name": "30min", "description": "30min" }, { "value": "1hour", "name": "1hour", "description": "1hour" }, { "value": "2hour", "name": "2hour", "description": "2hour" }, { "value": "4hour", "name": "4hour", "description": "4hour" }, { "value": "6hour", "name": "6hour", "description": "6hour" }, { "value": "8hour", "name": "8hour", "description": "8hour" }, { "value": "12hour", "name": "12hour", "description": "12hour" }, { "value": "1day", "name": "1day", "description": "1day" }, { "value": "1week", "name": "1week", "description": "1week" }, { "value": "1month", "name": "1month", "description": "1month" } ] } }, { "name": "startAt", "in": "query", "description": "Start time (second), default is 0", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "endAt", "in": "query", "description": "End time (second), default is 0", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "string", "description": "Start time of the candle cycle, opening price, closing price, highest price, Lowest price, Transaction amount, Transaction volume" } } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470163", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getKlines", "x-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.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n [\\n \\\"1566789720\\\",\\n \\\"10411.5\\\",\\n \\\"10401.9\\\",\\n \\\"10411.5\\\",\\n \\\"10396.3\\\",\\n \\\"29.11357276\\\",\\n \\\"302889.301529914\\\"\\n ],\\n [\\n \\\"1566789660\\\",\\n \\\"10416\\\",\\n \\\"10411.5\\\",\\n \\\"10422.3\\\",\\n \\\"10411.5\\\",\\n \\\"15.61781842\\\",\\n \\\"162703.708997029\\\"\\n ],\\n [\\n \\\"1566789600\\\",\\n \\\"10408.6\\\",\\n \\\"10416\\\",\\n \\\"10416\\\",\\n \\\"10405.4\\\",\\n \\\"12.45584973\\\",\\n \\\"129666.51508559\\\"\\n ]\\n ]\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"type\\\": \\\"1min\\\", \\\"startAt\\\": 1566703297, \\\"endAt\\\": 1566789757}", "operationId": "009" } }, "/api/v1/market/orderbook/level2_{size}": { "get": { "summary": "Get Part OrderBook", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "path", "description": "Get the depth layer, optional value: 20, 100", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "time": { "type": "integer", "description": "Timestamp(millisecond)", "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" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470165", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getPartOrderBook", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\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}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"size\\\": \\\"20\\\"}", "operationId": "010" } }, "/api/v3/market/orderbook/level2": { "get": { "summary": "Get Full OrderBook", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "time": { "type": "integer", "description": "Timestamp(millisecond)", "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": [ "time", "sequence", "bids", "asks" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470164", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getFullOrderBook", "x-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.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\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}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "011" } }, "/api/v1/market/orderbook/callauction/level2_{size}": { "get": { "summary": "Get Call Auction Part OrderBook", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "path", "description": "Get the depth layer, optional value: 20, 100", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "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" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3471564", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getCallAuctionPartOrderBook", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\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}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"size\\\": \\\"20\\\"}", "operationId": "012" } }, "/api/v1/market/callauctionData": { "get": { "summary": "Get Call Auction Info", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Symbol", "example": [ "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": "Buy order minimum price" }, "buyOrderRangeHighPrice": { "type": "string", "description": "Buy ​​order maximum price" }, "time": { "type": "integer", "description": "Timestamp (ms)", "format": "int64" } }, "required": [ "sellOrderRangeLowPrice", "sellOrderRangeHighPrice", "buyOrderRangeLowPrice", "buyOrderRangeHighPrice", "time", "symbol", "estimatedPrice", "estimatedSize" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3471565", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getCallAuctionInfo", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\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}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "013" } }, "/api/v1/prices": { "get": { "summary": "Get Fiat Price", "deprecated": false, "description": "Request the fiat price of the currencies for the available trading pairs via this endpoint.", "tags": [], "parameters": [ { "name": "base", "in": "query", "description": "Ticker symbol of a base currency, e.g. USD, EUR. Default is USD", "required": false, "schema": { "type": "string", "default": "USD", "example": [ "USD", "EUR" ] } }, { "name": "currencies", "in": "query", "description": "Comma-separated cryptocurrencies to be converted into fiat, e.g.: BTC,ETH, etc. Default to return the fiat price of all currencies.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": {}, "additionalProperties": { "type": "string" } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470153", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getFiatPrice", "x-sdk-method-description": "Request the fiat price of the currencies for the available trading pairs via this endpoint.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"AGLD\\\":\\\"1.1174410000000001\\\",\\\"DFI\\\":\\\"0.0168915500000000\\\",\\\"PYTHUP\\\":\\\"0.0397880960000000\\\",\\\"ISLM\\\":\\\"0.0606196750000000\\\",\\\"NEAR\\\":\\\"4.7185395500000000\\\",\\\"AIOZ\\\":\\\"0.4862867350000000\\\",\\\"AUDIO\\\":\\\"0.1219390000000000\\\",\\\"BBL\\\":\\\"0.0067766100000000\\\",\\\"WLD\\\":\\\"2.2893547500000000\\\",\\\"HNT\\\":\\\"5.8990489999999984\\\",\\\"ETHFI\\\":\\\"1.5892050000000000\\\",\\\"DMAIL\\\":\\\"0.2726636000000000\\\",\\\"OPUP\\\":\\\"0.0986506500000000\\\",\\\"VET3S\\\":\\\"0.0003700448850000\\\",\\\"MANA3S\\\":\\\"0.0006056970000000\\\",\\\"TIDAL\\\":\\\"0.0001154422500000\\\",\\\"HALO\\\":\\\"0.0058270850000000\\\",\\\"OPUL\\\":\\\"0.0839480050000000\\\",\\\"MANA3L\\\":\\\"0.0029569407900000\\\",\\\"DGB\\\":\\\"0.0066556705000000\\\",\\\"AA\\\":\\\"0.2406796000000000\\\",\\\"BCH\\\":\\\"366.2167999999996484\\\",\\\"GMEE\\\":\\\"0.0113333305000000\\\",\\\"JST\\\":\\\"0.0302348750000000\\\",\\\"PBUX\\\":\\\"0.0208795550000000\\\",\\\"AR\\\":\\\"18.5457224999999909\\\",\\\"SEI\\\":\\\"0.4332832500000000\\\",\\\"PSTAKE\\\":\\\"0.0493153300000000\\\",\\\"LMWR\\\":\\\"0.1618190500000000\\\",\\\"UNFIDOWN\\\":\\\"0.0062058955000000\\\",\\\"BB\\\":\\\"0.3245376500000000\\\",\\\"JTO\\\":\\\"2.1239375000000002\\\",\\\"WEMIX\\\":\\\"0.7916040000000000\\\",\\\"G\\\":\\\"0.0324037900000000\\\",\\\"MARSH\\\":\\\"0.0617591050000000\\\",\\\"BN\\\":\\\"0.0036961510000000\\\",\\\"FLIP\\\":\\\"1.0976509000000000\\\",\\\"FLR\\\":\\\"0.0144827550000000\\\",\\\"BIGTIME\\\":\\\"0.1238780300000000\\\",\\\"FLY\\\":\\\"0.0005157420000000\\\",\\\"T\\\":\\\"0.0233483200000000\\\",\\\"W\\\":\\\"0.2865566500000000\\\",\\\"BDX\\\":\\\"0.0774012800000000\\\",\\\"BABYDOGE\\\":\\\"0.0000000029375305\\\",\\\"SFP\\\":\\\"0.7256370000000000\\\",\\\"DIA\\\":\\\"0.9179408000000000\\\",\\\"ISME\\\":\\\"0.0022388800000000\\\",\\\"LYM\\\":\\\"0.0010155919500000\\\",\\\"VET3L\\\":\\\"0.0000289755050000\\\",\\\"JUP\\\":\\\"0.8230882500000000\\\",\\\"LYX\\\":\\\"1.4501745500000001\\\",\\\"AIEPK\\\":\\\"0.0050094940000000\\\",\\\"SILLY\\\":\\\"0.0159420250000000\\\",\\\"SCPT\\\":\\\"0.0122038950000000\\\",\\\"WOO\\\":\\\"0.1796601250000000\\\",\\\"BLUR\\\":\\\"0.2462768000000000\\\",\\\"STRK\\\":\\\"0.3963117450000000\\\",\\\"BFC\\\":\\\"0.0383608100000000\\\",\\\"DC\\\":\\\"0.0003097450500000\\\",\\\"KARATE\\\":\\\"0.0007296350000000\\\",\\\"SUSHI3L\\\":\\\"0.5115441000000000\\\",\\\"NETVR\\\":\\\"0.0976111700000000\\\",\\\"WAVES\\\":\\\"1.0806594000000000\\\",\\\"LITH\\\":\\\"0.0001520239500000\\\",\\\"HAPI\\\":\\\"8.6533711499999987\\\",\\\"SUSHI3S\\\":\\\"1.2752620500000000\\\",\\\"CEEK\\\":\\\"0.0294852500000000\\\",\\\"FLOKI\\\":\\\"0.0001414292500000\\\",\\\"SHR\\\":\\\"0.0012463765000000\\\",\\\"SAND\\\":\\\"0.2566616050000000\\\",\\\"TURT\\\":\\\"0.0020889550000000\\\",\\\"UMA\\\":\\\"2.5207390000000000\\\",\\\"BEPRO\\\":\\\"0.0003955021500000\\\",\\\"SCRT\\\":\\\"0.1995002000000000\\\",\\\"TUSD\\\":\\\"0.9945025000000000\\\",\\\"COOKIE\\\":\\\"0.0220089900000000\\\",\\\"LRDS\\\":\\\"0.6218889000000000\\\",\\\"SIN\\\":\\\"0.0033633175000000\\\",\\\"OAS\\\":\\\"0.0331933950000000\\\",\\\"ROOT\\\":\\\"0.0183108400000000\\\",\\\"ADA3L\\\":\\\"0.0046396790000000\\\",\\\"TIAUP\\\":\\\"0.1228385500000000\\\",\\\"HTR\\\":\\\"0.0353023400000000\\\",\\\"UNB\\\":\\\"0.0003837080500000\\\",\\\"UNA\\\":\\\"0.0164917500000000\\\",\\\"HARD\\\":\\\"0.1087056200000000\\\",\\\"G3\\\":\\\"0.0502648550000000\\\",\\\"ADA3S\\\":\\\"0.0006191202850000\\\",\\\"MYRO\\\":\\\"0.1071863800000000\\\",\\\"HTX\\\":\\\"0.0000013693150000\\\",\\\"FT\\\":\\\"0.3585206500000000\\\",\\\"BTCDOWN\\\":\\\"0.1065467000000000\\\",\\\"UNI\\\":\\\"7.3571195999999993\\\",\\\"FX\\\":\\\"0.1379310000000000\\\",\\\"OBI\\\":\\\"0.0079030465000000\\\",\\\"UNO\\\":\\\"0.0137131400000000\\\",\\\"WRX\\\":\\\"0.1221389000000000\\\",\\\"TIADOWN\\\":\\\"0.0000914642450000\\\",\\\"ETHDOWN\\\":\\\"0.1306346500000000\\\",\\\"WELL\\\":\\\"0.0471244260000000\\\",\\\"SWFTC\\\":\\\"0.0028966509500000\\\",\\\"SKL\\\":\\\"0.0362418700000000\\\",\\\"UOS\\\":\\\"0.0867765900000000\\\",\\\"AIPAD\\\":\\\"0.0478660550000000\\\",\\\"BRETT\\\":\\\"0.1037481000000000\\\",\\\"SKY\\\":\\\"0.0520139800000000\\\",\\\"FRM\\\":\\\"0.0153123400000000\\\",\\\"VISION\\\":\\\"0.0014451770500000\\\",\\\"LENDS\\\":\\\"0.0047276350000000\\\",\\\"SLF\\\":\\\"0.3318340000000000\\\",\\\"BULL\\\":\\\"0.0023988000000000\\\",\\\"FLOW\\\":\\\"0.5372312500000000\\\",\\\"ODDZ\\\":\\\"0.0063368300000000\\\",\\\"SLN\\\":\\\"0.2804597000000000\\\",\\\"UPO\\\":\\\"0.0440779500000000\\\",\\\"SLP\\\":\\\"0.0023997995000000\\\",\\\"ID\\\":\\\"0.3718140000000000\\\",\\\"SLIM\\\":\\\"0.0906446550000000\\\",\\\"SPOT\\\":\\\"0.0021289350000000\\\",\\\"DOP\\\":\\\"0.0023028480000000\\\",\\\"ISSP\\\":\\\"0.0000874562500000\\\",\\\"UQC\\\":\\\"3.2339822000000003\\\",\\\"IO\\\":\\\"1.8185902499999999\\\",\\\"DOT\\\":\\\"4.2022978000000005\\\",\\\"1INCH\\\":\\\"0.2645676500000000\\\",\\\"SMH\\\":\\\"0.3448275000000000\\\",\\\"MAK\\\":\\\"0.0396701550000000\\\",\\\"TOKO\\\":\\\"0.0005923037000000\\\",\\\"TURBO\\\":\\\"0.0108085930000000\\\",\\\"UNFI\\\":\\\"2.8555714999999996\\\",\\\"MAN\\\":\\\"0.0210764565000000\\\",\\\"EVER\\\":\\\"0.0332733550000000\\\",\\\"FTM\\\":\\\"0.7259068650000000\\\",\\\"SHRAP\\\":\\\"0.0476361700000000\\\",\\\"MAV\\\":\\\"0.1738130500000000\\\",\\\"MAX\\\":\\\"0.2864966800000000\\\",\\\"DPR\\\":\\\"0.0018240875000000\\\",\\\"FTT\\\":\\\"2.0559715000000002\\\",\\\"ARKM\\\":\\\"1.7444273499999999\\\",\\\"ATOM\\\":\\\"4.2954512000000002\\\",\\\"PENDLE\\\":\\\"4.1554212500000007\\\",\\\"QUICK\\\":\\\"0.0365317250000000\\\",\\\"BLZ\\\":\\\"0.1217191100000000\\\",\\\"BOBA\\\":\\\"0.2014092450000000\\\",\\\"MBL\\\":\\\"0.0027856065000000\\\",\\\"OFN\\\":\\\"0.1252373500000000\\\",\\\"UNIO\\\":\\\"0.0025487250000000\\\",\\\"SNS\\\":\\\"0.0200899500000000\\\",\\\"SNX\\\":\\\"1.4282854999999999\\\",\\\"NXRA\\\":\\\"0.0272763550000000\\\",\\\"TAIKO\\\":\\\"1.4392800000000001\\\",\\\"AVAX3L\\\":\\\"0.1410875109550000\\\",\\\"L3\\\":\\\"0.0608395650000000\\\",\\\"API3\\\":\\\"1.3728132500000001\\\",\\\"XRP3S\\\":\\\"0.0028095945000000\\\",\\\"QKC\\\":\\\"0.0085157400000000\\\",\\\"AVAX3S\\\":\\\"0.5148424500000000\\\",\\\"ROSE\\\":\\\"0.0693453100000000\\\",\\\"SATS\\\":\\\"0.0000002701648500\\\",\\\"BMX\\\":\\\"0.3100449000000000\\\",\\\"PORTAL\\\":\\\"0.2811593500000000\\\",\\\"TOMI\\\":\\\"0.0309045400000000\\\",\\\"XRP3L\\\":\\\"2.1586201500000002\\\",\\\"SOL\\\":\\\"151.7250995000003583\\\",\\\"SON\\\":\\\"0.0002421788500000\\\",\\\"BNC\\\":\\\"0.1882058500000000\\\",\\\"SOCIAL\\\":\\\"0.0026486750000000\\\",\\\"CGPT\\\":\\\"0.1305147100000000\\\",\\\"CELR\\\":\\\"0.0127736100000000\\\",\\\"BNB\\\":\\\"591.0973035000118935\\\",\\\"OGN\\\":\\\"0.0852573500000000\\\",\\\"CELO\\\":\\\"0.7711142500000000\\\",\\\"AUCTION\\\":\\\"13.1634150000000014\\\",\\\"MANTA\\\":\\\"0.7564216000000000\\\",\\\"LAYER\\\":\\\"0.0372713550000000\\\",\\\"AERO\\\":\\\"1.3783104999999999\\\",\\\"CETUS\\\":\\\"0.1808295400000000\\\",\\\"LL\\\":\\\"0.0201199350000000\\\",\\\"SPA\\\":\\\"0.0067426270000000\\\",\\\"PYTHDOWN\\\":\\\"0.0011834080000000\\\",\\\"NEIROCTO\\\":\\\"0.0019964013000000\\\",\\\"UTK\\\":\\\"0.0365217300000000\\\",\\\"GMRX\\\":\\\"0.0007386305000000\\\",\\\"BOB\\\":\\\"0.0000380619595000\\\",\\\"HOTCROSS\\\":\\\"0.0056491740000000\\\",\\\"AERGO\\\":\\\"0.1007595950000000\\\",\\\"MOCA\\\":\\\"0.0783608000000000\\\",\\\"SQD\\\":\\\"0.0380809500000000\\\",\\\"MV\\\":\\\"0.0081359300000000\\\",\\\"BNB3L\\\":\\\"0.2761618500000000\\\",\\\"BNB3S\\\":\\\"0.0008545725000000\\\",\\\"GALAX3L\\\":\\\"0.0057571999600000\\\",\\\"KAI\\\":\\\"0.0020080954500000\\\",\\\"SQR\\\":\\\"0.0470764500000000\\\",\\\"GALAX3S\\\":\\\"0.1933033000000000\\\",\\\"EGLD\\\":\\\"25.5272299999999713\\\",\\\"ZBCN\\\":\\\"0.0010404795000000\\\",\\\"KAS\\\":\\\"0.1216691350000000\\\",\\\"MEW\\\":\\\"0.0086176890000000\\\",\\\"PUNDIX\\\":\\\"0.4130933500000000\\\",\\\"LOOKS\\\":\\\"0.0392803500000000\\\",\\\"FXS\\\":\\\"1.9060465000000000\\\",\\\"BOSON\\\":\\\"0.2732633000000000\\\",\\\"BRISE\\\":\\\"0.0000000860569500\\\",\\\"AEVO\\\":\\\"0.3388305000000000\\\",\\\"FLUX\\\":\\\"0.5276360500000000\\\",\\\"PRCL\\\":\\\"0.1969015000000000\\\",\\\"UNFIUP\\\":\\\"0.0011654170000000\\\",\\\"SEIDOWN\\\":\\\"0.0442778500000000\\\",\\\"DOAI\\\":\\\"0.0052363805000000\\\",\\\"QNT\\\":\\\"65.4312679999998206\\\",\\\"REDO\\\":\\\"0.2837580500000000\\\",\\\"STRIKE\\\":\\\"6.8225869999999997\\\",\\\"ETHW\\\":\\\"3.2418782499999998\\\",\\\"OM\\\":\\\"1.5396797750000000\\\",\\\"OP\\\":\\\"1.6911539999999999\\\",\\\"WHALE\\\":\\\"0.8134930500000000\\\",\\\"1CAT\\\":\\\"0.0018460765000000\\\",\\\"NEON\\\":\\\"0.4446775500000000\\\",\\\"GTAI\\\":\\\"0.7786105000000000\\\",\\\"SSV\\\":\\\"21.2393749999999841\\\",\\\"ETH2\\\":\\\"2601.6678843156403923\\\",\\\"KCS\\\":\\\"8.7646155000000020\\\",\\\"ARPA\\\":\\\"0.0393882960000000\\\",\\\"ARTFI\\\":\\\"0.0141029450000000\\\",\\\"BRL\\\":\\\"0.1742807323452485\\\",\\\"ALEX\\\":\\\"0.0924537500000000\\\",\\\"STG\\\":\\\"0.2943527500000000\\\",\\\"SHIB\\\":\\\"0.0000178060925000\\\",\\\"IOTX\\\":\\\"0.0394202800000000\\\",\\\"OLE\\\":\\\"0.0171414250000000\\\",\\\"KDA\\\":\\\"0.5653172000000000\\\",\\\"CERE\\\":\\\"0.0022548720000000\\\",\\\"DOCK\\\":\\\"0.0018990500000000\\\",\\\"STX\\\":\\\"1.8157916500000000\\\",\\\"OLT\\\":\\\"0.0007596200000000\\\",\\\"QI\\\":\\\"0.0131754090000000\\\",\\\"SDAO\\\":\\\"0.2748625000000000\\\",\\\"BLAST\\\":\\\"0.0087636160000000\\\",\\\"LINK3S\\\":\\\"0.0000702948350000\\\",\\\"IOST\\\":\\\"0.0049745115000000\\\",\\\"SUI\\\":\\\"2.0589700000000000\\\",\\\"CAKE\\\":\\\"1.7941024999999999\\\",\\\"BSW\\\":\\\"0.0586706500000000\\\",\\\"OMG\\\":\\\"0.2597700500000000\\\",\\\"VOLT\\\":\\\"0.0000002716641000\\\",\\\"LINK3L\\\":\\\"1.3408292499999999\\\",\\\"GEEQ\\\":\\\"0.0385607100000000\\\",\\\"PYUSD\\\":\\\"0.9988003500000000\\\",\\\"SUN\\\":\\\"0.0186106900000000\\\",\\\"TOWER\\\":\\\"0.0014812590000000\\\",\\\"BTC\\\":\\\"67133.4165000832051564\\\",\\\"IOTA\\\":\\\"0.1189405000000000\\\",\\\"REEF\\\":\\\"0.0019960015000000\\\",\\\"TRIAS\\\":\\\"3.3683149999999998\\\",\\\"KEY\\\":\\\"0.0037594713240047\\\",\\\"ETH3L\\\":\\\"0.0003305946200000\\\",\\\"BTT\\\":\\\"0.0000009117439000\\\",\\\"ONE\\\":\\\"0.0132003965000000\\\",\\\"RENDER\\\":\\\"5.2263854999999995\\\",\\\"ETH3S\\\":\\\"0.5517240000000000\\\",\\\"ANKR\\\":\\\"0.0264867500000000\\\",\\\"ALGO\\\":\\\"0.1188405500000000\\\",\\\"SYLO\\\":\\\"0.0007600198000000\\\",\\\"ZCX\\\":\\\"0.0784707450000000\\\",\\\"SD\\\":\\\"0.3851073500000000\\\",\\\"ONT\\\":\\\"0.1877960550000000\\\",\\\"MJT\\\":\\\"0.0132433750000000\\\",\\\"DYM\\\":\\\"1.6659666000000001\\\",\\\"DYP\\\":\\\"0.0205397250000000\\\",\\\"BAKEUP\\\":\\\"0.0389894955000000\\\",\\\"OOE\\\":\\\"0.0079360300000000\\\",\\\"ZELIX\\\":\\\"0.0000649675000000\\\",\\\"DOGE3L\\\":\\\"0.3837080500000000\\\",\\\"ARTY\\\":\\\"0.3980009000000000\\\",\\\"QORPO\\\":\\\"0.1204297550000000\\\",\\\"ICE\\\":\\\"0.0051504235000000\\\",\\\"NOTAI\\\":\\\"0.0000892753400000\\\",\\\"DOGE3S\\\":\\\"0.2291853500000000\\\",\\\"NAKA\\\":\\\"1.0695649500000000\\\",\\\"GALAX\\\":\\\"0.0212893500000000\\\",\\\"MKR\\\":\\\"1245.8767500000163833\\\",\\\"DODO\\\":\\\"0.1152423500000000\\\",\\\"ICP\\\":\\\"7.6731615000000027\\\",\\\"ZEC\\\":\\\"35.9400209999999543\\\",\\\"ZEE\\\":\\\"0.0065767100000000\\\",\\\"ICX\\\":\\\"0.1383308000000000\\\",\\\"KMNO\\\":\\\"0.0921499020000000\\\",\\\"TT\\\":\\\"0.0033883050000000\\\",\\\"DOT3L\\\":\\\"0.1454272500000000\\\",\\\"XAI\\\":\\\"0.2038980000000000\\\",\\\"ZEN\\\":\\\"8.0149905000000007\\\",\\\"DOGE\\\":\\\"0.1213093150000000\\\",\\\"ALPHA\\\":\\\"0.0567416150000000\\\",\\\"DUSK\\\":\\\"0.1964517250000000\\\",\\\"DOT3S\\\":\\\"0.0053613180000000\\\",\\\"SXP\\\":\\\"0.2538730000000000\\\",\\\"HBAR\\\":\\\"0.0510044850000000\\\",\\\"SYNT\\\":\\\"0.0467166300000000\\\",\\\"ZEX\\\":\\\"0.0571714000000000\\\",\\\"BONDLY\\\":\\\"0.0022208890000000\\\",\\\"MLK\\\":\\\"0.2080859050000000\\\",\\\"KICKS\\\":\\\"0.0001301249050000\\\",\\\"PEPE\\\":\\\"0.0000100249850000\\\",\\\"OUSD\\\":\\\"0.9982006500000000\\\",\\\"LUNCDOWN\\\":\\\"0.0000733333150000\\\",\\\"DOGS\\\":\\\"0.0007086455000000\\\",\\\"REV3L\\\":\\\"0.0094672640000000\\\",\\\"CTSI\\\":\\\"0.1257371000000000\\\",\\\"C98\\\":\\\"0.1219390000000000\\\",\\\"OSMO\\\":\\\"0.5370313500000000\\\",\\\"NTRN\\\":\\\"0.3869064500000000\\\",\\\"CFX2S\\\":\\\"0.0084757600000000\\\",\\\"SYN\\\":\\\"0.5636180500000000\\\",\\\"VIDT\\\":\\\"0.0308745550000000\\\",\\\"SYS\\\":\\\"0.0997501000000000\\\",\\\"GAS\\\":\\\"4.3029474500000008\\\",\\\"BOME\\\":\\\"0.0087336310000000\\\",\\\"COMBO\\\":\\\"0.4068964500000000\\\",\\\"XCH\\\":\\\"14.9825050000000010\\\",\\\"VR\\\":\\\"0.0063538215000000\\\",\\\"CFX2L\\\":\\\"0.0499660045000000\\\",\\\"VSYS\\\":\\\"0.0005201398000000\\\",\\\"PANDORA\\\":\\\"1629.2949450001102772\\\",\\\"THETA\\\":\\\"1.2461766000000000\\\",\\\"XCN\\\":\\\"0.0012699647000000\\\",\\\"NEXG\\\":\\\"0.0039180400000000\\\",\\\"MELOS\\\":\\\"0.0021244372500000\\\",\\\"XCV\\\":\\\"0.0013253370000000\\\",\\\"ORN\\\":\\\"0.8797599000000000\\\",\\\"WLKN\\\":\\\"0.0010624685000000\\\",\\\"AAVE\\\":\\\"154.2708259999996162\\\",\\\"MNT\\\":\\\"0.6168914000000000\\\",\\\"BONK\\\":\\\"0.0000227296295000\\\",\\\"PERP\\\":\\\"0.6037979500000000\\\",\\\"XDC\\\":\\\"0.0276361750000000\\\",\\\"MNW\\\":\\\"0.3681158500000000\\\",\\\"XDB\\\":\\\"0.0002578710000000\\\",\\\"BOND\\\":\\\"1.5662165000000000\\\",\\\"SUIA\\\":\\\"0.0809595000000000\\\",\\\"MOG\\\":\\\"0.0000019330330000\\\",\\\"SUTER\\\":\\\"0.0001840079500000\\\",\\\"TIME\\\":\\\"16.2648634999999969\\\",\\\"RACA\\\":\\\"0.0001949025000000\\\",\\\"BICO\\\":\\\"0.2021988500000000\\\",\\\"MON\\\":\\\"0.1066466500000000\\\",\\\"SWEAT\\\":\\\"0.0063718125000000\\\",\\\"MOXIE\\\":\\\"0.0022088950000000\\\",\\\"BABYBNB\\\":\\\"0.0289755050000000\\\",\\\"IGU\\\":\\\"0.0050674650000000\\\",\\\"HMSTR\\\":\\\"0.0037990995000000\\\",\\\"XEC\\\":\\\"0.0000354722550000\\\",\\\"MONI\\\":\\\"0.0058470750000000\\\",\\\"XR\\\":\\\"0.2374812000000000\\\",\\\"PEOPLE\\\":\\\"0.0796601500000000\\\",\\\"PUMLX\\\":\\\"0.0054572700000000\\\",\\\"ZIL\\\":\\\"0.0145927000000000\\\",\\\"WLDDOWN\\\":\\\"0.2089954500000000\\\",\\\"VAI\\\":\\\"0.0799999800000000\\\",\\\"XEN\\\":\\\"0.0000000839580000\\\",\\\"MPC\\\":\\\"0.1001499000000000\\\",\\\"XEM\\\":\\\"0.0176951480000000\\\",\\\"JASMY3S\\\":\\\"0.0019670160000000\\\",\\\"OTK\\\":\\\"0.0290464695000000\\\",\\\"TRAC\\\":\\\"0.4521738000000000\\\",\\\"DFYN\\\":\\\"0.0070664650000000\\\",\\\"BIDP\\\":\\\"0.0001939030000000\\\",\\\"JASMY3L\\\":\\\"0.0001653772700000\\\",\\\"INJDOWN\\\":\\\"0.0000194902500000\\\",\\\"KLV\\\":\\\"0.0019310340000000\\\",\\\"WAXL\\\":\\\"0.7858069000000000\\\",\\\"TRBDOWN\\\":\\\"0.0023138425000000\\\",\\\"BCH3L\\\":\\\"4.6390663064999996\\\",\\\"GMT3S\\\":\\\"0.0000457771000000\\\",\\\"KMD\\\":\\\"0.2493752500000000\\\",\\\"BCH3S\\\":\\\"0.9634180500000000\\\",\\\"ECOX\\\":\\\"0.0987506000000000\\\",\\\"AAVE3S\\\":\\\"0.0560719500000000\\\",\\\"GMT3L\\\":\\\"0.0053983694650000\\\",\\\"EPIK\\\":\\\"0.0045857060000000\\\",\\\"SUIP\\\":\\\"0.1067565950000000\\\",\\\"AAVE3L\\\":\\\"0.3638687346200000\\\",\\\"ZK\\\":\\\"0.1262368500000000\\\",\\\"ZKF\\\":\\\"0.0008595700000000\\\",\\\"OMNIA\\\":\\\"0.7624186000000000\\\",\\\"ZKJ\\\":\\\"1.1124435000000000\\\",\\\"ZKL\\\":\\\"0.1255372000000000\\\",\\\"GAFI\\\":\\\"3.0634675000000001\\\",\\\"CARV\\\":\\\"0.8703646000000000\\\",\\\"KNC\\\":\\\"0.4433782000000000\\\",\\\"CATS\\\":\\\"0.0000599700000000\\\",\\\"PROM\\\":\\\"5.2833570000000006\\\",\\\"ALEPH\\\":\\\"0.1756121500000000\\\",\\\"PONKE\\\":\\\"0.3958020000000000\\\",\\\"OVR\\\":\\\"0.1553223000000000\\\",\\\"CATI\\\":\\\"0.4105146400000000\\\",\\\"ORDER\\\":\\\"0.1183008200000000\\\",\\\"GFT\\\":\\\"0.0166616650000000\\\",\\\"BIFI\\\":\\\"0.0020489750000000\\\",\\\"GGC\\\":\\\"6.9965029985000000\\\",\\\"GGG\\\":\\\"0.0403798000000000\\\",\\\"DAPPX\\\":\\\"0.0043788095000000\\\",\\\"SUKU\\\":\\\"0.0618790450000000\\\",\\\"ULTI\\\":\\\"0.0168015950000000\\\",\\\"CREDI\\\":\\\"0.0192903500000000\\\",\\\"ERTHA\\\":\\\"0.0010014990000000\\\",\\\"FURY\\\":\\\"0.1405297000000000\\\",\\\"KARRAT\\\":\\\"0.5577210000000000\\\",\\\"MOBILE\\\":\\\"0.0009005495000000\\\",\\\"SIDUS\\\":\\\"0.0037671155000000\\\",\\\"NAVI\\\":\\\"0.1254672350000000\\\",\\\"TAO\\\":\\\"583.4081500000051807\\\",\\\"USDJ\\\":\\\"1.1386304000000001\\\",\\\"MTL\\\":\\\"0.9563216000000000\\\",\\\"VET\\\":\\\"0.0225387250000000\\\",\\\"FITFI\\\":\\\"0.0036421780000000\\\",\\\"USDT\\\":\\\"0.9995000000000000\\\",\\\"OXT\\\":\\\"0.0695652000000000\\\",\\\"CANDY\\\":\\\"0.0005597200000000\\\",\\\"USDP\\\":\\\"0.9932031500000000\\\",\\\"MTS\\\":\\\"0.0027516235000000\\\",\\\"TADA\\\":\\\"0.0283858000000000\\\",\\\"MTV\\\":\\\"0.0006559718500000\\\",\\\"NAVX\\\":\\\"0.1342228550000000\\\",\\\"ILV\\\":\\\"35.6771524999999671\\\",\\\"VINU\\\":\\\"0.0000000109045450\\\",\\\"GHX\\\":\\\"0.0903548000000000\\\",\\\"EDU\\\":\\\"0.5167415000000000\\\",\\\"HYVE\\\":\\\"0.0137331300000000\\\",\\\"BTC3L\\\":\\\"0.0058620675000000\\\",\\\"ANYONE\\\":\\\"0.9015490000000000\\\",\\\"BEAT\\\":\\\"0.0012593700000000\\\",\\\"KING\\\":\\\"0.0004821588000000\\\",\\\"CREAM\\\":\\\"15.6541689999999973\\\",\\\"CAS\\\":\\\"0.0038590695000000\\\",\\\"IMX\\\":\\\"1.4944524000000000\\\",\\\"CAT\\\":\\\"0.0000256981445000\\\",\\\"BTC3S\\\":\\\"0.0014142925000000\\\",\\\"USDE\\\":\\\"0.9985005000000000\\\",\\\"USDD\\\":\\\"1.0000997000000000\\\",\\\"CWAR\\\":\\\"0.0037981000000000\\\",\\\"USDC\\\":\\\"0.9997998500000000\\\",\\\"KRL\\\":\\\"0.3543127550000000\\\",\\\"INJ\\\":\\\"21.7691100000000194\\\",\\\"GAME\\\":\\\"0.0139630150000000\\\",\\\"TRIBL\\\":\\\"1.0994500000000000\\\",\\\"XLM\\\":\\\"0.0948525500000000\\\",\\\"TRBUP\\\":\\\"0.0012293850000000\\\",\\\"VRADOWN\\\":\\\"0.0013433280000000\\\",\\\"SUPER\\\":\\\"1.2853570000000000\\\",\\\"EIGEN\\\":\\\"3.1536223999999999\\\",\\\"IOI\\\":\\\"0.0146926500000000\\\",\\\"KSM\\\":\\\"17.5212350000000129\\\",\\\"CCD\\\":\\\"0.0034832575000000\\\",\\\"EGO\\\":\\\"0.0093553200000000\\\",\\\"EGP\\\":\\\"2.7946019999999998\\\",\\\"MXC\\\":\\\"0.0066866550000000\\\",\\\"TEL\\\":\\\"0.0014432780000000\\\",\\\"MOVR\\\":\\\"9.1340307000000027\\\",\\\"XMR\\\":\\\"155.5421899999990755\\\",\\\"MXM\\\":\\\"0.0092853550000000\\\",\\\"OORT\\\":\\\"0.1099949750000000\\\",\\\"GLM\\\":\\\"0.3231383500000000\\\",\\\"RAY\\\":\\\"2.0228880499999998\\\",\\\"XTAG\\\":\\\"0.0218190850000000\\\",\\\"GLQ\\\":\\\"0.0854572500000000\\\",\\\"CWEB\\\":\\\"0.0038480750000000\\\",\\\"REVU\\\":\\\"0.0105047450000000\\\",\\\"REVV\\\":\\\"0.0039760110000000\\\",\\\"ZRO\\\":\\\"3.7952014499999994\\\",\\\"XNL\\\":\\\"0.0093853050000000\\\",\\\"XNO\\\":\\\"0.8496749500000000\\\",\\\"SAROS\\\":\\\"0.0019290350000000\\\",\\\"KACE\\\":\\\"2.1165411999999998\\\",\\\"ZRX\\\":\\\"0.3186406000000000\\\",\\\"WLTH\\\":\\\"0.0374312750000000\\\",\\\"ATOM3L\\\":\\\"0.0321719060000000\\\",\\\"GMM\\\":\\\"0.0001497251000000\\\",\\\"BEER\\\":\\\"0.0000138670630000\\\",\\\"GMT\\\":\\\"0.1275362000000000\\\",\\\"HEART\\\":\\\"0.0159920000000000\\\",\\\"GMX\\\":\\\"22.7186349999999882\\\",\\\"ABBC\\\":\\\"0.0061769100000000\\\",\\\"OMNI\\\":\\\"8.9235359999999970\\\",\\\"ATOM3S\\\":\\\"0.0007945225400000\\\",\\\"IRL\\\":\\\"0.0099650150000000\\\",\\\"CFG\\\":\\\"0.3248375000000000\\\",\\\"WSDM\\\":\\\"0.0139830050000000\\\",\\\"GNS\\\":\\\"1.8390800000000001\\\",\\\"VANRY\\\":\\\"0.0809295150000000\\\",\\\"CFX\\\":\\\"0.1595202000000000\\\",\\\"GRAIL\\\":\\\"817.1212349999937891\\\",\\\"BEFI\\\":\\\"0.0175712100000000\\\",\\\"VELO\\\":\\\"0.0132043945000000\\\",\\\"XPR\\\":\\\"0.0008077959000000\\\",\\\"DOVI\\\":\\\"0.0584707500000000\\\",\\\"ACE\\\":\\\"0.0021349320000000\\\",\\\"ACH\\\":\\\"0.0190534685000000\\\",\\\"ISP\\\":\\\"0.0012161916000000\\\",\\\"XCAD\\\":\\\"0.2834582000000000\\\",\\\"MINA\\\":\\\"0.5630183500000000\\\",\\\"TIA\\\":\\\"5.9318325999999999\\\",\\\"DRIFT\\\":\\\"0.4350823500000000\\\",\\\"ACQ\\\":\\\"0.0056981495000000\\\",\\\"ACS\\\":\\\"0.0014917537500000\\\",\\\"MIND\\\":\\\"0.0018920535000000\\\",\\\"STORE\\\":\\\"0.0062358805000000\\\",\\\"REN\\\":\\\"0.0351224300000000\\\",\\\"ELA\\\":\\\"1.7282354500000000\\\",\\\"DREAMS\\\":\\\"0.0002498750000000\\\",\\\"ADA\\\":\\\"0.3463267500000000\\\",\\\"ELF\\\":\\\"0.3777110500000000\\\",\\\"REQ\\\":\\\"0.0959919800000000\\\",\\\"STORJ\\\":\\\"0.5662167500000000\\\",\\\"LADYS\\\":\\\"0.0000000837581000\\\",\\\"PAXG\\\":\\\"2697.9303600003123340\\\",\\\"REZ\\\":\\\"0.0409795000000000\\\",\\\"XRD\\\":\\\"0.0157821050000000\\\",\\\"CHO\\\":\\\"0.0205097400000000\\\",\\\"CHR\\\":\\\"0.1769115000000000\\\",\\\"ADS\\\":\\\"0.1889055000000000\\\",\\\"CHZ\\\":\\\"0.0738030800000000\\\",\\\"ADX\\\":\\\"0.1575212000000000\\\",\\\"XRP\\\":\\\"0.5525036100000000\\\",\\\"JASMY\\\":\\\"0.0188615645000000\\\",\\\"KAGI\\\":\\\"0.1834582250000000\\\",\\\"FIDA\\\":\\\"0.2282858000000000\\\",\\\"PBR\\\":\\\"0.0291953950000000\\\",\\\"AEG\\\":\\\"0.0093453250000000\\\",\\\"H2O\\\":\\\"0.1610194500000000\\\",\\\"CHMB\\\":\\\"0.0001715641750000\\\",\\\"SAND3L\\\":\\\"0.0015447972150000\\\",\\\"PBX\\\":\\\"0.0006879558500000\\\",\\\"SOLVE\\\":\\\"0.0084557700000000\\\",\\\"DECHAT\\\":\\\"0.1512243500000000\\\",\\\"GARI\\\":\\\"0.0076861550000000\\\",\\\"SHIB2L\\\":\\\"1.1996998499999999\\\",\\\"SHIB2S\\\":\\\"0.0240879500000000\\\",\\\"ENA\\\":\\\"0.3942028000000000\\\",\\\"VEMP\\\":\\\"0.0029335325000000\\\",\\\"ENJ\\\":\\\"0.1467266000000000\\\",\\\"AFG\\\":\\\"0.0072163900000000\\\",\\\"RATS\\\":\\\"0.0001211593900000\\\",\\\"GRT\\\":\\\"0.1646076550000000\\\",\\\"FORWARD\\\":\\\"0.0012873560000000\\\",\\\"TFUEL\\\":\\\"0.0598800450000000\\\",\\\"ENS\\\":\\\"17.0634640000000052\\\",\\\"KASDOWN\\\":\\\"0.0258770550000000\\\",\\\"XTM\\\":\\\"0.0251074400000000\\\",\\\"DEGEN\\\":\\\"0.0084857550000000\\\",\\\"TLM\\\":\\\"0.0100449750000000\\\",\\\"DYDXDOWN\\\":\\\"0.1042598440000000\\\",\\\"CKB\\\":\\\"0.0146026950000000\\\",\\\"LUNC\\\":\\\"0.0000889255150000\\\",\\\"AURORA\\\":\\\"0.1204397500000000\\\",\\\"LUNA\\\":\\\"0.3624187000000000\\\",\\\"XTZ\\\":\\\"0.6776610000000000\\\",\\\"ELON\\\":\\\"0.0000001410294500\\\",\\\"DMTR\\\":\\\"0.0891554000000000\\\",\\\"EOS\\\":\\\"0.4759619000000000\\\",\\\"GST\\\":\\\"0.0118940500000000\\\",\\\"FORT\\\":\\\"0.1155422000000000\\\",\\\"FLAME\\\":\\\"0.0247076400000000\\\",\\\"PATEX\\\":\\\"0.9605195000000000\\\",\\\"DEEP\\\":\\\"0.0328885475000000\\\",\\\"ID3L\\\":\\\"0.0016201895000000\\\",\\\"GTC\\\":\\\"0.6625685500000000\\\",\\\"ID3S\\\":\\\"0.0071674145000000\\\",\\\"RIO\\\":\\\"0.7616190000000000\\\",\\\"CLH\\\":\\\"0.0008555720000000\\\",\\\"BURGER\\\":\\\"0.4016990500000000\\\",\\\"VRA\\\":\\\"0.0029765110000000\\\",\\\"SUNDOG\\\":\\\"0.2173912500000000\\\",\\\"GTT\\\":\\\"0.0002038980000000\\\",\\\"INJUP\\\":\\\"0.2327835500000000\\\",\\\"CPOOL\\\":\\\"0.1557720750000000\\\",\\\"EPX\\\":\\\"0.0000740629500000\\\",\\\"CLV\\\":\\\"0.0329835000000000\\\",\\\"FEAR\\\":\\\"0.0560519600000000\\\",\\\"MEME\\\":\\\"0.0124847545000000\\\",\\\"ROOBEE\\\":\\\"0.0004520738500000\\\",\\\"DEFI\\\":\\\"0.0192903500000000\\\",\\\"TOKEN\\\":\\\"0.0477361200000000\\\",\\\"GRAPE\\\":\\\"0.0020599695000000\\\",\\\"KASUP\\\":\\\"0.3996001000000000\\\",\\\"XWG\\\":\\\"0.0003843077500000\\\",\\\"SKEY\\\":\\\"0.0621289200000000\\\",\\\"SFUND\\\":\\\"1.3243375000000000\\\",\\\"EQX\\\":\\\"0.0032823580000000\\\",\\\"ORDIUP\\\":\\\"0.0548315705000000\\\",\\\"TON\\\":\\\"5.1857058499999995\\\",\\\"DEGO\\\":\\\"2.2667660500000001\\\",\\\"IZI\\\":\\\"0.0088455750000000\\\",\\\"ERG\\\":\\\"0.6605695500000000\\\",\\\"ERN\\\":\\\"1.9255367500000001\\\",\\\"VENOM\\\":\\\"0.0817591000000000\\\",\\\"VOXEL\\\":\\\"0.1497251000000000\\\",\\\"RLC\\\":\\\"1.4649671500000000\\\",\\\"PHA\\\":\\\"0.1093453000000000\\\",\\\"DYDXUP\\\":\\\"0.0112573685000000\\\",\\\"APE3S\\\":\\\"0.0008475760000000\\\",\\\"ORBS\\\":\\\"0.0288955450000000\\\",\\\"OPDOWN\\\":\\\"0.6758619000000000\\\",\\\"ESE\\\":\\\"0.0139130400000000\\\",\\\"APE3L\\\":\\\"0.1339330000000000\\\",\\\"HMND\\\":\\\"0.0982208650000000\\\",\\\"COQ\\\":\\\"0.0000014432780000\\\",\\\"AURY\\\":\\\"0.3340329000000000\\\",\\\"CULT\\\":\\\"0.0000028025980000\\\",\\\"AKT\\\":\\\"2.4642672500000001\\\",\\\"GLMR\\\":\\\"0.1606196500000000\\\",\\\"XYM\\\":\\\"0.0142528700000000\\\",\\\"ORAI\\\":\\\"6.1769100000000012\\\",\\\"XYO\\\":\\\"0.0058680645000000\\\",\\\"ETC\\\":\\\"18.8458723500000169\\\",\\\"LAI\\\":\\\"0.0142828550000000\\\",\\\"PIP\\\":\\\"0.0178310800000000\\\",\\\"ETH\\\":\\\"2607.6655149998362673\\\",\\\"NEO\\\":\\\"10.3575186499999991\\\",\\\"RMV\\\":\\\"0.0081659150000000\\\",\\\"KLAY\\\":\\\"0.1251374000000000\\\",\\\"PIT\\\":\\\"0.0000000003268365\\\",\\\"TARA\\\":\\\"0.0043978000000000\\\",\\\"KALT\\\":\\\"0.1128735350000000\\\",\\\"PIX\\\":\\\"0.0001023687900000\\\",\\\"ETN\\\":\\\"0.0021579205000000\\\",\\\"CSIX\\\":\\\"0.0141729100000000\\\",\\\"TRADE\\\":\\\"0.4708644500000000\\\",\\\"MAVIA\\\":\\\"1.3592200500000001\\\",\\\"HIGH\\\":\\\"1.3043474999999999\\\",\\\"TRB\\\":\\\"62.5387150000000006\\\",\\\"ORDI\\\":\\\"35.7421200000000126\\\",\\\"TRVL\\\":\\\"0.0373643085000000\\\",\\\"AMB\\\":\\\"0.0059670150000000\\\",\\\"TRU\\\":\\\"0.0762018800000000\\\",\\\"LOGX\\\":\\\"0.0271963950000000\\\",\\\"FINC\\\":\\\"0.0362018900000000\\\",\\\"INFRA\\\":\\\"0.1978010500000000\\\",\\\"NATIX\\\":\\\"0.0008729633000000\\\",\\\"NFP\\\":\\\"0.2152923000000000\\\",\\\"TRY\\\":\\\"0.0292166033323590\\\",\\\"TRX\\\":\\\"0.1597201000000000\\\",\\\"LBP\\\":\\\"0.0001243378000000\\\",\\\"LBR\\\":\\\"0.0595702000000000\\\",\\\"EUL\\\":\\\"2.9735125000000000\\\",\\\"NFT\\\":\\\"0.0000004077960000\\\",\\\"SEIUP\\\":\\\"0.0478110825000000\\\",\\\"PUFFER\\\":\\\"0.3676161000000000\\\",\\\"EUR\\\":\\\"1.0811249323958897\\\",\\\"ORCA\\\":\\\"2.0664662499999999\\\",\\\"NEAR3L\\\":\\\"0.0117010765350000\\\",\\\"AMP\\\":\\\"0.0038330825000000\\\",\\\"XDEFI\\\":\\\"0.0472563600000000\\\",\\\"HIFI\\\":\\\"0.4947525000000000\\\",\\\"TRUF\\\":\\\"0.0459570100000000\\\",\\\"AITECH\\\":\\\"0.1045477000000000\\\",\\\"AMU\\\":\\\"0.0043978000000000\\\",\\\"USTC\\\":\\\"0.0214692600000000\\\",\\\"KNGL\\\":\\\"0.0499750000000000\\\",\\\"FOXY\\\":\\\"0.0102686631000000\\\",\\\"NGC\\\":\\\"0.0147935995000000\\\",\\\"TENET\\\":\\\"0.0043278350000000\\\",\\\"NEAR3S\\\":\\\"0.0072553705000000\\\",\\\"MAHA\\\":\\\"1.1904045000000000\\\",\\\"NGL\\\":\\\"0.0701748950000000\\\",\\\"TST\\\":\\\"0.0080359800000000\\\",\\\"HIPPO\\\":\\\"0.0104447750000000\\\",\\\"AXS3S\\\":\\\"0.0308705570000000\\\",\\\"CRO\\\":\\\"0.0781409100000000\\\",\\\"ZPAY\\\":\\\"0.0050574700000000\\\",\\\"MNDE\\\":\\\"0.1026786350000000\\\",\\\"CRV\\\":\\\"0.2534732000000000\\\",\\\"SWASH\\\":\\\"0.0056271850000000\\\",\\\"AXS3L\\\":\\\"0.0106388779000000\\\",\\\"VERSE\\\":\\\"0.0001803098000000\\\",\\\"RPK\\\":\\\"0.0049975000000000\\\",\\\"RPL\\\":\\\"10.9745099999999958\\\",\\\"AZERO\\\":\\\"0.3789104500000000\\\",\\\"SOUL\\\":\\\"0.0534332700000000\\\",\\\"VXV\\\":\\\"0.2619689500000000\\\",\\\"LDO\\\":\\\"1.0885554500000000\\\",\\\"MAGIC\\\":\\\"0.3390304000000000\\\",\\\"ALICE\\\":\\\"1.0324835000000000\\\",\\\"SEAM\\\":\\\"1.1933030499999999\\\",\\\"PLU\\\":\\\"1.9300345000000001\\\",\\\"AOG\\\":\\\"0.0031224380000000\\\",\\\"SMOLE\\\":\\\"0.0000387806000000\\\",\\\"EWT\\\":\\\"1.1094450000000000\\\",\\\"TSUGT\\\":\\\"0.0029185400000000\\\",\\\"PMG\\\":\\\"0.0800599500000000\\\",\\\"OPAI\\\":\\\"0.0006826585000000\\\",\\\"LOCUS\\\":\\\"0.0216591650000000\\\",\\\"CTA\\\":\\\"0.0825087250000000\\\",\\\"NIM\\\":\\\"0.0013673160000000\\\",\\\"CTC\\\":\\\"0.4033982000000000\\\",\\\"APE\\\":\\\"0.7035480500000000\\\",\\\"MERL\\\":\\\"0.2720639000000000\\\",\\\"JAM\\\":\\\"0.0004770613500000\\\",\\\"CTI\\\":\\\"0.0130314810000000\\\",\\\"APP\\\":\\\"0.0021989000000000\\\",\\\"APT\\\":\\\"9.9947001500000000\\\",\\\"WLDUP\\\":\\\"0.0093043455000000\\\",\\\"ZEND\\\":\\\"0.1280759300000000\\\",\\\"FIRE\\\":\\\"0.9113441000000000\\\",\\\"DENT\\\":\\\"0.0008630682500000\\\",\\\"PYTH\\\":\\\"0.3390603850000000\\\",\\\"LFT\\\":\\\"0.0155322300000000\\\",\\\"DPET\\\":\\\"0.0319040400000000\\\",\\\"ORDIDOWN\\\":\\\"0.3788105000000000\\\",\\\"KPOL\\\":\\\"0.0029175405000000\\\",\\\"ETHUP\\\":\\\"8.4971493000000032\\\",\\\"BAND\\\":\\\"1.0939527500000001\\\",\\\"POL\\\":\\\"0.3656171000000000\\\",\\\"ASTR\\\":\\\"0.0582608550000000\\\",\\\"NKN\\\":\\\"0.0691654000000000\\\",\\\"RSR\\\":\\\"0.0068055955000000\\\",\\\"DVPN\\\":\\\"0.0005979009000000\\\",\\\"TWT\\\":\\\"1.1119437500000000\\\",\\\"ARB\\\":\\\"0.5510243500000000\\\",\\\"CVC\\\":\\\"0.1409801746501747\\\",\\\"ARC\\\":\\\"0.0300849500000000\\\",\\\"XETA\\\":\\\"0.0022888550000000\\\",\\\"MTRG\\\":\\\"0.4007995000000000\\\",\\\"LOKA\\\":\\\"0.1867066000000000\\\",\\\"LPOOL\\\":\\\"0.0660069800000000\\\",\\\"TURBOS\\\":\\\"0.0034812585000000\\\",\\\"CVX\\\":\\\"1.7816087499999999\\\",\\\"ARX\\\":\\\"0.0007556220000000\\\",\\\"MPLX\\\":\\\"0.4355221300000000\\\",\\\"SUSHI\\\":\\\"0.7011492500000000\\\",\\\"NLK\\\":\\\"0.0114442750000000\\\",\\\"PEPE2\\\":\\\"0.0000000313843000\\\",\\\"WBTC\\\":\\\"66881.4425499645548419\\\",\\\"SUI3L\\\":\\\"0.0211204345000000\\\",\\\"CWS\\\":\\\"0.1927036000000000\\\",\\\"SUI3S\\\":\\\"0.0000579110300000\\\",\\\"INSP\\\":\\\"0.0264167850000000\\\",\\\"MANA\\\":\\\"0.2945026750000000\\\",\\\"VRTX\\\":\\\"0.0641679000000000\\\",\\\"CSPR\\\":\\\"0.0116441750000000\\\",\\\"ATA\\\":\\\"0.0785007300000000\\\",\\\"OPEN\\\":\\\"0.0080049955000000\\\",\\\"HAI\\\":\\\"0.0448275750000000\\\",\\\"NMR\\\":\\\"14.7436245000000072\\\",\\\"ATH\\\":\\\"0.0540929400000000\\\",\\\"LIT\\\":\\\"0.6282857000000000\\\",\\\"TLOS\\\":\\\"0.3263467450000000\\\",\\\"TNSR\\\":\\\"0.3662168000000000\\\",\\\"CXT\\\":\\\"0.0871364100000000\\\",\\\"POLYX\\\":\\\"0.2346826000000000\\\",\\\"ZERO\\\":\\\"0.0002507745500000\\\",\\\"ROUTE\\\":\\\"0.0610694500000000\\\",\\\"LOOM\\\":\\\"0.0580009850000000\\\",\\\"PRE\\\":\\\"0.0078680640000000\\\",\\\"VRAUP\\\":\\\"0.0134652640000000\\\",\\\"HBB\\\":\\\"0.0714742450000000\\\",\\\"RVN\\\":\\\"0.0165017450000000\\\",\\\"PRQ\\\":\\\"0.0715741950000000\\\",\\\"ONDO\\\":\\\"0.7134930750000000\\\",\\\"PEPEDOWN\\\":\\\"0.0000155022450000\\\",\\\"WOOP\\\":\\\"0.0020179905000000\\\",\\\"LUNCUP\\\":\\\"0.0168355780000000\\\",\\\"KAVA\\\":\\\"0.3522238000000000\\\",\\\"LKI\\\":\\\"0.0104187880000000\\\",\\\"AVA\\\":\\\"0.4857570000000000\\\",\\\"NOM\\\":\\\"0.0233883000000000\\\",\\\"MAPO\\\":\\\"0.0089015470000000\\\",\\\"PEPEUP\\\":\\\"0.0114252845000000\\\",\\\"STRAX\\\":\\\"0.0487156300000000\\\",\\\"NOT\\\":\\\"0.0078670645000000\\\",\\\"ZERC\\\":\\\"0.1108245600000000\\\",\\\"BCUT\\\":\\\"0.0255672100000000\\\",\\\"MASA\\\":\\\"0.0691354150000000\\\",\\\"WAN\\\":\\\"0.1785077544737212\\\",\\\"WAT\\\":\\\"0.0003273762300000\\\",\\\"WAX\\\":\\\"0.0327636100000000\\\",\\\"MASK\\\":\\\"2.2259864500000002\\\",\\\"EOS3L\\\":\\\"0.0002122138400000\\\",\\\"IDEA\\\":\\\"0.0005887055000000\\\",\\\"EOS3S\\\":\\\"0.0034472755000000\\\",\\\"YFI\\\":\\\"4919.4290549999908843\\\",\\\"MOODENG\\\":\\\"0.0774612500000000\\\",\\\"XCUR\\\":\\\"0.0048845565000000\\\",\\\"HYDRA\\\":\\\"0.2225886500000000\\\",\\\"POPCAT\\\":\\\"1.3382305500000000\\\",\\\"LQTY\\\":\\\"0.7848074000000000\\\",\\\"PIXEL\\\":\\\"0.1406596350000000\\\",\\\"LMR\\\":\\\"0.0145437245000000\\\",\\\"ZETA\\\":\\\"0.5997999500000000\\\",\\\"YGG\\\":\\\"0.4717640000000000\\\",\\\"AXS\\\":\\\"4.6006985000000006\\\",\\\"BCHSV\\\":\\\"49.8250749999999370\\\",\\\"NRN\\\":\\\"0.0395802000000000\\\",\\\"FTON\\\":\\\"0.0091954000000000\\\",\\\"COMP\\\":\\\"43.6581599999999881\\\",\\\"XPRT\\\":\\\"0.1819090000000000\\\",\\\"HFT\\\":\\\"0.1443278000000000\\\",\\\"UXLINK\\\":\\\"0.5085456000000000\\\",\\\"STAMP\\\":\\\"0.0335032400000000\\\",\\\"RUNE\\\":\\\"4.9233370999999996\\\",\\\"ZEUS\\\":\\\"0.2587705500000000\\\",\\\"LTC3L\\\":\\\"1.8294848000000001\\\",\\\"DAPP\\\":\\\"0.1763118000000000\\\",\\\"FORTH\\\":\\\"2.9508238500000004\\\",\\\"ALPINE\\\":\\\"1.5322335000000000\\\",\\\"SENSO\\\":\\\"0.0328835500000000\\\",\\\"LTC3S\\\":\\\"0.0006986505000000\\\",\\\"DEXE\\\":\\\"8.3795081500000028\\\",\\\"GOAL\\\":\\\"0.0175912000000000\\\",\\\"AVAX\\\":\\\"27.5602130000000058\\\",\\\"LISTA\\\":\\\"0.3782108000000000\\\",\\\"AMPL\\\":\\\"1.3743124999999999\\\",\\\"WORK\\\":\\\"0.1384307500000000\\\",\\\"BRWL\\\":\\\"0.0017391300000000\\\",\\\"BANANA\\\":\\\"57.1314200000001362\\\",\\\"PUSH\\\":\\\"0.0750624500000000\\\",\\\"WEN\\\":\\\"0.0001015492000000\\\",\\\"NEIRO\\\":\\\"0.0879560000000000\\\",\\\"BTCUP\\\":\\\"34.7711057499999789\\\",\\\"SOL3S\\\":\\\"0.0007816090000000\\\",\\\"BRAWL\\\":\\\"0.0004776610500000\\\",\\\"LAY3R\\\":\\\"0.2161918500000000\\\",\\\"LPT\\\":\\\"11.9304317999999945\\\",\\\"GODS\\\":\\\"0.1807096000000000\\\",\\\"SAND3S\\\":\\\"4.6152911999999992\\\",\\\"RDNT\\\":\\\"0.0640679500000000\\\",\\\"SOL3L\\\":\\\"1.8351913752850000\\\",\\\"NIBI\\\":\\\"0.0653772950000000\\\",\\\"NUM\\\":\\\"0.0436181800000000\\\",\\\"PYR\\\":\\\"2.5590198499999997\\\",\\\"DAG\\\":\\\"0.0226176855000000\\\",\\\"DAI\\\":\\\"0.9989006596042375\\\",\\\"HIP\\\":\\\"0.0034982500000000\\\",\\\"DAO\\\":\\\"0.2848575000000000\\\",\\\"AVAIL\\\":\\\"0.1300929210000000\\\",\\\"DAR\\\":\\\"0.1512243500000000\\\",\\\"FET\\\":\\\"1.3760116500000000\\\",\\\"FCON\\\":\\\"0.0001197600900000\\\",\\\"XAVA\\\":\\\"0.3789104500000000\\\",\\\"LRC\\\":\\\"0.1208395500000000\\\",\\\"UNI3S\\\":\\\"0.0000653573050000\\\",\\\"PZP\\\":\\\"0.0599600050000000\\\",\\\"POKT\\\":\\\"0.0424787500000000\\\",\\\"DASH\\\":\\\"23.6881500000000109\\\",\\\"BAKEDOWN\\\":\\\"0.0003324636850000\\\",\\\"POLC\\\":\\\"0.0061389290000000\\\",\\\"DBR\\\":\\\"0.0377671070000000\\\",\\\"CIRUS\\\":\\\"0.0055772100000000\\\",\\\"UNI3L\\\":\\\"0.0993921490650000\\\",\\\"NWC\\\":\\\"0.0681659000000000\\\",\\\"POLK\\\":\\\"0.0142628650000000\\\",\\\"LSD\\\":\\\"0.9420287500000000\\\",\\\"MARS4\\\":\\\"0.0005878059500000\\\",\\\"LSK\\\":\\\"0.8080957500000000\\\",\\\"BLOCK\\\":\\\"0.0261869000000000\\\",\\\"ANALOS\\\":\\\"0.0000446776500000\\\",\\\"SAFE\\\":\\\"0.8779608000000000\\\",\\\"DCK\\\":\\\"0.0234082900000000\\\",\\\"LSS\\\":\\\"0.0562718500000000\\\",\\\"DCR\\\":\\\"12.4337799999999929\\\",\\\"LIKE\\\":\\\"0.0559720000000000\\\",\\\"DATA\\\":\\\"0.0361819000000000\\\",\\\"WIF\\\":\\\"2.5696145499999999\\\",\\\"BLOK\\\":\\\"0.0006546725000000\\\",\\\"LTC\\\":\\\"71.6261690000000611\\\",\\\"METIS\\\":\\\"42.0289750000000612\\\",\\\"WIN\\\":\\\"0.0000868365600000\\\",\\\"HLG\\\":\\\"0.0018790600000000\\\",\\\"LTO\\\":\\\"0.1166116650000000\\\",\\\"DYDX\\\":\\\"0.9341327000000000\\\",\\\"ARB3S\\\":\\\"0.0509025360000000\\\",\\\"MUBI\\\":\\\"0.0303848000000000\\\",\\\"ARB3L\\\":\\\"0.0025917035000000\\\",\\\"RBTC1\\\":\\\"0.0000039480250000\\\",\\\"POND\\\":\\\"0.0118640650000000\\\",\\\"LINA\\\":\\\"0.0037771105000000\\\",\\\"MYRIA\\\":\\\"0.0025337325000000\\\",\\\"LINK\\\":\\\"11.0244849999999944\\\",\\\"QTUM\\\":\\\"2.4262016723130069\\\",\\\"TUNE\\\":\\\"0.0148025950000000\\\",\\\"UFO\\\":\\\"0.0000006479758500\\\",\\\"CYBER\\\":\\\"2.8755615000000001\\\",\\\"WILD\\\":\\\"0.2433782500000000\\\",\\\"POLS\\\":\\\"0.2809594500000000\\\",\\\"NYM\\\":\\\"0.0719640000000000\\\",\\\"FIL\\\":\\\"3.6786597500000005\\\",\\\"BAL\\\":\\\"2.0099945000000000\\\",\\\"SCA\\\":\\\"0.3999999000000000\\\",\\\"STND\\\":\\\"0.0133123405000000\\\",\\\"WMTX\\\":\\\"0.2138930000000000\\\",\\\"SCLP\\\":\\\"0.1545227000000000\\\",\\\"MANEKI\\\":\\\"0.0073963000000000\\\",\\\"BAT\\\":\\\"0.1721139000000000\\\",\\\"AKRO\\\":\\\"0.0042302838000000\\\",\\\"FTM3L\\\":\\\"8.2574692000000024\\\",\\\"BAX\\\":\\\"0.0000709645000000\\\",\\\"FTM3S\\\":\\\"0.0000255072400000\\\",\\\"COTI\\\":\\\"0.0951524000000000\\\"}}", "x-request-example": "{\\\"base\\\": \\\"USD\\\", \\\"currencies\\\": \\\"example_string_default_value\\\"}", "operationId": "014" } }, "/api/v1/market/stats": { "get": { "summary": "Get 24hr Stats", "deprecated": false, "description": "Request via this endpoint to get the statistics of the specified ticker in the last 24 hours.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "time": { "type": "integer", "description": "timestamp", "format": "int64" }, "symbol": { "type": "string", "description": "Symbol" }, "buy": { "type": "string", "description": "Best bid price\n" }, "sell": { "type": "string", "description": "Best ask price" }, "changeRate": { "type": "string", "description": "24h change rate" }, "changePrice": { "type": "string", "description": "24h change price" }, "high": { "type": "string", "description": "Highest price in 24h" }, "low": { "type": "string", "description": "Lowest price in 24h" }, "vol": { "type": "string", "description": "24h volume, executed based on base currency" }, "volValue": { "type": "string", "description": "24h traded amount" }, "last": { "type": "string", "description": "Last traded price" }, "averagePrice": { "type": "string", "description": "Average trading price in the last 24 hours" }, "takerFeeRate": { "type": "string", "description": "Basic Taker Fee" }, "makerFeeRate": { "type": "string", "description": "Basic Maker Fee" }, "takerCoefficient": { "type": "string", "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" }, "makerCoefficient": { "type": "string", "description": "The maker 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" } }, "required": [ "time", "symbol", "buy", "sell", "changeRate", "changePrice", "high", "low", "vol", "volValue", "last", "averagePrice", "takerFeeRate", "makerFeeRate", "takerCoefficient", "makerCoefficient" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470161", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "get24hrStats", "x-sdk-method-description": "Request via this endpoint to get the statistics of the specified ticker in the last 24 hours.", "x-api-rate-limit-weight": 15, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"time\\\":1729175612158,\\\"symbol\\\":\\\"BTC-USDT\\\",\\\"buy\\\":\\\"66982.4\\\",\\\"sell\\\":\\\"66982.5\\\",\\\"changeRate\\\":\\\"-0.0114\\\",\\\"changePrice\\\":\\\"-778.1\\\",\\\"high\\\":\\\"68107.7\\\",\\\"low\\\":\\\"66683.3\\\",\\\"vol\\\":\\\"1738.02898182\\\",\\\"volValue\\\":\\\"117321982.415978333\\\",\\\"last\\\":\\\"66981.5\\\",\\\"averagePrice\\\":\\\"67281.21437289\\\",\\\"takerFeeRate\\\":\\\"0.001\\\",\\\"makerFeeRate\\\":\\\"0.001\\\",\\\"takerCoefficient\\\":\\\"1\\\",\\\"makerCoefficient\\\":\\\"1\\\"}}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "015" } }, "/api/v1/markets": { "get": { "summary": "Get Market List", "deprecated": false, "description": "Request via this endpoint the transaction currency for the entire trading market.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "string" } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470166", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getMarketList", "x-sdk-method-description": "Request via this endpoint the transaction currency for the entire trading market.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":[\\\"USDS\\\",\\\"TON\\\",\\\"AI\\\",\\\"DePIN\\\",\\\"PoW\\\",\\\"BRC-20\\\",\\\"ETF\\\",\\\"KCS\\\",\\\"Meme\\\",\\\"Solana\\\",\\\"FIAT\\\",\\\"VR&AR\\\",\\\"DeFi\\\",\\\"Polkadot\\\",\\\"BTC\\\",\\\"ALTS\\\",\\\"Layer 1\\\"]}", "operationId": "016" } }, "/api/v1/my-ip": { "get": { "summary": "Get Client IP Address", "deprecated": false, "description": "Get the server time.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "string" } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3471123", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getClientIPAddress", "x-sdk-method-description": "Get the server time.", "x-api-rate-limit-weight": 0, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":\\\"20.***.***.128\\\"}", "operationId": "017" } }, "/api/v1/timestamp": { "get": { "summary": "Get Server Time", "deprecated": false, "description": "Get the server time.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "integer", "format": "int64", "description": "ServerTime (milliseconds)" } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470156", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getServerTime", "x-sdk-method-description": "Get the server time.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":1729100692873}", "operationId": "018" } }, "/api/v1/status": { "get": { "summary": "Get Service Status", "deprecated": false, "description": "Get the service status.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "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", "enum": [ "open", "close", "cancelonly" ], "x-api-enum": [ { "value": "open", "name": "OPEN", "description": "normal transaction" }, { "value": "close", "name": "CLOSE", "description": "Stop Trading/Maintenance" }, { "value": "cancelonly", "name": "CANCELONLY", "description": "can only cancel the order but not place order" } ] }, "msg": { "type": "string", "description": "Remark for operation" } }, "required": [ "status", "msg" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470158", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getServiceStatus", "x-sdk-method-description": "Get the service status.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"status\\\":\\\"open\\\",\\\"msg\\\":\\\"\\\"}}", "operationId": "019" } }, "/api/v1/hf/orders": { "post": { "summary": "Add Order", "deprecated": false, "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.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "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" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470188", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "addOrder", "x-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.", "x-api-rate-limit-weight": 1, "requestBody": { "content": { "application/json": { "schema": { "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.", "example": [ "5c52e11203aa677f33e493fb" ] }, "side": { "type": "string", "description": "specify if the order is to 'buy' or 'sell'", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ], "example": [ "buy" ] }, "symbol": { "type": "string", "description": "symbol", "example": [ "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" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ], "example": [ "limit" ] }, "remark": { "type": "string", "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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\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 < Gateway received the message time, this order will fail.", "format": "int64", "example": [ 10, 20, 30 ] }, "clientTimestamp": { "type": "integer", "description": "Equal to KC-API-TIMESTAMP, Need to be defined if allowMaxTimeWindow is specified.", "format": "int64", "example": [ 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\": \"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" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"orderId\\\":\\\"670fd33bf9406e0007ab3945\\\",\\\"clientOid\\\":\\\"5c52e11203aa677f33e493fb\\\"}}", "x-request-example": "{\\\"type\\\": \\\"limit\\\", \\\"symbol\\\": \\\"BTC-USDT\\\", \\\"side\\\": \\\"buy\\\", \\\"price\\\": \\\"50000\\\", \\\"size\\\": \\\"0.00001\\\", \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\", \\\"remark\\\": \\\"order remarks\\\"}", "operationId": "020" }, "delete": { "summary": "Cancel All Orders By Symbol", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "string" } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470175", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelAllOrdersBySymbol", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":\\\"success\\\"}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "030" } }, "/api/v1/hf/orders/sync": { "post": { "summary": "Add Order Sync", "deprecated": false, "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.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "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." }, "orderTime": { "type": "integer", "format": "int64" }, "originSize": { "type": "string", "description": "Original order size" }, "dealSize": { "type": "string", "description": "Deal size" }, "remainSize": { "type": "string", "description": "Remain size" }, "canceledSize": { "type": "string", "description": "Cumulative canceled size" }, "status": { "type": "string", "description": "Order Status. open: order is active; done: order has been completed", "enum": [ "open", "done" ], "x-api-enum": [ { "value": "open", "name": "", "description": "" }, { "value": "done", "name": "", "description": "" } ] }, "matchTime": { "type": "integer", "format": "int64" } }, "required": [ "orderId", "clientOid", "orderTime", "originSize", "dealSize", "remainSize", "canceledSize", "status", "matchTime" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470170", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "addOrderSync", "x-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.", "x-api-rate-limit-weight": 1, "requestBody": { "content": { "application/json": { "schema": { "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.", "example": [ "5c52e11203aa677f33e493fb" ] }, "side": { "type": "string", "description": "Specify if the order is to 'buy' or 'sell'.", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ], "example": [ "buy" ] }, "symbol": { "type": "string", "description": "symbol", "example": [ "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" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ], "example": [ "limit" ] }, "remark": { "type": "string", "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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 < Gateway received the message time, this order will fail.", "format": "int64", "example": [ 10, 20, 30 ] }, "clientTimestamp": { "type": "integer", "description": "Equal to KC-API-TIMESTAMP. Needs to be defined if allowMaxTimeWindow is specified.", "format": "int64", "example": [ 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" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"orderId\\\":\\\"67111a7cb7cbdf000703e1f6\\\",\\\"clientOid\\\":\\\"5c52e11203aa677f33e493f\\\",\\\"orderTime\\\":1729174140586,\\\"originSize\\\":\\\"0.00001\\\",\\\"dealSize\\\":\\\"0\\\",\\\"remainSize\\\":\\\"0.00001\\\",\\\"canceledSize\\\":\\\"0\\\",\\\"status\\\":\\\"open\\\",\\\"matchTime\\\":1729174140588}}", "x-request-example": "{\\\"type\\\": \\\"limit\\\", \\\"symbol\\\": \\\"BTC-USDT\\\", \\\"side\\\": \\\"buy\\\", \\\"price\\\": \\\"50000\\\", \\\"size\\\": \\\"0.00001\\\", \\\"clientOid\\\": \\\"5c52e11203aa677f33e493f\\\", \\\"remark\\\": \\\"order remarks\\\"}", "operationId": "021" } }, "/api/v1/hf/orders/test": { "post": { "summary": "Add Order Test", "deprecated": false, "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.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "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" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470187", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "addOrderTest", "x-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.", "x-api-rate-limit-weight": 1, "requestBody": { "content": { "application/json": { "schema": { "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.", "example": [ "5c52e11203aa677f33e493fb" ] }, "side": { "type": "string", "description": "specify if the order is to 'buy' or 'sell'", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ], "example": [ "buy" ] }, "symbol": { "type": "string", "description": "symbol", "example": [ "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" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ], "example": [ "limit" ] }, "remark": { "type": "string", "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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 < Gateway received the message time, this order will fail.", "format": "int64", "example": [ 10, 20, 30 ] }, "clientTimestamp": { "type": "integer", "description": "Equal to KC-API-TIMESTAMP, Need to be defined if allowMaxTimeWindow is specified.", "format": "int64", "example": [ 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" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"orderId\\\":\\\"670fd33bf9406e0007ab3945\\\",\\\"clientOid\\\":\\\"5c52e11203aa677f33e493fb\\\"}}", "x-request-example": "{\\\"type\\\": \\\"limit\\\", \\\"symbol\\\": \\\"BTC-USDT\\\", \\\"side\\\": \\\"buy\\\", \\\"price\\\": \\\"50000\\\", \\\"size\\\": \\\"0.00001\\\", \\\"clientOid\\\": \\\"5c52e11203aa677f33e493f\\\", \\\"remark\\\": \\\"order remarks\\\"}", "operationId": "022" } }, "/api/v1/hf/orders/multi": { "post": { "summary": "Batch Add Orders", "deprecated": false, "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", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "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." }, "success": { "type": "boolean", "description": "Add order success/failure" }, "failMsg": { "type": "string", "description": "Error message" } }, "required": [ "success" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470168", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "batchAddOrders", "x-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", "x-api-rate-limit-weight": 1, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "orderList": { "type": "array", "items": { "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" }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "type": { "type": "string", "description": "Specify if the order is a 'limit' order or 'market' order. ", "enum": [ "limit" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" } ] }, "timeInForce": { "type": "string", "description": "[Time in force](https://www.kucoin.com/docs-new/doc-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": "" } ] }, "side": { "type": "string", "description": "Specify if the order is to 'buy' or 'sell'.", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ] }, "price": { "type": "string", "description": "Specify price for order" }, "size": { "type": "string", "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", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-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": "" } ] }, "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 }, "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](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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)" }, "remark": { "type": "string", "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" }, "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. Needs to be defined if allowMaxTimeWindow is specified.", "format": "int64", "example": [ 1740711735178 ] }, "allowMaxTimeWindow": { "type": "integer", "description": "Order failed after timeout of specified milliseconds, If clientTimestamp + allowMaxTimeWindow < Gateway received the message time, this order will fail.", "format": "int64", "example": [ 10, 20, 30 ] } }, "required": [ "type", "symbol", "side", "price" ] }, "description": "Order List" } }, "required": [ "orderList" ] }, "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}" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"orderId\\\": \\\"6710d8336afcdb0007319c27\\\",\\n \\\"clientOid\\\": \\\"client order id 12\\\",\\n \\\"success\\\": true\\n },\\n {\\n \\\"success\\\": false,\\n \\\"failMsg\\\": \\\"The order funds should more then 0.1 USDT.\\\"\\n }\\n ]\\n}", "x-request-example": "{\\\"orderList\\\": [{\\\"clientOid\\\": \\\"client order id 12\\\", \\\"symbol\\\": \\\"BTC-USDT\\\", \\\"type\\\": \\\"limit\\\", \\\"side\\\": \\\"buy\\\", \\\"price\\\": \\\"30000\\\", \\\"size\\\": \\\"0.00001\\\"}, {\\\"clientOid\\\": \\\"client order id 13\\\", \\\"symbol\\\": \\\"ETH-USDT\\\", \\\"type\\\": \\\"limit\\\", \\\"side\\\": \\\"sell\\\", \\\"price\\\": \\\"2000\\\", \\\"size\\\": \\\"0.00001\\\"}]}", "operationId": "023" } }, "/api/v1/hf/orders/multi/sync": { "post": { "summary": "Batch Add Orders Sync", "deprecated": false, "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", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "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." }, "orderTime": { "type": "integer", "format": "int64" }, "originSize": { "type": "string", "description": "Original order size" }, "dealSize": { "type": "string", "description": "Deal size" }, "remainSize": { "type": "string", "description": "Remain size" }, "canceledSize": { "type": "string", "description": "Cumulative canceled size" }, "status": { "type": "string", "description": "Order Status. open: order is active; done: order has been completed", "enum": [ "open", "done" ], "x-api-enum": [ { "value": "open", "name": "", "description": "" }, { "value": "done", "name": "", "description": "" } ] }, "matchTime": { "type": "integer", "format": "int64" }, "success": { "type": "boolean", "description": "Add order success/failure" }, "failMsg": { "type": "string", "description": "Error message" } }, "required": [ "success" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470169", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "batchAddOrdersSync", "x-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", "x-api-rate-limit-weight": 1, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "orderList": { "type": "array", "items": { "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" }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "type": { "type": "string", "description": "Specify if the order is a 'limit' order or 'market' order. ", "enum": [ "limit" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" } ] }, "timeInForce": { "type": "string", "description": "[Time in force](https://www.kucoin.com/docs-new/doc-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": "" } ] }, "side": { "type": "string", "description": "Specify if the order is to 'buy' or 'sell'.", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ] }, "price": { "type": "string", "description": "Specify price for order" }, "size": { "type": "string", "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", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-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": "" } ] }, "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 }, "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](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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)" }, "remark": { "type": "string", "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" }, "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 < Gateway received the message time, this order will fail.", "format": "int64", "example": [ 10, 20, 30 ] }, "clientTimestamp": { "type": "integer", "description": "Equal to KC-API-TIMESTAMP. Needs to be defined if allowMaxTimeWindow is specified.", "format": "int64", "example": [ 1740711735178 ] } }, "required": [ "type", "symbol", "side", "price" ] }, "description": "Order List" } }, "required": [ "orderList" ] }, "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}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":[{\\\"orderId\\\":\\\"6711195e5584bc0007bd5aef\\\",\\\"clientOid\\\":\\\"client order id 13\\\",\\\"orderTime\\\":1729173854299,\\\"originSize\\\":\\\"0.00001\\\",\\\"dealSize\\\":\\\"0\\\",\\\"remainSize\\\":\\\"0.00001\\\",\\\"canceledSize\\\":\\\"0\\\",\\\"status\\\":\\\"open\\\",\\\"matchTime\\\":1729173854326,\\\"success\\\":true},{\\\"success\\\":false,\\\"failMsg\\\":\\\"The order funds should more then 0.1 USDT.\\\"}]}", "x-request-example": "{\\\"orderList\\\": [{\\\"clientOid\\\": \\\"client order id 13\\\", \\\"symbol\\\": \\\"BTC-USDT\\\", \\\"type\\\": \\\"limit\\\", \\\"side\\\": \\\"buy\\\", \\\"price\\\": \\\"30000\\\", \\\"size\\\": \\\"0.00001\\\"}, {\\\"clientOid\\\": \\\"client order id 14\\\", \\\"symbol\\\": \\\"ETH-USDT\\\", \\\"type\\\": \\\"limit\\\", \\\"side\\\": \\\"sell\\\", \\\"price\\\": \\\"2000\\\", \\\"size\\\": \\\"0.00001\\\"}]}", "operationId": "024" } }, "/api/v1/hf/orders/{orderId}": { "delete": { "summary": "Cancel Order By OrderId", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "orderId", "in": "path", "description": "The unique order id generated by the trading system", "required": true, "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Order id" } }, "required": [ "orderId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470174", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelOrderByOrderId", "x-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.", "x-api-rate-limit-weight": 1, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"orderId\\\": \\\"671124f9365ccb00073debd4\\\"\\n }\\n}", "x-request-example": "{\\\"orderId\\\": \\\"671124f9365ccb00073debd4\\\", \\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "025" }, "get": { "summary": "Get Order By OrderId", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "orderId", "in": "path", "description": "The unique order id generated by the trading system", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique order id generated by the trading system" }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "opType": { "type": "string" }, "type": { "type": "string", "description": "Specify if the order is an 'limit' order or 'market' order. ", "enum": [ "limit", "market" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ] }, "side": { "type": "string", "description": "Buy or sell", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ] }, "price": { "type": "string", "description": "Order price" }, "size": { "type": "string", "description": "Order size" }, "funds": { "type": "string", "description": "Order Funds" }, "dealSize": { "type": "string", "description": "Number of filled transactions" }, "dealFunds": { "type": "string", "description": "Funds of filled transactions" }, "fee": { "type": "string", "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", "description": "currency used to calculate trading fee" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", "CN", "CB" ], "x-api-enum": [ { "value": "DC", "name": "", "description": "" }, { "value": "CO", "name": "", "description": "" }, { "value": "CN", "name": "", "description": "" }, { "value": "CB", "name": "", "description": "" } ] }, "timeInForce": { "type": "string", "description": "Time in force", "enum": [ "GTC", "GTT", "IOC", "FOK" ], "x-api-enum": [ { "value": "GTC", "name": "", "description": "" }, { "value": "GTT", "name": "", "description": "" }, { "value": "IOC", "name": "", "description": "" }, { "value": "FOK", "name": "", "description": "" } ] }, "postOnly": { "type": "boolean", "description": "Whether its a postOnly order." }, "hidden": { "type": "boolean", "description": "Whether its a hidden order." }, "iceberg": { "type": "boolean", "description": "Whether its a iceberg order." }, "visibleSize": { "type": "string", "description": "Visible size of iceberg order in order book." }, "cancelAfter": { "type": "integer", "description": "A GTT timeInForce that expires in n seconds", "format": "int64" }, "channel": { "type": "string" }, "clientOid": { "type": "string", "description": "Client Order Id,unique identifier created by the user" }, "remark": { "type": "string", "description": "Order placement remarks" }, "tags": { "type": "string", "description": "Order tag" }, "cancelExist": { "type": "boolean", "description": "Whether there is a cancellation record for the order." }, "createdAt": { "type": "integer", "format": "int64" }, "lastUpdatedAt": { "type": "integer", "format": "int64" }, "tradeType": { "type": "string", "description": "Trade type, redundancy param" }, "inOrderBook": { "type": "boolean", "description": "Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook" }, "cancelledSize": { "type": "string", "description": "Number of canceled transactions" }, "cancelledFunds": { "type": "string", "description": "Funds of canceled transactions" }, "remainSize": { "type": "string", "description": "Number of remain transactions" }, "remainFunds": { "type": "string", "description": "Funds of remain transactions" }, "tax": { "type": "string", "description": "Users in some regions need query this field" }, "active": { "type": "boolean", "description": "Order status: true-The status of the order isactive; false-The status of the order is done" } }, "required": [ "id", "symbol", "opType", "type", "side", "price", "size", "funds", "dealSize", "dealFunds", "fee", "feeCurrency", "timeInForce", "postOnly", "hidden", "iceberg", "visibleSize", "cancelAfter", "channel", "clientOid", "cancelExist", "tradeType", "inOrderBook", "cancelledSize", "cancelledFunds", "remainSize", "remainFunds", "active", "createdAt", "lastUpdatedAt", "tax" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470181", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOrderByOrderId", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"id\\\": \\\"6717422bd51c29000775ea03\\\",\\n \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"opType\\\": \\\"DEAL\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"70000\\\",\\n \\\"size\\\": \\\"0.00001\\\",\\n \\\"funds\\\": \\\"0.7\\\",\\n \\\"dealSize\\\": \\\"0.00001\\\",\\n \\\"dealFunds\\\": \\\"0.677176\\\",\\n \\\"remainSize\\\": \\\"0\\\",\\n \\\"remainFunds\\\": \\\"0.022824\\\",\\n \\\"cancelledSize\\\": \\\"0\\\",\\n \\\"cancelledFunds\\\": \\\"0\\\",\\n \\\"fee\\\": \\\"0.000677176\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stp\\\": null,\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": \\\"0\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"remark\\\": \\\"order remarks\\\",\\n \\\"tags\\\": null,\\n \\\"cancelExist\\\": false,\\n \\\"tradeType\\\": \\\"TRADE\\\",\\n \\\"inOrderBook\\\": false,\\n \\\"active\\\": false,\\n \\\"tax\\\": \\\"0\\\",\\n \\\"createdAt\\\": 1729577515444,\\n \\\"lastUpdatedAt\\\": 1729577515481\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"orderId\\\": \\\"6717422bd51c29000775ea03\\\"}", "operationId": "033" } }, "/api/v1/hf/orders/sync/{orderId}": { "delete": { "summary": "Cancel Order By OrderId Sync", "deprecated": false, "description": "This endpoint can be used to cancel a spot order by orderId.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "orderId", "in": "path", "description": "The unique order id generated by the trading system", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "orderId": { "type": "string", "description": "order id" }, "originSize": { "type": "string", "description": "original order size" }, "dealSize": { "type": "string", "description": "deal size" }, "remainSize": { "type": "string", "description": "remain size" }, "canceledSize": { "type": "string", "description": "Cumulative canceled size" }, "status": { "type": "string", "description": "Order Status. open:order is active; done:order has been completed", "enum": [ "open", "done" ], "x-api-enum": [ { "value": "open", "name": "open", "description": "order is active" }, { "value": "done", "name": "done", "description": "order has been completed" } ] } }, "required": [ "orderId", "dealSize", "remainSize", "canceledSize", "status", "originSize" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470185", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelOrderByOrderIdSync", "x-sdk-method-description": "This endpoint can be used to cancel a spot order by orderId.", "x-api-rate-limit-weight": 1, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"orderId\\\": \\\"671128ee365ccb0007534d45\\\",\\n \\\"originSize\\\": \\\"0.00001\\\",\\n \\\"dealSize\\\": \\\"0\\\",\\n \\\"remainSize\\\": \\\"0\\\",\\n \\\"canceledSize\\\": \\\"0.00001\\\",\\n \\\"status\\\": \\\"done\\\"\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"orderId\\\": \\\"671128ee365ccb0007534d45\\\"}", "operationId": "026" } }, "/api/v1/hf/orders/client-order/{clientOid}": { "delete": { "summary": "Cancel Order By ClientOid", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "clientOid", "in": "path", "description": "Client Order Id,unique identifier created by the user", "required": true, "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "clientOid": { "type": "string", "description": "Client Order Id,unique identifier created by the user" } }, "required": [ "clientOid" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470184", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelOrderByClientOid", "x-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.", "x-api-rate-limit-weight": 1, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"clientOid\\\":\\\"5c52e11203aa677f33e493fb\\\"}}", "x-request-example": "{\\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\", \\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "027" }, "get": { "summary": "Get Order By ClientOid", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "clientOid", "in": "path", "description": "Client Order Id,unique identifier created by the user", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique order id generated by the trading system" }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "opType": { "type": "string" }, "type": { "type": "string", "description": "Specify if the order is an 'limit' order or 'market' order. ", "enum": [ "limit", "market" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ] }, "side": { "type": "string", "description": "Buy or sell", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ] }, "price": { "type": "string", "description": "Order price" }, "size": { "type": "string", "description": "Order size" }, "funds": { "type": "string", "description": "Order Funds" }, "dealSize": { "type": "string", "description": "Number of filled transactions" }, "dealFunds": { "type": "string", "description": "Funds of filled transactions" }, "fee": { "type": "string", "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", "description": "currency used to calculate trading fee" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", "CN", "CB" ], "x-api-enum": [ { "value": "DC", "name": "", "description": "" }, { "value": "CO", "name": "", "description": "" }, { "value": "CN", "name": "", "description": "" }, { "value": "CB", "name": "", "description": "" } ] }, "timeInForce": { "type": "string", "description": "Time in force", "enum": [ "GTC", "GTT", "IOC", "FOK" ], "x-api-enum": [ { "value": "GTC", "name": "", "description": "" }, { "value": "GTT", "name": "", "description": "" }, { "value": "IOC", "name": "", "description": "" }, { "value": "FOK", "name": "", "description": "" } ] }, "postOnly": { "type": "boolean", "description": "Whether its a postOnly order." }, "hidden": { "type": "boolean", "description": "Whether its a hidden order." }, "iceberg": { "type": "boolean", "description": "Whether its a iceberg order." }, "visibleSize": { "type": "string", "description": "Visible size of iceberg order in order book." }, "cancelAfter": { "type": "integer", "description": "A GTT timeInForce that expires in n seconds", "format": "int64" }, "channel": { "type": "string" }, "clientOid": { "type": "string", "description": "Client Order Id,unique identifier created by the user" }, "remark": { "type": "string", "description": "Order placement remarks" }, "tags": { "type": "string", "description": "Order tag" }, "cancelExist": { "type": "boolean", "description": "Whether there is a cancellation record for the order." }, "createdAt": { "type": "integer", "format": "int64" }, "lastUpdatedAt": { "type": "integer", "format": "int64" }, "tradeType": { "type": "string", "description": "Trade type, redundancy param" }, "inOrderBook": { "type": "boolean", "description": "Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook" }, "cancelledSize": { "type": "string", "description": "Number of canceled transactions" }, "cancelledFunds": { "type": "string", "description": "Funds of canceled transactions" }, "remainSize": { "type": "string", "description": "Number of remain transactions" }, "remainFunds": { "type": "string", "description": "Funds of remain transactions" }, "tax": { "type": "string", "description": "Users in some regions need query this field" }, "active": { "type": "boolean", "description": "Order status: true-The status of the order isactive; false-The status of the order is done" } }, "required": [ "id", "symbol", "opType", "type", "side", "price", "size", "funds", "dealSize", "dealFunds", "fee", "feeCurrency", "timeInForce", "postOnly", "hidden", "iceberg", "visibleSize", "cancelAfter", "channel", "clientOid", "cancelExist", "tradeType", "inOrderBook", "cancelledSize", "cancelledFunds", "remainSize", "remainFunds", "active", "createdAt", "lastUpdatedAt", "tax" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470182", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOrderByClientOid", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"id\\\": \\\"6717422bd51c29000775ea03\\\",\\n \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"opType\\\": \\\"DEAL\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"70000\\\",\\n \\\"size\\\": \\\"0.00001\\\",\\n \\\"funds\\\": \\\"0.7\\\",\\n \\\"dealSize\\\": \\\"0.00001\\\",\\n \\\"dealFunds\\\": \\\"0.677176\\\",\\n \\\"remainSize\\\": \\\"0\\\",\\n \\\"remainFunds\\\": \\\"0.022824\\\",\\n \\\"cancelledSize\\\": \\\"0\\\",\\n \\\"cancelledFunds\\\": \\\"0\\\",\\n \\\"fee\\\": \\\"0.000677176\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stp\\\": null,\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": \\\"0\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"remark\\\": \\\"order remarks\\\",\\n \\\"tags\\\": null,\\n \\\"cancelExist\\\": false,\\n \\\"tradeType\\\": \\\"TRADE\\\",\\n \\\"inOrderBook\\\": false,\\n \\\"active\\\": false,\\n \\\"tax\\\": \\\"0\\\",\\n \\\"createdAt\\\": 1729577515444,\\n \\\"lastUpdatedAt\\\": 1729577515481\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\"}", "operationId": "034" } }, "/api/v1/hf/orders/sync/client-order/{clientOid}": { "delete": { "summary": "Cancel Order By ClientOid Sync", "deprecated": false, "description": "This endpoint can be used to cancel a spot order by orderId.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "clientOid", "in": "path", "description": "Client Order Id,unique identifier created by the user", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "clientOid": { "type": "string", "description": "Client Order Id,unique identifier created by the user" }, "originSize": { "type": "string", "description": "original order size" }, "dealSize": { "type": "string", "description": "deal size" }, "remainSize": { "type": "string", "description": "remain size" }, "canceledSize": { "type": "string", "description": "Cumulative canceled size" }, "status": { "type": "string", "description": "Order Status. open:order is active; done:order has been completed", "enum": [ "open", "done" ], "x-api-enum": [ { "value": "open", "name": "open", "description": "order is active" }, { "value": "done", "name": "done", "description": "order has been completed" } ] } }, "required": [ "clientOid", "originSize", "dealSize", "remainSize", "canceledSize", "status" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470186", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelOrderByClientOidSync", "x-sdk-method-description": "This endpoint can be used to cancel a spot order by orderId.", "x-api-rate-limit-weight": 1, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\",\\n \\\"originSize\\\": \\\"0.00001\\\",\\n \\\"dealSize\\\": \\\"0\\\",\\n \\\"remainSize\\\": \\\"0\\\",\\n \\\"canceledSize\\\": \\\"0.00001\\\",\\n \\\"status\\\": \\\"done\\\"\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\"}", "operationId": "028" } }, "/api/v1/hf/orders/cancel/{orderId}": { "delete": { "summary": "Cancel Partial Order", "deprecated": false, "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", "tags": [], "parameters": [ { "name": "orderId", "in": "path", "description": "The unique order id generated by the trading system", "required": true, "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "cancelSize", "in": "query", "description": "The size you want cancel", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "orderId": { "type": "string", "description": "order id" }, "cancelSize": { "type": "string", "description": "The size you canceled" } }, "required": [ "orderId", "cancelSize" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470183", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelPartialOrder", "x-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", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"orderId\\\": \\\"6711f73c1ef16c000717bb31\\\",\\n \\\"cancelSize\\\": \\\"0.00001\\\"\\n }\\n}", "x-request-example": "{\\\"orderId\\\": \\\"6711f73c1ef16c000717bb31\\\", \\\"symbol\\\": \\\"BTC-USDT\\\", \\\"cancelSize\\\": \\\"0.00001\\\"}", "operationId": "029" } }, "/api/v1/hf/orders/cancelAll": { "delete": { "summary": "Cancel All Orders", "deprecated": false, "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.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "succeedSymbols": { "type": "array", "items": { "type": "string" }, "description": "The Symbols Successfully cancelled" }, "failedSymbols": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "error": { "type": "string", "description": "error message" } } }, "description": "The Symbols Failed to cancel" } }, "required": [ "succeedSymbols", "failedSymbols" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470176", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelAllOrders", "x-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.", "x-api-rate-limit-weight": 30, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"succeedSymbols\\\": [\\n \\\"ETH-USDT\\\",\\n \\\"BTC-USDT\\\"\\n ],\\n \\\"failedSymbols\\\": []\\n }\\n}", "operationId": "031" } }, "/api/v1/hf/orders/alter": { "post": { "summary": "Modify Order", "deprecated": false, "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.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "newOrderId": { "type": "string", "description": "The new order ID" }, "clientOid": { "type": "string", "description": "The original client order ID" } }, "required": [ "newOrderId", "clientOid" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470171", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "modifyOrder", "x-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.", "x-api-rate-limit-weight": 1, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "clientOid": { "type": "string", "description": "One must be chose out of the old client order ID, orderId and clientOid", "example": [ "5c52e11203aa677f33e493fb" ] }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "orderId": { "type": "string", "description": "One must be chosen out of the old order id, orderId and clientOid" }, "newPrice": { "type": "string", "description": "One must be chosen out of the modified price of the new order, newPrice and newSize" }, "newSize": { "type": "string", "description": "One must be chosen out of the modified size of the new order, newPrice and newSize" } }, "required": [ "symbol" ] }, "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"newOrderId\\\":\\\"67112258f9406e0007408827\\\",\\\"clientOid\\\":\\\"client order id 12\\\"}}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"orderId\\\": \\\"670fd33bf9406e0007ab3945\\\", \\\"newPrice\\\": \\\"30000\\\", \\\"newSize\\\": \\\"0.0001\\\"}", "operationId": "032" } }, "/api/v1/hf/orders/active/symbols": { "get": { "summary": "Get Symbols With Open Order", "deprecated": false, "description": "This interface can query all spot symbol that has active orders", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "symbols": { "type": "array", "items": { "type": "string" }, "description": "The symbol that has active orders" } }, "required": [ "symbols" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470177", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getSymbolsWithOpenOrder", "x-sdk-method-description": "This interface can query all spot symbol that has active orders", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"symbols\\\": [\\n \\\"ETH-USDT\\\",\\n \\\"BTC-USDT\\\"\\n ]\\n }\\n}", "operationId": "035" } }, "/api/v1/hf/orders/active": { "get": { "summary": "Get Open Orders", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique order id generated by the trading system" }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "opType": { "type": "string" }, "type": { "type": "string", "description": "Specify if the order is an 'limit' order or 'market' order. ", "enum": [ "limit", "market" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ] }, "side": { "type": "string", "description": "Buy or sell", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ] }, "price": { "type": "string", "description": "Order price" }, "size": { "type": "string", "description": "Order size" }, "funds": { "type": "string", "description": "Order Funds" }, "dealSize": { "type": "string", "description": "Number of filled transactions" }, "dealFunds": { "type": "string", "description": "Funds of filled transactions" }, "fee": { "type": "string", "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", "description": "currency used to calculate trading fee" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", "CN", "CB" ], "x-api-enum": [ { "value": "DC", "name": "", "description": "" }, { "value": "CO", "name": "", "description": "" }, { "value": "CN", "name": "", "description": "" }, { "value": "CB", "name": "", "description": "" } ] }, "timeInForce": { "type": "string", "description": "Time in force", "enum": [ "GTC", "GTT", "IOC", "FOK" ], "x-api-enum": [ { "value": "GTC", "name": "", "description": "" }, { "value": "GTT", "name": "", "description": "" }, { "value": "IOC", "name": "", "description": "" }, { "value": "FOK", "name": "", "description": "" } ] }, "postOnly": { "type": "boolean", "description": "Whether its a postOnly order." }, "hidden": { "type": "boolean", "description": "Whether its a hidden order." }, "iceberg": { "type": "boolean", "description": "Whether its a iceberg order." }, "visibleSize": { "type": "string", "description": "Visible size of iceberg order in order book." }, "cancelAfter": { "type": "integer", "description": "A GTT timeInForce that expires in n seconds", "format": "int64" }, "channel": { "type": "string" }, "clientOid": { "type": "string", "description": "Client Order Id,unique identifier created by the user" }, "remark": { "type": "string", "description": "Order placement remarks" }, "tags": { "type": "string", "description": "Order tag" }, "cancelExist": { "type": "boolean", "description": "Whether there is a cancellation record for the order." }, "createdAt": { "type": "integer", "format": "int64" }, "lastUpdatedAt": { "type": "integer", "format": "int64" }, "tradeType": { "type": "string", "description": "Trade type, redundancy param" }, "inOrderBook": { "type": "boolean", "description": "Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook" }, "cancelledSize": { "type": "string", "description": "Number of canceled transactions" }, "cancelledFunds": { "type": "string", "description": "Funds of canceled transactions" }, "remainSize": { "type": "string", "description": "Number of remain transactions" }, "remainFunds": { "type": "string", "description": "Funds of remain transactions" }, "tax": { "type": "string", "description": "Users in some regions need query this field" }, "active": { "type": "boolean", "description": "Order status: true-The status of the order isactive; false-The status of the order is done" } }, "required": [ "id", "symbol", "opType", "type", "side", "price", "size", "funds", "dealSize", "dealFunds", "fee", "feeCurrency", "timeInForce", "postOnly", "hidden", "iceberg", "visibleSize", "cancelAfter", "channel", "clientOid", "cancelExist", "tradeType", "inOrderBook", "cancelledSize", "cancelledFunds", "remainSize", "remainFunds", "active", "createdAt", "lastUpdatedAt", "tax" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470178", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOpenOrders", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"id\\\": \\\"67120bbef094e200070976f6\\\",\\n \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"opType\\\": \\\"DEAL\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"50000\\\",\\n \\\"size\\\": \\\"0.00001\\\",\\n \\\"funds\\\": \\\"0.5\\\",\\n \\\"dealSize\\\": \\\"0\\\",\\n \\\"dealFunds\\\": \\\"0\\\",\\n \\\"fee\\\": \\\"0\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stp\\\": null,\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": \\\"0\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"remark\\\": \\\"order remarks\\\",\\n \\\"tags\\\": \\\"order tags\\\",\\n \\\"cancelExist\\\": false,\\n \\\"tradeType\\\": \\\"TRADE\\\",\\n \\\"inOrderBook\\\": true,\\n \\\"cancelledSize\\\": \\\"0\\\",\\n \\\"cancelledFunds\\\": \\\"0\\\",\\n \\\"remainSize\\\": \\\"0.00001\\\",\\n \\\"remainFunds\\\": \\\"0.5\\\",\\n \\\"tax\\\": \\\"0\\\",\\n \\\"active\\\": true,\\n \\\"createdAt\\\": 1729235902748,\\n \\\"lastUpdatedAt\\\": 1729235909862\\n }\\n ]\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "036" } }, "/api/v1/hf/orders/active/page": { "get": { "summary": "Get Open Orders By Page", "deprecated": false, "description": "This interface is to obtain Spot active order (uncompleted order) lists by page. The returned data is sorted in descending order according to the create 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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "Symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "pageNum", "in": "query", "description": "Current page", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Size per page", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 50 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalNum": { "type": "integer" }, "totalPage": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique order id generated by the trading system" }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "opType": { "type": "string" }, "type": { "type": "string", "description": "Specify if the order is an 'limit' order or 'market' order. ", "enum": [ "limit", "market" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ] }, "side": { "type": "string", "description": "Buy or sell", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ] }, "price": { "type": "string", "description": "Order price" }, "size": { "type": "string", "description": "Order size" }, "funds": { "type": "string", "description": "Order Funds" }, "dealSize": { "type": "string", "description": "Number of filled transactions" }, "dealFunds": { "type": "string", "description": "Funds of filled transactions" }, "fee": { "type": "string", "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", "description": "currency used to calculate trading fee" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", "CN", "CB" ], "x-api-enum": [ { "value": "DC", "name": "", "description": "" }, { "value": "CO", "name": "", "description": "" }, { "value": "CN", "name": "", "description": "" }, { "value": "CB", "name": "", "description": "" } ] }, "timeInForce": { "type": "string", "description": "Time in force", "enum": [ "GTC", "GTT", "IOC", "FOK" ], "x-api-enum": [ { "value": "GTC", "name": "", "description": "" }, { "value": "GTT", "name": "", "description": "" }, { "value": "IOC", "name": "", "description": "" }, { "value": "FOK", "name": "", "description": "" } ] }, "postOnly": { "type": "boolean", "description": "Whether its a postOnly order." }, "hidden": { "type": "boolean", "description": "Whether its a hidden order." }, "iceberg": { "type": "boolean", "description": "Whether its a iceberg order." }, "visibleSize": { "type": "string", "description": "Visible size of iceberg order in order book." }, "cancelAfter": { "type": "integer", "description": "A GTT timeInForce that expires in n seconds", "format": "int64" }, "channel": { "type": "string" }, "clientOid": { "type": "string", "description": "Client Order Id,unique identifier created by the user" }, "remark": { "type": "string", "description": "Order placement remarks" }, "tags": { "type": "string", "description": "Order tag" }, "cancelExist": { "type": "boolean", "description": "Whether there is a cancellation record for the order." }, "createdAt": { "type": "integer", "format": "int64" }, "lastUpdatedAt": { "type": "integer", "format": "int64" }, "tradeType": { "type": "string", "description": "Trade type, redundancy param" }, "inOrderBook": { "type": "boolean", "description": "Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook" }, "cancelledSize": { "type": "string", "description": "Number of canceled transactions" }, "cancelledFunds": { "type": "string", "description": "Funds of canceled transactions" }, "remainSize": { "type": "string", "description": "Number of remain transactions" }, "remainFunds": { "type": "string", "description": "Funds of remain transactions" }, "tax": { "type": "string", "description": "Users in some regions need query this field" }, "active": { "type": "boolean", "description": "Order status: true-The status of the order isactive; false-The status of the order is done" } }, "required": [ "id", "symbol", "opType", "type", "side", "price", "size", "funds", "dealSize", "dealFunds", "fee", "feeCurrency", "timeInForce", "postOnly", "hidden", "iceberg", "visibleSize", "cancelAfter", "channel", "clientOid", "cancelExist", "tradeType", "inOrderBook", "cancelledSize", "cancelledFunds", "remainSize", "remainFunds", "active", "createdAt", "lastUpdatedAt", "tax" ] } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3471591", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOpenOrdersByPage", "x-sdk-method-description": "This interface is to obtain Spot active order (uncompleted order) lists by page. The returned data is sorted in descending order according to the create 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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 20,\\n \\\"totalNum\\\": 1,\\n \\\"totalPage\\\": 1,\\n \\\"items\\\": [\\n {\\n \\\"id\\\": \\\"67c1437ea5226600071cc080\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"opType\\\": \\\"DEAL\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"50000\\\",\\n \\\"size\\\": \\\"0.00001\\\",\\n \\\"funds\\\": \\\"0.5\\\",\\n \\\"dealSize\\\": \\\"0\\\",\\n \\\"dealFunds\\\": \\\"0\\\",\\n \\\"fee\\\": \\\"0\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stp\\\": null,\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": \\\"0\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\",\\n \\\"remark\\\": \\\"order remarks\\\",\\n \\\"tags\\\": null,\\n \\\"cancelExist\\\": false,\\n \\\"createdAt\\\": 1740718974367,\\n \\\"lastUpdatedAt\\\": 1741867658590,\\n \\\"tradeType\\\": \\\"TRADE\\\",\\n \\\"inOrderBook\\\": true,\\n \\\"cancelledSize\\\": \\\"0\\\",\\n \\\"cancelledFunds\\\": \\\"0\\\",\\n \\\"remainSize\\\": \\\"0.00001\\\",\\n \\\"remainFunds\\\": \\\"0.5\\\",\\n \\\"tax\\\": \\\"0\\\",\\n \\\"active\\\": true\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"pageNum\\\": 1, \\\"pageSize\\\": 20}", "operationId": "037" } }, "/api/v1/hf/orders/done": { "get": { "summary": "Get Closed Orders", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "side", "in": "query", "description": "specify if the order is to 'buy' or 'sell'", "required": false, "schema": { "type": "string", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ] } }, { "name": "type", "in": "query", "description": "specify if the order is an 'limit' order or 'market' order. ", "required": false, "schema": { "type": "string", "enum": [ "limit", "market" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ] } }, { "name": "lastId", "in": "query", "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.", "required": false, "schema": { "type": "integer", "format": "int64", "minimum": 0, "exclusiveMinimum": 0 } }, { "name": "limit", "in": "query", "description": "Default20,Max100", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, { "name": "startAt", "in": "query", "description": "Start time (milisecond)", "required": false, "schema": { "type": "integer", "format": "int64", "minimum": 1000000000000, "maximum": 9999999999999, "exclusiveMinimum": 1000000000000, "exclusiveMaximum": 9999999999999 } }, { "name": "endAt", "in": "query", "description": "End time (milisecond)", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "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.", "format": "int64", "minimum": 0, "exclusiveMinimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique order id generated by the trading system" }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "opType": { "type": "string" }, "type": { "type": "string", "description": "Specify if the order is an 'limit' order or 'market' order. ", "enum": [ "limit", "market" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ] }, "side": { "type": "string", "description": "Buy or sell", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ] }, "price": { "type": "string", "description": "Order price" }, "size": { "type": "string", "description": "Order size" }, "funds": { "type": "string", "description": "Order Funds" }, "dealSize": { "type": "string", "description": "Number of filled transactions" }, "dealFunds": { "type": "string", "description": "Funds of filled transactions" }, "fee": { "type": "string", "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", "description": "currency used to calculate trading fee" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", "CN", "CB" ], "x-api-enum": [ { "value": "DC", "name": "", "description": "" }, { "value": "CO", "name": "", "description": "" }, { "value": "CN", "name": "", "description": "" }, { "value": "CB", "name": "", "description": "" } ] }, "timeInForce": { "type": "string", "description": "Time in force", "enum": [ "GTC", "GTT", "IOC", "FOK" ], "x-api-enum": [ { "value": "GTC", "name": "", "description": "" }, { "value": "GTT", "name": "", "description": "" }, { "value": "IOC", "name": "", "description": "" }, { "value": "FOK", "name": "", "description": "" } ] }, "postOnly": { "type": "boolean", "description": "Whether its a postOnly order." }, "hidden": { "type": "boolean", "description": "Whether its a hidden order." }, "iceberg": { "type": "boolean", "description": "Whether its a iceberg order." }, "visibleSize": { "type": "string", "description": "Visible size of iceberg order in order book." }, "cancelAfter": { "type": "integer", "description": "A GTT timeInForce that expires in n seconds" }, "channel": { "type": "string" }, "clientOid": { "type": "string", "description": "Client Order Id,unique identifier created by the user" }, "remark": { "type": "string", "description": "Order placement remarks" }, "tags": { "type": "string", "description": "Order tag" }, "cancelExist": { "type": "boolean", "description": "Whether there is a cancellation record for the order." }, "createdAt": { "type": "integer", "format": "int64" }, "lastUpdatedAt": { "type": "integer", "format": "int64" }, "tradeType": { "type": "string", "description": "Trade type, redundancy param" }, "inOrderBook": { "type": "boolean", "description": "Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook" }, "cancelledSize": { "type": "string", "description": "Number of canceled transactions" }, "cancelledFunds": { "type": "string", "description": "Funds of canceled transactions" }, "remainSize": { "type": "string", "description": "Number of remain transactions" }, "remainFunds": { "type": "string", "description": "Funds of remain transactions" }, "tax": { "type": "string", "description": "Users in some regions need query this field" }, "active": { "type": "boolean", "description": "Order status: true-The status of the order isactive; false-The status of the order is done" } }, "required": [ "feeCurrency", "id", "symbol", "opType", "type", "side", "price", "size", "funds", "dealSize", "fee", "timeInForce", "dealFunds", "clientOid", "remainSize", "remainFunds", "cancelledSize", "cancelledFunds", "lastUpdatedAt", "createdAt", "tax", "active", "cancelExist", "tradeType", "inOrderBook", "postOnly", "hidden", "iceberg", "visibleSize", "cancelAfter", "channel" ] } } }, "required": [ "lastId", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470179", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getClosedOrders", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"lastId\\\": 19814995255305,\\n \\\"items\\\": [\\n {\\n \\\"id\\\": \\\"6717422bd51c29000775ea03\\\",\\n \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"opType\\\": \\\"DEAL\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"70000\\\",\\n \\\"size\\\": \\\"0.00001\\\",\\n \\\"funds\\\": \\\"0.7\\\",\\n \\\"dealSize\\\": \\\"0.00001\\\",\\n \\\"dealFunds\\\": \\\"0.677176\\\",\\n \\\"remainSize\\\": \\\"0\\\",\\n \\\"remainFunds\\\": \\\"0.022824\\\",\\n \\\"cancelledSize\\\": \\\"0\\\",\\n \\\"cancelledFunds\\\": \\\"0\\\",\\n \\\"fee\\\": \\\"0.000677176\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stp\\\": null,\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": \\\"0\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"remark\\\": \\\"order remarks\\\",\\n \\\"tags\\\": null,\\n \\\"cancelExist\\\": false,\\n \\\"tradeType\\\": \\\"TRADE\\\",\\n \\\"inOrderBook\\\": false,\\n \\\"active\\\": false,\\n \\\"tax\\\": \\\"0\\\",\\n \\\"createdAt\\\": 1729577515444,\\n \\\"lastUpdatedAt\\\": 1729577515481\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"side\\\": \\\"buy\\\", \\\"type\\\": \\\"limit\\\", \\\"lastId\\\": 254062248624417, \\\"limit\\\": 20, \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000}", "operationId": "038" } }, "/api/v1/hf/fills": { "get": { "summary": "Get Trade History", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "orderId", "in": "query", "description": "The unique order id generated by the trading system\n(If orderId is specified,please ignore the other query parameters)", "required": false, "schema": { "type": "string", "maxLength": 24, "minLength": 24 } }, { "name": "side", "in": "query", "description": "specify if the order is to 'buy' or 'sell'", "required": false, "schema": { "type": "string", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ] } }, { "name": "type", "in": "query", "description": "specify if the order is an 'limit' order or 'market' order. ", "required": false, "schema": { "type": "string", "enum": [ "limit", "market" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ] } }, { "name": "lastId", "in": "query", "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.", "required": false, "schema": { "type": "integer", "format": "int64", "minimum": 0, "exclusiveMinimum": 0 } }, { "name": "limit", "in": "query", "description": "Default20,Max100", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, { "name": "startAt", "in": "query", "description": "Start time (milisecond)", "required": false, "schema": { "type": "integer", "format": "int64", "minimum": 1000000000000, "maximum": 9999999999999, "exclusiveMinimum": 1000000000000, "exclusiveMaximum": 9999999999999 } }, { "name": "endAt", "in": "query", "description": "End time (milisecond)", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 9999999999999, "exclusiveMaximum": 9999999999999, "minimum": 1000000000000, "exclusiveMinimum": 1000000000000 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id of transaction detail", "format": "int64" }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "tradeId": { "type": "integer", "description": "Trade Id, symbol latitude increment", "format": "int64" }, "orderId": { "type": "string", "description": "The unique order id generated by the trading system" }, "counterOrderId": { "type": "string", "description": "Counterparty order Id" }, "side": { "type": "string", "description": "Buy or sell", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ] }, "liquidity": { "type": "string", "description": "Liquidity type: taker or maker", "enum": [ "taker", "maker" ], "x-api-enum": [ { "value": "taker", "name": "", "description": "" }, { "value": "maker", "name": "", "description": "" } ] }, "forceTaker": { "type": "boolean" }, "price": { "type": "string", "description": "Order price" }, "size": { "type": "string", "description": "Order size" }, "funds": { "type": "string", "description": "Order Funds" }, "fee": { "type": "string", "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeRate": { "type": "string", "description": "Fee rate\n" }, "feeCurrency": { "type": "string", "description": "currency used to calculate trading fee" }, "stop": { "type": "string", "description": "Take Profit and Stop Loss type, currently HFT does not support the Take Profit and Stop Loss type, so it is empty" }, "tradeType": { "type": "string", "description": "Trade type, redundancy param" }, "taxRate": { "type": "string", "description": "Tax Rate, Users in some regions need query this field" }, "tax": { "type": "string", "description": "Users in some regions need query this field" }, "type": { "type": "string", "description": "Specify if the order is an 'limit' order or 'market' order. ", "enum": [ "limit", "market" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ] }, "createdAt": { "type": "integer", "format": "int64" } }, "required": [ "id", "symbol", "tradeId", "orderId", "counterOrderId", "side", "liquidity", "forceTaker", "price", "size", "funds", "fee", "feeRate", "feeCurrency", "stop", "tradeType", "taxRate", "tax", "type", "createdAt" ] } }, "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" } }, "required": [ "items", "lastId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470180", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getTradeHistory", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"items\\\": [\\n {\\n \\\"id\\\": 19814995255305,\\n \\\"orderId\\\": \\\"6717422bd51c29000775ea03\\\",\\n \\\"counterOrderId\\\": \\\"67174228135f9e000709da8c\\\",\\n \\\"tradeId\\\": 11029373945659392,\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"liquidity\\\": \\\"taker\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"forceTaker\\\": false,\\n \\\"price\\\": \\\"67717.6\\\",\\n \\\"size\\\": \\\"0.00001\\\",\\n \\\"funds\\\": \\\"0.677176\\\",\\n \\\"fee\\\": \\\"0.000677176\\\",\\n \\\"feeRate\\\": \\\"0.001\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stop\\\": \\\"\\\",\\n \\\"tradeType\\\": \\\"TRADE\\\",\\n \\\"taxRate\\\": \\\"0\\\",\\n \\\"tax\\\": \\\"0\\\",\\n \\\"createdAt\\\": 1729577515473\\n }\\n ],\\n \\\"lastId\\\": 19814995255305\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"orderId\\\": \\\"example_string_default_value\\\", \\\"side\\\": \\\"buy\\\", \\\"type\\\": \\\"limit\\\", \\\"lastId\\\": 254062248624417, \\\"limit\\\": 100, \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000}", "operationId": "039" } }, "/api/v1/hf/orders/dead-cancel-all/query": { "get": { "summary": "Get DCP", "deprecated": false, "description": "Get Disconnection Protect (Deadman Switch). Through this interface, you can query the settings of automatic order cancellation.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "timeout": { "type": "integer", "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" }, "currentTime": { "type": "integer", "description": "System current time (in seconds)", "format": "int64" }, "triggerTime": { "type": "integer", "description": "Trigger cancellation time (in seconds)", "format": "int64" } }, "description": "If the data is empty, it means that DCP is not set.", "additionalProperties": false } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470172", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getDCP", "x-sdk-method-description": "Get Disconnection Protect (Deadman Switch). Through this interface, you can query the settings of automatic order cancellation.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"timeout\\\": 5,\\n \\\"symbols\\\": \\\"BTC-USDT,ETH-USDT\\\",\\n \\\"currentTime\\\": 1729241305,\\n \\\"triggerTime\\\": 1729241308\\n }\\n}", "operationId": "040" } }, "/api/v1/hf/orders/dead-cancel-all": { "post": { "summary": "Set DCP", "deprecated": false, "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.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentTime": { "type": "integer", "description": "System current time (in seconds)", "format": "int64" }, "triggerTime": { "type": "integer", "description": "Trigger cancellation time (in seconds)", "format": "int64" } }, "required": [ "currentTime", "triggerTime" ], "description": "If the data is empty, it means that DCP is not set." } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470173", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "setDCP", "x-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.", "x-api-rate-limit-weight": 2, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "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." }, "symbols": { "type": "string", "description": "List of trading pairs. When this parameter is not empty, separate it with commas and support up to 50 trading pairs. Empty means all trading pairs. When this parameter is changed, the previous setting will be overwritten.", "example": [ "BTC-USDT,ETH-USDT" ] } }, "required": [ "timeout" ] }, "example": "{\n \"timeout\": 5,\n \"symbols\": \"BTC-USDT,ETH-USDT\"\n}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"currentTime\\\":1729656588,\\\"triggerTime\\\":1729656593}}", "x-request-example": "{\\\"timeout\\\": 5, \\\"symbols\\\": \\\"BTC-USDT,ETH-USDT\\\"}", "operationId": "041" } }, "/api/v1/stop-order": { "post": { "summary": "Add Stop Order", "deprecated": true, "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.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "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." } }, "required": [ "orderId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470334", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "addStopOrder", "x-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.", "x-api-rate-limit-weight": 1, "requestBody": { "content": { "application/json": { "schema": { "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.", "example": [ "5c52e11203aa677f33e493fb" ] }, "side": { "type": "string", "description": "specify if the order is to 'buy' or 'sell'", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ], "example": [ "buy" ] }, "symbol": { "type": "string", "description": "symbol", "example": [ "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" ], "x-api-enum": [ { "value": "limit", "name": "", "description": "" }, { "value": "market", "name": "", "description": "" } ], "example": [ "limit" ] }, "remark": { "type": "string", "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-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, not need for market 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](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading. Required for limit orders.", "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", "description": "passive order labels, this is disabled when the order timing strategy is IOC or FOK if **type** is limit.", "default": false }, "hidden": { "type": "boolean", "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { "type": "string", "description": "When **type** is limit, this is Maximum visible quantity in iceberg orders." }, "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" }, "stopPrice": { "type": "string", "description": "The trigger price." }, "tradeType": { "type": "string", "description": "The type of trading : TRADE(Spot), MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE" } }, "required": [ "symbol", "type", "side", "stopPrice" ] }, "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" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"orderId\\\": \\\"670fd33bf9406e0007ab3945\\\"\\n }\\n}", "x-request-example": "{\\\"type\\\": \\\"limit\\\", \\\"symbol\\\": \\\"BTC-USDT\\\", \\\"side\\\": \\\"buy\\\", \\\"price\\\": \\\"50000\\\", \\\"stopPrice\\\": \\\"50000\\\", \\\"size\\\": \\\"0.00001\\\", \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\", \\\"remark\\\": \\\"order remarks\\\"}", "operationId": "042" }, "get": { "summary": "Get Stop Orders List", "deprecated": false, "description": "This interface is to obtain all Spot active stop order lists", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "Only list orders for a specific symbol", "required": false, "schema": { "type": "string" } }, { "name": "side", "in": "query", "description": "buy or sell", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "limit, market", "required": false, "schema": { "type": "string", "enum": [ "limit", "market" ], "x-api-enum": [ { "value": "limit", "name": "limit", "description": "limit order" }, { "value": "market", "name": "market", "description": "market order" } ] } }, { "name": "tradeType", "in": "query", "description": "The type of trading : TRADE(Spot), MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE", "required": false, "schema": { "type": "string" } }, { "name": "startAt", "in": "query", "description": "Start time (milisecond)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "endAt", "in": "query", "description": "End time (milisecond)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "currentPage", "in": "query", "description": "Current page\n", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "orderIds", "in": "query", "description": "Comma seperated order ID list", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Page size", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 10, "maximum": 500 } }, { "name": "stop", "in": "query", "description": "Order type: stop: stop loss order, oco: oco order", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer", "description": "current page id" }, "pageSize": { "type": "integer" }, "totalNum": { "type": "integer", "description": "the stop order count" }, "totalPage": { "type": "integer", "description": "total page count of the list" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Order ID, the ID of an order." }, "symbol": { "type": "string", "description": "Symbol name" }, "userId": { "type": "string", "description": "User ID" }, "status": { "type": "string", "description": "Order status, include NEW, TRIGGERED" }, "type": { "type": "string", "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", "description": "transaction direction,include buy and sell" }, "price": { "type": "string", "description": "order price" }, "size": { "type": "string", "description": "order quantity" }, "funds": { "type": "string", "description": "order funds" }, "stp": { "type": "string" }, "timeInForce": { "type": "string", "description": "time InForce,include GTC,GTT,IOC,FOK" }, "cancelAfter": { "type": "integer", "description": "cancel orders after n seconds,requires timeInForce to be GTT" }, "postOnly": { "type": "boolean", "description": "postOnly" }, "hidden": { "type": "boolean", "description": "hidden order" }, "iceberg": { "type": "boolean", "description": "Iceberg order" }, "visibleSize": { "type": "string", "description": "displayed quantity for iceberg order" }, "channel": { "type": "string", "description": "order source" }, "clientOid": { "type": "string", "description": "user-entered order unique mark" }, "remark": { "type": "string", "description": "Remarks at stop order creation" }, "tags": { "type": "string", "description": "tag order source" }, "orderTime": { "type": "integer", "description": "Time of place a stop order, accurate to nanoseconds", "format": "int64" }, "domainId": { "type": "string", "description": "domainId, e.g: kucoin" }, "tradeSource": { "type": "string", "description": "trade source: USER(Order by user), MARGIN_SYSTEM(Order by margin system)" }, "tradeType": { "type": "string", "description": "The type of trading : TRADE(Spot), MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin)." }, "feeCurrency": { "type": "string", "description": "The currency of the fee" }, "takerFeeRate": { "type": "string", "description": "Fee Rate of taker" }, "makerFeeRate": { "type": "string", "description": "Fee Rate of maker" }, "createdAt": { "type": "integer", "description": "order creation time", "format": "int64" }, "stop": { "type": "string", "description": "Stop order type, include loss and entry" }, "stopTriggerTime": { "type": "integer", "description": "The trigger time of the stop order", "format": "int64" }, "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" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470338", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getStopOrdersList", "x-sdk-method-description": "This interface is to obtain all Spot active stop order lists", "x-api-rate-limit-weight": 8, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 50,\\n \\\"totalNum\\\": 2,\\n \\\"totalPage\\\": 1,\\n \\\"items\\\": [\\n {\\n \\\"id\\\": \\\"vs93gptvr9t2fsql003l8k5p\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"userId\\\": \\\"633559791e1cbc0001f319bc\\\",\\n \\\"status\\\": \\\"NEW\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"50000.00000000000000000000\\\",\\n \\\"size\\\": \\\"0.00001000000000000000\\\",\\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\\\": \\\"5c52e11203aa677f222233e493fb\\\",\\n \\\"remark\\\": \\\"order remarks\\\",\\n \\\"tags\\\": null,\\n \\\"relatedNo\\\": null,\\n \\\"orderTime\\\": 1740626554883000024,\\n \\\"domainId\\\": \\\"kucoin\\\",\\n \\\"tradeSource\\\": \\\"USER\\\",\\n \\\"tradeType\\\": \\\"TRADE\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"takerFeeRate\\\": \\\"0.00100000000000000000\\\",\\n \\\"makerFeeRate\\\": \\\"0.00100000000000000000\\\",\\n \\\"createdAt\\\": 1740626554884,\\n \\\"stop\\\": \\\"loss\\\",\\n \\\"stopTriggerTime\\\": null,\\n \\\"stopPrice\\\": \\\"60000.00000000000000000000\\\",\\n \\\"limitPrice\\\": null,\\n \\\"pop\\\": null,\\n \\\"activateCondition\\\": null\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"example_string_default_value\\\", \\\"side\\\": \\\"example_string_default_value\\\", \\\"type\\\": \\\"limit\\\", \\\"tradeType\\\": \\\"example_string_default_value\\\", \\\"startAt\\\": 123456, \\\"endAt\\\": 123456, \\\"currentPage\\\": 1, \\\"orderIds\\\": \\\"example_string_default_value\\\", \\\"pageSize\\\": 50, \\\"stop\\\": \\\"example_string_default_value\\\"}", "operationId": "046" } }, "/api/v1/stop-order/cancelOrderByClientOid": { "delete": { "summary": "Cancel Stop Order By ClientOid", "deprecated": true, "description": "This endpoint can be used to cancel a spot stop order by clientOid. ", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": false, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "clientOid", "in": "query", "description": "Unique order id created by users to identify their orders", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "clientOid": { "type": "string", "description": "Client Order Id,unique identifier created by the user" }, "cancelledOrderId": { "type": "string", "description": "Unique ID of the cancelled order" } }, "required": [ "clientOid", "cancelledOrderId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470336", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelStopOrderByClientOid", "x-sdk-method-description": "This endpoint can be used to cancel a spot stop order by clientOid. ", "x-api-rate-limit-weight": 5, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderId\\\": \\\"vs8hoo8ksc8mario0035a74n\\\",\\n \\\"clientOid\\\": \\\"689ff597f4414061aa819cc414836abd\\\"\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"clientOid\\\": \\\"689ff597f4414061aa819cc414836abd\\\"}", "operationId": "043" } }, "/api/v1/stop-order/{orderId}": { "delete": { "summary": "Cancel Stop Order By OrderId", "deprecated": true, "description": "This endpoint can be used to cancel a spot stop order by orderId. ", "tags": [], "parameters": [ { "name": "orderId", "in": "path", "description": "The unique order id generated by the trading system", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "cancelledOrderIds": { "type": "array", "items": { "type": "string" }, "description": "order ID array" } }, "required": [ "cancelledOrderIds" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470335", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelStopOrderByOrderId", "x-sdk-method-description": "This endpoint can be used to cancel a spot stop order by orderId. ", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderIds\\\": [\\n \\\"671124f9365ccb00073debd4\\\"\\n ]\\n }\\n}", "x-request-example": "{\\\"orderId\\\": \\\"671124f9365ccb00073debd4\\\"}", "operationId": "044" }, "get": { "summary": "Get Stop Order By OrderId", "deprecated": false, "description": "This interface is to obtain Spot stop order details by orderId", "tags": [], "parameters": [ { "name": "orderId", "in": "path", "description": "The order id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "Order ID, the ID of an order." }, "symbol": { "type": "string", "description": "Symbol name" }, "userId": { "type": "string", "description": "User ID" }, "status": { "type": "string", "description": "Order status, include NEW, TRIGGERED" }, "type": { "type": "string", "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", "description": "transaction direction,include buy and sell" }, "price": { "type": "string", "description": "order price" }, "size": { "type": "string", "description": "order quantity" }, "funds": { "type": "string", "description": "order funds" }, "stp": { "type": "string" }, "timeInForce": { "type": "string", "description": "time InForce,include GTC,GTT,IOC,FOK" }, "cancelAfter": { "type": "integer", "description": "cancel orders after n seconds,requires timeInForce to be GTT", "format": "int64" }, "postOnly": { "type": "boolean", "description": "postOnly" }, "hidden": { "type": "boolean", "description": "hidden order" }, "iceberg": { "type": "boolean", "description": "Iceberg order" }, "visibleSize": { "type": "string", "description": "displayed quantity for iceberg order" }, "channel": { "type": "string", "description": "order source" }, "clientOid": { "type": "string", "description": "user-entered order unique mark" }, "remark": { "type": "string", "description": "Remarks at stop order creation" }, "tags": { "type": "string", "description": "tag order source" }, "domainId": { "type": "string", "description": "domainId, e.g: kucoin" }, "tradeSource": { "type": "string", "description": "trade source: USER(Order by user), MARGIN_SYSTEM(Order by margin system)" }, "tradeType": { "type": "string", "description": "The type of trading : TRADE(Spot), MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin)." }, "feeCurrency": { "type": "string", "description": "The currency of the fee" }, "takerFeeRate": { "type": "string", "description": "Fee Rate of taker" }, "makerFeeRate": { "type": "string", "description": "Fee Rate of maker" }, "createdAt": { "type": "integer", "description": "order creation time", "format": "int64" }, "stop": { "type": "string", "description": "Stop order type, include loss and entry" }, "stopTriggerTime": { "type": "integer", "description": "The trigger time of the stop order", "format": "int64" }, "stopPrice": { "type": "string", "description": "stop price" }, "orderTime": { "type": "integer", "description": "Time of place a stop order, accurate to nanoseconds", "format": "int64" } }, "description": "the details" }, "code": { "type": "string", "description": "return status code" } }, "required": [ "data", "code" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470339", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getStopOrderByOrderId", "x-sdk-method-description": "This interface is to obtain Spot stop order details by orderId", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\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\\\": 1629098781127530200,\\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}", "x-request-example": "{\\\"orderId\\\": \\\"example_string_default_value\\\"}", "operationId": "047" } }, "/api/v1/stop-order/cancel": { "delete": { "summary": "Batch Cancel Stop Orders", "deprecated": false, "description": "This endpoint can be used to cancel a spot stop orders by batch.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "Cancel the open order for the specified symbol", "required": false, "schema": { "type": "string" } }, { "name": "tradeType", "in": "query", "description": "The type of trading : TRADE(Spot), MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin).", "required": false, "schema": { "type": "string" } }, { "name": "orderIds", "in": "query", "description": "Comma seperated order IDs.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "cancelledOrderIds": { "type": "array", "items": { "type": "string" }, "description": "order id array" } }, "required": [ "cancelledOrderIds" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470337", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "batchCancelStopOrder", "x-sdk-method-description": "This endpoint can be used to cancel a spot stop orders by batch.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderIds\\\": [\\n \\\"671124f9365ccb00073debd4\\\"\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"example_string_default_value\\\", \\\"tradeType\\\": \\\"example_string_default_value\\\", \\\"orderIds\\\": \\\"example_string_default_value\\\"}", "operationId": "045" } }, "/api/v1/stop-order/queryOrderByClientOid": { "get": { "summary": "Get Stop Order By ClientOid", "deprecated": false, "description": "This interface is to obtain Spot stop order details by orderId", "tags": [], "parameters": [ { "name": "clientOid", "in": "query", "description": "The client order id", "required": true, "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "description": "symbol name", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "description": "the return code" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Order ID, the ID of an order." }, "symbol": { "type": "string", "description": "Symbol name" }, "userId": { "type": "string", "description": "User ID" }, "status": { "type": "string", "description": "Order status, include NEW, TRIGGERED" }, "type": { "type": "string", "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", "description": "transaction direction,include buy and sell" }, "price": { "type": "string", "description": "order price" }, "size": { "type": "string", "description": "order quantity" }, "funds": { "type": "string", "description": "order funds" }, "stp": { "type": "string" }, "timeInForce": { "type": "string", "description": "time InForce,include GTC,GTT,IOC,FOK" }, "cancelAfter": { "type": "integer", "description": "cancel orders after n seconds,requires timeInForce to be GTT", "format": "int64" }, "postOnly": { "type": "boolean", "description": "postOnly" }, "hidden": { "type": "boolean", "description": "hidden order" }, "iceberg": { "type": "boolean", "description": "Iceberg order" }, "visibleSize": { "type": "string", "description": "displayed quantity for iceberg order" }, "channel": { "type": "string", "description": "order source" }, "clientOid": { "type": "string", "description": "user-entered order unique mark" }, "remark": { "type": "string", "description": "Remarks at stop order creation" }, "tags": { "type": "string", "description": "tag order source" }, "domainId": { "type": "string", "description": "domainId, e.g: kucoin" }, "tradeSource": { "type": "string", "description": "trade source: USER(Order by user), MARGIN_SYSTEM(Order by margin system)" }, "tradeType": { "type": "string", "description": "The type of trading : TRADE(Spot), MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin)." }, "feeCurrency": { "type": "string", "description": "The currency of the fee" }, "takerFeeRate": { "type": "string", "description": "Fee Rate of taker" }, "makerFeeRate": { "type": "string", "description": "Fee Rate of maker" }, "createdAt": { "type": "integer", "description": "order creation time", "format": "int64" }, "stop": { "type": "string", "description": "Stop order type, include loss and entry" }, "stopTriggerTime": { "type": "integer", "description": "The trigger time of the stop order", "format": "int64" }, "stopPrice": { "type": "string", "description": "stop price" }, "orderTime": { "type": "integer", "description": "Time of place a stop order, accurate to nanoseconds", "format": "int64" } } }, "description": "the return code" } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470340", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getStopOrderByClientOid", "x-sdk-method-description": "This interface is to obtain Spot stop order details by orderId", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"id\\\": \\\"vs8hoo8os561f5np0032vngj\\\",\\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\\\": \\\"2b700942b5db41cebe578cff48960e09\\\",\\n \\\"remark\\\": null,\\n \\\"tags\\\": null,\\n \\\"orderTime\\\": 1629020492834532600,\\n \\\"domainId\\\": \\\"kucoin\\\",\\n \\\"tradeSource\\\": \\\"USER\\\",\\n \\\"tradeType\\\": \\\"TRADE\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"takerFeeRate\\\": \\\"0.00200000000000000000\\\",\\n \\\"makerFeeRate\\\": \\\"0.00200000000000000000\\\",\\n \\\"createdAt\\\": 1629020492837,\\n \\\"stop\\\": \\\"loss\\\",\\n \\\"stopTriggerTime\\\": null,\\n \\\"stopPrice\\\": \\\"1.00000000000000000000\\\"\\n }\\n ]\\n}", "x-request-example": "{\\\"clientOid\\\": \\\"example_string_default_value\\\", \\\"symbol\\\": \\\"example_string_default_value\\\"}", "operationId": "048" } }, "/api/v3/oco/order": { "post": { "summary": "Add OCO Order", "deprecated": true, "description": "Place OCO order to the Spot trading system", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "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." } }, "required": [ "orderId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470353", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "addOcoOrder", "x-sdk-method-description": "Place OCO order to the Spot trading system", "x-api-rate-limit-weight": 2, "requestBody": { "content": { "application/json": { "schema": { "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.", "example": [ "5c52e11203aa677f33e493fb" ] }, "side": { "type": "string", "description": "specify if the order is to 'buy' or 'sell'", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ], "example": [ "buy" ] }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "remark": { "type": "string", "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" }, "price": { "type": "string", "description": "Specify price for order" }, "size": { "type": "string", "description": "Specify quantity for order" }, "stopPrice": { "type": "string", "description": "trigger price." }, "limitPrice": { "type": "string", "description": "The limit order price after take-profit and stop-loss are triggered." }, "tradeType": { "type": "string", "description": "Transaction Type, currently only supports TRADE (spot transactions), the default is TRADE", "enum": [ "TRADE" ], "x-api-enum": [ { "value": "TRADE", "name": "TRADE", "description": "Spot Trading" } ] } }, "required": [ "symbol", "side", "clientOid", "price", "size", "stopPrice", "limitPrice" ] }, "example": "{\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"94000\",\n \"size\": \"0.1\",\n \"clientOid\": \"5c52e11203aa67f1e493fb\",\n \"stopPrice\": \"98000\",\n \"limitPrice\": \"96000\",\n \"remark\": \"this is remark\",\n \"tradeType\": \"TRADE\"\n}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"orderId\\\":\\\"674c316e688dea0007c7b986\\\"}}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"side\\\": \\\"buy\\\", \\\"price\\\": \\\"94000\\\", \\\"size\\\": \\\"0.1\\\", \\\"clientOid\\\": \\\"5c52e11203aa67f1e493fb\\\", \\\"stopPrice\\\": \\\"98000\\\", \\\"limitPrice\\\": \\\"96000\\\", \\\"remark\\\": \\\"this is remark\\\", \\\"tradeType\\\": \\\"TRADE\\\"}", "operationId": "049" } }, "/api/v3/oco/order/{orderId}": { "delete": { "summary": "Cancel OCO Order By OrderId", "deprecated": true, "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.", "tags": [], "parameters": [ { "name": "orderId", "in": "path", "description": "The unique order id generated by the trading system", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "cancelledOrderIds": { "type": "array", "items": { "type": "string" }, "description": "List of two order IDs related to the canceled OCO order" } }, "required": [ "cancelledOrderIds" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470354", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelOcoOrderByOrderId", "x-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.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderIds\\\": [\\n \\\"vs93gpqc6kkmkk57003gok16\\\",\\n \\\"vs93gpqc6kkmkk57003gok17\\\"\\n ]\\n }\\n}", "x-request-example": "{\\\"orderId\\\": \\\"674c316e688dea0007c7b986\\\"}", "operationId": "050" }, "get": { "summary": "Get OCO Order By OrderId", "deprecated": true, "description": "Request via this interface an OCO order information via the order ID.", "tags": [], "parameters": [ { "name": "orderId", "in": "path", "description": "The unique order id generated by the trading system", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "symbol": { "type": "string", "description": "symbol" }, "clientOid": { "type": "string", "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." }, "orderTime": { "type": "integer", "description": "Order placement time, milliseconds", "format": "int64" }, "status": { "type": "string", "description": "Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELED: Canceled", "enum": [ "NEW", "DONE", "TRIGGERED", "CANCELLED" ], "x-api-enum": [ { "value": "NEW", "name": "NEW", "description": "New" }, { "value": "DONE", "name": "DONE", "description": "Completed" }, { "value": "TRIGGERED", "name": "TRIGGERED", "description": "Triggered" }, { "value": "CANCELLED", "name": "CANCELED", "description": "Canceled" } ] } }, "required": [ "orderId", "symbol", "clientOid", "orderTime", "status" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470357", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOcoOrderByOrderId", "x-sdk-method-description": "Request via this interface an OCO order information via the order ID.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"orderId\\\": \\\"674c3b6e688dea0007c7bab2\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"clientOid\\\": \\\"5c52e1203aa6f37f1e493fb\\\",\\n \\\"orderTime\\\": 1733049198863,\\n \\\"status\\\": \\\"NEW\\\"\\n }\\n}", "x-request-example": "{\\\"orderId\\\": \\\"674c3b6e688dea0007c7bab2\\\"}", "operationId": "053" } }, "/api/v3/oco/client-order/{clientOid}": { "delete": { "summary": "Cancel OCO Order By ClientOid", "deprecated": true, "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.", "tags": [], "parameters": [ { "name": "clientOid", "in": "path", "description": "Client Order Id,unique identifier created by the user", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "cancelledOrderIds": { "type": "array", "items": { "type": "string" }, "description": "List of two order IDs related to the canceled OCO order" } }, "required": [ "cancelledOrderIds" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470355", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelOcoOrderByClientOid", "x-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.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderIds\\\": [\\n \\\"vs93gpqc6r0mkk57003gok3h\\\",\\n \\\"vs93gpqc6r0mkk57003gok3i\\\"\\n ]\\n }\\n}", "x-request-example": "{\\\"clientOid\\\": \\\"5c52e11203aa67f1e493fb\\\"}", "operationId": "051" }, "get": { "summary": "Get OCO Order By ClientOid", "deprecated": true, "description": "Request via this interface to get a oco order information via the client order ID.", "tags": [], "parameters": [ { "name": "clientOid", "in": "path", "description": "Client Order Id,unique identifier created by the user", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "symbol": { "type": "string", "description": "symbol" }, "clientOid": { "type": "string", "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." }, "orderTime": { "type": "integer", "description": "Order placement time, milliseconds", "format": "int64" }, "status": { "type": "string", "description": "Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELLED: Cancelled" } }, "required": [ "orderId", "symbol", "clientOid", "orderTime", "status" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470358", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOcoOrderByClientOid", "x-sdk-method-description": "Request via this interface to get a oco order information via the client order ID.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"orderId\\\": \\\"674c3cfa72cf2800072ee7ce\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"clientOid\\\": \\\"5c52e1203aa6f3g7f1e493fb\\\",\\n \\\"orderTime\\\": 1733049594803,\\n \\\"status\\\": \\\"NEW\\\"\\n }\\n}", "x-request-example": "{\\\"clientOid\\\": \\\"5c52e1203aa6f3g7f1e493fb\\\"}", "operationId": "054" } }, "/api/v3/oco/orders": { "delete": { "summary": "Batch Cancel OCO Order", "deprecated": true, "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.", "tags": [], "parameters": [ { "name": "orderIds", "in": "query", "description": "Specify the order ID; there can be multiple orders, separated by commas. If not passed, all OCO orders will be canceled by default.", "required": false, "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "description": "Trading pair. If not passed, the OCO orders of all symbols will be canceled by default.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "cancelledOrderIds": { "type": "array", "items": { "type": "string" }, "description": "List of two order IDs related to the canceled OCO order" } }, "required": [ "cancelledOrderIds" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470356", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "batchCancelOcoOrders", "x-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.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderIds\\\": [\\n \\\"vs93gpqc750mkk57003gok6i\\\",\\n \\\"vs93gpqc750mkk57003gok6j\\\",\\n \\\"vs93gpqc75c39p83003tnriu\\\",\\n \\\"vs93gpqc75c39p83003tnriv\\\"\\n ]\\n }\\n}", "x-request-example": "{\\\"orderIds\\\": \\\"674c388172cf2800072ee746,674c38bdfd8300000795167e\\\", \\\"symbol\\\": \\\"BTC-USDT\\\"}", "operationId": "052" }, "get": { "summary": "Get OCO Order List", "deprecated": true, "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.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": false, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "startAt", "in": "query", "description": "Start time (milliseconds)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "endAt", "in": "query", "description": "End time (milliseconds)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "orderIds", "in": "query", "description": "Specify orderId collection, up to 500 orders\n", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Size per page, minimum value 10, maximum value 500", "required": false, "schema": { "type": "integer", "minimum": 10, "maximum": 500, "default": 50 } }, { "name": "currentPage", "in": "query", "description": "Page number, minimum value 1\n", "required": false, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalNum": { "type": "integer" }, "totalPage": { "type": "integer" }, "items": { "type": "array", "items": { "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." }, "symbol": { "type": "string", "description": "symbol" }, "clientOid": { "type": "string", "description": "Client Order ID" }, "orderTime": { "type": "integer", "description": "Order placement time, milliseconds", "format": "int64" }, "status": { "type": "string", "description": "Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELED: Canceled", "enum": [ "NEW", "DONE", "TRIGGERED", "CANCELLED" ], "x-api-enum": [ { "value": "NEW", "name": "NEW", "description": "New" }, { "value": "DONE", "name": "DONE", "description": "Completed" }, { "value": "TRIGGERED", "name": "TRIGGERED", "description": "Triggered" }, { "value": "CANCELLED", "name": "CANCELED", "description": "Canceled" } ] } }, "required": [ "orderId", "symbol", "clientOid", "orderTime", "status" ] } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470360", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOcoOrderList", "x-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.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 50,\\n \\\"totalNum\\\": 1,\\n \\\"totalPage\\\": 1,\\n \\\"items\\\": [\\n {\\n \\\"orderId\\\": \\\"674c3cfa72cf2800072ee7ce\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"clientOid\\\": \\\"5c52e1203aa6f3g7f1e493fb\\\",\\n \\\"orderTime\\\": 1733049594803,\\n \\\"status\\\": \\\"NEW\\\"\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"startAt\\\": 123456, \\\"endAt\\\": 123456, \\\"orderIds\\\": \\\"example_string_default_value\\\", \\\"pageSize\\\": 50, \\\"currentPage\\\": 1}", "operationId": "056" } }, "/api/v3/oco/order/details/{orderId}": { "get": { "summary": "Get OCO Order Detail By OrderId", "deprecated": true, "description": "Request via this interface to get a oco order detail via the order ID.", "tags": [], "parameters": [ { "name": "orderId", "in": "path", "description": "The unique order id generated by the trading system", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "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." }, "symbol": { "type": "string", "description": "symbol" }, "clientOid": { "type": "string", "description": "Client Order Id" }, "orderTime": { "type": "integer", "description": "Order placement time, milliseconds", "format": "int64" }, "status": { "type": "string", "description": "Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELLED: Cancelled" }, "orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "symbol": { "type": "string" }, "side": { "type": "string" }, "price": { "type": "string" }, "stopPrice": { "type": "string" }, "size": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "symbol", "side", "price", "stopPrice", "size", "status" ] } } }, "required": [ "orderId", "symbol", "clientOid", "orderTime", "status", "orders" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470359", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOcoOrderDetailByOrderId", "x-sdk-method-description": "Request via this interface to get a oco order detail via the order ID.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"orderId\\\": \\\"674c3b6e688dea0007c7bab2\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"clientOid\\\": \\\"5c52e1203aa6f37f1e493fb\\\",\\n \\\"orderTime\\\": 1733049198863,\\n \\\"status\\\": \\\"NEW\\\",\\n \\\"orders\\\": [\\n {\\n \\\"id\\\": \\\"vs93gpqc7dn6h3fa003sfelj\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"94000.00000000000000000000\\\",\\n \\\"stopPrice\\\": \\\"94000.00000000000000000000\\\",\\n \\\"size\\\": \\\"0.10000000000000000000\\\",\\n \\\"status\\\": \\\"NEW\\\"\\n },\\n {\\n \\\"id\\\": \\\"vs93gpqc7dn6h3fa003sfelk\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"96000.00000000000000000000\\\",\\n \\\"stopPrice\\\": \\\"98000.00000000000000000000\\\",\\n \\\"size\\\": \\\"0.10000000000000000000\\\",\\n \\\"status\\\": \\\"NEW\\\"\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"orderId\\\": \\\"674c3b6e688dea0007c7bab2\\\"}", "operationId": "055" } }, "/api/v1/bullet-public": { "post": { "summary": "Get Public Token - Spot/Margin", "deprecated": false, "description": "This interface can obtain the token required for Websocket to establish a Spot/Margin connection. If you need use public channels (e.g. all public market data), please make request as follows to obtain the server list and public token", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "token": { "type": "string", "description": "The token required to establish a Websocket connection" }, "instanceServers": { "type": "array", "items": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "Websocket domain URL. It is recommended to use a dynamic URL, as the URL may change." }, "encrypt": { "type": "boolean", "description": "Whether to encrypt. Currently only supports wss, not ws" }, "protocol": { "type": "string", "description": "Network Protocol", "enum": [ "websocket" ], "x-api-enum": [ { "value": "websocket", "name": "Websocket", "description": "Websocket" } ] }, "pingInterval": { "type": "integer", "description": "Recommended ping interval (milliseconds)" }, "pingTimeout": { "type": "integer", "description": "Heartbeat timeout (milliseconds)" } }, "required": [ "endpoint", "encrypt", "protocol", "pingInterval", "pingTimeout" ] } } }, "required": [ "token", "instanceServers" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470294", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", "x-api-permission": "NULL", "x-api-rate-limit-pool": "Public", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getPublicToken", "x-sdk-method-description": "This interface can obtain the token required for Websocket to establish a Spot/Margin connection. If you need use public channels (e.g. all public market data), please make request as follows to obtain the server list and public token", "x-api-rate-limit-weight": 10, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"token\\\": \\\"2neAiuYvAU61ZDXANAGAsiL4-iAExhsBXZxftpOeh_55i3Ysy2q2LEsEWU64mdzUOPusi34M_wGoSf7iNyEWJ93g2WHl-j4M7tCZ_S21PuIByWXUJFDywtiYB9J6i9GjsxUuhPw3Blq6rhZlGykT3Vp1phUafnulOOpts-MEmEF-3bpfetLOAq79RbGaLlE4JBvJHl5Vs9Y=.ymP9jIr6v-vucrZr8761yA==\\\",\\n \\\"instanceServers\\\": [\\n {\\n \\\"endpoint\\\": \\\"wss://ws-api-spot.kucoin.com/\\\",\\n \\\"encrypt\\\": true,\\n \\\"protocol\\\": \\\"websocket\\\",\\n \\\"pingInterval\\\": 18000,\\n \\\"pingTimeout\\\": 10000\\n }\\n ]\\n }\\n}", "operationId": "057" } }, "/api/v1/bullet-private": { "post": { "summary": "Get Private Token - Spot/Margin", "deprecated": false, "description": "This interface can obtain the token required for Websocket to establish a Spot/Margin private connection. If you need use private channels (e.g. account balance notice), please make request as follows to obtain the server list and private token", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "token": { "type": "string", "description": "The token required to establish a Websocket connection" }, "instanceServers": { "type": "array", "items": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "Websocket domain URL. It is recommended to use a dynamic URL, as the URL may change." }, "encrypt": { "type": "boolean", "description": "Whether to encrypt. Currently only supports wss, not ws" }, "protocol": { "type": "string", "description": "Network Protocol", "enum": [ "websocket" ], "x-api-enum": [ { "value": "websocket", "name": "Websocket", "description": "Websocket" } ] }, "pingInterval": { "type": "integer", "description": "Recommended ping interval (milliseconds)" }, "pingTimeout": { "type": "integer", "description": "Heartbeat timeout (milliseconds)" } }, "required": [ "endpoint", "encrypt", "protocol", "pingInterval", "pingTimeout" ] } } }, "required": [ "token", "instanceServers" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470295", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Market", "x-sdk-method-name": "getPrivateToken", "x-sdk-method-description": "This interface can obtain the token required for Websocket to establish a Spot/Margin private connection. If you need use private channels (e.g. account balance notice), please make request as follows to obtain the server list and private token", "x-api-rate-limit-weight": 10, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"token\\\": \\\"2neAiuYvAU737TOajb2U3uT8AEZqSWYe0fBD4LoHuXJDSC7gIzJiH4kNTWhCPISWo6nDpAe7aUaaHJ4fG8oRjFgMfUI2sM4IySWHrBceFocY8pKy2REU1HwZIngtMdMrjqPnP-biofFWbNaP1cl0X1pZc2SQ-33hDH1LgNP-yg80ZJv_Ctaj8sAFhTOZ8m1L.jut4vBQxXAseWKxODdGVGg==\\\",\\n \\\"instanceServers\\\": [\\n {\\n \\\"endpoint\\\": \\\"wss://ws-api-spot.kucoin.com/\\\",\\n \\\"encrypt\\\": true,\\n \\\"protocol\\\": \\\"websocket\\\",\\n \\\"pingInterval\\\": 18000,\\n \\\"pingTimeout\\\": 10000\\n }\\n ]\\n }\\n}", "operationId": "058" } }, "/api/v1/orders": { "post": { "summary": "Add Order - Old", "deprecated": true, "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.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "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." } }, "required": [ "orderId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470333", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "addOrderOld", "x-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.", "x-api-rate-limit-weight": 2, "requestBody": { "content": { "application/json": { "schema": { "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.", "example": [ "5c52e11203aa677f33e493fb" ] }, "side": { "type": "string", "description": "specify if the order is to 'buy' or 'sell'", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ], "example": [ "buy" ] }, "symbol": { "type": "string", "description": "symbol", "example": [ "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" ], "default": "limit", "x-api-enum": [ { "value": "limit", "name": "limit", "description": "limit order" }, { "value": "market", "name": "market", "description": "market order" } ] }, "remark": { "type": "string", "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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 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", "default": false }, "visibleSize": { "type": "string", "description": "Maximum visible quantity in iceberg orders" }, "cancelAfter": { "type": "integer", "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" }, "tradeType": { "type": "string", "description": "The type of trading : **TRADE**(Spot Trade), **MARGIN_TRADE** (Margin Trade). Default is **TRADE**. **Note: To improve the system performance and to accelerate order placing and processing, KuCoin has added a new interface for order placing of margin. For traders still using the current interface, please move to the new one as soon as possible. The current one will no longer accept margin orders by May 1st, 2021 (UTC). At the time, KuCoin will notify users via the announcement, please pay attention to it.**", "enum": [ "TRADE", "MARGIN_TRADE" ], "default": "TRADE", "x-api-enum": [ { "value": "TRADE", "name": "TRADE", "description": "Spot" }, { "value": "MARGIN_TRADE", "name": "MARGIN_TRADE", "description": "Margin" } ] } }, "required": [ "symbol", "side", "clientOid" ] }, "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" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"orderId\\\": \\\"674a8635b38d120007709c0f\\\"\\n }\\n}", "x-request-example": "{\\\"type\\\": \\\"limit\\\", \\\"symbol\\\": \\\"BTC-USDT\\\", \\\"side\\\": \\\"buy\\\", \\\"price\\\": \\\"50000\\\", \\\"size\\\": \\\"0.00001\\\", \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\", \\\"remark\\\": \\\"order remarks\\\"}", "operationId": "059" }, "delete": { "summary": "Batch Cancel Order - Old", "deprecated": true, "description": "Request via this endpoint to cancel all open orders. The response is a list of ids of the canceled orders.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": false, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "tradeType", "in": "query", "description": "The type of trading :TRADE(Spot Trading), MARGIN_TRADE(Cross Margin Trading), MARGIN_ISOLATED_TRADE(Isolated Margin Trading), and the default is TRADE to cancel the spot trading orders.", "required": false, "schema": { "type": "string", "enum": [ "TRADE", "MARGIN_TRADE", "MARGIN_ISOLATED_TRADE" ], "default": "TRADE", "x-api-enum": [ { "value": "TRADE", "name": "TRADE", "description": "Spot Trading" }, { "value": "MARGIN_TRADE", "name": "MARGIN_TRADE", "description": "Cross Margin Trading" }, { "value": "MARGIN_ISOLATED_TRADE", "name": "MARGIN_ISOLATED_TRADE", "description": "Isolated Margin Trading" } ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "cancelledOrderIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "cancelledOrderIds" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470345", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "batchCancelOrderOld", "x-sdk-method-description": "Request via this endpoint to cancel all open orders. The response is a list of ids of the canceled orders.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderIds\\\": [\\n \\\"674a8635b38d120007709c0f\\\",\\n \\\"674a8630439c100007d3bce1\\\"\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"tradeType\\\": \\\"TRADE\\\"}", "operationId": "064" }, "get": { "summary": "Get Orders List - Old", "deprecated": true, "description": "Request your current order list via this endpoint. The return value is the data after Pagination, sorted in descending order according to time.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "Symbol", "required": false, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "status", "in": "query", "description": "Active or done (done as default); only list orders with a specific status.", "required": false, "schema": { "type": "string", "enum": [ "active", "done" ], "default": "done", "x-api-enum": [ { "value": "active", "name": "active", "description": "Active order" }, { "value": "done", "name": "done", "description": "Done orders" } ] } }, { "name": "side", "in": "query", "description": "Buy or Sell", "required": false, "schema": { "type": "string", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "buy", "description": "buy" }, { "value": "sell", "name": "sell", "description": "sell" } ] } }, { "name": "type", "in": "query", "description": "Order type", "required": false, "schema": { "type": "string", "enum": [ "limit", "market", "limit_stop", "market_stop", "oco_limit", "oco_stop" ], "x-api-enum": [ { "value": "limit", "name": "limit", "description": "limit" }, { "value": "market", "name": "market", "description": "market" }, { "value": "limit_stop", "name": "limit_stop", "description": "limit_stop" }, { "value": "market_stop", "name": "market_stop", "description": "market_stop" }, { "value": "oco_limit", "name": "oco_limit", "description": "oco_limit" }, { "value": "oco_stop", "name": "oco_stop", "description": "oco_stop" } ] } }, { "name": "tradeType", "in": "query", "description": "The type of trading: TRADE - Spot Trading (TRADE as default), MARGIN_TRADE - Cross Margin Trading, MARGIN_ISOLATED_TRADE - Isolated Margin Trading.", "required": false, "schema": { "type": "string", "enum": [ "TRADE", "MARGIN_TRADE", "MARGIN_ISOLATED_TRADE" ], "default": "TRADE", "x-api-enum": [ { "value": "TRADE", "name": "TRADE", "description": "Spot Trading" }, { "value": "MARGIN_TRADE", "name": "MARGIN_TRADE", "description": "Cross Margin Trading" }, { "value": "MARGIN_ISOLATED_TRADE", "name": "MARGIN_ISOLATED_TRADE", "description": "Isolated Margin Trading" } ] } }, { "name": "startAt", "in": "query", "description": "Start time (milliseconds)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "endAt", "in": "query", "description": "End time (milliseconds)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "currentPage", "in": "query", "description": "Current request page.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Number of results per request. Minimum is 10, maximum is 500.", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 10, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalNum": { "type": "integer" }, "totalPage": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "symbol": { "type": "string" }, "opType": { "type": "string" }, "type": { "type": "string" }, "side": { "type": "string" }, "price": { "type": "string" }, "size": { "type": "string" }, "funds": { "type": "string" }, "dealFunds": { "type": "string" }, "dealSize": { "type": "string" }, "fee": { "type": "string" }, "feeCurrency": { "type": "string" }, "stp": { "type": "string" }, "stop": { "type": "string" }, "stopTriggered": { "type": "boolean" }, "stopPrice": { "type": "string" }, "timeInForce": { "type": "string" }, "postOnly": { "type": "boolean" }, "hidden": { "type": "boolean" }, "iceberg": { "type": "boolean" }, "visibleSize": { "type": "string" }, "cancelAfter": { "type": "integer" }, "channel": { "type": "string" }, "clientOid": { "type": "string" }, "remark": { "type": "string" }, "tags": { "type": "string" }, "isActive": { "type": "boolean" }, "cancelExist": { "type": "boolean" }, "createdAt": { "type": "integer", "format": "int64" }, "tradeType": { "type": "string" }, "tax": { "type": "string" }, "taxRate": { "type": "string" }, "taxCurrency": { "type": "string" } }, "required": [ "id", "symbol", "opType", "type", "side", "price", "size", "funds", "dealFunds", "dealSize", "fee", "feeCurrency", "stp", "stop", "stopTriggered", "stopPrice", "timeInForce", "postOnly", "hidden", "iceberg", "visibleSize", "cancelAfter", "channel", "clientOid", "remark", "tags", "isActive", "cancelExist", "createdAt", "tradeType" ] } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470346", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOrdersListOld", "x-sdk-method-description": "Request your current order list via this endpoint. The return value is the data after Pagination, sorted in descending order according to time.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 50,\\n \\\"totalNum\\\": 1,\\n \\\"totalPage\\\": 1,\\n \\\"items\\\": [\\n {\\n \\\"id\\\": \\\"674a9a872033a50007e2790d\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"opType\\\": \\\"DEAL\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"50000\\\",\\n \\\"size\\\": \\\"0.00001\\\",\\n \\\"funds\\\": \\\"0\\\",\\n \\\"dealFunds\\\": \\\"0\\\",\\n \\\"dealSize\\\": \\\"0\\\",\\n \\\"fee\\\": \\\"0\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stp\\\": \\\"\\\",\\n \\\"stop\\\": \\\"\\\",\\n \\\"stopTriggered\\\": false,\\n \\\"stopPrice\\\": \\\"0\\\",\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": \\\"0\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"clientOid\\\": \\\"5c52e11203aa677f33e4923fb\\\",\\n \\\"remark\\\": \\\"order remarks\\\",\\n \\\"tags\\\": null,\\n \\\"isActive\\\": false,\\n \\\"cancelExist\\\": true,\\n \\\"createdAt\\\": 1732942471752,\\n \\\"tradeType\\\": \\\"TRADE\\\"\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"status\\\": \\\"active\\\", \\\"side\\\": \\\"buy\\\", \\\"type\\\": \\\"limit\\\", \\\"tradeType\\\": \\\"TRADE\\\", \\\"startAt\\\": 123456, \\\"endAt\\\": 123456, \\\"currentPage\\\": 1, \\\"pageSize\\\": 50}", "operationId": "065" } }, "/api/v1/orders/test": { "post": { "summary": "Add Order Test - Old", "deprecated": true, "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.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "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." } }, "required": [ "orderId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470341", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "addOrderTestOld", "x-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.", "x-api-rate-limit-weight": 2, "requestBody": { "content": { "application/json": { "schema": { "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.", "example": [ "5c52e11203aa677f33e493fb" ] }, "side": { "type": "string", "description": "specify if the order is to 'buy' or 'sell'", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ], "example": [ "buy" ] }, "symbol": { "type": "string", "description": "symbol", "example": [ "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" ], "default": "limit", "x-api-enum": [ { "value": "limit", "name": "limit", "description": "limit order" }, { "value": "market", "name": "market", "description": "market order" } ] }, "remark": { "type": "string", "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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 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", "default": false }, "visibleSize": { "type": "string", "description": "Maximum visible quantity in iceberg orders" }, "cancelAfter": { "type": "integer", "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" }, "tradeType": { "type": "string", "description": "The type of trading : **TRADE**(Spot Trade), **MARGIN_TRADE** (Margin Trade). Default is **TRADE**. **Note: To improve the system performance and to accelerate order placing and processing, KuCoin has added a new interface for order placing of margin. For traders still using the current interface, please move to the new one as soon as possible. The current one will no longer accept margin orders by May 1st, 2021 (UTC). At the time, KuCoin will notify users via the announcement, please pay attention to it.**", "enum": [ "TRADE", "MARGIN_TRADE" ], "default": "TRADE", "x-api-enum": [ { "value": "TRADE", "name": "TRADE", "description": "Spot" }, { "value": "MARGIN_TRADE", "name": "MARGIN_TRADE", "description": "Margin" } ] } }, "required": [ "symbol", "side", "clientOid" ] }, "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" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"orderId\\\": \\\"674a8776291d9e00074f1edf\\\"\\n }\\n}", "x-request-example": "{\\\"type\\\": \\\"limit\\\", \\\"symbol\\\": \\\"BTC-USDT\\\", \\\"side\\\": \\\"buy\\\", \\\"price\\\": \\\"50000\\\", \\\"size\\\": \\\"0.00001\\\", \\\"clientOid\\\": \\\"5c52e11203aa677f33e493fb\\\", \\\"remark\\\": \\\"order remarks\\\"}", "operationId": "060" } }, "/api/v1/orders/multi": { "post": { "summary": "Batch Add Orders - Old", "deprecated": true, "description": "Request via this endpoint to place 5 orders at the same time. The order type must be a limit order of the same symbol.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string" }, "type": { "type": "string" }, "side": { "type": "string" }, "price": { "type": "string" }, "size": { "type": "string" }, "funds": { "type": "string" }, "stp": { "type": "string" }, "stop": { "type": "string" }, "stopPrice": { "type": "string" }, "timeInForce": { "type": "string" }, "cancelAfter": { "type": "integer" }, "postOnly": { "type": "boolean" }, "hidden": { "type": "boolean" }, "iceberge": { "type": "boolean" }, "iceberg": { "type": "boolean" }, "visibleSize": { "type": "string" }, "channel": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" }, "failMsg": { "type": "string" }, "clientOid": { "type": "string" } }, "required": [ "symbol", "type", "side", "price", "size", "funds", "stp", "stop", "stopPrice", "timeInForce", "cancelAfter", "postOnly", "hidden", "iceberge", "iceberg", "visibleSize", "channel", "id", "status", "failMsg", "clientOid" ] } } }, "required": [ "data" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470342", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "batchAddOrdersOld", "x-sdk-method-description": "Request via this endpoint to place 5 orders at the same time. The order type must be a limit order of the same symbol.", "x-api-rate-limit-weight": 3, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "orderList": { "type": "array", "items": { "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.", "example": [ "5c52e11203aa677f33e493fb" ] }, "side": { "type": "string", "description": "specify if the order is to 'buy' or 'sell'", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "", "description": "" }, { "value": "sell", "name": "", "description": "" } ], "example": [ "buy" ] }, "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "type": { "type": "string", "description": "only limit (default is limit)", "enum": [ "limit" ], "default": "limit", "x-api-enum": [ { "value": "limit", "name": "limit", "description": "limit order" } ] }, "remark": { "type": "string", "description": "Order placement remarks, length cannot exceed 20 characters (ASCII)" }, "stp": { "type": "string", "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-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](https://www.kucoin.com/docs-new/doc-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 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", "default": false }, "visibleSize": { "type": "string", "description": "Maximum visible quantity in iceberg orders" }, "cancelAfter": { "type": "integer", "format": "int64", "description": "Cancel after n seconds,the order timing strategy is GTT" }, "tradeType": { "type": "string", "description": "The type of trading : **TRADE**(Spot Trade)", "enum": [ "TRADE" ], "default": "TRADE", "x-api-enum": [ { "value": "TRADE", "name": "TRADE", "description": "Spot" } ] }, "stop": { "type": "string", "description": "Either loss or entry. Requires stopPrice to be defined", "enum": [ "loss", "entry" ], "x-api-enum": [ { "value": "loss", "name": "loss", "description": "<=" }, { "value": "entry", "name": "entry", "description": ">=" } ] }, "stopPrice": { "type": "string", "description": "Stop price, Need to be defined if stop is specified." } }, "required": [ "symbol", "side", "clientOid", "price", "size" ] } }, "symbol": { "type": "string" } }, "required": [ "symbol" ] }, "example": "{\n \"symbol\": \"BTC-USDT\",\n \"orderList\": [\n {\n \"clientOid\": \"3d07008668054da6b3cb12e432c2b13a\",\n \"side\": \"buy\",\n \"type\": \"limit\",\n \"price\": \"50000\",\n \"size\": \"0.0001\"\n },\n {\n \"clientOid\": \"37245dbe6e134b5c97732bfb36cd4a9d\",\n \"side\": \"buy\",\n \"type\": \"limit\",\n \"price\": \"49999\",\n \"size\": \"0.0001\"\n }\n ]\n}" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"data\\\": [\\n {\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"50000\\\",\\n \\\"size\\\": \\\"0.0001\\\",\\n \\\"funds\\\": null,\\n \\\"stp\\\": \\\"\\\",\\n \\\"stop\\\": \\\"\\\",\\n \\\"stopPrice\\\": null,\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberge\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": null,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"id\\\": \\\"674a97dfef434f0007efc431\\\",\\n \\\"status\\\": \\\"success\\\",\\n \\\"failMsg\\\": null,\\n \\\"clientOid\\\": \\\"3d07008668054da6b3cb12e432c2b13a\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"49999\\\",\\n \\\"size\\\": \\\"0.0001\\\",\\n \\\"funds\\\": null,\\n \\\"stp\\\": \\\"\\\",\\n \\\"stop\\\": \\\"\\\",\\n \\\"stopPrice\\\": null,\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberge\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": null,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"id\\\": \\\"674a97dffb378b00077b9c20\\\",\\n \\\"status\\\": \\\"fail\\\",\\n \\\"failMsg\\\": \\\"Balance insufficient!\\\",\\n \\\"clientOid\\\": \\\"37245dbe6e134b5c97732bfb36cd4a9d\\\"\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"orderList\\\": [{\\\"clientOid\\\": \\\"3d07008668054da6b3cb12e432c2b13a\\\", \\\"side\\\": \\\"buy\\\", \\\"type\\\": \\\"limit\\\", \\\"price\\\": \\\"50000\\\", \\\"size\\\": \\\"0.0001\\\"}, {\\\"clientOid\\\": \\\"37245dbe6e134b5c97732bfb36cd4a9d\\\", \\\"side\\\": \\\"buy\\\", \\\"type\\\": \\\"limit\\\", \\\"price\\\": \\\"49999\\\", \\\"size\\\": \\\"0.0001\\\"}]}", "operationId": "061" } }, "/api/v1/orders/{orderId}": { "delete": { "summary": "Cancel Order By OrderId - Old", "deprecated": true, "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.", "tags": [], "parameters": [ { "name": "orderId", "in": "path", "description": "The unique order id generated by the trading system", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "cancelledOrderIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "cancelledOrderIds" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470343", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelOrderByOrderIdOld", "x-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.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderIds\\\": [\\n \\\"674a97dfef434f0007efc431\\\"\\n ]\\n }\\n}", "x-request-example": "{\\\"orderId\\\": \\\"674a97dfef434f0007efc431\\\"}", "operationId": "062" }, "get": { "summary": "Get Order By OrderId - Old", "deprecated": true, "description": "Request a single order info by order ID via this endpoint.", "tags": [], "parameters": [ { "name": "orderId", "in": "path", "description": "The unique order id generated by the trading system", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "symbol": { "type": "string" }, "opType": { "type": "string" }, "type": { "type": "string" }, "side": { "type": "string" }, "price": { "type": "string" }, "size": { "type": "string" }, "funds": { "type": "string" }, "dealFunds": { "type": "string" }, "dealSize": { "type": "string" }, "fee": { "type": "string" }, "feeCurrency": { "type": "string" }, "stp": { "type": "string" }, "stop": { "type": "string" }, "stopTriggered": { "type": "boolean" }, "stopPrice": { "type": "string" }, "timeInForce": { "type": "string" }, "postOnly": { "type": "boolean" }, "hidden": { "type": "boolean" }, "iceberg": { "type": "boolean" }, "visibleSize": { "type": "string" }, "cancelAfter": { "type": "integer" }, "channel": { "type": "string" }, "clientOid": { "type": "string" }, "remark": { "type": "string" }, "tags": { "type": "string" }, "isActive": { "type": "boolean" }, "cancelExist": { "type": "boolean" }, "createdAt": { "type": "integer", "format": "int64" }, "tradeType": { "type": "string" }, "tax": { "type": "string" }, "taxRate": { "type": "string" }, "taxCurrency": { "type": "string" } }, "required": [ "id", "symbol", "opType", "type", "side", "price", "size", "funds", "dealFunds", "dealSize", "fee", "stp", "stop", "stopTriggered", "stopPrice", "timeInForce", "postOnly", "hidden", "iceberg", "visibleSize", "cancelAfter", "channel", "clientOid", "remark", "tags", "isActive", "cancelExist", "createdAt", "tradeType", "feeCurrency" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470348", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOrderByOrderIdOld", "x-sdk-method-description": "Request a single order info by order ID via this endpoint.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"id\\\": \\\"674a97dfef434f0007efc431\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"opType\\\": \\\"DEAL\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"50000\\\",\\n \\\"size\\\": \\\"0.0001\\\",\\n \\\"funds\\\": \\\"0\\\",\\n \\\"dealFunds\\\": \\\"0\\\",\\n \\\"dealSize\\\": \\\"0\\\",\\n \\\"fee\\\": \\\"0\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stp\\\": \\\"\\\",\\n \\\"stop\\\": \\\"\\\",\\n \\\"stopTriggered\\\": false,\\n \\\"stopPrice\\\": \\\"0\\\",\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": \\\"0\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"clientOid\\\": \\\"3d07008668054da6b3cb12e432c2b13a\\\",\\n \\\"remark\\\": null,\\n \\\"tags\\\": null,\\n \\\"isActive\\\": false,\\n \\\"cancelExist\\\": true,\\n \\\"createdAt\\\": 1732941791518,\\n \\\"tradeType\\\": \\\"TRADE\\\"\\n }\\n}", "x-request-example": "{\\\"orderId\\\": \\\"674a97dfef434f0007efc431\\\"}", "operationId": "067" } }, "/api/v1/order/client-order/{clientOid}": { "delete": { "summary": "Cancel Order By ClientOid - Old", "deprecated": false, "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.", "tags": [], "parameters": [ { "name": "clientOid", "in": "path", "description": "Client Order Id,unique identifier created by the user", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "clientOid": { "type": "string", "description": "Client Order Id,unique identifier created by the user" }, "cancelledOrderId": { "type": "string", "description": "The unique order id generated by the trading system" }, "cancelledOcoOrderIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "cancelledOrderId", "clientOid", "cancelledOcoOrderIds" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470344", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelOrderByClientOidOld", "x-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.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderId\\\": \\\"67c3252a63d25e0007f91de9\\\",\\n \\\"clientOid\\\": \\\"5c52e11203aa677f331e493fb\\\",\\n \\\"cancelledOcoOrderIds\\\": null\\n }\\n}", "x-request-example": "{\\\"clientOid\\\": \\\"5c52e11203aa677f331e493fb\\\"}", "operationId": "063" }, "get": { "summary": "Get Order By ClientOid - Old", "deprecated": true, "description": "Request via this interface to check the information of a single active order via clientOid. The system will send a prompt that the order does not exist if the order does not exist or has been settled.", "tags": [], "parameters": [ { "name": "clientOid", "in": "path", "description": "Unique order ID created by users to identify their orders", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "symbol": { "type": "string" }, "opType": { "type": "string" }, "type": { "type": "string" }, "side": { "type": "string" }, "price": { "type": "string" }, "size": { "type": "string" }, "funds": { "type": "string" }, "dealFunds": { "type": "string" }, "dealSize": { "type": "string" }, "fee": { "type": "string" }, "feeCurrency": { "type": "string" }, "stp": { "type": "string" }, "stop": { "type": "string" }, "stopTriggered": { "type": "boolean" }, "stopPrice": { "type": "string" }, "timeInForce": { "type": "string" }, "postOnly": { "type": "boolean" }, "hidden": { "type": "boolean" }, "iceberg": { "type": "boolean" }, "visibleSize": { "type": "string" }, "cancelAfter": { "type": "integer" }, "channel": { "type": "string" }, "clientOid": { "type": "string" }, "remark": { "type": "string" }, "tags": { "type": "string" }, "isActive": { "type": "boolean" }, "cancelExist": { "type": "boolean" }, "createdAt": { "type": "integer", "format": "int64" }, "tradeType": { "type": "string" }, "tax": { "type": "string" }, "taxRate": { "type": "string" }, "taxCurrency": { "type": "string" } }, "required": [ "id", "symbol", "opType", "type", "side", "price", "size", "funds", "dealFunds", "dealSize", "fee", "feeCurrency", "stp", "stop", "stopTriggered", "stopPrice", "timeInForce", "postOnly", "hidden", "iceberg", "visibleSize", "cancelAfter", "channel", "clientOid", "remark", "tags", "isActive", "cancelExist", "createdAt", "tradeType" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470349", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getOrderByClientOidOld", "x-sdk-method-description": "Request via this interface to check the information of a single active order via clientOid. The system will send a prompt that the order does not exist if the order does not exist or has been settled.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"id\\\": \\\"674a97dfef434f0007efc431\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"opType\\\": \\\"DEAL\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"50000\\\",\\n \\\"size\\\": \\\"0.0001\\\",\\n \\\"funds\\\": \\\"0\\\",\\n \\\"dealFunds\\\": \\\"0\\\",\\n \\\"dealSize\\\": \\\"0\\\",\\n \\\"fee\\\": \\\"0\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stp\\\": \\\"\\\",\\n \\\"stop\\\": \\\"\\\",\\n \\\"stopTriggered\\\": false,\\n \\\"stopPrice\\\": \\\"0\\\",\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": \\\"0\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"clientOid\\\": \\\"3d07008668054da6b3cb12e432c2b13a\\\",\\n \\\"remark\\\": null,\\n \\\"tags\\\": null,\\n \\\"isActive\\\": false,\\n \\\"cancelExist\\\": true,\\n \\\"createdAt\\\": 1732941791518,\\n \\\"tradeType\\\": \\\"TRADE\\\"\\n }\\n}", "x-request-example": "{\\\"clientOid\\\": \\\"3d07008668054da6b3cb12e432c2b13a\\\"}", "operationId": "068" } }, "/api/v1/limit/orders": { "get": { "summary": "Get Recent Orders List - Old", "deprecated": true, "description": "Request your current order list via this endpoint. The return value is the data after Pagination, sorted in descending order according to time.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "symbol": { "type": "string" }, "opType": { "type": "string" }, "type": { "type": "string" }, "side": { "type": "string" }, "price": { "type": "string" }, "size": { "type": "string" }, "funds": { "type": "string" }, "dealFunds": { "type": "string" }, "dealSize": { "type": "string" }, "fee": { "type": "string" }, "feeCurrency": { "type": "string" }, "stp": { "type": "string" }, "stop": { "type": "string" }, "stopTriggered": { "type": "boolean" }, "stopPrice": { "type": "string" }, "timeInForce": { "type": "string" }, "postOnly": { "type": "boolean" }, "hidden": { "type": "boolean" }, "iceberg": { "type": "boolean" }, "visibleSize": { "type": "string" }, "cancelAfter": { "type": "integer" }, "channel": { "type": "string" }, "clientOid": { "type": "string" }, "remark": { "type": "string" }, "tags": { "type": "string" }, "isActive": { "type": "boolean" }, "cancelExist": { "type": "boolean" }, "createdAt": { "type": "integer", "format": "int64" }, "tradeType": { "type": "string" }, "tax": { "type": "string" }, "taxRate": { "type": "string" }, "taxCurrency": { "type": "string" } }, "required": [ "id", "symbol", "opType", "type", "side", "price", "size", "funds", "dealFunds", "dealSize", "fee", "feeCurrency", "stp", "stop", "stopTriggered", "stopPrice", "timeInForce", "postOnly", "hidden", "iceberg", "visibleSize", "cancelAfter", "channel", "clientOid", "remark", "tags", "isActive", "cancelExist", "createdAt", "tradeType" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470347", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getRecentOrdersListOld", "x-sdk-method-description": "Request your current order list via this endpoint. The return value is the data after Pagination, sorted in descending order according to time.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"id\\\": \\\"674a9a872033a50007e2790d\\\",\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"opType\\\": \\\"DEAL\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"price\\\": \\\"50000\\\",\\n \\\"size\\\": \\\"0.00001\\\",\\n \\\"funds\\\": \\\"0\\\",\\n \\\"dealFunds\\\": \\\"0\\\",\\n \\\"dealSize\\\": \\\"0\\\",\\n \\\"fee\\\": \\\"0\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stp\\\": \\\"\\\",\\n \\\"stop\\\": \\\"\\\",\\n \\\"stopTriggered\\\": false,\\n \\\"stopPrice\\\": \\\"0\\\",\\n \\\"timeInForce\\\": \\\"GTC\\\",\\n \\\"postOnly\\\": false,\\n \\\"hidden\\\": false,\\n \\\"iceberg\\\": false,\\n \\\"visibleSize\\\": \\\"0\\\",\\n \\\"cancelAfter\\\": 0,\\n \\\"channel\\\": \\\"API\\\",\\n \\\"clientOid\\\": \\\"5c52e11203aa677f33e4923fb\\\",\\n \\\"remark\\\": \\\"order remarks\\\",\\n \\\"tags\\\": null,\\n \\\"isActive\\\": false,\\n \\\"cancelExist\\\": true,\\n \\\"createdAt\\\": 1732942471752,\\n \\\"tradeType\\\": \\\"TRADE\\\"\\n }\\n ]\\n}", "operationId": "066" } }, "/api/v1/fills": { "get": { "summary": "Get Trade History - Old", "deprecated": true, "description": "Request recent fills via this endpoint. The return value is the data after Pagination, sorted in descending order according to time.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "symbol", "required": true, "schema": { "type": "string", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] } }, { "name": "orderId", "in": "query", "description": "The unique order ID generated by the trading system. (If orderId is specified, please ignore the other query parameters.)", "required": false, "schema": { "type": "string" } }, { "name": "side", "in": "query", "description": "Specify if the order is to 'buy' or 'sell'.", "required": false, "schema": { "type": "string", "enum": [ "buy", "sell" ], "x-api-enum": [ { "value": "buy", "name": "buy", "description": "buy" }, { "value": "sell", "name": "sell", "description": "sell" } ] } }, { "name": "type", "in": "query", "description": "limit, market, limit_stop or market_stop\n", "required": false, "schema": { "type": "string", "enum": [ "limit", "market", "limit_stop", "market_stop" ], "x-api-enum": [ { "value": "limit", "name": "limit", "description": "limit" }, { "value": "market", "name": "market", "description": "market" }, { "value": "limit_stop", "name": "limit_stop", "description": "limit_stop" }, { "value": "market_stop", "name": "market_stop", "description": "market_stop" } ] } }, { "name": "tradeType", "in": "query", "description": "The type of trading: TRADE - Spot Trading (TRADE as default), MARGIN_TRADE - Cross Margin Trading, MARGIN_ISOLATED_TRADE - Isolated Margin Trading.", "required": false, "schema": { "type": "string", "enum": [ "TRADE", "MARGIN_TRADE", "MARGIN_ISOLATED_TRADE" ], "default": "TRADE", "x-api-enum": [ { "value": "TRADE", "name": "TRADE", "description": "Spot Trading" }, { "value": "MARGIN_TRADE", "name": "MARGIN_TRADE", "description": "Cross Margin Trading" }, { "value": "MARGIN_ISOLATED_TRADE", "name": "MARGIN_ISOLATED_TRADE", "description": "Isolated Margin Trading" } ] } }, { "name": "startAt", "in": "query", "description": "Start time (milliseconds)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "endAt", "in": "query", "description": "End time (milliseconds)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "currentPage", "in": "query", "description": "Current request page.", "required": false, "schema": { "type": "integer", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Number of results per request. Minimum is 10, maximum is 500.", "required": false, "schema": { "type": "integer", "minimum": 10, "maximum": 500, "example": [ 50 ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalNum": { "type": "integer" }, "totalPage": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "symbol", "example": [ "BTC-USDT", "ETH-USDT", "KCS-USDT" ] }, "tradeId": { "type": "string" }, "orderId": { "type": "string", "description": "The unique order id generated by the trading system" }, "counterOrderId": { "type": "string", "description": "Counterparty order ID" }, "side": { "type": "string", "description": "Buy or sell" }, "liquidity": { "type": "string", "description": "Liquidity type: taker or maker" }, "forceTaker": { "type": "boolean" }, "price": { "type": "string", "description": "Order Price" }, "size": { "type": "string", "description": "Order Size" }, "funds": { "type": "string", "description": "Order Funds" }, "fee": { "type": "string", "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeRate": { "type": "string", "description": "Fee rate\n" }, "feeCurrency": { "type": "string", "description": "Currency used to calculate trading fee" }, "stop": { "type": "string", "description": "Take Profit and Stop Loss type, currently HFT does not support the Take Profit and Stop Loss type, so it is empty" }, "tradeType": { "type": "string", "description": "Trade type, redundancy param" }, "type": { "type": "string", "description": "Specify if the order is a 'limit' order or 'market' order. " }, "createdAt": { "type": "integer", "format": "int64" } } } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470350", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getTradeHistoryOld", "x-sdk-method-description": "Request recent fills via this endpoint. The return value is the data after Pagination, sorted in descending order according to time.", "x-api-rate-limit-weight": 10, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 50,\\n \\\"totalNum\\\": 1,\\n \\\"totalPage\\\": 1,\\n \\\"items\\\": [\\n {\\n \\\"symbol\\\": \\\"DOGE-USDT\\\",\\n \\\"tradeId\\\": \\\"10862827223795713\\\",\\n \\\"orderId\\\": \\\"6745698ef4f1200007c561a8\\\",\\n \\\"counterOrderId\\\": \\\"6745695ef15b270007ac5076\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"liquidity\\\": \\\"taker\\\",\\n \\\"forceTaker\\\": false,\\n \\\"price\\\": \\\"0.40739\\\",\\n \\\"size\\\": \\\"10\\\",\\n \\\"funds\\\": \\\"4.0739\\\",\\n \\\"fee\\\": \\\"0.0040739\\\",\\n \\\"feeRate\\\": \\\"0.001\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stop\\\": \\\"\\\",\\n \\\"tradeType\\\": \\\"TRADE\\\",\\n \\\"type\\\": \\\"market\\\",\\n \\\"createdAt\\\": 1732602254928\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"orderId\\\": \\\"example_string_default_value\\\", \\\"side\\\": \\\"buy\\\", \\\"type\\\": \\\"limit\\\", \\\"tradeType\\\": \\\"TRADE\\\", \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000, \\\"currentPage\\\": 1, \\\"pageSize\\\": 50}", "operationId": "069" } }, "/api/v1/limit/fills": { "get": { "summary": "Get Recent Trade History - Old", "deprecated": true, "description": "Request a list of 1000 fills in the last 24 hours via this endpoint. The return value is the data after Pagination, sorted in descending order according to time.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string" }, "tradeId": { "type": "string" }, "orderId": { "type": "string" }, "counterOrderId": { "type": "string" }, "side": { "type": "string" }, "liquidity": { "type": "string" }, "forceTaker": { "type": "boolean" }, "price": { "type": "string" }, "size": { "type": "string" }, "funds": { "type": "string" }, "fee": { "type": "string" }, "feeRate": { "type": "string" }, "feeCurrency": { "type": "string" }, "stop": { "type": "string" }, "tradeType": { "type": "string" }, "type": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "tax": { "type": "string" }, "taxCurrency": { "type": "string" }, "taxRate": { "type": "string" } }, "required": [ "symbol", "tradeId", "orderId", "counterOrderId", "side", "liquidity", "forceTaker", "price", "size", "funds", "fee", "feeRate", "feeCurrency", "stop", "tradeType", "type", "createdAt" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470351", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Spot", "x-sdk-sub-service": "Order", "x-sdk-method-name": "getRecentTradeHistoryOld", "x-sdk-method-description": "Request a list of 1000 fills in the last 24 hours via this endpoint. The return value is the data after Pagination, sorted in descending order according to time.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"tradeId\\\": \\\"11732720444522497\\\",\\n \\\"orderId\\\": \\\"674aab24754b1e00077dbc69\\\",\\n \\\"counterOrderId\\\": \\\"674aab1fb26bfb0007a18b67\\\",\\n \\\"side\\\": \\\"buy\\\",\\n \\\"liquidity\\\": \\\"taker\\\",\\n \\\"forceTaker\\\": false,\\n \\\"price\\\": \\\"96999.6\\\",\\n \\\"size\\\": \\\"0.00001\\\",\\n \\\"funds\\\": \\\"0.969996\\\",\\n \\\"fee\\\": \\\"0.000969996\\\",\\n \\\"feeRate\\\": \\\"0.001\\\",\\n \\\"feeCurrency\\\": \\\"USDT\\\",\\n \\\"stop\\\": \\\"\\\",\\n \\\"tradeType\\\": \\\"TRADE\\\",\\n \\\"type\\\": \\\"limit\\\",\\n \\\"createdAt\\\": 1732946724082\\n }\\n ]\\n}", "operationId": "070" } } }, "components": { "schemas": {} } }