{ "openapi": "3.0.1", "info": { "title": "account", "description": "", "version": "1.0.0" }, "tags": [], "paths": { "/api/v2/user-info": { "get": { "summary": "Get Account Summary Info", "deprecated": false, "description": "This endpoint can be used to obtain account summary information.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "level": { "type": "integer", "description": "User VIP level\n" }, "subQuantity": { "type": "integer", "description": "Number of sub-accounts" }, "spotSubQuantity": { "type": "integer", "description": "Number of sub-accounts with spot trading permissions enabled" }, "marginSubQuantity": { "type": "integer", "description": "Number of sub-accounts with margin trading permissions enabled" }, "futuresSubQuantity": { "type": "integer", "description": "Number of sub-accounts with futures trading permissions enabled" }, "optionSubQuantity": { "type": "integer", "description": "Number of sub-accounts with option trading permissions enabled" }, "maxSubQuantity": { "type": "integer", "description": "Max. number of sub-accounts = maxDefaultSubQuantity + maxSpotSubQuantity" }, "maxDefaultSubQuantity": { "type": "integer", "description": "Max. number of default open sub-accounts (according to VIP level)" }, "maxSpotSubQuantity": { "type": "integer", "description": "Max. number of sub-accounts with additional spot trading permissions" }, "maxMarginSubQuantity": { "type": "integer", "description": "Max. number of sub-accounts with additional margin trading permissions" }, "maxFuturesSubQuantity": { "type": "integer", "description": "Max. number of sub-accounts with additional futures trading permissions" }, "maxOptionSubQuantity": { "type": "integer", "description": "Max. number of sub-accounts with additional option trading permissions" } }, "required": [ "level", "subQuantity", "spotSubQuantity", "marginSubQuantity", "futuresSubQuantity", "optionSubQuantity", "maxSubQuantity", "maxDefaultSubQuantity", "maxSpotSubQuantity", "maxMarginSubQuantity", "maxFuturesSubQuantity", "maxOptionSubQuantity" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470119", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getAccountInfo", "x-sdk-method-description": "This endpoint can be used to obtain account summary information.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"level\\\": 0,\\n \\\"subQuantity\\\": 3,\\n \\\"spotSubQuantity\\\": 3,\\n \\\"marginSubQuantity\\\": 2,\\n \\\"futuresSubQuantity\\\": 2,\\n \\\"optionSubQuantity\\\": 0,\\n \\\"maxSubQuantity\\\": 5,\\n \\\"maxDefaultSubQuantity\\\": 5,\\n \\\"maxSpotSubQuantity\\\": 0,\\n \\\"maxMarginSubQuantity\\\": 0,\\n \\\"maxFuturesSubQuantity\\\": 0,\\n \\\"maxOptionSubQuantity\\\": 0\\n }\\n}", "operationId": "001" } }, "/api/v1/user/api-key": { "get": { "summary": "Get Apikey Info", "deprecated": false, "description": "Get the api key information. Use the api key awaiting checking to call the endpoint. Both master and sub user's api key are applicable.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "remark": { "type": "string", "description": "Remarks" }, "apiKey": { "type": "string", "description": "Apikey" }, "apiVersion": { "type": "integer", "description": "API Version" }, "permission": { "type": "string", "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn" }, "ipWhitelist": { "type": "string", "description": "IP whitelist\n\n" }, "createdAt": { "type": "integer", "description": "Apikey create time", "format": "int64" }, "uid": { "type": "integer", "description": "Account UID" }, "isMaster": { "type": "boolean", "description": "Whether it is the master account." }, "subName": { "type": "string", "description": "Sub Name, There is no such param for the master account" } }, "required": [ "remark", "apiKey", "apiVersion", "permission", "createdAt", "uid", "isMaster" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470130", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getApikeyInfo", "x-sdk-method-description": "Get the api key information. Use the api key awaiting checking to call the endpoint. Both master and sub user's api key are applicable.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"remark\\\": \\\"account1\\\",\\n \\\"apiKey\\\": \\\"6705f5c311545b000157d3eb\\\",\\n \\\"apiVersion\\\": 3,\\n \\\"permission\\\": \\\"General,Futures,Spot,Earn,InnerTransfer,Transfer,Margin\\\",\\n \\\"ipWhitelist\\\": \\\"203.**.154,103.**.34\\\",\\n \\\"createdAt\\\": 1728443843000,\\n \\\"uid\\\": 165111215,\\n \\\"isMaster\\\": true\\n }\\n}", "operationId": "002" } }, "/api/v1/hf/accounts/opened": { "get": { "summary": "Get Account Type - Spot ", "deprecated": false, "description": "This interface determines whether the current user is a spot high-frequency user or a spot low-frequency user.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "boolean", "description": "Spot account type. True means the current user is a high-frequency spot user, False means the current user is a low-frequency spot user" } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470120", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getSpotAccountType", "x-sdk-method-description": "This interface determines whether the current user is a spot high-frequency user or a spot low-frequency user.", "x-api-rate-limit-weight": 30, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":false}", "operationId": "003" } }, "/api/v1/accounts": { "get": { "summary": "Get Account List - Spot", "deprecated": false, "description": "Get a list of accounts. Please deposit funds into the main account first, then use the Transfer function to move them to the trade account before trading.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Account type", "required": false, "schema": { "type": "string", "enum": [ "main", "trade", "option" ], "x-api-enum": [ { "value": "main", "name": "main", "description": "Funding account" }, { "value": "trade", "name": "trade", "description": "Spot account" }, { "value": "option", "name": "option", "description": "Option account" } ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Account ID" }, "currency": { "type": "string", "description": "Currency" }, "type": { "type": "string", "description": "Account type: main, trade, isolated (abandon), margin (abandon)\n", "enum": [ "main", "trade" ], "x-api-enum": [ { "value": "main", "name": "main", "description": "Funding account" }, { "value": "trade", "name": "trade", "description": "Spot account" } ] }, "balance": { "type": "string", "description": "Total funds in the account" }, "available": { "type": "string", "description": "Funds available to withdraw or trade" }, "holds": { "type": "string", "description": "Funds on hold (not available for use)" } }, "required": [ "id", "currency", "type", "balance", "available", "holds" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470125", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getSpotAccountList", "x-sdk-method-description": "Get a list of accounts. Please deposit funds into the main account first, then use the Transfer function to move them to the trade account before trading.", "x-api-rate-limit-weight": 5, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"id\\\": \\\"548674591753\\\",\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"type\\\": \\\"trade\\\",\\n \\\"balance\\\": \\\"26.66759503\\\",\\n \\\"available\\\": \\\"26.66759503\\\",\\n \\\"holds\\\": \\\"0\\\"\\n },\\n {\\n \\\"id\\\": \\\"63355cd156298d0001b66e61\\\",\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"type\\\": \\\"main\\\",\\n \\\"balance\\\": \\\"0.01\\\",\\n \\\"available\\\": \\\"0.01\\\",\\n \\\"holds\\\": \\\"0\\\"\\n }\\n ]\\n}", "x-request-example": "{\\\"currency\\\": \\\"USDT\\\", \\\"type\\\": \\\"main\\\"}", "operationId": "004" } }, "/api/v1/accounts/{accountId}": { "get": { "summary": "Get Account Detail - Spot", "deprecated": false, "description": "Get information for a single spot account. Use this endpoint when you know the accountId.", "tags": [], "parameters": [ { "name": "accountId", "in": "path", "description": "Path parameter. Account ID", "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": "The currency of the account" }, "balance": { "type": "string", "description": "Total funds in the account" }, "available": { "type": "string", "description": "Funds available to withdraw or trade" }, "holds": { "type": "string", "description": "Funds on hold (not available for use)" } }, "required": [ "currency", "balance", "available", "holds" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470126", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getSpotAccountDetail", "x-sdk-method-description": "Get information for a single spot account. Use this endpoint when you know the accountId.", "x-api-rate-limit-weight": 5, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"currency\\\":\\\"USDT\\\",\\\"balance\\\":\\\"26.66759503\\\",\\\"available\\\":\\\"26.66759503\\\",\\\"holds\\\":\\\"0\\\"}}", "x-request-example": "{\\\"accountId\\\": \\\"548674591753\\\"}", "operationId": "005" } }, "/api/v3/margin/accounts": { "get": { "summary": "Get Account - Cross Margin", "deprecated": false, "description": "Request cross margin account info via this endpoint.", "tags": [], "parameters": [ { "name": "quoteCurrency", "in": "query", "description": "quote currency, currently only supports USDT, KCS, BTC, USDT as default", "required": false, "schema": { "type": "string", "default": "USDT", "enum": [ "USDT", "KCS", "BTC" ], "x-api-enum": [ { "value": "USDT", "name": "", "description": "" }, { "value": "KCS", "name": "", "description": "" }, { "value": "BTC", "name": "", "description": "" } ] } }, { "name": "queryType", "in": "query", "description": "Query account type (default MARGIN), MARGIN - only query low frequency cross margin account, MARGIN_V2-only query high frequency cross margin account, ALL - consistent aggregate query with the web side", "required": false, "schema": { "type": "string", "default": "MARGIN", "enum": [ "MARGIN", "MARGIN_V2", "ALL" ], "x-api-enum": [ { "value": "MARGIN", "name": "", "description": "" }, { "value": "MARGIN_V2", "name": "", "description": "" }, { "value": "ALL", "name": "", "description": "" } ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "totalAssetOfQuoteCurrency": { "type": "string", "description": "Total Assets in Quote Currency" }, "totalLiabilityOfQuoteCurrency": { "type": "string", "description": "Total Liability in Quote Currency" }, "debtRatio": { "type": "string", "description": "debt ratio" }, "status": { "type": "string", "description": "Position status; EFFECTIVE-effective, BANKRUPTCY-bankruptcy liquidation, LIQUIDATION-closing, REPAY-repayment, BORROW-borrowing" }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "currency" }, "total": { "type": "string", "description": "Total Assets" }, "available": { "type": "string", "description": "Account available assets (total assets - frozen)" }, "hold": { "type": "string", "description": "Account frozen assets" }, "liability": { "type": "string", "description": "Liabilities" }, "maxBorrowSize": { "type": "string", "description": "The user's remaining maximum loan amount" }, "borrowEnabled": { "type": "boolean", "description": "Support borrow or not" }, "transferInEnabled": { "type": "boolean", "description": "Support transfer or not" }, "liabilityPrincipal": { "type": "string", "description": "Outstanding principal – the unpaid loan amount" }, "liabilityInterest": { "type": "string", "description": "Accrued interest – the unpaid interest amount" } }, "required": [ "currency", "total", "available", "hold", "liability", "liabilityPrincipal", "liabilityInterest", "maxBorrowSize", "borrowEnabled", "transferInEnabled" ] }, "description": "Margin account list" } }, "required": [ "totalAssetOfQuoteCurrency", "totalLiabilityOfQuoteCurrency", "debtRatio", "status", "accounts" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470127", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getCrossMarginAccount", "x-sdk-method-description": "Request cross margin account info via this endpoint.", "x-api-rate-limit-weight": 15, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"totalAssetOfQuoteCurrency\\\": \\\"40.8648372\\\",\\n \\\"totalLiabilityOfQuoteCurrency\\\": \\\"0\\\",\\n \\\"debtRatio\\\": \\\"0\\\",\\n \\\"status\\\": \\\"EFFECTIVE\\\",\\n \\\"accounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"total\\\": \\\"38.68855864\\\",\\n \\\"available\\\": \\\"20.01916691\\\",\\n \\\"hold\\\": \\\"18.66939173\\\",\\n \\\"liability\\\": \\\"0\\\",\\n \\\"liabilityPrincipal\\\": \\\"0\\\",\\n \\\"liabilityInterest\\\": \\\"0\\\",\\n \\\"maxBorrowSize\\\": \\\"163\\\",\\n \\\"borrowEnabled\\\": true,\\n \\\"transferInEnabled\\\": true\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"quoteCurrency\\\": \\\"USDT\\\", \\\"queryType\\\": \\\"MARGIN\\\"}", "operationId": "006" } }, "/api/v3/isolated/accounts": { "get": { "summary": "Get Account - Isolated Margin", "deprecated": false, "description": "Request isolated margin account info via this endpoint.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "For isolated trading pairs, query all without passing", "required": false, "schema": { "type": "string" } }, { "name": "quoteCurrency", "in": "query", "description": "quote currency, currently only supports USDT, KCS, BTC, USDT as default", "required": false, "schema": { "type": "string", "default": "USDT", "enum": [ "USDT", "KCS", "BTC" ], "x-api-enum": [ { "value": "USDT", "name": "", "description": "" }, { "value": "KCS", "name": "", "description": "" }, { "value": "BTC", "name": "", "description": "" } ] } }, { "name": "queryType", "in": "query", "description": "Query account type (default ISOLATED), ISOLATED- - only query low frequency isolated margin account, ISOLATED_V2-only query high frequency isolated margin account, ALL - consistent aggregate query with the web side", "required": false, "schema": { "type": "string", "default": "ISOLATED", "enum": [ "ISOLATED", "ISOLATED_V2", "ALL" ], "x-api-enum": [ { "value": "ISOLATED", "name": "", "description": "" }, { "value": "ISOLATED_V2", "name": "", "description": "" }, { "value": "ALL", "name": "", "description": "" } ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "totalAssetOfQuoteCurrency": { "type": "string", "description": "Total Assets in Quote Currency" }, "totalLiabilityOfQuoteCurrency": { "type": "string", "description": "Total Liability in Quote Currency" }, "timestamp": { "type": "integer", "description": "timestamp", "format": "int64" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Symbol" }, "status": { "type": "string", "description": "Position status; EFFECTIVE-effective, BANKRUPTCY-bankruptcy liquidation, LIQUIDATION-closing, REPAY-repayment, BORROW-borrowing" }, "debtRatio": { "type": "string", "description": "debt ratio" }, "baseAsset": { "type": "object", "properties": { "currency": { "type": "string", "description": "currency" }, "borrowEnabled": { "type": "boolean", "description": "Support borrow or not" }, "transferInEnabled": { "type": "boolean", "description": "Support transfer or not" }, "liability": { "type": "string", "description": "Liabilities" }, "total": { "type": "string", "description": "Total Assets" }, "available": { "type": "string", "description": "Account available assets (total assets - frozen)" }, "hold": { "type": "string", "description": "Account frozen assets" }, "maxBorrowSize": { "type": "string", "description": "The user's remaining maximum loan amount" }, "liabilityPrincipal": { "type": "string", "description": "Outstanding principal" }, "liabilityInterest": { "type": "string", "description": "Outstanding interest" } }, "required": [ "currency", "borrowEnabled", "transferInEnabled", "liability", "liabilityPrincipal", "liabilityInterest", "total", "available", "hold", "maxBorrowSize" ], "description": "base asset" }, "quoteAsset": { "type": "object", "properties": { "currency": { "type": "string", "description": "currency" }, "borrowEnabled": { "type": "boolean", "description": "Support borrow or not" }, "transferInEnabled": { "type": "boolean", "description": "Support transfer or not" }, "liability": { "type": "string", "description": "Liabilities" }, "total": { "type": "string", "description": "Total Assets" }, "available": { "type": "string", "description": "Account available assets (total assets - frozen)" }, "hold": { "type": "string", "description": "Account frozen assets" }, "maxBorrowSize": { "type": "string", "description": "The user's remaining maximum loan amount" }, "liabilityPrincipal": { "type": "string" }, "liabilityInterest": { "type": "string" } }, "required": [ "currency", "borrowEnabled", "transferInEnabled", "liability", "liabilityPrincipal", "liabilityInterest", "total", "available", "hold", "maxBorrowSize" ], "description": "quote asset" } } } } }, "required": [ "totalAssetOfQuoteCurrency", "totalLiabilityOfQuoteCurrency", "timestamp", "assets" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470128", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getIsolatedMarginAccount", "x-sdk-method-description": "Request isolated margin account info via this endpoint.", "x-api-rate-limit-weight": 15, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"totalAssetOfQuoteCurrency\\\": \\\"4.97047372\\\",\\n \\\"totalLiabilityOfQuoteCurrency\\\": \\\"0.00038891\\\",\\n \\\"timestamp\\\": 1747303659773,\\n \\\"assets\\\": [\\n {\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"status\\\": \\\"EFFECTIVE\\\",\\n \\\"debtRatio\\\": \\\"0\\\",\\n \\\"baseAsset\\\": {\\n \\\"currency\\\": \\\"BTC\\\",\\n \\\"borrowEnabled\\\": true,\\n \\\"transferInEnabled\\\": true,\\n \\\"liability\\\": \\\"0\\\",\\n \\\"liabilityPrincipal\\\": \\\"0\\\",\\n \\\"liabilityInterest\\\": \\\"0\\\",\\n \\\"total\\\": \\\"0\\\",\\n \\\"available\\\": \\\"0\\\",\\n \\\"hold\\\": \\\"0\\\",\\n \\\"maxBorrowSize\\\": \\\"0\\\"\\n },\\n \\\"quoteAsset\\\": {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"borrowEnabled\\\": true,\\n \\\"transferInEnabled\\\": true,\\n \\\"liability\\\": \\\"0.00038891\\\",\\n \\\"liabilityPrincipal\\\": \\\"0.00038888\\\",\\n \\\"liabilityInterest\\\": \\\"0.00000003\\\",\\n \\\"total\\\": \\\"4.97047372\\\",\\n \\\"available\\\": \\\"4.97047372\\\",\\n \\\"hold\\\": \\\"0\\\",\\n \\\"maxBorrowSize\\\": \\\"44\\\"\\n }\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"BTC-USDT\\\", \\\"quoteCurrency\\\": \\\"USDT\\\", \\\"queryType\\\": \\\"ISOLATED\\\"}", "operationId": "007" } }, "/api/v1/account-overview": { "get": { "summary": "Get Account - Futures", "deprecated": false, "description": "Request futures account info via this endpoint.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "Currency, Default XBT", "required": false, "schema": { "type": "string", "default": "XBT", "example": [ "USDT", "USDC", "XBT", "ETH" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "accountEquity": { "type": "number", "description": "Account equity = marginBalance + unrealizedPNL" }, "unrealisedPNL": { "type": "number", "description": "Unrealized profit and loss" }, "marginBalance": { "type": "number", "description": "Margin balance = positionMargin + orderMargin + frozenFunds + availableBalance - unrealizedPNL" }, "positionMargin": { "type": "number", "description": "Position margin" }, "orderMargin": { "type": "number", "description": "Order margin" }, "frozenFunds": { "type": "number", "description": "Frozen funds for out-transfer" }, "availableBalance": { "type": "number", "description": "Available balance" }, "currency": { "type": "string", "description": "Currency", "example": [ "XBT", "USDT", "ETH" ] }, "riskRatio": { "type": "number", "description": "Cross margin risk rate" }, "maxWithdrawAmount": { "type": "number", "description": "Maximum amount that can be withdrawn/transferred." } }, "required": [ "accountEquity", "unrealisedPNL", "marginBalance", "positionMargin", "orderMargin", "frozenFunds", "availableBalance", "currency", "riskRatio", "maxWithdrawAmount" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470129", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", "x-api-permission": "Futures", "x-api-rate-limit-pool": "Futures", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getFuturesAccount", "x-sdk-method-description": "Request futures account info via this endpoint.", "x-api-rate-limit-weight": 5, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"accountEquity\\\": 394.439280806,\\n \\\"unrealisedPNL\\\": 20.15278,\\n \\\"marginBalance\\\": 371.394298816,\\n \\\"positionMargin\\\": 102.20664159,\\n \\\"orderMargin\\\": 10.06002012,\\n \\\"frozenFunds\\\": 0.0,\\n \\\"availableBalance\\\": 290.326799096,\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"riskRatio\\\": 0.0065289525,\\n \\\"maxWithdrawAmount\\\": 290.326419096\\n }\\n}", "x-request-example": "{\\\"currency\\\": \\\"USDT\\\"}", "operationId": "008" } }, "/api/v1/accounts/ledgers": { "get": { "summary": "Get Account Ledgers - Spot/Margin", "deprecated": false, "description": "This interface is for transaction records from all your account types, supporting various currency inquiries. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "Currency (you can choose more than one currency). You can specify a max. of 10 currencies in one go. If not specified, all currencies will be queried by default.", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "direction: in, out", "required": false, "schema": { "type": "string", "enum": [ "in", "out" ], "x-api-enum": [ { "value": "in", "name": "in", "description": "Funds in" }, { "value": "out", "name": "out", "description": "Funds out" } ] } }, { "name": "bizType", "in": "query", "description": "Type: DEPOSIT-deposit, WITHDRAW-withdraw, TRANSFER-transfer, SUB_TRANSFER-sub-account transfer, TRADE_EXCHANGE-trade, MARGIN_EXCHANGE-margin trade, KUCOIN_BONUS-bonus, BROKER_TRANSFER-Broker transfer record", "required": false, "schema": { "type": "string" } }, { "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", "description": "current page" }, "pageSize": { "type": "integer", "description": "page size" }, "totalNum": { "type": "integer", "description": "total number" }, "totalPage": { "type": "integer", "description": "total pages" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "unique id" }, "currency": { "type": "string", "description": "Currency" }, "amount": { "type": "string", "description": "The total amount of assets (fees included) involved in assets changes such as transactions, withdrawals and bonus distributions." }, "fee": { "type": "string", "description": "Fees generated in transaction, withdrawal, etc." }, "balance": { "type": "string", "description": "Remaining funds after the transaction. (Deprecated field, no actual use of the value field)" }, "accountType": { "type": "string", "description": "Master user account types: MAIN, TRADE, MARGIN or CONTRACT." }, "bizType": { "type": "string", "description": "Business type leading to changes in funds, such as exchange, withdrawal, deposit, KUCOIN_BONUS, REFERRAL_BONUS, Lendings, etc." }, "direction": { "type": "string", "description": "Side, out or in" }, "createdAt": { "type": "integer", "description": "Time of event", "format": "int64" }, "context": { "type": "string", "description": "Business related information such as order ID, serial no., etc." } } } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470121", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getSpotLedger", "x-sdk-method-description": "This interface is for transaction records from all your account types, supporting various currency inquiries. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.", "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\\\": \\\"265329987780896\\\",\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"amount\\\": \\\"0.01\\\",\\n \\\"fee\\\": \\\"0\\\",\\n \\\"balance\\\": \\\"0\\\",\\n \\\"accountType\\\": \\\"TRADE\\\",\\n \\\"bizType\\\": \\\"SUB_TRANSFER\\\",\\n \\\"direction\\\": \\\"out\\\",\\n \\\"createdAt\\\": 1728658481484,\\n \\\"context\\\": \\\"\\\"\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"direction\\\": \\\"in\\\", \\\"bizType\\\": \\\"TRANSFER\\\", \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000, \\\"currentPage\\\": 1, \\\"pageSize\\\": 50}", "operationId": "009" } }, "/api/v1/hf/accounts/ledgers": { "get": { "summary": "Get Account Ledgers - Trade_hf", "deprecated": false, "description": "This API endpoint returns all transfer (in and out) records in high-frequency trading accounts and supports multi-coin queries. The query results are sorted in descending order by createdAt and ID.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "Currency (you can choose more than one currency). You can specify a max. of 10 currencies in one go. If not specified, all currencies will be queried by default.", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "direction: in, out", "required": false, "schema": { "type": "string", "enum": [ "in", "out" ], "x-api-enum": [ { "value": "in", "name": "", "description": "" }, { "value": "out", "name": "", "description": "" } ] } }, { "name": "bizType", "in": "query", "description": "Transaction type", "required": false, "schema": { "type": "string", "enum": [ "TRADE_EXCHANGE", "TRANSFER", "SUB_TRANSFER", "RETURNED_FEES", "DEDUCTION_FEES", "OTHER" ], "x-api-enum": [ { "value": "TRADE_EXCHANGE", "name": "TRADE_EXCHANGE", "description": "Trade exchange" }, { "value": "TRANSFER", "name": "TRANSFER", "description": "Transfer" }, { "value": "SUB_TRANSFER", "name": "SUB_TRANSFER", "description": "Sub transfer" }, { "value": "RETURNED_FEES", "name": "RETURNED_FEES", "description": "Returned fees" }, { "value": "DEDUCTION_FEES", "name": "DEDUCTION_FEES", "description": "Deduction fees" }, { "value": "OTHER", "name": "OTHER", "description": "Other" } ] } }, { "name": "lastId", "in": "query", "description": "The ID of the last set of data from the previous data batch. By default, the latest information is given.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "Default100, Max200", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 200, "minimum": 1 } }, { "name": "startAt", "in": "query", "description": "Start time (milliseconds)", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 9999999999999, "minimum": 0 } }, { "name": "endAt", "in": "query", "description": "End time (milliseconds)", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 9999999999999, "minimum": 0 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID" }, "currency": { "type": "string", "description": "currency" }, "amount": { "type": "string", "description": "Change in funds balance" }, "fee": { "type": "string", "description": "Transaction, Deposit or withdrawal fee" }, "tax": { "type": "string" }, "balance": { "type": "string", "description": "Total balance of funds after change" }, "accountType": { "type": "string", "description": "Master account type TRADE_HF" }, "bizType": { "type": "string", "description": "Trnasaction type, such as TRANSFER, TRADE_EXCHANGE, etc." }, "direction": { "type": "string", "description": "Direction of transfer (out or in)", "enum": [ "in", "out" ], "x-api-enum": [ { "value": "in", "name": "", "description": "" }, { "value": "out", "name": "", "description": "" } ] }, "createdAt": { "type": "string", "description": "Created time" }, "context": { "type": "string", "description": "Core transaction parameter" } }, "required": [ "id", "currency", "amount", "fee", "tax", "balance", "accountType", "bizType", "direction", "createdAt", "context" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470122", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getSpotHFLedger", "x-sdk-method-description": "This API endpoint returns all transfer (in and out) records in high-frequency trading accounts and supports multi-coin queries. The query results are sorted in descending order by createdAt and ID.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"id\\\": \\\"254062248624417\\\",\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"amount\\\": \\\"1.59760080\\\",\\n \\\"fee\\\": \\\"0.00159920\\\",\\n \\\"tax\\\": \\\"0\\\",\\n \\\"balance\\\": \\\"26.73759503\\\",\\n \\\"accountType\\\": \\\"TRADE_HF\\\",\\n \\\"bizType\\\": \\\"TRADE_EXCHANGE\\\",\\n \\\"direction\\\": \\\"in\\\",\\n \\\"createdAt\\\": \\\"1728443957539\\\",\\n \\\"context\\\": \\\"{\\\\\\\"symbol\\\\\\\":\\\\\\\"KCS-USDT\\\\\\\",\\\\\\\"orderId\\\\\\\":\\\\\\\"6705f6350dc7210007d6a36d\\\\\\\",\\\\\\\"tradeId\\\\\\\":\\\\\\\"10046097631627265\\\\\\\"}\\\"\\n }\\n ]\\n}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"direction\\\": \\\"in\\\", \\\"bizType\\\": \\\"TRANSFER\\\", \\\"lastId\\\": 254062248624417, \\\"limit\\\": 100, \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000}", "operationId": "010" } }, "/api/v3/hf/margin/account/ledgers": { "get": { "summary": "Get Account Ledgers - Margin_hf", "deprecated": false, "description": "This API endpoint returns all transfer (in and out) records in high-frequency margin trading accounts and supports multi-coin queries. The query results are sorted in descending order by createdAt and ID.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "Currency optional; more than one can be selected; separate using commas; select no more than 10 currencies; the default will be to query for all currencies if left empty", "required": false, "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "direction: in, out", "required": false, "schema": { "type": "string", "enum": [ "in", "out" ], "x-api-enum": [ { "value": "in", "name": "", "description": "" }, { "value": "out", "name": "", "description": "" } ] } }, { "name": "bizType", "in": "query", "description": "Transaction type: TRANSFER- transfer funds, MARGIN_EXCHANGE-cross margin trade, ISOLATED_EXCHANGE-isolated margin trade, LIQUIDATION-liquidation, ASSERT_RETURN-forced liquidation asset return", "required": false, "schema": { "type": "string" } }, { "name": "lastId", "in": "query", "description": "The ID of the last set of data from the previous data batch. By default, the latest information is given.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "Default100, Max200", "required": false, "schema": { "type": "integer", "default": 100, "maximum": 200, "minimum": 1 } }, { "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" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "currency" }, "amount": { "type": "string", "description": "Change in funds balance" }, "fee": { "type": "string", "description": "Transaction, Deposit or withdrawal fee" }, "balance": { "type": "string", "description": "Total balance of funds after change" }, "accountType": { "type": "string", "description": "Master account type TRADE_HF" }, "bizType": { "type": "string", "description": "Trnasaction type, such as TRANSFER, TRADE_EXCHANGE, etc." }, "direction": { "type": "string", "description": "Direction of transfer (out or in)" }, "createdAt": { "type": "integer", "description": "Ledger creation time", "format": "int64" }, "context": { "type": "string", "description": "Core transaction parameter" }, "tax": { "type": "string" } } } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470123", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getMarginHFLedger", "x-sdk-method-description": "This API endpoint returns all transfer (in and out) records in high-frequency margin trading accounts and supports multi-coin queries. The query results are sorted in descending order by createdAt and ID.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":[{\\\"id\\\":1949641706720,\\\"currency\\\":\\\"USDT\\\",\\\"amount\\\":\\\"0.01000000\\\",\\\"fee\\\":\\\"0.00000000\\\",\\\"balance\\\":\\\"0.01000000\\\",\\\"accountType\\\":\\\"MARGIN_V2\\\",\\\"bizType\\\":\\\"TRANSFER\\\",\\\"direction\\\":\\\"in\\\",\\\"createdAt\\\":1728664091208,\\\"context\\\":\\\"{}\\\",\\\"tax\\\":\\\"0.00000000\\\"}]}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"direction\\\": \\\"in\\\", \\\"bizType\\\": \\\"TRANSFER\\\", \\\"lastId\\\": 254062248624417, \\\"limit\\\": 100, \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000}", "operationId": "011" } }, "/api/v1/transaction-history": { "get": { "summary": "Get Account Ledgers - Futures", "deprecated": false, "description": "This interface can query the ledger records of the futures business line.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "Currency of transaction history, XBT or USDT", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type RealizedPNL-Realized profit and loss, Deposit-Deposit, Withdrawal-withdraw, Transferin-Transfer in, TransferOut-Transfer out", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Start offset. Generally, only the attributes of the last returned result of the previous request are used, and the first page is returned by default", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "forward", "in": "query", "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default.", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "maxCount", "in": "query", "description": "Displayed size per page. The default size is 50", "required": false, "schema": { "type": "integer", "default": 50, "format": "int64" } }, { "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" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "dataList": { "type": "array", "items": { "type": "object", "properties": { "time": { "type": "integer", "description": "Ledger time", "format": "int64" }, "type": { "type": "string", "description": "Type: RealisedPNL, Deposit, Withdrawal, TransferIn, TransferOut" }, "amount": { "type": "number", "description": "Transaction amount" }, "fee": { "type": "number", "description": "Fee" }, "accountEquity": { "type": "number", "description": "Account equity" }, "status": { "type": "string", "description": "Status: Completed, Pending" }, "remark": { "type": "string", "description": "Ticker symbol of the contract" }, "offset": { "type": "integer", "description": "Offset" }, "currency": { "type": "string", "description": "Currency" } }, "required": [ "time", "type", "amount", "fee", "accountEquity", "status", "remark", "offset", "currency" ] } }, "hasMore": { "type": "boolean", "description": "Is it the last page? If it is false, it means it is the last page, and if it is true, it means you need to move to the next page." } }, "required": [ "dataList", "hasMore" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470124", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Futures", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getFuturesLedger", "x-sdk-method-description": "This interface can query the ledger records of the futures business line.", "x-api-rate-limit-weight": 2, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"dataList\\\": [\\n {\\n \\\"time\\\": 1728665747000,\\n \\\"type\\\": \\\"TransferIn\\\",\\n \\\"amount\\\": 0.01,\\n \\\"fee\\\": 0.0,\\n \\\"accountEquity\\\": 14.02924938,\\n \\\"status\\\": \\\"Completed\\\",\\n \\\"remark\\\": \\\"Transferred from High-Frequency Trading Account\\\",\\n \\\"offset\\\": 51360793,\\n \\\"currency\\\": \\\"USDT\\\"\\n },\\n {\\n \\\"time\\\": 1728648000000,\\n \\\"type\\\": \\\"RealisedPNL\\\",\\n \\\"amount\\\": 0.00630042,\\n \\\"fee\\\": 0.0,\\n \\\"accountEquity\\\": 20.0,\\n \\\"status\\\": \\\"Completed\\\",\\n \\\"remark\\\": \\\"XBTUSDTM\\\",\\n \\\"offset\\\": 51352430,\\n \\\"currency\\\": \\\"USDT\\\"\\n }\\n ],\\n \\\"hasMore\\\": false\\n }\\n}", "x-request-example": "{\\\"currency\\\": \\\"XBT\\\", \\\"type\\\": \\\"Transferin\\\", \\\"offset\\\": 254062248624417, \\\"forward\\\": true, \\\"maxCount\\\": 50, \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000}", "operationId": "012" } }, "/api/v2/sub/user/created": { "post": { "summary": "Add sub-account", "deprecated": false, "description": "This endpoint can be used to create sub-accounts.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "uid": { "type": "integer", "description": "Sub account user id" }, "subName": { "type": "string", "description": "Sub account name" }, "remarks": { "type": "string", "description": "Sub account name" }, "access": { "type": "string", "description": "permission" } }, "required": [ "uid", "subName", "remarks", "access" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470135", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "addSubAccount", "x-sdk-method-description": "This endpoint can be used to create sub-accounts.", "x-api-rate-limit-weight": 15, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "password": { "type": "string", "description": "Password (7–24 characters, must contain letters and numbers, cannot only contain numbers or include special characters)" }, "remarks": { "type": "string", "description": "Remarks (1–24 characters)" }, "subName": { "type": "string", "description": "Sub-account name (must contain 7–32 characters, at least one number and one letter. Cannot contain any spaces.)" }, "access": { "type": "string", "description": "Permission (types include Spot, Futures, Margin permissions, which can be used alone or in combination).", "enum": [ "Spot", "Futures", "Margin" ], "x-api-enum": [ { "value": "Spot", "name": "", "description": "Spot Account" }, { "value": "Futures", "name": "", "description": "Futures Account" }, { "value": "Margin", "name": "", "description": "Margin Account" } ] } }, "required": [ "password", "subName", "access" ] }, "example": "{\n \"password\": \"q1234567\",\n \"access\": \"Spot\",\n \"subName\": \"subNameTest1\",\n \"remarks\": \"TheRemark\"\n}" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"uid\\\": 245730746,\\n \\\"subName\\\": \\\"subNameTest1\\\",\\n \\\"remarks\\\": \\\"TheRemark\\\",\\n \\\"access\\\": \\\"Spot\\\"\\n }\\n}", "x-request-example": "{\\\"password\\\": \\\"q1234567\\\", \\\"access\\\": \\\"Spot\\\", \\\"subName\\\": \\\"subNameTest1\\\", \\\"remarks\\\": \\\"TheRemark\\\"}", "operationId": "013" } }, "/api/v3/sub/user/margin/enable": { "post": { "summary": "Add sub-account Margin Permission", "deprecated": false, "description": "This endpoint can be used to add sub-account Margin permissions. Before using this endpoint, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated.", "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-3470331", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Margin", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "addSubAccountMarginPermission", "x-sdk-method-description": "This endpoint can be used to add sub-account Margin permissions. Before using this endpoint, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated.", "x-api-rate-limit-weight": 15, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "uid": { "type": "string", "description": "Sub account UID" } }, "required": [ "uid" ] }, "example": "{\n \"uid\": \"169579801\"\n}" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": null\\n}", "x-request-example": "{\\\"uid\\\": \\\"169579801\\\"}", "operationId": "014" } }, "/api/v3/sub/user/futures/enable": { "post": { "summary": "Add sub-account Futures Permission", "deprecated": false, "description": "This endpoint can be used to add sub-account Futures permissions. Before using this endpoint, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "boolean" } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470332", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Futures", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "addSubAccountFuturesPermission", "x-sdk-method-description": "This endpoint can be used to add sub-account Futures permissions. Before using this endpoint, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated.", "x-api-rate-limit-weight": 15, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "uid": { "type": "string", "description": "Sub account UID" } }, "required": [ "uid" ] }, "example": "{\n \"uid\": \"169579801\"\n}" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": null\\n}", "x-request-example": "{\\\"uid\\\": \\\"169579801\\\"}", "operationId": "015" } }, "/api/v2/sub/user": { "get": { "summary": "Get sub-account List - Summary Info", "deprecated": false, "description": "This endpoint can be used to get a paginated list of sub-accounts. Pagination is required.", "tags": [], "parameters": [ { "name": "currentPage", "in": "query", "description": "Current request page. Default is 1", "required": false, "schema": { "type": "integer" } }, { "name": "pageSize", "in": "query", "description": "Number of results per request. Minimum is 1, maximum is 100, default is 10.", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer", "description": "Current request page" }, "pageSize": { "type": "integer", "description": "Number of results per request. Minimum is 1, maximum is 100" }, "totalNum": { "type": "integer", "description": "Total number of messages" }, "totalPage": { "type": "integer", "description": "Total number of pages" }, "items": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string", "description": "Sub-account User ID" }, "uid": { "type": "integer", "description": "Sub-account UID" }, "subName": { "type": "string", "description": "Sub-account name" }, "status": { "type": "integer", "description": "Sub-account; 2:Enable, 3:Frozen", "enum": [ 2, 3 ], "x-api-enum": [ { "value": 2, "name": "", "description": "Enable" }, { "value": 3, "name": "", "description": "Frozen" } ] }, "type": { "type": "integer", "description": "Sub-account type", "enum": [ 0, 1, 2, 5 ], "x-api-enum": [ { "value": 0, "name": "NORMAL", "description": "Normal sub-account" }, { "value": 1, "name": "ROBOT", "description": "Robot sub-account" }, { "value": 2, "name": "Novice", "description": "New financial sub-account" }, { "value": 5, "name": "HOSTED", "description": "Asset management sub-account" } ] }, "access": { "type": "string", "description": "Sub-account Permission" }, "createdAt": { "type": "integer", "description": "Time of event", "format": "int64" }, "remarks": { "type": "string", "description": "Remarks" }, "tradeTypes": { "type": "array", "items": { "type": "string" }, "description": "Sub-account Permissions" }, "openedTradeTypes": { "type": "array", "items": { "type": "string" }, "description": "Sub-account active permissions: If you do not have the corresponding permissions, you must log in to the sub-account and go to the corresponding web page to activate." }, "hostedStatus": { "type": "string" } }, "required": [ "userId", "uid", "subName", "status", "type", "access", "createdAt", "remarks", "tradeTypes", "openedTradeTypes", "hostedStatus" ] } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470131", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "getSpotSubAccountsSummaryV2", "x-sdk-method-description": "This endpoint can be used to get a paginated list of sub-accounts. Pagination is required.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 10,\\n \\\"totalNum\\\": 1,\\n \\\"totalPage\\\": 1,\\n \\\"items\\\": [\\n {\\n \\\"userId\\\": \\\"63743f07e0c5230001761d08\\\",\\n \\\"uid\\\": 169579801,\\n \\\"subName\\\": \\\"testapi6\\\",\\n \\\"status\\\": 2,\\n \\\"type\\\": 0,\\n \\\"access\\\": \\\"All\\\",\\n \\\"createdAt\\\": 1668562696000,\\n \\\"remarks\\\": \\\"remarks\\\",\\n \\\"tradeTypes\\\": [\\n \\\"Spot\\\",\\n \\\"Futures\\\",\\n \\\"Margin\\\"\\n ],\\n \\\"openedTradeTypes\\\": [\\n \\\"Spot\\\"\\n ],\\n \\\"hostedStatus\\\": null\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"currentPage\\\": 1, \\\"pageSize\\\": 10}", "operationId": "016" } }, "/api/v1/sub-accounts/{subUserId}": { "get": { "summary": "Get sub-account Detail - Balance", "deprecated": false, "description": "This endpoint returns the account info of a sub-user specified by the subUserId.", "tags": [], "parameters": [ { "name": "subUserId", "in": "path", "description": "the userID of a sub-account.", "required": true, "schema": { "type": "string" } }, { "name": "includeBaseAmount", "in": "query", "description": "False: Do not display currencies with 0 assets; True: display all currencies", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "baseCurrency", "in": "query", "description": "Specify the currency used to convert assets", "required": false, "schema": { "type": "string" } }, { "name": "baseAmount", "in": "query", "description": "The currency balance specified must be greater than or equal to the amount", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "subUserId": { "type": "string", "description": "The user ID of a sub-user." }, "subName": { "type": "string", "description": "The username of a sub-user." }, "mainAccounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency" }, "balance": { "type": "string", "description": "Total funds in an account." }, "available": { "type": "string", "description": "Funds available to withdraw or trade." }, "holds": { "type": "string", "description": "Funds on hold (not available for use)." }, "baseCurrency": { "type": "string", "description": "Calculated on this currency." }, "baseCurrencyPrice": { "type": "string", "description": "The base currency price." }, "baseAmount": { "type": "string", "description": "The base currency amount." }, "tag": { "type": "string" } } }, "description": "Funding Account" }, "tradeAccounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency" }, "balance": { "type": "string", "description": "Total funds in an account." }, "available": { "type": "string", "description": "Funds available to withdraw or trade." }, "holds": { "type": "string", "description": "Funds on hold (not available for use)." }, "baseCurrency": { "type": "string", "description": "Calculated on this currency." }, "baseCurrencyPrice": { "type": "string", "description": "The base currency price." }, "baseAmount": { "type": "string", "description": "The base currency amount." }, "tag": { "type": "string" } } }, "description": "Spot Account" }, "marginAccounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency" }, "balance": { "type": "string", "description": "Total funds in an account." }, "available": { "type": "string", "description": "Funds available to withdraw or trade." }, "holds": { "type": "string", "description": "Funds on hold (not available for use)." }, "baseCurrency": { "type": "string", "description": "Calculated on this currency." }, "baseCurrencyPrice": { "type": "string", "description": "The base currency price." }, "baseAmount": { "type": "string", "description": "The base currency amount." }, "tag": { "type": "string" } } }, "description": "Margin Account" }, "tradeHFAccounts": { "type": "array", "items": { "type": "string" }, "description": "This param is deprecated and only valid for some old users" } }, "required": [ "subUserId", "subName", "mainAccounts", "tradeAccounts", "marginAccounts", "tradeHFAccounts" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470132", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "getSpotSubAccountDetail", "x-sdk-method-description": "This endpoint returns the account info of a sub-user specified by the subUserId.", "x-api-rate-limit-weight": 15, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"subUserId\\\": \\\"63743f07e0c5230001761d08\\\",\\n \\\"subName\\\": \\\"testapi6\\\",\\n \\\"mainAccounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"balance\\\": \\\"0.01\\\",\\n \\\"available\\\": \\\"0.01\\\",\\n \\\"holds\\\": \\\"0\\\",\\n \\\"baseCurrency\\\": \\\"BTC\\\",\\n \\\"baseCurrencyPrice\\\": \\\"62384.3\\\",\\n \\\"baseAmount\\\": \\\"0.00000016\\\",\\n \\\"tag\\\": \\\"DEFAULT\\\"\\n }\\n ],\\n \\\"tradeAccounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"balance\\\": \\\"0.01\\\",\\n \\\"available\\\": \\\"0.01\\\",\\n \\\"holds\\\": \\\"0\\\",\\n \\\"baseCurrency\\\": \\\"BTC\\\",\\n \\\"baseCurrencyPrice\\\": \\\"62384.3\\\",\\n \\\"baseAmount\\\": \\\"0.00000016\\\",\\n \\\"tag\\\": \\\"DEFAULT\\\"\\n }\\n ],\\n \\\"marginAccounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"balance\\\": \\\"0.01\\\",\\n \\\"available\\\": \\\"0.01\\\",\\n \\\"holds\\\": \\\"0\\\",\\n \\\"baseCurrency\\\": \\\"BTC\\\",\\n \\\"baseCurrencyPrice\\\": \\\"62384.3\\\",\\n \\\"baseAmount\\\": \\\"0.00000016\\\",\\n \\\"tag\\\": \\\"DEFAULT\\\"\\n }\\n ],\\n \\\"tradeHFAccounts\\\": []\\n }\\n}", "x-request-example": "{\\\"subUserId\\\": \\\"63743f07e0c5230001761d08\\\", \\\"includeBaseAmount\\\": true, \\\"baseCurrency\\\": \\\"example_string_default_value\\\", \\\"baseAmount\\\": \\\"example_string_default_value\\\"}", "operationId": "017" } }, "/api/v2/sub-accounts": { "get": { "summary": "Get sub-account List - Spot Balance (V2)", "deprecated": false, "description": "This endpoint can be used to get paginated Spot sub-account information. Pagination is required.", "tags": [], "parameters": [ { "name": "currentPage", "in": "query", "description": "Current request page. Default is 1", "required": false, "schema": { "type": "integer", "default": 1, "example": [ 1 ] } }, { "name": "pageSize", "in": "query", "description": "Number of results per request. Minimum is 10, maximum is 100, default is 10.\n", "required": false, "schema": { "type": "integer", "default": 10, "minimum": 10, "maximum": 100, "example": [ 10 ] } } ], "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": { "subUserId": { "type": "string", "description": "The user ID of the sub-user." }, "subName": { "type": "string", "description": "The username of the sub-user." }, "mainAccounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the account." }, "balance": { "type": "string", "description": "Total funds in the account." }, "available": { "type": "string", "description": "Funds available to withdraw or trade." }, "holds": { "type": "string", "description": "Funds on hold (not available for use)." }, "baseCurrency": { "type": "string", "description": "Calculated on this currency." }, "baseCurrencyPrice": { "type": "string", "description": "The base currency price." }, "baseAmount": { "type": "string", "description": "The base currency amount." }, "tag": { "type": "string" } } }, "description": "Funding Account" }, "tradeAccounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the account." }, "balance": { "type": "string", "description": "Total funds in the account." }, "available": { "type": "string", "description": "Funds available to withdraw or trade." }, "holds": { "type": "string", "description": "Funds on hold (not available for use)." }, "baseCurrency": { "type": "string", "description": "Calculated on this currency." }, "baseCurrencyPrice": { "type": "string", "description": "The base currency price." }, "baseAmount": { "type": "string", "description": "The base currency amount." }, "tag": { "type": "string" } } }, "description": "Spot Account" }, "marginAccounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the account." }, "balance": { "type": "string", "description": "Total funds in the account." }, "available": { "type": "string", "description": "Funds available to withdraw or trade." }, "holds": { "type": "string", "description": "Funds on hold (not available for use)." }, "baseCurrency": { "type": "string", "description": "Calculated on this currency." }, "baseCurrencyPrice": { "type": "string", "description": "The base currency price." }, "baseAmount": { "type": "string", "description": "The base currency amount." }, "tag": { "type": "string" } } }, "description": "Margin Account" }, "tradeHFAccounts": { "type": "array", "items": { "type": "string" }, "description": "This param is deprecated and only valid for some old users" } }, "required": [ "subUserId", "subName", "mainAccounts", "tradeAccounts", "marginAccounts", "tradeHFAccounts" ] } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470133", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "getSpotSubAccountListV2", "x-sdk-method-description": "This endpoint can be used to get paginated Spot sub-account information. Pagination is required.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 10,\\n \\\"totalNum\\\": 3,\\n \\\"totalPage\\\": 1,\\n \\\"items\\\": [\\n {\\n \\\"subUserId\\\": \\\"63743f07e0c5230001761d08\\\",\\n \\\"subName\\\": \\\"testapi6\\\",\\n \\\"mainAccounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"balance\\\": \\\"0.01\\\",\\n \\\"available\\\": \\\"0.01\\\",\\n \\\"holds\\\": \\\"0\\\",\\n \\\"baseCurrency\\\": \\\"BTC\\\",\\n \\\"baseCurrencyPrice\\\": \\\"62514.5\\\",\\n \\\"baseAmount\\\": \\\"0.00000015\\\",\\n \\\"tag\\\": \\\"DEFAULT\\\"\\n }\\n ],\\n \\\"tradeAccounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"balance\\\": \\\"0.01\\\",\\n \\\"available\\\": \\\"0.01\\\",\\n \\\"holds\\\": \\\"0\\\",\\n \\\"baseCurrency\\\": \\\"BTC\\\",\\n \\\"baseCurrencyPrice\\\": \\\"62514.5\\\",\\n \\\"baseAmount\\\": \\\"0.00000015\\\",\\n \\\"tag\\\": \\\"DEFAULT\\\"\\n }\\n ],\\n \\\"marginAccounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"balance\\\": \\\"0.01\\\",\\n \\\"available\\\": \\\"0.01\\\",\\n \\\"holds\\\": \\\"0\\\",\\n \\\"baseCurrency\\\": \\\"BTC\\\",\\n \\\"baseCurrencyPrice\\\": \\\"62514.5\\\",\\n \\\"baseAmount\\\": \\\"0.00000015\\\",\\n \\\"tag\\\": \\\"DEFAULT\\\"\\n }\\n ],\\n \\\"tradeHFAccounts\\\": []\\n },\\n {\\n \\\"subUserId\\\": \\\"670538a31037eb000115b076\\\",\\n \\\"subName\\\": \\\"Name1234567\\\",\\n \\\"mainAccounts\\\": [],\\n \\\"tradeAccounts\\\": [],\\n \\\"marginAccounts\\\": [],\\n \\\"tradeHFAccounts\\\": []\\n },\\n {\\n \\\"subUserId\\\": \\\"66b0c0905fc1480001c14c36\\\",\\n \\\"subName\\\": \\\"LTkucoin1491\\\",\\n \\\"mainAccounts\\\": [],\\n \\\"tradeAccounts\\\": [],\\n \\\"marginAccounts\\\": [],\\n \\\"tradeHFAccounts\\\": []\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"currentPage\\\": 1, \\\"pageSize\\\": 10}", "operationId": "018" } }, "/api/v1/account-overview-all": { "get": { "summary": "Get sub-account List - Futures Balance (V2)", "deprecated": false, "description": "This endpoint can be used to get Futures sub-account information. ", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "Currency, Default XBT", "required": false, "schema": { "type": "string", "default": "XBT", "example": [ "USDT", "ETH" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "accountEquityTotal": { "type": "number", "description": "Total Account Equity" }, "unrealisedPNLTotal": { "type": "number", "description": "Total unrealizedPNL" }, "marginBalanceTotal": { "type": "number", "description": "Total Margin Balance" }, "positionMarginTotal": { "type": "number", "description": "Total Position margin" }, "orderMarginTotal": { "type": "number" }, "frozenFundsTotal": { "type": "number", "description": "Total frozen funds for withdrawal and out-transfer" }, "availableBalanceTotal": { "type": "number", "description": "Total available balance" }, "currency": { "type": "string" } }, "required": [ "accountEquityTotal", "unrealisedPNLTotal", "marginBalanceTotal", "positionMarginTotal", "orderMarginTotal", "frozenFundsTotal", "availableBalanceTotal", "currency" ] }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Account name, main account is main", "example": [ "main" ] }, "accountEquity": { "type": "number" }, "unrealisedPNL": { "type": "number" }, "marginBalance": { "type": "number" }, "positionMargin": { "type": "number" }, "orderMargin": { "type": "number" }, "frozenFunds": { "type": "number" }, "availableBalance": { "type": "number" }, "currency": { "type": "string", "description": "currency" } }, "required": [ "accountName", "accountEquity", "unrealisedPNL", "marginBalance", "positionMargin", "orderMargin", "frozenFunds", "availableBalance", "currency" ] }, "description": "Account List" } }, "required": [ "summary", "accounts" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470134", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Futures", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "getFuturesSubAccountListV2", "x-sdk-method-description": "This endpoint can be used to get Futures sub-account information. ", "x-api-rate-limit-weight": 6, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"summary\\\": {\\n \\\"accountEquityTotal\\\": 103.899081508,\\n \\\"unrealisedPNLTotal\\\": 38.81075,\\n \\\"marginBalanceTotal\\\": 65.336985668,\\n \\\"positionMarginTotal\\\": 68.9588320683,\\n \\\"orderMarginTotal\\\": 0,\\n \\\"frozenFundsTotal\\\": 0,\\n \\\"availableBalanceTotal\\\": 67.2492494397,\\n \\\"currency\\\": \\\"USDT\\\"\\n },\\n \\\"accounts\\\": [\\n {\\n \\\"accountName\\\": \\\"Name1234567\\\",\\n \\\"accountEquity\\\": 0,\\n \\\"unrealisedPNL\\\": 0,\\n \\\"marginBalance\\\": 0,\\n \\\"positionMargin\\\": 0,\\n \\\"orderMargin\\\": 0,\\n \\\"frozenFunds\\\": 0,\\n \\\"availableBalance\\\": 0,\\n \\\"currency\\\": \\\"USDT\\\"\\n },\\n {\\n \\\"accountName\\\": \\\"LTkucoin1491\\\",\\n \\\"accountEquity\\\": 0,\\n \\\"unrealisedPNL\\\": 0,\\n \\\"marginBalance\\\": 0,\\n \\\"positionMargin\\\": 0,\\n \\\"orderMargin\\\": 0,\\n \\\"frozenFunds\\\": 0,\\n \\\"availableBalance\\\": 0,\\n \\\"currency\\\": \\\"USDT\\\"\\n },\\n {\\n \\\"accountName\\\": \\\"manage112233\\\",\\n \\\"accountEquity\\\": 0,\\n \\\"unrealisedPNL\\\": 0,\\n \\\"marginBalance\\\": 0,\\n \\\"positionMargin\\\": 0,\\n \\\"orderMargin\\\": 0,\\n \\\"frozenFunds\\\": 0,\\n \\\"availableBalance\\\": 0,\\n \\\"currency\\\": \\\"USDT\\\"\\n },\\n {\\n \\\"accountName\\\": \\\"testapi6\\\",\\n \\\"accountEquity\\\": 27.30545128,\\n \\\"unrealisedPNL\\\": 22.549,\\n \\\"marginBalance\\\": 4.75645128,\\n \\\"positionMargin\\\": 24.1223749975,\\n \\\"orderMargin\\\": 0,\\n \\\"frozenFunds\\\": 0,\\n \\\"availableBalance\\\": 25.7320762825,\\n \\\"currency\\\": \\\"USDT\\\"\\n },\\n {\\n \\\"accountName\\\": \\\"main\\\",\\n \\\"accountEquity\\\": 76.593630228,\\n \\\"unrealisedPNL\\\": 16.26175,\\n \\\"marginBalance\\\": 60.580534388,\\n \\\"positionMargin\\\": 44.8364570708,\\n \\\"orderMargin\\\": 0,\\n \\\"frozenFunds\\\": 0,\\n \\\"availableBalance\\\": 41.5171731572,\\n \\\"currency\\\": \\\"USDT\\\"\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"currency\\\": \\\"USDT\\\"}", "operationId": "019" } }, "/api/v1/sub/api-key": { "post": { "summary": "Add sub-account API", "deprecated": false, "description": "This endpoint can be used to create APIs for sub-accounts.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "subName": { "type": "string", "description": "Sub-account name" }, "remark": { "type": "string", "description": "Remarks" }, "apiKey": { "type": "string", "description": "API Key" }, "apiSecret": { "type": "string", "description": "API Secret Key\n" }, "apiVersion": { "type": "integer", "description": "API Version" }, "passphrase": { "type": "string", "description": "Password" }, "permission": { "type": "string", "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)" }, "ipWhitelist": { "type": "string", "description": "IP whitelist" }, "createdAt": { "type": "integer", "description": "Time of event", "format": "int64" } }, "required": [ "subName", "remark", "apiKey", "apiSecret", "apiVersion", "passphrase", "permission", "createdAt" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470138", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "addSubAccountApi", "x-sdk-method-description": "This endpoint can be used to create APIs for sub-accounts.", "x-api-rate-limit-weight": 20, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "passphrase": { "type": "string", "description": "Password (Must contain 7–32 characters. Cannot contain any spaces.)" }, "remark": { "type": "string", "description": "Remarks (1–24 characters)" }, "permission": { "type": "string", "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)(Only General, Spot, Futures, Margin, InnerTransfer (Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")", "default": "General", "example": [ "General, Trade" ] }, "ipWhitelist": { "type": "string", "description": "IP whitelist (You may add up to 20 IPs. Use a halfwidth comma to each IP)" }, "expire": { "type": "string", "description": "API expiration time: Never expire(default)-1, 30Day30, 90Day90, 180Day180, 360Day360", "default": "-1", "enum": [ "-1", "30", "90", "180", "360" ], "x-api-enum": [ { "value": "-1", "name": "", "description": "" }, { "value": "30", "name": "", "description": "" }, { "value": "90", "name": "", "description": "" }, { "value": "180", "name": "", "description": "" }, { "value": "360", "name": "", "description": "" } ], "example": [ "30" ] }, "subName": { "type": "string", "description": "Sub-account name, create sub account name of API Key." } }, "required": [ "subName", "remark", "passphrase" ] }, "example": "{\n \"subName\": \"testapi6\",\n \"passphrase\": \"11223344\",\n \"remark\": \"TheRemark\",\n \"permission\": \"General,Spot,Futures\"\n}" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"subName\\\": \\\"testapi6\\\",\\n \\\"remark\\\": \\\"TheRemark\\\",\\n \\\"apiKey\\\": \\\"670621e3a25958000159c82f\\\",\\n \\\"apiSecret\\\": \\\"46fd8974******896f005b2340\\\",\\n \\\"apiVersion\\\": 3,\\n \\\"passphrase\\\": \\\"11223344\\\",\\n \\\"permission\\\": \\\"General,Futures\\\",\\n \\\"createdAt\\\": 1728455139000\\n }\\n}", "x-request-example": "{\\\"subName\\\": \\\"testapi6\\\", \\\"passphrase\\\": \\\"11223344\\\", \\\"remark\\\": \\\"TheRemark\\\", \\\"permission\\\": \\\"General,Spot,Futures\\\"}", "operationId": "020" }, "get": { "summary": "Get sub-account API List", "deprecated": false, "description": "This endpoint can be used to obtain a list of APIs pertaining to a sub-account (not including ND broker sub-accounts).", "tags": [], "parameters": [ { "name": "apiKey", "in": "query", "description": "API-Key", "required": false, "schema": { "type": "string" } }, { "name": "subName", "in": "query", "description": "Sub-account name.", "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": { "subName": { "type": "string", "description": "Sub Name" }, "remark": { "type": "string", "description": "Remarks" }, "apiKey": { "type": "string", "description": "API Key" }, "apiVersion": { "type": "integer", "description": "API Version" }, "permission": { "type": "string", "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)" }, "ipWhitelist": { "type": "string", "description": "IP whitelist" }, "createdAt": { "type": "integer", "format": "int64", "description": "Apikey create time" }, "uid": { "type": "integer", "description": "Sub-account UID" }, "isMaster": { "type": "boolean", "description": "Whether it is the master account." } } } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470136", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "getSubAccountApiList", "x-sdk-method-description": "This endpoint can be used to obtain a list of APIs pertaining to a sub-account (not including ND broker sub-accounts).", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"subName\\\": \\\"apiSdkTest\\\",\\n \\\"remark\\\": \\\"sdk_test_integration\\\",\\n \\\"apiKey\\\": \\\"673eab2a955ebf000195d7e4\\\",\\n \\\"apiVersion\\\": 3,\\n \\\"permission\\\": \\\"General\\\",\\n \\\"ipWhitelist\\\": \\\"10.**.1\\\",\\n \\\"createdAt\\\": 1732160298000,\\n \\\"uid\\\": 215112467,\\n \\\"isMaster\\\": false\\n }\\n ]\\n}", "x-request-example": "{\\\"apiKey\\\": \\\"example_string_default_value\\\", \\\"subName\\\": \\\"testapi6\\\"}", "operationId": "022" }, "delete": { "summary": "Delete sub-account API", "deprecated": false, "description": "This endpoint can be used to delete sub-account APIs.", "tags": [], "parameters": [ { "name": "apiKey", "in": "query", "description": "API-Key", "required": true, "schema": { "type": "string" } }, { "name": "subName", "in": "query", "description": "Sub-account name.", "required": true, "schema": { "type": "string" } }, { "name": "passphrase", "in": "query", "description": "Password (password of the API key)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "subName": { "type": "string", "description": "The username of a sub-user." }, "apiKey": { "type": "string", "description": "The APIKEY of a sub-user." } }, "required": [ "subName", "apiKey" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470137", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "deleteSubAccountApi", "x-sdk-method-description": "This endpoint can be used to delete sub-account APIs.", "x-api-rate-limit-weight": 30, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"subName\\\":\\\"testapi6\\\",\\\"apiKey\\\":\\\"670621e3a25958000159c82f\\\"}}", "x-request-example": "{\\\"apiKey\\\": \\\"670621e3a25958000159c82f\\\", \\\"subName\\\": \\\"testapi6\\\", \\\"passphrase\\\": \\\"11223344\\\"}", "operationId": "023" } }, "/api/v1/sub/api-key/update": { "post": { "summary": "Modify sub-account API", "deprecated": false, "description": "This endpoint can be used to modify sub-account APIs.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "subName": { "type": "string", "description": "Sub-account name" }, "apiKey": { "type": "string", "description": "API Key" }, "permission": { "type": "string", "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)" }, "ipWhitelist": { "type": "string", "description": "IP whitelist" } }, "required": [ "subName", "apiKey", "permission" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470139", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "modifySubAccountApi", "x-sdk-method-description": "This endpoint can be used to modify sub-account APIs.", "x-api-rate-limit-weight": 30, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "passphrase": { "type": "string", "description": "Password (Must contain 7–32 characters. Cannot contain any spaces.)" }, "permission": { "type": "string", "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)(Only General, Spot, Futures, Margin, InnerTransfer (Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")", "default": "General", "example": [ "General,Trade" ] }, "ipWhitelist": { "type": "string", "description": "IP whitelist (You may add up to 20 IPs. Use a halfwidth comma to each IP)" }, "expire": { "type": "string", "description": "API expiration time: Never expire(default)-1, 30Day30, 90Day90, 180Day180, 360Day360", "default": "-1", "enum": [ "-1", "30", "90", "180", "360" ], "x-api-enum": [ { "value": "-1", "name": "", "description": "" }, { "value": "30", "name": "", "description": "" }, { "value": "90", "name": "", "description": "" }, { "value": "180", "name": "", "description": "" }, { "value": "360", "name": "", "description": "" } ], "example": [ "30" ] }, "subName": { "type": "string", "description": "Sub-account name, create sub account name of API Key." }, "apiKey": { "type": "string", "description": "API-Key (Sub-account APIKey)" } }, "required": [ "subName", "passphrase", "apiKey" ] }, "example": "{\n \"subName\": \"testapi6\",\n \"apiKey\": \"670621e3a25958000159c82f\",\n \"passphrase\": \"11223344\",\n \"permission\": \"General,Spot,Futures\"\n}" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"subName\\\": \\\"testapi6\\\",\\n \\\"apiKey\\\": \\\"670621e3a25958000159c82f\\\",\\n \\\"permission\\\": \\\"General,Futures,Spot\\\"\\n }\\n}", "x-request-example": "{\\\"subName\\\": \\\"testapi6\\\", \\\"apiKey\\\": \\\"670621e3a25958000159c82f\\\", \\\"passphrase\\\": \\\"11223344\\\", \\\"permission\\\": \\\"General,Spot,Futures\\\"}", "operationId": "021" } }, "/api/v3/deposit-address/create": { "post": { "summary": "Add Deposit Address (V3)", "deprecated": false, "description": "Request via this endpoint the creation of a deposit address for a currency you intend to deposit.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "address": { "type": "string", "description": "Deposit address" }, "memo": { "type": "string", "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to KuCoin, you need to fill in memo(tag). Be careful: If you do not fill in memo(tag), your deposit may not be available." }, "chainId": { "type": "string", "description": "The chainId of currency", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "to": { "type": "string", "description": "Deposit account type: MAIN (funding account), TRADE (spot trading account)" }, "expirationDate": { "type": "integer", "description": "Expiration time; Lightning network expiration time; this field is not applicable to non-Lightning networks" }, "currency": { "type": "string", "description": "currency", "example": [ "BTC", "ETH", "USDT" ] }, "chainName": { "type": "string", "description": "The chainName of currency" } }, "required": [ "address", "memo", "chainId", "to", "expirationDate", "currency", "chainName" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470142", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Deposit", "x-sdk-method-name": "addDepositAddressV3", "x-sdk-method-description": "Request via this endpoint the creation of a deposit address for a currency you intend to deposit.", "x-api-rate-limit-weight": 20, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "currency": { "type": "string", "description": "currency", "example": [ "BTC", "ETH", "USDT" ] }, "chain": { "type": "string", "description": "The currency chainId, e.g. the available values for USDT are OMNI, ERC20, and TRC20; default is ERC20. The available values for BTC are Native, Segwit, TRC20; the parameters are bech32, btc, trx; default is Native. ", "default": "eth", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "to": { "type": "string", "description": "Deposit account type: MAIN (funding account), TRADE (spot trading account); the default is MAIN", "enum": [ "main", "trade" ], "default": "main", "x-api-enum": [ { "value": "main", "name": "main", "description": "Funding account" }, { "value": "trade", "name": "trade", "description": "Spot account" } ] }, "amount": { "type": "string", "description": "Deposit amount. This parameter is only used when applying for invoices on the Lightning Network. This parameter is invalid if it is not passed through the Lightning Network." } }, "required": [ "currency", "chain" ] }, "example": "{\n \"currency\": \"TON\",\n \"chain\": \"ton\",\n \"to\": \"trade\"\n}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"address\\\":\\\"EQCA1BI4QRZ8qYmskSRDzJmkucGodYRTZCf_b9hckjla6dZl\\\",\\\"memo\\\":\\\"2090821203\\\",\\\"chainId\\\":\\\"ton\\\",\\\"to\\\":\\\"TRADE\\\",\\\"expirationDate\\\":0,\\\"currency\\\":\\\"TON\\\",\\\"chainName\\\":\\\"TON\\\"}}", "x-request-example": "{\\\"currency\\\": \\\"TON\\\", \\\"chain\\\": \\\"ton\\\", \\\"to\\\": \\\"trade\\\"}", "operationId": "024" } }, "/api/v3/deposit-addresses": { "get": { "summary": "Get Deposit Address (V3)", "deprecated": false, "description": "Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to add the deposit address first.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": true, "schema": { "type": "string", "example": [ "BTC", "ETH", "USDT" ] } }, { "name": "amount", "in": "query", "description": "Deposit amount. This parameter is only used when applying for invoices on the Lightning Network. This parameter is invalid if it is not passed through the Lightning Network.", "required": false, "schema": { "type": "string" } }, { "name": "chain", "in": "query", "description": "The chain Id of currency.", "required": false, "schema": { "type": "string", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Deposit address" }, "memo": { "type": "string", "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to KuCoin, you need to fill in memo(tag). Be careful: If you do not fill in memo(tag), your deposit may not be available." }, "chainId": { "type": "string", "description": "The chainId of currency", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "to": { "type": "string", "description": "Deposit account type: MAIN (funding account), TRADE (spot trading account)", "enum": [ "MAIN", "TRADE" ], "x-api-enum": [ { "value": "MAIN", "name": "MAIN", "description": "Funding account" }, { "value": "TRADE", "name": "TRADE", "description": "Spot account" } ] }, "expirationDate": { "type": "integer", "description": "Expiration time; Lightning network expiration time; this field is not applicable to non-Lightning networks" }, "currency": { "type": "string", "description": "currency", "example": [ "BTC", "ETH", "USDT" ] }, "contractAddress": { "type": "string", "description": "The token contract address." }, "chainName": { "type": "string", "description": "The chainName of currency" } }, "required": [ "address", "memo", "chainId", "to", "expirationDate", "currency", "contractAddress", "chainName" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470140", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Deposit", "x-sdk-method-name": "getDepositAddressV3", "x-sdk-method-description": "Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to add the deposit address first.", "x-api-rate-limit-weight": 5, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":[{\\\"address\\\":\\\"TSv3L1fS7yA3SxzKD8c1qdX4nLP6rqNxYz\\\",\\\"memo\\\":\\\"\\\",\\\"chainId\\\":\\\"trx\\\",\\\"to\\\":\\\"TRADE\\\",\\\"expirationDate\\\":0,\\\"currency\\\":\\\"USDT\\\",\\\"contractAddress\\\":\\\"TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t\\\",\\\"chainName\\\":\\\"TRC20\\\"},{\\\"address\\\":\\\"0x551e823a3b36865e8c5dc6e6ac6cc0b00d98533e\\\",\\\"memo\\\":\\\"\\\",\\\"chainId\\\":\\\"kcc\\\",\\\"to\\\":\\\"TRADE\\\",\\\"expirationDate\\\":0,\\\"currency\\\":\\\"USDT\\\",\\\"contractAddress\\\":\\\"0x0039f574ee5cc39bdd162e9a88e3eb1f111baf48\\\",\\\"chainName\\\":\\\"KCC\\\"},{\\\"address\\\":\\\"EQCA1BI4QRZ8qYmskSRDzJmkucGodYRTZCf_b9hckjla6dZl\\\",\\\"memo\\\":\\\"2085202643\\\",\\\"chainId\\\":\\\"ton\\\",\\\"to\\\":\\\"TRADE\\\",\\\"expirationDate\\\":0,\\\"currency\\\":\\\"USDT\\\",\\\"contractAddress\\\":\\\"EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs\\\",\\\"chainName\\\":\\\"TON\\\"},{\\\"address\\\":\\\"0x0a2586d5a901c8e7e68f6b0dc83bfd8bd8600ff5\\\",\\\"memo\\\":\\\"\\\",\\\"chainId\\\":\\\"eth\\\",\\\"to\\\":\\\"MAIN\\\",\\\"expirationDate\\\":0,\\\"currency\\\":\\\"USDT\\\",\\\"contractAddress\\\":\\\"0xdac17f958d2ee523a2206206994597c13d831ec7\\\",\\\"chainName\\\":\\\"ERC20\\\"}]}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"amount\\\": \\\"example_string_default_value\\\", \\\"chain\\\": \\\"eth\\\"}", "operationId": "025" } }, "/api/v1/deposits": { "get": { "summary": "Get Deposit History", "deprecated": false, "description": "Request a deposit list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": true, "schema": { "type": "string", "example": [ "BTC", "ETH", "USDT" ] } }, { "name": "status", "in": "query", "description": "Status. Available value: PROCESSING, SUCCESS, and FAILURE", "required": false, "schema": { "type": "string", "enum": [ "PROCESSING", "SUCCESS", "FAILURE" ], "x-api-enum": [ { "value": "PROCESSING", "name": "PROCESSING", "description": "Deposit processing" }, { "value": "SUCCESS", "name": "SUCCESS", "description": "Deposit success" }, { "value": "FAILURE", "name": "FAILURE", "description": "Deposit fail" } ] } }, { "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" } }, { "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, "default": 50 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer", "description": "current page" }, "pageSize": { "type": "integer", "description": "page size" }, "totalNum": { "type": "integer", "description": "total number" }, "totalPage": { "type": "integer", "description": "total pages" }, "items": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency" }, "chain": { "type": "string", "description": "The chainName of currency", "example": [ "ERC20", "BTC-Segwit", "BTC", "KCC", "TRC20", "BEP20", "ARBITRUM", "TON", "OPTIMISM" ] }, "status": { "type": "string", "description": "Status", "enum": [ "PROCESSING", "SUCCESS", "FAILURE" ], "x-api-enum": [ { "value": "PROCESSING", "name": "", "description": "" }, { "value": "SUCCESS", "name": "", "description": "" }, { "value": "FAILURE", "name": "", "description": "" } ] }, "address": { "type": "string", "description": "Deposit address" }, "memo": { "type": "string", "description": "Address remark. If there’s no remark, it is empty. " }, "isInner": { "type": "boolean", "description": "Internal deposit or not" }, "amount": { "type": "string", "description": "Deposit amount" }, "fee": { "type": "string", "description": "Fees charged for deposit" }, "walletTxId": { "type": "string", "description": "Wallet Txid" }, "createdAt": { "type": "integer", "description": "Database record creation time", "format": "int64" }, "updatedAt": { "type": "integer", "description": "Update time of the database record", "format": "int64" }, "remark": { "type": "string", "description": "remark" }, "arrears": { "type": "boolean", "description": "Whether there is any debt.A quick rollback will cause the deposit to fail. If the deposit fails, you will need to repay the balance." } } } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470141", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Deposit", "x-sdk-method-name": "getDepositHistory", "x-sdk-method-description": "Request a deposit list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.", "x-api-rate-limit-weight": 5, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 50,\\n \\\"totalNum\\\": 5,\\n \\\"totalPage\\\": 1,\\n \\\"items\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"chain\\\": \\\"\\\",\\n \\\"status\\\": \\\"SUCCESS\\\",\\n \\\"address\\\": \\\"a435*****@gmail.com\\\",\\n \\\"memo\\\": \\\"\\\",\\n \\\"isInner\\\": true,\\n \\\"amount\\\": \\\"1.00000000\\\",\\n \\\"fee\\\": \\\"0.00000000\\\",\\n \\\"walletTxId\\\": null,\\n \\\"createdAt\\\": 1728555875000,\\n \\\"updatedAt\\\": 1728555875000,\\n \\\"remark\\\": \\\"\\\",\\n \\\"arrears\\\": false\\n },\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"chain\\\": \\\"trx\\\",\\n \\\"status\\\": \\\"SUCCESS\\\",\\n \\\"address\\\": \\\"TSv3L1fS7******X4nLP6rqNxYz\\\",\\n \\\"memo\\\": \\\"\\\",\\n \\\"isInner\\\": true,\\n \\\"amount\\\": \\\"6.00000000\\\",\\n \\\"fee\\\": \\\"0.00000000\\\",\\n \\\"walletTxId\\\": null,\\n \\\"createdAt\\\": 1721730920000,\\n \\\"updatedAt\\\": 1721730920000,\\n \\\"remark\\\": \\\"\\\",\\n \\\"arrears\\\": false\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"status\\\": \\\"SUCCESS\\\", \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000, \\\"currentPage\\\": 1, \\\"pageSize\\\": 50}", "operationId": "026" } }, "/api/v1/withdrawals/quotas": { "get": { "summary": "Get Withdrawal Quotas", "deprecated": false, "description": "This interface can obtain the withdrawal quota information of this currency.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": true, "schema": { "type": "string", "example": [ "BTC", "ETH", "USDT" ] } }, { "name": "chain", "in": "query", "description": "The chainId of currency, e.g. the available values for USDT are OMNI, ERC20, and TRC20; default is ERC20. The available values for BTC are Native, Segwit, TRC20; the parameters are bech32, btc, trx; default is Native. This only applies to multi-chain currencies; no need for single-chain currencies.", "required": false, "schema": { "type": "string", "default": "eth", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currency": { "type": "string" }, "limitBTCAmount": { "type": "string" }, "usedBTCAmount": { "type": "string" }, "quotaCurrency": { "type": "string", "description": "Withdrawal limit currency" }, "limitQuotaCurrencyAmount": { "type": "string", "description": "The intraday available withdrawal amount (withdrawal limit currency)" }, "usedQuotaCurrencyAmount": { "type": "string", "description": "The intraday cumulative withdrawal amount (withdrawal limit currency)" }, "remainAmount": { "type": "string", "description": "Remaining amount available to withdraw the current day\n" }, "availableAmount": { "type": "string", "description": "Current available withdrawal amount" }, "withdrawMinFee": { "type": "string", "description": "Minimum withdrawal fee" }, "innerWithdrawMinFee": { "type": "string", "description": "Fees for internal withdrawal" }, "withdrawMinSize": { "type": "string", "description": "Minimum withdrawal amount" }, "isWithdrawEnabled": { "type": "boolean", "description": "Is the withdraw function enabled?" }, "precision": { "type": "integer", "description": "Floating point precision." }, "chain": { "type": "string", "description": "The chainName of currency", "example": [ "ERC20", "BTC-Segwit", "BTC", "KCC", "TRC20", "BEP20", "ARBITRUM", "TON", "OPTIMISM" ] }, "reason": { "type": "string", "description": "Reasons for restriction. Usually empty." }, "lockedAmount": { "type": "string", "description": "Total locked amount (including the amount locked into USDT for each currency)" } }, "required": [ "currency", "limitBTCAmount", "usedBTCAmount", "quotaCurrency", "limitQuotaCurrencyAmount", "usedQuotaCurrencyAmount", "remainAmount", "availableAmount", "withdrawMinFee", "innerWithdrawMinFee", "withdrawMinSize", "isWithdrawEnabled", "precision", "chain", "reason", "lockedAmount" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470143", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Withdrawal", "x-sdk-method-name": "getWithdrawalQuotas", "x-sdk-method-description": "This interface can obtain the withdrawal quota information of this currency.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"currency\\\":\\\"BTC\\\",\\\"limitBTCAmount\\\":\\\"15.79590095\\\",\\\"usedBTCAmount\\\":\\\"0.00000000\\\",\\\"quotaCurrency\\\":\\\"USDT\\\",\\\"limitQuotaCurrencyAmount\\\":\\\"999999.00000000\\\",\\\"usedQuotaCurrencyAmount\\\":\\\"0\\\",\\\"remainAmount\\\":\\\"15.79590095\\\",\\\"availableAmount\\\":\\\"0\\\",\\\"withdrawMinFee\\\":\\\"0.0005\\\",\\\"innerWithdrawMinFee\\\":\\\"0\\\",\\\"withdrawMinSize\\\":\\\"0.001\\\",\\\"isWithdrawEnabled\\\":true,\\\"precision\\\":8,\\\"chain\\\":\\\"BTC\\\",\\\"reason\\\":null,\\\"lockedAmount\\\":\\\"0\\\"}}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"chain\\\": \\\"eth\\\"}", "operationId": "027" } }, "/api/v3/withdrawals": { "post": { "summary": "Withdraw (V3)", "deprecated": false, "description": "Use this interface to withdraw the specified currency.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "withdrawalId": { "type": "string", "description": "Withdrawal id, a unique ID for a withdrawal" } }, "required": [ "withdrawalId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470146", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Withdrawal", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Withdrawal", "x-sdk-method-name": "withdrawalV3", "x-sdk-method-description": "Use this interface to withdraw the specified currency.", "x-api-rate-limit-weight": 5, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "currency": { "type": "string", "description": "currency", "example": [ "BTC", "ETH", "USDT" ] }, "chain": { "type": "string", "description": "The chainId of currency, For a currency with multiple chains, it is recommended to specify the chain parameter instead of using the default chain; you can query the chainId through the response of the GET /api/v3/currencies/{currency} interface.", "default": "eth", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "amount": { "type": "string", "description": "Withdrawal amount, a positive number which is a multiple of the amount precision" }, "memo": { "type": "string", "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to KuCoin, you need to fill in memo(tag). Be careful: If you do not fill in memo(tag), your deposit may not be available." }, "isInner": { "type": "boolean", "description": "Internal withdrawal or not. Default: False", "default": false }, "remark": { "type": "string", "description": "Remark" }, "feeDeductType": { "type": "string", "description": "Withdrawal fee deduction type: INTERNAL, EXTERNAL, or not specified\n\n1. INTERNAL: Deduct the transaction fees from your withdrawal amount\n2. EXTERNAL: Deduct the transaction fees from your main account\n3. If you don't specify the feeDeductType parameter, when the balance in your main account is sufficient to support the withdrawal, the system will initially deduct the transaction fees from your main account. But if the balance in your main account is not sufficient to support the withdrawal, the system will deduct the fees from your withdrawal amount. For example: Suppose you are going to withdraw 1 BTC from the KuCoin platform (transaction fee: 0.0001BTC), if the balance in your main account is insufficient, the system will deduct the transaction fees from your withdrawal amount. In this case, you will be receiving 0.9999BTC." }, "toAddress": { "type": "string", "description": "Withdrawal address", "example": [ "0x023****2355", "1572**401", "a431***1e@gmail.com", "55-12341234" ] }, "withdrawType": { "type": "string", "description": "Withdrawal type, ADDRESS (withdrawal address), UID, MAIL (email), PHONE (mobile phone number). Note: If you withdraw by uid/mail/phone, there will be rate limits: 3 times/10 seconds, 50 times/24 hours (calculated on a rolling basis based on the first request time)", "enum": [ "ADDRESS", "UID", "MAIL", "PHONE" ], "x-api-enum": [ { "value": "ADDRESS", "name": "", "description": "" }, { "value": "UID", "name": "", "description": "" }, { "value": "MAIL", "name": "", "description": "" }, { "value": "PHONE", "name": "", "description": "" } ] } }, "required": [ "currency", "toAddress", "amount", "withdrawType" ] }, "example": "{\n \"currency\": \"USDT\",\n \"toAddress\": \"TKFRQXSDcY****GmLrjJggwX8\",\n \"amount\": \"3\",\n \"withdrawType\": \"ADDRESS\",\n \"chain\": \"trx\",\n \"isInner\": true,\n \"remark\": \"this is Remark\"\n}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"withdrawalId\\\":\\\"670deec84d64da0007d7c946\\\"}}", "x-request-example": "{\\\"currency\\\": \\\"USDT\\\", \\\"toAddress\\\": \\\"TKFRQXSDcY****GmLrjJggwX8\\\", \\\"amount\\\": \\\"3\\\", \\\"withdrawType\\\": \\\"ADDRESS\\\", \\\"chain\\\": \\\"trx\\\", \\\"isInner\\\": true, \\\"remark\\\": \\\"this is Remark\\\"}", "operationId": "028" } }, "/api/v1/withdrawals/{withdrawalId}": { "delete": { "summary": "Cancel Withdrawal", "deprecated": false, "description": "This interface can cancel the withdrawal. Only withdrawal requests with PROCESSING status can be canceled.", "tags": [], "parameters": [ { "name": "withdrawalId", "in": "path", "description": "Path parameter, a unique ID for a withdrawalId", "required": true, "schema": { "type": "string" } } ], "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-3470144", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Withdrawal", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Withdrawal", "x-sdk-method-name": "cancelWithdrawal", "x-sdk-method-description": "This interface can cancel the withdrawal. Only withdrawal requests with PROCESSING status can be canceled.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":null}", "x-request-example": "{\\\"withdrawalId\\\": \\\"670b891f7e0f440007730692\\\"}", "operationId": "029" }, "get": { "summary": "Get Withdrawal History By ID", "deprecated": false, "description": "Request a withdrawal history by id via this endpoint.", "tags": [], "parameters": [ { "name": "withdrawalId", "in": "path", "description": "withdrawal ID", "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": "Unique ID" }, "uid": { "type": "integer", "description": "User ID" }, "currency": { "type": "string", "description": "A unique currency code that will never change" }, "chainId": { "type": "string", "description": "The chain id of currency", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "chainName": { "type": "string", "description": "Chain name of currency" }, "currencyName": { "type": "string", "description": "Currency name; will change after renaming" }, "status": { "type": "string", "description": "Status. Available value: REVIEW, PROCESSING, WALLET_PROCESSING, SUCCESS and FAILURE" }, "failureReason": { "type": "string", "description": "Failure reason code" }, "failureReasonMsg": { "type": "string", "description": "Failure reason message" }, "address": { "type": "string", "description": "Withwrawal address" }, "memo": { "type": "string", "description": "Address remark. If there’s no remark, it is empty. " }, "isInner": { "type": "boolean", "description": "Internal withdrawal or not. " }, "amount": { "type": "string", "description": "Withwrawal amount" }, "fee": { "type": "string", "description": "Fees charged for withwrawal" }, "walletTxId": { "type": "string", "description": "Wallet Transaction ID" }, "addressRemark": { "type": "string", "description": "Address remark" }, "remark": { "type": "string", "description": "Remark" }, "createdAt": { "type": "integer", "format": "int64", "description": "Creation Time (milliseconds)" }, "cancelType": { "type": "string", "enum": [ "CANCELABLE", "CANCELING", "NON_CANCELABLE" ], "x-api-enum": [ { "value": "CANCELABLE", "name": "CANCELABLE", "description": "Cancellable" }, { "value": "CANCELING", "name": "CANCELING", "description": "Cancelling" }, { "value": "NON_CANCELABLE", "name": "NON_CANCELABLE", "description": "Non-Cancellable" } ] }, "taxes": { "type": "array", "items": { "type": "string" }, "description": "Users in some regions need query this field" }, "taxDescription": { "type": "string", "description": "Tax description" }, "returnStatus": { "type": "string", "enum": [ "NOT_RETURN", "PROCESSING", "SUCCESS" ], "description": "Return status", "x-api-enum": [ { "value": "NOT_RETURN", "name": "NOT_RETURN", "description": "No returned" }, { "value": "PROCESSING", "name": "PROCESSING", "description": "To be returned" }, { "value": "SUCCESS", "name": "SUCCESS", "description": "Returned" } ] }, "returnAmount": { "type": "string", "description": "Return amount" }, "returnCurrency": { "type": "string", "description": "Return currency" } }, "required": [ "id", "uid", "currency", "chainId", "chainName", "currencyName", "status", "failureReason", "address", "memo", "isInner", "amount", "fee", "remark", "createdAt", "cancelType", "returnStatus", "returnCurrency" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3471890", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Withdrawal", "x-sdk-method-name": "getWithdrawalHistoryById", "x-sdk-method-description": "Request a withdrawal history by id via this endpoint.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"id\\\": \\\"67e6515f7960ba0007b42025\\\",\\n \\\"uid\\\": 165111215,\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"chainId\\\": \\\"trx\\\",\\n \\\"chainName\\\": \\\"TRC20\\\",\\n \\\"currencyName\\\": \\\"USDT\\\",\\n \\\"status\\\": \\\"SUCCESS\\\",\\n \\\"failureReason\\\": \\\"\\\",\\n \\\"failureReasonMsg\\\": null,\\n \\\"address\\\": \\\"TKFRQXSDcY4kd3QLzw7uK16GmLrjJggwX8\\\",\\n \\\"memo\\\": \\\"\\\",\\n \\\"isInner\\\": true,\\n \\\"amount\\\": \\\"3.00000000\\\",\\n \\\"fee\\\": \\\"0.00000000\\\",\\n \\\"walletTxId\\\": null,\\n \\\"addressRemark\\\": null,\\n \\\"remark\\\": \\\"this is Remark\\\",\\n \\\"createdAt\\\": 1743147359000,\\n \\\"cancelType\\\": \\\"NON_CANCELABLE\\\",\\n \\\"taxes\\\": null,\\n \\\"taxDescription\\\": null,\\n \\\"returnStatus\\\": \\\"NOT_RETURN\\\",\\n \\\"returnAmount\\\": null,\\n \\\"returnCurrency\\\": \\\"KCS\\\"\\n }\\n}", "x-request-example": "{\\\"withdrawalId\\\": \\\"67e6515f7960ba0007b42025\\\"}", "operationId": "031" } }, "/api/v1/withdrawals": { "get": { "summary": "Get Withdrawal History", "deprecated": false, "description": "Request a withdrawal list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": true, "schema": { "type": "string", "example": [ "BTC", "ETH", "USDT" ] } }, { "name": "status", "in": "query", "description": "Status. Available value: REVIEW, PROCESSING, WALLET_PROCESSING, SUCCESS and FAILURE", "required": false, "schema": { "type": "string", "enum": [ "PROCESSING", "REVIEW", "WALLET_PROCESSING", "SUCCESS", "FAILURE" ], "x-api-enum": [ { "value": "PROCESSING", "name": "PROCESSING", "description": "" }, { "value": "REVIEW", "name": "REVIEW", "description": "" }, { "value": "WALLET_PROCESSING", "name": "WALLET_PROCESSING", "description": "" }, { "value": "SUCCESS", "name": "SUCCESS", "description": "" }, { "value": "FAILURE", "name": "FAILURE", "description": "" } ] } }, { "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, "default": 50 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer", "description": "current page" }, "pageSize": { "type": "integer", "description": "page size" }, "totalNum": { "type": "integer", "description": "total number" }, "totalPage": { "type": "integer", "description": "total pages" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique ID" }, "currency": { "type": "string", "description": "Currency" }, "chain": { "type": "string", "description": "The chain id of currency", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "status": { "type": "string", "description": "Status. Available value: REVIEW, PROCESSING, WALLET_PROCESSING, SUCCESS and FAILURE", "enum": [ "REVIEW", "PROCESSING", "WALLET_PROCESSING", "FAILURE", "SUCCESS" ], "x-api-enum": [ { "value": "REVIEW", "name": "REVIEW", "description": "REVIEW" }, { "value": "PROCESSING", "name": "PROCESSING", "description": "PROCESSING" }, { "value": "WALLET_PROCESSING", "name": "WALLET_PROCESSING", "description": "WALLET_PROCESSING" }, { "value": "FAILURE", "name": "FAILURE", "description": "FAILURE" }, { "value": "SUCCESS", "name": "SUCCESS", "description": "SUCCESS" } ] }, "address": { "type": "string", "description": "Withwrawal address" }, "memo": { "type": "string", "description": "Address remark. If there’s no remark, it is empty. " }, "isInner": { "type": "boolean", "description": "Internal deposit or not" }, "amount": { "type": "string", "description": "Withwrawal amount" }, "fee": { "type": "string", "description": "Fees charged for withwrawal" }, "walletTxId": { "type": "string", "description": "Wallet Txid, If this is an internal\nwithdrawal, it is empty. " }, "createdAt": { "type": "integer", "description": "Database record creation time", "format": "int64" }, "updatedAt": { "type": "integer", "description": "Update time of the database record", "format": "int64" }, "remark": { "type": "string", "description": "Remark" } } } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470145", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Withdrawal", "x-sdk-method-name": "getWithdrawalHistory", "x-sdk-method-description": "Request a withdrawal list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 50,\\n \\\"totalNum\\\": 5,\\n \\\"totalPage\\\": 1,\\n \\\"items\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"chain\\\": \\\"\\\",\\n \\\"status\\\": \\\"SUCCESS\\\",\\n \\\"address\\\": \\\"a435*****@gmail.com\\\",\\n \\\"memo\\\": \\\"\\\",\\n \\\"isInner\\\": true,\\n \\\"amount\\\": \\\"1.00000000\\\",\\n \\\"fee\\\": \\\"0.00000000\\\",\\n \\\"walletTxId\\\": null,\\n \\\"createdAt\\\": 1728555875000,\\n \\\"updatedAt\\\": 1728555875000,\\n \\\"remark\\\": \\\"\\\",\\n \\\"arrears\\\": false\\n },\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"chain\\\": \\\"trx\\\",\\n \\\"status\\\": \\\"SUCCESS\\\",\\n \\\"address\\\": \\\"TSv3L1fS7******X4nLP6rqNxYz\\\",\\n \\\"memo\\\": \\\"\\\",\\n \\\"isInner\\\": true,\\n \\\"amount\\\": \\\"6.00000000\\\",\\n \\\"fee\\\": \\\"0.00000000\\\",\\n \\\"walletTxId\\\": null,\\n \\\"createdAt\\\": 1721730920000,\\n \\\"updatedAt\\\": 1721730920000,\\n \\\"remark\\\": \\\"\\\",\\n \\\"arrears\\\": false\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"status\\\": \\\"SUCCESS\\\", \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000, \\\"currentPage\\\": 1, \\\"pageSize\\\": 50}", "operationId": "030" }, "post": { "summary": "Withdraw - V1", "deprecated": true, "description": "Use this interface to withdraw the specified currency.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "withdrawalId": { "type": "string", "description": "Withdrawal id, a unique ID for a withdrawal" } }, "required": [ "withdrawalId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470310", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Withdrawal", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Withdrawal", "x-sdk-method-name": "withdrawalV1", "x-sdk-method-description": "Use this interface to withdraw the specified currency.", "x-api-rate-limit-weight": 5, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "currency": { "type": "string", "description": "currency", "example": [ "BTC", "ETH", "USDT" ] }, "chain": { "type": "string", "description": "The chainId of currency, For a currency with multiple chains, it is recommended to specify the chain parameter instead of using the default chain; you can query the chainId through the response of the GET /api/v3/currencies/{currency} interface.", "default": "eth", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "address": { "type": "string", "description": "Withdrawal address" }, "amount": { "type": "integer", "format": "int64", "description": "Withdrawal amount, a positive number which is a multiple of the amount precision" }, "memo": { "type": "string", "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to KuCoin, you need to fill in memo(tag). Be careful: If you do not fill in memo(tag), your deposit may not be available." }, "isInner": { "type": "boolean", "description": "Internal withdrawal or not. Default: False", "default": false }, "remark": { "type": "string", "description": "Remark" }, "feeDeductType": { "type": "string", "description": "Withdrawal fee deduction type: INTERNAL, EXTERNAL, or not specified\n\n1. INTERNAL: Deduct the transaction fees from your withdrawal amount\n2. EXTERNAL: Deduct the transaction fees from your main account\n3. If you don't specify the feeDeductType parameter, when the balance in your main account is sufficient to support the withdrawal, the system will initially deduct the transaction fees from your main account. But if the balance in your main account is not sufficient to support the withdrawal, the system will deduct the fees from your withdrawal amount. For example: Suppose you are going to withdraw 1 BTC from the KuCoin platform (transaction fee: 0.0001BTC), if the balance in your main account is insufficient, the system will deduct the transaction fees from your withdrawal amount. In this case, you will be receiving 0.9999BTC." } }, "required": [ "currency", "address", "amount" ] }, "example": "{\n \"currency\": \"USDT\",\n \"address\": \"TKFRQXSDc****16GmLrjJggwX8\",\n \"amount\": 3,\n \"chain\": \"trx\",\n \"isInner\": true\n}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"withdrawalId\\\":\\\"670a973cf07b3800070e216c\\\"}}", "x-request-example": "{\\\"currency\\\": \\\"USDT\\\", \\\"address\\\": \\\"TKFRQXSDc****16GmLrjJggwX8\\\", \\\"amount\\\": 3, \\\"chain\\\": \\\"trx\\\", \\\"isInner\\\": true}", "operationId": "049" } }, "/api/v1/accounts/transferable": { "get": { "summary": "Get Transfer Quotas", "deprecated": false, "description": "This endpoint returns the transferable balance of a specified account.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": true, "schema": { "type": "string", "example": [ "BTC", "ETH", "USDT" ] } }, { "name": "type", "in": "query", "description": "The account type:MAIN, TRADE, MARGIN, ISOLATED, MARGIN_V2, ISOLATED_V2", "required": true, "schema": { "type": "string", "enum": [ "MAIN", "TRADE", "MARGIN", "ISOLATED", "OPTION", "MARGIN_V2", "ISOLATED_V2" ], "x-api-enum": [ { "value": "MAIN", "name": "MAIN", "description": "Funding account" }, { "value": "TRADE", "name": "TRADE", "description": "Spot account" }, { "value": "MARGIN", "name": "MARGIN", "description": "Spot cross margin account" }, { "value": "ISOLATED", "name": "ISOLATED", "description": "Spot isolated margin account" }, { "value": "OPTION", "name": "OPTION", "description": "Option account" }, { "value": "MARGIN_V2", "name": "MARGIN_V2", "description": "Spot cross margin HF account" }, { "value": "ISOLATED_V2", "name": "ISOLATED_V2", "description": "Spot isolated margin HF account" } ] } }, { "name": "tag", "in": "query", "description": "Trading pair required when the account type is ISOLATED; other types do not pass, e.g.: BTC-USDT", "required": false, "schema": { "type": "string", "default": "BTC-USDT", "example": [ "ETH-USDT", "KCS-USDT" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency" }, "balance": { "type": "string", "description": "Total funds in an account." }, "available": { "type": "string", "description": "Funds available to withdraw or trade." }, "holds": { "type": "string", "description": "Funds on hold (not available for use)." }, "transferable": { "type": "string", "description": "Funds available to transfer." } }, "required": [ "currency", "balance", "available", "holds", "transferable" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470148", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Transfer", "x-sdk-method-name": "getTransferQuotas", "x-sdk-method-description": "This endpoint returns the transferable balance of a specified account.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"currency\\\":\\\"USDT\\\",\\\"balance\\\":\\\"10.5\\\",\\\"available\\\":\\\"10.5\\\",\\\"holds\\\":\\\"0\\\",\\\"transferable\\\":\\\"10.5\\\"}}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"type\\\": \\\"MAIN\\\", \\\"tag\\\": \\\"ETH-USDT\\\"}", "operationId": "032" } }, "/api/v3/accounts/universal-transfer": { "post": { "summary": "Flex Transfer", "deprecated": false, "description": "This interface can be used for transfers between master- and sub-accounts and transfers", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Transfer order ID" } }, "required": [ "orderId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470147", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "FlexTransfers", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Transfer", "x-sdk-method-name": "flexTransfer", "x-sdk-method-description": "This interface can be used for transfers between master- and sub-accounts and transfers", "x-api-rate-limit-weight": 4, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "clientOid": { "type": "string", "description": "Unique order ID created by users to identify their orders, e.g. UUID, with a maximum length of 128 bits" }, "currency": { "type": "string", "description": "currency" }, "amount": { "type": "string", "description": "Transfer amount: The amount is a positive integer multiple of the currency precision." }, "fromUserId": { "type": "string", "description": "Transfer out UserId: This is required when transferring from sub-account to master-account. It is optional for internal transfers." }, "fromAccountType": { "type": "string", "description": "Account type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED, MARGIN_V2, ISOLATED_V2", "enum": [ "MAIN", "TRADE", "CONTRACT", "MARGIN", "ISOLATED", "MARGIN_V2", "ISOLATED_V2", "OPTION" ], "x-api-enum": [ { "value": "MAIN", "name": "MAIN", "description": "Funding account" }, { "value": "TRADE", "name": "TRADE", "description": "Spot account" }, { "value": "CONTRACT", "name": "CONTRACT", "description": "Futures account" }, { "value": "MARGIN", "name": "MARGIN", "description": "Cross margin account" }, { "value": "ISOLATED", "name": "ISOLATED", "description": "Isolated margin account" }, { "value": "MARGIN_V2", "name": "MARGIN_V2", "description": "Cross margin account" }, { "value": "ISOLATED_V2", "name": "ISOLATED_V2", "description": "Isolated margin account" }, { "value": "OPTION", "name": "OPTION", "description": "Option account" } ] }, "fromAccountTag": { "type": "string", "description": "Symbol: Required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT" }, "type": { "type": "string", "description": "Transfer type: INTERNAL (Transfer within account), PARENT_TO_SUB (Transfer from master-account to sub-account), SUB_TO_PARENT (Transfer from sub-account to master-account)", "enum": [ "INTERNAL", "PARENT_TO_SUB", "SUB_TO_PARENT" ], "x-api-enum": [ { "value": "INTERNAL", "name": "", "description": "" }, { "value": "PARENT_TO_SUB", "name": "", "description": "" }, { "value": "SUB_TO_PARENT", "name": "", "description": "" } ] }, "toUserId": { "type": "string", "description": "Transfer in UserId: This is required when transferring master-account to sub-account. It is optional for internal transfers." }, "toAccountType": { "type": "string", "description": "Account type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED, MARGIN_V2, ISOLATED_V2", "enum": [ "MAIN", "TRADE", "CONTRACT", "MARGIN", "ISOLATED", "MARGIN_V2", "ISOLATED_V2", "OPTION" ], "x-api-enum": [ { "value": "MAIN", "name": "MAIN", "description": "Funding account" }, { "value": "TRADE", "name": "TRADE", "description": "Spot account" }, { "value": "CONTRACT", "name": "CONTRACT", "description": "Futures account" }, { "value": "MARGIN", "name": "MARGIN", "description": "Cross margin account" }, { "value": "ISOLATED", "name": "ISOLATED", "description": "Isolated margin account" }, { "value": "MARGIN_V2", "name": "MARGIN_V2", "description": "Cross margin account" }, { "value": "ISOLATED_V2", "name": "ISOLATED_V2", "description": "Isolated margin account" }, { "value": "OPTION", "name": "OPTION", "description": "Option account" } ] }, "toAccountTag": { "type": "string", "description": "Symbol: Required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT" } }, "required": [ "clientOid", "amount", "fromAccountType", "type", "toAccountType", "currency" ] }, "example": "//transfer from master-account to sub-account\n{\n \"clientOid\": \"64ccc0f164781800010d8c09\",\n \"type\": \"PARENT_TO_SUB\",\n \"currency\": \"USDT\",\n \"amount\": \"0.01\",\n \"fromAccountType\": \"TRADE\",\n \"toUserId\": \"63743f07e0c5230001761d08\",\n \"toAccountType\": \"TRADE\"\n}\n\n//transfer from sub-account to master-account\n// {\n// \"clientOid\": \"64ccc0f164781800010d8c09\",\n// \"type\": \"SUB_TO_PARENT\",\n// \"currency\": \"BTC\",\n// \"amount\": 1,\n// \"fromUserId\": \"62f5f5d4d72aaf000122707e\",\n// \"fromAccountType\": \"TRADE\",\n// \"toAccountType\": \"CONTRACT\"\n// }\n\n// internal transfer\n// {\n// \"clientOid\": \"53666633336123\",\n// \"type\": \"INTERNAL\",\n// \"currency\": \"BTC\",\n// \"amount\": 0.0003,\n// \"fromAccountType\": \"TRADE\",\n// \"toAccountType\": \"MAIN\"\n// }\n\n\n\n\n\n" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"orderId\\\": \\\"6705f7248c6954000733ecac\\\"\\n }\\n}", "x-request-example": "{\\\"clientOid\\\": \\\"64ccc0f164781800010d8c09\\\", \\\"type\\\": \\\"PARENT_TO_SUB\\\", \\\"currency\\\": \\\"USDT\\\", \\\"amount\\\": \\\"0.01\\\", \\\"fromAccountType\\\": \\\"TRADE\\\", \\\"toUserId\\\": \\\"63743f07e0c5230001761d08\\\", \\\"toAccountType\\\": \\\"TRADE\\\"}", "operationId": "033" } }, "/api/v1/base-fee": { "get": { "summary": "Get Basic Fee - Spot/Margin", "deprecated": false, "description": "This interface is for the user’s spot/margin basic fee rate.", "tags": [], "parameters": [ { "name": "currencyType", "in": "query", "description": "Currency type: 0-crypto currency, 1-fiat currency. Default is 0-crypto currency", "required": false, "schema": { "type": "integer", "enum": [ 0, 1 ], "default": 0, "x-api-enum": [ { "value": 0, "name": "", "description": "cryptocurrency" }, { "value": 1, "name": "", "description": "fiat currency" } ], "example": [ 1 ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "takerFeeRate": { "type": "string", "description": "Base taker fee rate" }, "makerFeeRate": { "type": "string", "description": "Base maker fee rate" } }, "required": [ "takerFeeRate", "makerFeeRate" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470149", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Account", "x-sdk-sub-service": "Fee", "x-sdk-method-name": "getBasicFee", "x-sdk-method-description": "This interface is for the user’s spot/margin basic fee rate.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"takerFeeRate\\\": \\\"0.001\\\",\\n \\\"makerFeeRate\\\": \\\"0.001\\\"\\n }\\n}", "x-request-example": "{\\\"currencyType\\\": 1}", "operationId": "034" } }, "/api/v1/trade-fees": { "get": { "summary": "Get Actual Fee - Spot/Margin", "deprecated": false, "description": "This interface is for the trading pair’s actual fee rate. You can inquire about fee rates of 10 trading pairs each time at most. The fee rate of your sub-account is the same as that of the master account.", "tags": [], "parameters": [ { "name": "symbols", "in": "query", "description": "Trading pair (optional; you can inquire fee rates of 10 trading pairs each time at most)", "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": { "symbol": { "type": "string", "description": "The unique identity of the trading pair; will not change even if the trading pair is renamed" }, "takerFeeRate": { "type": "string", "description": "Actual taker fee rate of the symbol" }, "makerFeeRate": { "type": "string", "description": "Actual maker fee rate of the symbol" }, "sellTaxRate": { "type": "string", "description": "Buy tax rate; this field is visible to users in certain countries" }, "buyTaxRate": { "type": "string", "description": "Sell tax rate; this field is visible to users in certain countries" } }, "required": [ "symbol", "takerFeeRate", "makerFeeRate" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470150", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Account", "x-sdk-sub-service": "Fee", "x-sdk-method-name": "getSpotActualFee", "x-sdk-method-description": "This interface is for the trading pair’s actual fee rate. You can inquire about fee rates of 10 trading pairs each time at most. The fee rate of your sub-account is the same as that of the master account.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":[{\\\"symbol\\\":\\\"BTC-USDT\\\",\\\"takerFeeRate\\\":\\\"0.001\\\",\\\"makerFeeRate\\\":\\\"0.001\\\"},{\\\"symbol\\\":\\\"ETH-USDT\\\",\\\"takerFeeRate\\\":\\\"0.001\\\",\\\"makerFeeRate\\\":\\\"0.001\\\"}]}", "x-request-example": "{\\\"symbols\\\": \\\"BTC-USDT,ETH-USDT\\\"}", "operationId": "035" }, "patch": { "summary": "Get Actual Fee - Futures", "deprecated": false, "description": "This interface is for the trading pair’s actual futures fee rate. The fee rate of your sub-account is the same as that of the master account.", "tags": [], "parameters": [ { "name": "symbol", "in": "query", "description": "The unique identity of the trading pair; will not change even if the trading pair is renamed", "required": true, "schema": { "type": "string", "example": [ "XBTUSDTM", "XBTUSDM", "ETHUSDTM" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "symbol": { "type": "string", "description": "The unique identity of the trading pair; will not change even if the trading pair is renamed" }, "takerFeeRate": { "type": "string", "description": "Actual taker fee rate of the trading pair" }, "makerFeeRate": { "type": "string", "description": "Actual maker fee rate of the trading pair" } }, "required": [ "symbol", "takerFeeRate", "makerFeeRate" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470151", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Futures", "x-sdk-service": "Account", "x-sdk-sub-service": "Fee", "x-sdk-method-name": "getFuturesActualFee", "x-sdk-method-description": "This interface is for the trading pair’s actual futures fee rate. The fee rate of your sub-account is the same as that of the master account.", "x-api-rate-limit-weight": 3, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"symbol\\\":\\\"XBTUSDTM\\\",\\\"takerFeeRate\\\":\\\"0.0006\\\",\\\"makerFeeRate\\\":\\\"0.0002\\\"}}", "x-request-example": "{\\\"symbol\\\": \\\"XBTUSDTM\\\"}", "operationId": "036", "x-original-method": "get" } }, "/api/v1/sub/user": { "get": { "summary": "Get sub-account List - Summary Info (V1)", "deprecated": true, "description": "You can get the user info of all sub-account via this interface; it is recommended to use the GET /api/v2/sub/user interface for paging query", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "uid": { "type": "integer" }, "subName": { "type": "string" }, "type": { "type": "integer" }, "remarks": { "type": "string" }, "access": { "type": "string", "description": "Sub-account Permission" } }, "required": [ "userId", "uid", "subName", "type", "remarks", "access" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470298", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "getSpotSubAccountsSummaryV1", "x-sdk-method-description": "You can get the user info of all sub-account via this interface; it is recommended to use the GET /api/v2/sub/user interface for paging query", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"userId\\\": \\\"63743f07e0c5230001761d08\\\",\\n \\\"uid\\\": 169579801,\\n \\\"subName\\\": \\\"testapi6\\\",\\n \\\"type\\\": 0,\\n \\\"remarks\\\": \\\"remarks\\\",\\n \\\"access\\\": \\\"All\\\"\\n },\\n {\\n \\\"userId\\\": \\\"670538a31037eb000115b076\\\",\\n \\\"uid\\\": 225139445,\\n \\\"subName\\\": \\\"Name1234567\\\",\\n \\\"type\\\": 0,\\n \\\"remarks\\\": \\\"TheRemark\\\",\\n \\\"access\\\": \\\"All\\\"\\n }\\n ]\\n}", "operationId": "037" } }, "/api/v1/sub-accounts": { "get": { "summary": "Get sub-account List - Spot Balance (V1)", "deprecated": true, "description": "This endpoint returns the account info of all sub-users.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "subUserId": { "type": "string", "description": "The user ID of the sub-user." }, "subName": { "type": "string", "description": "The username of the sub-user." }, "mainAccounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the account." }, "balance": { "type": "string", "description": "Total funds in the account." }, "available": { "type": "string", "description": "Funds available to withdraw or trade." }, "holds": { "type": "string", "description": "Funds on hold (not available for use)." }, "baseCurrency": { "type": "string", "description": "Calculated on this currency." }, "baseCurrencyPrice": { "type": "string", "description": "The base currency price." }, "baseAmount": { "type": "string", "description": "The base currency amount." }, "tag": { "type": "string" } } }, "description": "Funding Account" }, "tradeAccounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the account." }, "balance": { "type": "string", "description": "Total funds in the account." }, "available": { "type": "string", "description": "Funds available to withdraw or trade." }, "holds": { "type": "string", "description": "Funds on hold (not available for use)." }, "baseCurrency": { "type": "string", "description": "Calculated on this currency." }, "baseCurrencyPrice": { "type": "string", "description": "The base currency price." }, "baseAmount": { "type": "string", "description": "The base currency amount." }, "tag": { "type": "string" } } }, "description": "Spot Account" }, "marginAccounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the account." }, "balance": { "type": "string", "description": "Total funds in the account." }, "available": { "type": "string", "description": "Funds available to withdraw or trade." }, "holds": { "type": "string", "description": "Funds on hold (not available for use)." }, "baseCurrency": { "type": "string", "description": "Calculated on this currency." }, "baseCurrencyPrice": { "type": "string", "description": "The base currency price." }, "baseAmount": { "type": "string", "description": "The base currency amount." }, "tag": { "type": "string" } } }, "description": "Margin Account" }, "tradeHFAccounts": { "type": "array", "items": { "type": "string" }, "description": "This param is deprecated and only valid for some old users" } }, "required": [ "subUserId", "subName", "mainAccounts", "tradeAccounts", "marginAccounts", "tradeHFAccounts" ] } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470299", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "SubAccount", "x-sdk-method-name": "getSpotSubAccountListV1", "x-sdk-method-description": "This endpoint returns the account info of all sub-users.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"subUserId\\\": \\\"63743f07e0c5230001761d08\\\",\\n \\\"subName\\\": \\\"testapi6\\\",\\n \\\"mainAccounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"balance\\\": \\\"0.01\\\",\\n \\\"available\\\": \\\"0.01\\\",\\n \\\"holds\\\": \\\"0\\\",\\n \\\"baseCurrency\\\": \\\"BTC\\\",\\n \\\"baseCurrencyPrice\\\": \\\"62489.8\\\",\\n \\\"baseAmount\\\": \\\"0.00000016\\\",\\n \\\"tag\\\": \\\"DEFAULT\\\"\\n }\\n ],\\n \\\"tradeAccounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"balance\\\": \\\"0.01\\\",\\n \\\"available\\\": \\\"0.01\\\",\\n \\\"holds\\\": \\\"0\\\",\\n \\\"baseCurrency\\\": \\\"BTC\\\",\\n \\\"baseCurrencyPrice\\\": \\\"62489.8\\\",\\n \\\"baseAmount\\\": \\\"0.00000016\\\",\\n \\\"tag\\\": \\\"DEFAULT\\\"\\n }\\n ],\\n \\\"marginAccounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"balance\\\": \\\"0.01\\\",\\n \\\"available\\\": \\\"0.01\\\",\\n \\\"holds\\\": \\\"0\\\",\\n \\\"baseCurrency\\\": \\\"BTC\\\",\\n \\\"baseCurrencyPrice\\\": \\\"62489.8\\\",\\n \\\"baseAmount\\\": \\\"0.00000016\\\",\\n \\\"tag\\\": \\\"DEFAULT\\\"\\n }\\n ],\\n \\\"tradeHFAccounts\\\": []\\n },\\n {\\n \\\"subUserId\\\": \\\"670538a31037eb000115b076\\\",\\n \\\"subName\\\": \\\"Name1234567\\\",\\n \\\"mainAccounts\\\": [],\\n \\\"tradeAccounts\\\": [],\\n \\\"marginAccounts\\\": [],\\n \\\"tradeHFAccounts\\\": []\\n },\\n {\\n \\\"subUserId\\\": \\\"66b0c0905fc1480001c14c36\\\",\\n \\\"subName\\\": \\\"LTkucoin1491\\\",\\n \\\"mainAccounts\\\": [],\\n \\\"tradeAccounts\\\": [],\\n \\\"marginAccounts\\\": [],\\n \\\"tradeHFAccounts\\\": []\\n }\\n ]\\n}", "operationId": "038" } }, "/api/v2/deposit-addresses": { "get": { "summary": "Get Deposit Addresses (V2)", "deprecated": true, "description": "Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to add the deposit address first.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": true, "schema": { "type": "string", "example": [ "BTC", "ETH", "USDT" ] } }, { "name": "chain", "in": "query", "description": "Chain ID of currency", "required": false, "schema": { "type": "string", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Deposit address" }, "memo": { "type": "string", "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to KuCoin, you need to fill in memo(tag). Be careful: If you do not fill in memo(tag), your deposit may not be available." }, "chain": { "type": "string", "description": "The chainName of currency", "example": [ "ERC20", "BTC-Segwit", "BTC", "KCC", "TRC20", "BEP20", "ARBITRUM", "TON", "OPTIMISM" ] }, "chainId": { "type": "string", "description": "The chainId of currency", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "to": { "type": "string", "description": "Deposit account type: main (funding account), trade (spot trading account)", "enum": [ "MAIN", "TRADE" ], "x-api-enum": [ { "value": "MAIN", "name": "", "description": "" }, { "value": "TRADE", "name": "", "description": "" } ] }, "currency": { "type": "string", "description": "currency", "example": [ "BTC", "ETH", "USDT" ] }, "contractAddress": { "type": "string", "description": "The token contract address." } } } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470300", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Deposit", "x-sdk-method-name": "getDepositAddressV2", "x-sdk-method-description": "Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to add the deposit address first.", "x-api-rate-limit-weight": 5, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": [\\n {\\n \\\"address\\\": \\\"0x02028456*****87ede7a73d7c\\\",\\n \\\"memo\\\": \\\"\\\",\\n \\\"chain\\\": \\\"ERC20\\\",\\n \\\"chainId\\\": \\\"eth\\\",\\n \\\"to\\\": \\\"MAIN\\\",\\n \\\"currency\\\": \\\"ETH\\\",\\n \\\"contractAddress\\\": \\\"\\\"\\n }\\n ]\\n}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"chain\\\": \\\"eth\\\"}", "operationId": "039" } }, "/api/v1/deposit-addresses": { "get": { "summary": "Get Deposit Addresses - V1", "deprecated": true, "description": "Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to add the deposit address first.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": true, "schema": { "type": "string", "example": [ "BTC", "ETH", "USDT" ] } }, { "name": "chain", "in": "query", "description": "The chainId of currency, e.g. the available values for USDT are OMNI, ERC20, and TRC20; default is ERC20. The available values for BTC are Native, Segwit, TRC20; the parameters are bech32, btc, trx; default is Native. This only applies to multi-chain currencies; no need for single-chain currencies.", "required": false, "schema": { "type": "string", "default": "eth", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "address": { "type": "string", "description": "Deposit address" }, "memo": { "type": "string", "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to KuCoin, you need to fill in memo(tag). Be careful: If you do not fill in memo(tag), your deposit may not be available." }, "chain": { "type": "string", "description": "The chainName of currency", "example": [ "ERC20", "BTC-Segwit", "BTC", "KCC", "TRC20", "BEP20", "ARBITRUM", "TON", "OPTIMISM" ] }, "chainId": { "type": "string", "description": "The chainId of currency", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "to": { "type": "string", "description": "Deposit account type: main (funding account), trade (spot trading account)", "enum": [ "MAIN", "TRADE" ], "x-api-enum": [ { "value": "MAIN", "name": "", "description": "" }, { "value": "TRADE", "name": "", "description": "" } ] }, "currency": { "type": "string", "description": "currency", "example": [ "BTC", "ETH", "USDT" ] }, "contractAddress": { "type": "string", "description": "The token contract address." } } } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470305", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Deposit", "x-sdk-method-name": "getDepositAddressV1", "x-sdk-method-description": "Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to add the deposit address first.", "x-api-rate-limit-weight": 5, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"address\\\": \\\"0xea220bf61c3c2b0adc2cfa29fec3d2677745a379\\\",\\n \\\"memo\\\": \\\"\\\",\\n \\\"chain\\\": \\\"ERC20\\\",\\n \\\"chainId\\\": \\\"eth\\\",\\n \\\"to\\\": \\\"MAIN\\\",\\n \\\"currency\\\": \\\"USDT\\\"\\n }\\n}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"chain\\\": \\\"eth\\\"}", "operationId": "040" }, "post": { "summary": "Add Deposit Address - V1", "deprecated": true, "description": "Request via this endpoint the creation of a deposit address for a currency you intend to deposit.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "address": { "type": "string", "description": "Deposit address" }, "memo": { "type": "string", "description": "Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to KuCoin, you need to fill in memo(tag). Be careful: If you do not fill in memo(tag), your deposit may not be available." }, "chain": { "type": "string", "description": "The chainName of currency", "example": [ "ERC20", "BTC-Segwit", "BTC", "KCC", "TRC20", "BEP20", "ARBITRUM", "TON", "OPTIMISM" ] }, "chainId": { "type": "string", "description": "The chainId of currency", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "to": { "type": "string", "description": "Deposit account type: main (funding account), trade (spot trading account)", "enum": [ "MAIN", "TRADE" ], "x-api-enum": [ { "value": "MAIN", "name": "", "description": "" }, { "value": "TRADE", "name": "", "description": "" } ] }, "currency": { "type": "string", "description": "currency", "example": [ "BTC", "ETH", "USDT" ] } }, "required": [ "address", "memo", "chain", "to", "currency", "chainId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470309", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Deposit", "x-sdk-method-name": "addDepositAddressV1", "x-sdk-method-description": "Request via this endpoint the creation of a deposit address for a currency you intend to deposit.", "x-api-rate-limit-weight": 20, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "currency": { "type": "string", "description": "currency", "example": [ "BTC", "ETH", "USDT" ] }, "chain": { "type": "string", "description": "The chainId of currency, e.g. the available values for USDT are OMNI, ERC20, and TRC20; default is ERC20. The available values for BTC are Native, Segwit, TRC20; the parameters are bech32, btc, trx; default is Native. This only applies to multi-chain currencies; no need for single-chain currencies.", "default": "eth", "example": [ "eth", "bech32", "btc", "kcc", "trx", "bsc", "arbitrum", "ton", "optimism" ] }, "to": { "type": "string", "description": "Deposit account type: main (funding account), trade (spot trading account); the default is main", "enum": [ "MAIN", "TRADE" ], "default": "MAIN", "x-api-enum": [ { "value": "MAIN", "name": "main", "description": "Funding account" }, { "value": "TRADE", "name": "trade", "description": "Spot account" } ] } }, "required": [ "currency" ] }, "example": "{\n \"currency\": \"ETH\",\n \"chain\": \"eth\",\n \"to\": \"MAIN\"\n}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"address\\\":\\\"0x02028456f38e78609904e8a002c787ede7a73d7c\\\",\\\"memo\\\":null,\\\"chain\\\":\\\"ERC20\\\",\\\"chainId\\\":\\\"eth\\\",\\\"to\\\":\\\"MAIN\\\",\\\"currency\\\":\\\"ETH\\\"}}", "x-request-example": "{\\\"currency\\\": \\\"ETH\\\", \\\"chain\\\": \\\"eth\\\", \\\"to\\\": \\\"MAIN\\\"}", "operationId": "048" } }, "/api/v2/accounts/sub-transfer": { "post": { "summary": "Sub-account Transfer", "deprecated": true, "description": "Funds in the main account, trading account and margin account of a Master Account can be transferred to the main account, trading account, futures account and margin account of its Sub-Account. The futures account of both the Master Account and Sub-Account can only accept funds transferred in from the main account, trading account and margin account and cannot transfer out to these accounts.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Transfer order ID" } }, "required": [ "orderId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470301", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Transfer", "x-sdk-method-name": "subAccountTransfer", "x-sdk-method-description": "Funds in the main account, trading account and margin account of a Master Account can be transferred to the main account, trading account, futures account and margin account of its Sub-Account. The futures account of both the Master Account and Sub-Account can only accept funds transferred in from the main account, trading account and margin account and cannot transfer out to these accounts.", "x-api-rate-limit-weight": 30, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "clientOid": { "type": "string", "description": "Unique order ID created by users to identify their orders, e.g. UUID, with a maximum length of 128 bits" }, "currency": { "type": "string", "description": "currency" }, "amount": { "type": "string", "description": "Transfer amount: The amount is a positive integer multiple of the currency precision." }, "direction": { "type": "string", "description": "OUT — the master user to sub user\nIN — the sub user to the master user", "enum": [ "IN", "OUT" ], "x-api-enum": [ { "value": "IN", "name": "", "description": "" }, { "value": "OUT", "name": "", "description": "" } ] }, "accountType": { "type": "string", "description": "Account type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED", "enum": [ "MAIN", "TRADE", "MARGIN", "CONTRACT", "OPTION" ], "default": "MAIN", "x-api-enum": [ { "value": "MAIN", "name": "MAIN", "description": "Funding account" }, { "value": "TRADE", "name": "TRADE", "description": "Spot account" }, { "value": "MARGIN", "name": "MARGIN", "description": "Margin account" }, { "value": "CONTRACT", "name": "CONTRACT", "description": "Futures account" }, { "value": "OPTION", "name": "OPTION", "description": "Option account" } ] }, "subAccountType": { "type": "string", "description": "Sub-account type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED", "enum": [ "MAIN", "TRADE", "MARGIN", "CONTRACT" ], "default": "MAIN", "x-api-enum": [ { "value": "MAIN", "name": "", "description": "" }, { "value": "TRADE", "name": "", "description": "" }, { "value": "MARGIN", "name": "", "description": "" }, { "value": "CONTRACT", "name": "", "description": "" } ] }, "subUserId": { "type": "string", "description": "the user ID of a sub-account." }, "tag": { "type": "string", "description": " Need to be defined if accountType=ISOLATED.", "maxLength": 20, "example": [ "BTC-USDT" ] }, "subTag": { "type": "string", "description": " Need to be defined if subAccountType=ISOLATED.", "maxLength": 20, "example": [ "BTC-USDT" ] } }, "required": [ "clientOid", "amount", "currency", "direction", "subTag" ] }, "example": "{\n \"clientOid\": \"64ccc0f164781800010d8c09\",\n \"currency\": \"USDT\",\n \"amount\": \"0.01\",\n \"direction\": \"OUT\",\n \"accountType\": \"MAIN\",\n \"subAccountType\": \"MAIN\",\n \"subUserId\": \"63743f07e0c5230001761d08\"\n}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"orderId\\\":\\\"670be6b0b1b9080007040a9b\\\"}}", "x-request-example": "{\\\"clientOid\\\": \\\"64ccc0f164781800010d8c09\\\", \\\"currency\\\": \\\"USDT\\\", \\\"amount\\\": \\\"0.01\\\", \\\"direction\\\": \\\"OUT\\\", \\\"accountType\\\": \\\"MAIN\\\", \\\"subAccountType\\\": \\\"MAIN\\\", \\\"subUserId\\\": \\\"63743f07e0c5230001761d08\\\"}", "operationId": "041" } }, "/api/v1/hist-deposits": { "get": { "summary": "Get Deposit History - Old", "deprecated": true, "description": "Request the V1 historical deposits list on KuCoin via this endpoint. The return value is the data after Pagination, sorted in descending order according to time.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": true, "schema": { "type": "string", "example": [ "BTC", "ETH", "USDT" ] } }, { "name": "status", "in": "query", "description": "Status. Available value: PROCESSING, SUCCESS, and FAILURE", "required": false, "schema": { "type": "string", "enum": [ "PROCESSING", "SUCCESS", "FAILURE" ], "x-api-enum": [ { "value": "PROCESSING", "name": "", "description": "" }, { "value": "SUCCESS", "name": "", "description": "" }, { "value": "FAILURE", "name": "", "description": "" } ] } }, { "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" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer", "description": "current page" }, "pageSize": { "type": "integer", "description": "page size" }, "totalNum": { "type": "integer", "description": "total number" }, "totalPage": { "type": "integer", "description": "total pages" }, "items": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency" }, "createAt": { "type": "integer", "description": "Database record creation time" }, "amount": { "type": "string", "description": "Deposit amount" }, "walletTxId": { "type": "string", "description": "Wallet Txid" }, "isInner": { "type": "boolean", "description": "Internal deposit or not" }, "status": { "type": "string", "enum": [ "PROCESSING", "SUCCESS", "FAILURE" ], "x-api-enum": [ { "value": "PROCESSING", "name": "", "description": "" }, { "value": "SUCCESS", "name": "", "description": "" }, { "value": "FAILURE", "name": "", "description": "" } ] } } } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470306", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Deposit", "x-sdk-method-name": "getDepositHistoryOld", "x-sdk-method-description": "Request the V1 historical deposits list on KuCoin via this endpoint. The return value is the data after Pagination, sorted in descending order according to time.", "x-api-rate-limit-weight": 5, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 50,\\n \\\"totalNum\\\": 0,\\n \\\"totalPage\\\": 0,\\n \\\"items\\\": [\\n {\\n \\\"currency\\\": \\\"BTC\\\",\\n \\\"createAt\\\": 1528536998,\\n \\\"amount\\\": \\\"0.03266638\\\",\\n \\\"walletTxId\\\": \\\"55c643bc2c68d6f17266383ac1be9e454038864b929ae7cee0bc408cc5c869e8@12ffGWmMMD1zA1WbFm7Ho3JZ1w6NYXjpFk@234\\\",\\n \\\"isInner\\\": false,\\n \\\"status\\\": \\\"SUCCESS\\\"\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"status\\\": \\\"SUCCESS\\\", \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000}", "operationId": "042" } }, "/api/v2/accounts/inner-transfer": { "post": { "summary": "Internal Transfer", "deprecated": true, "description": "This API endpoint can be used to transfer funds between accounts internally. Users can transfer funds between their accounts free of charge. ", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "orderId": { "type": "string", "description": "Transfer order ID" } }, "required": [ "orderId" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470302", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "Spot", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Transfer", "x-sdk-method-name": "innerTransfer", "x-sdk-method-description": "This API endpoint can be used to transfer funds between accounts internally. Users can transfer funds between their accounts free of charge. ", "x-api-rate-limit-weight": 10, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "clientOid": { "type": "string", "description": "Unique order ID created by users to identify their orders, e.g. UUID, with a maximum length of 128 bits" }, "currency": { "type": "string", "description": "currency" }, "amount": { "type": "string", "description": "Transfer amount: The amount is a positive integer multiple of the currency precision." }, "to": { "type": "string", "description": "Receiving Account Type: main, trade, margin, isolated, margin_v2, isolated_v2, contract", "enum": [ "main", "trade", "margin", "isolated", "margin_v2", "isolated_v2", "option" ], "x-api-enum": [ { "value": "main", "name": "main", "description": "Funding account" }, { "value": "trade", "name": "trade", "description": "Spot account" }, { "value": "margin", "name": "margin", "description": "Cross margin account" }, { "value": "isolated", "name": "isolated", "description": "Isolated margin account" }, { "value": "margin_v2", "name": "margin_v2", "description": "Cross margin account" }, { "value": "isolated_v2", "name": "isolated_v2", "description": "Isolated margin account" }, { "value": "option", "name": "option", "description": "Option account" } ] }, "fromTag": { "type": "string", "description": "Trading pair, required when the payment account type is isolated, e.g.: BTC-USDT" }, "toTag": { "type": "string", "description": "Trading pair, required when the payment account type is isolated, e.g.: BTC-USDT" }, "from": { "type": "string", "description": "Payment Account Type: main, trade, margin, isolated, margin_v2, isolated_v2", "enum": [ "main", "trade", "margin", "isolated", "margin_v2", "isolated_v2", "option" ], "x-api-enum": [ { "value": "main", "name": "main", "description": "Funding account" }, { "value": "trade", "name": "trade", "description": "Spot account" }, { "value": "margin", "name": "margin", "description": "Cross margin account" }, { "value": "isolated", "name": "isolated", "description": "Isolated margin account" }, { "value": "margin_v2", "name": "margin_v2", "description": "Cross margin account" }, { "value": "isolated_v2", "name": "isolated_v2", "description": "Isolated margin account" }, { "value": "option", "name": "option", "description": "Option account" } ] } }, "required": [ "clientOid", "amount", "currency", "from", "to" ] }, "example": "{\n \"clientOid\": \"64ccc0f164781800010d8c09\",\n \"currency\": \"USDT\",\n \"amount\": \"0.01\",\n \"from\": \"main\",\n \"to\": \"trade\"\n}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"orderId\\\":\\\"670beb3482a1bb0007dec644\\\"}}", "x-request-example": "{\\\"clientOid\\\": \\\"64ccc0f164781800010d8c09\\\", \\\"currency\\\": \\\"USDT\\\", \\\"amount\\\": \\\"0.01\\\", \\\"from\\\": \\\"main\\\", \\\"to\\\": \\\"trade\\\"}", "operationId": "043" } }, "/api/v1/transfer-list": { "get": { "summary": "Get Futures Account Transfer Out Ledger", "deprecated": true, "description": "Futures account transfer out ledgers can be obtained at this endpoint.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": false, "schema": { "type": "string", "example": [ "XBT", "USDT", "ETH" ] } }, { "name": "type", "in": "query", "description": "Status PROCESSING, SUCCESS, FAILURE", "required": false, "schema": { "type": "string", "enum": [ "MAIN", "TRADE", "MARGIN", "ISOLATED" ], "x-api-enum": [ { "value": "MAIN", "name": "", "description": "" }, { "value": "TRADE", "name": "", "description": "" }, { "value": "MARGIN", "name": "", "description": "" }, { "value": "ISOLATED", "name": "", "description": "" } ] } }, { "name": "tag", "in": "query", "description": "Status List PROCESSING, SUCCESS, FAILURE", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "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. The default currentPage is 1", "required": false, "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "pageSize; the default pageSize is 50", "required": false, "schema": { "type": "integer", "format": "int64", "default": 50 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer", "description": "current page" }, "pageSize": { "type": "integer", "description": "page size" }, "totalNum": { "type": "integer", "description": "total number" }, "totalPage": { "type": "integer", "description": "total pages" }, "items": { "type": "array", "items": { "type": "object", "properties": { "applyId": { "type": "string", "description": "Transfer order ID" }, "currency": { "type": "string", "description": "Currency" }, "recRemark": { "type": "string", "description": "Receive account tx remark" }, "recSystem": { "type": "string", "description": "Receive system" }, "status": { "type": "string", "description": "Status PROCESSING, SUCCESS, FAILURE", "enum": [ "PROCESSING", "SUCCESS", "FAILURE" ], "x-api-enum": [ { "value": "PROCESSING", "name": "", "description": "" }, { "value": "SUCCESS", "name": "", "description": "" }, { "value": "FAILURE", "name": "", "description": "" } ] }, "amount": { "type": "string", "description": "Transaction amount" }, "reason": { "type": "string", "description": "Reason for the failure" }, "offset": { "type": "integer", "description": "Offset", "format": "int64" }, "createdAt": { "type": "integer", "description": "Request application time", "format": "int64" }, "remark": { "type": "string", "description": "User remark" } } } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470307", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Transfer", "x-sdk-method-name": "getFuturesAccountTransferOutLedger", "x-sdk-method-description": "Futures account transfer out ledgers can be obtained at this endpoint.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":{\\\"currentPage\\\":1,\\\"pageSize\\\":50,\\\"totalNum\\\":1,\\\"totalPage\\\":1,\\\"items\\\":[{\\\"applyId\\\":\\\"670bf84c577f6c00017a1c48\\\",\\\"currency\\\":\\\"USDT\\\",\\\"recRemark\\\":\\\"\\\",\\\"recSystem\\\":\\\"KUCOIN\\\",\\\"status\\\":\\\"SUCCESS\\\",\\\"amount\\\":\\\"0.01\\\",\\\"reason\\\":\\\"\\\",\\\"offset\\\":1519769124134806,\\\"createdAt\\\":1728837708000,\\\"remark\\\":\\\"\\\"}]}}", "x-request-example": "{\\\"currency\\\": \\\"XBT\\\", \\\"type\\\": \\\"MAIN\\\", \\\"tag\\\": [\\\"mock_a\\\", \\\"mock_b\\\"], \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000, \\\"currentPage\\\": 1, \\\"pageSize\\\": 50}", "operationId": "044" } }, "/api/v1/hist-withdrawals": { "get": { "summary": "Get Withdrawal History - Old", "deprecated": true, "description": "Request a deposit list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.", "tags": [], "parameters": [ { "name": "currency", "in": "query", "description": "currency", "required": true, "schema": { "type": "string", "example": [ "BTC", "ETH", "USDT" ] } }, { "name": "status", "in": "query", "description": "Status. Available value: PROCESSING, SUCCESS, and FAILURE", "required": false, "schema": { "type": "string", "enum": [ "PROCESSING", "SUCCESS", "FAILURE" ], "x-api-enum": [ { "value": "PROCESSING", "name": "", "description": "" }, { "value": "SUCCESS", "name": "", "description": "" }, { "value": "FAILURE", "name": "", "description": "" } ] } }, { "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, "default": 50 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "currentPage": { "type": "integer", "description": "current page" }, "pageSize": { "type": "integer", "description": "page size" }, "totalNum": { "type": "integer", "description": "total number" }, "totalPage": { "type": "integer", "description": "total pages" }, "items": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency" }, "createAt": { "type": "integer", "description": "Database record creation time" }, "amount": { "type": "string", "description": "Withdrawal amount" }, "address": { "type": "string", "description": "Withdrawal address" }, "walletTxId": { "type": "string", "description": "Wallet Txid" }, "isInner": { "type": "boolean", "description": "Internal deposit or not" }, "status": { "type": "string", "description": "Status", "enum": [ "PROCESSING", "SUCCESS", "FAILURE" ], "x-api-enum": [ { "value": "PROCESSING", "name": "", "description": "" }, { "value": "SUCCESS", "name": "", "description": "" }, { "value": "FAILURE", "name": "", "description": "" } ] } } } } }, "required": [ "currentPage", "pageSize", "totalNum", "totalPage", "items" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470308", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Withdrawal", "x-sdk-method-name": "getWithdrawalHistoryOld", "x-sdk-method-description": "Request a deposit list via this endpoint. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.", "x-api-rate-limit-weight": 20, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"currentPage\\\": 1,\\n \\\"pageSize\\\": 50,\\n \\\"totalNum\\\": 1,\\n \\\"totalPage\\\": 1,\\n \\\"items\\\": [\\n {\\n \\\"currency\\\": \\\"BTC\\\",\\n \\\"createAt\\\": 1526723468,\\n \\\"amount\\\": \\\"0.534\\\",\\n \\\"address\\\": \\\"33xW37ZSW4tQvg443Pc7NLCAs167Yc2XUV\\\",\\n \\\"walletTxId\\\": \\\"aeacea864c020acf58e51606169240e96774838dcd4f7ce48acf38e3651323f4\\\",\\n \\\"isInner\\\": false,\\n \\\"status\\\": \\\"SUCCESS\\\"\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"currency\\\": \\\"BTC\\\", \\\"status\\\": \\\"SUCCESS\\\", \\\"startAt\\\": 1728663338000, \\\"endAt\\\": 1728692138000, \\\"currentPage\\\": 1, \\\"pageSize\\\": 50}", "operationId": "045" } }, "/api/v3/transfer-out": { "post": { "summary": "Futures Account Transfer Out", "deprecated": true, "description": "The amount to be transferred will be deducted from the KuCoin Futures Account. Please ensure that you have sufficient funds in your KuCoin Futures Account, or the transfer will fail.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "applyId": { "type": "string", "description": "Transfer order ID" }, "bizNo": { "type": "string", "description": "Business number" }, "payAccountType": { "type": "string", "description": "Pay account type" }, "payTag": { "type": "string", "description": "Pay account sub type" }, "remark": { "type": "string", "description": "User remark" }, "recAccountType": { "type": "string", "description": "Receive account type" }, "recTag": { "type": "string", "description": "Receive account sub type" }, "recRemark": { "type": "string", "description": "Receive account tx remark" }, "recSystem": { "type": "string", "description": "Receive system" }, "status": { "type": "string", "description": "Status:APPLY, PROCESSING, PENDING_APPROVAL, APPROVED, REJECTED, PENDING_CANCEL, CANCEL, SUCCESS" }, "currency": { "type": "string", "description": "Currency" }, "amount": { "type": "string", "description": "Transfer amount" }, "fee": { "type": "string", "description": "Transfer fee" }, "sn": { "type": "integer", "description": "Serial number", "format": "int64" }, "reason": { "type": "string", "description": "Fail Reason" }, "createdAt": { "type": "integer", "description": "Create time", "format": "int64" }, "updatedAt": { "type": "integer", "description": "Update time", "format": "int64" } }, "required": [ "applyId", "bizNo", "payAccountType", "payTag", "remark", "recAccountType", "recTag", "recRemark", "recSystem", "status", "currency", "amount", "fee", "sn", "reason", "createdAt", "updatedAt" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470303", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", "x-api-permission": "Futures", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Transfer", "x-sdk-method-name": "futuresAccountTransferOut", "x-sdk-method-description": "The amount to be transferred will be deducted from the KuCoin Futures Account. Please ensure that you have sufficient funds in your KuCoin Futures Account, or the transfer will fail.", "x-api-rate-limit-weight": 20, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "currency": { "type": "string", "description": "Currency, including XBT, USDT...", "example": [ "XBT", "USDT", "ETH" ] }, "amount": { "type": "number", "description": "Amount to be transferred out; cannot exceed 1000000000", "maximum": 1000000000 }, "recAccountType": { "type": "string", "description": "Receive account type, including MAIN, TRADE", "enum": [ "MAIN", "TRADE" ], "x-api-enum": [ { "value": "MAIN", "name": "", "description": "" }, { "value": "TRADE", "name": "", "description": "" } ] } }, "required": [ "amount", "currency", "recAccountType" ] }, "example": "{\n \"currency\": \"USDT\",\n \"amount\": 0.01,\n \"recAccountType\": \"MAIN\"\n}" } } }, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"applyId\\\": \\\"670bf84c577f6c00017a1c48\\\",\\n \\\"bizNo\\\": \\\"670bf84c577f6c00017a1c47\\\",\\n \\\"payAccountType\\\": \\\"CONTRACT\\\",\\n \\\"payTag\\\": \\\"DEFAULT\\\",\\n \\\"remark\\\": \\\"\\\",\\n \\\"recAccountType\\\": \\\"MAIN\\\",\\n \\\"recTag\\\": \\\"DEFAULT\\\",\\n \\\"recRemark\\\": \\\"\\\",\\n \\\"recSystem\\\": \\\"KUCOIN\\\",\\n \\\"status\\\": \\\"PROCESSING\\\",\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"amount\\\": \\\"0.01\\\",\\n \\\"fee\\\": \\\"0\\\",\\n \\\"sn\\\": 1519769124134806,\\n \\\"reason\\\": \\\"\\\",\\n \\\"createdAt\\\": 1728837708000,\\n \\\"updatedAt\\\": 1728837708000\\n }\\n}", "x-request-example": "{\\\"currency\\\": \\\"USDT\\\", \\\"amount\\\": 0.01, \\\"recAccountType\\\": \\\"MAIN\\\"}", "operationId": "046" } }, "/api/v1/transfer-in": { "post": { "summary": "Futures Account Transfer In", "deprecated": true, "description": "The amount to be transferred will be deducted from the payAccount. Please ensure that you have sufficient funds in your payAccount account, or the transfer will fail.", "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-3470304", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", "x-api-permission": "Futures", "x-api-rate-limit-pool": "Management", "x-sdk-service": "Account", "x-sdk-sub-service": "Transfer", "x-sdk-method-name": "futuresAccountTransferIn", "x-sdk-method-description": "The amount to be transferred will be deducted from the payAccount. Please ensure that you have sufficient funds in your payAccount account, or the transfer will fail.", "x-api-rate-limit-weight": 20, "requestBody": { "content": { "application/json": { "schema": { "title": "", "type": "object", "properties": { "currency": { "type": "string", "description": "Currency, including XBT, USDT...", "example": [ "XBT", "USDT", "ETH" ] }, "amount": { "type": "number", "description": "Amount to be transferred in" }, "payAccountType": { "type": "string", "description": "Payment account type, including MAIN, TRADE", "enum": [ "MAIN", "TRADE" ], "x-api-enum": [ { "value": "MAIN", "name": "", "description": "" }, { "value": "TRADE", "name": "", "description": "" } ] } }, "required": [ "amount", "currency", "payAccountType" ] }, "example": "{\n \"currency\": \"USDT\",\n \"amount\": 0.01,\n \"payAccountType\": \"MAIN\"\n}" } } }, "x-response-example": "{\\\"code\\\":\\\"200000\\\",\\\"data\\\":null}", "x-request-example": "{\\\"currency\\\": \\\"USDT\\\", \\\"amount\\\": 0.01, \\\"payAccountType\\\": \\\"MAIN\\\"}", "operationId": "047" } }, "/api/v1/margin/account": { "get": { "summary": "Get Account Detail - Margin", "deprecated": true, "description": "Request margin account info via this endpoint.", "tags": [], "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "debtRatio": { "type": "string", "description": "Debt ratio" }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency" }, "totalBalance": { "type": "string", "description": "Total funds in the account" }, "availableBalance": { "type": "string", "description": "Available funds in the account" }, "holdBalance": { "type": "string", "description": "Funds on hold in the account" }, "liability": { "type": "string", "description": "Total liabilities" }, "maxBorrowSize": { "type": "string", "description": "Available size to borrow" } }, "required": [ "currency", "totalBalance", "availableBalance", "holdBalance", "liability", "maxBorrowSize" ] }, "description": "Margin account list" } }, "required": [ "debtRatio", "accounts" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470311", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getMarginAccountDetail", "x-sdk-method-description": "Request margin account info via this endpoint.", "x-api-rate-limit-weight": 40, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"debtRatio\\\": \\\"0\\\",\\n \\\"accounts\\\": [\\n {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"totalBalance\\\": \\\"0.03\\\",\\n \\\"availableBalance\\\": \\\"0.02\\\",\\n \\\"holdBalance\\\": \\\"0.01\\\",\\n \\\"liability\\\": \\\"0\\\",\\n \\\"maxBorrowSize\\\": \\\"0\\\"\\n }\\n ]\\n }\\n}", "operationId": "050" } }, "/api/v1/isolated/accounts": { "get": { "summary": "Get Account List - Isolated Margin - V1", "deprecated": true, "description": "Request the isolated margin account info list via this endpoint.", "tags": [], "parameters": [ { "name": "balanceCurrency", "in": "query", "description": "quote currency, currently only supports USDT, KCS, BTC, USDT as default", "required": false, "schema": { "type": "string", "default": "BTC", "enum": [ "USDT", "KCS", "BTC" ], "x-api-enum": [ { "value": "USDT", "name": "", "description": "" }, { "value": "KCS", "name": "", "description": "" }, { "value": "BTC", "name": "", "description": "" } ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "data": { "type": "object", "properties": { "totalConversionBalance": { "type": "string", "description": "The total balance of the isolated margin account (in the request coin)" }, "liabilityConversionBalance": { "type": "string", "description": "Total liabilities of the isolated margin account (in the request coin)" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Symbol" }, "status": { "type": "string", "description": "Position status: Existing liabilities-DEBT, No liabilities-CLEAR, Bankrupcy (after position enters a negative balance)-BANKRUPTCY, Existing borrowings-IN_BORROW, Existing repayments-IN_REPAY, Under liquidation-IN_LIQUIDATION, Under auto-renewal assets-IN_AUTO_RENEW .", "enum": [ "DEBT", "CLEAR", "BANKRUPTCY", "IN_BORROW", "IN_REPAY", "IN_LIQUIDATION", "IN_AUTO_RENEW" ], "x-api-enum": [ { "value": "DEBT", "name": "", "description": "" }, { "value": "CLEAR", "name": "", "description": "" }, { "value": "BANKRUPTCY", "name": "", "description": "" }, { "value": "IN_BORROW", "name": "", "description": "" }, { "value": "IN_REPAY", "name": "", "description": "" }, { "value": "IN_LIQUIDATION", "name": "", "description": "" }, { "value": "IN_AUTO_RENEW", "name": "", "description": "" } ] }, "debtRatio": { "type": "string", "description": "debt ratio" }, "baseAsset": { "type": "object", "properties": { "currency": { "type": "string", "description": "currency" }, "totalBalance": { "type": "string", "description": "Current currency total asset amount" }, "holdBalance": { "type": "string", "description": "Current currency holding asset amount" }, "availableBalance": { "type": "string", "description": "Current available asset amount" }, "liability": { "type": "string", "description": "Liabilities" }, "interest": { "type": "string" }, "borrowableAmount": { "type": "string" } }, "required": [ "currency", "totalBalance", "holdBalance", "availableBalance", "liability", "interest", "borrowableAmount" ], "description": "base asset" }, "quoteAsset": { "type": "object", "properties": { "currency": { "type": "string", "description": "currency" }, "totalBalance": { "type": "string", "description": "Current currency total asset amount" }, "holdBalance": { "type": "string", "description": "Current currency holding asset amount" }, "availableBalance": { "type": "string", "description": "Current available asset amount" }, "liability": { "type": "string", "description": "Liabilities" }, "interest": { "type": "string" }, "borrowableAmount": { "type": "string" } }, "required": [ "currency", "totalBalance", "holdBalance", "availableBalance", "liability", "interest", "borrowableAmount" ], "description": "quote asset" } }, "required": [ "symbol", "status", "debtRatio", "baseAsset", "quoteAsset" ] }, "description": "Account list" } }, "required": [ "totalConversionBalance", "liabilityConversionBalance", "assets" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470314", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getIsolatedMarginAccountListV1", "x-sdk-method-description": "Request the isolated margin account info list via this endpoint.", "x-api-rate-limit-weight": 50, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"totalConversionBalance\\\": \\\"0.01\\\",\\n \\\"liabilityConversionBalance\\\": \\\"0\\\",\\n \\\"assets\\\": [\\n {\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"status\\\": \\\"CLEAR\\\",\\n \\\"debtRatio\\\": \\\"0\\\",\\n \\\"baseAsset\\\": {\\n \\\"currency\\\": \\\"BTC\\\",\\n \\\"totalBalance\\\": \\\"0\\\",\\n \\\"holdBalance\\\": \\\"0\\\",\\n \\\"availableBalance\\\": \\\"0\\\",\\n \\\"liability\\\": \\\"0\\\",\\n \\\"interest\\\": \\\"0\\\",\\n \\\"borrowableAmount\\\": \\\"0\\\"\\n },\\n \\\"quoteAsset\\\": {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"totalBalance\\\": \\\"0.01\\\",\\n \\\"holdBalance\\\": \\\"0\\\",\\n \\\"availableBalance\\\": \\\"0.01\\\",\\n \\\"liability\\\": \\\"0\\\",\\n \\\"interest\\\": \\\"0\\\",\\n \\\"borrowableAmount\\\": \\\"0\\\"\\n }\\n }\\n ]\\n }\\n}", "x-request-example": "{\\\"balanceCurrency\\\": \\\"USDT\\\"}", "operationId": "051" } }, "/api/v1/isolated/account/{symbol}": { "get": { "summary": "Get Account Detail - Isolated Margin - V1", "deprecated": true, "description": "Request isolated margin account info via this endpoint.", "tags": [], "parameters": [ { "name": "symbol", "in": "path", "description": "", "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" }, "status": { "type": "string", "description": "Position status: Existing liabilities-DEBT, No liabilities-CLEAR, Bankrupcy (after position enters a negative balance)-BANKRUPTCY, Existing borrowings-IN_BORROW, Existing repayments-IN_REPAY, Under liquidation-IN_LIQUIDATION, Under auto-renewal assets-IN_AUTO_RENEW .", "enum": [ "DEBT", "CLEAR", "BANKRUPTCY", "IN_BORROW", "IN_REPAY", "IN_LIQUIDATION", "IN_AUTO_RENEW" ], "x-api-enum": [ { "value": "DEBT", "name": "", "description": "" }, { "value": "CLEAR", "name": "", "description": "" }, { "value": "BANKRUPTCY", "name": "", "description": "" }, { "value": "IN_BORROW", "name": "", "description": "" }, { "value": "IN_REPAY", "name": "", "description": "" }, { "value": "IN_LIQUIDATION", "name": "", "description": "" }, { "value": "IN_AUTO_RENEW", "name": "", "description": "" } ] }, "debtRatio": { "type": "string", "description": "debt ratio" }, "baseAsset": { "type": "object", "properties": { "currency": { "type": "string", "description": "currency" }, "totalBalance": { "type": "string", "description": "Current currency total asset amount" }, "holdBalance": { "type": "string", "description": "Current currency holding asset amount" }, "availableBalance": { "type": "string", "description": "Current available asset amount" }, "liability": { "type": "string", "description": "Liabilities" }, "interest": { "type": "string" }, "borrowableAmount": { "type": "string" } }, "required": [ "currency", "totalBalance", "holdBalance", "availableBalance", "liability", "interest", "borrowableAmount" ], "description": "base asset" }, "quoteAsset": { "type": "object", "properties": { "currency": { "type": "string", "description": "currency" }, "totalBalance": { "type": "string", "description": "Current currency total asset amount" }, "holdBalance": { "type": "string", "description": "Current currency holding asset amount" }, "availableBalance": { "type": "string", "description": "Current available asset amount" }, "liability": { "type": "string", "description": "Liabilities" }, "interest": { "type": "string" }, "borrowableAmount": { "type": "string" } }, "required": [ "currency", "totalBalance", "holdBalance", "availableBalance", "liability", "interest", "borrowableAmount" ], "description": "quote asset" } }, "required": [ "symbol", "status", "debtRatio", "baseAsset", "quoteAsset" ] } }, "required": [ "code", "data" ] } } } } }, "x-api-doc": "https://www.kucoin.com/docs-new/api-3470315", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", "x-api-permission": "General", "x-api-rate-limit-pool": "Spot", "x-sdk-service": "Account", "x-sdk-sub-service": "Account", "x-sdk-method-name": "getIsolatedMarginAccountDetailV1", "x-sdk-method-description": "Request isolated margin account info via this endpoint.", "x-api-rate-limit-weight": 50, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"symbol\\\": \\\"BTC-USDT\\\",\\n \\\"status\\\": \\\"CLEAR\\\",\\n \\\"debtRatio\\\": \\\"0\\\",\\n \\\"baseAsset\\\": {\\n \\\"currency\\\": \\\"BTC\\\",\\n \\\"totalBalance\\\": \\\"0\\\",\\n \\\"holdBalance\\\": \\\"0\\\",\\n \\\"availableBalance\\\": \\\"0\\\",\\n \\\"liability\\\": \\\"0\\\",\\n \\\"interest\\\": \\\"0\\\",\\n \\\"borrowableAmount\\\": \\\"0\\\"\\n },\\n \\\"quoteAsset\\\": {\\n \\\"currency\\\": \\\"USDT\\\",\\n \\\"totalBalance\\\": \\\"0.01\\\",\\n \\\"holdBalance\\\": \\\"0\\\",\\n \\\"availableBalance\\\": \\\"0.01\\\",\\n \\\"liability\\\": \\\"0\\\",\\n \\\"interest\\\": \\\"0\\\",\\n \\\"borrowableAmount\\\": \\\"0\\\"\\n }\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"example_string_default_value\\\"}", "operationId": "052" } } }, "components": { "schemas": {} } }