diff --git a/Makefile b/Makefile index e7a339a..b118855 100644 --- a/Makefile +++ b/Makefile @@ -74,6 +74,10 @@ define generate-code @echo "$(GREEN)lang: $(lang), done!$(NC)" endef +define generate-postman + @make -f generate.mk generate-postman +endef + SUBDIRS := $(shell find ./sdk -mindepth 1 -maxdepth 1 -type d) .PHONY: test $(SUBDIRS) @@ -86,9 +90,14 @@ $(SUBDIRS): .PHONY: generate generate: setup-logs + $(call generate-postman) $(call generate-code,golang,/pkg/generate) $(call generate-code,python,/kucoin_universal_sdk/generate) +.PHONY: gen-postman +gen-postman: preprocessor + $(call generate-postman) + .PHONY: fastgen fastgen: build-tools preprocessor @make generate diff --git a/README.md b/README.md index f14ab67..15c764f 100644 --- a/README.md +++ b/README.md @@ -32,22 +32,24 @@ The **KuCoin Universal SDK** is the official SDK provided by KuCoin, offering a ## 🛠️ Installation -### Latest Version: `0.1.1-alpha` -**Note:** This SDK is currently in the **Alpha phase**. We are actively iterating and improving its features, stability, and documentation. Feedback and contributions are highly encouraged to help us refine the SDK. +### Latest Version: `1.0.0` ### Python Installation ```bash -pip install kucoin-universal-sdk==0.1.1a1 +pip install kucoin-universal-sdk ``` ### Golang Installation ```bash -go get github.com/Kucoin/kucoin-universal-sdk/sdk/golang@v0.1.1-alpha +go get github.com/Kucoin/kucoin-universal-sdk/sdk/golang go mod tidy ``` +### Postman Installation +Visit the [KuCoin API Collection on Postman](https://www.postman.com/kucoin-api/kucoin-api/overview) + ## 📖 Getting Started Here's a quick example to get you started with the SDK in **Python**. @@ -122,6 +124,7 @@ For other languages, refer to the [Examples](#-examples) section. - Official Documentation: [KuCoin API Docs](https://www.kucoin.com/docs-new) - **[Python Documentation](sdk/python/README.md)** - **[Go Documentation](sdk/golang/README.md)** +- **[Postman Documentation](sdk/postman/README.md)** ## 📂 Examples Find usage examples for your desired language by selecting the corresponding link below: @@ -131,6 +134,7 @@ Find usage examples for your desired language by selecting the corresponding lin | Python | [sdk/python/examples/](sdk/python/example/)| | Go | [sdk/go/examples/](sdk/golang/example/) | + ## 🏗️ Technical Design The KuCoin Universal SDK is built with a code-generation-first approach to ensure consistency, scalability, and rapid updates across all supported languages. By leveraging the OpenAPI Specification and a custom code generator, the SDK achieves the following advantages: @@ -181,18 +185,8 @@ The following table describes the key components of the project directory: | `README.md` | Main documentation file. | | `generate.mk` | Additional Makefile specifically for code generation tasks. | | `generator/` | Directory containing the code generation logic. | -| `generator/plugin/` | Custom plugins for generating SDKs. | -| `generator/preprocessor/`| Scripts or tools for preprocessing API specifications. | | `sdk/` | Directory for generated SDKs organized by language. | -| `sdk/golang/` | Generated SDK for Golang. | -| `sdk/python/` | Generated SDK for Python. | | `spec/` | Directory containing API specification files. | -| `spec/apis.csv` | List of all APIs. | -| `spec/original/` | Original unprocessed API specifications. | -| `spec/rest/` | REST API specifications. | -| `spec/ws/` | WebSocket API specifications. | -| `spec/ws.csv` | List of WebSocket-specific APIs. - ## ⚙️ Build and Test Guide diff --git a/VERSION b/VERSION index e4774dc..60453e6 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -v0.1.1-alpha \ No newline at end of file +v1.0.0 \ No newline at end of file diff --git a/generate.mk b/generate.mk index fc9e3a4..0c3e64f 100644 --- a/generate.mk +++ b/generate.mk @@ -7,6 +7,12 @@ RED=\033[0;31m GREEN=\033[0;32m NC=\033[0m +define generate-postman-func + docker run --rm -v "${PWD}:/local" -w /local/generator/postman -e SDK_VERSION=$(VERSION) python:3.9.20-alpine3.20 \ + python main.py + + @echo "$(GREEN)lang: postman, done!$(NC)" +endef define generate-api @echo "$(GREEN)lang: $(2). generate api for $(service)...$(NC)" @@ -79,7 +85,10 @@ REST_FILES := $(wildcard ./spec/rest/api/*.json) ENTRY_FILES := $(wildcard ./spec/rest/entry/*.json) WS_FILES := $(wildcard ./spec/ws/*.json) -.PHONY: generate $(REST_FILES) $(ENTRY_FILES) $(WS_FILES) force +.PHONY: generate $(REST_FILES) $(ENTRY_FILES) $(WS_FILES) generate-postman force + +generate-postman: + $(call generate-postman-func) generate: $(patsubst ./spec/rest/api/%.json,generate-rest-%, $(REST_FILES)) $(patsubst ./spec/rest/entry/%.json,generate-entry-%, $(ENTRY_FILES)) $(patsubst ./spec/ws/%.json,generate-ws-%, $(WS_FILES)) diff --git a/generator/plugin/src/main/resources/golang-sdk/api.mustache b/generator/plugin/src/main/resources/golang-sdk/api.mustache index b6563a8..e8aebfd 100644 --- a/generator/plugin/src/main/resources/golang-sdk/api.mustache +++ b/generator/plugin/src/main/resources/golang-sdk/api.mustache @@ -13,6 +13,7 @@ type {{classname}} interface { // {{vendorExtensions.x-meta.method}} {{summary}} // Description: {{notes}} + // Documentation: {{vendorExtensions.x-api-doc}} {{#vendorExtensions.x-extra-comment}} // {{.}} {{/vendorExtensions.x-extra-comment}}{{#isDeprecated}} // Deprecated diff --git a/generator/plugin/src/main/resources/python-sdk/api.mustache b/generator/plugin/src/main/resources/python-sdk/api.mustache index 783b000..5e7a09d 100644 --- a/generator/plugin/src/main/resources/python-sdk/api.mustache +++ b/generator/plugin/src/main/resources/python-sdk/api.mustache @@ -16,6 +16,7 @@ class {{classname}}(ABC): """ summary: {{summary}} description: {{notes}} + documentation: {{vendorExtensions.x-api-doc}} {{#vendorExtensions.x-extra-comment}} {{.}} {{/vendorExtensions.x-extra-comment}} diff --git a/generator/plugin/src/test/java/com/kucoin/universal/sdk/plugin/SdkGeneratorTest.java b/generator/plugin/src/test/java/com/kucoin/universal/sdk/plugin/SdkGeneratorTest.java index c1a8853..c71eafe 100644 --- a/generator/plugin/src/test/java/com/kucoin/universal/sdk/plugin/SdkGeneratorTest.java +++ b/generator/plugin/src/test/java/com/kucoin/universal/sdk/plugin/SdkGeneratorTest.java @@ -7,7 +7,7 @@ public class SdkGeneratorTest { - private static final String SDK_NAME = "golang-sdk"; + private static final String SDK_NAME = "python-sdk"; private static final String SPEC_NAME = "../../spec/rest/api/openapi-account-fee.json"; private static final String SPEC_ENTRY_NAME = "../../spec/rest/entry/openapi-account.json"; private static final String WS_SPEC_NAME = "../../spec/ws/openapi-futures-private.json"; diff --git a/generator/postman/collection.py b/generator/postman/collection.py new file mode 100644 index 0000000..11fcd19 --- /dev/null +++ b/generator/postman/collection.py @@ -0,0 +1,403 @@ +import json +import re +import sys +from json import JSONDecodeError + +import script +from costant import docPath, apiPath, metaPath, outputPath, brokerFolderName + + +class Collection: + + def __init__(self): + self.path_var = set() + self.title = "" + self.doc_id = set() + + def generate_collection(self, subdir, title): + self.title = title + + meta_data = self.parse(metaPath, subdir) + + collection_data = self.gen_data(meta_data) + + collection = self.gen_postman(collection_data) + + self.write(f"{outputPath}/collection-{subdir}.json", collection) + + def parse(self, file_path, subdir): + try: + with open(file_path, "r") as file: + file_content = file.read() + meta_data = json.loads(file_content) + + self.doc_id = set(meta_data['doc_id']) + if 'apiCollection' not in meta_data: + raise RuntimeError("incomplete meta data") + + api_collection = meta_data['apiCollection'][0] + if 'items' not in api_collection: + raise RuntimeError("incomplete meta data") + + for item in api_collection['items']: + if item['name'] == subdir: + return item + + raise RuntimeError("no rest subdir found") + + except Exception as e: + print(f"An error occurred when read meta file: {e}") + sys.exit(1) + + def write(self, out_path, postman): + try: + with open(out_path, 'w', encoding='utf-8') as file: + json.dump(postman, file, ensure_ascii=False, indent=4) + except Exception as e: + print(f"An error occurred when generate postman specification file: {e}") + sys.exit(1) + + def gen_api(self, item): + if 'api' not in item: + raise RuntimeError(f"incomplete data for api {item}") + + api = item['api'] + path = [part for part in api['path'].split('/') if part] + x_tags = json.loads(api['customApiFields']) + if 'domain' not in x_tags: + raise RuntimeError(f'no domain tag found in {api}') + domain = x_tags['domain'].lower() + + parameters = api['parameters'] + request = api['requestBody'] + responses = api['responseExamples'] + + description_detail = self.gen_markdown(api) + + query = [] + path_var = [] + + # update query + if parameters['query']: + for p in parameters['query']: + query.append({ + 'key': p['name'], + 'value': p['example'] if 'example' in p else None, + 'description': self.escape_url(p['description']) + }) + + # update path + if parameters['path']: + for p in parameters['path']: + path_var_name = p['name'] + path_var_name_ext = "{" + path_var_name + "}" + path_var.append(path_var_name) + self.path_var.add(path_var_name) + + if path_var_name_ext in path: + index = path.index(path_var_name_ext) + path[index] = "{{" + path_var_name + "}}" + + # update request + req_body = {} + if 'type' in request and request['type'] == 'application/json': + req_body = { + "mode": "raw", + "raw": request['example'], + "options": { + "raw": { + "language": "json" + } + } + } + + # update response + resp_body_data = '' + for resp_example in responses: + if resp_example['name'] == 'Success': + try: + resp_body_data = json.dumps(json.loads(resp_example['data']), ensure_ascii=False, indent=4) + except JSONDecodeError as e: + resp_body_data = resp_example['data'] + pass + + postman_obj = { + "name": item['name'], + "request": { + "method": api['method'].upper(), + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{%s}}" % (domain + "_endpoint") + ], + "path": path, + 'query': query, + }, + "description": description_detail, + "body": req_body, + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": api['method'].upper(), + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{%s}}" % (domain + "_endpoint") + ], + "path": path, + 'query': query + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + }, + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": resp_body_data, + } + ], + + } + + return postman_obj + + def properties_to_markdown_table(self, prop): + if not prop: + return "" + + headers = prop[0].keys() + + markdown_table = "| " + " | ".join(headers) + " |\n" + markdown_table += "| " + " | ".join(["---" for _ in headers]) + " |\n" + + # Populate the rows + for item in prop: + row = [str(item.get(header, "")) for header in headers] + markdown_table += "| " + " | ".join(row) + " |\n" + + return markdown_table + + def gen_doc_api_url(self, id, doc: bool): + if doc: + return f'{docPath}{id}' + return f'{apiPath}{id}' + + def escape_markdown(self, markdown): + markdown = markdown.replace('\n', '
') + markdown = markdown.replace('|', '\\|') + return markdown + + def escape_url(self, markdown): + pattern = r"apidog://link/(pages|endpoint)/(\d+)" + match = re.search(pattern, markdown) + if match: + number = match.group(2) + url = '' + if int(number) in self.doc_id: + url = self.gen_doc_api_url(number, True) + else: + url = self.gen_doc_api_url(number, False) + markdown = re.sub(pattern, url, markdown) + return markdown + + def generate_markdown_schema(self, parent, order, schema) -> dict: + + markdown_sections = [] + prop = [] + + if schema['type'] == 'array': + sections = self.generate_markdown_schema(parent, order + 1, schema['items']) + if len(sections) > 0: + markdown_sections.extend(sections) + + if schema['type'] == 'object': + for name, value in schema['properties'].items(): + ref = False + if value['type'] == 'object' or value['type'] == 'array': + inner = self.generate_markdown_schema(name, order + 1, value) + markdown_sections.extend(inner) + ref = True + + description = value['description'] if 'description' in value else '' + if ref: + description = f'Refer to the schema section of {name}' + + description = self.escape_url(description) + description = self.escape_markdown(description) + + prop.append({ + 'name': name, + 'type': value['type'], + 'description': description, + }) + markdown_sections.append({ + 'parent': parent, + 'value': self.properties_to_markdown_table(prop), + 'order': order, + }) + + return markdown_sections + + def gen_markdown(self, api): + api_doc_addr = self.gen_doc_api_url(api['id'], False) + api_doc = api['description'] + + request = api['requestBody'] + response = None + for r in api['responses']: + if r['code'] == 200: + response = r + + def gen_inner(obj, title): + markdown_section = {} + if 'jsonSchema' in obj: + schema = obj['jsonSchema'] + markdown_section = self.generate_markdown_schema('root', 0, schema) + else: + markdown_section = [{'parent': 'root', 'value': '', 'order': 0}] + + markdown_section = sorted(markdown_section, key=lambda x: x['order']) + nonlocal api_doc + api_doc += f'\n**{title} Body**\n\n' + + parent = '' + api_doc += '---\n' + for section in markdown_section: + if parent == '' and section['value'] == '': + api_doc += f' **None** \n' + break + if parent == '': + parent = f'root' + else: + parent = f'{parent}.{section["parent"]}' + api_doc += f'**{parent} Schema**\n\n' + api_doc += f'{section["value"]}\n' + api_doc += '---\n' + + api_doc = f'# API Description\n\nFor the complete API documentation, please refer to [doc]({api_doc_addr})\n\n' + api_doc + api_doc += f'\n# API Schema\n\n' + api_doc += f'## Request Schema\n\n' + gen_inner(request, "Request") + api_doc += f'## Response Schema\n\n' + gen_inner(response, "Response") + + return api_doc + + def gen_data(self, meta_data): + postman_item = [] + + if 'items' in meta_data: + for item in meta_data['items']: + is_dir = 'items' in item + + postman_obj = {} + if is_dir: + postman_obj = { + 'name': item['name'], + 'item': self.gen_data(item), + "description": '', + } + + if item['name'] == brokerFolderName: + postman_obj["event"] = [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + script.get_script(True) + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + } + ] + else: + postman_obj = self.gen_api(item) + + postman_item.append(postman_obj) + + return postman_item + + def gen_postman(self, postman_data): + + variables = [] + for var in sorted(self.path_var): + variables.append({ + "key": var, + "value": "", + }) + + postman = { + "info": { + "_postman_id": "e22e2bc3-0147-4151-9872-e9f6bda04a9c", + "name": self.title, + "description": f"For the complete API documentation, please refer to https://www.kucoin.com/docs-new", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + }, + "item": postman_data, + "variable": variables, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + script.get_script(False) + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + } + ], + } + return postman diff --git a/generator/postman/costant.py b/generator/postman/costant.py new file mode 100644 index 0000000..b40484b --- /dev/null +++ b/generator/postman/costant.py @@ -0,0 +1,7 @@ + +specRoot = "../../spec/" +metaPath = f"{specRoot}/original/meta.json" +outputPath = f"../../sdk/postman" +brokerFolderName = 'Broker' +apiPath = 'https://www.kucoin.com/docs-new/api-' +docPath = 'https://www.kucoin.com/docs-new/doc-' \ No newline at end of file diff --git a/generator/postman/env.py b/generator/postman/env.py new file mode 100644 index 0000000..aea1529 --- /dev/null +++ b/generator/postman/env.py @@ -0,0 +1,88 @@ +import json +import sys + +from costant import outputPath + + +class Env: + def gen_env(self): + values = [ + { + "key": "spot_endpoint", + "value": "api.kucoin.com", + "type": "default", + "enable": True, + }, + { + "key": "futures_endpoint", + "value": "api-futures.kucoin.com", + "type": "default", + "enable": True, + }, + { + "key": "broker_endpoint", + "value": "api-broker.kucoin.com", + "type": "default", + "enable": True, + }, + { + "key": "API_KEY", + "value": "", + "type": "secret", + "enabled": True + }, + { + "key": "API_SECRET", + "value": "", + "type": "secret", + "enabled": True + }, + { + "key": "API_PASSPHRASE", + "value": "", + "type": "secret", + "enabled": True + } + , + { + "key": "BROKER_NAME", + "value": "", + "type": "secret", + "enabled": True + } + , + { + "key": "BROKER_PARTNER", + "value": "", + "type": "secret", + "enabled": True + } + , + { + "key": "BROKER_KEY", + "value": "", + "type": "secret", + "enabled": True + } + ] + + env_obj = { + "id": "0deee4de-080a-4246-a95d-3eee14126248", + "name": "KuCoin API Production", + "values": values, + "_postman_variable_scope": "environment", + } + return env_obj + + def write_env(self, env_obj): + try: + out_path = f"{outputPath}/env.json" + with open(out_path, 'w', encoding='utf-8') as file: + json.dump(env_obj, file, ensure_ascii=False, indent=4) + except Exception as e: + print(f"An error occurred when generate postman env file: {e}") + sys.exit(1) + + def generate(self): + env_obj = self.gen_env() + self.write_env(env_obj) diff --git a/generator/postman/main.py b/generator/postman/main.py new file mode 100644 index 0000000..4a916e4 --- /dev/null +++ b/generator/postman/main.py @@ -0,0 +1,13 @@ +import collection +import env + +if __name__ == '__main__': + rest_collection = collection.Collection() + rest_collection.generate_collection("REST", "Kucoin REST API") + + res_collection = collection.Collection() + res_collection.generate_collection("Abandoned Endpoints", "Kucoin REST API(Abandoned)") + + env = env.Env() + env.generate() + diff --git a/generator/postman/script.py b/generator/postman/script.py new file mode 100644 index 0000000..99cd7b6 --- /dev/null +++ b/generator/postman/script.py @@ -0,0 +1,15 @@ +import os + + +def get_script(broker: bool) -> str: + + sdk_version = os.getenv("SDK_VERSION", '') + + file_name = 'script_template.js' + if broker: + file_name = 'script_broker_template.js' + + with open(file_name, 'r', encoding='utf-8') as file: + content = file.read() + content = content.replace('{{SDK-VERSION}}', sdk_version) + return content \ No newline at end of file diff --git a/generator/postman/script_broker_template.js b/generator/postman/script_broker_template.js new file mode 100644 index 0000000..1870727 --- /dev/null +++ b/generator/postman/script_broker_template.js @@ -0,0 +1,83 @@ + +function extractPathVariable(str) { + const regex = /^\{\{(.+?)\}\}$/; + const match = str.match(regex); + if (match) { + return match[1]; + } + return null; +} + +function hasAnyFieldEmpty(obj) { + for (const key in obj) { + if (obj[key] === "" || obj[key] === null || obj[key] === undefined) { + return true; + } + } + return false; +} + +function sign(text, secret) { + const hash = CryptoJS.HmacSHA256(text, secret); + return CryptoJS.enc.Base64.stringify(hash) +} + +function auth(apiKey, method, url, data) { + if (hasAnyFieldEmpty(apiKey)) { + console.warn('The API key-related (or broker-related) information is not configured. Please check the fields in the environment variables.') + return {'User-Agent': `Kucoin-Universal-Postman-SDK/{{SDK-VERSION}}`} + } + + + const timestamp = Date.now(); + const text = timestamp + method.toUpperCase() + url + data; + const signature = sign(text, apiKey.secret); + const brokerText = timestamp + apiKey.partner + apiKey.key; + const brokerSignature = sign(brokerText, apiKey.brokerKey); + return { + 'KC-API-KEY': apiKey.key, + 'KC-API-SIGN': signature, + 'KC-API-TIMESTAMP': timestamp.toString(), + 'KC-API-PASSPHRASE': sign(apiKey.passphrase || '', apiKey.secret), + 'Content-Type': 'application/json', + 'User-Agent': `Kucoin-Universal-Postman-SDK/{{SDK-VERSION}}`, + 'KC-API-KEY-VERSION': 2, + 'KC-API-PARTNER': apiKey.partner, + 'KC-BROKER-NAME': apiKey.brokerName, + 'KC-API-PARTNER-VERIFY': 'true', + 'KC-API-PARTNER-SIGN': brokerSignature, + }; +} + +let key = pm.environment.get('API_KEY') +let secret = pm.environment.get('API_SECRET') +let passphrase = pm.environment.get('API_PASSPHRASE') + +let brokerName = pm.environment.get('BROKER_NAME') +let partner = pm.environment.get('BROKER_PARTNER') +let brokerKey = pm.environment.get('BROKER_KEY') + +let url = pm.request.url.getPathWithQuery() +let method = pm.request.method +let body = pm.request.body ? pm.request.body.toString() : '' + +for (const index in pm.request.url.path) { + path = pm.request.url.path[index] + pathVar = extractPathVariable(path) + if (pathVar != null) { + let collectionVariable = pm.collectionVariables.get(pathVar); + if (collectionVariable != null) { + url = url.replace(path, collectionVariable) + } else { + console.warn('no path variable set: ' + path) + } + } +} + +header = auth({ + key: key, passphrase: passphrase, secret: secret, brokerName: brokerName, partner: partner, brokerKey: brokerKey +}, method, url, body) + +for (const [headerName, headerValue] of Object.entries(header)) { + pm.request.headers.add({ key: headerName, value: headerValue }) +} \ No newline at end of file diff --git a/generator/postman/script_template.js b/generator/postman/script_template.js new file mode 100644 index 0000000..fd0d899 --- /dev/null +++ b/generator/postman/script_template.js @@ -0,0 +1,69 @@ +function extractPathVariable(str) { + const regex = /^\{\{(.+?)\}\}$/; + const match = str.match(regex); + if (match) { + return match[1]; + } + return null; +} + +function hasAnyFieldEmpty(obj) { + for (const key in obj) { + if (obj[key] === "" || obj[key] === null || obj[key] === undefined) { + return true; + } + } + return false; +} + +function sign(text, secret) { + const hash = CryptoJS.HmacSHA256(text, secret); + return CryptoJS.enc.Base64.stringify(hash) +} + +function auth(apiKey, method, url, data) { + if (hasAnyFieldEmpty(apiKey)) { + console.warn('The API key-related information is not configured; only the public channel API is accessible.') + return {'User-Agent': `Kucoin-Universal-Postman-SDK/{{SDK-VERSION}}`} + } + + const timestamp = Date.now(); + const text = timestamp + method.toUpperCase() + url + data; + const signature = sign(text, apiKey.secret); + return { + 'KC-API-KEY': apiKey.key, + 'KC-API-SIGN': signature, + 'KC-API-TIMESTAMP': timestamp.toString(), + 'KC-API-PASSPHRASE': sign(apiKey.passphrase || '', apiKey.secret), + 'Content-Type': 'application/json', + 'User-Agent': `Kucoin-Universal-Postman-SDK/{{SDK-VERSION}}`, + 'KC-API-KEY-VERSION': 2, + }; +} + +let key = pm.environment.get('API_KEY') +let secret = pm.environment.get('API_SECRET') +let passphrase = pm.environment.get('API_PASSPHRASE') + +let url = pm.request.url.getPathWithQuery() +let method = pm.request.method +let body = pm.request.body ? pm.request.body.toString() : '' + +for (const index in pm.request.url.path) { + path = pm.request.url.path[index] + pathVar = extractPathVariable(path) + if (pathVar != null) { + let collectionVariable = pm.collectionVariables.get(pathVar); + if (collectionVariable != null) { + url = url.replace(path, collectionVariable) + } else { + console.warn('no path variable set: ' + path) + } + } +} + +header = auth({ key: key, passphrase: passphrase, secret: secret }, method, url, body) + +for (const [headerName, headerValue] of Object.entries(header)) { + pm.request.headers.add({ key: headerName, value: headerValue }) +} \ No newline at end of file diff --git a/generator/preprocessor/api_meta.py b/generator/preprocessor/api_meta.py index dd8a3ee..b3b0763 100644 --- a/generator/preprocessor/api_meta.py +++ b/generator/preprocessor/api_meta.py @@ -1,10 +1,16 @@ import codecs import json -import random +import re import sys +apiPath = 'https://www.kucoin.com/docs-new/api-' +docPath = 'https://www.kucoin.com/docs-new/doc-' + class ApiMetaUtil: + + doc_id = [] + @staticmethod def collect_api(collection, result: list): if type(collection) is list: @@ -28,6 +34,7 @@ def group_api(api_collection, entry) -> dict: api_name = api['name'] api_data = api['api'] + api_doc = ApiMetaUtil.gen_doc_api_url(api_data['id'], False) if 'customApiFields' not in api_data: raise Exception("customApiFields not found in meta json") @@ -35,7 +42,9 @@ def group_api(api_collection, entry) -> dict: if len(api_fields) == 0: raise Exception("illegal customApiFields" + api_name) - x_fields = {} + x_fields = { + 'x-api-doc' : api_doc, + } for k in api_fields: x_fields[f'x-{k}'] = api_fields[k] @@ -65,6 +74,7 @@ def parse(file_path): file_content = file.read() json_content = json.loads(file_content) + ApiMetaUtil.doc_id = json_content['doc_id'] api_list = list() for collection in json_content['apiCollection']: @@ -77,13 +87,32 @@ def parse(file_path): print(f"An error occurred when read meta file: {e}") sys.exit(1) + @staticmethod + def gen_doc_api_url(id, doc: bool): + if doc: + return f'{docPath}{id}' + return f'{apiPath}{id}' + + @staticmethod + def escape_url(desc, doc_id): + pattern = r"apidog://link/(pages|endpoint)/(\d+)" + match = re.search(pattern, desc) + if match: + number = match.group(2) + url = '' + if int(number) in doc_id: + url = ApiMetaUtil.gen_doc_api_url(number, True) + else: + url = ApiMetaUtil.gen_doc_api_url(number, False) + desc = re.sub(pattern, url, desc) + return desc + @staticmethod def update_doc_desc(schema): if schema and isinstance(schema, dict) and 'properties' in schema: for p in schema['properties'].values(): if isinstance(p, dict) and 'description' in p: - p['description'] = p['description'].replace('apidog://link', 'doc://link') - + p['description'] = ApiMetaUtil.escape_url(p['description'], ApiMetaUtil.doc_id) @staticmethod def update_tuple(schema): @@ -101,7 +130,6 @@ def update_tuple(schema): 'type': 'AnyType' } - @staticmethod def update_response_schema_required(schema): @@ -198,7 +226,7 @@ def generate_path_operation(api): result = { 'name': path_para['name'], 'in': 'path', - 'description': path_para['description'], + 'description': ApiMetaUtil.escape_url(path_para['description'], ApiMetaUtil.doc_id), 'required': path_para['required'], 'schema': { 'type': path_para['type'], @@ -228,7 +256,7 @@ def generate_path_operation(api): result = { 'name': query_para['name'], 'in': 'query', - 'description': query_para['description'], + 'description': ApiMetaUtil.escape_url(query_para['description'], ApiMetaUtil.doc_id), 'required': query_para['required'], 'schema': schema, } @@ -256,7 +284,6 @@ def generate_path_operation(api): if name not in req_example: req_example[name] = ApiMetaUtil.gen_default_value_for_example(query_para) - path_operation['parameters'].append(result) # requestBody @@ -279,7 +306,8 @@ def generate_path_operation(api): } try: example_raw = body_data['example'] - filtered_data = "\n".join(line for line in example_raw.splitlines() if not line.strip().startswith("//")) + filtered_data = "\n".join( + line for line in example_raw.splitlines() if not line.strip().startswith("//")) j = json.loads(filtered_data) if len(req_example) == 0 and isinstance(j, list): diff --git a/generator/preprocessor/meta_tools.py b/generator/preprocessor/meta_tools.py index 41107b7..b87f34a 100644 --- a/generator/preprocessor/meta_tools.py +++ b/generator/preprocessor/meta_tools.py @@ -57,12 +57,32 @@ def clear_api_collection(data): for k in clear_keys: del data['api'][k] + def gen_doc_id_collection(self, collection): + id = set() + + if 'items' in collection: + for item in collection['items']: + id.add(item['id']) + + for doc in collection['children']: + id.update(self.gen_doc_id_collection(doc)) + + return id + + def clear_garbage(self): MetaTools.clear_api_collection(self.data['apiCollection']) + + if 'docCollection' in self.data: + doc_id = self.gen_doc_id_collection(self.data['docCollection'][0]) + else: + doc_id = self.data['doc_id'] + self.data = { 'apiCollection' : self.data['apiCollection'], 'schemaCollection': self.data['schemaCollection'], + 'doc_id': list(doc_id), } diff --git a/sdk/golang/README.md b/sdk/golang/README.md index ffd9c98..13e179b 100644 --- a/sdk/golang/README.md +++ b/sdk/golang/README.md @@ -8,12 +8,12 @@ For an overview of the project and SDKs in other languages, refer to the [Main R ## 📦 Installation -**Note:** This SDK is currently in the **Alpha phase**. We are actively iterating and improving its features, stability, and documentation. Feedback and contributions are highly encouraged to help us refine the SDK. +### Latest Version: `1.0.0` Install the Golang SDK using `go get`: ```bash -go get github.com/Kucoin/kucoin-universal-sdk/sdk/golang@v0.1.1-alpha +go get github.com/Kucoin/kucoin-universal-sdk/sdk/golang go mod tidy ``` diff --git a/sdk/golang/pkg/generate/account/account/api_account.go b/sdk/golang/pkg/generate/account/account/api_account.go index 6dd0ad3..168071e 100644 --- a/sdk/golang/pkg/generate/account/account/api_account.go +++ b/sdk/golang/pkg/generate/account/account/api_account.go @@ -11,6 +11,7 @@ type AccountAPI interface { // GetFuturesAccount Get Account - Futures // Description: Request via this endpoint to get the info of the futures account. + // Documentation: https://www.kucoin.com/docs-new/api-3470129 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type AccountAPI interface { // GetSpotAccountDetail Get Account Detail - Spot // Description: get Information for a single spot account. Use this endpoint when you know the accountId. + // Documentation: https://www.kucoin.com/docs-new/api-3470126 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -37,6 +39,7 @@ type AccountAPI interface { // GetSpotAccountList Get Account List - Spot // Description: Get a list of accounts. Please Deposit to the main account firstly, then transfer the funds to the trade account via Inner Transfer before transaction. + // Documentation: https://www.kucoin.com/docs-new/api-3470125 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -50,6 +53,7 @@ type AccountAPI interface { // GetSpotLedger Get Account Ledgers - Spot/Margin // Description: This interface is for transaction records from all types of your accounts, supporting inquiry of various currencies. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page. + // Documentation: https://www.kucoin.com/docs-new/api-3470121 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -63,6 +67,7 @@ type AccountAPI interface { // GetSpotHFLedger Get Account Ledgers - Trade_hf // Description: This API endpoint returns all transfer (in and out) records in high-frequency trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id. + // Documentation: https://www.kucoin.com/docs-new/api-3470122 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -76,6 +81,7 @@ type AccountAPI interface { // GetSpotAccountType Get Account Type - Spot // Description: This interface determines whether the current user is a spot high-frequency user or a spot low-frequency user. + // Documentation: https://www.kucoin.com/docs-new/api-3470120 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -89,6 +95,7 @@ type AccountAPI interface { // GetIsolatedMarginAccountDetailV1 Get Account Detail - Isolated Margin - V1 // Description: Request via this endpoint to get the info of the isolated margin account. + // Documentation: https://www.kucoin.com/docs-new/api-3470315 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -103,6 +110,7 @@ type AccountAPI interface { // GetIsolatedMarginAccountListV1 Get Account List - Isolated Margin - V1 // Description: Request via this endpoint to get the info list of the isolated margin account. + // Documentation: https://www.kucoin.com/docs-new/api-3470314 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -117,6 +125,7 @@ type AccountAPI interface { // GetMarginAccountDetail Get Account Detail - Margin // Description: Request via this endpoint to get the info of the margin account. + // Documentation: https://www.kucoin.com/docs-new/api-3470311 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -131,6 +140,7 @@ type AccountAPI interface { // GetFuturesLedger Get Account Ledgers - Futures // Description: This interface can query the ledger records of the futures business line + // Documentation: https://www.kucoin.com/docs-new/api-3470124 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -142,8 +152,9 @@ type AccountAPI interface { // +---------------------+---------+ GetFuturesLedger(req *GetFuturesLedgerReq, ctx context.Context) (*GetFuturesLedgerResp, error) - // GetApikeyInfo Get API Key Info + // GetApikeyInfo Get Apikey Info // Description: Get the information of the api key. Use the api key pending to be checked to call the endpoint. Both master and sub user's api key are applicable. + // Documentation: https://www.kucoin.com/docs-new/api-3470130 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -157,6 +168,7 @@ type AccountAPI interface { // GetAccountInfo Get Account Summary Info // Description: This endpoint can be used to obtain account summary information. + // Documentation: https://www.kucoin.com/docs-new/api-3470119 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -170,6 +182,7 @@ type AccountAPI interface { // GetMarginHFLedger Get Account Ledgers - Margin_hf // Description: This API endpoint returns all transfer (in and out) records in high-frequency margin trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id. + // Documentation: https://www.kucoin.com/docs-new/api-3470123 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -183,6 +196,7 @@ type AccountAPI interface { // GetIsolatedMarginAccount Get Account - Isolated Margin // Description: Request via this endpoint to get the info of the isolated margin account. + // Documentation: https://www.kucoin.com/docs-new/api-3470128 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -196,6 +210,7 @@ type AccountAPI interface { // GetCrossMarginAccount Get Account - Cross Margin // Description: Request via this endpoint to get the info of the cross margin account. + // Documentation: https://www.kucoin.com/docs-new/api-3470127 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/account/account/api_account.template b/sdk/golang/pkg/generate/account/account/api_account.template index bcdd30a..2794c19 100644 --- a/sdk/golang/pkg/generate/account/account/api_account.template +++ b/sdk/golang/pkg/generate/account/account/api_account.template @@ -227,7 +227,7 @@ func TestAccountGetFuturesLedgerReq(t *testing.T) { func TestAccountGetApikeyInfoReq(t *testing.T) { // GetApikeyInfo - // Get API Key Info + // Get Apikey Info // /api/v1/user/api-key diff --git a/sdk/golang/pkg/generate/account/account/api_account_test.go b/sdk/golang/pkg/generate/account/account/api_account_test.go index dff7690..64ea172 100644 --- a/sdk/golang/pkg/generate/account/account/api_account_test.go +++ b/sdk/golang/pkg/generate/account/account/api_account_test.go @@ -108,7 +108,7 @@ func TestAccountGetSpotLedgerRespModel(t *testing.T) { // Get Account Ledgers - Spot/Margin // /api/v1/accounts/ledgers - data := "{\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\": \"\u5b50\u8d26\u53f7\u8f6c\u8d26\",\n \"direction\": \"out\",\n \"createdAt\": 1728658481484,\n \"context\": \"\"\n }\n ]\n }\n}" + data := "{\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}" commonResp := &types.RestResponse{} err := json.Unmarshal([]byte(data), commonResp) assert.Nil(t, err) @@ -279,14 +279,14 @@ func TestAccountGetFuturesLedgerRespModel(t *testing.T) { func TestAccountGetApikeyInfoReqModel(t *testing.T) { // GetApikeyInfo - // Get API Key Info + // Get Apikey Info // /api/v1/user/api-key } func TestAccountGetApikeyInfoRespModel(t *testing.T) { // GetApikeyInfo - // Get API Key Info + // Get Apikey Info // /api/v1/user/api-key data := "{\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}" diff --git a/sdk/golang/pkg/generate/account/account/types_get_apikey_info_resp.go b/sdk/golang/pkg/generate/account/account/types_get_apikey_info_resp.go index a93dca8..2c3c84a 100644 --- a/sdk/golang/pkg/generate/account/account/types_get_apikey_info_resp.go +++ b/sdk/golang/pkg/generate/account/account/types_get_apikey_info_resp.go @@ -16,7 +16,7 @@ type GetApikeyInfoResp struct { ApiKey string `json:"apiKey,omitempty"` // API Version ApiVersion int32 `json:"apiVersion,omitempty"` - // [Permissions](doc://link/pages/338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn + // [Permissions](https://www.kucoin.com/docs-new/doc-338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn Permission string `json:"permission,omitempty"` // IP whitelist IpWhitelist *string `json:"ipWhitelist,omitempty"` diff --git a/sdk/golang/pkg/generate/account/deposit/api_deposit.go b/sdk/golang/pkg/generate/account/deposit/api_deposit.go index 6eb47f7..e530f69 100644 --- a/sdk/golang/pkg/generate/account/deposit/api_deposit.go +++ b/sdk/golang/pkg/generate/account/deposit/api_deposit.go @@ -11,6 +11,7 @@ type DepositAPI interface { // GetDepositAddressV1 Get Deposit Addresses - V1 // Description: Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first. + // Documentation: https://www.kucoin.com/docs-new/api-3470305 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -25,6 +26,7 @@ type DepositAPI interface { // AddDepositAddressV1 Add Deposit Address - V1 // Description: Request via this endpoint to create a deposit address for a currency you intend to deposit. + // Documentation: https://www.kucoin.com/docs-new/api-3470309 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -39,6 +41,7 @@ type DepositAPI interface { // GetDepositHistory Get Deposit History // Description: Request via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page. + // Documentation: https://www.kucoin.com/docs-new/api-3470141 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -52,6 +55,7 @@ type DepositAPI interface { // GetDepositHistoryOld Get Deposit History - Old // Description: Request via this endpoint to get the V1 historical deposits list on KuCoin. The return value is the data after Pagination, sorted in descending order according to time. + // Documentation: https://www.kucoin.com/docs-new/api-3470306 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -66,6 +70,7 @@ type DepositAPI interface { // GetDepositAddressV2 Get Deposit Addresses(V2) // Description: Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first. + // Documentation: https://www.kucoin.com/docs-new/api-3470300 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -80,6 +85,7 @@ type DepositAPI interface { // AddDepositAddressV3 Add Deposit Address(V3) // Description: Request via this endpoint to create a deposit address for a currency you intend to deposit. + // Documentation: https://www.kucoin.com/docs-new/api-3470142 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -91,8 +97,9 @@ type DepositAPI interface { // +---------------------+------------+ AddDepositAddressV3(req *AddDepositAddressV3Req, ctx context.Context) (*AddDepositAddressV3Resp, error) - // GetDepositAddressV3 Get Deposit Addresses(V3) + // GetDepositAddressV3 Get Deposit Address(V3) // Description: Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first. + // Documentation: https://www.kucoin.com/docs-new/api-3470140 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ diff --git a/sdk/golang/pkg/generate/account/deposit/api_deposit.template b/sdk/golang/pkg/generate/account/deposit/api_deposit.template index 1cf0e2f..451a3fc 100644 --- a/sdk/golang/pkg/generate/account/deposit/api_deposit.template +++ b/sdk/golang/pkg/generate/account/deposit/api_deposit.template @@ -141,7 +141,7 @@ func TestDepositAddDepositAddressV3Req(t *testing.T) { func TestDepositGetDepositAddressV3Req(t *testing.T) { // GetDepositAddressV3 - // Get Deposit Addresses(V3) + // Get Deposit Address(V3) // /api/v3/deposit-addresses builder := deposit.NewGetDepositAddressV3ReqBuilder() diff --git a/sdk/golang/pkg/generate/account/deposit/api_deposit_test.go b/sdk/golang/pkg/generate/account/deposit/api_deposit_test.go index c94e103..ff6b1ce 100644 --- a/sdk/golang/pkg/generate/account/deposit/api_deposit_test.go +++ b/sdk/golang/pkg/generate/account/deposit/api_deposit_test.go @@ -177,7 +177,7 @@ func TestDepositAddDepositAddressV3RespModel(t *testing.T) { func TestDepositGetDepositAddressV3ReqModel(t *testing.T) { // GetDepositAddressV3 - // Get Deposit Addresses(V3) + // Get Deposit Address(V3) // /api/v3/deposit-addresses data := "{\"currency\": \"BTC\", \"amount\": \"example_string_default_value\", \"chain\": \"example_string_default_value\"}" @@ -189,7 +189,7 @@ func TestDepositGetDepositAddressV3ReqModel(t *testing.T) { func TestDepositGetDepositAddressV3RespModel(t *testing.T) { // GetDepositAddressV3 - // Get Deposit Addresses(V3) + // Get Deposit Address(V3) // /api/v3/deposit-addresses data := "{\"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\"}]}" diff --git a/sdk/golang/pkg/generate/account/fee/api_fee.go b/sdk/golang/pkg/generate/account/fee/api_fee.go index 1c8d81f..cc6e58c 100644 --- a/sdk/golang/pkg/generate/account/fee/api_fee.go +++ b/sdk/golang/pkg/generate/account/fee/api_fee.go @@ -11,6 +11,7 @@ type FeeAPI interface { // GetBasicFee Get Basic Fee - Spot/Margin // Description: This interface is for the spot/margin basic fee rate of users + // Documentation: https://www.kucoin.com/docs-new/api-3470149 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type FeeAPI interface { // GetSpotActualFee Get Actual Fee - Spot/Margin // Description: This interface is for the actual fee rate of the trading pair. You can inquire about fee rates of 10 trading pairs each time at most. The fee rate of your sub-account is the same as that of the master account. + // Documentation: https://www.kucoin.com/docs-new/api-3470150 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -37,6 +39,7 @@ type FeeAPI interface { // GetFuturesActualFee Get Actual Fee - Futures // Description: This interface is for the actual futures fee rate of the trading pair. The fee rate of your sub-account is the same as that of the master account. + // Documentation: https://www.kucoin.com/docs-new/api-3470151 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/account/subaccount/api_sub_account.go b/sdk/golang/pkg/generate/account/subaccount/api_sub_account.go index f3bbaae..7ebfca0 100644 --- a/sdk/golang/pkg/generate/account/subaccount/api_sub_account.go +++ b/sdk/golang/pkg/generate/account/subaccount/api_sub_account.go @@ -11,6 +11,7 @@ type SubAccountAPI interface { // GetFuturesSubAccountListV2 Get SubAccount List - Futures Balance(V2) // Description: This endpoint can be used to get Futures sub-account information. + // Documentation: https://www.kucoin.com/docs-new/api-3470134 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type SubAccountAPI interface { // GetSpotSubAccountListV1 Get SubAccount List - Spot Balance(V1) // Description: This endpoint returns the account info of all sub-users. + // Documentation: https://www.kucoin.com/docs-new/api-3470299 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -38,6 +40,7 @@ type SubAccountAPI interface { // GetSpotSubAccountDetail Get SubAccount Detail - Balance // Description: This endpoint returns the account info of a sub-user specified by the subUserId. + // Documentation: https://www.kucoin.com/docs-new/api-3470132 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -51,6 +54,7 @@ type SubAccountAPI interface { // DeleteSubAccountApi Delete SubAccount API // Description: This endpoint can be used to delete sub-account APIs. + // Documentation: https://www.kucoin.com/docs-new/api-3470137 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -64,6 +68,7 @@ type SubAccountAPI interface { // GetSubAccountApiList Get SubAccount API List // Description: This endpoint can be used to obtain a list of APIs pertaining to a sub-account.(Not contain ND Broker Sub Account) + // Documentation: https://www.kucoin.com/docs-new/api-3470136 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -77,6 +82,7 @@ type SubAccountAPI interface { // AddSubAccountApi Add SubAccount API // Description: This endpoint can be used to create APIs for sub-accounts. + // Documentation: https://www.kucoin.com/docs-new/api-3470138 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -90,6 +96,7 @@ type SubAccountAPI interface { // ModifySubAccountApi Modify SubAccount API // Description: This endpoint can be used to modify sub-account APIs. + // Documentation: https://www.kucoin.com/docs-new/api-3470139 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -103,6 +110,7 @@ type SubAccountAPI interface { // GetSpotSubAccountsSummaryV1 Get SubAccount List - Summary Info(V1) // 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 + // Documentation: https://www.kucoin.com/docs-new/api-3470298 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -117,6 +125,7 @@ type SubAccountAPI interface { // GetSpotSubAccountListV2 Get SubAccount List - Spot Balance(V2) // Description: This endpoint can be used to get paginated Spot sub-account information. Pagination is required. + // Documentation: https://www.kucoin.com/docs-new/api-3470133 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -130,6 +139,7 @@ type SubAccountAPI interface { // AddSubAccount Add SubAccount // Description: This endpoint can be used to create sub-accounts. + // Documentation: https://www.kucoin.com/docs-new/api-3470135 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -143,6 +153,7 @@ type SubAccountAPI interface { // GetSpotSubAccountsSummaryV2 Get SubAccount List - Summary Info // Description: This endpoint can be used to get a paginated list of sub-accounts. Pagination is required. + // Documentation: https://www.kucoin.com/docs-new/api-3470131 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -156,6 +167,7 @@ type SubAccountAPI interface { // AddSubAccountFuturesPermission Add SubAccount Futures Permission // Description: This endpoint can be used to add sub-accounts Futures permission. Before using this endpoints, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated. + // Documentation: https://www.kucoin.com/docs-new/api-3470332 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -169,6 +181,7 @@ type SubAccountAPI interface { // AddSubAccountMarginPermission Add SubAccount Margin Permission // Description: This endpoint can be used to add sub-accounts Margin permission. Before using this endpoints, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated. + // Documentation: https://www.kucoin.com/docs-new/api-3470331 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ diff --git a/sdk/golang/pkg/generate/account/subaccount/types_add_sub_account_api_req.go b/sdk/golang/pkg/generate/account/subaccount/types_add_sub_account_api_req.go index 7662658..9b1aa44 100644 --- a/sdk/golang/pkg/generate/account/subaccount/types_add_sub_account_api_req.go +++ b/sdk/golang/pkg/generate/account/subaccount/types_add_sub_account_api_req.go @@ -8,7 +8,7 @@ type AddSubAccountApiReq struct { Passphrase string `json:"passphrase,omitempty"` // Remarks(1~24 characters) Remark string `json:"remark,omitempty"` - // [Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\") + // [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\") Permission *string `json:"permission,omitempty"` // IP whitelist(You may add up to 20 IPs. Use a halfwidth comma to each IP) IpWhitelist *string `json:"ipWhitelist,omitempty"` @@ -74,7 +74,7 @@ func (builder *AddSubAccountApiReqBuilder) SetRemark(value string) *AddSubAccoun return builder } -// [Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\") +// [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\") func (builder *AddSubAccountApiReqBuilder) SetPermission(value string) *AddSubAccountApiReqBuilder { builder.obj.Permission = &value return builder diff --git a/sdk/golang/pkg/generate/account/subaccount/types_add_sub_account_api_resp.go b/sdk/golang/pkg/generate/account/subaccount/types_add_sub_account_api_resp.go index 6c50a6e..89e707d 100644 --- a/sdk/golang/pkg/generate/account/subaccount/types_add_sub_account_api_resp.go +++ b/sdk/golang/pkg/generate/account/subaccount/types_add_sub_account_api_resp.go @@ -22,7 +22,7 @@ type AddSubAccountApiResp struct { ApiVersion int32 `json:"apiVersion,omitempty"` // Password Passphrase string `json:"passphrase,omitempty"` - // [Permissions](doc://link/pages/338144) + // [Permissions](https://www.kucoin.com/docs-new/doc-338144) Permission string `json:"permission,omitempty"` // IP whitelist IpWhitelist *string `json:"ipWhitelist,omitempty"` diff --git a/sdk/golang/pkg/generate/account/subaccount/types_get_sub_account_api_list_data.go b/sdk/golang/pkg/generate/account/subaccount/types_get_sub_account_api_list_data.go index 1df53d5..89846bd 100644 --- a/sdk/golang/pkg/generate/account/subaccount/types_get_sub_account_api_list_data.go +++ b/sdk/golang/pkg/generate/account/subaccount/types_get_sub_account_api_list_data.go @@ -12,7 +12,7 @@ type GetSubAccountApiListData struct { ApiKey *string `json:"apiKey,omitempty"` // API Version ApiVersion *int32 `json:"apiVersion,omitempty"` - // [Permissions](doc://link/pages/338144) + // [Permissions](https://www.kucoin.com/docs-new/doc-338144) Permission *string `json:"permission,omitempty"` // IP whitelist IpWhitelist *string `json:"ipWhitelist,omitempty"` diff --git a/sdk/golang/pkg/generate/account/subaccount/types_modify_sub_account_api_req.go b/sdk/golang/pkg/generate/account/subaccount/types_modify_sub_account_api_req.go index 721e50e..10e136c 100644 --- a/sdk/golang/pkg/generate/account/subaccount/types_modify_sub_account_api_req.go +++ b/sdk/golang/pkg/generate/account/subaccount/types_modify_sub_account_api_req.go @@ -6,7 +6,7 @@ package subaccount type ModifySubAccountApiReq struct { // Password(Must contain 7-32 characters. Cannot contain any spaces.) Passphrase string `json:"passphrase,omitempty"` - // [Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\") + // [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\") Permission *string `json:"permission,omitempty"` // IP whitelist(You may add up to 20 IPs. Use a halfwidth comma to each IP) IpWhitelist *string `json:"ipWhitelist,omitempty"` @@ -68,7 +68,7 @@ func (builder *ModifySubAccountApiReqBuilder) SetPassphrase(value string) *Modif return builder } -// [Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\") +// [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\") func (builder *ModifySubAccountApiReqBuilder) SetPermission(value string) *ModifySubAccountApiReqBuilder { builder.obj.Permission = &value return builder diff --git a/sdk/golang/pkg/generate/account/subaccount/types_modify_sub_account_api_resp.go b/sdk/golang/pkg/generate/account/subaccount/types_modify_sub_account_api_resp.go index 3195c2d..d2360ca 100644 --- a/sdk/golang/pkg/generate/account/subaccount/types_modify_sub_account_api_resp.go +++ b/sdk/golang/pkg/generate/account/subaccount/types_modify_sub_account_api_resp.go @@ -14,7 +14,7 @@ type ModifySubAccountApiResp struct { SubName string `json:"subName,omitempty"` // API Key ApiKey string `json:"apiKey,omitempty"` - // [Permissions](doc://link/pages/338144) + // [Permissions](https://www.kucoin.com/docs-new/doc-338144) Permission string `json:"permission,omitempty"` // IP whitelist IpWhitelist *string `json:"ipWhitelist,omitempty"` diff --git a/sdk/golang/pkg/generate/account/transfer/api_transfer.go b/sdk/golang/pkg/generate/account/transfer/api_transfer.go index cde0699..bde4a40 100644 --- a/sdk/golang/pkg/generate/account/transfer/api_transfer.go +++ b/sdk/golang/pkg/generate/account/transfer/api_transfer.go @@ -11,6 +11,7 @@ type TransferAPI interface { // GetTransferQuotas Get Transfer Quotas // Description: This endpoint returns the transferable balance of a specified account. + // Documentation: https://www.kucoin.com/docs-new/api-3470148 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -24,6 +25,7 @@ type TransferAPI interface { // FuturesAccountTransferIn Futures Account Transfer In // 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. + // Documentation: https://www.kucoin.com/docs-new/api-3470304 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -38,6 +40,7 @@ type TransferAPI interface { // GetFuturesAccountTransferOutLedger Get Futures Account Transfer Out Ledger // Description: This endpoint can get futures account transfer out ledger + // Documentation: https://www.kucoin.com/docs-new/api-3470307 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -52,6 +55,7 @@ type TransferAPI interface { // InnerTransfer Inner Transfer // Description: This API endpoint can be used to transfer funds between accounts internally. Users can transfer funds between their account free of charge. + // Documentation: https://www.kucoin.com/docs-new/api-3470302 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -66,6 +70,7 @@ type TransferAPI interface { // SubAccountTransfer SubAccount Transfer // 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. + // Documentation: https://www.kucoin.com/docs-new/api-3470301 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -80,6 +85,7 @@ type TransferAPI interface { // FlexTransfer Flex Transfer // Description: This interface can be used for transfers between master and sub accounts and inner transfers + // Documentation: https://www.kucoin.com/docs-new/api-3470147 // +---------------------+---------------+ // | Extra API Info | Value | // +---------------------+---------------+ @@ -93,6 +99,7 @@ type TransferAPI interface { // FuturesAccountTransferOut Futures Account Transfer Out // 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. + // Documentation: https://www.kucoin.com/docs-new/api-3470303 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ diff --git a/sdk/golang/pkg/generate/account/withdrawal/api_withdrawal.go b/sdk/golang/pkg/generate/account/withdrawal/api_withdrawal.go index b07c53c..39b3b56 100644 --- a/sdk/golang/pkg/generate/account/withdrawal/api_withdrawal.go +++ b/sdk/golang/pkg/generate/account/withdrawal/api_withdrawal.go @@ -11,6 +11,7 @@ type WithdrawalAPI interface { // GetWithdrawalHistoryOld Get Withdrawal History - Old // Description: Request via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page. + // Documentation: https://www.kucoin.com/docs-new/api-3470308 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -25,6 +26,7 @@ type WithdrawalAPI interface { // GetWithdrawalHistory Get Withdrawal History // Description: Request via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page. + // Documentation: https://www.kucoin.com/docs-new/api-3470145 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -38,6 +40,7 @@ type WithdrawalAPI interface { // WithdrawalV1 Withdraw - V1 // Description: Use this interface to withdraw the specified currency + // Documentation: https://www.kucoin.com/docs-new/api-3470310 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -52,6 +55,7 @@ type WithdrawalAPI interface { // GetWithdrawalQuotas Get Withdrawal Quotas // Description: This interface can obtain the withdrawal quotas information of this currency. + // Documentation: https://www.kucoin.com/docs-new/api-3470143 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -65,6 +69,7 @@ type WithdrawalAPI interface { // CancelWithdrawal Cancel Withdrawal // Description: This interface can cancel the withdrawal, Only withdrawals requests of PROCESSING status could be canceled. + // Documentation: https://www.kucoin.com/docs-new/api-3470144 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -78,6 +83,7 @@ type WithdrawalAPI interface { // WithdrawalV3 Withdraw(V3) // Description: Use this interface to withdraw the specified currency + // Documentation: https://www.kucoin.com/docs-new/api-3470146 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ diff --git a/sdk/golang/pkg/generate/affiliate/affiliate/api_affiliate.go b/sdk/golang/pkg/generate/affiliate/affiliate/api_affiliate.go index 35df124..dd28a6b 100644 --- a/sdk/golang/pkg/generate/affiliate/affiliate/api_affiliate.go +++ b/sdk/golang/pkg/generate/affiliate/affiliate/api_affiliate.go @@ -11,6 +11,7 @@ type AffiliateAPI interface { // GetAccount Get Account // Description: This endpoint allows getting affiliate user rebate information. + // Documentation: https://www.kucoin.com/docs-new/api-3470279 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ diff --git a/sdk/golang/pkg/generate/broker/apibroker/api_api_broker.go b/sdk/golang/pkg/generate/broker/apibroker/api_api_broker.go index 21da0c3..c03e81d 100644 --- a/sdk/golang/pkg/generate/broker/apibroker/api_api_broker.go +++ b/sdk/golang/pkg/generate/broker/apibroker/api_api_broker.go @@ -11,6 +11,7 @@ type APIBrokerAPI interface { // GetRebase Get Broker Rebate // Description: This interface supports downloading Broker rebate orders + // Documentation: https://www.kucoin.com/docs-new/api-3470280 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ diff --git a/sdk/golang/pkg/generate/broker/ndbroker/api_nd_broker.go b/sdk/golang/pkg/generate/broker/ndbroker/api_nd_broker.go index c3f82fb..0c6f2a9 100644 --- a/sdk/golang/pkg/generate/broker/ndbroker/api_nd_broker.go +++ b/sdk/golang/pkg/generate/broker/ndbroker/api_nd_broker.go @@ -11,6 +11,7 @@ type NDBrokerAPI interface { // GetDepositList Get Deposit List // Description: This endpoint can obtain the deposit records of each sub-account under the ND Broker. + // Documentation: https://www.kucoin.com/docs-new/api-3470285 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type NDBrokerAPI interface { // DeleteSubAccountAPI Delete SubAccount API // Description: This interface supports deleting Broker’s sub-account APIKEY + // Documentation: https://www.kucoin.com/docs-new/api-3470289 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -37,6 +39,7 @@ type NDBrokerAPI interface { // GetSubAccountAPI Get SubAccount API // Description: This interface supports querying the Broker’s sub-account APIKEY + // Documentation: https://www.kucoin.com/docs-new/api-3470284 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -50,6 +53,7 @@ type NDBrokerAPI interface { // AddSubAccountApi Add SubAccount API // Description: This interface supports the creation of Broker sub-account APIKEY + // Documentation: https://www.kucoin.com/docs-new/api-3470291 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -63,6 +67,7 @@ type NDBrokerAPI interface { // GetSubAccount Get SubAccount // Description: This interface supports querying sub-accounts created by Broker + // Documentation: https://www.kucoin.com/docs-new/api-3470283 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -76,6 +81,7 @@ type NDBrokerAPI interface { // AddSubAccount Add SubAccount // Description: This endpoint supports Broker users to create sub-accounts + // Documentation: https://www.kucoin.com/docs-new/api-3470290 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -89,6 +95,7 @@ type NDBrokerAPI interface { // ModifySubAccountApi Modify SubAccount API // Description: This interface supports modify the Broker’s sub-account APIKEY + // Documentation: https://www.kucoin.com/docs-new/api-3470292 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -102,6 +109,7 @@ type NDBrokerAPI interface { // GetBrokerInfo Get Broker Info // Description: This endpoint supports querying the basic information of the current Broker + // Documentation: https://www.kucoin.com/docs-new/api-3470282 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -115,6 +123,7 @@ type NDBrokerAPI interface { // GetRebase Get Broker Rebate // Description: This interface supports downloading Broker rebate orders + // Documentation: https://www.kucoin.com/docs-new/api-3470281 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -128,6 +137,7 @@ type NDBrokerAPI interface { // Transfer Transfer // Description: This endpoint supports fund transfer between Broker account and Broker sub-accounts. Please be aware that withdrawal from sub-account is not directly supported. Broker has to transfer funds from broker sub-account to broker account to initiate the withdrawals. + // Documentation: https://www.kucoin.com/docs-new/api-3470293 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -141,6 +151,7 @@ type NDBrokerAPI interface { // GetDepositDetail Get Deposit Detail // Description: This endpoint supports querying the deposit record of sub-accounts created by a Broker (excluding main account of nd broker) + // Documentation: https://www.kucoin.com/docs-new/api-3470288 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -154,6 +165,7 @@ type NDBrokerAPI interface { // GetTransferHistory Get Transfer History // Description: This endpoint supports querying transfer records of the broker itself and its created sub-accounts. + // Documentation: https://www.kucoin.com/docs-new/api-3470286 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -167,6 +179,7 @@ type NDBrokerAPI interface { // GetWithdrawDetail Get Withdraw Detail // Description: This endpoint supports querying the withdrawal records of sub-accounts created by a Broker (excluding main account of nd broker). + // Documentation: https://www.kucoin.com/docs-new/api-3470287 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/broker/ndbroker/types_add_sub_account_api_resp.go b/sdk/golang/pkg/generate/broker/ndbroker/types_add_sub_account_api_resp.go index 1aa3afd..db7c5cb 100644 --- a/sdk/golang/pkg/generate/broker/ndbroker/types_add_sub_account_api_resp.go +++ b/sdk/golang/pkg/generate/broker/ndbroker/types_add_sub_account_api_resp.go @@ -20,7 +20,7 @@ type AddSubAccountApiResp struct { SecretKey string `json:"secretKey,omitempty"` // apiVersion ApiVersion int32 `json:"apiVersion,omitempty"` - // [Permissions](doc://link/pages/338144) group list + // [Permissions](https://www.kucoin.com/docs-new/doc-338144) group list Permissions []string `json:"permissions,omitempty"` // IP whitelist list IpWhitelist []string `json:"ipWhitelist,omitempty"` diff --git a/sdk/golang/pkg/generate/broker/ndbroker/types_get_sub_account_api_data.go b/sdk/golang/pkg/generate/broker/ndbroker/types_get_sub_account_api_data.go index b58722c..a011f94 100644 --- a/sdk/golang/pkg/generate/broker/ndbroker/types_get_sub_account_api_data.go +++ b/sdk/golang/pkg/generate/broker/ndbroker/types_get_sub_account_api_data.go @@ -12,7 +12,7 @@ type GetSubAccountAPIData struct { ApiKey string `json:"apiKey,omitempty"` // apiVersion ApiVersion int32 `json:"apiVersion,omitempty"` - // [Permissions](doc://link/pages/338144) group list + // [Permissions](https://www.kucoin.com/docs-new/doc-338144) group list Permissions []string `json:"permissions,omitempty"` // IP whitelist list IpWhitelist []string `json:"ipWhitelist,omitempty"` diff --git a/sdk/golang/pkg/generate/broker/ndbroker/types_modify_sub_account_api_req.go b/sdk/golang/pkg/generate/broker/ndbroker/types_modify_sub_account_api_req.go index 938fcc8..eec23e6 100644 --- a/sdk/golang/pkg/generate/broker/ndbroker/types_modify_sub_account_api_req.go +++ b/sdk/golang/pkg/generate/broker/ndbroker/types_modify_sub_account_api_req.go @@ -8,7 +8,7 @@ type ModifySubAccountApiReq struct { Uid string `json:"uid,omitempty"` // IP whitelist list, supports up to 20 IPs IpWhitelist []string `json:"ipWhitelist,omitempty"` - // [Permissions](doc://link/pages/338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". ) + // [Permissions](https://www.kucoin.com/docs-new/doc-338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". ) Permissions []string `json:"permissions,omitempty"` // apikey remarks (length 4~32) Label string `json:"label,omitempty"` @@ -65,7 +65,7 @@ func (builder *ModifySubAccountApiReqBuilder) SetIpWhitelist(value []string) *Mo return builder } -// [Permissions](doc://link/pages/338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". ) +// [Permissions](https://www.kucoin.com/docs-new/doc-338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". ) func (builder *ModifySubAccountApiReqBuilder) SetPermissions(value []string) *ModifySubAccountApiReqBuilder { builder.obj.Permissions = value return builder diff --git a/sdk/golang/pkg/generate/broker/ndbroker/types_modify_sub_account_api_resp.go b/sdk/golang/pkg/generate/broker/ndbroker/types_modify_sub_account_api_resp.go index f554b39..e5c396d 100644 --- a/sdk/golang/pkg/generate/broker/ndbroker/types_modify_sub_account_api_resp.go +++ b/sdk/golang/pkg/generate/broker/ndbroker/types_modify_sub_account_api_resp.go @@ -18,7 +18,7 @@ type ModifySubAccountApiResp struct { ApiKey string `json:"apiKey,omitempty"` // apiVersion ApiVersion int32 `json:"apiVersion,omitempty"` - // [Permissions](doc://link/pages/338144) group list + // [Permissions](https://www.kucoin.com/docs-new/doc-338144) group list Permissions []string `json:"permissions,omitempty"` // IP whitelist list IpWhitelist []string `json:"ipWhitelist,omitempty"` diff --git a/sdk/golang/pkg/generate/earn/earn/api_earn.go b/sdk/golang/pkg/generate/earn/earn/api_earn.go index 7e1ac29..fc23f4e 100644 --- a/sdk/golang/pkg/generate/earn/earn/api_earn.go +++ b/sdk/golang/pkg/generate/earn/earn/api_earn.go @@ -11,6 +11,7 @@ type EarnAPI interface { // GetETHStakingProducts Get ETH Staking Products // Description: This endpoint can get available ETH staking products. If no products are available, an empty list is returned. + // Documentation: https://www.kucoin.com/docs-new/api-3470276 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type EarnAPI interface { // GetAccountHolding Get Account Holding // Description: This endpoint can get current holding assets information. If no current holding assets are available, an empty list is returned. + // Documentation: https://www.kucoin.com/docs-new/api-3470273 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -37,6 +39,7 @@ type EarnAPI interface { // GetKcsStakingProducts Get KCS Staking Products // Description: This endpoint can get available KCS staking products. If no products are available, an empty list is returned. + // Documentation: https://www.kucoin.com/docs-new/api-3470275 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -50,6 +53,7 @@ type EarnAPI interface { // Redeem Redeem // Description: This endpoint allows initiating redemption by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist. + // Documentation: https://www.kucoin.com/docs-new/api-3470270 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -63,6 +67,7 @@ type EarnAPI interface { // Purchase purchase // Description: This endpoint allows subscribing earn product + // Documentation: https://www.kucoin.com/docs-new/api-3470268 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -76,6 +81,7 @@ type EarnAPI interface { // GetPromotionProducts Get Promotion Products // Description: This endpoint can get available limited-time promotion products. If no products are available, an empty list is returned. + // Documentation: https://www.kucoin.com/docs-new/api-3470272 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -89,6 +95,7 @@ type EarnAPI interface { // GetRedeemPreview Get Redeem Preview // Description: This endpoint allows subscribing earn products + // Documentation: https://www.kucoin.com/docs-new/api-3470269 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -102,6 +109,7 @@ type EarnAPI interface { // GetSavingsProducts Get Savings Products // Description: This endpoint can get available savings products. If no products are available, an empty list is returned. + // Documentation: https://www.kucoin.com/docs-new/api-3470271 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -115,6 +123,7 @@ type EarnAPI interface { // GetStakingProducts Get Staking Products // Description: This endpoint can get available staking products. If no products are available, an empty list is returned. + // Documentation: https://www.kucoin.com/docs-new/api-3470274 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/futures/fundingfees/api_funding_fees.go b/sdk/golang/pkg/generate/futures/fundingfees/api_funding_fees.go index 4e1714b..8da151d 100644 --- a/sdk/golang/pkg/generate/futures/fundingfees/api_funding_fees.go +++ b/sdk/golang/pkg/generate/futures/fundingfees/api_funding_fees.go @@ -11,6 +11,7 @@ type FundingFeesAPI interface { // GetPublicFundingHistory Get Public Funding History // Description: Query the funding rate at each settlement time point within a certain time range of the corresponding contract + // Documentation: https://www.kucoin.com/docs-new/api-3470266 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type FundingFeesAPI interface { // GetPrivateFundingHistory Get Private Funding History // Description: Submit request to get the funding history. + // Documentation: https://www.kucoin.com/docs-new/api-3470267 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -37,6 +39,7 @@ type FundingFeesAPI interface { // GetCurrentFundingRate Get Current Funding Rate // Description: get Current Funding Rate + // Documentation: https://www.kucoin.com/docs-new/api-3470265 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/futures/fundingfees/types_get_current_funding_rate_req.go b/sdk/golang/pkg/generate/futures/fundingfees/types_get_current_funding_rate_req.go index c19444e..980f38a 100644 --- a/sdk/golang/pkg/generate/futures/fundingfees/types_get_current_funding_rate_req.go +++ b/sdk/golang/pkg/generate/futures/fundingfees/types_get_current_funding_rate_req.go @@ -4,7 +4,7 @@ package fundingfees // GetCurrentFundingRateReq struct for GetCurrentFundingRateReq type GetCurrentFundingRateReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" path:"symbol" url:"-"` } @@ -36,7 +36,7 @@ func NewGetCurrentFundingRateReqBuilder() *GetCurrentFundingRateReqBuilder { return &GetCurrentFundingRateReqBuilder{obj: NewGetCurrentFundingRateReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetCurrentFundingRateReqBuilder) SetSymbol(value string) *GetCurrentFundingRateReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/fundingfees/types_get_private_funding_history_data_list.go b/sdk/golang/pkg/generate/futures/fundingfees/types_get_private_funding_history_data_list.go index 2ddc371..a86ed0b 100644 --- a/sdk/golang/pkg/generate/futures/fundingfees/types_get_private_funding_history_data_list.go +++ b/sdk/golang/pkg/generate/futures/fundingfees/types_get_private_funding_history_data_list.go @@ -6,7 +6,7 @@ package fundingfees type GetPrivateFundingHistoryDataList struct { // id Id int64 `json:"id,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Time point (milisecond) TimePoint int64 `json:"timePoint,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/fundingfees/types_get_private_funding_history_req.go b/sdk/golang/pkg/generate/futures/fundingfees/types_get_private_funding_history_req.go index af00fb5..1e8e940 100644 --- a/sdk/golang/pkg/generate/futures/fundingfees/types_get_private_funding_history_req.go +++ b/sdk/golang/pkg/generate/futures/fundingfees/types_get_private_funding_history_req.go @@ -4,7 +4,7 @@ package fundingfees // GetPrivateFundingHistoryReq struct for GetPrivateFundingHistoryReq type GetPrivateFundingHistoryReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // Begin time (milisecond) From *int64 `json:"from,omitempty" url:"from,omitempty"` @@ -54,7 +54,7 @@ func NewGetPrivateFundingHistoryReqBuilder() *GetPrivateFundingHistoryReqBuilder return &GetPrivateFundingHistoryReqBuilder{obj: NewGetPrivateFundingHistoryReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetPrivateFundingHistoryReqBuilder) SetSymbol(value string) *GetPrivateFundingHistoryReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/fundingfees/types_get_public_funding_history_data.go b/sdk/golang/pkg/generate/futures/fundingfees/types_get_public_funding_history_data.go index 7a3905c..4deba88 100644 --- a/sdk/golang/pkg/generate/futures/fundingfees/types_get_public_funding_history_data.go +++ b/sdk/golang/pkg/generate/futures/fundingfees/types_get_public_funding_history_data.go @@ -4,7 +4,7 @@ package fundingfees // GetPublicFundingHistoryData struct for GetPublicFundingHistoryData type GetPublicFundingHistoryData struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Funding rate FundingRate float32 `json:"fundingRate,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/fundingfees/types_get_public_funding_history_req.go b/sdk/golang/pkg/generate/futures/fundingfees/types_get_public_funding_history_req.go index a8fb5ed..68eb7be 100644 --- a/sdk/golang/pkg/generate/futures/fundingfees/types_get_public_funding_history_req.go +++ b/sdk/golang/pkg/generate/futures/fundingfees/types_get_public_funding_history_req.go @@ -4,7 +4,7 @@ package fundingfees // GetPublicFundingHistoryReq struct for GetPublicFundingHistoryReq type GetPublicFundingHistoryReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // Begin time (milisecond) From *int64 `json:"from,omitempty" url:"from,omitempty"` @@ -42,7 +42,7 @@ func NewGetPublicFundingHistoryReqBuilder() *GetPublicFundingHistoryReqBuilder { return &GetPublicFundingHistoryReqBuilder{obj: NewGetPublicFundingHistoryReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetPublicFundingHistoryReqBuilder) SetSymbol(value string) *GetPublicFundingHistoryReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/futuresprivate/types_all_order_event.go b/sdk/golang/pkg/generate/futures/futuresprivate/types_all_order_event.go index 31350e1..5ccc00b 100644 --- a/sdk/golang/pkg/generate/futures/futuresprivate/types_all_order_event.go +++ b/sdk/golang/pkg/generate/futures/futuresprivate/types_all_order_event.go @@ -11,7 +11,7 @@ import ( type AllOrderEvent struct { // common response CommonResponse *types.WsMessage - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) Symbol string `json:"symbol,omitempty"` // User-specified order type OrderType *string `json:"orderType,omitempty"` @@ -39,7 +39,7 @@ type AllOrderEvent struct { Status string `json:"status,omitempty"` // Push time(Nanosecond) Ts int64 `json:"ts,omitempty"` - // Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** + // Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** Liquidity *string `json:"liquidity,omitempty"` // Actual Fee Type FeeType *string `json:"feeType,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/futuresprivate/types_all_position_event.go b/sdk/golang/pkg/generate/futures/futuresprivate/types_all_position_event.go index e315e7f..0b68ec0 100644 --- a/sdk/golang/pkg/generate/futures/futuresprivate/types_all_position_event.go +++ b/sdk/golang/pkg/generate/futures/futuresprivate/types_all_position_event.go @@ -11,7 +11,7 @@ import ( type AllPositionEvent struct { // common response CommonResponse *types.WsMessage - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) Symbol string `json:"symbol,omitempty"` // Whether it is cross margin. CrossMode bool `json:"crossMode,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/futuresprivate/types_order_event.go b/sdk/golang/pkg/generate/futures/futuresprivate/types_order_event.go index 8109cd5..a7aea56 100644 --- a/sdk/golang/pkg/generate/futures/futuresprivate/types_order_event.go +++ b/sdk/golang/pkg/generate/futures/futuresprivate/types_order_event.go @@ -11,7 +11,7 @@ import ( type OrderEvent struct { // common response CommonResponse *types.WsMessage - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) Symbol string `json:"symbol,omitempty"` // User-specified order type OrderType *string `json:"orderType,omitempty"` @@ -39,7 +39,7 @@ type OrderEvent struct { Status string `json:"status,omitempty"` // Push time(Nanosecond) Ts int64 `json:"ts,omitempty"` - // Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** + // Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** Liquidity *string `json:"liquidity,omitempty"` // Actual Fee Type FeeType *string `json:"feeType,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/futuresprivate/types_position_event.go b/sdk/golang/pkg/generate/futures/futuresprivate/types_position_event.go index 5d80558..e6dff42 100644 --- a/sdk/golang/pkg/generate/futures/futuresprivate/types_position_event.go +++ b/sdk/golang/pkg/generate/futures/futuresprivate/types_position_event.go @@ -11,7 +11,7 @@ import ( type PositionEvent struct { // common response CommonResponse *types.WsMessage - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) Symbol string `json:"symbol,omitempty"` // Whether it is cross margin. CrossMode bool `json:"crossMode,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/futuresprivate/types_stop_orders_event.go b/sdk/golang/pkg/generate/futures/futuresprivate/types_stop_orders_event.go index 21e25a1..20a1a0b 100644 --- a/sdk/golang/pkg/generate/futures/futuresprivate/types_stop_orders_event.go +++ b/sdk/golang/pkg/generate/futures/futuresprivate/types_stop_orders_event.go @@ -29,7 +29,7 @@ type StopOrdersEvent struct { // Stop Price StopPrice string `json:"stopPrice,omitempty"` StopPriceType string `json:"stopPriceType,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) Symbol string `json:"symbol,omitempty"` Ts int64 `json:"ts,omitempty"` // Order Type diff --git a/sdk/golang/pkg/generate/futures/futurespublic/types_klines_event.go b/sdk/golang/pkg/generate/futures/futurespublic/types_klines_event.go index 29d7a9f..29d4880 100644 --- a/sdk/golang/pkg/generate/futures/futurespublic/types_klines_event.go +++ b/sdk/golang/pkg/generate/futures/futurespublic/types_klines_event.go @@ -11,7 +11,7 @@ import ( type KlinesEvent struct { // common response CommonResponse *types.WsMessage - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Start time, open price, close price, high price, low price, Transaction volume(This value is incorrect, please do not use it, we will fix it in subsequent versions), Transaction amount Candles []string `json:"candles,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/market/api_market.go b/sdk/golang/pkg/generate/futures/market/api_market.go index 27d65a6..c635ff2 100644 --- a/sdk/golang/pkg/generate/futures/market/api_market.go +++ b/sdk/golang/pkg/generate/futures/market/api_market.go @@ -11,6 +11,7 @@ type MarketAPI interface { // GetAllTickers Get All Tickers // Description: This endpoint returns \"last traded price/size\"、\"best bid/ask price/size\" etc. of a single symbol. These messages can also be obtained through Websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470223 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type MarketAPI interface { // GetPrivateToken Get Private Token - Futures // Description: This interface can obtain the token required for websocket to establish a Futures private connection. If you need use private channels(e.g. account balance notice), please make request as follows to obtain the server list and private token + // Documentation: https://www.kucoin.com/docs-new/api-3470296 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -37,6 +39,7 @@ type MarketAPI interface { // GetPublicToken Get Public Token - Futures // Description: This interface can obtain the token required for websocket to establish a Futures connection. If you need use public channels (e.g. all public market data), please make request as follows to obtain the server list and public token + // Documentation: https://www.kucoin.com/docs-new/api-3470297 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -50,6 +53,7 @@ type MarketAPI interface { // GetAllSymbols Get All Symbols // Description: Get detailed information of all contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc. + // Documentation: https://www.kucoin.com/docs-new/api-3470220 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -63,6 +67,7 @@ type MarketAPI interface { // GetSymbol Get Symbol // Description: Get information of specified contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc. + // Documentation: https://www.kucoin.com/docs-new/api-3470221 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -76,6 +81,7 @@ type MarketAPI interface { // GetSpotIndexPrice Get Spot Index Price // Description: Get Spot Index Price + // Documentation: https://www.kucoin.com/docs-new/api-3470231 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -89,6 +95,7 @@ type MarketAPI interface { // GetInterestRateIndex Get Interest Rate Index // Description: Get interest rate Index. + // Documentation: https://www.kucoin.com/docs-new/api-3470226 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -102,6 +109,7 @@ type MarketAPI interface { // GetKlines Get Klines // Description: Get the Kline of the symbol. Data are returned in grouped buckets based on requested type. For each query, the system would return at most 500 pieces of data. To obtain more data, please page the data by time. + // Documentation: https://www.kucoin.com/docs-new/api-3470234 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -115,6 +123,7 @@ type MarketAPI interface { // GetPartOrderBook Get Part OrderBook // Description: Query for part orderbook depth data. (aggregated by price) You are recommended to request via this endpoint as the system reponse would be faster and cosume less traffic. + // Documentation: https://www.kucoin.com/docs-new/api-3470225 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -128,6 +137,7 @@ type MarketAPI interface { // GetFullOrderBook Get Full OrderBook // Description: Query for Full orderbook depth data. (aggregated by price) It is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control. To maintain up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook. + // Documentation: https://www.kucoin.com/docs-new/api-3470224 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -141,6 +151,7 @@ type MarketAPI interface { // GetMarkPrice Get Mark Price // Description: Get current mark price + // Documentation: https://www.kucoin.com/docs-new/api-3470233 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -154,6 +165,7 @@ type MarketAPI interface { // GetPremiumIndex Get Premium Index // Description: Submit request to get premium index. + // Documentation: https://www.kucoin.com/docs-new/api-3470227 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -167,6 +179,7 @@ type MarketAPI interface { // GetServiceStatus Get Service Status // Description: Get the service status. + // Documentation: https://www.kucoin.com/docs-new/api-3470230 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -180,6 +193,7 @@ type MarketAPI interface { // GetTicker Get Ticker // Description: This endpoint returns \"last traded price/size\"、\"best bid/ask price/size\" etc. of a single symbol. These messages can also be obtained through Websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470222 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -193,6 +207,7 @@ type MarketAPI interface { // GetServerTime Get Server Time // Description: Get the API server time. This is the Unix timestamp. + // Documentation: https://www.kucoin.com/docs-new/api-3470229 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -206,6 +221,7 @@ type MarketAPI interface { // GetTradeHistory Get Trade History // Description: Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records. + // Documentation: https://www.kucoin.com/docs-new/api-3470232 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -219,6 +235,7 @@ type MarketAPI interface { // Get24hrStats Get 24hr Stats // Description: Get the statistics of the platform futures trading volume in the last 24 hours. + // Documentation: https://www.kucoin.com/docs-new/api-3470228 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/futures/market/types_get_full_order_book_req.go b/sdk/golang/pkg/generate/futures/market/types_get_full_order_book_req.go index 0f01e36..8168794 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_full_order_book_req.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_full_order_book_req.go @@ -4,7 +4,7 @@ package market // GetFullOrderBookReq struct for GetFullOrderBookReq type GetFullOrderBookReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewGetFullOrderBookReqBuilder() *GetFullOrderBookReqBuilder { return &GetFullOrderBookReqBuilder{obj: NewGetFullOrderBookReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetFullOrderBookReqBuilder) SetSymbol(value string) *GetFullOrderBookReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/market/types_get_full_order_book_resp.go b/sdk/golang/pkg/generate/futures/market/types_get_full_order_book_resp.go index 846bc8a..fbf3305 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_full_order_book_resp.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_full_order_book_resp.go @@ -12,7 +12,7 @@ type GetFullOrderBookResp struct { CommonResponse *types.RestResponse // Sequence number Sequence int64 `json:"sequence,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // bids, from high to low Bids [][]float32 `json:"bids,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/market/types_get_interest_rate_index_data_list.go b/sdk/golang/pkg/generate/futures/market/types_get_interest_rate_index_data_list.go index d8967f5..c3fbb48 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_interest_rate_index_data_list.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_interest_rate_index_data_list.go @@ -4,7 +4,7 @@ package market // GetInterestRateIndexDataList struct for GetInterestRateIndexDataList type GetInterestRateIndexDataList struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Granularity (milisecond) Granularity int32 `json:"granularity,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/market/types_get_interest_rate_index_req.go b/sdk/golang/pkg/generate/futures/market/types_get_interest_rate_index_req.go index 4ef609a..bf70033 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_interest_rate_index_req.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_interest_rate_index_req.go @@ -4,7 +4,7 @@ package market // GetInterestRateIndexReq struct for GetInterestRateIndexReq type GetInterestRateIndexReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // Start time (milisecond) StartAt *int64 `json:"startAt,omitempty" url:"startAt,omitempty"` @@ -66,7 +66,7 @@ func NewGetInterestRateIndexReqBuilder() *GetInterestRateIndexReqBuilder { return &GetInterestRateIndexReqBuilder{obj: NewGetInterestRateIndexReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetInterestRateIndexReqBuilder) SetSymbol(value string) *GetInterestRateIndexReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/market/types_get_klines_req.go b/sdk/golang/pkg/generate/futures/market/types_get_klines_req.go index 12087c3..9870422 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_klines_req.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_klines_req.go @@ -4,7 +4,7 @@ package market // GetKlinesReq struct for GetKlinesReq type GetKlinesReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // Type of candlestick patterns(minute) Granularity *int64 `json:"granularity,omitempty" url:"granularity,omitempty"` @@ -45,7 +45,7 @@ func NewGetKlinesReqBuilder() *GetKlinesReqBuilder { return &GetKlinesReqBuilder{obj: NewGetKlinesReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetKlinesReqBuilder) SetSymbol(value string) *GetKlinesReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/market/types_get_mark_price_req.go b/sdk/golang/pkg/generate/futures/market/types_get_mark_price_req.go index ab48c96..43240b8 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_mark_price_req.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_mark_price_req.go @@ -4,7 +4,7 @@ package market // GetMarkPriceReq struct for GetMarkPriceReq type GetMarkPriceReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" path:"symbol" url:"-"` } @@ -36,7 +36,7 @@ func NewGetMarkPriceReqBuilder() *GetMarkPriceReqBuilder { return &GetMarkPriceReqBuilder{obj: NewGetMarkPriceReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetMarkPriceReqBuilder) SetSymbol(value string) *GetMarkPriceReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/market/types_get_mark_price_resp.go b/sdk/golang/pkg/generate/futures/market/types_get_mark_price_resp.go index d8be9ee..3e9dee8 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_mark_price_resp.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_mark_price_resp.go @@ -10,7 +10,7 @@ import ( type GetMarkPriceResp struct { // common response CommonResponse *types.RestResponse - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Granularity (milisecond) Granularity int32 `json:"granularity,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/market/types_get_part_order_book_req.go b/sdk/golang/pkg/generate/futures/market/types_get_part_order_book_req.go index fbacba3..e97dac8 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_part_order_book_req.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_part_order_book_req.go @@ -4,7 +4,7 @@ package market // GetPartOrderBookReq struct for GetPartOrderBookReq type GetPartOrderBookReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // Get the depth layer, optional value: 20, 100 Size *string `json:"size,omitempty" path:"size" url:"-"` @@ -39,7 +39,7 @@ func NewGetPartOrderBookReqBuilder() *GetPartOrderBookReqBuilder { return &GetPartOrderBookReqBuilder{obj: NewGetPartOrderBookReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetPartOrderBookReqBuilder) SetSymbol(value string) *GetPartOrderBookReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/market/types_get_part_order_book_resp.go b/sdk/golang/pkg/generate/futures/market/types_get_part_order_book_resp.go index da86ba0..5627c5f 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_part_order_book_resp.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_part_order_book_resp.go @@ -12,7 +12,7 @@ type GetPartOrderBookResp struct { CommonResponse *types.RestResponse // Sequence number Sequence int64 `json:"sequence,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // bids, from high to low Bids [][]float32 `json:"bids,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/market/types_get_premium_index_data_list.go b/sdk/golang/pkg/generate/futures/market/types_get_premium_index_data_list.go index 08a62cf..b1bfee7 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_premium_index_data_list.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_premium_index_data_list.go @@ -4,7 +4,7 @@ package market // GetPremiumIndexDataList struct for GetPremiumIndexDataList type GetPremiumIndexDataList struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Granularity(milisecond) Granularity int32 `json:"granularity,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/market/types_get_premium_index_req.go b/sdk/golang/pkg/generate/futures/market/types_get_premium_index_req.go index 79c1634..54a38c9 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_premium_index_req.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_premium_index_req.go @@ -4,7 +4,7 @@ package market // GetPremiumIndexReq struct for GetPremiumIndexReq type GetPremiumIndexReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // Start time (milisecond) StartAt *int64 `json:"startAt,omitempty" url:"startAt,omitempty"` @@ -66,7 +66,7 @@ func NewGetPremiumIndexReqBuilder() *GetPremiumIndexReqBuilder { return &GetPremiumIndexReqBuilder{obj: NewGetPremiumIndexReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetPremiumIndexReqBuilder) SetSymbol(value string) *GetPremiumIndexReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/market/types_get_spot_index_price_data_list.go b/sdk/golang/pkg/generate/futures/market/types_get_spot_index_price_data_list.go index 62ff506..1a10e60 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_spot_index_price_data_list.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_spot_index_price_data_list.go @@ -4,7 +4,7 @@ package market // GetSpotIndexPriceDataList struct for GetSpotIndexPriceDataList type GetSpotIndexPriceDataList struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Granularity (milisecond) Granularity int32 `json:"granularity,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/market/types_get_spot_index_price_req.go b/sdk/golang/pkg/generate/futures/market/types_get_spot_index_price_req.go index e5fa1e1..5a6d439 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_spot_index_price_req.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_spot_index_price_req.go @@ -4,7 +4,7 @@ package market // GetSpotIndexPriceReq struct for GetSpotIndexPriceReq type GetSpotIndexPriceReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // Start time (milisecond) StartAt *int64 `json:"startAt,omitempty" url:"startAt,omitempty"` @@ -66,7 +66,7 @@ func NewGetSpotIndexPriceReqBuilder() *GetSpotIndexPriceReqBuilder { return &GetSpotIndexPriceReqBuilder{obj: NewGetSpotIndexPriceReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetSpotIndexPriceReqBuilder) SetSymbol(value string) *GetSpotIndexPriceReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/market/types_get_ticker_req.go b/sdk/golang/pkg/generate/futures/market/types_get_ticker_req.go index 3f27b90..0975ccb 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_ticker_req.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_ticker_req.go @@ -4,7 +4,7 @@ package market // GetTickerReq struct for GetTickerReq type GetTickerReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewGetTickerReqBuilder() *GetTickerReqBuilder { return &GetTickerReqBuilder{obj: NewGetTickerReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetTickerReqBuilder) SetSymbol(value string) *GetTickerReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/market/types_get_ticker_resp.go b/sdk/golang/pkg/generate/futures/market/types_get_ticker_resp.go index 8f95f98..4d77305 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_ticker_resp.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_ticker_resp.go @@ -12,7 +12,7 @@ type GetTickerResp struct { CommonResponse *types.RestResponse // Sequence number, used to judge whether the messages pushed by Websocket is continuous. Sequence int64 `json:"sequence,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Filled side, The trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book. Side string `json:"side,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/market/types_get_trade_history_req.go b/sdk/golang/pkg/generate/futures/market/types_get_trade_history_req.go index febfb59..e2c1fb2 100644 --- a/sdk/golang/pkg/generate/futures/market/types_get_trade_history_req.go +++ b/sdk/golang/pkg/generate/futures/market/types_get_trade_history_req.go @@ -4,7 +4,7 @@ package market // GetTradeHistoryReq struct for GetTradeHistoryReq type GetTradeHistoryReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewGetTradeHistoryReqBuilder() *GetTradeHistoryReqBuilder { return &GetTradeHistoryReqBuilder{obj: NewGetTradeHistoryReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetTradeHistoryReqBuilder) SetSymbol(value string) *GetTradeHistoryReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/api_order.go b/sdk/golang/pkg/generate/futures/order/api_order.go index 30fb4a8..f13d780 100644 --- a/sdk/golang/pkg/generate/futures/order/api_order.go +++ b/sdk/golang/pkg/generate/futures/order/api_order.go @@ -11,6 +11,7 @@ type OrderAPI interface { // GetTradeHistory Get Trade History // Description: Get a list of recent fills. If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time. + // Documentation: https://www.kucoin.com/docs-new/api-3470248 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type OrderAPI interface { // GetOpenOrderValue Get Open Order Value // Description: You can query this endpoint to get the the total number and value of the all your active orders. + // Documentation: https://www.kucoin.com/docs-new/api-3470250 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -37,6 +39,7 @@ type OrderAPI interface { // GetOrderByClientOid Get Order By ClientOid // Description: Get a single order by client order id (including a stop order). + // Documentation: https://www.kucoin.com/docs-new/api-3470352 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -50,6 +53,7 @@ type OrderAPI interface { // CancelOrderByClientOid Cancel Order By ClientOid // Description: Cancel order by client defined orderId. + // Documentation: https://www.kucoin.com/docs-new/api-3470240 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -63,6 +67,7 @@ type OrderAPI interface { // CancelAllOrdersV1 Cancel All Orders - V1 // Description: Cancel all open orders (excluding stop orders). The response is a list of orderIDs of the canceled orders. + // Documentation: https://www.kucoin.com/docs-new/api-3470362 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -70,13 +75,14 @@ type OrderAPI interface { // | API-CHANNEL | PRIVATE | // | API-PERMISSION | FUTURES | // | API-RATE-LIMIT-POOL | FUTURES | - // | API-RATE-LIMIT | 30 | + // | API-RATE-LIMIT | 200 | // +---------------------+---------+ // Deprecated CancelAllOrdersV1(req *CancelAllOrdersV1Req, ctx context.Context) (*CancelAllOrdersV1Resp, error) // GetOrderList Get Order List // Description: List your current orders. + // Documentation: https://www.kucoin.com/docs-new/api-3470244 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -90,6 +96,7 @@ type OrderAPI interface { // BatchCancelOrders Batch Cancel Orders // Description: Cancel a bach of orders by client defined orderId or system generated orderId + // Documentation: https://www.kucoin.com/docs-new/api-3470241 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -103,6 +110,7 @@ type OrderAPI interface { // BatchAddOrders Batch Add Orders // Description: Place multiple order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. You can place up to 20 orders at one time, including limit orders, market orders, and stop orders Please be noted that the system would hold the fees from the orders entered the orderbook in advance. + // Documentation: https://www.kucoin.com/docs-new/api-3470236 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -116,6 +124,7 @@ type OrderAPI interface { // CancelOrderById Cancel Order By OrderId // Description: Cancel order by system generated orderId. + // Documentation: https://www.kucoin.com/docs-new/api-3470239 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -129,6 +138,7 @@ type OrderAPI interface { // GetOrderByOrderId Get Order By OrderId // Description: Get a single order by order id (including a stop order). + // Documentation: https://www.kucoin.com/docs-new/api-3470245 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -142,6 +152,7 @@ type OrderAPI interface { // AddOrder Add Order // Description: Place order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + // Documentation: https://www.kucoin.com/docs-new/api-3470235 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -155,6 +166,7 @@ type OrderAPI interface { // AddOrderTest Add Order Test // Description: Place order to the futures trading system just for validation + // Documentation: https://www.kucoin.com/docs-new/api-3470238 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -168,6 +180,7 @@ type OrderAPI interface { // GetRecentClosedOrders Get Recent Closed Orders // Description: Get a list of recent 1000 closed orders in the last 24 hours. If you need to get your recent traded order history with low latency, you may query this endpoint. + // Documentation: https://www.kucoin.com/docs-new/api-3470246 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -181,6 +194,7 @@ type OrderAPI interface { // GetRecentTradeHistory Get Recent Trade History // Description: Get a list of recent 1000 fills in the last 24 hours. If you need to get your recent traded order history with low latency, you may query this endpoint. + // Documentation: https://www.kucoin.com/docs-new/api-3470249 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -194,6 +208,7 @@ type OrderAPI interface { // AddTPSLOrder Add Take Profit And Stop Loss Order // Description: Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order interface. + // Documentation: https://www.kucoin.com/docs-new/api-3470237 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -207,6 +222,7 @@ type OrderAPI interface { // CancelAllStopOrders Cancel All Stop orders // Description: Cancel all untriggered stop orders. The response is a list of orderIDs of the canceled stop orders. To cancel triggered stop orders, please use 'Cancel Multiple Futures Limit orders'. + // Documentation: https://www.kucoin.com/docs-new/api-3470243 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -220,6 +236,7 @@ type OrderAPI interface { // GetStopOrderList Get Stop Order List // Description: Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order interface + // Documentation: https://www.kucoin.com/docs-new/api-3470247 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -233,6 +250,7 @@ type OrderAPI interface { // CancelAllOrdersV3 Cancel All Orders // Description: Cancel all open orders (excluding stop orders). The response is a list of orderIDs of the canceled orders. + // Documentation: https://www.kucoin.com/docs-new/api-3470242 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/futures/order/types_add_order_req.go b/sdk/golang/pkg/generate/futures/order/types_add_order_req.go index 8041481..ffc72e1 100644 --- a/sdk/golang/pkg/generate/futures/order/types_add_order_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_add_order_req.go @@ -8,7 +8,7 @@ type AddOrderReq struct { ClientOid string `json:"clientOid,omitempty"` // specify if the order is to 'buy' or 'sell' Side string `json:"side,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. Leverage int32 `json:"leverage,omitempty"` @@ -28,7 +28,7 @@ type AddOrderReq struct { CloseOrder *bool `json:"closeOrder,omitempty"` // A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. ForceHold *bool `json:"forceHold,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. Stp *string `json:"stp,omitempty"` // Margin mode: ISOLATED, CROSS, default: ISOLATED MarginMode *string `json:"marginMode,omitempty"` @@ -36,7 +36,7 @@ type AddOrderReq struct { Price *string `json:"price,omitempty"` // **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. Size *int32 `json:"size,omitempty"` - // Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + // Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC TimeInForce *string `json:"timeInForce,omitempty"` // Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. PostOnly *bool `json:"postOnly,omitempty"` @@ -154,7 +154,7 @@ func (builder *AddOrderReqBuilder) SetSide(value string) *AddOrderReqBuilder { return builder } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *AddOrderReqBuilder) SetSymbol(value string) *AddOrderReqBuilder { builder.obj.Symbol = value return builder @@ -214,7 +214,7 @@ func (builder *AddOrderReqBuilder) SetForceHold(value bool) *AddOrderReqBuilder return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. func (builder *AddOrderReqBuilder) SetStp(value string) *AddOrderReqBuilder { builder.obj.Stp = &value return builder @@ -238,7 +238,7 @@ func (builder *AddOrderReqBuilder) SetSize(value int32) *AddOrderReqBuilder { return builder } -// Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC +// Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC func (builder *AddOrderReqBuilder) SetTimeInForce(value string) *AddOrderReqBuilder { builder.obj.TimeInForce = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_add_order_test_req.go b/sdk/golang/pkg/generate/futures/order/types_add_order_test_req.go index c36fab0..1189f58 100644 --- a/sdk/golang/pkg/generate/futures/order/types_add_order_test_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_add_order_test_req.go @@ -8,7 +8,7 @@ type AddOrderTestReq struct { ClientOid string `json:"clientOid,omitempty"` // specify if the order is to 'buy' or 'sell' Side string `json:"side,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. Leverage int32 `json:"leverage,omitempty"` @@ -28,7 +28,7 @@ type AddOrderTestReq struct { CloseOrder *bool `json:"closeOrder,omitempty"` // A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. ForceHold *bool `json:"forceHold,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. Stp *string `json:"stp,omitempty"` // Margin mode: ISOLATED, CROSS, default: ISOLATED MarginMode *string `json:"marginMode,omitempty"` @@ -36,7 +36,7 @@ type AddOrderTestReq struct { Price *string `json:"price,omitempty"` // **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. Size *int32 `json:"size,omitempty"` - // Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + // Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC TimeInForce *string `json:"timeInForce,omitempty"` // Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. PostOnly *bool `json:"postOnly,omitempty"` @@ -153,7 +153,7 @@ func (builder *AddOrderTestReqBuilder) SetSide(value string) *AddOrderTestReqBui return builder } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *AddOrderTestReqBuilder) SetSymbol(value string) *AddOrderTestReqBuilder { builder.obj.Symbol = value return builder @@ -213,7 +213,7 @@ func (builder *AddOrderTestReqBuilder) SetForceHold(value bool) *AddOrderTestReq return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. func (builder *AddOrderTestReqBuilder) SetStp(value string) *AddOrderTestReqBuilder { builder.obj.Stp = &value return builder @@ -237,7 +237,7 @@ func (builder *AddOrderTestReqBuilder) SetSize(value int32) *AddOrderTestReqBuil return builder } -// Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC +// Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC func (builder *AddOrderTestReqBuilder) SetTimeInForce(value string) *AddOrderTestReqBuilder { builder.obj.TimeInForce = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_add_tpsl_order_req.go b/sdk/golang/pkg/generate/futures/order/types_add_tpsl_order_req.go index fe2fd82..b5a6c6c 100644 --- a/sdk/golang/pkg/generate/futures/order/types_add_tpsl_order_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_add_tpsl_order_req.go @@ -8,7 +8,7 @@ type AddTPSLOrderReq struct { ClientOid string `json:"clientOid,omitempty"` // specify if the order is to 'buy' or 'sell' Side string `json:"side,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. Leverage int32 `json:"leverage,omitempty"` @@ -24,7 +24,7 @@ type AddTPSLOrderReq struct { CloseOrder *bool `json:"closeOrder,omitempty"` // A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. ForceHold *bool `json:"forceHold,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. Stp *string `json:"stp,omitempty"` // Margin mode: ISOLATED, CROSS, default: ISOLATED MarginMode *string `json:"marginMode,omitempty"` @@ -32,7 +32,7 @@ type AddTPSLOrderReq struct { Price *string `json:"price,omitempty"` // **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. Size *int32 `json:"size,omitempty"` - // Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + // Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC TimeInForce *string `json:"timeInForce,omitempty"` // Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. PostOnly *bool `json:"postOnly,omitempty"` @@ -153,7 +153,7 @@ func (builder *AddTPSLOrderReqBuilder) SetSide(value string) *AddTPSLOrderReqBui return builder } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *AddTPSLOrderReqBuilder) SetSymbol(value string) *AddTPSLOrderReqBuilder { builder.obj.Symbol = value return builder @@ -201,7 +201,7 @@ func (builder *AddTPSLOrderReqBuilder) SetForceHold(value bool) *AddTPSLOrderReq return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. func (builder *AddTPSLOrderReqBuilder) SetStp(value string) *AddTPSLOrderReqBuilder { builder.obj.Stp = &value return builder @@ -225,7 +225,7 @@ func (builder *AddTPSLOrderReqBuilder) SetSize(value int32) *AddTPSLOrderReqBuil return builder } -// Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC +// Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC func (builder *AddTPSLOrderReqBuilder) SetTimeInForce(value string) *AddTPSLOrderReqBuilder { builder.obj.TimeInForce = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_batch_add_orders_data.go b/sdk/golang/pkg/generate/futures/order/types_batch_add_orders_data.go index 25a751c..872c1a6 100644 --- a/sdk/golang/pkg/generate/futures/order/types_batch_add_orders_data.go +++ b/sdk/golang/pkg/generate/futures/order/types_batch_add_orders_data.go @@ -8,7 +8,7 @@ type BatchAddOrdersData struct { OrderId string `json:"orderId,omitempty"` // Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) ClientOid string `json:"clientOid,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` Code string `json:"code,omitempty"` Msg string `json:"msg,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/order/types_batch_add_orders_item.go b/sdk/golang/pkg/generate/futures/order/types_batch_add_orders_item.go index 44affc6..65ae213 100644 --- a/sdk/golang/pkg/generate/futures/order/types_batch_add_orders_item.go +++ b/sdk/golang/pkg/generate/futures/order/types_batch_add_orders_item.go @@ -8,7 +8,7 @@ type BatchAddOrdersItem struct { ClientOid string `json:"clientOid,omitempty"` // specify if the order is to 'buy' or 'sell' Side string `json:"side,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) Symbol string `json:"symbol,omitempty"` // Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. Leverage int32 `json:"leverage,omitempty"` @@ -28,7 +28,7 @@ type BatchAddOrdersItem struct { CloseOrder *bool `json:"closeOrder,omitempty"` // A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. ForceHold *bool `json:"forceHold,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. Stp *string `json:"stp,omitempty"` // Margin mode: ISOLATED, CROSS, default: ISOLATED MarginMode *string `json:"marginMode,omitempty"` @@ -36,7 +36,7 @@ type BatchAddOrdersItem struct { Price *string `json:"price,omitempty"` // **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. Size *int32 `json:"size,omitempty"` - // Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + // Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC TimeInForce *string `json:"timeInForce,omitempty"` // Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. PostOnly *bool `json:"postOnly,omitempty"` @@ -153,7 +153,7 @@ func (builder *BatchAddOrdersItemBuilder) SetSide(value string) *BatchAddOrdersI return builder } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) func (builder *BatchAddOrdersItemBuilder) SetSymbol(value string) *BatchAddOrdersItemBuilder { builder.obj.Symbol = value return builder @@ -213,7 +213,7 @@ func (builder *BatchAddOrdersItemBuilder) SetForceHold(value bool) *BatchAddOrde return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. func (builder *BatchAddOrdersItemBuilder) SetStp(value string) *BatchAddOrdersItemBuilder { builder.obj.Stp = &value return builder @@ -237,7 +237,7 @@ func (builder *BatchAddOrdersItemBuilder) SetSize(value int32) *BatchAddOrdersIt return builder } -// Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC +// Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC func (builder *BatchAddOrdersItemBuilder) SetTimeInForce(value string) *BatchAddOrdersItemBuilder { builder.obj.TimeInForce = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_batch_cancel_orders_client_oids_list.go b/sdk/golang/pkg/generate/futures/order/types_batch_cancel_orders_client_oids_list.go index 17f189e..b207eea 100644 --- a/sdk/golang/pkg/generate/futures/order/types_batch_cancel_orders_client_oids_list.go +++ b/sdk/golang/pkg/generate/futures/order/types_batch_cancel_orders_client_oids_list.go @@ -4,7 +4,7 @@ package order // BatchCancelOrdersClientOidsList struct for BatchCancelOrdersClientOidsList type BatchCancelOrdersClientOidsList struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` ClientOid string `json:"clientOid,omitempty"` } @@ -40,7 +40,7 @@ func NewBatchCancelOrdersClientOidsListBuilder() *BatchCancelOrdersClientOidsLis return &BatchCancelOrdersClientOidsListBuilder{obj: NewBatchCancelOrdersClientOidsListWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *BatchCancelOrdersClientOidsListBuilder) SetSymbol(value string) *BatchCancelOrdersClientOidsListBuilder { builder.obj.Symbol = value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_cancel_all_orders_v1_req.go b/sdk/golang/pkg/generate/futures/order/types_cancel_all_orders_v1_req.go index 5c0ae16..a6ae6a4 100644 --- a/sdk/golang/pkg/generate/futures/order/types_cancel_all_orders_v1_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_cancel_all_orders_v1_req.go @@ -4,7 +4,7 @@ package order // CancelAllOrdersV1Req struct for CancelAllOrdersV1Req type CancelAllOrdersV1Req struct { - // Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewCancelAllOrdersV1ReqBuilder() *CancelAllOrdersV1ReqBuilder { return &CancelAllOrdersV1ReqBuilder{obj: NewCancelAllOrdersV1ReqWithDefaults()} } -// Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *CancelAllOrdersV1ReqBuilder) SetSymbol(value string) *CancelAllOrdersV1ReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_cancel_all_orders_v3_req.go b/sdk/golang/pkg/generate/futures/order/types_cancel_all_orders_v3_req.go index f1ae502..2a8b51c 100644 --- a/sdk/golang/pkg/generate/futures/order/types_cancel_all_orders_v3_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_cancel_all_orders_v3_req.go @@ -4,7 +4,7 @@ package order // CancelAllOrdersV3Req struct for CancelAllOrdersV3Req type CancelAllOrdersV3Req struct { - // Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewCancelAllOrdersV3ReqBuilder() *CancelAllOrdersV3ReqBuilder { return &CancelAllOrdersV3ReqBuilder{obj: NewCancelAllOrdersV3ReqWithDefaults()} } -// Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *CancelAllOrdersV3ReqBuilder) SetSymbol(value string) *CancelAllOrdersV3ReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_cancel_all_stop_orders_req.go b/sdk/golang/pkg/generate/futures/order/types_cancel_all_stop_orders_req.go index 8925a1c..16bb515 100644 --- a/sdk/golang/pkg/generate/futures/order/types_cancel_all_stop_orders_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_cancel_all_stop_orders_req.go @@ -4,7 +4,7 @@ package order // CancelAllStopOrdersReq struct for CancelAllStopOrdersReq type CancelAllStopOrdersReq struct { - // Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewCancelAllStopOrdersReqBuilder() *CancelAllStopOrdersReqBuilder { return &CancelAllStopOrdersReqBuilder{obj: NewCancelAllStopOrdersReqWithDefaults()} } -// Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *CancelAllStopOrdersReqBuilder) SetSymbol(value string) *CancelAllStopOrdersReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_cancel_order_by_client_oid_req.go b/sdk/golang/pkg/generate/futures/order/types_cancel_order_by_client_oid_req.go index 05e6feb..d4496f1 100644 --- a/sdk/golang/pkg/generate/futures/order/types_cancel_order_by_client_oid_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_cancel_order_by_client_oid_req.go @@ -4,7 +4,7 @@ package order // CancelOrderByClientOidReq struct for CancelOrderByClientOidReq type CancelOrderByClientOidReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // client order id ClientOid *string `json:"clientOid,omitempty" path:"clientOid" url:"-"` @@ -39,7 +39,7 @@ func NewCancelOrderByClientOidReqBuilder() *CancelOrderByClientOidReqBuilder { return &CancelOrderByClientOidReqBuilder{obj: NewCancelOrderByClientOidReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *CancelOrderByClientOidReqBuilder) SetSymbol(value string) *CancelOrderByClientOidReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_get_open_order_value_req.go b/sdk/golang/pkg/generate/futures/order/types_get_open_order_value_req.go index e0a93ad..1445b1e 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_open_order_value_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_open_order_value_req.go @@ -4,7 +4,7 @@ package order // GetOpenOrderValueReq struct for GetOpenOrderValueReq type GetOpenOrderValueReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewGetOpenOrderValueReqBuilder() *GetOpenOrderValueReqBuilder { return &GetOpenOrderValueReqBuilder{obj: NewGetOpenOrderValueReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetOpenOrderValueReqBuilder) SetSymbol(value string) *GetOpenOrderValueReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_get_order_by_client_oid_resp.go b/sdk/golang/pkg/generate/futures/order/types_get_order_by_client_oid_resp.go index 324b7ce..6fff8a6 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_order_by_client_oid_resp.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_order_by_client_oid_resp.go @@ -12,7 +12,7 @@ type GetOrderByClientOidResp struct { CommonResponse *types.RestResponse // Order ID Id string `json:"id,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Order type, market order or limit order Type string `json:"type,omitempty"` @@ -28,7 +28,7 @@ type GetOrderByClientOidResp struct { DealValue string `json:"dealValue,omitempty"` // Executed quantity DealSize int32 `json:"dealSize,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. Stp string `json:"stp,omitempty"` // Stop order type (stop limit or stop market) Stop string `json:"stop,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/order/types_get_order_by_order_id_resp.go b/sdk/golang/pkg/generate/futures/order/types_get_order_by_order_id_resp.go index 9facea5..eeed6c4 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_order_by_order_id_resp.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_order_by_order_id_resp.go @@ -12,7 +12,7 @@ type GetOrderByOrderIdResp struct { CommonResponse *types.RestResponse // Order ID Id string `json:"id,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Order type, market order or limit order Type string `json:"type,omitempty"` @@ -28,7 +28,7 @@ type GetOrderByOrderIdResp struct { DealValue string `json:"dealValue,omitempty"` // Executed quantity DealSize int32 `json:"dealSize,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. Stp string `json:"stp,omitempty"` // Stop order type (stop limit or stop market) Stop string `json:"stop,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/order/types_get_order_list_items.go b/sdk/golang/pkg/generate/futures/order/types_get_order_list_items.go index 925d861..ce8a878 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_order_list_items.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_order_list_items.go @@ -6,7 +6,7 @@ package order type GetOrderListItems struct { // Order ID Id string `json:"id,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Order type, market order or limit order Type string `json:"type,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/order/types_get_order_list_req.go b/sdk/golang/pkg/generate/futures/order/types_get_order_list_req.go index db9f3cf..3aa4776 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_order_list_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_order_list_req.go @@ -6,7 +6,7 @@ package order type GetOrderListReq struct { // active or done, done as default. Only list orders for a specific status Status *string `json:"status,omitempty" url:"status,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // buy or sell Side *string `json:"side,omitempty" url:"side,omitempty"` @@ -63,7 +63,7 @@ func (builder *GetOrderListReqBuilder) SetStatus(value string) *GetOrderListReqB return builder } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetOrderListReqBuilder) SetSymbol(value string) *GetOrderListReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_get_recent_closed_orders_data.go b/sdk/golang/pkg/generate/futures/order/types_get_recent_closed_orders_data.go index b5b0763..57425cc 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_recent_closed_orders_data.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_recent_closed_orders_data.go @@ -6,7 +6,7 @@ package order type GetRecentClosedOrdersData struct { // Order ID Id string `json:"id,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Order type, market order or limit order Type string `json:"type,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/order/types_get_recent_closed_orders_req.go b/sdk/golang/pkg/generate/futures/order/types_get_recent_closed_orders_req.go index f53f60f..e327f9b 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_recent_closed_orders_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_recent_closed_orders_req.go @@ -4,7 +4,7 @@ package order // GetRecentClosedOrdersReq struct for GetRecentClosedOrdersReq type GetRecentClosedOrdersReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewGetRecentClosedOrdersReqBuilder() *GetRecentClosedOrdersReqBuilder { return &GetRecentClosedOrdersReqBuilder{obj: NewGetRecentClosedOrdersReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetRecentClosedOrdersReqBuilder) SetSymbol(value string) *GetRecentClosedOrdersReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_get_recent_trade_history_data.go b/sdk/golang/pkg/generate/futures/order/types_get_recent_trade_history_data.go index 1c79ed6..829486c 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_recent_trade_history_data.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_recent_trade_history_data.go @@ -4,7 +4,7 @@ package order // GetRecentTradeHistoryData struct for GetRecentTradeHistoryData type GetRecentTradeHistoryData struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Trade ID TradeId string `json:"tradeId,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/order/types_get_recent_trade_history_req.go b/sdk/golang/pkg/generate/futures/order/types_get_recent_trade_history_req.go index 1e0d67d..9e39019 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_recent_trade_history_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_recent_trade_history_req.go @@ -4,7 +4,7 @@ package order // GetRecentTradeHistoryReq struct for GetRecentTradeHistoryReq type GetRecentTradeHistoryReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewGetRecentTradeHistoryReqBuilder() *GetRecentTradeHistoryReqBuilder { return &GetRecentTradeHistoryReqBuilder{obj: NewGetRecentTradeHistoryReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetRecentTradeHistoryReqBuilder) SetSymbol(value string) *GetRecentTradeHistoryReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_get_stop_order_list_items.go b/sdk/golang/pkg/generate/futures/order/types_get_stop_order_list_items.go index 9411c11..0720b7f 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_stop_order_list_items.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_stop_order_list_items.go @@ -6,7 +6,7 @@ package order type GetStopOrderListItems struct { // Order ID Id string `json:"id,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Order type, market order or limit order Type string `json:"type,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/order/types_get_stop_order_list_req.go b/sdk/golang/pkg/generate/futures/order/types_get_stop_order_list_req.go index 0e6b995..9601bc1 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_stop_order_list_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_stop_order_list_req.go @@ -4,7 +4,7 @@ package order // GetStopOrderListReq struct for GetStopOrderListReq type GetStopOrderListReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // buy or sell Side *string `json:"side,omitempty" url:"side,omitempty"` @@ -58,7 +58,7 @@ func NewGetStopOrderListReqBuilder() *GetStopOrderListReqBuilder { return &GetStopOrderListReqBuilder{obj: NewGetStopOrderListReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetStopOrderListReqBuilder) SetSymbol(value string) *GetStopOrderListReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/order/types_get_trade_history_items.go b/sdk/golang/pkg/generate/futures/order/types_get_trade_history_items.go index 0292448..c5c1f34 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_trade_history_items.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_trade_history_items.go @@ -4,7 +4,7 @@ package order // GetTradeHistoryItems struct for GetTradeHistoryItems type GetTradeHistoryItems struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Trade ID TradeId string `json:"tradeId,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/order/types_get_trade_history_req.go b/sdk/golang/pkg/generate/futures/order/types_get_trade_history_req.go index 3c23211..6090cad 100644 --- a/sdk/golang/pkg/generate/futures/order/types_get_trade_history_req.go +++ b/sdk/golang/pkg/generate/futures/order/types_get_trade_history_req.go @@ -6,7 +6,7 @@ package order type GetTradeHistoryReq struct { // List fills for a specific order only (If you specify orderId, other parameters can be ignored) OrderId *string `json:"orderId,omitempty" url:"orderId,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // Order side Side *string `json:"side,omitempty" url:"side,omitempty"` @@ -74,7 +74,7 @@ func (builder *GetTradeHistoryReqBuilder) SetOrderId(value string) *GetTradeHist return builder } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetTradeHistoryReqBuilder) SetSymbol(value string) *GetTradeHistoryReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/api_positions.go b/sdk/golang/pkg/generate/futures/positions/api_positions.go index 8bf38d5..ec741b8 100644 --- a/sdk/golang/pkg/generate/futures/positions/api_positions.go +++ b/sdk/golang/pkg/generate/futures/positions/api_positions.go @@ -11,6 +11,7 @@ type PositionsAPI interface { // GetIsolatedMarginRiskLimit Get Isolated Margin Risk Limit // Description: This interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin). + // Documentation: https://www.kucoin.com/docs-new/api-3470263 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type PositionsAPI interface { // GetPositionsHistory Get Positions History // Description: This interface can query position history information records. + // Documentation: https://www.kucoin.com/docs-new/api-3470254 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -37,6 +39,7 @@ type PositionsAPI interface { // GetMaxWithdrawMargin Get Max Withdraw Margin // Description: This interface can query the maximum amount of margin that the current position supports withdrawal. + // Documentation: https://www.kucoin.com/docs-new/api-3470258 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -50,6 +53,7 @@ type PositionsAPI interface { // RemoveIsolatedMargin Remove Isolated Margin // Description: Remove Isolated Margin Manually. + // Documentation: https://www.kucoin.com/docs-new/api-3470256 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -63,6 +67,7 @@ type PositionsAPI interface { // GetPositionDetails Get Position Details // Description: Get the position details of a specified position. + // Documentation: https://www.kucoin.com/docs-new/api-3470252 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -76,6 +81,7 @@ type PositionsAPI interface { // ModifyAutoDepositStatus Modify Isolated Margin Auto-Deposit Status // Description: This endpoint is only applicable to isolated margin and is no longer recommended. It is recommended to use cross margin instead. + // Documentation: https://www.kucoin.com/docs-new/api-3470255 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -90,6 +96,7 @@ type PositionsAPI interface { // AddIsolatedMargin Add Isolated Margin // Description: Add Isolated Margin Manually. + // Documentation: https://www.kucoin.com/docs-new/api-3470257 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -103,6 +110,7 @@ type PositionsAPI interface { // ModifyIsolatedMarginRiskLimt Modify Isolated Margin Risk Limit // Description: This interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin). + // Documentation: https://www.kucoin.com/docs-new/api-3470264 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -116,6 +124,7 @@ type PositionsAPI interface { // GetPositionList Get Position List // Description: Get the position details of a specified position. + // Documentation: https://www.kucoin.com/docs-new/api-3470253 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -129,6 +138,7 @@ type PositionsAPI interface { // ModifyMarginLeverage Modify Cross Margin Leverage // Description: This interface can modify the current symbol’s cross-margin leverage multiple. + // Documentation: https://www.kucoin.com/docs-new/api-3470261 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -142,6 +152,7 @@ type PositionsAPI interface { // GetCrossMarginLeverage Get Cross Margin Leverage // Description: This interface can query the current symbol’s cross-margin leverage multiple. + // Documentation: https://www.kucoin.com/docs-new/api-3470260 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -155,6 +166,7 @@ type PositionsAPI interface { // GetMaxOpenSize Get Max Open Size // Description: Get Maximum Open Position Size. + // Documentation: https://www.kucoin.com/docs-new/api-3470251 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -168,6 +180,7 @@ type PositionsAPI interface { // SwitchMarginMode Switch Margin Mode // Description: This interface can modify the margin mode of the current symbol. + // Documentation: https://www.kucoin.com/docs-new/api-3470262 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -181,6 +194,7 @@ type PositionsAPI interface { // GetMarginMode Get Margin Mode // Description: This interface can query the margin mode of the current symbol. + // Documentation: https://www.kucoin.com/docs-new/api-3470259 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/futures/positions/types_add_isolated_margin_req.go b/sdk/golang/pkg/generate/futures/positions/types_add_isolated_margin_req.go index a36a175..c0d5f38 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_add_isolated_margin_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_add_isolated_margin_req.go @@ -4,7 +4,7 @@ package positions // AddIsolatedMarginReq struct for AddIsolatedMarginReq type AddIsolatedMarginReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Margin amount (min. margin amount≥0.00001667XBT） Margin float32 `json:"margin,omitempty"` @@ -45,7 +45,7 @@ func NewAddIsolatedMarginReqBuilder() *AddIsolatedMarginReqBuilder { return &AddIsolatedMarginReqBuilder{obj: NewAddIsolatedMarginReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *AddIsolatedMarginReqBuilder) SetSymbol(value string) *AddIsolatedMarginReqBuilder { builder.obj.Symbol = value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_add_isolated_margin_resp.go b/sdk/golang/pkg/generate/futures/positions/types_add_isolated_margin_resp.go index 9b12caf..af5a6ae 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_add_isolated_margin_resp.go +++ b/sdk/golang/pkg/generate/futures/positions/types_add_isolated_margin_resp.go @@ -12,7 +12,7 @@ type AddIsolatedMarginResp struct { CommonResponse *types.RestResponse // Position ID Id string `json:"id,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Auto deposit margin or not AutoDeposit bool `json:"autoDeposit,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_cross_margin_leverage_req.go b/sdk/golang/pkg/generate/futures/positions/types_get_cross_margin_leverage_req.go index bfbb154..35343e3 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_cross_margin_leverage_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_cross_margin_leverage_req.go @@ -4,7 +4,7 @@ package positions // GetCrossMarginLeverageReq struct for GetCrossMarginLeverageReq type GetCrossMarginLeverageReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewGetCrossMarginLeverageReqBuilder() *GetCrossMarginLeverageReqBuilder { return &GetCrossMarginLeverageReqBuilder{obj: NewGetCrossMarginLeverageReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetCrossMarginLeverageReqBuilder) SetSymbol(value string) *GetCrossMarginLeverageReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_cross_margin_leverage_resp.go b/sdk/golang/pkg/generate/futures/positions/types_get_cross_margin_leverage_resp.go index e5e322a..04ffb9f 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_cross_margin_leverage_resp.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_cross_margin_leverage_resp.go @@ -10,7 +10,7 @@ import ( type GetCrossMarginLeverageResp struct { // common response CommonResponse *types.RestResponse - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Leverage multiple Leverage string `json:"leverage,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_isolated_margin_risk_limit_data.go b/sdk/golang/pkg/generate/futures/positions/types_get_isolated_margin_risk_limit_data.go index c24d718..b40b702 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_isolated_margin_risk_limit_data.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_isolated_margin_risk_limit_data.go @@ -4,7 +4,7 @@ package positions // GetIsolatedMarginRiskLimitData struct for GetIsolatedMarginRiskLimitData type GetIsolatedMarginRiskLimitData struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // level Level int32 `json:"level,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_isolated_margin_risk_limit_req.go b/sdk/golang/pkg/generate/futures/positions/types_get_isolated_margin_risk_limit_req.go index 5a3e414..cc9c767 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_isolated_margin_risk_limit_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_isolated_margin_risk_limit_req.go @@ -4,7 +4,7 @@ package positions // GetIsolatedMarginRiskLimitReq struct for GetIsolatedMarginRiskLimitReq type GetIsolatedMarginRiskLimitReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" path:"symbol" url:"-"` } @@ -36,7 +36,7 @@ func NewGetIsolatedMarginRiskLimitReqBuilder() *GetIsolatedMarginRiskLimitReqBui return &GetIsolatedMarginRiskLimitReqBuilder{obj: NewGetIsolatedMarginRiskLimitReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetIsolatedMarginRiskLimitReqBuilder) SetSymbol(value string) *GetIsolatedMarginRiskLimitReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_margin_mode_req.go b/sdk/golang/pkg/generate/futures/positions/types_get_margin_mode_req.go index 74bace6..999aa62 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_margin_mode_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_margin_mode_req.go @@ -4,7 +4,7 @@ package positions // GetMarginModeReq struct for GetMarginModeReq type GetMarginModeReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewGetMarginModeReqBuilder() *GetMarginModeReqBuilder { return &GetMarginModeReqBuilder{obj: NewGetMarginModeReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetMarginModeReqBuilder) SetSymbol(value string) *GetMarginModeReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_margin_mode_resp.go b/sdk/golang/pkg/generate/futures/positions/types_get_margin_mode_resp.go index 837b7ad..37dc223 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_margin_mode_resp.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_margin_mode_resp.go @@ -10,7 +10,7 @@ import ( type GetMarginModeResp struct { // common response CommonResponse *types.RestResponse - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Margin mode: ISOLATED (isolated), CROSS (cross margin). MarginMode string `json:"marginMode,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_max_open_size_req.go b/sdk/golang/pkg/generate/futures/positions/types_get_max_open_size_req.go index f2a1256..b00abf7 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_max_open_size_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_max_open_size_req.go @@ -4,7 +4,7 @@ package positions // GetMaxOpenSizeReq struct for GetMaxOpenSizeReq type GetMaxOpenSizeReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // Order price Price *string `json:"price,omitempty" url:"price,omitempty"` @@ -42,7 +42,7 @@ func NewGetMaxOpenSizeReqBuilder() *GetMaxOpenSizeReqBuilder { return &GetMaxOpenSizeReqBuilder{obj: NewGetMaxOpenSizeReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetMaxOpenSizeReqBuilder) SetSymbol(value string) *GetMaxOpenSizeReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_max_open_size_resp.go b/sdk/golang/pkg/generate/futures/positions/types_get_max_open_size_resp.go index 76f1f28..eed8672 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_max_open_size_resp.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_max_open_size_resp.go @@ -10,7 +10,7 @@ import ( type GetMaxOpenSizeResp struct { // common response CommonResponse *types.RestResponse - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Maximum buy size MaxBuyOpenSize int32 `json:"maxBuyOpenSize,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_max_withdraw_margin_req.go b/sdk/golang/pkg/generate/futures/positions/types_get_max_withdraw_margin_req.go index e60f94a..8ce7697 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_max_withdraw_margin_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_max_withdraw_margin_req.go @@ -4,7 +4,7 @@ package positions // GetMaxWithdrawMarginReq struct for GetMaxWithdrawMarginReq type GetMaxWithdrawMarginReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewGetMaxWithdrawMarginReqBuilder() *GetMaxWithdrawMarginReqBuilder { return &GetMaxWithdrawMarginReqBuilder{obj: NewGetMaxWithdrawMarginReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetMaxWithdrawMarginReqBuilder) SetSymbol(value string) *GetMaxWithdrawMarginReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_position_details_req.go b/sdk/golang/pkg/generate/futures/positions/types_get_position_details_req.go index 636241d..b0b149e 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_position_details_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_position_details_req.go @@ -4,7 +4,7 @@ package positions // GetPositionDetailsReq struct for GetPositionDetailsReq type GetPositionDetailsReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` } @@ -36,7 +36,7 @@ func NewGetPositionDetailsReqBuilder() *GetPositionDetailsReqBuilder { return &GetPositionDetailsReqBuilder{obj: NewGetPositionDetailsReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetPositionDetailsReqBuilder) SetSymbol(value string) *GetPositionDetailsReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_position_details_resp.go b/sdk/golang/pkg/generate/futures/positions/types_get_position_details_resp.go index 6b97a63..d9eafcb 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_position_details_resp.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_position_details_resp.go @@ -12,7 +12,7 @@ type GetPositionDetailsResp struct { CommonResponse *types.RestResponse // Position ID Id string `json:"id,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Whether it is cross margin. CrossMode bool `json:"crossMode,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_position_list_data.go b/sdk/golang/pkg/generate/futures/positions/types_get_position_list_data.go index 9fd5ef7..2d7a3cc 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_position_list_data.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_position_list_data.go @@ -6,7 +6,7 @@ package positions type GetPositionListData struct { // Position ID Id string `json:"id,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Whether it is cross margin. CrossMode bool `json:"crossMode,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_position_list_req.go b/sdk/golang/pkg/generate/futures/positions/types_get_position_list_req.go index bcc95af..69d261d 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_position_list_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_position_list_req.go @@ -4,7 +4,7 @@ package positions // GetPositionListReq struct for GetPositionListReq type GetPositionListReq struct { - // Currency code, Please refer to [rootSymbol](apidog://link/endpoint/221752070) , such as USDT,XBT. Query all positions when empty + // Currency code, Please refer to [rootSymbol](https://www.kucoin.com/docs-new/api-221752070) , such as USDT,XBT. Query all positions when empty Currency *string `json:"currency,omitempty" url:"currency,omitempty"` } @@ -36,7 +36,7 @@ func NewGetPositionListReqBuilder() *GetPositionListReqBuilder { return &GetPositionListReqBuilder{obj: NewGetPositionListReqWithDefaults()} } -// Currency code, Please refer to [rootSymbol](apidog://link/endpoint/221752070) , such as USDT,XBT. Query all positions when empty +// Currency code, Please refer to [rootSymbol](https://www.kucoin.com/docs-new/api-221752070) , such as USDT,XBT. Query all positions when empty func (builder *GetPositionListReqBuilder) SetCurrency(value string) *GetPositionListReqBuilder { builder.obj.Currency = &value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_positions_history_items.go b/sdk/golang/pkg/generate/futures/positions/types_get_positions_history_items.go index 0c3f765..e583bf0 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_positions_history_items.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_positions_history_items.go @@ -8,7 +8,7 @@ type GetPositionsHistoryItems struct { CloseId string `json:"closeId,omitempty"` // User ID UserId string `json:"userId,omitempty"` - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Currency used to settle trades SettleCurrency string `json:"settleCurrency,omitempty"` diff --git a/sdk/golang/pkg/generate/futures/positions/types_get_positions_history_req.go b/sdk/golang/pkg/generate/futures/positions/types_get_positions_history_req.go index abe1d90..af99563 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_get_positions_history_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_get_positions_history_req.go @@ -4,7 +4,7 @@ package positions // GetPositionsHistoryReq struct for GetPositionsHistoryReq type GetPositionsHistoryReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol *string `json:"symbol,omitempty" url:"symbol,omitempty"` // Closing start time(ms) From *int64 `json:"from,omitempty" url:"from,omitempty"` @@ -56,7 +56,7 @@ func NewGetPositionsHistoryReqBuilder() *GetPositionsHistoryReqBuilder { return &GetPositionsHistoryReqBuilder{obj: NewGetPositionsHistoryReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *GetPositionsHistoryReqBuilder) SetSymbol(value string) *GetPositionsHistoryReqBuilder { builder.obj.Symbol = &value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_modify_isolated_margin_risk_limt_req.go b/sdk/golang/pkg/generate/futures/positions/types_modify_isolated_margin_risk_limt_req.go index 9575a8d..e3c2010 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_modify_isolated_margin_risk_limt_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_modify_isolated_margin_risk_limt_req.go @@ -4,7 +4,7 @@ package positions // ModifyIsolatedMarginRiskLimtReq struct for ModifyIsolatedMarginRiskLimtReq type ModifyIsolatedMarginRiskLimtReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // level Level int32 `json:"level,omitempty"` @@ -41,7 +41,7 @@ func NewModifyIsolatedMarginRiskLimtReqBuilder() *ModifyIsolatedMarginRiskLimtRe return &ModifyIsolatedMarginRiskLimtReqBuilder{obj: NewModifyIsolatedMarginRiskLimtReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *ModifyIsolatedMarginRiskLimtReqBuilder) SetSymbol(value string) *ModifyIsolatedMarginRiskLimtReqBuilder { builder.obj.Symbol = value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_modify_margin_leverage_req.go b/sdk/golang/pkg/generate/futures/positions/types_modify_margin_leverage_req.go index 7f9ee4f..9767918 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_modify_margin_leverage_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_modify_margin_leverage_req.go @@ -4,7 +4,7 @@ package positions // ModifyMarginLeverageReq struct for ModifyMarginLeverageReq type ModifyMarginLeverageReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Leverage multiple Leverage string `json:"leverage,omitempty"` @@ -41,7 +41,7 @@ func NewModifyMarginLeverageReqBuilder() *ModifyMarginLeverageReqBuilder { return &ModifyMarginLeverageReqBuilder{obj: NewModifyMarginLeverageReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *ModifyMarginLeverageReqBuilder) SetSymbol(value string) *ModifyMarginLeverageReqBuilder { builder.obj.Symbol = value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_remove_isolated_margin_req.go b/sdk/golang/pkg/generate/futures/positions/types_remove_isolated_margin_req.go index b7406bc..da91996 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_remove_isolated_margin_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_remove_isolated_margin_req.go @@ -4,7 +4,7 @@ package positions // RemoveIsolatedMarginReq struct for RemoveIsolatedMarginReq type RemoveIsolatedMarginReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // The size of the position that can be deposited. If it is USDT-margin, it represents the amount of USDT. If it is coin-margin, this value represents the number of coins WithdrawAmount string `json:"withdrawAmount,omitempty"` @@ -41,7 +41,7 @@ func NewRemoveIsolatedMarginReqBuilder() *RemoveIsolatedMarginReqBuilder { return &RemoveIsolatedMarginReqBuilder{obj: NewRemoveIsolatedMarginReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *RemoveIsolatedMarginReqBuilder) SetSymbol(value string) *RemoveIsolatedMarginReqBuilder { builder.obj.Symbol = value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_switch_margin_mode_req.go b/sdk/golang/pkg/generate/futures/positions/types_switch_margin_mode_req.go index 9ff4406..971de61 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_switch_margin_mode_req.go +++ b/sdk/golang/pkg/generate/futures/positions/types_switch_margin_mode_req.go @@ -4,7 +4,7 @@ package positions // SwitchMarginModeReq struct for SwitchMarginModeReq type SwitchMarginModeReq struct { - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Modified margin model: ISOLATED (isolated), CROSS (cross margin). MarginMode string `json:"marginMode,omitempty"` @@ -41,7 +41,7 @@ func NewSwitchMarginModeReqBuilder() *SwitchMarginModeReqBuilder { return &SwitchMarginModeReqBuilder{obj: NewSwitchMarginModeReqWithDefaults()} } -// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) +// Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) func (builder *SwitchMarginModeReqBuilder) SetSymbol(value string) *SwitchMarginModeReqBuilder { builder.obj.Symbol = value return builder diff --git a/sdk/golang/pkg/generate/futures/positions/types_switch_margin_mode_resp.go b/sdk/golang/pkg/generate/futures/positions/types_switch_margin_mode_resp.go index c4a65ab..2e6d5f7 100644 --- a/sdk/golang/pkg/generate/futures/positions/types_switch_margin_mode_resp.go +++ b/sdk/golang/pkg/generate/futures/positions/types_switch_margin_mode_resp.go @@ -10,7 +10,7 @@ import ( type SwitchMarginModeResp struct { // common response CommonResponse *types.RestResponse - // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + // Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) Symbol string `json:"symbol,omitempty"` // Margin mode: ISOLATED (isolated), CROSS (cross margin). MarginMode string `json:"marginMode,omitempty"` diff --git a/sdk/golang/pkg/generate/margin/credit/api_credit.go b/sdk/golang/pkg/generate/margin/credit/api_credit.go index e67bf17..b3192b1 100644 --- a/sdk/golang/pkg/generate/margin/credit/api_credit.go +++ b/sdk/golang/pkg/generate/margin/credit/api_credit.go @@ -11,6 +11,7 @@ type CreditAPI interface { // ModifyPurchase Modify Purchase // Description: This API endpoint is used to update the interest rates of subscription orders, which will take effect at the beginning of the next hour.,Please ensure that the funds are in the main(funding) account + // Documentation: https://www.kucoin.com/docs-new/api-3470217 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type CreditAPI interface { // GetLoanMarket Get Loan Market // Description: This API endpoint is used to get the information about the currencies available for lending. + // Documentation: https://www.kucoin.com/docs-new/api-3470212 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -37,6 +39,7 @@ type CreditAPI interface { // GetLoanMarketInterestRate Get Loan Market Interest Rate // Description: This API endpoint is used to get the interest rates of the margin lending market over the past 7 days. + // Documentation: https://www.kucoin.com/docs-new/api-3470215 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -50,6 +53,7 @@ type CreditAPI interface { // GetPurchaseOrders Get Purchase Orders // Description: This API endpoint provides pagination query for the purchase orders. + // Documentation: https://www.kucoin.com/docs-new/api-3470213 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -63,6 +67,7 @@ type CreditAPI interface { // Purchase Purchase // Description: Invest credit in the market and earn interest + // Documentation: https://www.kucoin.com/docs-new/api-3470216 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -76,6 +81,7 @@ type CreditAPI interface { // GetRedeemOrders Get Redeem Orders // Description: This API endpoint provides pagination query for the redeem orders. + // Documentation: https://www.kucoin.com/docs-new/api-3470214 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -89,6 +95,7 @@ type CreditAPI interface { // Redeem Redeem // Description: Redeem your loan order + // Documentation: https://www.kucoin.com/docs-new/api-3470218 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/margin/debit/api_debit.go b/sdk/golang/pkg/generate/margin/debit/api_debit.go index 1d95e73..e2ea02a 100644 --- a/sdk/golang/pkg/generate/margin/debit/api_debit.go +++ b/sdk/golang/pkg/generate/margin/debit/api_debit.go @@ -11,6 +11,7 @@ type DebitAPI interface { // GetBorrowHistory Get Borrow History // Description: This API endpoint is used to get the borrowing orders for cross and isolated margin accounts + // Documentation: https://www.kucoin.com/docs-new/api-3470207 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type DebitAPI interface { // Borrow Borrow // Description: This API endpoint is used to initiate an application for cross or isolated margin borrowing. + // Documentation: https://www.kucoin.com/docs-new/api-3470206 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -37,6 +39,7 @@ type DebitAPI interface { // GetInterestHistory Get Interest History // Description: Request via this endpoint to get the interest records of the cross/isolated margin lending. + // Documentation: https://www.kucoin.com/docs-new/api-3470209 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -50,6 +53,7 @@ type DebitAPI interface { // GetRepayHistory Get Repay History // Description: This API endpoint is used to get the borrowing orders for cross and isolated margin accounts + // Documentation: https://www.kucoin.com/docs-new/api-3470208 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -63,6 +67,7 @@ type DebitAPI interface { // Repay Repay // Description: This API endpoint is used to initiate an application for cross or isolated margin repayment. + // Documentation: https://www.kucoin.com/docs-new/api-3470210 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -76,6 +81,7 @@ type DebitAPI interface { // ModifyLeverage Modify Leverage // Description: This endpoint allows modifying the leverage multiplier for cross margin or isolated margin. + // Documentation: https://www.kucoin.com/docs-new/api-3470211 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/margin/market/api_market.go b/sdk/golang/pkg/generate/margin/market/api_market.go index 43e5800..ae29f7d 100644 --- a/sdk/golang/pkg/generate/margin/market/api_market.go +++ b/sdk/golang/pkg/generate/margin/market/api_market.go @@ -11,6 +11,7 @@ type MarketAPI interface { // GetIsolatedMarginSymbols Get Symbols - Isolated Margin // Description: This endpoint allows querying the configuration of isolated margin symbol. + // Documentation: https://www.kucoin.com/docs-new/api-3470194 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -24,6 +25,7 @@ type MarketAPI interface { // GetMarginConfig Get Margin Config // Description: Request via this endpoint to get the configure info of the cross margin. + // Documentation: https://www.kucoin.com/docs-new/api-3470190 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -37,6 +39,7 @@ type MarketAPI interface { // GetMarkPriceDetail Get Mark Price Detail // Description: This endpoint returns the current Mark price for specified margin trading pairs. + // Documentation: https://www.kucoin.com/docs-new/api-3470193 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -50,6 +53,7 @@ type MarketAPI interface { // GetETFInfo Get ETF Info // Description: This interface returns leveraged token information + // Documentation: https://www.kucoin.com/docs-new/api-3470191 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -63,6 +67,7 @@ type MarketAPI interface { // GetCrossMarginSymbols Get Symbols - Cross Margin // Description: This endpoint allows querying the configuration of cross margin symbol. + // Documentation: https://www.kucoin.com/docs-new/api-3470189 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -76,6 +81,7 @@ type MarketAPI interface { // GetMarkPriceList Get Mark Price List // Description: This endpoint returns the current Mark price for all margin trading pairs. + // Documentation: https://www.kucoin.com/docs-new/api-3470192 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ diff --git a/sdk/golang/pkg/generate/margin/order/api_order.go b/sdk/golang/pkg/generate/margin/order/api_order.go index 434fc65..3176b36 100644 --- a/sdk/golang/pkg/generate/margin/order/api_order.go +++ b/sdk/golang/pkg/generate/margin/order/api_order.go @@ -11,6 +11,7 @@ type OrderAPI interface { // AddOrderV1 Add Order - V1 // Description: Place order to the Cross-margin or Isolated-margin trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + // Documentation: https://www.kucoin.com/docs-new/api-3470312 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -25,6 +26,7 @@ type OrderAPI interface { // AddOrderTestV1 Add Order Test - V1 // Description: Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried. + // Documentation: https://www.kucoin.com/docs-new/api-3470313 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -39,6 +41,7 @@ type OrderAPI interface { // GetTradeHistory Get Trade History // Description: This endpoint can be used to obtain a list of the latest Margin transaction details. The returned data is sorted in descending order according to the latest update time of the order. + // Documentation: https://www.kucoin.com/docs-new/api-3470200 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -52,6 +55,7 @@ type OrderAPI interface { // GetSymbolsWithOpenOrder Get Symbols With Open Order // Description: This interface can query all Margin symbol that has active orders + // Documentation: https://www.kucoin.com/docs-new/api-3470196 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -65,6 +69,7 @@ type OrderAPI interface { // AddOrder Add Order // Description: Place order to the Cross-margin or Isolated-margin trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + // Documentation: https://www.kucoin.com/docs-new/api-3470204 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -78,6 +83,7 @@ type OrderAPI interface { // AddOrderTest Add Order Test // Description: Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried. + // Documentation: https://www.kucoin.com/docs-new/api-3470205 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -91,6 +97,7 @@ type OrderAPI interface { // GetOpenOrders Get Open Orders // Description: This interface is to obtain all Margin active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + // Documentation: https://www.kucoin.com/docs-new/api-3470198 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -104,6 +111,7 @@ type OrderAPI interface { // CancelOrderByClientOid Cancel Order By ClientOid // Description: This endpoint can be used to cancel a margin order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470201 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -117,6 +125,7 @@ type OrderAPI interface { // GetOrderByClientOid Get Order By ClientOid // Description: This endpoint can be used to obtain information for a single Margin order using the client order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + // Documentation: https://www.kucoin.com/docs-new/api-3470203 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -130,6 +139,7 @@ type OrderAPI interface { // CancelAllOrdersBySymbol Cancel All Orders By Symbol // Description: This interface can cancel all open Margin orders by symbol This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470197 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -143,6 +153,7 @@ type OrderAPI interface { // GetClosedOrders Get Closed Orders // Description: This interface is to obtain all Margin closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + // Documentation: https://www.kucoin.com/docs-new/api-3470199 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -156,6 +167,7 @@ type OrderAPI interface { // CancelOrderByOrderId Cancel Order By OrderId // Description: This endpoint can be used to cancel a margin order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470195 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -169,6 +181,7 @@ type OrderAPI interface { // GetOrderByOrderId Get Order By OrderId // Description: This endpoint can be used to obtain information for a single Margin order using the order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + // Documentation: https://www.kucoin.com/docs-new/api-3470202 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/margin/order/types_add_order_req.go b/sdk/golang/pkg/generate/margin/order/types_add_order_req.go index c1dc180..02193b0 100644 --- a/sdk/golang/pkg/generate/margin/order/types_add_order_req.go +++ b/sdk/golang/pkg/generate/margin/order/types_add_order_req.go @@ -12,19 +12,19 @@ type AddOrderReq struct { Symbol string `json:"symbol,omitempty"` // specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. Type *string `json:"type,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price *string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Time in force](doc://link/pages/5176570) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` - // [Hidden order](doc://link/pages/338146) or not (not shown in order book) + // [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) Hidden *bool `json:"hidden,omitempty"` - // Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + // Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) Iceberg *bool `json:"iceberg,omitempty"` // Maximum visible quantity in iceberg orders VisibleSize *string `json:"visibleSize,omitempty"` @@ -143,7 +143,7 @@ func (builder *AddOrderReqBuilder) SetType(value string) *AddOrderReqBuilder { return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC func (builder *AddOrderReqBuilder) SetStp(value string) *AddOrderReqBuilder { builder.obj.Stp = &value return builder @@ -161,7 +161,7 @@ func (builder *AddOrderReqBuilder) SetSize(value string) *AddOrderReqBuilder { return builder } -// [Time in force](doc://link/pages/5176570) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading func (builder *AddOrderReqBuilder) SetTimeInForce(value string) *AddOrderReqBuilder { builder.obj.TimeInForce = &value return builder @@ -173,13 +173,13 @@ func (builder *AddOrderReqBuilder) SetPostOnly(value bool) *AddOrderReqBuilder { return builder } -// [Hidden order](doc://link/pages/338146) or not (not shown in order book) +// [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) func (builder *AddOrderReqBuilder) SetHidden(value bool) *AddOrderReqBuilder { builder.obj.Hidden = &value return builder } -// Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) +// Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) func (builder *AddOrderReqBuilder) SetIceberg(value bool) *AddOrderReqBuilder { builder.obj.Iceberg = &value return builder diff --git a/sdk/golang/pkg/generate/margin/order/types_add_order_test_req.go b/sdk/golang/pkg/generate/margin/order/types_add_order_test_req.go index baf2018..c00777a 100644 --- a/sdk/golang/pkg/generate/margin/order/types_add_order_test_req.go +++ b/sdk/golang/pkg/generate/margin/order/types_add_order_test_req.go @@ -12,19 +12,19 @@ type AddOrderTestReq struct { Symbol string `json:"symbol,omitempty"` // specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. Type *string `json:"type,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price *string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Time in force](doc://link/pages/5176570) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` - // [Hidden order](doc://link/pages/338146) or not (not shown in order book) + // [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) Hidden *bool `json:"hidden,omitempty"` - // Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + // Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) Iceberg *bool `json:"iceberg,omitempty"` // Maximum visible quantity in iceberg orders VisibleSize *string `json:"visibleSize,omitempty"` @@ -143,7 +143,7 @@ func (builder *AddOrderTestReqBuilder) SetType(value string) *AddOrderTestReqBui return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC func (builder *AddOrderTestReqBuilder) SetStp(value string) *AddOrderTestReqBuilder { builder.obj.Stp = &value return builder @@ -161,7 +161,7 @@ func (builder *AddOrderTestReqBuilder) SetSize(value string) *AddOrderTestReqBui return builder } -// [Time in force](doc://link/pages/5176570) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading func (builder *AddOrderTestReqBuilder) SetTimeInForce(value string) *AddOrderTestReqBuilder { builder.obj.TimeInForce = &value return builder @@ -173,13 +173,13 @@ func (builder *AddOrderTestReqBuilder) SetPostOnly(value bool) *AddOrderTestReqB return builder } -// [Hidden order](doc://link/pages/338146) or not (not shown in order book) +// [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) func (builder *AddOrderTestReqBuilder) SetHidden(value bool) *AddOrderTestReqBuilder { builder.obj.Hidden = &value return builder } -// Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) +// Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) func (builder *AddOrderTestReqBuilder) SetIceberg(value bool) *AddOrderTestReqBuilder { builder.obj.Iceberg = &value return builder diff --git a/sdk/golang/pkg/generate/margin/order/types_add_order_test_v1_req.go b/sdk/golang/pkg/generate/margin/order/types_add_order_test_v1_req.go index 774125d..d19029b 100644 --- a/sdk/golang/pkg/generate/margin/order/types_add_order_test_v1_req.go +++ b/sdk/golang/pkg/generate/margin/order/types_add_order_test_v1_req.go @@ -12,13 +12,13 @@ type AddOrderTestV1Req struct { Symbol string `json:"symbol,omitempty"` // specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. Type *string `json:"type,omitempty"` - // [Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price *string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Time in force](doc://link/pages/5176570) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` @@ -143,7 +143,7 @@ func (builder *AddOrderTestV1ReqBuilder) SetType(value string) *AddOrderTestV1Re return builder } -// [Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) is divided into four strategies: CN, CO, CB , and DC func (builder *AddOrderTestV1ReqBuilder) SetStp(value string) *AddOrderTestV1ReqBuilder { builder.obj.Stp = &value return builder @@ -161,7 +161,7 @@ func (builder *AddOrderTestV1ReqBuilder) SetSize(value string) *AddOrderTestV1Re return builder } -// [Time in force](doc://link/pages/5176570) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading func (builder *AddOrderTestV1ReqBuilder) SetTimeInForce(value string) *AddOrderTestV1ReqBuilder { builder.obj.TimeInForce = &value return builder diff --git a/sdk/golang/pkg/generate/margin/order/types_add_order_v1_req.go b/sdk/golang/pkg/generate/margin/order/types_add_order_v1_req.go index 0fefd25..63f7a4a 100644 --- a/sdk/golang/pkg/generate/margin/order/types_add_order_v1_req.go +++ b/sdk/golang/pkg/generate/margin/order/types_add_order_v1_req.go @@ -12,13 +12,13 @@ type AddOrderV1Req struct { Symbol string `json:"symbol,omitempty"` // specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. Type *string `json:"type,omitempty"` - // [Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price *string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Time in force](doc://link/pages/5176570) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` @@ -143,7 +143,7 @@ func (builder *AddOrderV1ReqBuilder) SetType(value string) *AddOrderV1ReqBuilder return builder } -// [Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC func (builder *AddOrderV1ReqBuilder) SetStp(value string) *AddOrderV1ReqBuilder { builder.obj.Stp = &value return builder @@ -161,7 +161,7 @@ func (builder *AddOrderV1ReqBuilder) SetSize(value string) *AddOrderV1ReqBuilder return builder } -// [Time in force](doc://link/pages/5176570) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading func (builder *AddOrderV1ReqBuilder) SetTimeInForce(value string) *AddOrderV1ReqBuilder { builder.obj.TimeInForce = &value return builder diff --git a/sdk/golang/pkg/generate/margin/order/types_get_closed_orders_items.go b/sdk/golang/pkg/generate/margin/order/types_get_closed_orders_items.go index 74ee4fb..aa346f4 100644 --- a/sdk/golang/pkg/generate/margin/order/types_get_closed_orders_items.go +++ b/sdk/golang/pkg/generate/margin/order/types_get_closed_orders_items.go @@ -23,11 +23,11 @@ type GetClosedOrdersItems struct { DealSize string `json:"dealSize,omitempty"` // Funds of filled transactions DealFunds string `json:"dealFunds,omitempty"` - // [Handling fees](doc://link/pages/5327739) + // [Handling fees](https://www.kucoin.com/docs-new/api-5327739) Fee string `json:"fee,omitempty"` // currency used to calculate trading fee FeeCurrency string `json:"feeCurrency,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` Stop *string `json:"stop,omitempty"` StopTriggered bool `json:"stopTriggered,omitempty"` diff --git a/sdk/golang/pkg/generate/margin/order/types_get_open_orders_data.go b/sdk/golang/pkg/generate/margin/order/types_get_open_orders_data.go index 1754f47..2102679 100644 --- a/sdk/golang/pkg/generate/margin/order/types_get_open_orders_data.go +++ b/sdk/golang/pkg/generate/margin/order/types_get_open_orders_data.go @@ -27,7 +27,7 @@ type GetOpenOrdersData struct { Fee string `json:"fee,omitempty"` // currency used to calculate trading fee FeeCurrency string `json:"feeCurrency,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` Stop *string `json:"stop,omitempty"` StopTriggered bool `json:"stopTriggered,omitempty"` diff --git a/sdk/golang/pkg/generate/margin/order/types_get_order_by_client_oid_resp.go b/sdk/golang/pkg/generate/margin/order/types_get_order_by_client_oid_resp.go index 7586f9f..ecbc571 100644 --- a/sdk/golang/pkg/generate/margin/order/types_get_order_by_client_oid_resp.go +++ b/sdk/golang/pkg/generate/margin/order/types_get_order_by_client_oid_resp.go @@ -29,11 +29,11 @@ type GetOrderByClientOidResp struct { DealSize string `json:"dealSize,omitempty"` // Funds of filled transactions DealFunds string `json:"dealFunds,omitempty"` - // [Handling fees](doc://link/pages/5327739) + // [Handling fees](https://www.kucoin.com/docs-new/api-5327739) Fee string `json:"fee,omitempty"` // currency used to calculate trading fee FeeCurrency string `json:"feeCurrency,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` Stop *string `json:"stop,omitempty"` StopTriggered bool `json:"stopTriggered,omitempty"` diff --git a/sdk/golang/pkg/generate/margin/order/types_get_order_by_order_id_resp.go b/sdk/golang/pkg/generate/margin/order/types_get_order_by_order_id_resp.go index 71ddc43..97bec08 100644 --- a/sdk/golang/pkg/generate/margin/order/types_get_order_by_order_id_resp.go +++ b/sdk/golang/pkg/generate/margin/order/types_get_order_by_order_id_resp.go @@ -29,11 +29,11 @@ type GetOrderByOrderIdResp struct { DealSize string `json:"dealSize,omitempty"` // Funds of filled transactions DealFunds string `json:"dealFunds,omitempty"` - // [Handling fees](doc://link/pages/5327739) + // [Handling fees](https://www.kucoin.com/docs-new/api-5327739) Fee string `json:"fee,omitempty"` // currency used to calculate trading fee FeeCurrency string `json:"feeCurrency,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` Stop *string `json:"stop,omitempty"` StopTriggered bool `json:"stopTriggered,omitempty"` diff --git a/sdk/golang/pkg/generate/margin/order/types_get_trade_history_items.go b/sdk/golang/pkg/generate/margin/order/types_get_trade_history_items.go index 164edbe..70484ac 100644 --- a/sdk/golang/pkg/generate/margin/order/types_get_trade_history_items.go +++ b/sdk/golang/pkg/generate/margin/order/types_get_trade_history_items.go @@ -25,7 +25,7 @@ type GetTradeHistoryItems struct { Size string `json:"size,omitempty"` // Order Funds Funds string `json:"funds,omitempty"` - // [Handling fees](doc://link/pages/5327739) + // [Handling fees](https://www.kucoin.com/docs-new/api-5327739) Fee string `json:"fee,omitempty"` // Fee rate FeeRate string `json:"feeRate,omitempty"` diff --git a/sdk/golang/pkg/generate/margin/risklimit/api_risk_limit.go b/sdk/golang/pkg/generate/margin/risklimit/api_risk_limit.go index 601aa82..ad02461 100644 --- a/sdk/golang/pkg/generate/margin/risklimit/api_risk_limit.go +++ b/sdk/golang/pkg/generate/margin/risklimit/api_risk_limit.go @@ -11,6 +11,7 @@ type RiskLimitAPI interface { // GetMarginRiskLimit Get Margin Risk Limit // Description: Request via this endpoint to get the Configure and Risk limit info of the margin. + // Documentation: https://www.kucoin.com/docs-new/api-3470219 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/spot/market/api_market.go b/sdk/golang/pkg/generate/spot/market/api_market.go index 80607cd..49e9597 100644 --- a/sdk/golang/pkg/generate/spot/market/api_market.go +++ b/sdk/golang/pkg/generate/spot/market/api_market.go @@ -11,6 +11,7 @@ type MarketAPI interface { // GetPrivateToken Get Private Token - Spot/Margin // Description: This interface can obtain the token required for websocket to establish a Spot/Margin private connection. If you need use private channels(e.g. account balance notice), please make request as follows to obtain the server list and private token + // Documentation: https://www.kucoin.com/docs-new/api-3470295 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -24,6 +25,7 @@ type MarketAPI interface { // GetPublicToken Get Public Token - Spot/Margin // Description: This interface can obtain the token required for websocket to establish a Spot/Margin connection. If you need use public channels (e.g. all public market data), please make request as follows to obtain the server list and public token + // Documentation: https://www.kucoin.com/docs-new/api-3470294 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -37,6 +39,7 @@ type MarketAPI interface { // GetAllTickers Get All Tickers // Description: Request market tickers for all the trading pairs in the market (including 24h volume), takes a snapshot every 2 seconds. On the rare occasion that we will change the currency name, if you still want the changed symbol name, you can use the symbolName field instead of the symbol field via “Get all tickers” endpoint. + // Documentation: https://www.kucoin.com/docs-new/api-3470167 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -50,6 +53,7 @@ type MarketAPI interface { // GetKlines Get Klines // Description: Get the Kline of the symbol. Data are returned in grouped buckets based on requested type. For each query, the system would return at most 1500 pieces of data. To obtain more data, please page the data by time. + // Documentation: https://www.kucoin.com/docs-new/api-3470163 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -63,6 +67,7 @@ type MarketAPI interface { // GetTradeHistory Get Trade History // Description: Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records. + // Documentation: https://www.kucoin.com/docs-new/api-3470162 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -76,6 +81,7 @@ type MarketAPI interface { // GetTicker Get Ticker // Description: Request via this endpoint to get Level 1 Market Data. The returned value includes the best bid price and size, the best ask price and size as well as the last traded price and the last traded size. + // Documentation: https://www.kucoin.com/docs-new/api-3470160 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -89,6 +95,7 @@ type MarketAPI interface { // GetPartOrderBook Get Part OrderBook // Description: Query for part orderbook depth data. (aggregated by price) You are recommended to request via this endpoint as the system reponse would be faster and cosume less traffic. + // Documentation: https://www.kucoin.com/docs-new/api-3470165 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -102,6 +109,7 @@ type MarketAPI interface { // Get24hrStats Get 24hr Stats // Description: Request via this endpoint to get the statistics of the specified ticker in the last 24 hours. + // Documentation: https://www.kucoin.com/docs-new/api-3470161 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -115,6 +123,7 @@ type MarketAPI interface { // GetMarketList Get Market List // Description: Request via this endpoint to get the transaction currency for the entire trading market. + // Documentation: https://www.kucoin.com/docs-new/api-3470166 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -128,6 +137,7 @@ type MarketAPI interface { // GetFiatPrice Get Fiat Price // Description: Request via this endpoint to get the fiat price of the currencies for the available trading pairs. + // Documentation: https://www.kucoin.com/docs-new/api-3470153 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -141,6 +151,7 @@ type MarketAPI interface { // GetServiceStatus Get Service Status // Description: Get the service status + // Documentation: https://www.kucoin.com/docs-new/api-3470158 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -154,6 +165,7 @@ type MarketAPI interface { // GetServerTime Get Server Time // Description: Get the server time. + // Documentation: https://www.kucoin.com/docs-new/api-3470156 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -167,6 +179,7 @@ type MarketAPI interface { // GetAllSymbols Get All Symbols // Description: Request via this endpoint to get a list of available currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers. + // Documentation: https://www.kucoin.com/docs-new/api-3470154 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -180,6 +193,7 @@ type MarketAPI interface { // GetSymbol Get Symbol // Description: Request via this endpoint to get detail currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers. + // Documentation: https://www.kucoin.com/docs-new/api-3470159 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -193,6 +207,7 @@ type MarketAPI interface { // GetAnnouncements Get Announcements // Description: This interface can obtain the latest news announcements, and the default page search is for announcements within a month. + // Documentation: https://www.kucoin.com/docs-new/api-3470157 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -206,6 +221,7 @@ type MarketAPI interface { // GetCurrency Get Currency // Description: Request via this endpoint to get the currency details of a specified currency + // Documentation: https://www.kucoin.com/docs-new/api-3470155 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -219,6 +235,7 @@ type MarketAPI interface { // GetAllCurrencies Get All Currencies // Description: Request via this endpoint to get the currency list.Not all currencies currently can be used for trading. + // Documentation: https://www.kucoin.com/docs-new/api-3470152 // +---------------------+--------+ // | Extra API Info | Value | // +---------------------+--------+ @@ -232,6 +249,7 @@ type MarketAPI interface { // GetFullOrderBook Get Full OrderBook // Description: Query for Full orderbook depth data. (aggregated by price) It is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control. To maintain up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook. + // Documentation: https://www.kucoin.com/docs-new/api-3470164 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/spot/market/types_get_all_symbols_req.go b/sdk/golang/pkg/generate/spot/market/types_get_all_symbols_req.go index 88a75d8..20226e5 100644 --- a/sdk/golang/pkg/generate/spot/market/types_get_all_symbols_req.go +++ b/sdk/golang/pkg/generate/spot/market/types_get_all_symbols_req.go @@ -4,7 +4,7 @@ package market // GetAllSymbolsReq struct for GetAllSymbolsReq type GetAllSymbolsReq struct { - // [The trading market](apidog://link/endpoint/222921786) + // [The trading market](https://www.kucoin.com/docs-new/api-222921786) Market *string `json:"market,omitempty" url:"market,omitempty"` } @@ -36,7 +36,7 @@ func NewGetAllSymbolsReqBuilder() *GetAllSymbolsReqBuilder { return &GetAllSymbolsReqBuilder{obj: NewGetAllSymbolsReqWithDefaults()} } -// [The trading market](apidog://link/endpoint/222921786) +// [The trading market](https://www.kucoin.com/docs-new/api-222921786) func (builder *GetAllSymbolsReqBuilder) SetMarket(value string) *GetAllSymbolsReqBuilder { builder.obj.Market = &value return builder diff --git a/sdk/golang/pkg/generate/spot/order/api_order.go b/sdk/golang/pkg/generate/spot/order/api_order.go index d3f6423..24413d2 100644 --- a/sdk/golang/pkg/generate/spot/order/api_order.go +++ b/sdk/golang/pkg/generate/spot/order/api_order.go @@ -11,6 +11,7 @@ type OrderAPI interface { // GetTradeHistoryOld Get Trade History - Old // Description: Request via this endpoint to get the recent fills. The return value is the data after Pagination, sorted in descending order according to time. + // Documentation: https://www.kucoin.com/docs-new/api-3470350 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -25,6 +26,7 @@ type OrderAPI interface { // GetTradeHistory Get Trade History // Description: This endpoint can be used to obtain a list of the latest Spot transaction details. The returned data is sorted in descending order according to the latest update time of the order. + // Documentation: https://www.kucoin.com/docs-new/api-3470180 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -38,6 +40,7 @@ type OrderAPI interface { // GetOpenOrders Get Open Orders // Description: This interface is to obtain all Spot active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + // Documentation: https://www.kucoin.com/docs-new/api-3470178 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -51,6 +54,7 @@ type OrderAPI interface { // GetSymbolsWithOpenOrder Get Symbols With Open Order // Description: This interface can query all spot symbol that has active orders + // Documentation: https://www.kucoin.com/docs-new/api-3470177 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -64,6 +68,7 @@ type OrderAPI interface { // ModifyOrder Modify Order // Description: This interface can modify the price and quantity of the order according to orderId or clientOid. The implementation of this interface is: cancel the order and place a new order on the same trading pair, and return the modification result to the client synchronously When the quantity of the new order updated by the user is less than the filled quantity of this order, the order will be considered as completed, and the order will be cancelled, and no new order will be placed + // Documentation: https://www.kucoin.com/docs-new/api-3470171 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -77,6 +82,7 @@ type OrderAPI interface { // CancelAllOrders Cancel All Orders // Description: This endpoint can cancel all spot orders for all symbol. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470176 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -90,6 +96,7 @@ type OrderAPI interface { // CancelPartialOrder Cancel Partial Order // Description: This interface can cancel the specified quantity of the order according to the orderId. The order execution order is: price first, time first, this interface will not change the queue order + // Documentation: https://www.kucoin.com/docs-new/api-3470183 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -103,6 +110,7 @@ type OrderAPI interface { // CancelOrderByClientOid Cancel Order By ClientOid // Description: This endpoint can be used to cancel a spot order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470184 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -116,6 +124,7 @@ type OrderAPI interface { // GetOrderByClientOid Get Order By ClientOid // Description: This endpoint can be used to obtain information for a single Spot order using the client order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + // Documentation: https://www.kucoin.com/docs-new/api-3470182 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -129,6 +138,7 @@ type OrderAPI interface { // SetDCP Set DCP // Description: Set Disconnection Protect(Deadman Swich)Through this interface, Call this interface to automatically cancel all orders of the set trading pair after the specified time. If this interface is not called again for renewal or cancellation before the set time, the system will help the user to cancel the order of the corresponding trading pair. Otherwise it will not. + // Documentation: https://www.kucoin.com/docs-new/api-3470173 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -142,6 +152,7 @@ type OrderAPI interface { // GetDCP Get DCP // Description: Get Disconnection Protect(Deadman Swich)Through this interface, you can query the settings of automatic order cancellation + // Documentation: https://www.kucoin.com/docs-new/api-3470172 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -155,6 +166,7 @@ type OrderAPI interface { // CancelAllOrdersBySymbol Cancel All Orders By Symbol // Description: This endpoint can cancel all spot orders for specific symbol. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470175 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -168,6 +180,7 @@ type OrderAPI interface { // GetClosedOrders Get Closed Orders // Description: This interface is to obtain all Spot closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + // Documentation: https://www.kucoin.com/docs-new/api-3470179 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -181,6 +194,7 @@ type OrderAPI interface { // BatchAddOrders Batch Add Orders // Description: This endpoint supports sequential batch order placement from a single endpoint. A maximum of 5orders can be placed simultaneously. The order types must be limit orders of the same trading pair + // Documentation: https://www.kucoin.com/docs-new/api-3470168 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -194,6 +208,7 @@ type OrderAPI interface { // BatchAddOrdersSync Batch Add Orders Sync // Description: This endpoint supports sequential batch order placement from a single endpoint. A maximum of 5orders can be placed simultaneously. The order types must be limit orders of the same trading pair + // Documentation: https://www.kucoin.com/docs-new/api-3470169 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -207,6 +222,7 @@ type OrderAPI interface { // CancelOrderByOrderId Cancel Order By OrderId // Description: This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470174 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -220,6 +236,7 @@ type OrderAPI interface { // GetOrderByOrderId Get Order By OrderId // Description: This endpoint can be used to obtain information for a single Spot order using the order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + // Documentation: https://www.kucoin.com/docs-new/api-3470181 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -233,6 +250,7 @@ type OrderAPI interface { // AddOrder Add Order // Description: Place order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + // Documentation: https://www.kucoin.com/docs-new/api-3470188 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -246,6 +264,7 @@ type OrderAPI interface { // CancelOrderByClientOidSync Cancel Order By ClientOid Sync // Description: This endpoint can be used to cancel a spot order by orderId. + // Documentation: https://www.kucoin.com/docs-new/api-3470186 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -259,6 +278,7 @@ type OrderAPI interface { // CancelOrderByOrderIdSync Cancel Order By OrderId Sync // Description: This endpoint can be used to cancel a spot order by orderId. + // Documentation: https://www.kucoin.com/docs-new/api-3470185 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -272,6 +292,7 @@ type OrderAPI interface { // AddOrderSync Add Order Sync // Description: Place order to the spot trading system The difference between this interface and \"Add order\" is that this interface will synchronously return the order information after the order matching is completed. For higher latency requirements, please select the \"Add order\" interface. If there is a requirement for returning data integrity, please select this interface + // Documentation: https://www.kucoin.com/docs-new/api-3470170 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -285,6 +306,7 @@ type OrderAPI interface { // AddOrderTest Add Order Test // Description: Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried. + // Documentation: https://www.kucoin.com/docs-new/api-3470187 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -298,6 +320,7 @@ type OrderAPI interface { // GetRecentTradeHistoryOld Get Recent Trade History - Old // Description: Request via this endpoint to get a list of 1000 fills in the last 24 hours. The return value is the data after Pagination, sorted in descending order according to time. + // Documentation: https://www.kucoin.com/docs-new/api-3470351 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -312,6 +335,7 @@ type OrderAPI interface { // GetRecentOrdersListOld Get Recent Orders List - Old // Description: Request via this endpoint to get your current order list. The return value is the data after Pagination, sorted in descending order according to time. + // Documentation: https://www.kucoin.com/docs-new/api-3470347 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -326,6 +350,7 @@ type OrderAPI interface { // CancelOrderByClientOidOld Cancel Order By ClientOid - Old // Description: This endpoint can be used to cancel a spot order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470344 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -339,6 +364,7 @@ type OrderAPI interface { // GetOrderByClientOidOld Get Order By ClientOid - Old // Description: Request via this interface to check the information of a single active order via clientOid. The system will prompt that the order does not exists if the order does not exist or has been settled. + // Documentation: https://www.kucoin.com/docs-new/api-3470349 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -353,6 +379,7 @@ type OrderAPI interface { // BatchCancelOrderOld Batch Cancel Order - Old // Description: Request via this endpoint to cancel all open orders. The response is a list of ids of the canceled orders. + // Documentation: https://www.kucoin.com/docs-new/api-3470345 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -367,6 +394,7 @@ type OrderAPI interface { // GetOrdersListOld Get Orders List - Old // Description: Request via this endpoint to get your current order list. The return value is the data after Pagination, sorted in descending order according to time. + // Documentation: https://www.kucoin.com/docs-new/api-3470346 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -381,6 +409,7 @@ type OrderAPI interface { // BatchAddOrdersOld Batch Add Orders - Old // Description: Request via this endpoint to place 5 orders at the same time. The order type must be a limit order of the same symbol. + // Documentation: https://www.kucoin.com/docs-new/api-3470342 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -395,6 +424,7 @@ type OrderAPI interface { // CancelOrderByOrderIdOld Cancel Order By OrderId - Old // Description: This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470343 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -409,6 +439,7 @@ type OrderAPI interface { // GetOrderByOrderIdOld Get Order By OrderId - Old // Description: Request via this endpoint to get a single order info by order ID. + // Documentation: https://www.kucoin.com/docs-new/api-3470348 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -423,6 +454,7 @@ type OrderAPI interface { // AddOrderOld Add Order - Old // Description: Place order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + // Documentation: https://www.kucoin.com/docs-new/api-3470333 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -437,6 +469,7 @@ type OrderAPI interface { // AddOrderTestOld Add Order Test - Old // Description: Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried. + // Documentation: https://www.kucoin.com/docs-new/api-3470341 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -451,6 +484,7 @@ type OrderAPI interface { // BatchCancelStopOrder Batch Cancel Stop Orders // Description: This endpoint can be used to cancel a spot stop orders by batch. + // Documentation: https://www.kucoin.com/docs-new/api-3470337 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -464,6 +498,7 @@ type OrderAPI interface { // CancelStopOrderByClientOid Cancel Stop Order By ClientOid // Description: This endpoint can be used to cancel a spot stop order by clientOid. + // Documentation: https://www.kucoin.com/docs-new/api-3470336 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -478,6 +513,7 @@ type OrderAPI interface { // GetStopOrdersList Get Stop Orders List // Description: This interface is to obtain all Spot active stop order lists + // Documentation: https://www.kucoin.com/docs-new/api-3470338 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -491,6 +527,7 @@ type OrderAPI interface { // CancelStopOrderByOrderId Cancel Stop Order By OrderId // Description: This endpoint can be used to cancel a spot stop order by orderId. + // Documentation: https://www.kucoin.com/docs-new/api-3470335 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -505,6 +542,7 @@ type OrderAPI interface { // GetStopOrderByOrderId Get Stop Order By OrderId // Description: This interface is to obtain Spot stop order details by orderId + // Documentation: https://www.kucoin.com/docs-new/api-3470339 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -518,6 +556,7 @@ type OrderAPI interface { // AddStopOrder Add Stop Order // Description: Place stop order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + // Documentation: https://www.kucoin.com/docs-new/api-3470334 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -532,6 +571,7 @@ type OrderAPI interface { // GetStopOrderByClientOid Get Stop Order By ClientOid // Description: This interface is to obtain Spot stop order details by orderId + // Documentation: https://www.kucoin.com/docs-new/api-3470340 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -545,6 +585,7 @@ type OrderAPI interface { // CancelOcoOrderByClientOid Cancel OCO Order By ClientOid // Description: Request via this interface to cancel a stop order via the clientOid. You will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes. + // Documentation: https://www.kucoin.com/docs-new/api-3470355 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -559,6 +600,7 @@ type OrderAPI interface { // GetOcoOrderByClientOid Get OCO Order By ClientOid // Description: Request via this interface to get a oco order information via the client order ID. + // Documentation: https://www.kucoin.com/docs-new/api-3470358 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -573,6 +615,7 @@ type OrderAPI interface { // GetOcoOrderDetailByOrderId Get OCO Order Detail By OrderId // Description: Request via this interface to get a oco order detail via the order ID. + // Documentation: https://www.kucoin.com/docs-new/api-3470359 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -587,6 +630,7 @@ type OrderAPI interface { // CancelOcoOrderByOrderId Cancel OCO Order By OrderId // Description: This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + // Documentation: https://www.kucoin.com/docs-new/api-3470354 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -601,6 +645,7 @@ type OrderAPI interface { // GetOcoOrderByOrderId Get OCO Order By OrderId // Description: Request via this interface to get a oco order information via the order ID. + // Documentation: https://www.kucoin.com/docs-new/api-3470357 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -615,6 +660,7 @@ type OrderAPI interface { // AddOcoOrder Add OCO Order // Description: Place OCO order to the Spot trading system + // Documentation: https://www.kucoin.com/docs-new/api-3470353 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -629,6 +675,7 @@ type OrderAPI interface { // BatchCancelOcoOrders Batch Cancel OCO Order // Description: This interface can batch cancel OCO orders through orderIds. You will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes. + // Documentation: https://www.kucoin.com/docs-new/api-3470356 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ @@ -643,6 +690,7 @@ type OrderAPI interface { // GetOcoOrderList Get OCO Order List // Description: Request via this endpoint to get your current OCO order list. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page. + // Documentation: https://www.kucoin.com/docs-new/api-3470360 // +---------------------+---------+ // | Extra API Info | Value | // +---------------------+---------+ diff --git a/sdk/golang/pkg/generate/spot/order/types_add_order_old_req.go b/sdk/golang/pkg/generate/spot/order/types_add_order_old_req.go index 0ab4393..be4f35d 100644 --- a/sdk/golang/pkg/generate/spot/order/types_add_order_old_req.go +++ b/sdk/golang/pkg/generate/spot/order/types_add_order_old_req.go @@ -14,13 +14,13 @@ type AddOrderOldReq struct { Type *string `json:"type,omitempty"` // Order placement remarks, length cannot exceed 20 characters (ASCII) Remark *string `json:"remark,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price *string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Time in force](doc://link/pages/338146) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` @@ -138,7 +138,7 @@ func (builder *AddOrderOldReqBuilder) SetRemark(value string) *AddOrderOldReqBui return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC func (builder *AddOrderOldReqBuilder) SetStp(value string) *AddOrderOldReqBuilder { builder.obj.Stp = &value return builder @@ -156,7 +156,7 @@ func (builder *AddOrderOldReqBuilder) SetSize(value string) *AddOrderOldReqBuild return builder } -// [Time in force](doc://link/pages/338146) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading func (builder *AddOrderOldReqBuilder) SetTimeInForce(value string) *AddOrderOldReqBuilder { builder.obj.TimeInForce = &value return builder diff --git a/sdk/golang/pkg/generate/spot/order/types_add_order_req.go b/sdk/golang/pkg/generate/spot/order/types_add_order_req.go index 4bfeda5..5bc9d07 100644 --- a/sdk/golang/pkg/generate/spot/order/types_add_order_req.go +++ b/sdk/golang/pkg/generate/spot/order/types_add_order_req.go @@ -14,19 +14,19 @@ type AddOrderReq struct { Type string `json:"type,omitempty"` // Order placement remarks, length cannot exceed 20 characters (ASCII) Remark *string `json:"remark,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price *string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Time in force](doc://link/pages/338146) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` - // [Hidden order](doc://link/pages/338146) or not (not shown in order book) + // [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) Hidden *bool `json:"hidden,omitempty"` - // Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + // Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) Iceberg *bool `json:"iceberg,omitempty"` // Maximum visible quantity in iceberg orders VisibleSize *string `json:"visibleSize,omitempty"` @@ -130,7 +130,7 @@ func (builder *AddOrderReqBuilder) SetRemark(value string) *AddOrderReqBuilder { return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC func (builder *AddOrderReqBuilder) SetStp(value string) *AddOrderReqBuilder { builder.obj.Stp = &value return builder @@ -148,7 +148,7 @@ func (builder *AddOrderReqBuilder) SetSize(value string) *AddOrderReqBuilder { return builder } -// [Time in force](doc://link/pages/338146) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading func (builder *AddOrderReqBuilder) SetTimeInForce(value string) *AddOrderReqBuilder { builder.obj.TimeInForce = &value return builder @@ -160,13 +160,13 @@ func (builder *AddOrderReqBuilder) SetPostOnly(value bool) *AddOrderReqBuilder { return builder } -// [Hidden order](doc://link/pages/338146) or not (not shown in order book) +// [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) func (builder *AddOrderReqBuilder) SetHidden(value bool) *AddOrderReqBuilder { builder.obj.Hidden = &value return builder } -// Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) +// Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) func (builder *AddOrderReqBuilder) SetIceberg(value bool) *AddOrderReqBuilder { builder.obj.Iceberg = &value return builder diff --git a/sdk/golang/pkg/generate/spot/order/types_add_order_sync_req.go b/sdk/golang/pkg/generate/spot/order/types_add_order_sync_req.go index bebc63e..eda9593 100644 --- a/sdk/golang/pkg/generate/spot/order/types_add_order_sync_req.go +++ b/sdk/golang/pkg/generate/spot/order/types_add_order_sync_req.go @@ -14,19 +14,19 @@ type AddOrderSyncReq struct { Type string `json:"type,omitempty"` // Order placement remarks, length cannot exceed 20 characters (ASCII) Remark *string `json:"remark,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price *string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Time in force](doc://link/pages/338146) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` - // [Hidden order](doc://link/pages/338146) or not (not shown in order book) + // [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) Hidden *bool `json:"hidden,omitempty"` - // Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + // Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) Iceberg *bool `json:"iceberg,omitempty"` // Maximum visible quantity in iceberg orders VisibleSize *string `json:"visibleSize,omitempty"` @@ -130,7 +130,7 @@ func (builder *AddOrderSyncReqBuilder) SetRemark(value string) *AddOrderSyncReqB return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC func (builder *AddOrderSyncReqBuilder) SetStp(value string) *AddOrderSyncReqBuilder { builder.obj.Stp = &value return builder @@ -148,7 +148,7 @@ func (builder *AddOrderSyncReqBuilder) SetSize(value string) *AddOrderSyncReqBui return builder } -// [Time in force](doc://link/pages/338146) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading func (builder *AddOrderSyncReqBuilder) SetTimeInForce(value string) *AddOrderSyncReqBuilder { builder.obj.TimeInForce = &value return builder @@ -160,13 +160,13 @@ func (builder *AddOrderSyncReqBuilder) SetPostOnly(value bool) *AddOrderSyncReqB return builder } -// [Hidden order](doc://link/pages/338146) or not (not shown in order book) +// [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) func (builder *AddOrderSyncReqBuilder) SetHidden(value bool) *AddOrderSyncReqBuilder { builder.obj.Hidden = &value return builder } -// Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) +// Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) func (builder *AddOrderSyncReqBuilder) SetIceberg(value bool) *AddOrderSyncReqBuilder { builder.obj.Iceberg = &value return builder diff --git a/sdk/golang/pkg/generate/spot/order/types_add_order_test_old_req.go b/sdk/golang/pkg/generate/spot/order/types_add_order_test_old_req.go index 536d3c3..a97d945 100644 --- a/sdk/golang/pkg/generate/spot/order/types_add_order_test_old_req.go +++ b/sdk/golang/pkg/generate/spot/order/types_add_order_test_old_req.go @@ -14,13 +14,13 @@ type AddOrderTestOldReq struct { Type *string `json:"type,omitempty"` // Order placement remarks, length cannot exceed 20 characters (ASCII) Remark *string `json:"remark,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price *string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Time in force](doc://link/pages/338146) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` @@ -138,7 +138,7 @@ func (builder *AddOrderTestOldReqBuilder) SetRemark(value string) *AddOrderTestO return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC func (builder *AddOrderTestOldReqBuilder) SetStp(value string) *AddOrderTestOldReqBuilder { builder.obj.Stp = &value return builder @@ -156,7 +156,7 @@ func (builder *AddOrderTestOldReqBuilder) SetSize(value string) *AddOrderTestOld return builder } -// [Time in force](doc://link/pages/338146) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading func (builder *AddOrderTestOldReqBuilder) SetTimeInForce(value string) *AddOrderTestOldReqBuilder { builder.obj.TimeInForce = &value return builder diff --git a/sdk/golang/pkg/generate/spot/order/types_add_order_test_req.go b/sdk/golang/pkg/generate/spot/order/types_add_order_test_req.go index bb2da28..a53761c 100644 --- a/sdk/golang/pkg/generate/spot/order/types_add_order_test_req.go +++ b/sdk/golang/pkg/generate/spot/order/types_add_order_test_req.go @@ -14,19 +14,19 @@ type AddOrderTestReq struct { Type string `json:"type,omitempty"` // Order placement remarks, length cannot exceed 20 characters (ASCII) Remark *string `json:"remark,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price *string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Time in force](doc://link/pages/338146) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` - // [Hidden order](doc://link/pages/338146) or not (not shown in order book) + // [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) Hidden *bool `json:"hidden,omitempty"` - // Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + // Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) Iceberg *bool `json:"iceberg,omitempty"` // Maximum visible quantity in iceberg orders VisibleSize *string `json:"visibleSize,omitempty"` @@ -130,7 +130,7 @@ func (builder *AddOrderTestReqBuilder) SetRemark(value string) *AddOrderTestReqB return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC func (builder *AddOrderTestReqBuilder) SetStp(value string) *AddOrderTestReqBuilder { builder.obj.Stp = &value return builder @@ -148,7 +148,7 @@ func (builder *AddOrderTestReqBuilder) SetSize(value string) *AddOrderTestReqBui return builder } -// [Time in force](doc://link/pages/338146) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading func (builder *AddOrderTestReqBuilder) SetTimeInForce(value string) *AddOrderTestReqBuilder { builder.obj.TimeInForce = &value return builder @@ -160,13 +160,13 @@ func (builder *AddOrderTestReqBuilder) SetPostOnly(value bool) *AddOrderTestReqB return builder } -// [Hidden order](doc://link/pages/338146) or not (not shown in order book) +// [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) func (builder *AddOrderTestReqBuilder) SetHidden(value bool) *AddOrderTestReqBuilder { builder.obj.Hidden = &value return builder } -// Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) +// Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) func (builder *AddOrderTestReqBuilder) SetIceberg(value bool) *AddOrderTestReqBuilder { builder.obj.Iceberg = &value return builder diff --git a/sdk/golang/pkg/generate/spot/order/types_add_stop_order_req.go b/sdk/golang/pkg/generate/spot/order/types_add_stop_order_req.go index a2f7108..a77e3eb 100644 --- a/sdk/golang/pkg/generate/spot/order/types_add_stop_order_req.go +++ b/sdk/golang/pkg/generate/spot/order/types_add_stop_order_req.go @@ -14,19 +14,19 @@ type AddStopOrderReq struct { Type string `json:"type,omitempty"` // Order placement remarks, length cannot exceed 20 characters (ASCII) Remark *string `json:"remark,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order, not need for market order. When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price *string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Time in force](doc://link/pages/338146) is a special strategy used during trading. Required for limit orders. + // [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading. Required for limit orders. TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK if **type** is limit. PostOnly *bool `json:"postOnly,omitempty"` - // [Hidden order](doc://link/pages/338146) or not (not shown in order book) + // [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) Hidden *bool `json:"hidden,omitempty"` - // Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + // Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) Iceberg *bool `json:"iceberg,omitempty"` // When **type** is limit, this is Maximum visible quantity in iceberg orders. VisibleSize *string `json:"visibleSize,omitempty"` @@ -134,7 +134,7 @@ func (builder *AddStopOrderReqBuilder) SetRemark(value string) *AddStopOrderReqB return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC func (builder *AddStopOrderReqBuilder) SetStp(value string) *AddStopOrderReqBuilder { builder.obj.Stp = &value return builder @@ -152,7 +152,7 @@ func (builder *AddStopOrderReqBuilder) SetSize(value string) *AddStopOrderReqBui return builder } -// [Time in force](doc://link/pages/338146) is a special strategy used during trading. Required for limit orders. +// [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading. Required for limit orders. func (builder *AddStopOrderReqBuilder) SetTimeInForce(value string) *AddStopOrderReqBuilder { builder.obj.TimeInForce = &value return builder @@ -164,13 +164,13 @@ func (builder *AddStopOrderReqBuilder) SetPostOnly(value bool) *AddStopOrderReqB return builder } -// [Hidden order](doc://link/pages/338146) or not (not shown in order book) +// [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) func (builder *AddStopOrderReqBuilder) SetHidden(value bool) *AddStopOrderReqBuilder { builder.obj.Hidden = &value return builder } -// Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) +// Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) func (builder *AddStopOrderReqBuilder) SetIceberg(value bool) *AddStopOrderReqBuilder { builder.obj.Iceberg = &value return builder diff --git a/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_old_order_list.go b/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_old_order_list.go index ab76176..a0eb507 100644 --- a/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_old_order_list.go +++ b/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_old_order_list.go @@ -14,13 +14,13 @@ type BatchAddOrdersOldOrderList struct { Type *string `json:"type,omitempty"` // Order placement remarks, length cannot exceed 20 characters (ASCII) Remark *string `json:"remark,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. Price string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size string `json:"size,omitempty"` - // [Time in force](doc://link/pages/338146) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` @@ -143,7 +143,7 @@ func (builder *BatchAddOrdersOldOrderListBuilder) SetRemark(value string) *Batch return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC func (builder *BatchAddOrdersOldOrderListBuilder) SetStp(value string) *BatchAddOrdersOldOrderListBuilder { builder.obj.Stp = &value return builder @@ -161,7 +161,7 @@ func (builder *BatchAddOrdersOldOrderListBuilder) SetSize(value string) *BatchAd return builder } -// [Time in force](doc://link/pages/338146) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading func (builder *BatchAddOrdersOldOrderListBuilder) SetTimeInForce(value string) *BatchAddOrdersOldOrderListBuilder { builder.obj.TimeInForce = &value return builder diff --git a/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_order_list.go b/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_order_list.go index 4f49438..7afbbe9 100644 --- a/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_order_list.go +++ b/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_order_list.go @@ -10,7 +10,7 @@ type BatchAddOrdersOrderList struct { Symbol string `json:"symbol,omitempty"` // Specify if the order is an 'limit' order or 'market' order. Type string `json:"type,omitempty"` - // [Time in force](doc://link/pages/338146) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // Specify if the order is to 'buy' or 'sell' Side string `json:"side,omitempty"` @@ -18,15 +18,15 @@ type BatchAddOrdersOrderList struct { Price string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, select one out of two: size or funds, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Cancel after n seconds，the order timing strategy is GTT CancelAfter *int64 `json:"cancelAfter,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` - // [Hidden order](doc://link/pages/338146) or not (not shown in order book) + // [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) Hidden *bool `json:"hidden,omitempty"` - // Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + // Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) Iceberg *bool `json:"iceberg,omitempty"` // Maximum visible quantity in iceberg orders VisibleSize *string `json:"visibleSize,omitempty"` @@ -119,7 +119,7 @@ func (builder *BatchAddOrdersOrderListBuilder) SetType(value string) *BatchAddOr return builder } -// [Time in force](doc://link/pages/338146) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading func (builder *BatchAddOrdersOrderListBuilder) SetTimeInForce(value string) *BatchAddOrdersOrderListBuilder { builder.obj.TimeInForce = &value return builder @@ -143,7 +143,7 @@ func (builder *BatchAddOrdersOrderListBuilder) SetSize(value string) *BatchAddOr return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC func (builder *BatchAddOrdersOrderListBuilder) SetStp(value string) *BatchAddOrdersOrderListBuilder { builder.obj.Stp = &value return builder @@ -161,13 +161,13 @@ func (builder *BatchAddOrdersOrderListBuilder) SetPostOnly(value bool) *BatchAdd return builder } -// [Hidden order](doc://link/pages/338146) or not (not shown in order book) +// [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) func (builder *BatchAddOrdersOrderListBuilder) SetHidden(value bool) *BatchAddOrdersOrderListBuilder { builder.obj.Hidden = &value return builder } -// Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) +// Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) func (builder *BatchAddOrdersOrderListBuilder) SetIceberg(value bool) *BatchAddOrdersOrderListBuilder { builder.obj.Iceberg = &value return builder diff --git a/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_sync_order_list.go b/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_sync_order_list.go index a2604e8..61dea2b 100644 --- a/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_sync_order_list.go +++ b/sdk/golang/pkg/generate/spot/order/types_batch_add_orders_sync_order_list.go @@ -10,7 +10,7 @@ type BatchAddOrdersSyncOrderList struct { Symbol string `json:"symbol,omitempty"` // Specify if the order is an 'limit' order or 'market' order. Type string `json:"type,omitempty"` - // [Time in force](doc://link/pages/338146) is a special strategy used during trading + // [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading TimeInForce *string `json:"timeInForce,omitempty"` // Specify if the order is to 'buy' or 'sell' Side string `json:"side,omitempty"` @@ -18,15 +18,15 @@ type BatchAddOrdersSyncOrderList struct { Price string `json:"price,omitempty"` // Specify quantity for order When **type** is limit, select one out of two: size or funds, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds Size *string `json:"size,omitempty"` - // [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + // [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC Stp *string `json:"stp,omitempty"` // Cancel after n seconds，the order timing strategy is GTT CancelAfter *int64 `json:"cancelAfter,omitempty"` // passive order labels, this is disabled when the order timing strategy is IOC or FOK PostOnly *bool `json:"postOnly,omitempty"` - // [Hidden order](doc://link/pages/338146) or not (not shown in order book) + // [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) Hidden *bool `json:"hidden,omitempty"` - // Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + // Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) Iceberg *bool `json:"iceberg,omitempty"` // Maximum visible quantity in iceberg orders VisibleSize *string `json:"visibleSize,omitempty"` @@ -119,7 +119,7 @@ func (builder *BatchAddOrdersSyncOrderListBuilder) SetType(value string) *BatchA return builder } -// [Time in force](doc://link/pages/338146) is a special strategy used during trading +// [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading func (builder *BatchAddOrdersSyncOrderListBuilder) SetTimeInForce(value string) *BatchAddOrdersSyncOrderListBuilder { builder.obj.TimeInForce = &value return builder @@ -143,7 +143,7 @@ func (builder *BatchAddOrdersSyncOrderListBuilder) SetSize(value string) *BatchA return builder } -// [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC +// [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC func (builder *BatchAddOrdersSyncOrderListBuilder) SetStp(value string) *BatchAddOrdersSyncOrderListBuilder { builder.obj.Stp = &value return builder @@ -161,13 +161,13 @@ func (builder *BatchAddOrdersSyncOrderListBuilder) SetPostOnly(value bool) *Batc return builder } -// [Hidden order](doc://link/pages/338146) or not (not shown in order book) +// [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) func (builder *BatchAddOrdersSyncOrderListBuilder) SetHidden(value bool) *BatchAddOrdersSyncOrderListBuilder { builder.obj.Hidden = &value return builder } -// Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) +// Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) func (builder *BatchAddOrdersSyncOrderListBuilder) SetIceberg(value bool) *BatchAddOrdersSyncOrderListBuilder { builder.obj.Iceberg = &value return builder diff --git a/sdk/golang/pkg/generate/spot/order/types_get_closed_orders_items.go b/sdk/golang/pkg/generate/spot/order/types_get_closed_orders_items.go index c8b7464..2763cec 100644 --- a/sdk/golang/pkg/generate/spot/order/types_get_closed_orders_items.go +++ b/sdk/golang/pkg/generate/spot/order/types_get_closed_orders_items.go @@ -23,11 +23,11 @@ type GetClosedOrdersItems struct { DealSize string `json:"dealSize,omitempty"` // Funds of filled transactions DealFunds string `json:"dealFunds,omitempty"` - // [Handling fees](doc://link/pages/5327739) + // [Handling fees](https://www.kucoin.com/docs-new/api-5327739) Fee string `json:"fee,omitempty"` // currency used to calculate trading fee FeeCurrency string `json:"feeCurrency,omitempty"` - // [Self Trade Prevention](doc://link/pages/5176570) + // [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) Stp *string `json:"stp,omitempty"` // Time in force TimeInForce string `json:"timeInForce,omitempty"` diff --git a/sdk/golang/pkg/generate/spot/order/types_get_open_orders_data.go b/sdk/golang/pkg/generate/spot/order/types_get_open_orders_data.go index 9f582af..a8b490b 100644 --- a/sdk/golang/pkg/generate/spot/order/types_get_open_orders_data.go +++ b/sdk/golang/pkg/generate/spot/order/types_get_open_orders_data.go @@ -23,11 +23,11 @@ type GetOpenOrdersData struct { DealSize string `json:"dealSize,omitempty"` // Funds of filled transactions DealFunds string `json:"dealFunds,omitempty"` - // [Handling fees](doc://link/pages/5327739) + // [Handling fees](https://www.kucoin.com/docs-new/api-5327739) Fee string `json:"fee,omitempty"` // currency used to calculate trading fee FeeCurrency string `json:"feeCurrency,omitempty"` - // [Self Trade Prevention](doc://link/pages/5176570) + // [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) Stp *string `json:"stp,omitempty"` // Time in force TimeInForce string `json:"timeInForce,omitempty"` diff --git a/sdk/golang/pkg/generate/spot/order/types_get_order_by_client_oid_resp.go b/sdk/golang/pkg/generate/spot/order/types_get_order_by_client_oid_resp.go index 8c6ec74..fb14329 100644 --- a/sdk/golang/pkg/generate/spot/order/types_get_order_by_client_oid_resp.go +++ b/sdk/golang/pkg/generate/spot/order/types_get_order_by_client_oid_resp.go @@ -29,11 +29,11 @@ type GetOrderByClientOidResp struct { DealSize string `json:"dealSize,omitempty"` // Funds of filled transactions DealFunds string `json:"dealFunds,omitempty"` - // [Handling fees](doc://link/pages/5327739) + // [Handling fees](https://www.kucoin.com/docs-new/api-5327739) Fee string `json:"fee,omitempty"` // currency used to calculate trading fee FeeCurrency string `json:"feeCurrency,omitempty"` - // [Self Trade Prevention](doc://link/pages/5176570) + // [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) Stp *string `json:"stp,omitempty"` // Time in force TimeInForce string `json:"timeInForce,omitempty"` diff --git a/sdk/golang/pkg/generate/spot/order/types_get_order_by_order_id_resp.go b/sdk/golang/pkg/generate/spot/order/types_get_order_by_order_id_resp.go index 70a3e25..9cd700c 100644 --- a/sdk/golang/pkg/generate/spot/order/types_get_order_by_order_id_resp.go +++ b/sdk/golang/pkg/generate/spot/order/types_get_order_by_order_id_resp.go @@ -29,11 +29,11 @@ type GetOrderByOrderIdResp struct { DealSize string `json:"dealSize,omitempty"` // Funds of filled transactions DealFunds string `json:"dealFunds,omitempty"` - // [Handling fees](doc://link/pages/5327739) + // [Handling fees](https://www.kucoin.com/docs-new/api-5327739) Fee string `json:"fee,omitempty"` // currency used to calculate trading fee FeeCurrency string `json:"feeCurrency,omitempty"` - // [Self Trade Prevention](doc://link/pages/5176570) + // [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) Stp *string `json:"stp,omitempty"` // Time in force TimeInForce string `json:"timeInForce,omitempty"` diff --git a/sdk/golang/pkg/generate/spot/order/types_get_trade_history_items.go b/sdk/golang/pkg/generate/spot/order/types_get_trade_history_items.go index ab4816d..dd760c2 100644 --- a/sdk/golang/pkg/generate/spot/order/types_get_trade_history_items.go +++ b/sdk/golang/pkg/generate/spot/order/types_get_trade_history_items.go @@ -25,7 +25,7 @@ type GetTradeHistoryItems struct { Size string `json:"size,omitempty"` // Order Funds Funds string `json:"funds,omitempty"` - // [Handling fees](doc://link/pages/5327739) + // [Handling fees](https://www.kucoin.com/docs-new/api-5327739) Fee string `json:"fee,omitempty"` // Fee rate FeeRate string `json:"feeRate,omitempty"` diff --git a/sdk/golang/pkg/generate/spot/order/types_get_trade_history_old_items.go b/sdk/golang/pkg/generate/spot/order/types_get_trade_history_old_items.go index 200962d..278c812 100644 --- a/sdk/golang/pkg/generate/spot/order/types_get_trade_history_old_items.go +++ b/sdk/golang/pkg/generate/spot/order/types_get_trade_history_old_items.go @@ -22,7 +22,7 @@ type GetTradeHistoryOldItems struct { Size *string `json:"size,omitempty"` // Order Funds Funds *string `json:"funds,omitempty"` - // [Handling fees](doc://link/pages/5327739) + // [Handling fees](https://www.kucoin.com/docs-new/api-5327739) Fee *string `json:"fee,omitempty"` // Fee rate FeeRate *string `json:"feeRate,omitempty"` diff --git a/sdk/golang/pkg/generate/spot/order/types_get_trade_history_req.go b/sdk/golang/pkg/generate/spot/order/types_get_trade_history_req.go index 79d64e7..9c3ca58 100644 --- a/sdk/golang/pkg/generate/spot/order/types_get_trade_history_req.go +++ b/sdk/golang/pkg/generate/spot/order/types_get_trade_history_req.go @@ -14,7 +14,7 @@ type GetTradeHistoryReq struct { Type *string `json:"type,omitempty" url:"type,omitempty"` // The id of the last set of data from the previous batch of data. By default, the latest information is given. lastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page. LastId *int64 `json:"lastId,omitempty" url:"lastId,omitempty"` - // Default100，Max100 + // Default20，Max100 Limit *int32 `json:"limit,omitempty" url:"limit,omitempty"` // Start time (milisecond) StartAt *int64 `json:"startAt,omitempty" url:"startAt,omitempty"` @@ -91,7 +91,7 @@ func (builder *GetTradeHistoryReqBuilder) SetLastId(value int64) *GetTradeHistor return builder } -// Default100，Max100 +// Default20，Max100 func (builder *GetTradeHistoryReqBuilder) SetLimit(value int32) *GetTradeHistoryReqBuilder { builder.obj.Limit = &value return builder diff --git a/sdk/golang/pkg/generate/spot/spotprivate/types_order_v1_event.go b/sdk/golang/pkg/generate/spot/spotprivate/types_order_v1_event.go index f223e66..c65dc20 100644 --- a/sdk/golang/pkg/generate/spot/spotprivate/types_order_v1_event.go +++ b/sdk/golang/pkg/generate/spot/spotprivate/types_order_v1_event.go @@ -47,7 +47,7 @@ type OrderV1Event struct { OldSize *string `json:"oldSize,omitempty"` // Actual Fee Type FeeType *string `json:"feeType,omitempty"` - // Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** + // Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** Liquidity *string `json:"liquidity,omitempty"` // Match Price (when the type is \"match\") MatchPrice *string `json:"matchPrice,omitempty"` diff --git a/sdk/golang/pkg/generate/spot/spotprivate/types_order_v2_event.go b/sdk/golang/pkg/generate/spot/spotprivate/types_order_v2_event.go index 6905ca3..0ab6274 100644 --- a/sdk/golang/pkg/generate/spot/spotprivate/types_order_v2_event.go +++ b/sdk/golang/pkg/generate/spot/spotprivate/types_order_v2_event.go @@ -47,7 +47,7 @@ type OrderV2Event struct { OldSize *string `json:"oldSize,omitempty"` // Actual Fee Type FeeType *string `json:"feeType,omitempty"` - // Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** + // Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** Liquidity *string `json:"liquidity,omitempty"` // Match Price (when the type is \"match\") MatchPrice *string `json:"matchPrice,omitempty"` diff --git a/sdk/golang/pkg/generate/version.go b/sdk/golang/pkg/generate/version.go index 0d85aa1..e85b7c0 100644 --- a/sdk/golang/pkg/generate/version.go +++ b/sdk/golang/pkg/generate/version.go @@ -1,6 +1,6 @@ package generate const ( - SdkVersion = "v0.1.1-alpha" - SdkGenerateDate = "2024-12-17" + SdkVersion = "v1.0.0" + SdkGenerateDate = "2024-12-30" ) diff --git a/sdk/golang/pkg/generate/viplending/viplending/api_vip_lending.go b/sdk/golang/pkg/generate/viplending/viplending/api_vip_lending.go index 6b3300a..2b76162 100644 --- a/sdk/golang/pkg/generate/viplending/viplending/api_vip_lending.go +++ b/sdk/golang/pkg/generate/viplending/viplending/api_vip_lending.go @@ -11,6 +11,7 @@ type VIPLendingAPI interface { // GetAccounts Get Accounts // Description: Accounts participating in OTC lending, This interface is only for querying accounts currently running OTC lending. + // Documentation: https://www.kucoin.com/docs-new/api-3470278 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ @@ -24,6 +25,7 @@ type VIPLendingAPI interface { // GetAccountDetail Get Account Detail // Description: The following information is only applicable to loans. Get information on off-exchange funding and loans, This endpoint is only for querying accounts that are currently involved in loans. + // Documentation: https://www.kucoin.com/docs-new/api-3470277 // +---------------------+------------+ // | Extra API Info | Value | // +---------------------+------------+ diff --git a/sdk/postman/LICENSE b/sdk/postman/LICENSE new file mode 100644 index 0000000..b894b05 --- /dev/null +++ b/sdk/postman/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 KuCoin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/postman/README.md b/sdk/postman/README.md new file mode 100644 index 0000000..2daf91c --- /dev/null +++ b/sdk/postman/README.md @@ -0,0 +1,91 @@ +# Postman API Collection Documentation + +Welcome to the **Postman API Collection** for the KuCoin Universal SDK. This collection is designed to provide a quick and interactive way to explore and test the KuCoin APIs directly within Postman. + +For an overview of the KuCoin Universal SDK and implementations in other languages, refer to the [README](https://github.com/kucoin/kucoin-universal-sdk). + +![Overview](img/overview.png) + +## 📦 Installation + +**Note:** The API collection is actively maintained and updated in line with KuCoin's API specifications. Feedback and contributions to improve the collection are highly encouraged. + +1. Visit the official Postman collection shared link: [KuCoin API Collection on Postman](https://www.postman.com/kucoin-api/kucoin-api/overview). +2. Log in to your Postman account on the web (or create one if you don't have an account). +3. Click **Run in Postman** or **Fork Collection** to add the collection directly to your Postman workspace. +4. Once added, navigate to your workspace, where the collection will be available for immediate use. +5. If you are using the Postman desktop app, the collection will automatically sync with your desktop workspace once added to your account. +6. Configure the environment variables according to your API credentials and begin testing KuCoin's APIs. + +## Set Up Environment Variables + +![Overview](img/env.png) + +To use the collection effectively, follow these steps: + +#### Steps to Configure + +1. In Postman, select the preconfigured environment named **`KuCoin API Production`** from the **Environment** dropdown. +2. Fill in the following variables based on your usage needs: + - **Mandatory Variables** (required only for private API endpoints): + - `API_KEY`: Your KuCoin API key. + - `API_SECRET`: Your KuCoin API secret. + - `API_PASSPHRASE`: Your KuCoin API passphrase. + - **Optional Variables** (only required for broker-related APIs): + - `BROKER_NAME`: Name of the broker account. + - `BROKER_PARTNER`: Partner information associated with the broker account. + - `BROKER_KEY`: Key associated with the broker account for authentication. +3. For public API endpoints (e.g., market data), the mandatory variables are not required and can be left blank. +4. Save the environment to ensure all variables are correctly applied. +5. Return to the Postman main interface and select **`KuCoin API Production`** from the **Environment** dropdown to activate the configuration. +6. Once configured, you're ready to use the Postman collection. + +#### Variable Reference + +| Variable | Description | Example Value | +|-------------------|-----------------------------------------------------------------|---------------------------| +| `spot_endpoint` | Base URL for Spot API endpoints. | `https://api.kucoin.com` | +| `futures_endpoint`| Base URL for Futures API endpoints. | `https://api-futures.kucoin.com` | +| `broker_endpoint` | Base URL for Broker API endpoints. | `https://api-broker.kucoin.com` | +| `API_KEY` | Your KuCoin API key. | | +| `API_SECRET` | Your KuCoin API secret. | | +| `API_PASSPHRASE` | Your KuCoin API passphrase. | | +| `BROKER_NAME` | *(Optional)* Name of the broker account. Required only for broker-related APIs. | | +| `BROKER_PARTNER` | *(Optional)* Partner information associated with the broker account. Required only for broker-related APIs. | | +| `BROKER_KEY` | *(Optional)* Key associated with the broker account for authentication. Required only for broker-related APIs. | | + +## 📖 Getting Started + +Here's a quick guide to interact with KuCoin APIs using the Postman collection: + +### Step 1: Open the Collection + +![Open Collection](img/endpoints.png) + +### Step 2: Send a Request + +![Send Request](img/send.png) + +### Step 3: View Responses + +![View Response](img/response.png) + +## 📝 Documentation + +For detailed information about the API endpoints, refer to the official KuCoin API documentation: + +- [KuCoin API Docs](https://www.kucoin.com/docs-new) + +## 📧 Contact Support + +If you encounter any issues or have questions, feel free to reach out through: + +- GitHub Issues: [Submit an Issue](https://github.com/kucoin/kucoin-universal-sdk/issues) + +## ⚠️ Disclaimer + +- **Financial Risk**: This Postman collection is provided as a tool to explore KuCoin's APIs. It does not provide financial advice. Trading cryptocurrencies involves substantial risk, including the risk of loss. Users should assess their financial circumstances and consult with financial advisors before engaging in trading. +- **No Warranty**: The collection is provided "as is" without any guarantees of accuracy, reliability, or suitability for a specific purpose. Use it at your own risk. +- **Compliance**: Users are responsible for ensuring compliance with all applicable laws and regulations in their jurisdiction when using this collection. + +By using this Postman collection, you acknowledge that you have read, understood, and agreed to this disclaimer. diff --git a/sdk/postman/collection-Abandoned Endpoints.json b/sdk/postman/collection-Abandoned Endpoints.json new file mode 100644 index 0000000..014c9d0 --- /dev/null +++ b/sdk/postman/collection-Abandoned Endpoints.json @@ -0,0 +1,3124 @@ +{ + "info": { + "_postman_id": "e22e2bc3-0147-4151-9872-e9f6bda04a9c", + "name": "Kucoin REST API(Abandoned)", + "description": "For the complete API documentation, please refer to https://www.kucoin.com/docs-new", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Account & Funding", + "item": [ + { + "name": "Get SubAccount List - Summary Info(V1)", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub", + "user" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470298)\n\n:::tip[]\nIt is recommended to use the **GET /api/v2/sub/user** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nYou can get the user info of all sub-account via this interface.\n:::\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| userId | string | |\n| uid | integer | |\n| subName | string | |\n| type | integer | |\n| remarks | string | |\n| access | string | Sub-account Permission |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub", + "user" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get SubAccount List - Spot Balance(V1)", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub-accounts" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470299)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v2/sub-accounts** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nThis endpoint returns the account info of all sub-users.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| subUserId | string | The user ID of the sub-user. |\n| subName | string | The username of the sub-user. |\n| mainAccounts | array | Refer to the schema section of mainAccounts |\n| tradeAccounts | array | Refer to the schema section of tradeAccounts |\n| marginAccounts | array | Refer to the schema section of marginAccounts |\n| tradeHFAccounts | array | Refer to the schema section of tradeHFAccounts |\n\n**root.data.mainAccounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | The currency of the account. |\n| balance | string | Total funds in the account. |\n| available | string | Funds available to withdraw or trade. |\n| holds | string | Funds on hold (not available for use). |\n| baseCurrency | string | Calculated on this currency. |\n| baseCurrencyPrice | string | The base currency price. |\n| baseAmount | string | The base currency amount. |\n| tag | string | |\n\n**root.data.mainAccounts.tradeAccounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | The currency of the account. |\n| balance | string | Total funds in the account. |\n| available | string | Funds available to withdraw or trade. |\n| holds | string | Funds on hold (not available for use). |\n| baseCurrency | string | Calculated on this currency. |\n| baseCurrencyPrice | string | The base currency price. |\n| baseAmount | string | The base currency amount. |\n| tag | string | |\n\n**root.data.mainAccounts.tradeAccounts.marginAccounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | The currency of the account. |\n| balance | string | Total funds in the account. |\n| available | string | Funds available to withdraw or trade. |\n| holds | string | Funds on hold (not available for use). |\n| baseCurrency | string | Calculated on this currency. |\n| baseCurrencyPrice | string | The base currency price. |\n| baseAmount | string | The base currency amount. |\n| tag | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub-accounts" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get Deposit Addresses(V2)", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "deposit-addresses" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470300)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v3/deposit-addresses** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nGet all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| address | string | Deposit address |\n| memo | string | Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious. |\n| chain | string | The chainName of currency |\n| chainId | string | The chainId of currency |\n| to | string | Deposit account type: main (funding account), trade (spot trading account) |\n| currency | string | currency |\n| contractAddress | string | The token contract address. |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "deposit-addresses" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "SubAccount Transfer", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "accounts", + "sub-transfer" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470301)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v3/accounts/universal-transfer** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nFunds 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.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Unique order id created by users to identify their orders, e.g. UUID, with a maximum length of 128 bits |\n| currency | string | currency |\n| amount | string | Transfer amount, the amount is a positive integer multiple of the currency precision. |\n| direction | string | OUT — the master user to sub user
IN — the sub user to the master user. |\n| accountType | string | Account type：MAIN、TRADE、CONTRACT、MARGIN |\n| subAccountType | string | Sub Account type：MAIN、TRADE、CONTRACT、MARGIN |\n| subUserId | string | the user ID of a sub-account. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | Transfer order ID |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"clientOid\": \"64ccc0f164781800010d8c09\",\n \"currency\": \"USDT\",\n \"amount\": \"0.01\",\n \"direction\": \"OUT\",\n \"accountType\": \"MAIN\",\n \"subAccountType\": \"MAIN\",\n \"subUserId\": \"63743f07e0c5230001761d08\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "accounts", + "sub-transfer" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"670be6b0b1b9080007040a9b\"\n }\n}" + } + ] + }, + { + "name": "Inner Transfer", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "accounts", + "inner-transfer" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470302)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v3/accounts/universal-transfer** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nThis API endpoint can be used to transfer funds between accounts internally. Users can transfer funds between their account free of charge. \n:::\n\nnotice:\nIt is not supported to transfer funds from contract account to other accounts.\nThe margin_v2 account currently only supports mutual transfers with margin accounts, and cannot be directly transferred from other accounts to margin_v2\nThe isolated_v2 account currently only supports mutual transfer with the margin account, and cannot be directly transferred from other accounts to isolated_v2\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Unique order id created by users to identify their orders, e.g. UUID, with a maximum length of 128 bits |\n| currency | string | currency |\n| amount | string | Transfer amount, the amount is a positive integer multiple of the currency precision. |\n| to | string | Receiving Account Type: main, trade, margin, isolated, margin_v2, isolated_v2, contract |\n| fromTag | string | Trading pair, required when the payment account type is isolated, e.g.: BTC-USDT |\n| toTag | string | Trading pair, required when the payment account type is isolated, e.g.: BTC-USDT |\n| from | string | Payment Account Type: main, trade, margin, isolated, margin_v2, isolated_v2 |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | Transfer order ID |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"clientOid\": \"64ccc0f164781800010d8c09\",\n \"currency\": \"USDT\",\n \"amount\": \"0.01\",\n \"from\": \"main\",\n \"to\": \"trade\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "accounts", + "inner-transfer" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"670beb3482a1bb0007dec644\"\n }\n}" + } + ] + }, + { + "name": "Futures Account Transfer Out", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v3", + "transfer-out" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470303)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v3/accounts/universal-transfer** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nThe 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.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency, including XBT,USDT... |\n| amount | number | Amount to be transfered out, the maximum cannot exceed 1000000000 |\n| recAccountType | string | Receive account type, including MAIN,TRADE |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| applyId | string | Transfer order ID |\n| bizNo | string | Business number |\n| payAccountType | string | Pay account type |\n| payTag | string | Pay account sub type |\n| remark | string | User remark |\n| recAccountType | string | Receive account type |\n| recTag | string | Receive account sub type |\n| recRemark | string | Receive account tx remark |\n| recSystem | string | Receive system |\n| status | string | Status:APPLY, PROCESSING, PENDING_APPROVAL, APPROVED, REJECTED, PENDING_CANCEL, CANCEL, SUCCESS |\n| currency | string | Currency |\n| amount | string | Transfer amout |\n| fee | string | Transfer fee |\n| sn | integer | Serial number |\n| reason | string | Fail Reason |\n| createdAt | integer | Create time |\n| updatedAt | integer | Update time |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"USDT\",\n \"amount\": 0.01,\n \"recAccountType\": \"MAIN\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v3", + "transfer-out" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Futures Account Transfer In", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "transfer-in" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470304)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v3/accounts/universal-transfer** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nThe 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.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency, including XBT,USDT... |\n| amount | number | Amount to be transfered in |\n| payAccountType | string | Payment account type, including MAIN,TRADE |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | string | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"USDT\",\n \"amount\": 0.01,\n \"payAccountType\": \"MAIN\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "transfer-in" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": null\n}" + } + ] + }, + { + "name": "Get Deposit Addresses - V1", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "deposit-addresses" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "chain", + "value": null, + "description": "The chainId of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20, default is ERC20. The available value for BTC are Native, Segwit, TRC20, the parameters are bech32, btc, trx, default is Native. This only apply for multi-chain currency, and there is no need for single chain currency." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470305)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v3/deposit-addresses** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nGet all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| address | string | Deposit address |\n| memo | string | Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious. |\n| chain | string | The chainName of currency |\n| chainId | string | The chainId of currency |\n| to | string | Deposit account type: main (funding account), trade (spot trading account) |\n| currency | string | currency |\n| contractAddress | string | The token contract address. |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "deposit-addresses" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "chain", + "value": null, + "description": "The chainId of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20, default is ERC20. The available value for BTC are Native, Segwit, TRC20, the parameters are bech32, btc, trx, default is Native. This only apply for multi-chain currency, and there is no need for single chain currency." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"address\": \"0xea220bf61c3c2b0adc2cfa29fec3d2677745a379\",\n \"memo\": \"\",\n \"chain\": \"ERC20\",\n \"chainId\": \"eth\",\n \"to\": \"MAIN\",\n \"currency\": \"USDT\"\n }\n}" + } + ] + }, + { + "name": "Get Deposit History - Old", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hist-deposits" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "status", + "value": "SUCCESS", + "description": "Status. Available value: PROCESSING, SUCCESS, and FAILURE" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470306)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v1/deposits** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to get the V1 historical deposits list on KuCoin. The return value is the data after Pagination, sorted in descending order according to time.\n:::\n\n:::tip[TIPS]\nDefault query for one month of data.\nThis request is paginated\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | current page |\n| pageSize | integer | page size |\n| totalNum | integer | total number |\n| totalPage | integer | total page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| createAt | integer | Creation time of the database record |\n| amount | string | Deposit amount |\n| walletTxId | string | Wallet Txid |\n| isInner | boolean | Internal deposit or not |\n| status | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hist-deposits" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "status", + "value": "SUCCESS", + "description": "Status. Available value: PROCESSING, SUCCESS, and FAILURE" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get Futures Account Transfer Out Ledger", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "transfer-list" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "type", + "value": "MAIN", + "description": "Status PROCESSING, SUCCESS, FAILURE" + }, + { + "key": "tag", + "value": null, + "description": "Status List PROCESSING, SUCCESS, FAILURE" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page, The default currentPage is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "pageSize, The default pageSize is 50" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470307)\n\n:::info[Description]\nThis endpoint can get futures account transfer out ledger\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | current page |\n| pageSize | integer | page size |\n| totalNum | integer | total number |\n| totalPage | integer | total page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| applyId | string | Transfer order ID |\n| currency | string | Currency |\n| recRemark | string | Receive account tx remark |\n| recSystem | string | Receive system |\n| status | string | Status PROCESSING, SUCCESS, FAILURE |\n| amount | string | Transaction amount |\n| reason | string | Reason caused the failure |\n| offset | integer | Offset |\n| createdAt | integer | Request application time |\n| remark | string | User remark |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "transfer-list" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "type", + "value": "MAIN", + "description": "Status PROCESSING, SUCCESS, FAILURE" + }, + { + "key": "tag", + "value": null, + "description": "Status List PROCESSING, SUCCESS, FAILURE" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page, The default currentPage is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "pageSize, The default pageSize is 50" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"applyId\": \"670bf84c577f6c00017a1c48\",\n \"currency\": \"USDT\",\n \"recRemark\": \"\",\n \"recSystem\": \"KUCOIN\",\n \"status\": \"SUCCESS\",\n \"amount\": \"0.01\",\n \"reason\": \"\",\n \"offset\": 1519769124134806,\n \"createdAt\": 1728837708000,\n \"remark\": \"\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Withdrawal History - Old", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hist-withdrawals" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "status", + "value": "SUCCESS", + "description": "Status. Available value: PROCESSING, SUCCESS, and FAILURE" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current request page." + }, + { + "key": "pageSize", + "value": "50", + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470308)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v1/withdrawals** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to get withdrawal list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::\n\n:::tip[TIPS]\nDefault query for one month of data.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | current page |\n| pageSize | integer | page size |\n| totalNum | integer | total number |\n| totalPage | integer | total page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| createAt | integer | Creation time of the database record |\n| amount | string | Withdrawal amount |\n| address | string | Withdrawal address |\n| walletTxId | string | Wallet Txid |\n| isInner | boolean | Internal deposit or not |\n| status | string | Status |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hist-withdrawals" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "status", + "value": "SUCCESS", + "description": "Status. Available value: PROCESSING, SUCCESS, and FAILURE" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current request page." + }, + { + "key": "pageSize", + "value": "50", + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Add Deposit Address - V1", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "deposit-addresses" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470309)\n\n:::tip[TIPS]\nIt is recommended to use the **POST /v3/deposit-address/create** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to create a deposit address for a currency you intend to deposit.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| chain | string | The chainId of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20, default is ERC20. The available value for BTC are Native, Segwit, TRC20, the parameters are bech32, btc, trx, default is Native. This only apply for multi-chain currency, and there is no need for single chain currency. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| address | string | Deposit address |\n| memo | string | Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious. |\n| chain | string | The chainName of currency |\n| chainId | string | The chainId of currency |\n| to | string | Deposit account type: main (funding account), trade (spot trading account) |\n| currency | string | currency |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"ETH\",\n \"chain\": \"eth\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "deposit-addresses" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"address\": \"0x02028456f38e78609904e8a002c787ede7a73d7c\",\n \"memo\": null,\n \"chain\": \"ERC20\",\n \"chainId\": \"eth\",\n \"to\": \"MAIN\",\n \"currency\": \"ETH\"\n }\n}" + } + ] + }, + { + "name": "Withdraw - V1", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "withdrawals" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470310)\n\n:::tip[TIPS]\nIt is recommended to use the **POST /api/v3/withdrawals** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nUse this interface to withdraw the specified currency\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| chain | string | The chainId of currency, For a currency with multiple chains, it is recommended to specify chain parameter instead of using the default chain; you can query the chainId through the response of the GET /api/v3/currencies/{currency} interface. |\n| address | string | Withdrawal address |\n| amount | integer | Withdrawal amount, a positive number which is a multiple of the amount precision |\n| memo | string | Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious. |\n| isInner | boolean | Internal withdrawal or not. Default : false |\n| remark | string | remark |\n| feeDeductType | string | Withdrawal fee deduction type: INTERNAL or EXTERNAL or not specified

1. INTERNAL- deduct the transaction fees from your withdrawal amount
2. EXTERNAL- deduct the transaction fees from your main account
3. 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. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| withdrawalId | string | Withdrawal id, a unique ID for a withdrawal |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"USDT\",\n \"address\": \"TKFRQXSDc****16GmLrjJggwX8\",\n \"amount\": 3,\n \"chain\": \"trx\",\n \"isInner\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "withdrawals" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"withdrawalId\": \"670a973cf07b3800070e216c\"\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Spot Trading", + "item": [ + { + "name": "Orders", + "item": [ + { + "name": "Cancel Order By OrderId - Old", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470343)\n\n:::tip[]\nIt is recommended to use the **DELETE /api/v1/hf/orders/{orderId}** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nThis endpoint can be used to cancel a spot order by orderId.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"674a97dfef434f0007efc431\"\n ]\n }\n}" + } + ] + }, + { + "name": "Get Orders List - Old", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "status", + "value": null, + "description": "active or done(done as default), Only list orders with a specific status ." + }, + { + "key": "side", + "value": null, + "description": "buy or sell" + }, + { + "key": "type", + "value": null, + "description": "limit, market, limit_stop or market_stop" + }, + { + "key": "tradeType", + "value": null, + "description": "The type of trading:TRADE - Spot Trading(TRADE as default), MARGIN_TRADE - Cross Margin Trading, MARGIN_ISOLATED_TRADE - Isolated Margin Trading." + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page." + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470346)\n\n:::tip[]\nIt is recommended to use the **GET /api/v1/hf/orders/active** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to get your current order list. The return value is the data after Pagination, sorted in descending order according to time.\n:::\n\n:::tip[Tips]\nWhen you query orders in active status, there is no time limit. However, when you query orders in done status, the start and end time range cannot exceed 7* 24 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 7*24 hours, and vice versa.\n\nThe history for cancelled orders is only kept for one month. The history for Filled orders is only kept for six month.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | |\n| pageSize | integer | |\n| totalNum | integer | |\n| totalPage | integer | |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | |\n| symbol | string | |\n| opType | string | |\n| type | string | |\n| side | string | |\n| price | string | |\n| size | string | |\n| funds | string | |\n| dealFunds | string | |\n| dealSize | string | |\n| fee | string | |\n| feeCurrency | string | |\n| stp | string | |\n| stop | string | |\n| stopTriggered | boolean | |\n| stopPrice | string | |\n| timeInForce | string | |\n| postOnly | boolean | |\n| hidden | boolean | |\n| iceberg | boolean | |\n| visibleSize | string | |\n| cancelAfter | integer | |\n| channel | string | |\n| clientOid | string | |\n| remark | string | |\n| tags | string | |\n| isActive | boolean | |\n| cancelExist | boolean | |\n| createdAt | integer | |\n| tradeType | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "status", + "value": null, + "description": "active or done(done as default), Only list orders with a specific status ." + }, + { + "key": "side", + "value": null, + "description": "buy or sell" + }, + { + "key": "type", + "value": null, + "description": "limit, market, limit_stop or market_stop" + }, + { + "key": "tradeType", + "value": null, + "description": "The type of trading:TRADE - Spot Trading(TRADE as default), MARGIN_TRADE - Cross Margin Trading, MARGIN_ISOLATED_TRADE - Isolated Margin Trading." + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page." + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"id\": \"674a9a872033a50007e2790d\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"funds\": \"0\",\n \"dealFunds\": \"0\",\n \"dealSize\": \"0\",\n \"fee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": \"0\",\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"clientOid\": \"5c52e11203aa677f33e4923fb\",\n \"remark\": \"order remarks\",\n \"tags\": null,\n \"isActive\": false,\n \"cancelExist\": true,\n \"createdAt\": 1732942471752,\n \"tradeType\": \"TRADE\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Recent Orders List - Old", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "limit", + "orders" + ], + "query": [ + { + "key": "currentPage", + "value": null, + "description": "Current request page." + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470347)\n\n:::tip[]\nIt is recommended to use the **GET /api/v1/hf/orders/active** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to get 1000 orders in the last 24 hours. The return value is the data after Pagination, sorted in descending order according to time.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | |\n| symbol | string | |\n| opType | string | |\n| type | string | |\n| side | string | |\n| price | string | |\n| size | string | |\n| funds | string | |\n| dealFunds | string | |\n| dealSize | string | |\n| fee | string | |\n| feeCurrency | string | |\n| stp | string | |\n| stop | string | |\n| stopTriggered | boolean | |\n| stopPrice | string | |\n| timeInForce | string | |\n| postOnly | boolean | |\n| hidden | boolean | |\n| iceberg | boolean | |\n| visibleSize | string | |\n| cancelAfter | integer | |\n| channel | string | |\n| clientOid | string | |\n| remark | string | |\n| tags | string | |\n| isActive | boolean | |\n| cancelExist | boolean | |\n| createdAt | integer | |\n| tradeType | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "limit", + "orders" + ], + "query": [ + { + "key": "currentPage", + "value": null, + "description": "Current request page." + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"674a9a872033a50007e2790d\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"funds\": \"0\",\n \"dealFunds\": \"0\",\n \"dealSize\": \"0\",\n \"fee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": \"0\",\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"clientOid\": \"5c52e11203aa677f33e4923fb\",\n \"remark\": \"order remarks\",\n \"tags\": null,\n \"isActive\": false,\n \"cancelExist\": true,\n \"createdAt\": 1732942471752,\n \"tradeType\": \"TRADE\"\n }\n ]\n}" + } + ] + }, + { + "name": "Get Order By OrderId - Old", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "{{orderId}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470348)\n\n:::tip[]\nIt is recommended to use the **GET /api/v1/hf/orders/{orderId}** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to get a single order info by order ID.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | |\n| symbol | string | |\n| opType | string | |\n| type | string | |\n| side | string | |\n| price | string | |\n| size | string | |\n| funds | string | |\n| dealFunds | string | |\n| dealSize | string | |\n| fee | string | |\n| feeCurrency | string | |\n| stp | string | |\n| stop | string | |\n| stopTriggered | boolean | |\n| stopPrice | string | |\n| timeInForce | string | |\n| postOnly | boolean | |\n| hidden | boolean | |\n| iceberg | boolean | |\n| visibleSize | string | |\n| cancelAfter | integer | |\n| channel | string | |\n| clientOid | string | |\n| remark | string | |\n| tags | string | |\n| isActive | boolean | |\n| cancelExist | boolean | |\n| createdAt | integer | |\n| tradeType | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "{{orderId}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"674a97dfef434f0007efc431\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.0001\",\n \"funds\": \"0\",\n \"dealFunds\": \"0\",\n \"dealSize\": \"0\",\n \"fee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": \"0\",\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"clientOid\": \"3d07008668054da6b3cb12e432c2b13a\",\n \"remark\": null,\n \"tags\": null,\n \"isActive\": false,\n \"cancelExist\": true,\n \"createdAt\": 1732941791518,\n \"tradeType\": \"TRADE\"\n }\n}" + } + ] + }, + { + "name": "Get Order By ClientOid - Old", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "order", + "client-order", + "{{clientOid}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470349)\n\n:::tip[]\nIt is recommended to use the **GET /api/v1/hf/orders/client-order/{clientOid}** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this interface to check the information of a single active order via clientOid. The system will prompt that the order does not exists if the order does not exist or has been settled.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | |\n| symbol | string | |\n| opType | string | |\n| type | string | |\n| side | string | |\n| price | string | |\n| size | string | |\n| funds | string | |\n| dealFunds | string | |\n| dealSize | string | |\n| fee | string | |\n| feeCurrency | string | |\n| stp | string | |\n| stop | string | |\n| stopTriggered | boolean | |\n| stopPrice | string | |\n| timeInForce | string | |\n| postOnly | boolean | |\n| hidden | boolean | |\n| iceberg | boolean | |\n| visibleSize | string | |\n| cancelAfter | integer | |\n| channel | string | |\n| clientOid | string | |\n| remark | string | |\n| tags | string | |\n| isActive | boolean | |\n| cancelExist | boolean | |\n| createdAt | integer | |\n| tradeType | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "order", + "client-order", + "{{clientOid}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"674a97dfef434f0007efc431\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.0001\",\n \"funds\": \"0\",\n \"dealFunds\": \"0\",\n \"dealSize\": \"0\",\n \"fee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": \"0\",\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"clientOid\": \"3d07008668054da6b3cb12e432c2b13a\",\n \"remark\": null,\n \"tags\": null,\n \"isActive\": false,\n \"cancelExist\": true,\n \"createdAt\": 1732941791518,\n \"tradeType\": \"TRADE\"\n }\n}" + } + ] + }, + { + "name": "Batch Cancel Order - Old", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "tradeType", + "value": "TRADE", + "description": "The type of trading :TRADE(Spot Trading), MARGIN_TRADE(Cross Margin Trading), MARGIN_ISOLATED_TRADE(Isolated Margin Trading), and the default is TRADE to cancel the spot trading orders." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470345)\n\n:::tip[]\nIt is recommended to use the **DELETE /api/v1/hf/orders/cancelAll** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to cancel all open orders. The response is a list of ids of the canceled orders.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "tradeType", + "value": "TRADE", + "description": "The type of trading :TRADE(Spot Trading), MARGIN_TRADE(Cross Margin Trading), MARGIN_ISOLATED_TRADE(Isolated Margin Trading), and the default is TRADE to cancel the spot trading orders." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"674a8635b38d120007709c0f\",\n \"674a8630439c100007d3bce1\"\n ]\n }\n}" + } + ] + }, + { + "name": "Get Trade History - Old", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "fills" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "orderId", + "value": null, + "description": "The unique order id generated by the trading system (If orderId is specified，please ignore the other query parameters)" + }, + { + "key": "side", + "value": null, + "description": "specify if the order is to 'buy' or 'sell'" + }, + { + "key": "type", + "value": null, + "description": "limit, market, limit_stop or market_stop\n" + }, + { + "key": "tradeType", + "value": null, + "description": "The type of trading:TRADE - Spot Trading(TRADE as default), MARGIN_TRADE - Cross Margin Trading, MARGIN_ISOLATED_TRADE - Isolated Margin Trading." + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page." + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470350)\n\n:::tip[]\nIt is recommended to use the **GET /api/v1/hf/fills** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to get the recent fills.\nThe return value is the data after Pagination, sorted in descending order according to time.\n:::\n\n:::tip[Tips]\nThe system allows you to retrieve data up to one week (start from the last day by default). If the time period of the queried data exceeds one week (time range from the start time to end time exceeded 7*24 hours), the system will prompt to remind you that you have exceeded the time limit. If you only specified the start time, the system will automatically calculate the end time (end time = start time + 7 * 24 hours). On the contrary, if you only specified the end time, the system will calculate the start time (start time= end time - 7 * 24 hours) the same way.\n\nThe total number of items retrieved cannot exceed 50,000. If it is exceeded, please shorten the query time range.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | |\n| pageSize | integer | |\n| totalNum | integer | |\n| totalPage | integer | |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | symbol |\n| tradeId | string | |\n| orderId | string | The unique order id generated by the trading system |\n| counterOrderId | string | Counterparty order Id |\n| side | string | Buy or sell |\n| liquidity | string | Liquidity type: taker or maker |\n| forceTaker | boolean | |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| fee | string | [Handling fees](https://www.kucoin.com/docs-new/api-5327739) |\n| feeRate | string | Fee rate
|\n| feeCurrency | string | currency used to calculate trading fee |\n| stop | string | Take Profit and Stop Loss type, currently HFT does not support the Take Profit and Stop Loss type, so it is empty |\n| tradeType | string | Trade type, redundancy param |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| createdAt | integer | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "fills" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "orderId", + "value": null, + "description": "The unique order id generated by the trading system (If orderId is specified，please ignore the other query parameters)" + }, + { + "key": "side", + "value": null, + "description": "specify if the order is to 'buy' or 'sell'" + }, + { + "key": "type", + "value": null, + "description": "limit, market, limit_stop or market_stop\n" + }, + { + "key": "tradeType", + "value": null, + "description": "The type of trading:TRADE - Spot Trading(TRADE as default), MARGIN_TRADE - Cross Margin Trading, MARGIN_ISOLATED_TRADE - Isolated Margin Trading." + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page." + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"symbol\": \"DOGE-USDT\",\n \"tradeId\": \"10862827223795713\",\n \"orderId\": \"6745698ef4f1200007c561a8\",\n \"counterOrderId\": \"6745695ef15b270007ac5076\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"forceTaker\": false,\n \"price\": \"0.40739\",\n \"size\": \"10\",\n \"funds\": \"4.0739\",\n \"fee\": \"0.0040739\",\n \"feeRate\": \"0.001\",\n \"feeCurrency\": \"USDT\",\n \"stop\": \"\",\n \"tradeType\": \"TRADE\",\n \"type\": \"market\",\n \"createdAt\": 1732602254928\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Recent Trade History - Old", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "limit", + "fills" + ], + "query": [ + { + "key": "currentPage", + "value": null, + "description": "Current request page." + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470351)\n\n:::tip[]\nIt is recommended to use the **GET /api/v1/hf/fills** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to get a list of 1000 fills in the last 24 hours. The return value is the data after Pagination, sorted in descending order according to time.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | |\n| tradeId | string | |\n| orderId | string | |\n| counterOrderId | string | |\n| side | string | |\n| liquidity | string | |\n| forceTaker | boolean | |\n| price | string | |\n| size | string | |\n| funds | string | |\n| fee | string | |\n| feeRate | string | |\n| feeCurrency | string | |\n| stop | string | |\n| tradeType | string | |\n| type | string | |\n| createdAt | integer | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "limit", + "fills" + ], + "query": [ + { + "key": "currentPage", + "value": null, + "description": "Current request page." + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"BTC-USDT\",\n \"tradeId\": \"11732720444522497\",\n \"orderId\": \"674aab24754b1e00077dbc69\",\n \"counterOrderId\": \"674aab1fb26bfb0007a18b67\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"forceTaker\": false,\n \"price\": \"96999.6\",\n \"size\": \"0.00001\",\n \"funds\": \"0.969996\",\n \"fee\": \"0.000969996\",\n \"feeRate\": \"0.001\",\n \"feeCurrency\": \"USDT\",\n \"stop\": \"\",\n \"tradeType\": \"TRADE\",\n \"type\": \"limit\",\n \"createdAt\": 1732946724082\n }\n ]\n}" + } + ] + }, + { + "name": "Cancel Order By ClientOid - Old", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "order", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470344)\n\n:::tip[]\nIt is recommended to use the **DELETE /api/v1/hf/orders/client-order/{clientOid}** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nThis endpoint can be used to cancel a spot order by clientOid.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| cancelledOrderId | string | |\n| cancelledOcoOrderIds | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "order", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderId\": \"674a9a872033a50007e2790d\",\n \"clientOid\": \"5c52e11203aa677f33e4923fb\",\n \"cancelledOcoOrderIds\": null\n }\n}" + } + ] + }, + { + "name": "Add Order - Old", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470333)\n\n:::tip[]\nIt is recommended to use the **POST /api/v1/hf/orders** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nPlace order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.(including stop orders).\n:::\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | Yes | clientOid, the unique identifier created by the client, use of UUID, with a maximum length of 128 bits. |\n| side | String | Yes | **buy** or **sell** |\n| symbol | String | Yes | symbol, e.g. ETH-BTC |\n| type | String | No | **limit** or **market** (default is **limit**) |\n| remark | String | No | remark, length cannot exceed 50 characters (ASCII) |\n| stp | String | No | self trade prevention, **CN**, **CO**, **CB** or **DC** |\n| tradeType | String | No | The type of trading : **TRADE**（Spot Trade）, **MARGIN_TRADE** (Margin Trade). Default is **TRADE**. **Note: To improve the system performance and to accelerate order placing and processing, KuCoin has added a new interface for order placing of margin. For traders still using the current interface, please move to the new one as soon as possible. The current one will no longer accept margin orders by May 1st, 2021 (UTC). At the time, KuCoin will notify users via the announcement, please pay attention to it.** |\n\n##### Additional Request Parameters Required by `limit` Orders\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ------------ |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n##### Additional request parameters required by `market` orders\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. |\n| remark | string | Order placement remarks, length cannot exceed 20 characters (ASCII) |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | Hidden or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| funds | string | When **type** is market, select one out of two: size or funds |\n| tradeType | string | The type of trading : **TRADE**（Spot Trade）, **MARGIN_TRADE** (Margin Trade). Default is **TRADE**. **Note: To improve the system performance and to accelerate order placing and processing, KuCoin has added a new interface for order placing of margin. For traders still using the current interface, please move to the new one as soon as possible. The current one will no longer accept margin orders by May 1st, 2021 (UTC). At the time, KuCoin will notify users via the announcement, please pay attention to it.** |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"674a8635b38d120007709c0f\"\n }\n}" + } + ] + }, + { + "name": "Batch Add Orders - Old", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "multi" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470342)\n\n:::tip[]\nIt is recommended to use the **POST /api/v1/hf/orders/multi** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to place 5 orders at the same time. The order type must be a limit order of the same symbol.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderList | array | Refer to the schema section of orderList |\n| symbol | string | |\n\n**root.orderList Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | only limit (default is limit) |\n| remark | string | Order placement remarks, length cannot exceed 20 characters (ASCII) |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | Hidden or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| tradeType | string | The type of trading : **TRADE**（Spot Trade） |\n| stop | string | Either loss or entry. Requires stopPrice to be defined |\n| stopPrice | string | Stop price, Need to be defined if stop is specified. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| data | array | Refer to the schema section of data |\n\n**root.data.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | |\n| type | string | |\n| side | string | |\n| price | string | |\n| size | string | |\n| funds | string | |\n| stp | string | |\n| stop | string | |\n| stopPrice | string | |\n| timeInForce | string | |\n| cancelAfter | integer | |\n| postOnly | boolean | |\n| hidden | boolean | |\n| iceberge | boolean | |\n| iceberg | boolean | |\n| visibleSize | string | |\n| channel | string | |\n| id | string | |\n| status | string | |\n| failMsg | string | |\n| clientOid | string | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"symbol\": \"BTC-USDT\",\n \"orderList\": [\n {\n \"clientOid\": \"3d07008668054da6b3cb12e432c2b13a\",\n \"side\": \"buy\",\n \"type\": \"limit\",\n \"price\": \"50000\",\n \"size\": \"0.0001\"\n },\n {\n \"clientOid\": \"37245dbe6e134b5c97732bfb36cd4a9d\",\n \"side\": \"buy\",\n \"type\": \"limit\",\n \"price\": \"49999\",\n \"size\": \"0.0001\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "multi" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"data\": [\n {\n \"symbol\": \"BTC-USDT\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.0001\",\n \"funds\": null,\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopPrice\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": 0,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberge\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"id\": \"674a97dfef434f0007efc431\",\n \"status\": \"success\",\n \"failMsg\": null,\n \"clientOid\": \"3d07008668054da6b3cb12e432c2b13a\"\n },\n {\n \"symbol\": \"BTC-USDT\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"49999\",\n \"size\": \"0.0001\",\n \"funds\": null,\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopPrice\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": 0,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberge\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"id\": \"674a97dffb378b00077b9c20\",\n \"status\": \"fail\",\n \"failMsg\": \"Balance insufficient!\",\n \"clientOid\": \"37245dbe6e134b5c97732bfb36cd4a9d\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Add Order Test - Old", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "test" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470341)\n\n:::tip[]\nIt is recommended to use the **POST /api/v1/hf/orders/test** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nOrder test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.(including stop orders).\n:::\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | Yes | clientOid, the unique identifier created by the client, use of UUID, with a maximum length of 128 bits. |\n| side | String | Yes | **buy** or **sell** |\n| symbol | String | Yes | symbol, e.g. ETH-BTC |\n| type | String | No | **limit** or **market** (default is **limit**) |\n| remark | String | No | remark, length cannot exceed 50 characters (ASCII) |\n| stp | String | No | self trade prevention, **CN**, **CO**, **CB** or **DC** |\n| tradeType | String | No | The type of trading : **TRADE**（Spot Trade）, **MARGIN_TRADE** (Margin Trade). Default is **TRADE**. **Note: To improve the system performance and to accelerate order placing and processing, KuCoin has added a new interface for order placing of margin. For traders still using the current interface, please move to the new one as soon as possible. The current one will no longer accept margin orders by May 1st, 2021 (UTC). At the time, KuCoin will notify users via the announcement, please pay attention to it.** |\n\n##### Additional Request Parameters Required by `limit` Orders\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ------------ |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n##### Additional request parameters required by `market` orders\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. |\n| remark | string | Order placement remarks, length cannot exceed 20 characters (ASCII) |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | Hidden or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| funds | string | When **type** is market, select one out of two: size or funds |\n| tradeType | string | The type of trading : **TRADE**（Spot Trade）, **MARGIN_TRADE** (Margin Trade). Default is **TRADE**. **Note: To improve the system performance and to accelerate order placing and processing, KuCoin has added a new interface for order placing of margin. For traders still using the current interface, please move to the new one as soon as possible. The current one will no longer accept margin orders by May 1st, 2021 (UTC). At the time, KuCoin will notify users via the announcement, please pay attention to it.** |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "test" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"674a8776291d9e00074f1edf\"\n }\n}" + } + ] + } + ], + "description": "" + } + ], + "description": "" + }, + { + "name": "Margin Trading", + "item": [ + { + "name": "Get Account Detail - Margin", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "account" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470311)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v3/margin/accounts** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to get the info of the margin account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| debtRatio | string | Debt ratio |\n| accounts | array | Refer to the schema section of accounts |\n\n**root.data.accounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| totalBalance | string | Total funds in the account |\n| availableBalance | string | Available funds in the account |\n| holdBalance | string | Funds on hold in the account |\n| liability | string | Total liabilities |\n| maxBorrowSize | string | Available size to borrow |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "account" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Add Order - V1", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "order" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470312)\n\n:::tip[TIPS]\nIt is recommended to use the **POST /api/v3/hf/margin/order** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nPlace order to the Cross-margin or Isolated-margin trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | Yes | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| side | String | Yes | `buy` or `sell` |\n| type | String | No | Order type `limit` and `market`, defult is limit |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| marginModel | String | No | The type of trading, including cross (cross mode) and isolated (isolated mode). It is set at cross by default. |\n| autoBorrow | boolean | No | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | No | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n\n**Hidden Orders and Iceberg Orders (Hidden & Iceberg)**\n\nHidden orders and iceberg orders can be set in advanced settings (iceberg orders are a special type of hidden orders). When placing limit orders or stop limit orders, you can choose to execute according to hidden orders or iceberg orders.\n\nHidden orders are not shown in order books.\n\nUnlike hidden orders, iceberg orders are divided into visible and hidden portions. When engaging in iceberg orders, visible order sizes must be set. The minimum visible size for an iceberg order is 1/20 of the total order size.\n\nWhen matching, the visible portions of iceberg orders are matched first. Once the visible portions are fully matched, hidden portions will emerge. This will continue until the order is fully filled.\n\nNote:\n\n- The system will charge taker fees for hidden orders and iceberg orders.\n- If you simultaneously set iceberg orders and hidden orders, your order will default to an iceberg order for execution.\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | Hidden or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| funds | string | When **type** is market, select one out of two: size or funds |\n| autoBorrow | boolean | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n| marginModel | string | The type of trading, including cross (cross mode) and isolated (isolated mode). It is set at cross by default. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| loanApplyId | string | Borrow order id. The field is returned only after placing the order under the mode of Auto-Borrow. |\n| borrowSize | string | Borrowed amount. The field is returned only after placing the order under the mode of Auto-Borrow. |\n| clientOid | string | This return value is invalid |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e4193fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "order" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"671bb90194422f00073ff4f0\",\n \"loanApplyId\": null,\n \"borrowSize\": null,\n \"clientOid\": null\n }\n}" + } + ] + }, + { + "name": "Add Order Test - V1", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "order", + "test" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470313)\n\n:::tip[TIPS]\nIt is recommended to use the **POST /api/v3/hf/margin/order/test** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nOrder test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | Yes | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| side | String | Yes | `buy` or `sell` |\n| type | String | No | Order type `limit` and `market`, defult is limit |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| marginModel | String | No | The type of trading, including cross (cross mode) and isolated (isolated mode). It is set at cross by default. |\n| autoBorrow | boolean | No | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | No | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n\n**Hidden Orders and Iceberg Orders (Hidden & Iceberg)**\n\nHidden orders and iceberg orders can be set in advanced settings (iceberg orders are a special type of hidden orders). When placing limit orders or stop limit orders, you can choose to execute according to hidden orders or iceberg orders.\n\nHidden orders are not shown in order books.\n\nUnlike hidden orders, iceberg orders are divided into visible and hidden portions. When engaging in iceberg orders, visible order sizes must be set. The minimum visible size for an iceberg order is 1/20 of the total order size.\n\nWhen matching, the visible portions of iceberg orders are matched first. Once the visible portions are fully matched, hidden portions will emerge. This will continue until the order is fully filled.\n\nNote:\n\n- The system will charge taker fees for hidden orders and iceberg orders.\n- If you simultaneously set iceberg orders and hidden orders, your order will default to an iceberg order for execution.\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) is divided into four strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | Hidden or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| funds | string | When **type** is market, select one out of two: size or funds |\n| autoBorrow | boolean | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n| marginModel | string | The type of trading, including cross (cross mode) and isolated (isolated mode). It is set at cross by default. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| loanApplyId | string | Borrow order id. The field is returned only after placing the order under the mode of Auto-Borrow. |\n| borrowSize | string | Borrowed amount. The field is returned only after placing the order under the mode of Auto-Borrow. |\n| clientOid | string | This return value is invalid |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e4193fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "order", + "test" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"671bb90194422f00073ff4f0\",\n \"loanApplyId\": null,\n \"borrowSize\": null,\n \"clientOid\": null\n }\n}" + } + ] + }, + { + "name": "Get Account List - Isolated Margin - V1", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "isolated", + "accounts" + ], + "query": [ + { + "key": "balanceCurrency", + "value": "USDT", + "description": "quote currency, currently only supports USDT, KCS, BTC, USDT as default" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470314)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v3/isolated/accounts** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to get the info list of the isolated margin account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| totalConversionBalance | string | The total balance of the isolated margin account(in the request coin) |\n| liabilityConversionBalance | string | Total liabilities of the isolated margin account(in the request coin) |\n| assets | array | Refer to the schema section of assets |\n\n**root.data.assets Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol |\n| status | string | The 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 . |\n| debtRatio | string | debt ratio |\n| baseAsset | object | Refer to the schema section of baseAsset |\n| quoteAsset | object | Refer to the schema section of quoteAsset |\n\n**root.data.assets.baseAsset Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| totalBalance | string | Current currency total asset amount |\n| holdBalance | string | Current currency holding asset amount |\n| availableBalance | string | Current available asset amount |\n| liability | string | Liabilities |\n| interest | string | |\n| borrowableAmount | string | |\n\n**root.data.assets.baseAsset.quoteAsset Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| totalBalance | string | Current currency total asset amount |\n| holdBalance | string | Current currency holding asset amount |\n| availableBalance | string | Current available asset amount |\n| liability | string | Liabilities |\n| interest | string | |\n| borrowableAmount | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "isolated", + "accounts" + ], + "query": [ + { + "key": "balanceCurrency", + "value": "USDT", + "description": "quote currency, currently only supports USDT, KCS, BTC, USDT as default" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get Account Detail - Isolated Margin - V1", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "isolated", + "account", + "{{symbol}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470315)\n\n:::tip[TIPS]\nIt is recommended to use the **GET /api/v3/isolated/accounts** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nRequest via this endpoint to get the info of the isolated margin account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol |\n| status | string | The 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 . |\n| debtRatio | string | debt ratio |\n| baseAsset | object | Refer to the schema section of baseAsset |\n| quoteAsset | object | Refer to the schema section of quoteAsset |\n\n**root.data.baseAsset Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| totalBalance | string | Current currency total asset amount |\n| holdBalance | string | Current currency holding asset amount |\n| availableBalance | string | Current available asset amount |\n| liability | string | Liabilities |\n| interest | string | |\n| borrowableAmount | string | |\n\n**root.data.baseAsset.quoteAsset Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| totalBalance | string | Current currency total asset amount |\n| holdBalance | string | Current currency holding asset amount |\n| availableBalance | string | Current available asset amount |\n| liability | string | Liabilities |\n| interest | string | |\n| borrowableAmount | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "isolated", + "account", + "{{symbol}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + } + ], + "description": "" + }, + { + "name": "Futures Trading", + "item": [ + { + "name": "Modify Isolated Margin Auto-Deposit Status", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "position", + "margin", + "auto-deposit-status" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470255)\n\n:::tip[TIPS]\nCurrently, it is not recommended to use the Isolated margin + auto deposit margin . It is recommended to switch to the cross margin mode.\nPlease refer to **POST /api/v2/position/changeMarginMode** endpoint\n:::\n\n:::info[Description]\nThis endpoint is only applicable to isolated margin and is no longer recommended. It is recommended to use cross margin instead.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract
|\n| status | boolean | Status |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | boolean | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"symbol\": \"XBTUSDTM\",\n \"status\": true\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "position", + "margin", + "auto-deposit-status" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": true\n}" + } + ] + }, + { + "name": "Cancel All Orders - V1", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470362)\n\n:::tip[TIPS]\nIt is recommended to use the **DELETE /api/v3/orders** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nUsing this endpoint, all open orders (excluding stop orders) can be canceled in batches.\n\nThe response is a list of orderIDs of the canceled orders.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"235919172150824960\",\n \"235919172150824961\"\n ]\n }\n}" + } + ] + } + ], + "description": "" + } + ], + "variable": [ + { + "key": "clientOid", + "value": "" + }, + { + "key": "orderId", + "value": "" + }, + { + "key": "symbol", + "value": "" + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "function extractPathVariable(str) {\n const regex = /^\\{\\{(.+?)\\}\\}$/;\n const match = str.match(regex);\n if (match) {\n return match[1];\n }\n return null;\n}\n\nfunction hasAnyFieldEmpty(obj) {\n for (const key in obj) {\n if (obj[key] === \"\" || obj[key] === null || obj[key] === undefined) {\n return true;\n }\n }\n return false;\n}\n\nfunction sign(text, secret) {\n const hash = CryptoJS.HmacSHA256(text, secret);\n return CryptoJS.enc.Base64.stringify(hash)\n}\n\nfunction auth(apiKey, method, url, data) {\n if (hasAnyFieldEmpty(apiKey)) {\n console.warn('The API key-related information is not configured; only the public channel API is accessible.')\n return {'User-Agent': `Kucoin-Universal-Postman-SDK/`}\n }\n\n const timestamp = Date.now();\n const text = timestamp + method.toUpperCase() + url + data;\n const signature = sign(text, apiKey.secret);\n return {\n 'KC-API-KEY': apiKey.key,\n 'KC-API-SIGN': signature,\n 'KC-API-TIMESTAMP': timestamp.toString(),\n 'KC-API-PASSPHRASE': sign(apiKey.passphrase || '', apiKey.secret),\n 'Content-Type': 'application/json',\n 'User-Agent': `Kucoin-Universal-Postman-SDK/`,\n 'KC-API-KEY-VERSION': 2,\n };\n}\n\nlet key = pm.environment.get('API_KEY')\nlet secret = pm.environment.get('API_SECRET')\nlet passphrase = pm.environment.get('API_PASSPHRASE')\n\nlet url = pm.request.url.getPathWithQuery()\nlet method = pm.request.method\nlet body = pm.request.body ? pm.request.body.toString() : ''\n\nfor (const index in pm.request.url.path) {\n path = pm.request.url.path[index]\n pathVar = extractPathVariable(path)\n if (pathVar != null) {\n let collectionVariable = pm.collectionVariables.get(pathVar);\n if (collectionVariable != null) {\n url = url.replace(path, collectionVariable)\n } else {\n console.warn('no path variable set: ' + path)\n }\n }\n}\n\nheader = auth({ key: key, passphrase: passphrase, secret: secret }, method, url, body)\n\nfor (const [headerName, headerValue] of Object.entries(header)) {\n pm.request.headers.add({ key: headerName, value: headerValue })\n}" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + } + ] +} \ No newline at end of file diff --git a/sdk/postman/collection-REST.json b/sdk/postman/collection-REST.json new file mode 100644 index 0000000..9baf32c --- /dev/null +++ b/sdk/postman/collection-REST.json @@ -0,0 +1,18921 @@ +{ + "info": { + "_postman_id": "e22e2bc3-0147-4151-9872-e9f6bda04a9c", + "name": "Kucoin REST API", + "description": "For the complete API documentation, please refer to https://www.kucoin.com/docs-new", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Account Info", + "item": [ + { + "name": "Account & Funding", + "item": [ + { + "name": "Get Account Summary Info", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "user-info" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470119)\n\n:::info[Description]\nThis endpoint can be used to obtain account summary information.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| level | integer | User VIP level
|\n| subQuantity | integer | Number of sub-accounts |\n| spotSubQuantity | integer | Number of sub-accounts with spot trading permissions enabled |\n| marginSubQuantity | integer | Number of sub-accounts with margin trading permissions enabled |\n| futuresSubQuantity | integer | Number of sub-accounts with futures trading permissions enabled |\n| optionSubQuantity | integer | Number of sub-accounts with option trading permissions enabled |\n| maxSubQuantity | integer | Max number of sub-accounts = maxDefaultSubQuantity + maxSpotSubQuantity |\n| maxDefaultSubQuantity | integer | Max number of default open sub-accounts (according to VIP level) |\n| maxSpotSubQuantity | integer | Max number of sub-accounts with additional Spot trading permissions |\n| maxMarginSubQuantity | integer | Max number of sub-accounts with additional margin trading permissions |\n| maxFuturesSubQuantity | integer | Max number of sub-accounts with additional futures trading permissions |\n| maxOptionSubQuantity | integer | Max number of sub-accounts with additional Option trading permissions |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "user-info" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get Account Type - Spot ", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "accounts", + "opened" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470120)\n\n:::info[Description]\nThis interface determines whether the current user is a spot high-frequency user or a spot low-frequency user.\n:::\n\n:::tip[Tips]\nThis interface is a compatibility interface left over from the old version upgrade. Only some old users need to use it (high frequency will be opened before 2024 and trade_hf has been used). Most user do not need to use this interface. When the return is true, you need to use trade_hf to transfer assets and query assets When the return is false, you need to use trade to transfer assets and query assets.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | boolean | 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 |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "accounts", + "opened" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": false\n}" + } + ] + }, + { + "name": "Get Account Ledgers - Spot/Margin", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "accounts", + "ledgers" + ], + "query": [ + { + "key": "currency", + "value": "BTC", + "description": "Currency ( you can choose more than one currency). You can specify 10 currencies at most for one time. If not specified, all currencies will be inquired by default." + }, + { + "key": "direction", + "value": "in", + "description": "direction: in, out" + }, + { + "key": "bizType", + "value": "TRANSFER", + "description": "Type: DEPOSIT -deposit, WITHDRAW -withdraw, TRANSFER -transfer, SUB_TRANSFER -subaccount transfer,TRADE_EXCHANGE -trade, MARGIN_EXCHANGE -margin trade, KUCOIN_BONUS -bonus, BROKER_TRANSFER -Broker transfer record" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current request page." + }, + { + "key": "pageSize", + "value": "50", + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470121)\n\n:::info[Description]\nThis interface is for transaction records from all types of your accounts, supporting inquiry of various currencies. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::\n\n:::tip[Tips]\nthe start and end time range cannot exceed 24 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.\n:::\n\n:::tip[Tips]\nSupport to obtain 1 year historical data, if need to obtain longer historical data, please submit a ticket: https://kucoin.zendesk.com/hc/en-us/requests/new\n:::\n\n**context**\n\nIf the returned value under bizType is “trade exchange”, the additional info. (such as order ID and trade ID, trading pair, etc.) of the trade will be returned in field context.\n\n**BizType Description**\n\n| Field | Description |\n| ------ | ---------- |\n| Assets Transferred in After Upgrading | Assets Transferred in After V1 to V2 Upgrading |\n| Deposit | Deposit |\n| Withdrawal | Withdrawal |\n| Transfer | Transfer |\n| Trade_Exchange | Trade |\n| Vote for Coin | Vote for Coin |\n| KuCoin Bonus | KuCoin Bonus |\n| Referral Bonus | Referral Bonus |\n| Rewards | Activities Rewards |\n| Distribution | Distribution, such as get GAS by holding NEO |\n| Airdrop/Fork | Airdrop/Fork |\n| Other rewards | Other rewards, except Vote, Airdrop, Fork |\n| Fee Rebate | Fee Rebate |\n| Buy Crypto | Use credit card to buy crypto |\n| Sell Crypto | Use credit card to sell crypto |\n| Public Offering Purchase | Public Offering Purchase for Spotlight |\n| Send red envelope | Send red envelope |\n| Open red envelope | Open red envelope |\n| Staking | Staking |\n| LockDrop Vesting | LockDrop Vesting |\n| Staking Profits | Staking Profits |\n| Redemption | Redemption |\n| Refunded Fees | Refunded Fees |\n| KCS Pay Fees | KCS Pay Fees |\n| Margin Trade | Margin Trade |\n| Loans | Loans |\n| Borrowings | Borrowings |\n| Debt Repayment | Debt Repayment |\n| Loans Repaid | Loans Repaid |\n| Lendings | Lendings |\n| Pool transactions | Pool-X transactions |\n| Instant Exchange | Instant Exchange |\n| Sub Account Transfer | Sub-account transfer |\n| Liquidation Fees | Liquidation Fees |\n| Soft Staking Profits | Soft Staking Profits |\n| Voting Earnings | Voting Earnings on Pool-X |\n| Redemption of Voting | Redemption of Voting on Pool-X |\n| Convert to KCS | Convert to KCS |\n| BROKER_TRANSFER | Broker transfer record |\n\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | current page |\n| pageSize | integer | page size |\n| totalNum | integer | total number |\n| totalPage | integer | total page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | unique id |\n| currency | string | The currency of an account |\n| amount | string | The total amount of assets (fees included) involved in assets changes such as transaction, withdrawal and bonus distribution. |\n| fee | string | Fees generated in transaction, withdrawal, etc. |\n| balance | string | Remaining funds after the transaction. |\n| accountType | string | The account type of the master user: MAIN, TRADE, MARGIN or CONTRACT. |\n| bizType | string | Business type leading to the changes in funds, such as exchange, withdrawal, deposit, KUCOIN_BONUS, REFERRAL_BONUS, Lendings etc. |\n| direction | string | Side, out or in |\n| createdAt | integer | Time of the event |\n| context | string | Business related information such as order ID, serial No., etc. |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "accounts", + "ledgers" + ], + "query": [ + { + "key": "currency", + "value": "BTC", + "description": "Currency ( you can choose more than one currency). You can specify 10 currencies at most for one time. If not specified, all currencies will be inquired by default." + }, + { + "key": "direction", + "value": "in", + "description": "direction: in, out" + }, + { + "key": "bizType", + "value": "TRANSFER", + "description": "Type: DEPOSIT -deposit, WITHDRAW -withdraw, TRANSFER -transfer, SUB_TRANSFER -subaccount transfer,TRADE_EXCHANGE -trade, MARGIN_EXCHANGE -margin trade, KUCOIN_BONUS -bonus, BROKER_TRANSFER -Broker transfer record" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current request page." + }, + { + "key": "pageSize", + "value": "50", + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get Account Ledgers - Trade_hf", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "accounts", + "ledgers" + ], + "query": [ + { + "key": "currency", + "value": "BTC", + "description": "Currency ( you can choose more than one currency). You can specify 10 currencies at most for one time. If not specified, all currencies will be inquired by default." + }, + { + "key": "direction", + "value": "in", + "description": "direction: in, out" + }, + { + "key": "bizType", + "value": "TRANSFER", + "description": "Transaction type: TRANSFER-transfer funds,TRADE_EXCHANGE-Trade" + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given." + }, + { + "key": "limit", + "value": "100", + "description": "Default100，Max200" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470122)\n\n:::info[Description]\nThis API endpoint returns all transfer (in and out) records in high-frequency trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id.\n:::\n\n\n\n:::tip[Tips]\nIf lastId is configured, the information obtained < lastId. Otherwise, it will go back to the latest information.\n\nYou can only obtain data from within a 3 _ 24 hour time range (i.e., from 3 _ 24 hours ago up to now) If you specify a time range that exceeds this limit, the system will default to data from within 3 * 24 hours.\n:::\n\n**context**\n\nIf the bizType is TRADE_EXCHANGE, the context field will include additional transaction information (order id, transaction id, and trading pair).\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Unique id |\n| currency | string | currency |\n| amount | string | Change in funds balance |\n| fee | string | Deposit or withdrawal fee |\n| tax | string | |\n| balance | string | Total balance of funds after change |\n| accountType | string | Master account type TRADE_HF |\n| bizType | string | Trnasaction type，such as TRANSFER, TRADE_EXCHANGE, etc. |\n| direction | string | Direction of transfer( out or in) |\n| createdAt | string | Created time |\n| context | string | Core transaction parameter |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "accounts", + "ledgers" + ], + "query": [ + { + "key": "currency", + "value": "BTC", + "description": "Currency ( you can choose more than one currency). You can specify 10 currencies at most for one time. If not specified, all currencies will be inquired by default." + }, + { + "key": "direction", + "value": "in", + "description": "direction: in, out" + }, + { + "key": "bizType", + "value": "TRANSFER", + "description": "Transaction type: TRANSFER-transfer funds,TRADE_EXCHANGE-Trade" + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given." + }, + { + "key": "limit", + "value": "100", + "description": "Default100，Max200" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get Account Ledgers - Margin_hf", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "account", + "ledgers" + ], + "query": [ + { + "key": "currency", + "value": "BTC", + "description": "currency, optional，can select more than one，separate with commas，select no more than 10 currencys，the default will be to query for all currencys if left empty" + }, + { + "key": "direction", + "value": "in", + "description": "direction: in, out" + }, + { + "key": "bizType", + "value": "TRANSFER", + "description": "Transaction type: TRANSFER- transfer funds, MARGIN_EXCHANGE - cross margin trade, ISOLATED_EXCHANGE - isolated margin trade, LIQUIDATION - liquidation, ASSERT_RETURN - forced liquidation asset return" + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given." + }, + { + "key": "limit", + "value": "100", + "description": "Default100，Max200" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470123)\n\n:::info[Description]\nThis API endpoint returns all transfer (in and out) records in high-frequency margin trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id.\n:::\n\n\n:::tip[Tips]\nIf lastId is configured, the information obtained < lastId. Otherwise, it will go back to the latest information.\n\nYou can only obtain data from within a 3 _ 24 hour time range (i.e., from 3 _ 24 hours ago up to now) If you specify a time range that exceeds this limit, the system will default to data from within 3 * 24 hours.\n\nIf bizType is MARGIN_EXCHANGE or ISOLATED_EXCHANGE, the context field will contain additional information about the transaction (order id, transaction id, transaction pair).\n:::\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | integer | |\n| currency | string | currency |\n| amount | string | Change in funds balance |\n| fee | string | Deposit or withdrawal fee |\n| balance | string | Total balance of funds after change |\n| accountType | string | Master account type TRADE_HF |\n| bizType | string | Trnasaction type，such as TRANSFER, TRADE_EXCHANGE, etc. |\n| direction | string | Direction of transfer( out or in) |\n| createdAt | integer | Ledger creation time |\n| context | string | Core transaction parameter |\n| tax | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "account", + "ledgers" + ], + "query": [ + { + "key": "currency", + "value": "BTC", + "description": "currency, optional，can select more than one，separate with commas，select no more than 10 currencys，the default will be to query for all currencys if left empty" + }, + { + "key": "direction", + "value": "in", + "description": "direction: in, out" + }, + { + "key": "bizType", + "value": "TRANSFER", + "description": "Transaction type: TRANSFER- transfer funds, MARGIN_EXCHANGE - cross margin trade, ISOLATED_EXCHANGE - isolated margin trade, LIQUIDATION - liquidation, ASSERT_RETURN - forced liquidation asset return" + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given." + }, + { + "key": "limit", + "value": "100", + "description": "Default100，Max200" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": 1949641706720,\n \"currency\": \"USDT\",\n \"amount\": \"0.01000000\",\n \"fee\": \"0.00000000\",\n \"balance\": \"0.01000000\",\n \"accountType\": \"MARGIN_V2\",\n \"bizType\": \"TRANSFER\",\n \"direction\": \"in\",\n \"createdAt\": 1728664091208,\n \"context\": \"{}\",\n \"tax\": \"0.00000000\"\n }\n ]\n}" + } + ] + }, + { + "name": "Get Account Ledgers - Futures", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "transaction-history" + ], + "query": [ + { + "key": "currency", + "value": "XBT", + "description": "Currency of transaction history, XBT or USDT" + }, + { + "key": "type", + "value": "Transferin", + "description": "Type RealisedPNL-Realised profit and loss, Deposit-Deposit, Withdrawal-withdraw, Transferin-Transfer in, TransferOut-Transfer out" + }, + { + "key": "offset", + "value": "254062248624417", + "description": "Start offset. Generally, the only attribute of the last returned result of the previous request is used, and the first page is returned by default" + }, + { + "key": "forward", + "value": "false", + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default" + }, + { + "key": "maxCount", + "value": "50", + "description": "Displayed size per page. The default size is 50" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470124)\n\n:::info[Description]\nThis interface can query the ledger records of the futures business line\n:::\n\n\n\n:::tip[Tips]\nIf there are open positions, the status of the first page returned will be Pending, indicating the realised profit and loss in the current 8-hour settlement period. Please specify the minimum offset number of the current page into the offset field to turn the page.\n:::\n\n:::tip[Tips]\nSupplementary instructions for startAt and endAt: startAt must be less than endAt; and the interval cannot exceed 1 day; only one field is allowed, and if only one field is passed, another field will be automatically added or subtracted by the system 1 day to complete\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| dataList | array | Refer to the schema section of dataList |\n| hasMore | boolean | Is it the last page. If it is false, it means it is the last page, and if it is true, it means need to turn the page. |\n\n**root.data.dataList Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| time | integer | ledger time |\n| type | string | Type: RealisedPNL, Deposit, Withdrawal, TransferIn, TransferOut |\n| amount | number | Transaction amount |\n| fee | number | Fee |\n| accountEquity | number | Account equity |\n| status | string | Status: Completed, Pending |\n| remark | string | Ticker symbol of the contract |\n| offset | integer | Offset |\n| currency | string | Currency |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "transaction-history" + ], + "query": [ + { + "key": "currency", + "value": "XBT", + "description": "Currency of transaction history, XBT or USDT" + }, + { + "key": "type", + "value": "Transferin", + "description": "Type RealisedPNL-Realised profit and loss, Deposit-Deposit, Withdrawal-withdraw, Transferin-Transfer in, TransferOut-Transfer out" + }, + { + "key": "offset", + "value": "254062248624417", + "description": "Start offset. Generally, the only attribute of the last returned result of the previous request is used, and the first page is returned by default" + }, + { + "key": "forward", + "value": "false", + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default" + }, + { + "key": "maxCount", + "value": "50", + "description": "Displayed size per page. The default size is 50" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get Account List - Spot", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "accounts" + ], + "query": [ + { + "key": "currency", + "value": "USDT", + "description": "currency" + }, + { + "key": "type", + "value": "main", + "description": "Account type main、trade" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470125)\n\n:::info[Description]\nGet a list of accounts. Please Deposit to the main account firstly, then transfer the funds to the trade account via Inner Transfer before transaction.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Account ID |\n| currency | string | Currency |\n| type | string | Account type:，main、trade、isolated(abandon)、margin(abandon)
|\n| balance | string | Total funds in the account |\n| available | string | Funds available to withdraw or trade |\n| holds | string | Funds on hold (not available for use) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "accounts" + ], + "query": [ + { + "key": "currency", + "value": "USDT", + "description": "currency" + }, + { + "key": "type", + "value": "main", + "description": "Account type main、trade" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get Account Detail - Spot", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "accounts", + "{{accountId}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470126)\n\n:::info[Description]\nget Information for a single spot account. Use this endpoint when you know the accountId.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | The currency of the account |\n| balance | string | Total funds in the account |\n| available | string | Funds available to withdraw or trade |\n| holds | string | Funds on hold (not available for use) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "accounts", + "{{accountId}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currency\": \"USDT\",\n \"balance\": \"26.66759503\",\n \"available\": \"26.66759503\",\n \"holds\": \"0\"\n }\n}" + } + ] + }, + { + "name": "Get Account - Cross Margin", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "accounts" + ], + "query": [ + { + "key": "quoteCurrency", + "value": "USDT", + "description": "quote currency, currently only supports USDT, KCS, BTC, USDT as default" + }, + { + "key": "queryType", + "value": "MARGIN", + "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" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470127)\n\n:::info[Description]\nRequest via this endpoint to get the info of the cross margin account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| totalAssetOfQuoteCurrency | string | Total Assets in Quote Currency |\n| totalLiabilityOfQuoteCurrency | string | Total Liability in Quote Currency |\n| debtRatio | string | debt ratio |\n| status | string | Position status; EFFECTIVE-effective, BANKRUPTCY-bankruptcy liquidation, LIQUIDATION-closing, REPAY-repayment, BORROW borrowing |\n| accounts | array | Refer to the schema section of accounts |\n\n**root.data.accounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| total | string | Total Assets |\n| available | string | Account available assets (total assets - frozen) |\n| hold | string | Account frozen assets |\n| liability | string | Liabilities |\n| maxBorrowSize | string | The user's remaining maximum loan amount |\n| borrowEnabled | boolean | Support borrow or not |\n| transferInEnabled | boolean | Support transfer or not |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "accounts" + ], + "query": [ + { + "key": "quoteCurrency", + "value": "USDT", + "description": "quote currency, currently only supports USDT, KCS, BTC, USDT as default" + }, + { + "key": "queryType", + "value": "MARGIN", + "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" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"totalAssetOfQuoteCurrency\": \"0.02\",\n \"totalLiabilityOfQuoteCurrency\": \"0\",\n \"debtRatio\": \"0\",\n \"status\": \"EFFECTIVE\",\n \"accounts\": [\n {\n \"currency\": \"USDT\",\n \"total\": \"0.02\",\n \"available\": \"0.02\",\n \"hold\": \"0\",\n \"liability\": \"0\",\n \"maxBorrowSize\": \"0\",\n \"borrowEnabled\": true,\n \"transferInEnabled\": true\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Account - Isolated Margin", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "isolated", + "accounts" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "For isolated trading pairs, query all without passing" + }, + { + "key": "quoteCurrency", + "value": "USDT", + "description": "quote currency, currently only supports USDT, KCS, BTC, USDT as default" + }, + { + "key": "queryType", + "value": "ISOLATED", + "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" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470128)\n\n:::info[Description]\nRequest via this endpoint to get the info of the isolated margin account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| totalAssetOfQuoteCurrency | string | Total Assets in Quote Currency |\n| totalLiabilityOfQuoteCurrency | string | Total Liability in Quote Currency |\n| timestamp | integer | timestamp |\n| assets | array | Refer to the schema section of assets |\n\n**root.data.assets Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol |\n| status | string | Position status; EFFECTIVE-effective, BANKRUPTCY-bankruptcy liquidation, LIQUIDATION-closing, REPAY-repayment, BORROW borrowing |\n| debtRatio | string | debt ratio |\n| baseAsset | object | Refer to the schema section of baseAsset |\n| quoteAsset | object | Refer to the schema section of quoteAsset |\n\n**root.data.assets.baseAsset Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| borrowEnabled | boolean | Support borrow or not |\n| transferInEnabled | boolean | Support transfer or not |\n| liability | string | Liabilities |\n| total | string | Total Assets |\n| available | string | Account available assets (total assets - frozen) |\n| hold | string | Account frozen assets |\n| maxBorrowSize | string | The user's remaining maximum loan amount |\n\n**root.data.assets.baseAsset.quoteAsset Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| borrowEnabled | boolean | Support borrow or not |\n| transferInEnabled | boolean | Support transfer or not |\n| liability | string | Liabilities |\n| total | string | Total Assets |\n| available | string | Account available assets (total assets - frozen) |\n| hold | string | Account frozen assets |\n| maxBorrowSize | string | The user's remaining maximum loan amount |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "isolated", + "accounts" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "For isolated trading pairs, query all without passing" + }, + { + "key": "quoteCurrency", + "value": "USDT", + "description": "quote currency, currently only supports USDT, KCS, BTC, USDT as default" + }, + { + "key": "queryType", + "value": "ISOLATED", + "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" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"totalAssetOfQuoteCurrency\": \"0.01\",\n \"totalLiabilityOfQuoteCurrency\": \"0\",\n \"timestamp\": 1728725465994,\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 \"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\",\n \"total\": \"0.01\",\n \"available\": \"0.01\",\n \"hold\": \"0\",\n \"maxBorrowSize\": \"0\"\n }\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Account - Futures", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "account-overview" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "Currecny, Default XBT" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470129)\n\n:::info[Description]\nRequest via this endpoint to get the info of the futures account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| accountEquity | number | Account equity = marginBalance + Unrealised PNL |\n| unrealisedPNL | number | Unrealised profit and loss |\n| marginBalance | number | Margin balance = positionMargin + orderMargin + frozenFunds + availableBalance - unrealisedPNL |\n| positionMargin | number | Position margin |\n| orderMargin | number | Order margin |\n| frozenFunds | number | Frozen funds for out-transfer |\n| availableBalance | number | Available balance |\n| currency | string | Currency |\n| riskRatio | number | Cross margin risk rate |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "account-overview" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "Currecny, Default XBT" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currency\": \"USDT\",\n \"accountEquity\": 48.921913718,\n \"unrealisedPNL\": 1.59475,\n \"marginBalance\": 47.548728628,\n \"positionMargin\": 34.1577964733,\n \"orderMargin\": 0,\n \"frozenFunds\": 0,\n \"availableBalance\": 14.7876172447,\n \"riskRatio\": 0.0090285199\n }\n}" + } + ] + }, + { + "name": "Get Apikey Info", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "user", + "api-key" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470130)\n\n:::info[Description]\nGet the information of the api key. Use the api key pending to be checked to call the endpoint. Both master and sub user's api key are applicable.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| remark | string | Remarks |\n| apiKey | string | Apikey |\n| apiVersion | integer | API Version |\n| permission | string | [Permissions](https://www.kucoin.com/docs-new/doc-338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn |\n| ipWhitelist | string | IP whitelist

|\n| createdAt | integer | Apikey create time |\n| uid | integer | Account UID |\n| isMaster | boolean | Whether it is the master account. |\n| subName | string | Sub Name, There is no such param for the master account |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "user", + "api-key" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + } + ], + "description": "" + }, + { + "name": "Sub Account", + "item": [ + { + "name": "Get SubAccount List - Summary Info", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "sub", + "user" + ], + "query": [ + { + "key": "currentPage", + "value": "1", + "description": "Current request page. Default is 1" + }, + { + "key": "pageSize", + "value": "10", + "description": "Number of results per request. Minimum is 1, maximum is 100, default is 10." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470131)\n\n:::info[Description]\nThis endpoint can be used to get a paginated list of sub-accounts. Pagination is required.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | Current request page |\n| pageSize | integer | Number of results per request. Minimum is 1, maximum is 100 |\n| totalNum | integer | Total number of messages |\n| totalPage | integer | Total number of page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| userId | string | Sub-account User Id |\n| uid | integer | Sub-account UID |\n| subName | string | Sub-account name |\n| status | integer | Sub-account; 2:Enable, 3:Frozen |\n| type | integer | Sub-account type |\n| access | string | Sub-account Permission |\n| createdAt | integer | Time of the event |\n| remarks | string | Remarks |\n| tradeTypes | array | Refer to the schema section of tradeTypes |\n| openedTradeTypes | array | Refer to the schema section of openedTradeTypes |\n| hostedStatus | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "sub", + "user" + ], + "query": [ + { + "key": "currentPage", + "value": "1", + "description": "Current request page. Default is 1" + }, + { + "key": "pageSize", + "value": "10", + "description": "Number of results per request. Minimum is 1, maximum is 100, default is 10." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get SubAccount Detail - Balance", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub-accounts", + "{{subUserId}}" + ], + "query": [ + { + "key": "includeBaseAmount", + "value": "false", + "description": "false: do not display the currency which asset is 0, true: display all currency" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470132)\n\n:::info[Description]\nThis endpoint returns the account info of a sub-user specified by the subUserId.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| subUserId | string | The user ID of a sub-user. |\n| subName | string | The username of a sub-user. |\n| mainAccounts | array | Refer to the schema section of mainAccounts |\n| tradeAccounts | array | Refer to the schema section of tradeAccounts |\n| marginAccounts | array | Refer to the schema section of marginAccounts |\n| tradeHFAccounts | array | Refer to the schema section of tradeHFAccounts |\n\n**root.data.mainAccounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| balance | string | Total funds in an account. |\n| available | string | Funds available to withdraw or trade. |\n| holds | string | Funds on hold (not available for use). |\n| baseCurrency | string | Calculated on this currency. |\n| baseCurrencyPrice | string | The base currency price. |\n| baseAmount | string | The base currency amount. |\n| tag | string | |\n\n**root.data.mainAccounts.tradeAccounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| balance | string | Total funds in an account. |\n| available | string | Funds available to withdraw or trade. |\n| holds | string | Funds on hold (not available for use). |\n| baseCurrency | string | Calculated on this currency. |\n| baseCurrencyPrice | string | The base currency price. |\n| baseAmount | string | The base currency amount. |\n| tag | string | |\n\n**root.data.mainAccounts.tradeAccounts.marginAccounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| balance | string | Total funds in an account. |\n| available | string | Funds available to withdraw or trade. |\n| holds | string | Funds on hold (not available for use). |\n| baseCurrency | string | Calculated on this currency. |\n| baseCurrencyPrice | string | The base currency price. |\n| baseAmount | string | The base currency amount. |\n| tag | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub-accounts", + "{{subUserId}}" + ], + "query": [ + { + "key": "includeBaseAmount", + "value": "false", + "description": "false: do not display the currency which asset is 0, true: display all currency" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get SubAccount List - Spot Balance(V2)", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "sub-accounts" + ], + "query": [ + { + "key": "currentPage", + "value": "1", + "description": "Current request page. Default is 1" + }, + { + "key": "pageSize", + "value": "10", + "description": "Number of results per request. Minimum is 10, maximum is 100, default is 10.\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470133)\n\n:::info[Description]\nThis endpoint can be used to get paginated Spot sub-account information. Pagination is required.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | |\n| pageSize | integer | |\n| totalNum | integer | |\n| totalPage | integer | |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| subUserId | string | The user ID of the sub-user. |\n| subName | string | The username of the sub-user. |\n| mainAccounts | array | Refer to the schema section of mainAccounts |\n| tradeAccounts | array | Refer to the schema section of tradeAccounts |\n| marginAccounts | array | Refer to the schema section of marginAccounts |\n| tradeHFAccounts | array | Refer to the schema section of tradeHFAccounts |\n\n**root.data.items.mainAccounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | The currency of the account. |\n| balance | string | Total funds in the account. |\n| available | string | Funds available to withdraw or trade. |\n| holds | string | Funds on hold (not available for use). |\n| baseCurrency | string | Calculated on this currency. |\n| baseCurrencyPrice | string | The base currency price. |\n| baseAmount | string | The base currency amount. |\n| tag | string | |\n\n**root.data.items.mainAccounts.tradeAccounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | The currency of the account. |\n| balance | string | Total funds in the account. |\n| available | string | Funds available to withdraw or trade. |\n| holds | string | Funds on hold (not available for use). |\n| baseCurrency | string | Calculated on this currency. |\n| baseCurrencyPrice | string | The base currency price. |\n| baseAmount | string | The base currency amount. |\n| tag | string | |\n\n**root.data.items.mainAccounts.tradeAccounts.marginAccounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | The currency of the account. |\n| balance | string | Total funds in the account. |\n| available | string | Funds available to withdraw or trade. |\n| holds | string | Funds on hold (not available for use). |\n| baseCurrency | string | Calculated on this currency. |\n| baseCurrencyPrice | string | The base currency price. |\n| baseAmount | string | The base currency amount. |\n| tag | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "sub-accounts" + ], + "query": [ + { + "key": "currentPage", + "value": "1", + "description": "Current request page. Default is 1" + }, + { + "key": "pageSize", + "value": "10", + "description": "Number of results per request. Minimum is 10, maximum is 100, default is 10.\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Get SubAccount List - Futures Balance(V2)", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "account-overview-all" + ], + "query": [ + { + "key": "currency", + "value": "USDT", + "description": "Currecny, Default XBT" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470134)\n\n:::info[Description]\nThis endpoint can be used to get Futures sub-account information. \n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| summary | object | Refer to the schema section of summary |\n| accounts | array | Refer to the schema section of accounts |\n\n**root.data.summary Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| accountEquityTotal | number | Total Account Equity |\n| unrealisedPNLTotal | number | Total unrealisedPNL |\n| marginBalanceTotal | number | Total Margin Balance |\n| positionMarginTotal | number | Total Position margin |\n| orderMarginTotal | number | |\n| frozenFundsTotal | number | Total frozen funds for withdrawal and out-transfer |\n| availableBalanceTotal | number | total available balance |\n| currency | string | |\n\n**root.data.summary.accounts Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| accountName | string | Account name, main account is main |\n| accountEquity | number | |\n| unrealisedPNL | number | |\n| marginBalance | number | |\n| positionMargin | number | |\n| orderMargin | number | |\n| frozenFunds | number | |\n| availableBalance | number | |\n| currency | string | currency |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "account-overview-all" + ], + "query": [ + { + "key": "currency", + "value": "USDT", + "description": "Currecny, Default XBT" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Add SubAccount", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "sub", + "user", + "created" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470135)\n\n:::info[Description]\nThis endpoint can be used to create sub-accounts.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| password | string | Password(7-24 characters, must contain letters and numbers, cannot only contain numbers or include special characters) |\n| remarks | string | Remarks(1~24 characters) |\n| subName | string | Sub-account name(must contain 7-32 characters, at least one number and one letter. Cannot contain any spaces.) |\n| access | string | Permission (types include Spot, Futures, Margin permissions, which can be used alone or in combination). |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| uid | integer | Sub-account UID |\n| subName | string | Sub-account name |\n| remarks | string | Remarks |\n| access | string | Permission |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"password\": \"1234567\",\n \"remarks\": \"TheRemark\",\n \"subName\": \"Name1234567\",\n \"access\": \"Spot\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "sub", + "user", + "created" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Add SubAccount Margin Permission", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "sub", + "user", + "margin", + "enable" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470331)\n\n:::info[Description]\nThis endpoint can be used to add sub-accounts Margin permission. Before using this endpoints, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| uid | string | Sub account UID |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | string | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"uid\": \"169579801\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "sub", + "user", + "margin", + "enable" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": null\n}" + } + ] + }, + { + "name": "Add SubAccount Futures Permission", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "sub", + "user", + "futures", + "enable" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470332)\n\n:::info[Description]\nThis endpoint can be used to add sub-accounts Futures permission. Before using this endpoints, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| uid | string | Sub account UID |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | boolean | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"uid\": \"169579801\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "sub", + "user", + "futures", + "enable" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": null\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Sub Account API", + "item": [ + { + "name": "Get SubAccount API List", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub", + "api-key" + ], + "query": [ + { + "key": "apiKey", + "value": "", + "description": "API-Key" + }, + { + "key": "subName", + "value": "testapi6", + "description": "Sub-account name." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470136)\n\n:::info[Description]\nThis endpoint can be used to obtain a list of APIs pertaining to a sub-account.(Not contain ND Broker Sub Account)\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| subName | string | Sub Name |\n| remark | string | Remarks |\n| apiKey | string | API Key |\n| apiVersion | integer | API Version |\n| permission | string | [Permissions](https://www.kucoin.com/docs-new/doc-338144) |\n| ipWhitelist | string | IP whitelist |\n| createdAt | integer | Apikey create time |\n| uid | integer | Sub-account UID |\n| isMaster | boolean | Whether it is the master account. |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub", + "api-key" + ], + "query": [ + { + "key": "apiKey", + "value": "", + "description": "API-Key" + }, + { + "key": "subName", + "value": "testapi6", + "description": "Sub-account name." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Delete SubAccount API", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub", + "api-key" + ], + "query": [ + { + "key": "apiKey", + "value": "670621e3a25958000159c82f", + "description": "API-Key" + }, + { + "key": "subName", + "value": "testapi6", + "description": "Sub-account name." + }, + { + "key": "passphrase", + "value": "11223344", + "description": "Password(Password of the API key)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470137)\n\n:::info[Description]\nThis endpoint can be used to delete sub-account APIs.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| subName | string | The username of a sub-user. |\n| apiKey | string | The APIKEY of a sub-user. |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub", + "api-key" + ], + "query": [ + { + "key": "apiKey", + "value": "670621e3a25958000159c82f", + "description": "API-Key" + }, + { + "key": "subName", + "value": "testapi6", + "description": "Sub-account name." + }, + { + "key": "passphrase", + "value": "11223344", + "description": "Password(Password of the API key)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"subName\": \"testapi6\",\n \"apiKey\": \"670621e3a25958000159c82f\"\n }\n}" + } + ] + }, + { + "name": "Add SubAccount API", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub", + "api-key" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470138)\n\n:::info[Description]\nThis endpoint can be used to create APIs for sub-accounts.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| passphrase | string | Password(Must contain 7-32 characters. Cannot contain any spaces.) |\n| remark | string | Remarks(1~24 characters) |\n| permission | string | [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\") |\n| ipWhitelist | string | IP whitelist(You may add up to 20 IPs. Use a halfwidth comma to each IP) |\n| expire | string | API expiration time; Never expire(default)-1，30Day30，90Day90，180Day180，360Day360 |\n| subName | string | Sub-account name, create sub account name of API Key. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| subName | string | Sub-account name |\n| remark | string | Remarks |\n| apiKey | string | API Key |\n| apiSecret | string | API Secret Key
|\n| apiVersion | integer | API Version |\n| passphrase | string | Password |\n| permission | string | [Permissions](https://www.kucoin.com/docs-new/doc-338144) |\n| ipWhitelist | string | IP whitelist |\n| createdAt | integer | Time of the event |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"subName\": \"testapi6\",\n \"passphrase\": \"11223344\",\n \"remark\": \"TheRemark\",\n \"permission\": \"General,Spot,Futures\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub", + "api-key" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Modify SubAccount API", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub", + "api-key", + "update" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470139)\n\n:::info[Description]\nThis endpoint can be used to modify sub-account APIs.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| passphrase | string | Password(Must contain 7-32 characters. Cannot contain any spaces.) |\n| permission | string | [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\") |\n| ipWhitelist | string | IP whitelist(You may add up to 20 IPs. Use a halfwidth comma to each IP) |\n| expire | string | API expiration time; Never expire(default)-1，30Day30，90Day90，180Day180，360Day360 |\n| subName | string | Sub-account name, create sub account name of API Key. |\n| apiKey | string | API-Key(Sub-account APIKey) |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| subName | string | Sub-account name |\n| apiKey | string | API Key |\n| permission | string | [Permissions](https://www.kucoin.com/docs-new/doc-338144) |\n| ipWhitelist | string | IP whitelist |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"subName\": \"testapi6\",\n \"apiKey\": \"670621e3a25958000159c82f\",\n \"passphrase\": \"11223344\",\n \"permission\": \"General,Spot,Futures\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "sub", + "api-key", + "update" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"subName\": \"testapi6\",\n \"apiKey\": \"670621e3a25958000159c82f\",\n \"permission\": \"General,Futures,Spot\"\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Deposit", + "item": [ + { + "name": "Get Deposit Address(V3)", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "deposit-addresses" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "amount", + "value": null, + "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." + }, + { + "key": "chain", + "value": null, + "description": "The chain Id of currency." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470140)\n\n:::info[Description]\nGet all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| address | string | Deposit address |\n| memo | string | Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious. |\n| chainId | string | The chainId of currency |\n| to | string | Deposit account type: main (funding account), trade (spot trading account) |\n| expirationDate | integer | Expiration time, Lightning network expiration time, non-Lightning network this field is invalid |\n| currency | string | currency |\n| contractAddress | string | The token contract address. |\n| chainName | string | The chainName of currency |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "deposit-addresses" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "amount", + "value": null, + "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." + }, + { + "key": "chain", + "value": null, + "description": "The chain Id of currency." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"address\": \"TSv3L1fS7yA3SxzKD8c1qdX4nLP6rqNxYz\",\n \"memo\": \"\",\n \"chainId\": \"trx\",\n \"to\": \"TRADE\",\n \"expirationDate\": 0,\n \"currency\": \"USDT\",\n \"contractAddress\": \"TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t\",\n \"chainName\": \"TRC20\"\n },\n {\n \"address\": \"0x551e823a3b36865e8c5dc6e6ac6cc0b00d98533e\",\n \"memo\": \"\",\n \"chainId\": \"kcc\",\n \"to\": \"TRADE\",\n \"expirationDate\": 0,\n \"currency\": \"USDT\",\n \"contractAddress\": \"0x0039f574ee5cc39bdd162e9a88e3eb1f111baf48\",\n \"chainName\": \"KCC\"\n },\n {\n \"address\": \"EQCA1BI4QRZ8qYmskSRDzJmkucGodYRTZCf_b9hckjla6dZl\",\n \"memo\": \"2085202643\",\n \"chainId\": \"ton\",\n \"to\": \"TRADE\",\n \"expirationDate\": 0,\n \"currency\": \"USDT\",\n \"contractAddress\": \"EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs\",\n \"chainName\": \"TON\"\n },\n {\n \"address\": \"0x0a2586d5a901c8e7e68f6b0dc83bfd8bd8600ff5\",\n \"memo\": \"\",\n \"chainId\": \"eth\",\n \"to\": \"MAIN\",\n \"expirationDate\": 0,\n \"currency\": \"USDT\",\n \"contractAddress\": \"0xdac17f958d2ee523a2206206994597c13d831ec7\",\n \"chainName\": \"ERC20\"\n }\n ]\n}" + } + ] + }, + { + "name": "Get Deposit History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "deposits" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "status", + "value": "SUCCESS", + "description": "Status. Available value: PROCESSING, SUCCESS, and FAILURE" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current request page." + }, + { + "key": "pageSize", + "value": "50", + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470141)\n\n:::info[Description]\nRequest via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | current page |\n| pageSize | integer | page size |\n| totalNum | integer | total number |\n| totalPage | integer | total page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| chain | string | The chainName of currency |\n| status | string | Status |\n| address | string | Deposit address |\n| memo | string | Address remark. If there’s no remark, it is empty. |\n| isInner | boolean | Internal deposit or not |\n| amount | string | Deposit amount |\n| fee | string | Fees charged for deposit |\n| walletTxId | string | Wallet Txid |\n| createdAt | integer | Creation time of the database record |\n| updatedAt | integer | Update time of the database record |\n| remark | string | remark |\n| arrears | boolean | 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. |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "deposits" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "status", + "value": "SUCCESS", + "description": "Status. Available value: PROCESSING, SUCCESS, and FAILURE" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current request page." + }, + { + "key": "pageSize", + "value": "50", + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Add Deposit Address(V3)", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "deposit-address", + "create" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470142)\n\n:::info[Description]\nRequest via this endpoint to create a deposit address for a currency you intend to deposit.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| chain | string | The chainId of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20, default is ERC20. The available value for BTC are Native, Segwit, TRC20, the parameters are bech32, btc, trx, default is Native. This only apply for multi-chain currency, and there is no need for single chain currency. |\n| to | string | Deposit account type: main (funding account), trade (spot trading account), the default is main |\n| amount | string | 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. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| address | string | Deposit address |\n| memo | string | Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious. |\n| chainId | string | The chainId of currency |\n| to | string | Deposit account type: main (funding account), trade (spot trading account) |\n| expirationDate | integer | Expiration time, Lightning network expiration time, non-Lightning network this field is invalid |\n| currency | string | currency |\n| chainName | string | The chainName of currency |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"TON\",\n \"chain\": \"ton\",\n \"to\": \"trade\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "deposit-address", + "create" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"address\": \"EQCA1BI4QRZ8qYmskSRDzJmkucGodYRTZCf_b9hckjla6dZl\",\n \"memo\": \"2090821203\",\n \"chainId\": \"ton\",\n \"to\": \"TRADE\",\n \"expirationDate\": 0,\n \"currency\": \"TON\",\n \"chainName\": \"TON\"\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Withdrawals", + "item": [ + { + "name": "Get Withdrawal Quotas", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "withdrawals", + "quotas" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "chain", + "value": null, + "description": "The chainId of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20, default is ERC20. The available value for BTC are Native, Segwit, TRC20, the parameters are bech32, btc, trx, default is Native. This only apply for multi-chain currency, and there is no need for single chain currency." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470143)\n\n:::info[Description]\nThis interface can obtain the withdrawal quotas information of this currency.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | |\n| limitBTCAmount | string | |\n| usedBTCAmount | string | |\n| quotaCurrency | string | withdrawal limit currency |\n| limitQuotaCurrencyAmount | string | The intraday available withdrawal amount(withdrawal limit currency) |\n| usedQuotaCurrencyAmount | string | The intraday cumulative withdrawal amount(withdrawal limit currency) |\n| remainAmount | string | Remaining amount available to withdraw the current day
|\n| availableAmount | string | Current available withdrawal amount |\n| withdrawMinFee | string | Minimum withdrawal fee |\n| innerWithdrawMinFee | string | Fees for internal withdrawal |\n| withdrawMinSize | string | Minimum withdrawal amount |\n| isWithdrawEnabled | boolean | Is the withdraw function enabled or not |\n| precision | integer | Floating point precision. |\n| chain | string | The chainName of currency |\n| reason | string | Reasons for restriction, Usually empty |\n| lockedAmount | string | Total locked amount (including the amount locked into USDT for each currency) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "withdrawals", + "quotas" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "chain", + "value": null, + "description": "The chainId of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20, default is ERC20. The available value for BTC are Native, Segwit, TRC20, the parameters are bech32, btc, trx, default is Native. This only apply for multi-chain currency, and there is no need for single chain currency." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currency\": \"BTC\",\n \"limitBTCAmount\": \"15.79590095\",\n \"usedBTCAmount\": \"0.00000000\",\n \"quotaCurrency\": \"USDT\",\n \"limitQuotaCurrencyAmount\": \"999999.00000000\",\n \"usedQuotaCurrencyAmount\": \"0\",\n \"remainAmount\": \"15.79590095\",\n \"availableAmount\": \"0\",\n \"withdrawMinFee\": \"0.0005\",\n \"innerWithdrawMinFee\": \"0\",\n \"withdrawMinSize\": \"0.001\",\n \"isWithdrawEnabled\": true,\n \"precision\": 8,\n \"chain\": \"BTC\",\n \"reason\": null,\n \"lockedAmount\": \"0\"\n }\n}" + } + ] + }, + { + "name": "Cancel Withdrawal", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "withdrawals", + "{{withdrawalId}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470144)\n\n:::info[Description]\nThis interface can cancel the withdrawal, Only withdrawals requests of PROCESSING status could be canceled.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "withdrawals", + "{{withdrawalId}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": null\n}" + } + ] + }, + { + "name": "Get Withdrawal History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "withdrawals" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "status", + "value": "SUCCESS", + "description": "Status. Available value: PROCESSING, WALLET_PROCESSING, SUCCESS, and FAILURE" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current request page." + }, + { + "key": "pageSize", + "value": "50", + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470145)\n\n:::info[Description]\nRequest via this endpoint to get withdrawal list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | current page |\n| pageSize | integer | page size |\n| totalNum | integer | total number |\n| totalPage | integer | total page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Unique id |\n| currency | string | Currency |\n| chain | string | The id of currency |\n| status | string | Status |\n| address | string | Deposit address |\n| memo | string | Address remark. If there’s no remark, it is empty. |\n| isInner | boolean | Internal deposit or not |\n| amount | string | Deposit amount |\n| fee | string | Fees charged for deposit |\n| walletTxId | string | Wallet Txid |\n| createdAt | integer | Creation time of the database record |\n| updatedAt | integer | Update time of the database record |\n| remark | string | remark |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "withdrawals" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "status", + "value": "SUCCESS", + "description": "Status. Available value: PROCESSING, WALLET_PROCESSING, SUCCESS, and FAILURE" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current request page." + }, + { + "key": "pageSize", + "value": "50", + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\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}" + } + ] + }, + { + "name": "Withdraw(V3)", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "withdrawals" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470146)\n\n:::info[Description]\nUse this interface to withdraw the specified currency\n:::\n\n:::tip[Tips]\nOn the WEB end, you can open the switch of specified favorite addresses for withdrawal, and when it is turned on, it will verify whether your withdrawal address(including chain) is a favorite address(it is case sensitive); if it fails validation, it will respond with the error message {\"msg\":\"Already set withdraw whitelist, this address is not favorite address\",\"code\":\"260325\"}.\n:::\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| chain | string | The chainId of currency, For a currency with multiple chains, it is recommended to specify chain parameter instead of using the default chain; you can query the chainId through the response of the GET /api/v3/currencies/{currency} interface. |\n| amount | integer | Withdrawal amount, a positive number which is a multiple of the amount precision |\n| memo | string | Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious. |\n| isInner | boolean | Internal withdrawal or not. Default : false |\n| remark | string | remark |\n| feeDeductType | string | Withdrawal fee deduction type: INTERNAL or EXTERNAL or not specified

1. INTERNAL- deduct the transaction fees from your withdrawal amount
2. EXTERNAL- deduct the transaction fees from your main account
3. 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. |\n| toAddress | string | Withdrawal address |\n| withdrawType | string | Withdrawal type, ADDRESS (withdrawal address), UID, MAIL (email), PHONE (mobile phone number). Note: If you withdraw by uid/mail/phone, there will have rate limited: 3 times/10 seconds, 50 times/24 hours (calculated on a rolling basis based on the first request time) |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| withdrawalId | string | Withdrawal id, a unique ID for a withdrawal |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\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}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "withdrawals" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"withdrawalId\": \"670deec84d64da0007d7c946\"\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Transfer", + "item": [ + { + "name": "Flex Transfer", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "accounts", + "universal-transfer" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470147)\n\n:::info[Description]\nThis interface can be used for transfers between master and sub accounts and inner transfers\n:::\n\n\n\nThe API Key needs to have universal transfer permission when calling.\n\nSupport internal transfer,do not support transfers between sub-accounts.\n\nSupport transfer between master and sub accounts (only applicable to master account APIKey).\n\nMARGIN_V2 only supports internal transfers between MARGIN and does not support transfers between master and sub accounts.\n\nISOLATED_V2 only supports internal transfers between ISOLATED and does not support transfers between master and sub accounts.\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Unique order id created by users to identify their orders, e.g. UUID, with a maximum length of 128 bits |\n| currency | string | currency |\n| amount | string | Transfer amount, the amount is a positive integer multiple of the currency precision. |\n| fromUserId | string | Transfer out UserId， This is required when transferring sub-account to master-account. It is optional for internal transfers. |\n| fromAccountType | string | Account type：MAIN、TRADE、CONTRACT、MARGIN、ISOLATED、MARGIN_V2、ISOLATED_V2 |\n| fromAccountTag | string | Symbol, required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT |\n| type | string | 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) |\n| toUserId | string | Transfer in UserId， This is required when transferring master-account to sub-account. It is optional for internal transfers. |\n| toAccountType | string | Account type：MAIN、TRADE、CONTRACT、MARGIN、ISOLATED、MARGIN_V2、ISOLATED_V2 |\n| toAccountTag | string | Symbol, required when the account type is ISOLATED or ISOLATED_V2, for example: BTC-USDT |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | Transfer order ID |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//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", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "accounts", + "universal-transfer" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"6705f7248c6954000733ecac\"\n }\n}" + } + ] + }, + { + "name": "Get Transfer Quotas", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "accounts", + "transferable" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "type", + "value": "MAIN", + "description": "The account type:MAIN、TRADE、MARGIN、ISOLATED" + }, + { + "key": "tag", + "value": null, + "description": "Trading pair, required when the account type is ISOLATED; other types are not passed, e.g.: BTC-USDT" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470148)\n\n:::info[Description]\nThis endpoint returns the transferable balance of a specified account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| balance | string | Total funds in an account. |\n| available | string | Funds available to withdraw or trade. |\n| holds | string | Funds on hold (not available for use). |\n| transferable | string | Funds available to transfer. |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "accounts", + "transferable" + ], + "query": [ + { + "key": "currency", + "value": "", + "description": "currency" + }, + { + "key": "type", + "value": "MAIN", + "description": "The account type:MAIN、TRADE、MARGIN、ISOLATED" + }, + { + "key": "tag", + "value": null, + "description": "Trading pair, required when the account type is ISOLATED; other types are not passed, e.g.: BTC-USDT" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currency\": \"USDT\",\n \"balance\": \"10.5\",\n \"available\": \"10.5\",\n \"holds\": \"0\",\n \"transferable\": \"10.5\"\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Trade Fee", + "item": [ + { + "name": "Get Basic Fee - Spot/Margin", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "base-fee" + ], + "query": [ + { + "key": "currencyType", + "value": "", + "description": "Currency type: 0-crypto currency, 1-fiat currency. default is 0-crypto currency\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470149)\n\n:::info[Description]\nThis interface is for the spot/margin basic fee rate of users\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| takerFeeRate | string | Base taker fee rate |\n| makerFeeRate | string | Base maker fee rate |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "base-fee" + ], + "query": [ + { + "key": "currencyType", + "value": "", + "description": "Currency type: 0-crypto currency, 1-fiat currency. default is 0-crypto currency\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"takerFeeRate\": \"0.001\",\n \"makerFeeRate\": \"0.001\"\n }\n}" + } + ] + }, + { + "name": "Get Actual Fee - Spot/Margin", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "trade-fees" + ], + "query": [ + { + "key": "symbols", + "value": "", + "description": "Trading pair (optional, you can inquire fee rates of 10 trading pairs each time at most)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470150)\n\n:::info[Description]\nThis interface is for the actual fee rate of the trading pair. You can inquire about fee rates of 10 trading pairs each time at most. The fee rate of your sub-account is the same as that of the master account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | The unique identity of the trading pair and will not change even if the trading pair is renamed |\n| takerFeeRate | string | Actual taker fee rate of the symbol |\n| makerFeeRate | string | Actual maker fee rate of the symbol |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "trade-fees" + ], + "query": [ + { + "key": "symbols", + "value": "", + "description": "Trading pair (optional, you can inquire fee rates of 10 trading pairs each time at most)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"BTC-USDT\",\n \"takerFeeRate\": \"0.001\",\n \"makerFeeRate\": \"0.001\"\n },\n {\n \"symbol\": \"ETH-USDT\",\n \"takerFeeRate\": \"0.001\",\n \"makerFeeRate\": \"0.001\"\n }\n ]\n}" + } + ] + }, + { + "name": "Get Actual Fee - Futures", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "trade-fees" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Trading pair" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470151)\n\n:::info[Description]\nThis interface is for the actual futures fee rate of the trading pair. The fee rate of your sub-account is the same as that of the master account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | The unique identity of the trading pair and will not change even if the trading pair is renamed |\n| takerFeeRate | string | Actual taker fee rate of the trading pair |\n| makerFeeRate | string | Actual maker fee rate of the trading pair |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "trade-fees" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Trading pair" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"XBTUSDTM\",\n \"takerFeeRate\": \"0.0006\",\n \"makerFeeRate\": \"0.0002\"\n }\n}" + } + ] + } + ], + "description": "" + } + ], + "description": "" + }, + { + "name": "Spot Trading", + "item": [ + { + "name": "Market Data", + "item": [ + { + "name": "Get All Currencies", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "currencies" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470152)\n\n:::info[Description]\nRequest via this endpoint to get the currency list. Not all currencies currently can be used for trading.\n:::\n\n:::tip[Tips]\n**CURRENCY CODES**\n\nCurrency codes will conform to the ISO 4217 standard where possible. Currencies which have or had no representation in ISO 4217 may use a custom code.\n\n\n| Code | Description |\n| --- | --- |\n| BTC | Bitcoin |\n| ETH | Ethereum |\n| KCS | Kucoin Shares |\n\nFor a coin, the \"**currency**\" is a fixed value and works as the only recognized identity of the coin. As the \"**name**\", \"**fullnane**\" and \"**precision**\" of a coin are modifiable values, when the \"name\" of a coin is changed, you should use \"**currency**\" to get the coin.\n\nFor example: The \"**currency**\" of XRB is \"XRB\", if the \"**name**\" of XRB is changed into \"**Nano**\", you should use \"XRB\" (the currency of XRB) to search the coin.\n:::\n\n\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | A unique currency code that will never change |\n| name | string | Currency name, will change after renaming |\n| fullName | string | Full name of a currency, will change after renaming |\n| precision | integer | Currency precision |\n| confirms | integer | Number of block confirmations |\n| contractAddress | string | Contract address |\n| isMarginEnabled | boolean | Support margin or not |\n| isDebitEnabled | boolean | Support debit or not |\n| chains | array | Refer to the schema section of chains |\n\n**root.data.chains Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| chainName | string | chain name of currency |\n| withdrawalMinSize | string | Minimum withdrawal amount |\n| depositMinSize | string | Minimum deposit amount |\n| withdrawFeeRate | string | withdraw fee rate |\n| withdrawalMinFee | string | Minimum fees charged for withdrawal |\n| isWithdrawEnabled | boolean | Support withdrawal or not |\n| isDepositEnabled | boolean | Support deposit or not |\n| confirms | integer | Number of block confirmations |\n| preConfirms | integer | The number of blocks (confirmations) for advance on-chain verification |\n| contractAddress | string | Contract address |\n| withdrawPrecision | integer | Withdrawal precision bit, indicating the maximum supported length after the decimal point of the withdrawal amount |\n| maxWithdraw | string | Maximum amount of single withdrawal |\n| maxDeposit | string | Maximum amount of single deposit (only applicable to Lightning Network) |\n| needTag | boolean | whether memo/tag is needed |\n| chainId | string | chain id of currency |\n| depositFeeRate | string | deposit fee rate (some currencies have this param, the default is empty) |\n| withdrawMaxFee | string | withdraw max fee(some currencies have this param, the default is empty) |\n| depositTierFee | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "currencies" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"currency\": \"BTC\",\n \"name\": \"BTC\",\n \"fullName\": \"Bitcoin\",\n \"precision\": 8,\n \"confirms\": null,\n \"contractAddress\": null,\n \"isMarginEnabled\": true,\n \"isDebitEnabled\": true,\n \"chains\": [\n {\n \"chainName\": \"BTC\",\n \"withdrawalMinSize\": \"0.001\",\n \"depositMinSize\": \"0.0002\",\n \"withdrawFeeRate\": \"0\",\n \"withdrawalMinFee\": \"0.0005\",\n \"isWithdrawEnabled\": true,\n \"isDepositEnabled\": true,\n \"confirms\": 3,\n \"preConfirms\": 1,\n \"contractAddress\": \"\",\n \"withdrawPrecision\": 8,\n \"maxWithdraw\": null,\n \"maxDeposit\": null,\n \"needTag\": false,\n \"chainId\": \"btc\"\n },\n {\n \"chainName\": \"Lightning Network\",\n \"withdrawalMinSize\": \"0.00001\",\n \"depositMinSize\": \"0.00001\",\n \"withdrawFeeRate\": \"0\",\n \"withdrawalMinFee\": \"0.000015\",\n \"isWithdrawEnabled\": true,\n \"isDepositEnabled\": true,\n \"confirms\": 1,\n \"preConfirms\": 1,\n \"contractAddress\": \"\",\n \"withdrawPrecision\": 8,\n \"maxWithdraw\": null,\n \"maxDeposit\": \"0.03\",\n \"needTag\": false,\n \"chainId\": \"btcln\"\n },\n {\n \"chainName\": \"KCC\",\n \"withdrawalMinSize\": \"0.0008\",\n \"depositMinSize\": null,\n \"withdrawFeeRate\": \"0\",\n \"withdrawalMinFee\": \"0.00002\",\n \"isWithdrawEnabled\": true,\n \"isDepositEnabled\": true,\n \"confirms\": 20,\n \"preConfirms\": 20,\n \"contractAddress\": \"0xfa93c12cd345c658bc4644d1d4e1b9615952258c\",\n \"withdrawPrecision\": 8,\n \"maxWithdraw\": null,\n \"maxDeposit\": null,\n \"needTag\": false,\n \"chainId\": \"kcc\"\n },\n {\n \"chainName\": \"BTC-Segwit\",\n \"withdrawalMinSize\": \"0.0008\",\n \"depositMinSize\": \"0.0002\",\n \"withdrawFeeRate\": \"0\",\n \"withdrawalMinFee\": \"0.0005\",\n \"isWithdrawEnabled\": false,\n \"isDepositEnabled\": true,\n \"confirms\": 2,\n \"preConfirms\": 2,\n \"contractAddress\": \"\",\n \"withdrawPrecision\": 8,\n \"maxWithdraw\": null,\n \"maxDeposit\": null,\n \"needTag\": false,\n \"chainId\": \"bech32\"\n }\n ]\n },\n {\n \"currency\": \"BTCP\",\n \"name\": \"BTCP\",\n \"fullName\": \"Bitcoin Private\",\n \"precision\": 8,\n \"confirms\": null,\n \"contractAddress\": null,\n \"isMarginEnabled\": false,\n \"isDebitEnabled\": false,\n \"chains\": [\n {\n \"chainName\": \"BTCP\",\n \"withdrawalMinSize\": \"0.100000\",\n \"depositMinSize\": null,\n \"withdrawFeeRate\": \"0\",\n \"withdrawalMinFee\": \"0.010000\",\n \"isWithdrawEnabled\": false,\n \"isDepositEnabled\": false,\n \"confirms\": 6,\n \"preConfirms\": 6,\n \"contractAddress\": \"\",\n \"withdrawPrecision\": 8,\n \"maxWithdraw\": null,\n \"maxDeposit\": null,\n \"needTag\": false,\n \"chainId\": \"btcp\"\n }\n ]\n }\n ]\n}" + } + ] + }, + { + "name": "Get Fiat Price", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "prices" + ], + "query": [ + { + "key": "base", + "value": "", + "description": "Ticker symbol of a base currency,eg.USD,EUR. Default is USD" + }, + { + "key": "currencies", + "value": "", + "description": "Comma-separated cryptocurrencies to be converted into fiat, e.g.: BTC,ETH, etc. Default to return the fiat price of all currencies." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470153)\n\n:::info[Description]\nRequest via this endpoint to get the fiat price of the currencies for the available trading pairs.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| AGLD | string | |\n| DFI | string | |\n| PYTHUP | string | |\n| ISLM | string | |\n| NEAR | string | |\n| AIOZ | string | |\n| AUDIO | string | |\n| BBL | string | |\n| WLD | string | |\n| HNT | string | |\n| ETHFI | string | |\n| DMAIL | string | |\n| OPUP | string | |\n| VET3S | string | |\n| MANA3S | string | |\n| TIDAL | string | |\n| HALO | string | |\n| OPUL | string | |\n| MANA3L | string | |\n| DGB | string | |\n| AA | string | |\n| BCH | string | |\n| GMEE | string | |\n| JST | string | |\n| PBUX | string | |\n| AR | string | |\n| SEI | string | |\n| PSTAKE | string | |\n| LMWR | string | |\n| UNFIDOWN | string | |\n| BB | string | |\n| JTO | string | |\n| WEMIX | string | |\n| G | string | |\n| MARSH | string | |\n| BN | string | |\n| FLIP | string | |\n| FLR | string | |\n| BIGTIME | string | |\n| FLY | string | |\n| T | string | |\n| W | string | |\n| BDX | string | |\n| BABYDOGE | string | |\n| SFP | string | |\n| DIA | string | |\n| ISME | string | |\n| LYM | string | |\n| VET3L | string | |\n| JUP | string | |\n| LYX | string | |\n| AIEPK | string | |\n| SILLY | string | |\n| SCPT | string | |\n| WOO | string | |\n| BLUR | string | |\n| STRK | string | |\n| BFC | string | |\n| DC | string | |\n| KARATE | string | |\n| SUSHI3L | string | |\n| NETVR | string | |\n| WAVES | string | |\n| LITH | string | |\n| HAPI | string | |\n| SUSHI3S | string | |\n| CEEK | string | |\n| FLOKI | string | |\n| SHR | string | |\n| SAND | string | |\n| TURT | string | |\n| UMA | string | |\n| BEPRO | string | |\n| SCRT | string | |\n| TUSD | string | |\n| COOKIE | string | |\n| LRDS | string | |\n| SIN | string | |\n| OAS | string | |\n| ROOT | string | |\n| ADA3L | string | |\n| TIAUP | string | |\n| HTR | string | |\n| UNB | string | |\n| UNA | string | |\n| HARD | string | |\n| G3 | string | |\n| ADA3S | string | |\n| MYRO | string | |\n| HTX | string | |\n| FT | string | |\n| BTCDOWN | string | |\n| UNI | string | |\n| FX | string | |\n| OBI | string | |\n| UNO | string | |\n| WRX | string | |\n| TIADOWN | string | |\n| ETHDOWN | string | |\n| WELL | string | |\n| SWFTC | string | |\n| SKL | string | |\n| UOS | string | |\n| AIPAD | string | |\n| BRETT | string | |\n| SKY | string | |\n| FRM | string | |\n| VISION | string | |\n| LENDS | string | |\n| SLF | string | |\n| BULL | string | |\n| FLOW | string | |\n| ODDZ | string | |\n| SLN | string | |\n| UPO | string | |\n| SLP | string | |\n| ID | string | |\n| SLIM | string | |\n| SPOT | string | |\n| DOP | string | |\n| ISSP | string | |\n| UQC | string | |\n| IO | string | |\n| DOT | string | |\n| 1INCH | string | |\n| SMH | string | |\n| MAK | string | |\n| TOKO | string | |\n| TURBO | string | |\n| UNFI | string | |\n| MAN | string | |\n| EVER | string | |\n| FTM | string | |\n| SHRAP | string | |\n| MAV | string | |\n| MAX | string | |\n| DPR | string | |\n| FTT | string | |\n| ARKM | string | |\n| ATOM | string | |\n| PENDLE | string | |\n| QUICK | string | |\n| BLZ | string | |\n| BOBA | string | |\n| MBL | string | |\n| OFN | string | |\n| UNIO | string | |\n| SNS | string | |\n| SNX | string | |\n| NXRA | string | |\n| TAIKO | string | |\n| AVAX3L | string | |\n| L3 | string | |\n| API3 | string | |\n| XRP3S | string | |\n| QKC | string | |\n| AVAX3S | string | |\n| ROSE | string | |\n| SATS | string | |\n| BMX | string | |\n| PORTAL | string | |\n| TOMI | string | |\n| XRP3L | string | |\n| SOL | string | |\n| SON | string | |\n| BNC | string | |\n| SOCIAL | string | |\n| CGPT | string | |\n| CELR | string | |\n| BNB | string | |\n| OGN | string | |\n| CELO | string | |\n| AUCTION | string | |\n| MANTA | string | |\n| LAYER | string | |\n| AERO | string | |\n| CETUS | string | |\n| LL | string | |\n| SPA | string | |\n| PYTHDOWN | string | |\n| NEIROCTO | string | |\n| UTK | string | |\n| GMRX | string | |\n| BOB | string | |\n| HOTCROSS | string | |\n| AERGO | string | |\n| MOCA | string | |\n| SQD | string | |\n| MV | string | |\n| BNB3L | string | |\n| BNB3S | string | |\n| GALAX3L | string | |\n| KAI | string | |\n| SQR | string | |\n| GALAX3S | string | |\n| EGLD | string | |\n| ZBCN | string | |\n| KAS | string | |\n| MEW | string | |\n| PUNDIX | string | |\n| LOOKS | string | |\n| FXS | string | |\n| BOSON | string | |\n| BRISE | string | |\n| AEVO | string | |\n| FLUX | string | |\n| PRCL | string | |\n| UNFIUP | string | |\n| SEIDOWN | string | |\n| DOAI | string | |\n| QNT | string | |\n| REDO | string | |\n| STRIKE | string | |\n| ETHW | string | |\n| OM | string | |\n| OP | string | |\n| WHALE | string | |\n| 1CAT | string | |\n| NEON | string | |\n| GTAI | string | |\n| SSV | string | |\n| ETH2 | string | |\n| KCS | string | |\n| ARPA | string | |\n| ARTFI | string | |\n| BRL | string | |\n| ALEX | string | |\n| STG | string | |\n| SHIB | string | |\n| IOTX | string | |\n| OLE | string | |\n| KDA | string | |\n| CERE | string | |\n| DOCK | string | |\n| STX | string | |\n| OLT | string | |\n| QI | string | |\n| SDAO | string | |\n| BLAST | string | |\n| LINK3S | string | |\n| IOST | string | |\n| SUI | string | |\n| CAKE | string | |\n| BSW | string | |\n| OMG | string | |\n| VOLT | string | |\n| LINK3L | string | |\n| GEEQ | string | |\n| PYUSD | string | |\n| SUN | string | |\n| TOWER | string | |\n| BTC | string | |\n| IOTA | string | |\n| REEF | string | |\n| TRIAS | string | |\n| KEY | string | |\n| ETH3L | string | |\n| BTT | string | |\n| ONE | string | |\n| RENDER | string | |\n| ETH3S | string | |\n| ANKR | string | |\n| ALGO | string | |\n| SYLO | string | |\n| ZCX | string | |\n| SD | string | |\n| ONT | string | |\n| MJT | string | |\n| DYM | string | |\n| DYP | string | |\n| BAKEUP | string | |\n| OOE | string | |\n| ZELIX | string | |\n| DOGE3L | string | |\n| ARTY | string | |\n| QORPO | string | |\n| ICE | string | |\n| NOTAI | string | |\n| DOGE3S | string | |\n| NAKA | string | |\n| GALAX | string | |\n| MKR | string | |\n| DODO | string | |\n| ICP | string | |\n| ZEC | string | |\n| ZEE | string | |\n| ICX | string | |\n| KMNO | string | |\n| TT | string | |\n| DOT3L | string | |\n| XAI | string | |\n| ZEN | string | |\n| DOGE | string | |\n| ALPHA | string | |\n| DUSK | string | |\n| DOT3S | string | |\n| SXP | string | |\n| HBAR | string | |\n| SYNT | string | |\n| ZEX | string | |\n| BONDLY | string | |\n| MLK | string | |\n| KICKS | string | |\n| PEPE | string | |\n| OUSD | string | |\n| LUNCDOWN | string | |\n| DOGS | string | |\n| REV3L | string | |\n| CTSI | string | |\n| C98 | string | |\n| OSMO | string | |\n| NTRN | string | |\n| CFX2S | string | |\n| SYN | string | |\n| VIDT | string | |\n| SYS | string | |\n| GAS | string | |\n| BOME | string | |\n| COMBO | string | |\n| XCH | string | |\n| VR | string | |\n| CFX2L | string | |\n| VSYS | string | |\n| PANDORA | string | |\n| THETA | string | |\n| XCN | string | |\n| NEXG | string | |\n| MELOS | string | |\n| XCV | string | |\n| ORN | string | |\n| WLKN | string | |\n| AAVE | string | |\n| MNT | string | |\n| BONK | string | |\n| PERP | string | |\n| XDC | string | |\n| MNW | string | |\n| XDB | string | |\n| BOND | string | |\n| SUIA | string | |\n| MOG | string | |\n| SUTER | string | |\n| TIME | string | |\n| RACA | string | |\n| BICO | string | |\n| MON | string | |\n| SWEAT | string | |\n| MOXIE | string | |\n| BABYBNB | string | |\n| IGU | string | |\n| HMSTR | string | |\n| XEC | string | |\n| MONI | string | |\n| XR | string | |\n| PEOPLE | string | |\n| PUMLX | string | |\n| ZIL | string | |\n| WLDDOWN | string | |\n| VAI | string | |\n| XEN | string | |\n| MPC | string | |\n| XEM | string | |\n| JASMY3S | string | |\n| OTK | string | |\n| TRAC | string | |\n| DFYN | string | |\n| BIDP | string | |\n| JASMY3L | string | |\n| INJDOWN | string | |\n| KLV | string | |\n| WAXL | string | |\n| TRBDOWN | string | |\n| BCH3L | string | |\n| GMT3S | string | |\n| KMD | string | |\n| BCH3S | string | |\n| ECOX | string | |\n| AAVE3S | string | |\n| GMT3L | string | |\n| EPIK | string | |\n| SUIP | string | |\n| AAVE3L | string | |\n| ZK | string | |\n| ZKF | string | |\n| OMNIA | string | |\n| ZKJ | string | |\n| ZKL | string | |\n| GAFI | string | |\n| CARV | string | |\n| KNC | string | |\n| CATS | string | |\n| PROM | string | |\n| ALEPH | string | |\n| PONKE | string | |\n| OVR | string | |\n| CATI | string | |\n| ORDER | string | |\n| GFT | string | |\n| BIFI | string | |\n| GGC | string | |\n| GGG | string | |\n| DAPPX | string | |\n| SUKU | string | |\n| ULTI | string | |\n| CREDI | string | |\n| ERTHA | string | |\n| FURY | string | |\n| KARRAT | string | |\n| MOBILE | string | |\n| SIDUS | string | |\n| NAVI | string | |\n| TAO | string | |\n| USDJ | string | |\n| MTL | string | |\n| VET | string | |\n| FITFI | string | |\n| USDT | string | |\n| OXT | string | |\n| CANDY | string | |\n| USDP | string | |\n| MTS | string | |\n| TADA | string | |\n| MTV | string | |\n| NAVX | string | |\n| ILV | string | |\n| VINU | string | |\n| GHX | string | |\n| EDU | string | |\n| HYVE | string | |\n| BTC3L | string | |\n| ANYONE | string | |\n| BEAT | string | |\n| KING | string | |\n| CREAM | string | |\n| CAS | string | |\n| IMX | string | |\n| CAT | string | |\n| BTC3S | string | |\n| USDE | string | |\n| USDD | string | |\n| CWAR | string | |\n| USDC | string | |\n| KRL | string | |\n| INJ | string | |\n| GAME | string | |\n| TRIBL | string | |\n| XLM | string | |\n| TRBUP | string | |\n| VRADOWN | string | |\n| SUPER | string | |\n| EIGEN | string | |\n| IOI | string | |\n| KSM | string | |\n| CCD | string | |\n| EGO | string | |\n| EGP | string | |\n| MXC | string | |\n| TEL | string | |\n| MOVR | string | |\n| XMR | string | |\n| MXM | string | |\n| OORT | string | |\n| GLM | string | |\n| RAY | string | |\n| XTAG | string | |\n| GLQ | string | |\n| CWEB | string | |\n| REVU | string | |\n| REVV | string | |\n| ZRO | string | |\n| XNL | string | |\n| XNO | string | |\n| SAROS | string | |\n| KACE | string | |\n| ZRX | string | |\n| WLTH | string | |\n| ATOM3L | string | |\n| GMM | string | |\n| BEER | string | |\n| GMT | string | |\n| HEART | string | |\n| GMX | string | |\n| ABBC | string | |\n| OMNI | string | |\n| ATOM3S | string | |\n| IRL | string | |\n| CFG | string | |\n| WSDM | string | |\n| GNS | string | |\n| VANRY | string | |\n| CFX | string | |\n| GRAIL | string | |\n| BEFI | string | |\n| VELO | string | |\n| XPR | string | |\n| DOVI | string | |\n| ACE | string | |\n| ACH | string | |\n| ISP | string | |\n| XCAD | string | |\n| MINA | string | |\n| TIA | string | |\n| DRIFT | string | |\n| ACQ | string | |\n| ACS | string | |\n| MIND | string | |\n| STORE | string | |\n| REN | string | |\n| ELA | string | |\n| DREAMS | string | |\n| ADA | string | |\n| ELF | string | |\n| REQ | string | |\n| STORJ | string | |\n| LADYS | string | |\n| PAXG | string | |\n| REZ | string | |\n| XRD | string | |\n| CHO | string | |\n| CHR | string | |\n| ADS | string | |\n| CHZ | string | |\n| ADX | string | |\n| XRP | string | |\n| JASMY | string | |\n| KAGI | string | |\n| FIDA | string | |\n| PBR | string | |\n| AEG | string | |\n| H2O | string | |\n| CHMB | string | |\n| SAND3L | string | |\n| PBX | string | |\n| SOLVE | string | |\n| DECHAT | string | |\n| GARI | string | |\n| SHIB2L | string | |\n| SHIB2S | string | |\n| ENA | string | |\n| VEMP | string | |\n| ENJ | string | |\n| AFG | string | |\n| RATS | string | |\n| GRT | string | |\n| FORWARD | string | |\n| TFUEL | string | |\n| ENS | string | |\n| KASDOWN | string | |\n| XTM | string | |\n| DEGEN | string | |\n| TLM | string | |\n| DYDXDOWN | string | |\n| CKB | string | |\n| LUNC | string | |\n| AURORA | string | |\n| LUNA | string | |\n| XTZ | string | |\n| ELON | string | |\n| DMTR | string | |\n| EOS | string | |\n| GST | string | |\n| FORT | string | |\n| FLAME | string | |\n| PATEX | string | |\n| DEEP | string | |\n| ID3L | string | |\n| GTC | string | |\n| ID3S | string | |\n| RIO | string | |\n| CLH | string | |\n| BURGER | string | |\n| VRA | string | |\n| SUNDOG | string | |\n| GTT | string | |\n| INJUP | string | |\n| CPOOL | string | |\n| EPX | string | |\n| CLV | string | |\n| FEAR | string | |\n| MEME | string | |\n| ROOBEE | string | |\n| DEFI | string | |\n| TOKEN | string | |\n| GRAPE | string | |\n| KASUP | string | |\n| XWG | string | |\n| SKEY | string | |\n| SFUND | string | |\n| EQX | string | |\n| ORDIUP | string | |\n| TON | string | |\n| DEGO | string | |\n| IZI | string | |\n| ERG | string | |\n| ERN | string | |\n| VENOM | string | |\n| VOXEL | string | |\n| RLC | string | |\n| PHA | string | |\n| DYDXUP | string | |\n| APE3S | string | |\n| ORBS | string | |\n| OPDOWN | string | |\n| ESE | string | |\n| APE3L | string | |\n| HMND | string | |\n| COQ | string | |\n| AURY | string | |\n| CULT | string | |\n| AKT | string | |\n| GLMR | string | |\n| XYM | string | |\n| ORAI | string | |\n| XYO | string | |\n| ETC | string | |\n| LAI | string | |\n| PIP | string | |\n| ETH | string | |\n| NEO | string | |\n| RMV | string | |\n| KLAY | string | |\n| PIT | string | |\n| TARA | string | |\n| KALT | string | |\n| PIX | string | |\n| ETN | string | |\n| CSIX | string | |\n| TRADE | string | |\n| MAVIA | string | |\n| HIGH | string | |\n| TRB | string | |\n| ORDI | string | |\n| TRVL | string | |\n| AMB | string | |\n| TRU | string | |\n| LOGX | string | |\n| FINC | string | |\n| INFRA | string | |\n| NATIX | string | |\n| NFP | string | |\n| TRY | string | |\n| TRX | string | |\n| LBP | string | |\n| LBR | string | |\n| EUL | string | |\n| NFT | string | |\n| SEIUP | string | |\n| PUFFER | string | |\n| EUR | string | |\n| ORCA | string | |\n| NEAR3L | string | |\n| AMP | string | |\n| XDEFI | string | |\n| HIFI | string | |\n| TRUF | string | |\n| AITECH | string | |\n| AMU | string | |\n| USTC | string | |\n| KNGL | string | |\n| FOXY | string | |\n| NGC | string | |\n| TENET | string | |\n| NEAR3S | string | |\n| MAHA | string | |\n| NGL | string | |\n| TST | string | |\n| HIPPO | string | |\n| AXS3S | string | |\n| CRO | string | |\n| ZPAY | string | |\n| MNDE | string | |\n| CRV | string | |\n| SWASH | string | |\n| AXS3L | string | |\n| VERSE | string | |\n| RPK | string | |\n| RPL | string | |\n| AZERO | string | |\n| SOUL | string | |\n| VXV | string | |\n| LDO | string | |\n| MAGIC | string | |\n| ALICE | string | |\n| SEAM | string | |\n| PLU | string | |\n| AOG | string | |\n| SMOLE | string | |\n| EWT | string | |\n| TSUGT | string | |\n| PMG | string | |\n| OPAI | string | |\n| LOCUS | string | |\n| CTA | string | |\n| NIM | string | |\n| CTC | string | |\n| APE | string | |\n| MERL | string | |\n| JAM | string | |\n| CTI | string | |\n| APP | string | |\n| APT | string | |\n| WLDUP | string | |\n| ZEND | string | |\n| FIRE | string | |\n| DENT | string | |\n| PYTH | string | |\n| LFT | string | |\n| DPET | string | |\n| ORDIDOWN | string | |\n| KPOL | string | |\n| ETHUP | string | |\n| BAND | string | |\n| POL | string | |\n| ASTR | string | |\n| NKN | string | |\n| RSR | string | |\n| DVPN | string | |\n| TWT | string | |\n| ARB | string | |\n| CVC | string | |\n| ARC | string | |\n| XETA | string | |\n| MTRG | string | |\n| LOKA | string | |\n| LPOOL | string | |\n| TURBOS | string | |\n| CVX | string | |\n| ARX | string | |\n| MPLX | string | |\n| SUSHI | string | |\n| NLK | string | |\n| PEPE2 | string | |\n| WBTC | string | |\n| SUI3L | string | |\n| CWS | string | |\n| SUI3S | string | |\n| INSP | string | |\n| MANA | string | |\n| VRTX | string | |\n| CSPR | string | |\n| ATA | string | |\n| OPEN | string | |\n| HAI | string | |\n| NMR | string | |\n| ATH | string | |\n| LIT | string | |\n| TLOS | string | |\n| TNSR | string | |\n| CXT | string | |\n| POLYX | string | |\n| ZERO | string | |\n| ROUTE | string | |\n| LOOM | string | |\n| PRE | string | |\n| VRAUP | string | |\n| HBB | string | |\n| RVN | string | |\n| PRQ | string | |\n| ONDO | string | |\n| PEPEDOWN | string | |\n| WOOP | string | |\n| LUNCUP | string | |\n| KAVA | string | |\n| LKI | string | |\n| AVA | string | |\n| NOM | string | |\n| MAPO | string | |\n| PEPEUP | string | |\n| STRAX | string | |\n| NOT | string | |\n| ZERC | string | |\n| BCUT | string | |\n| MASA | string | |\n| WAN | string | |\n| WAT | string | |\n| WAX | string | |\n| MASK | string | |\n| EOS3L | string | |\n| IDEA | string | |\n| EOS3S | string | |\n| YFI | string | |\n| MOODENG | string | |\n| XCUR | string | |\n| HYDRA | string | |\n| POPCAT | string | |\n| LQTY | string | |\n| PIXEL | string | |\n| LMR | string | |\n| ZETA | string | |\n| YGG | string | |\n| AXS | string | |\n| BCHSV | string | |\n| NRN | string | |\n| FTON | string | |\n| COMP | string | |\n| XPRT | string | |\n| HFT | string | |\n| UXLINK | string | |\n| STAMP | string | |\n| RUNE | string | |\n| ZEUS | string | |\n| LTC3L | string | |\n| DAPP | string | |\n| FORTH | string | |\n| ALPINE | string | |\n| SENSO | string | |\n| LTC3S | string | |\n| DEXE | string | |\n| GOAL | string | |\n| AVAX | string | |\n| LISTA | string | |\n| AMPL | string | |\n| WORK | string | |\n| BRWL | string | |\n| BANANA | string | |\n| PUSH | string | |\n| WEN | string | |\n| NEIRO | string | |\n| BTCUP | string | |\n| SOL3S | string | |\n| BRAWL | string | |\n| LAY3R | string | |\n| LPT | string | |\n| GODS | string | |\n| SAND3S | string | |\n| RDNT | string | |\n| SOL3L | string | |\n| NIBI | string | |\n| NUM | string | |\n| PYR | string | |\n| DAG | string | |\n| DAI | string | |\n| HIP | string | |\n| DAO | string | |\n| AVAIL | string | |\n| DAR | string | |\n| FET | string | |\n| FCON | string | |\n| XAVA | string | |\n| LRC | string | |\n| UNI3S | string | |\n| POKT | string | |\n| DASH | string | |\n| BAKEDOWN | string | |\n| POLC | string | |\n| CIRUS | string | |\n| UNI3L | string | |\n| NWC | string | |\n| POLK | string | |\n| LSD | string | |\n| MARS4 | string | |\n| LSK | string | |\n| BLOCK | string | |\n| ANALOS | string | |\n| SAFE | string | |\n| DCK | string | |\n| LSS | string | |\n| DCR | string | |\n| LIKE | string | |\n| DATA | string | |\n| WIF | string | |\n| BLOK | string | |\n| LTC | string | |\n| METIS | string | |\n| WIN | string | |\n| HLG | string | |\n| LTO | string | |\n| DYDX | string | |\n| ARB3S | string | |\n| MUBI | string | |\n| ARB3L | string | |\n| RBTC1 | string | |\n| POND | string | |\n| LINA | string | |\n| MYRIA | string | |\n| LINK | string | |\n| QTUM | string | |\n| TUNE | string | |\n| UFO | string | |\n| CYBER | string | |\n| WILD | string | |\n| POLS | string | |\n| NYM | string | |\n| FIL | string | |\n| BAL | string | |\n| SCA | string | |\n| STND | string | |\n| WMTX | string | |\n| SCLP | string | |\n| MANEKI | string | |\n| BAT | string | |\n| AKRO | string | |\n| FTM3L | string | |\n| BAX | string | |\n| FTM3S | string | |\n| COTI | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "prices" + ], + "query": [ + { + "key": "base", + "value": "", + "description": "Ticker symbol of a base currency,eg.USD,EUR. Default is USD" + }, + { + "key": "currencies", + "value": "", + "description": "Comma-separated cryptocurrencies to be converted into fiat, e.g.: BTC,ETH, etc. Default to return the fiat price of all currencies." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"AGLD\": \"1.1174410000000001\",\n \"DFI\": \"0.0168915500000000\",\n \"PYTHUP\": \"0.0397880960000000\",\n \"ISLM\": \"0.0606196750000000\",\n \"NEAR\": \"4.7185395500000000\",\n \"AIOZ\": \"0.4862867350000000\",\n \"AUDIO\": \"0.1219390000000000\",\n \"BBL\": \"0.0067766100000000\",\n \"WLD\": \"2.2893547500000000\",\n \"HNT\": \"5.8990489999999984\",\n \"ETHFI\": \"1.5892050000000000\",\n \"DMAIL\": \"0.2726636000000000\",\n \"OPUP\": \"0.0986506500000000\",\n \"VET3S\": \"0.0003700448850000\",\n \"MANA3S\": \"0.0006056970000000\",\n \"TIDAL\": \"0.0001154422500000\",\n \"HALO\": \"0.0058270850000000\",\n \"OPUL\": \"0.0839480050000000\",\n \"MANA3L\": \"0.0029569407900000\",\n \"DGB\": \"0.0066556705000000\",\n \"AA\": \"0.2406796000000000\",\n \"BCH\": \"366.2167999999996484\",\n \"GMEE\": \"0.0113333305000000\",\n \"JST\": \"0.0302348750000000\",\n \"PBUX\": \"0.0208795550000000\",\n \"AR\": \"18.5457224999999909\",\n \"SEI\": \"0.4332832500000000\",\n \"PSTAKE\": \"0.0493153300000000\",\n \"LMWR\": \"0.1618190500000000\",\n \"UNFIDOWN\": \"0.0062058955000000\",\n \"BB\": \"0.3245376500000000\",\n \"JTO\": \"2.1239375000000002\",\n \"WEMIX\": \"0.7916040000000000\",\n \"G\": \"0.0324037900000000\",\n \"MARSH\": \"0.0617591050000000\",\n \"BN\": \"0.0036961510000000\",\n \"FLIP\": \"1.0976509000000000\",\n \"FLR\": \"0.0144827550000000\",\n \"BIGTIME\": \"0.1238780300000000\",\n \"FLY\": \"0.0005157420000000\",\n \"T\": \"0.0233483200000000\",\n \"W\": \"0.2865566500000000\",\n \"BDX\": \"0.0774012800000000\",\n \"BABYDOGE\": \"0.0000000029375305\",\n \"SFP\": \"0.7256370000000000\",\n \"DIA\": \"0.9179408000000000\",\n \"ISME\": \"0.0022388800000000\",\n \"LYM\": \"0.0010155919500000\",\n \"VET3L\": \"0.0000289755050000\",\n \"JUP\": \"0.8230882500000000\",\n \"LYX\": \"1.4501745500000001\",\n \"AIEPK\": \"0.0050094940000000\",\n \"SILLY\": \"0.0159420250000000\",\n \"SCPT\": \"0.0122038950000000\",\n \"WOO\": \"0.1796601250000000\",\n \"BLUR\": \"0.2462768000000000\",\n \"STRK\": \"0.3963117450000000\",\n \"BFC\": \"0.0383608100000000\",\n \"DC\": \"0.0003097450500000\",\n \"KARATE\": \"0.0007296350000000\",\n \"SUSHI3L\": \"0.5115441000000000\",\n \"NETVR\": \"0.0976111700000000\",\n \"WAVES\": \"1.0806594000000000\",\n \"LITH\": \"0.0001520239500000\",\n \"HAPI\": \"8.6533711499999987\",\n \"SUSHI3S\": \"1.2752620500000000\",\n \"CEEK\": \"0.0294852500000000\",\n \"FLOKI\": \"0.0001414292500000\",\n \"SHR\": \"0.0012463765000000\",\n \"SAND\": \"0.2566616050000000\",\n \"TURT\": \"0.0020889550000000\",\n \"UMA\": \"2.5207390000000000\",\n \"BEPRO\": \"0.0003955021500000\",\n \"SCRT\": \"0.1995002000000000\",\n \"TUSD\": \"0.9945025000000000\",\n \"COOKIE\": \"0.0220089900000000\",\n \"LRDS\": \"0.6218889000000000\",\n \"SIN\": \"0.0033633175000000\",\n \"OAS\": \"0.0331933950000000\",\n \"ROOT\": \"0.0183108400000000\",\n \"ADA3L\": \"0.0046396790000000\",\n \"TIAUP\": \"0.1228385500000000\",\n \"HTR\": \"0.0353023400000000\",\n \"UNB\": \"0.0003837080500000\",\n \"UNA\": \"0.0164917500000000\",\n \"HARD\": \"0.1087056200000000\",\n \"G3\": \"0.0502648550000000\",\n \"ADA3S\": \"0.0006191202850000\",\n \"MYRO\": \"0.1071863800000000\",\n \"HTX\": \"0.0000013693150000\",\n \"FT\": \"0.3585206500000000\",\n \"BTCDOWN\": \"0.1065467000000000\",\n \"UNI\": \"7.3571195999999993\",\n \"FX\": \"0.1379310000000000\",\n \"OBI\": \"0.0079030465000000\",\n \"UNO\": \"0.0137131400000000\",\n \"WRX\": \"0.1221389000000000\",\n \"TIADOWN\": \"0.0000914642450000\",\n \"ETHDOWN\": \"0.1306346500000000\",\n \"WELL\": \"0.0471244260000000\",\n \"SWFTC\": \"0.0028966509500000\",\n \"SKL\": \"0.0362418700000000\",\n \"UOS\": \"0.0867765900000000\",\n \"AIPAD\": \"0.0478660550000000\",\n \"BRETT\": \"0.1037481000000000\",\n \"SKY\": \"0.0520139800000000\",\n \"FRM\": \"0.0153123400000000\",\n \"VISION\": \"0.0014451770500000\",\n \"LENDS\": \"0.0047276350000000\",\n \"SLF\": \"0.3318340000000000\",\n \"BULL\": \"0.0023988000000000\",\n \"FLOW\": \"0.5372312500000000\",\n \"ODDZ\": \"0.0063368300000000\",\n \"SLN\": \"0.2804597000000000\",\n \"UPO\": \"0.0440779500000000\",\n \"SLP\": \"0.0023997995000000\",\n \"ID\": \"0.3718140000000000\",\n \"SLIM\": \"0.0906446550000000\",\n \"SPOT\": \"0.0021289350000000\",\n \"DOP\": \"0.0023028480000000\",\n \"ISSP\": \"0.0000874562500000\",\n \"UQC\": \"3.2339822000000003\",\n \"IO\": \"1.8185902499999999\",\n \"DOT\": \"4.2022978000000005\",\n \"1INCH\": \"0.2645676500000000\",\n \"SMH\": \"0.3448275000000000\",\n \"MAK\": \"0.0396701550000000\",\n \"TOKO\": \"0.0005923037000000\",\n \"TURBO\": \"0.0108085930000000\",\n \"UNFI\": \"2.8555714999999996\",\n \"MAN\": \"0.0210764565000000\",\n \"EVER\": \"0.0332733550000000\",\n \"FTM\": \"0.7259068650000000\",\n \"SHRAP\": \"0.0476361700000000\",\n \"MAV\": \"0.1738130500000000\",\n \"MAX\": \"0.2864966800000000\",\n \"DPR\": \"0.0018240875000000\",\n \"FTT\": \"2.0559715000000002\",\n \"ARKM\": \"1.7444273499999999\",\n \"ATOM\": \"4.2954512000000002\",\n \"PENDLE\": \"4.1554212500000007\",\n \"QUICK\": \"0.0365317250000000\",\n \"BLZ\": \"0.1217191100000000\",\n \"BOBA\": \"0.2014092450000000\",\n \"MBL\": \"0.0027856065000000\",\n \"OFN\": \"0.1252373500000000\",\n \"UNIO\": \"0.0025487250000000\",\n \"SNS\": \"0.0200899500000000\",\n \"SNX\": \"1.4282854999999999\",\n \"NXRA\": \"0.0272763550000000\",\n \"TAIKO\": \"1.4392800000000001\",\n \"AVAX3L\": \"0.1410875109550000\",\n \"L3\": \"0.0608395650000000\",\n \"API3\": \"1.3728132500000001\",\n \"XRP3S\": \"0.0028095945000000\",\n \"QKC\": \"0.0085157400000000\",\n \"AVAX3S\": \"0.5148424500000000\",\n \"ROSE\": \"0.0693453100000000\",\n \"SATS\": \"0.0000002701648500\",\n \"BMX\": \"0.3100449000000000\",\n \"PORTAL\": \"0.2811593500000000\",\n \"TOMI\": \"0.0309045400000000\",\n \"XRP3L\": \"2.1586201500000002\",\n \"SOL\": \"151.7250995000003583\",\n \"SON\": \"0.0002421788500000\",\n \"BNC\": \"0.1882058500000000\",\n \"SOCIAL\": \"0.0026486750000000\",\n \"CGPT\": \"0.1305147100000000\",\n \"CELR\": \"0.0127736100000000\",\n \"BNB\": \"591.0973035000118935\",\n \"OGN\": \"0.0852573500000000\",\n \"CELO\": \"0.7711142500000000\",\n \"AUCTION\": \"13.1634150000000014\",\n \"MANTA\": \"0.7564216000000000\",\n \"LAYER\": \"0.0372713550000000\",\n \"AERO\": \"1.3783104999999999\",\n \"CETUS\": \"0.1808295400000000\",\n \"LL\": \"0.0201199350000000\",\n \"SPA\": \"0.0067426270000000\",\n \"PYTHDOWN\": \"0.0011834080000000\",\n \"NEIROCTO\": \"0.0019964013000000\",\n \"UTK\": \"0.0365217300000000\",\n \"GMRX\": \"0.0007386305000000\",\n \"BOB\": \"0.0000380619595000\",\n \"HOTCROSS\": \"0.0056491740000000\",\n \"AERGO\": \"0.1007595950000000\",\n \"MOCA\": \"0.0783608000000000\",\n \"SQD\": \"0.0380809500000000\",\n \"MV\": \"0.0081359300000000\",\n \"BNB3L\": \"0.2761618500000000\",\n \"BNB3S\": \"0.0008545725000000\",\n \"GALAX3L\": \"0.0057571999600000\",\n \"KAI\": \"0.0020080954500000\",\n \"SQR\": \"0.0470764500000000\",\n \"GALAX3S\": \"0.1933033000000000\",\n \"EGLD\": \"25.5272299999999713\",\n \"ZBCN\": \"0.0010404795000000\",\n \"KAS\": \"0.1216691350000000\",\n \"MEW\": \"0.0086176890000000\",\n \"PUNDIX\": \"0.4130933500000000\",\n \"LOOKS\": \"0.0392803500000000\",\n \"FXS\": \"1.9060465000000000\",\n \"BOSON\": \"0.2732633000000000\",\n \"BRISE\": \"0.0000000860569500\",\n \"AEVO\": \"0.3388305000000000\",\n \"FLUX\": \"0.5276360500000000\",\n \"PRCL\": \"0.1969015000000000\",\n \"UNFIUP\": \"0.0011654170000000\",\n \"SEIDOWN\": \"0.0442778500000000\",\n \"DOAI\": \"0.0052363805000000\",\n \"QNT\": \"65.4312679999998206\",\n \"REDO\": \"0.2837580500000000\",\n \"STRIKE\": \"6.8225869999999997\",\n \"ETHW\": \"3.2418782499999998\",\n \"OM\": \"1.5396797750000000\",\n \"OP\": \"1.6911539999999999\",\n \"WHALE\": \"0.8134930500000000\",\n \"1CAT\": \"0.0018460765000000\",\n \"NEON\": \"0.4446775500000000\",\n \"GTAI\": \"0.7786105000000000\",\n \"SSV\": \"21.2393749999999841\",\n \"ETH2\": \"2601.6678843156403923\",\n \"KCS\": \"8.7646155000000020\",\n \"ARPA\": \"0.0393882960000000\",\n \"ARTFI\": \"0.0141029450000000\",\n \"BRL\": \"0.1742807323452485\",\n \"ALEX\": \"0.0924537500000000\",\n \"STG\": \"0.2943527500000000\",\n \"SHIB\": \"0.0000178060925000\",\n \"IOTX\": \"0.0394202800000000\",\n \"OLE\": \"0.0171414250000000\",\n \"KDA\": \"0.5653172000000000\",\n \"CERE\": \"0.0022548720000000\",\n \"DOCK\": \"0.0018990500000000\",\n \"STX\": \"1.8157916500000000\",\n \"OLT\": \"0.0007596200000000\",\n \"QI\": \"0.0131754090000000\",\n \"SDAO\": \"0.2748625000000000\",\n \"BLAST\": \"0.0087636160000000\",\n \"LINK3S\": \"0.0000702948350000\",\n \"IOST\": \"0.0049745115000000\",\n \"SUI\": \"2.0589700000000000\",\n \"CAKE\": \"1.7941024999999999\",\n \"BSW\": \"0.0586706500000000\",\n \"OMG\": \"0.2597700500000000\",\n \"VOLT\": \"0.0000002716641000\",\n \"LINK3L\": \"1.3408292499999999\",\n \"GEEQ\": \"0.0385607100000000\",\n \"PYUSD\": \"0.9988003500000000\",\n \"SUN\": \"0.0186106900000000\",\n \"TOWER\": \"0.0014812590000000\",\n \"BTC\": \"67133.4165000832051564\",\n \"IOTA\": \"0.1189405000000000\",\n \"REEF\": \"0.0019960015000000\",\n \"TRIAS\": \"3.3683149999999998\",\n \"KEY\": \"0.0037594713240047\",\n \"ETH3L\": \"0.0003305946200000\",\n \"BTT\": \"0.0000009117439000\",\n \"ONE\": \"0.0132003965000000\",\n \"RENDER\": \"5.2263854999999995\",\n \"ETH3S\": \"0.5517240000000000\",\n \"ANKR\": \"0.0264867500000000\",\n \"ALGO\": \"0.1188405500000000\",\n \"SYLO\": \"0.0007600198000000\",\n \"ZCX\": \"0.0784707450000000\",\n \"SD\": \"0.3851073500000000\",\n \"ONT\": \"0.1877960550000000\",\n \"MJT\": \"0.0132433750000000\",\n \"DYM\": \"1.6659666000000001\",\n \"DYP\": \"0.0205397250000000\",\n \"BAKEUP\": \"0.0389894955000000\",\n \"OOE\": \"0.0079360300000000\",\n \"ZELIX\": \"0.0000649675000000\",\n \"DOGE3L\": \"0.3837080500000000\",\n \"ARTY\": \"0.3980009000000000\",\n \"QORPO\": \"0.1204297550000000\",\n \"ICE\": \"0.0051504235000000\",\n \"NOTAI\": \"0.0000892753400000\",\n \"DOGE3S\": \"0.2291853500000000\",\n \"NAKA\": \"1.0695649500000000\",\n \"GALAX\": \"0.0212893500000000\",\n \"MKR\": \"1245.8767500000163833\",\n \"DODO\": \"0.1152423500000000\",\n \"ICP\": \"7.6731615000000027\",\n \"ZEC\": \"35.9400209999999543\",\n \"ZEE\": \"0.0065767100000000\",\n \"ICX\": \"0.1383308000000000\",\n \"KMNO\": \"0.0921499020000000\",\n \"TT\": \"0.0033883050000000\",\n \"DOT3L\": \"0.1454272500000000\",\n \"XAI\": \"0.2038980000000000\",\n \"ZEN\": \"8.0149905000000007\",\n \"DOGE\": \"0.1213093150000000\",\n \"ALPHA\": \"0.0567416150000000\",\n \"DUSK\": \"0.1964517250000000\",\n \"DOT3S\": \"0.0053613180000000\",\n \"SXP\": \"0.2538730000000000\",\n \"HBAR\": \"0.0510044850000000\",\n \"SYNT\": \"0.0467166300000000\",\n \"ZEX\": \"0.0571714000000000\",\n \"BONDLY\": \"0.0022208890000000\",\n \"MLK\": \"0.2080859050000000\",\n \"KICKS\": \"0.0001301249050000\",\n \"PEPE\": \"0.0000100249850000\",\n \"OUSD\": \"0.9982006500000000\",\n \"LUNCDOWN\": \"0.0000733333150000\",\n \"DOGS\": \"0.0007086455000000\",\n \"REV3L\": \"0.0094672640000000\",\n \"CTSI\": \"0.1257371000000000\",\n \"C98\": \"0.1219390000000000\",\n \"OSMO\": \"0.5370313500000000\",\n \"NTRN\": \"0.3869064500000000\",\n \"CFX2S\": \"0.0084757600000000\",\n \"SYN\": \"0.5636180500000000\",\n \"VIDT\": \"0.0308745550000000\",\n \"SYS\": \"0.0997501000000000\",\n \"GAS\": \"4.3029474500000008\",\n \"BOME\": \"0.0087336310000000\",\n \"COMBO\": \"0.4068964500000000\",\n \"XCH\": \"14.9825050000000010\",\n \"VR\": \"0.0063538215000000\",\n \"CFX2L\": \"0.0499660045000000\",\n \"VSYS\": \"0.0005201398000000\",\n \"PANDORA\": \"1629.2949450001102772\",\n \"THETA\": \"1.2461766000000000\",\n \"XCN\": \"0.0012699647000000\",\n \"NEXG\": \"0.0039180400000000\",\n \"MELOS\": \"0.0021244372500000\",\n \"XCV\": \"0.0013253370000000\",\n \"ORN\": \"0.8797599000000000\",\n \"WLKN\": \"0.0010624685000000\",\n \"AAVE\": \"154.2708259999996162\",\n \"MNT\": \"0.6168914000000000\",\n \"BONK\": \"0.0000227296295000\",\n \"PERP\": \"0.6037979500000000\",\n \"XDC\": \"0.0276361750000000\",\n \"MNW\": \"0.3681158500000000\",\n \"XDB\": \"0.0002578710000000\",\n \"BOND\": \"1.5662165000000000\",\n \"SUIA\": \"0.0809595000000000\",\n \"MOG\": \"0.0000019330330000\",\n \"SUTER\": \"0.0001840079500000\",\n \"TIME\": \"16.2648634999999969\",\n \"RACA\": \"0.0001949025000000\",\n \"BICO\": \"0.2021988500000000\",\n \"MON\": \"0.1066466500000000\",\n \"SWEAT\": \"0.0063718125000000\",\n \"MOXIE\": \"0.0022088950000000\",\n \"BABYBNB\": \"0.0289755050000000\",\n \"IGU\": \"0.0050674650000000\",\n \"HMSTR\": \"0.0037990995000000\",\n \"XEC\": \"0.0000354722550000\",\n \"MONI\": \"0.0058470750000000\",\n \"XR\": \"0.2374812000000000\",\n \"PEOPLE\": \"0.0796601500000000\",\n \"PUMLX\": \"0.0054572700000000\",\n \"ZIL\": \"0.0145927000000000\",\n \"WLDDOWN\": \"0.2089954500000000\",\n \"VAI\": \"0.0799999800000000\",\n \"XEN\": \"0.0000000839580000\",\n \"MPC\": \"0.1001499000000000\",\n \"XEM\": \"0.0176951480000000\",\n \"JASMY3S\": \"0.0019670160000000\",\n \"OTK\": \"0.0290464695000000\",\n \"TRAC\": \"0.4521738000000000\",\n \"DFYN\": \"0.0070664650000000\",\n \"BIDP\": \"0.0001939030000000\",\n \"JASMY3L\": \"0.0001653772700000\",\n \"INJDOWN\": \"0.0000194902500000\",\n \"KLV\": \"0.0019310340000000\",\n \"WAXL\": \"0.7858069000000000\",\n \"TRBDOWN\": \"0.0023138425000000\",\n \"BCH3L\": \"4.6390663064999996\",\n \"GMT3S\": \"0.0000457771000000\",\n \"KMD\": \"0.2493752500000000\",\n \"BCH3S\": \"0.9634180500000000\",\n \"ECOX\": \"0.0987506000000000\",\n \"AAVE3S\": \"0.0560719500000000\",\n \"GMT3L\": \"0.0053983694650000\",\n \"EPIK\": \"0.0045857060000000\",\n \"SUIP\": \"0.1067565950000000\",\n \"AAVE3L\": \"0.3638687346200000\",\n \"ZK\": \"0.1262368500000000\",\n \"ZKF\": \"0.0008595700000000\",\n \"OMNIA\": \"0.7624186000000000\",\n \"ZKJ\": \"1.1124435000000000\",\n \"ZKL\": \"0.1255372000000000\",\n \"GAFI\": \"3.0634675000000001\",\n \"CARV\": \"0.8703646000000000\",\n \"KNC\": \"0.4433782000000000\",\n \"CATS\": \"0.0000599700000000\",\n \"PROM\": \"5.2833570000000006\",\n \"ALEPH\": \"0.1756121500000000\",\n \"PONKE\": \"0.3958020000000000\",\n \"OVR\": \"0.1553223000000000\",\n \"CATI\": \"0.4105146400000000\",\n \"ORDER\": \"0.1183008200000000\",\n \"GFT\": \"0.0166616650000000\",\n \"BIFI\": \"0.0020489750000000\",\n \"GGC\": \"6.9965029985000000\",\n \"GGG\": \"0.0403798000000000\",\n \"DAPPX\": \"0.0043788095000000\",\n \"SUKU\": \"0.0618790450000000\",\n \"ULTI\": \"0.0168015950000000\",\n \"CREDI\": \"0.0192903500000000\",\n \"ERTHA\": \"0.0010014990000000\",\n \"FURY\": \"0.1405297000000000\",\n \"KARRAT\": \"0.5577210000000000\",\n \"MOBILE\": \"0.0009005495000000\",\n \"SIDUS\": \"0.0037671155000000\",\n \"NAVI\": \"0.1254672350000000\",\n \"TAO\": \"583.4081500000051807\",\n \"USDJ\": \"1.1386304000000001\",\n \"MTL\": \"0.9563216000000000\",\n \"VET\": \"0.0225387250000000\",\n \"FITFI\": \"0.0036421780000000\",\n \"USDT\": \"0.9995000000000000\",\n \"OXT\": \"0.0695652000000000\",\n \"CANDY\": \"0.0005597200000000\",\n \"USDP\": \"0.9932031500000000\",\n \"MTS\": \"0.0027516235000000\",\n \"TADA\": \"0.0283858000000000\",\n \"MTV\": \"0.0006559718500000\",\n \"NAVX\": \"0.1342228550000000\",\n \"ILV\": \"35.6771524999999671\",\n \"VINU\": \"0.0000000109045450\",\n \"GHX\": \"0.0903548000000000\",\n \"EDU\": \"0.5167415000000000\",\n \"HYVE\": \"0.0137331300000000\",\n \"BTC3L\": \"0.0058620675000000\",\n \"ANYONE\": \"0.9015490000000000\",\n \"BEAT\": \"0.0012593700000000\",\n \"KING\": \"0.0004821588000000\",\n \"CREAM\": \"15.6541689999999973\",\n \"CAS\": \"0.0038590695000000\",\n \"IMX\": \"1.4944524000000000\",\n \"CAT\": \"0.0000256981445000\",\n \"BTC3S\": \"0.0014142925000000\",\n \"USDE\": \"0.9985005000000000\",\n \"USDD\": \"1.0000997000000000\",\n \"CWAR\": \"0.0037981000000000\",\n \"USDC\": \"0.9997998500000000\",\n \"KRL\": \"0.3543127550000000\",\n \"INJ\": \"21.7691100000000194\",\n \"GAME\": \"0.0139630150000000\",\n \"TRIBL\": \"1.0994500000000000\",\n \"XLM\": \"0.0948525500000000\",\n \"TRBUP\": \"0.0012293850000000\",\n \"VRADOWN\": \"0.0013433280000000\",\n \"SUPER\": \"1.2853570000000000\",\n \"EIGEN\": \"3.1536223999999999\",\n \"IOI\": \"0.0146926500000000\",\n \"KSM\": \"17.5212350000000129\",\n \"CCD\": \"0.0034832575000000\",\n \"EGO\": \"0.0093553200000000\",\n \"EGP\": \"2.7946019999999998\",\n \"MXC\": \"0.0066866550000000\",\n \"TEL\": \"0.0014432780000000\",\n \"MOVR\": \"9.1340307000000027\",\n \"XMR\": \"155.5421899999990755\",\n \"MXM\": \"0.0092853550000000\",\n \"OORT\": \"0.1099949750000000\",\n \"GLM\": \"0.3231383500000000\",\n \"RAY\": \"2.0228880499999998\",\n \"XTAG\": \"0.0218190850000000\",\n \"GLQ\": \"0.0854572500000000\",\n \"CWEB\": \"0.0038480750000000\",\n \"REVU\": \"0.0105047450000000\",\n \"REVV\": \"0.0039760110000000\",\n \"ZRO\": \"3.7952014499999994\",\n \"XNL\": \"0.0093853050000000\",\n \"XNO\": \"0.8496749500000000\",\n \"SAROS\": \"0.0019290350000000\",\n \"KACE\": \"2.1165411999999998\",\n \"ZRX\": \"0.3186406000000000\",\n \"WLTH\": \"0.0374312750000000\",\n \"ATOM3L\": \"0.0321719060000000\",\n \"GMM\": \"0.0001497251000000\",\n \"BEER\": \"0.0000138670630000\",\n \"GMT\": \"0.1275362000000000\",\n \"HEART\": \"0.0159920000000000\",\n \"GMX\": \"22.7186349999999882\",\n \"ABBC\": \"0.0061769100000000\",\n \"OMNI\": \"8.9235359999999970\",\n \"ATOM3S\": \"0.0007945225400000\",\n \"IRL\": \"0.0099650150000000\",\n \"CFG\": \"0.3248375000000000\",\n \"WSDM\": \"0.0139830050000000\",\n \"GNS\": \"1.8390800000000001\",\n \"VANRY\": \"0.0809295150000000\",\n \"CFX\": \"0.1595202000000000\",\n \"GRAIL\": \"817.1212349999937891\",\n \"BEFI\": \"0.0175712100000000\",\n \"VELO\": \"0.0132043945000000\",\n \"XPR\": \"0.0008077959000000\",\n \"DOVI\": \"0.0584707500000000\",\n \"ACE\": \"0.0021349320000000\",\n \"ACH\": \"0.0190534685000000\",\n \"ISP\": \"0.0012161916000000\",\n \"XCAD\": \"0.2834582000000000\",\n \"MINA\": \"0.5630183500000000\",\n \"TIA\": \"5.9318325999999999\",\n \"DRIFT\": \"0.4350823500000000\",\n \"ACQ\": \"0.0056981495000000\",\n \"ACS\": \"0.0014917537500000\",\n \"MIND\": \"0.0018920535000000\",\n \"STORE\": \"0.0062358805000000\",\n \"REN\": \"0.0351224300000000\",\n \"ELA\": \"1.7282354500000000\",\n \"DREAMS\": \"0.0002498750000000\",\n \"ADA\": \"0.3463267500000000\",\n \"ELF\": \"0.3777110500000000\",\n \"REQ\": \"0.0959919800000000\",\n \"STORJ\": \"0.5662167500000000\",\n \"LADYS\": \"0.0000000837581000\",\n \"PAXG\": \"2697.9303600003123340\",\n \"REZ\": \"0.0409795000000000\",\n \"XRD\": \"0.0157821050000000\",\n \"CHO\": \"0.0205097400000000\",\n \"CHR\": \"0.1769115000000000\",\n \"ADS\": \"0.1889055000000000\",\n \"CHZ\": \"0.0738030800000000\",\n \"ADX\": \"0.1575212000000000\",\n \"XRP\": \"0.5525036100000000\",\n \"JASMY\": \"0.0188615645000000\",\n \"KAGI\": \"0.1834582250000000\",\n \"FIDA\": \"0.2282858000000000\",\n \"PBR\": \"0.0291953950000000\",\n \"AEG\": \"0.0093453250000000\",\n \"H2O\": \"0.1610194500000000\",\n \"CHMB\": \"0.0001715641750000\",\n \"SAND3L\": \"0.0015447972150000\",\n \"PBX\": \"0.0006879558500000\",\n \"SOLVE\": \"0.0084557700000000\",\n \"DECHAT\": \"0.1512243500000000\",\n \"GARI\": \"0.0076861550000000\",\n \"SHIB2L\": \"1.1996998499999999\",\n \"SHIB2S\": \"0.0240879500000000\",\n \"ENA\": \"0.3942028000000000\",\n \"VEMP\": \"0.0029335325000000\",\n \"ENJ\": \"0.1467266000000000\",\n \"AFG\": \"0.0072163900000000\",\n \"RATS\": \"0.0001211593900000\",\n \"GRT\": \"0.1646076550000000\",\n \"FORWARD\": \"0.0012873560000000\",\n \"TFUEL\": \"0.0598800450000000\",\n \"ENS\": \"17.0634640000000052\",\n \"KASDOWN\": \"0.0258770550000000\",\n \"XTM\": \"0.0251074400000000\",\n \"DEGEN\": \"0.0084857550000000\",\n \"TLM\": \"0.0100449750000000\",\n \"DYDXDOWN\": \"0.1042598440000000\",\n \"CKB\": \"0.0146026950000000\",\n \"LUNC\": \"0.0000889255150000\",\n \"AURORA\": \"0.1204397500000000\",\n \"LUNA\": \"0.3624187000000000\",\n \"XTZ\": \"0.6776610000000000\",\n \"ELON\": \"0.0000001410294500\",\n \"DMTR\": \"0.0891554000000000\",\n \"EOS\": \"0.4759619000000000\",\n \"GST\": \"0.0118940500000000\",\n \"FORT\": \"0.1155422000000000\",\n \"FLAME\": \"0.0247076400000000\",\n \"PATEX\": \"0.9605195000000000\",\n \"DEEP\": \"0.0328885475000000\",\n \"ID3L\": \"0.0016201895000000\",\n \"GTC\": \"0.6625685500000000\",\n \"ID3S\": \"0.0071674145000000\",\n \"RIO\": \"0.7616190000000000\",\n \"CLH\": \"0.0008555720000000\",\n \"BURGER\": \"0.4016990500000000\",\n \"VRA\": \"0.0029765110000000\",\n \"SUNDOG\": \"0.2173912500000000\",\n \"GTT\": \"0.0002038980000000\",\n \"INJUP\": \"0.2327835500000000\",\n \"CPOOL\": \"0.1557720750000000\",\n \"EPX\": \"0.0000740629500000\",\n \"CLV\": \"0.0329835000000000\",\n \"FEAR\": \"0.0560519600000000\",\n \"MEME\": \"0.0124847545000000\",\n \"ROOBEE\": \"0.0004520738500000\",\n \"DEFI\": \"0.0192903500000000\",\n \"TOKEN\": \"0.0477361200000000\",\n \"GRAPE\": \"0.0020599695000000\",\n \"KASUP\": \"0.3996001000000000\",\n \"XWG\": \"0.0003843077500000\",\n \"SKEY\": \"0.0621289200000000\",\n \"SFUND\": \"1.3243375000000000\",\n \"EQX\": \"0.0032823580000000\",\n \"ORDIUP\": \"0.0548315705000000\",\n \"TON\": \"5.1857058499999995\",\n \"DEGO\": \"2.2667660500000001\",\n \"IZI\": \"0.0088455750000000\",\n \"ERG\": \"0.6605695500000000\",\n \"ERN\": \"1.9255367500000001\",\n \"VENOM\": \"0.0817591000000000\",\n \"VOXEL\": \"0.1497251000000000\",\n \"RLC\": \"1.4649671500000000\",\n \"PHA\": \"0.1093453000000000\",\n \"DYDXUP\": \"0.0112573685000000\",\n \"APE3S\": \"0.0008475760000000\",\n \"ORBS\": \"0.0288955450000000\",\n \"OPDOWN\": \"0.6758619000000000\",\n \"ESE\": \"0.0139130400000000\",\n \"APE3L\": \"0.1339330000000000\",\n \"HMND\": \"0.0982208650000000\",\n \"COQ\": \"0.0000014432780000\",\n \"AURY\": \"0.3340329000000000\",\n \"CULT\": \"0.0000028025980000\",\n \"AKT\": \"2.4642672500000001\",\n \"GLMR\": \"0.1606196500000000\",\n \"XYM\": \"0.0142528700000000\",\n \"ORAI\": \"6.1769100000000012\",\n \"XYO\": \"0.0058680645000000\",\n \"ETC\": \"18.8458723500000169\",\n \"LAI\": \"0.0142828550000000\",\n \"PIP\": \"0.0178310800000000\",\n \"ETH\": \"2607.6655149998362673\",\n \"NEO\": \"10.3575186499999991\",\n \"RMV\": \"0.0081659150000000\",\n \"KLAY\": \"0.1251374000000000\",\n \"PIT\": \"0.0000000003268365\",\n \"TARA\": \"0.0043978000000000\",\n \"KALT\": \"0.1128735350000000\",\n \"PIX\": \"0.0001023687900000\",\n \"ETN\": \"0.0021579205000000\",\n \"CSIX\": \"0.0141729100000000\",\n \"TRADE\": \"0.4708644500000000\",\n \"MAVIA\": \"1.3592200500000001\",\n \"HIGH\": \"1.3043474999999999\",\n \"TRB\": \"62.5387150000000006\",\n \"ORDI\": \"35.7421200000000126\",\n \"TRVL\": \"0.0373643085000000\",\n \"AMB\": \"0.0059670150000000\",\n \"TRU\": \"0.0762018800000000\",\n \"LOGX\": \"0.0271963950000000\",\n \"FINC\": \"0.0362018900000000\",\n \"INFRA\": \"0.1978010500000000\",\n \"NATIX\": \"0.0008729633000000\",\n \"NFP\": \"0.2152923000000000\",\n \"TRY\": \"0.0292166033323590\",\n \"TRX\": \"0.1597201000000000\",\n \"LBP\": \"0.0001243378000000\",\n \"LBR\": \"0.0595702000000000\",\n \"EUL\": \"2.9735125000000000\",\n \"NFT\": \"0.0000004077960000\",\n \"SEIUP\": \"0.0478110825000000\",\n \"PUFFER\": \"0.3676161000000000\",\n \"EUR\": \"1.0811249323958897\",\n \"ORCA\": \"2.0664662499999999\",\n \"NEAR3L\": \"0.0117010765350000\",\n \"AMP\": \"0.0038330825000000\",\n \"XDEFI\": \"0.0472563600000000\",\n \"HIFI\": \"0.4947525000000000\",\n \"TRUF\": \"0.0459570100000000\",\n \"AITECH\": \"0.1045477000000000\",\n \"AMU\": \"0.0043978000000000\",\n \"USTC\": \"0.0214692600000000\",\n \"KNGL\": \"0.0499750000000000\",\n \"FOXY\": \"0.0102686631000000\",\n \"NGC\": \"0.0147935995000000\",\n \"TENET\": \"0.0043278350000000\",\n \"NEAR3S\": \"0.0072553705000000\",\n \"MAHA\": \"1.1904045000000000\",\n \"NGL\": \"0.0701748950000000\",\n \"TST\": \"0.0080359800000000\",\n \"HIPPO\": \"0.0104447750000000\",\n \"AXS3S\": \"0.0308705570000000\",\n \"CRO\": \"0.0781409100000000\",\n \"ZPAY\": \"0.0050574700000000\",\n \"MNDE\": \"0.1026786350000000\",\n \"CRV\": \"0.2534732000000000\",\n \"SWASH\": \"0.0056271850000000\",\n \"AXS3L\": \"0.0106388779000000\",\n \"VERSE\": \"0.0001803098000000\",\n \"RPK\": \"0.0049975000000000\",\n \"RPL\": \"10.9745099999999958\",\n \"AZERO\": \"0.3789104500000000\",\n \"SOUL\": \"0.0534332700000000\",\n \"VXV\": \"0.2619689500000000\",\n \"LDO\": \"1.0885554500000000\",\n \"MAGIC\": \"0.3390304000000000\",\n \"ALICE\": \"1.0324835000000000\",\n \"SEAM\": \"1.1933030499999999\",\n \"PLU\": \"1.9300345000000001\",\n \"AOG\": \"0.0031224380000000\",\n \"SMOLE\": \"0.0000387806000000\",\n \"EWT\": \"1.1094450000000000\",\n \"TSUGT\": \"0.0029185400000000\",\n \"PMG\": \"0.0800599500000000\",\n \"OPAI\": \"0.0006826585000000\",\n \"LOCUS\": \"0.0216591650000000\",\n \"CTA\": \"0.0825087250000000\",\n \"NIM\": \"0.0013673160000000\",\n \"CTC\": \"0.4033982000000000\",\n \"APE\": \"0.7035480500000000\",\n \"MERL\": \"0.2720639000000000\",\n \"JAM\": \"0.0004770613500000\",\n \"CTI\": \"0.0130314810000000\",\n \"APP\": \"0.0021989000000000\",\n \"APT\": \"9.9947001500000000\",\n \"WLDUP\": \"0.0093043455000000\",\n \"ZEND\": \"0.1280759300000000\",\n \"FIRE\": \"0.9113441000000000\",\n \"DENT\": \"0.0008630682500000\",\n \"PYTH\": \"0.3390603850000000\",\n \"LFT\": \"0.0155322300000000\",\n \"DPET\": \"0.0319040400000000\",\n \"ORDIDOWN\": \"0.3788105000000000\",\n \"KPOL\": \"0.0029175405000000\",\n \"ETHUP\": \"8.4971493000000032\",\n \"BAND\": \"1.0939527500000001\",\n \"POL\": \"0.3656171000000000\",\n \"ASTR\": \"0.0582608550000000\",\n \"NKN\": \"0.0691654000000000\",\n \"RSR\": \"0.0068055955000000\",\n \"DVPN\": \"0.0005979009000000\",\n \"TWT\": \"1.1119437500000000\",\n \"ARB\": \"0.5510243500000000\",\n \"CVC\": \"0.1409801746501747\",\n \"ARC\": \"0.0300849500000000\",\n \"XETA\": \"0.0022888550000000\",\n \"MTRG\": \"0.4007995000000000\",\n \"LOKA\": \"0.1867066000000000\",\n \"LPOOL\": \"0.0660069800000000\",\n \"TURBOS\": \"0.0034812585000000\",\n \"CVX\": \"1.7816087499999999\",\n \"ARX\": \"0.0007556220000000\",\n \"MPLX\": \"0.4355221300000000\",\n \"SUSHI\": \"0.7011492500000000\",\n \"NLK\": \"0.0114442750000000\",\n \"PEPE2\": \"0.0000000313843000\",\n \"WBTC\": \"66881.4425499645548419\",\n \"SUI3L\": \"0.0211204345000000\",\n \"CWS\": \"0.1927036000000000\",\n \"SUI3S\": \"0.0000579110300000\",\n \"INSP\": \"0.0264167850000000\",\n \"MANA\": \"0.2945026750000000\",\n \"VRTX\": \"0.0641679000000000\",\n \"CSPR\": \"0.0116441750000000\",\n \"ATA\": \"0.0785007300000000\",\n \"OPEN\": \"0.0080049955000000\",\n \"HAI\": \"0.0448275750000000\",\n \"NMR\": \"14.7436245000000072\",\n \"ATH\": \"0.0540929400000000\",\n \"LIT\": \"0.6282857000000000\",\n \"TLOS\": \"0.3263467450000000\",\n \"TNSR\": \"0.3662168000000000\",\n \"CXT\": \"0.0871364100000000\",\n \"POLYX\": \"0.2346826000000000\",\n \"ZERO\": \"0.0002507745500000\",\n \"ROUTE\": \"0.0610694500000000\",\n \"LOOM\": \"0.0580009850000000\",\n \"PRE\": \"0.0078680640000000\",\n \"VRAUP\": \"0.0134652640000000\",\n \"HBB\": \"0.0714742450000000\",\n \"RVN\": \"0.0165017450000000\",\n \"PRQ\": \"0.0715741950000000\",\n \"ONDO\": \"0.7134930750000000\",\n \"PEPEDOWN\": \"0.0000155022450000\",\n \"WOOP\": \"0.0020179905000000\",\n \"LUNCUP\": \"0.0168355780000000\",\n \"KAVA\": \"0.3522238000000000\",\n \"LKI\": \"0.0104187880000000\",\n \"AVA\": \"0.4857570000000000\",\n \"NOM\": \"0.0233883000000000\",\n \"MAPO\": \"0.0089015470000000\",\n \"PEPEUP\": \"0.0114252845000000\",\n \"STRAX\": \"0.0487156300000000\",\n \"NOT\": \"0.0078670645000000\",\n \"ZERC\": \"0.1108245600000000\",\n \"BCUT\": \"0.0255672100000000\",\n \"MASA\": \"0.0691354150000000\",\n \"WAN\": \"0.1785077544737212\",\n \"WAT\": \"0.0003273762300000\",\n \"WAX\": \"0.0327636100000000\",\n \"MASK\": \"2.2259864500000002\",\n \"EOS3L\": \"0.0002122138400000\",\n \"IDEA\": \"0.0005887055000000\",\n \"EOS3S\": \"0.0034472755000000\",\n \"YFI\": \"4919.4290549999908843\",\n \"MOODENG\": \"0.0774612500000000\",\n \"XCUR\": \"0.0048845565000000\",\n \"HYDRA\": \"0.2225886500000000\",\n \"POPCAT\": \"1.3382305500000000\",\n \"LQTY\": \"0.7848074000000000\",\n \"PIXEL\": \"0.1406596350000000\",\n \"LMR\": \"0.0145437245000000\",\n \"ZETA\": \"0.5997999500000000\",\n \"YGG\": \"0.4717640000000000\",\n \"AXS\": \"4.6006985000000006\",\n \"BCHSV\": \"49.8250749999999370\",\n \"NRN\": \"0.0395802000000000\",\n \"FTON\": \"0.0091954000000000\",\n \"COMP\": \"43.6581599999999881\",\n \"XPRT\": \"0.1819090000000000\",\n \"HFT\": \"0.1443278000000000\",\n \"UXLINK\": \"0.5085456000000000\",\n \"STAMP\": \"0.0335032400000000\",\n \"RUNE\": \"4.9233370999999996\",\n \"ZEUS\": \"0.2587705500000000\",\n \"LTC3L\": \"1.8294848000000001\",\n \"DAPP\": \"0.1763118000000000\",\n \"FORTH\": \"2.9508238500000004\",\n \"ALPINE\": \"1.5322335000000000\",\n \"SENSO\": \"0.0328835500000000\",\n \"LTC3S\": \"0.0006986505000000\",\n \"DEXE\": \"8.3795081500000028\",\n \"GOAL\": \"0.0175912000000000\",\n \"AVAX\": \"27.5602130000000058\",\n \"LISTA\": \"0.3782108000000000\",\n \"AMPL\": \"1.3743124999999999\",\n \"WORK\": \"0.1384307500000000\",\n \"BRWL\": \"0.0017391300000000\",\n \"BANANA\": \"57.1314200000001362\",\n \"PUSH\": \"0.0750624500000000\",\n \"WEN\": \"0.0001015492000000\",\n \"NEIRO\": \"0.0879560000000000\",\n \"BTCUP\": \"34.7711057499999789\",\n \"SOL3S\": \"0.0007816090000000\",\n \"BRAWL\": \"0.0004776610500000\",\n \"LAY3R\": \"0.2161918500000000\",\n \"LPT\": \"11.9304317999999945\",\n \"GODS\": \"0.1807096000000000\",\n \"SAND3S\": \"4.6152911999999992\",\n \"RDNT\": \"0.0640679500000000\",\n \"SOL3L\": \"1.8351913752850000\",\n \"NIBI\": \"0.0653772950000000\",\n \"NUM\": \"0.0436181800000000\",\n \"PYR\": \"2.5590198499999997\",\n \"DAG\": \"0.0226176855000000\",\n \"DAI\": \"0.9989006596042375\",\n \"HIP\": \"0.0034982500000000\",\n \"DAO\": \"0.2848575000000000\",\n \"AVAIL\": \"0.1300929210000000\",\n \"DAR\": \"0.1512243500000000\",\n \"FET\": \"1.3760116500000000\",\n \"FCON\": \"0.0001197600900000\",\n \"XAVA\": \"0.3789104500000000\",\n \"LRC\": \"0.1208395500000000\",\n \"UNI3S\": \"0.0000653573050000\",\n \"PZP\": \"0.0599600050000000\",\n \"POKT\": \"0.0424787500000000\",\n \"DASH\": \"23.6881500000000109\",\n \"BAKEDOWN\": \"0.0003324636850000\",\n \"POLC\": \"0.0061389290000000\",\n \"DBR\": \"0.0377671070000000\",\n \"CIRUS\": \"0.0055772100000000\",\n \"UNI3L\": \"0.0993921490650000\",\n \"NWC\": \"0.0681659000000000\",\n \"POLK\": \"0.0142628650000000\",\n \"LSD\": \"0.9420287500000000\",\n \"MARS4\": \"0.0005878059500000\",\n \"LSK\": \"0.8080957500000000\",\n \"BLOCK\": \"0.0261869000000000\",\n \"ANALOS\": \"0.0000446776500000\",\n \"SAFE\": \"0.8779608000000000\",\n \"DCK\": \"0.0234082900000000\",\n \"LSS\": \"0.0562718500000000\",\n \"DCR\": \"12.4337799999999929\",\n \"LIKE\": \"0.0559720000000000\",\n \"DATA\": \"0.0361819000000000\",\n \"WIF\": \"2.5696145499999999\",\n \"BLOK\": \"0.0006546725000000\",\n \"LTC\": \"71.6261690000000611\",\n \"METIS\": \"42.0289750000000612\",\n \"WIN\": \"0.0000868365600000\",\n \"HLG\": \"0.0018790600000000\",\n \"LTO\": \"0.1166116650000000\",\n \"DYDX\": \"0.9341327000000000\",\n \"ARB3S\": \"0.0509025360000000\",\n \"MUBI\": \"0.0303848000000000\",\n \"ARB3L\": \"0.0025917035000000\",\n \"RBTC1\": \"0.0000039480250000\",\n \"POND\": \"0.0118640650000000\",\n \"LINA\": \"0.0037771105000000\",\n \"MYRIA\": \"0.0025337325000000\",\n \"LINK\": \"11.0244849999999944\",\n \"QTUM\": \"2.4262016723130069\",\n \"TUNE\": \"0.0148025950000000\",\n \"UFO\": \"0.0000006479758500\",\n \"CYBER\": \"2.8755615000000001\",\n \"WILD\": \"0.2433782500000000\",\n \"POLS\": \"0.2809594500000000\",\n \"NYM\": \"0.0719640000000000\",\n \"FIL\": \"3.6786597500000005\",\n \"BAL\": \"2.0099945000000000\",\n \"SCA\": \"0.3999999000000000\",\n \"STND\": \"0.0133123405000000\",\n \"WMTX\": \"0.2138930000000000\",\n \"SCLP\": \"0.1545227000000000\",\n \"MANEKI\": \"0.0073963000000000\",\n \"BAT\": \"0.1721139000000000\",\n \"AKRO\": \"0.0042302838000000\",\n \"FTM3L\": \"8.2574692000000024\",\n \"BAX\": \"0.0000709645000000\",\n \"FTM3S\": \"0.0000255072400000\",\n \"COTI\": \"0.0951524000000000\"\n }\n}" + } + ] + }, + { + "name": "Get All Symbols", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "symbols" + ], + "query": [ + { + "key": "market", + "value": "", + "description": "[The trading market](https://www.kucoin.com/docs-new/api-222921786)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470154)\n\n:::info[Description]\nRequest via this endpoint to get a list of available currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers.\n:::\n\n\n:::tip[Tips]\npriceIncrement and quoteIncrement may be adjusted in the future. We will notify you by email and site notifications before adjustment.\n:::\n\n| Order Type | Follow the rules of minFunds |\n| --- | --- |\n| Limit Buy | [Order Amount * Order Price] >= minFunds |\n| Limit Sell | [Order Amount * Order Price] >= minFunds |\n| Market Buy | Order Value >= minFunds |\n| Market Sell | [Order Amount * Last Price of Base Currency] >= minFunds |\n\nNote:\n\n- API market buy orders (by amount) valued at [Order Amount * Last Price of Base Currency] < minFunds will be rejected.\n- API market sell orders (by value) valued at < minFunds will be rejected.\n- Take profit and stop loss orders at market or limit prices will be rejected when triggered.\n\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | unique code of a symbol, it would not change after renaming |\n| name | string | Name of trading pairs, it would change after renaming |\n| baseCurrency | string | Base currency,e.g. BTC. |\n| quoteCurrency | string | Quote currency,e.g. USDT. |\n| feeCurrency | string | The currency of charged fees. |\n| market | string | The trading market. |\n| baseMinSize | string | The minimum order quantity requried to place an order. |\n| quoteMinSize | string | The minimum order funds required to place a market order. |\n| baseMaxSize | string | The maximum order size required to place an order. |\n| quoteMaxSize | string | The maximum order funds required to place a market order. |\n| baseIncrement | string | Quantity increment: The quantity for an order must be a positive integer multiple of this increment. Here, the size refers to the quantity of the base currency for the order. For example, for the ETH-USDT trading pair, if the baseIncrement is 0.0000001, the order quantity can be 1.0000001 but not 1.00000001. |\n| quoteIncrement | string | Quote increment: The funds for a market order must be a positive integer multiple of this increment. The funds refer to the quote currency amount. For example, for the ETH-USDT trading pair, if the quoteIncrement is 0.000001, the amount of USDT for the order can be 3000.000001 but not 3000.0000001. |\n| priceIncrement | string | Price increment: The price of an order must be a positive integer multiple of this increment. For example, for the ETH-USDT trading pair, if the priceIncrement is 0.01, the order price can be 3000.01 but not 3000.001.

specifies the min order price as well as the price increment.This also applies to quote currency. |\n| priceLimitRate | string | Threshold for price portection |\n| minFunds | string | the minimum trading amounts |\n| isMarginEnabled | boolean | Available for margin or not. |\n| enableTrading | boolean | Available for transaction or not. |\n| feeCategory | integer | [Fee Type](https://www.kucoin.com/vip/privilege) |\n| makerFeeCoefficient | string | The maker fee coefficient. The actual fee needs to be multiplied by this coefficient to get the final fee. Most currencies have a coefficient of 1. If set to 0, it means no fee |\n| takerFeeCoefficient | string | The taker fee coefficient. The actual fee needs to be multiplied by this coefficient to get the final fee. Most currencies have a coefficient of 1. If set to 0, it means no fee |\n| st | boolean | Whether it is an [Special Treatment](https://www.kucoin.com/legal/special-treatment) symbol |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "symbols" + ], + "query": [ + { + "key": "market", + "value": "", + "description": "[The trading market](https://www.kucoin.com/docs-new/api-222921786)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"BTC-USDT\",\n \"name\": \"BTC-USDT\",\n \"baseCurrency\": \"BTC\",\n \"quoteCurrency\": \"USDT\",\n \"feeCurrency\": \"USDT\",\n \"market\": \"USDS\",\n \"baseMinSize\": \"0.00001\",\n \"quoteMinSize\": \"0.1\",\n \"baseMaxSize\": \"10000000000\",\n \"quoteMaxSize\": \"99999999\",\n \"baseIncrement\": \"0.00000001\",\n \"quoteIncrement\": \"0.000001\",\n \"priceIncrement\": \"0.1\",\n \"priceLimitRate\": \"0.1\",\n \"minFunds\": \"0.1\",\n \"isMarginEnabled\": true,\n \"enableTrading\": true,\n \"feeCategory\": 1,\n \"makerFeeCoefficient\": \"1.00\",\n \"takerFeeCoefficient\": \"1.00\",\n \"st\": false\n }\n ]\n}" + } + ] + }, + { + "name": "Get Currency", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "currencies", + "{{currency}}" + ], + "query": [ + { + "key": "chain", + "value": "", + "description": "Support for querying the chain of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20. This only apply for multi-chain currency, and there is no need for single chain currency." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470155)\n\n:::info[Description]\nRequest via this endpoint to get the currency details of a specified currency\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | A unique currency code that will never change |\n| name | string | Currency name, will change after renaming |\n| fullName | string | Full name of a currency, will change after renaming |\n| precision | integer | Currency precision |\n| confirms | integer | Number of block confirmations |\n| contractAddress | string | Contract address |\n| isMarginEnabled | boolean | Support margin or not |\n| isDebitEnabled | boolean | Support debit or not |\n| chains | array | Refer to the schema section of chains |\n\n**root.data.chains Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| chainName | string | chain name of currency |\n| withdrawalMinSize | string | Minimum withdrawal amount |\n| depositMinSize | string | Minimum deposit amount |\n| withdrawFeeRate | string | withdraw fee rate |\n| withdrawalMinFee | string | Minimum fees charged for withdrawal |\n| isWithdrawEnabled | boolean | Support withdrawal or not |\n| isDepositEnabled | boolean | Support deposit or not |\n| confirms | integer | Number of block confirmations |\n| preConfirms | integer | The number of blocks (confirmations) for advance on-chain verification |\n| contractAddress | string | Contract address |\n| withdrawPrecision | integer | Withdrawal precision bit, indicating the maximum supported length after the decimal point of the withdrawal amount |\n| maxWithdraw | number | Maximum amount of single withdrawal |\n| maxDeposit | string | Maximum amount of single deposit (only applicable to Lightning Network) |\n| needTag | boolean | whether memo/tag is needed |\n| chainId | string | chain id of currency |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "currencies", + "{{currency}}" + ], + "query": [ + { + "key": "chain", + "value": "", + "description": "Support for querying the chain of currency, e.g. The available value for USDT are OMNI, ERC20, TRC20. This only apply for multi-chain currency, and there is no need for single chain currency." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currency\": \"BTC\",\n \"name\": \"BTC\",\n \"fullName\": \"Bitcoin\",\n \"precision\": 8,\n \"confirms\": null,\n \"contractAddress\": null,\n \"isMarginEnabled\": true,\n \"isDebitEnabled\": true,\n \"chains\": [\n {\n \"chainName\": \"BTC\",\n \"withdrawalMinSize\": \"0.001\",\n \"depositMinSize\": \"0.0002\",\n \"withdrawFeeRate\": \"0\",\n \"withdrawalMinFee\": \"0.0005\",\n \"isWithdrawEnabled\": true,\n \"isDepositEnabled\": true,\n \"confirms\": 3,\n \"preConfirms\": 1,\n \"contractAddress\": \"\",\n \"withdrawPrecision\": 8,\n \"maxWithdraw\": null,\n \"maxDeposit\": null,\n \"needTag\": false,\n \"chainId\": \"btc\"\n },\n {\n \"chainName\": \"Lightning Network\",\n \"withdrawalMinSize\": \"0.00001\",\n \"depositMinSize\": \"0.00001\",\n \"withdrawFeeRate\": \"0\",\n \"withdrawalMinFee\": \"0.000015\",\n \"isWithdrawEnabled\": true,\n \"isDepositEnabled\": true,\n \"confirms\": 1,\n \"preConfirms\": 1,\n \"contractAddress\": \"\",\n \"withdrawPrecision\": 8,\n \"maxWithdraw\": null,\n \"maxDeposit\": \"0.03\",\n \"needTag\": false,\n \"chainId\": \"btcln\"\n },\n {\n \"chainName\": \"KCC\",\n \"withdrawalMinSize\": \"0.0008\",\n \"depositMinSize\": null,\n \"withdrawFeeRate\": \"0\",\n \"withdrawalMinFee\": \"0.00002\",\n \"isWithdrawEnabled\": true,\n \"isDepositEnabled\": true,\n \"confirms\": 20,\n \"preConfirms\": 20,\n \"contractAddress\": \"0xfa93c12cd345c658bc4644d1d4e1b9615952258c\",\n \"withdrawPrecision\": 8,\n \"maxWithdraw\": null,\n \"maxDeposit\": null,\n \"needTag\": false,\n \"chainId\": \"kcc\"\n },\n {\n \"chainName\": \"BTC-Segwit\",\n \"withdrawalMinSize\": \"0.0008\",\n \"depositMinSize\": \"0.0002\",\n \"withdrawFeeRate\": \"0\",\n \"withdrawalMinFee\": \"0.0005\",\n \"isWithdrawEnabled\": false,\n \"isDepositEnabled\": true,\n \"confirms\": 2,\n \"preConfirms\": 2,\n \"contractAddress\": \"\",\n \"withdrawPrecision\": 8,\n \"maxWithdraw\": null,\n \"maxDeposit\": null,\n \"needTag\": false,\n \"chainId\": \"bech32\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Server Time", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "timestamp" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470156)\n\n:::info[Description]\nGet the server time.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | integer | ServerTime(millisecond) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "timestamp" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": 1729100692873\n}" + } + ] + }, + { + "name": "Get Announcements", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "announcements" + ], + "query": [ + { + "key": "currentPage", + "value": "1", + "description": "page number" + }, + { + "key": "pageSize", + "value": "50", + "description": "page Size" + }, + { + "key": "annType", + "value": "latest-announcements", + "description": "Announcement types: latest-announcements , activities (latest activities), new-listings (new currency online), product-updates (product updates), vip (institutions and VIPs), maintenance-updates (system maintenance), product -updates (product news), delistings (currency offline), others, api-campaigns (API user activities), default : latest-announcements" + }, + { + "key": "lang", + "value": "en_US", + "description": "Language type, the default is en_US, the specific value parameters are as follows" + }, + { + "key": "startTime", + "value": "1729594043000", + "description": "Announcement online start time (milliseconds)" + }, + { + "key": "endTime", + "value": "1729697729000", + "description": "Announcement online end time (milliseconds)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470157)\n\n:::info[Description]\nThis interface can obtain the latest news announcements, and the default page search is for announcements within a month.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| totalNum | integer | Total Number |\n| items | array | Refer to the schema section of items |\n| currentPage | integer | Current page |\n| pageSize | integer | Page size |\n| totalPage | integer | Total Page |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| annId | integer | Announcement ID |\n| annTitle | string | Announcement title |\n| annType | array | Refer to the schema section of annType |\n| annDesc | string | Announcement description |\n| cTime | integer | Announcement release time, Unix millisecond timestamp format |\n| language | string | language type |\n| annUrl | string | Announcement link |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "announcements" + ], + "query": [ + { + "key": "currentPage", + "value": "1", + "description": "page number" + }, + { + "key": "pageSize", + "value": "50", + "description": "page Size" + }, + { + "key": "annType", + "value": "latest-announcements", + "description": "Announcement types: latest-announcements , activities (latest activities), new-listings (new currency online), product-updates (product updates), vip (institutions and VIPs), maintenance-updates (system maintenance), product -updates (product news), delistings (currency offline), others, api-campaigns (API user activities), default : latest-announcements" + }, + { + "key": "lang", + "value": "en_US", + "description": "Language type, the default is en_US, the specific value parameters are as follows" + }, + { + "key": "startTime", + "value": "1729594043000", + "description": "Announcement online start time (milliseconds)" + }, + { + "key": "endTime", + "value": "1729697729000", + "description": "Announcement online end time (milliseconds)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"totalNum\": 195,\n \"totalPage\": 13,\n \"currentPage\": 1,\n \"pageSize\": 15,\n \"items\": [\n {\n \"annId\": 129045,\n \"annTitle\": \"KuCoin Isolated Margin Adds the Scroll (SCR) Trading Pair\",\n \"annType\": [\n \"latest-announcements\"\n ],\n \"annDesc\": \"To enrich the variety of assets available, KuCoin’s Isolated Margin Trading platform has added the Scroll (SCR) asset and trading pair.\",\n \"cTime\": 1729594043000,\n \"language\": \"en_US\",\n \"annUrl\": \"https://www.kucoin.com/announcement/kucoin-isolated-margin-adds-scr?lang=en_US\"\n },\n {\n \"annId\": 129001,\n \"annTitle\": \"DAPP-30D Fixed Promotion, Enjoy an APR of 200%!​\",\n \"annType\": [\n \"latest-announcements\",\n \"activities\"\n ],\n \"annDesc\": \"KuCoin Earn will be launching the DAPP Fixed Promotion at 10:00:00 on October 22, 2024 (UTC). The available product is “DAPP-30D'' with an APR of 200%.\",\n \"cTime\": 1729588460000,\n \"language\": \"en_US\",\n \"annUrl\": \"https://www.kucoin.com/announcement/dapp-30d-fixed-promotion-enjoy?lang=en_US\"\n },\n {\n \"annId\": 128581,\n \"annTitle\": \"NAYM (NAYM) Gets Listed on KuCoin! World Premiere!\",\n \"annType\": [\n \"latest-announcements\",\n \"new-listings\"\n ],\n \"annDesc\": \"Trading: 11:00 on October 22, 2024 (UTC)\",\n \"cTime\": 1729497729000,\n \"language\": \"en_US\",\n \"annUrl\": \"https://www.kucoin.com/announcement/en-naym-naym-gets-listed-on-kucoin-world-premiere?lang=en_US\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Service Status", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "status" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470158)\n\n:::info[Description]\nGet the service status\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| status | string | Status of service: open：normal transaction, close：Stop Trading/Maintenance, cancelonly：can only cancel the order but not place order |\n| msg | string | Remark for operation |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "status" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"status\": \"open\",\n \"msg\": \"\"\n }\n}" + } + ] + }, + { + "name": "Get Symbol ", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "symbols", + "{{symbol}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470159)\n\n:::info[Description]\nRequest via this endpoint to get detail currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers.\n:::\n\n\n- The baseMinSize and baseMaxSize fields define the min and max order size.\n- The priceIncrement field specifies the min order price as well as the price increment.This also applies to quote currency.\n\nThe order price must be a positive integer multiple of this priceIncrement (i.e. if the increment is 0.01, the 0.001 and 0.021 order prices would be rejected).\n\npriceIncrement and quoteIncrement may be adjusted in the future. We will notify you by email and site notifications before adjustment.\n\n| Order Type | Follow the rules of minFunds |\n| ------ | ---------- |\n| Limit Buy\t | [Order Amount * Order Price] >= minFunds |\n| Limit Sell | [Order Amount * Order Price] >= minFunds |\n| Market Buy | Order Value >= minFunds |\n| Market Sell | [Order Amount * Last Price of Base Currency] >= minFunds |\n\nNote:\n- API market buy orders (by amount) valued at (Order Amount * Last Price of Base Currency) < minFunds will be rejected.\n- API market sell orders (by value) valued at < minFunds will be rejected.\n- Take profit and stop loss orders at market or limit prices will be rejected when triggered.\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | unique code of a symbol, it would not change after renaming |\n| name | string | Name of trading pairs, it would change after renaming |\n| baseCurrency | string | Base currency,e.g. BTC. |\n| quoteCurrency | string | Quote currency,e.g. USDT. |\n| feeCurrency | string | The currency of charged fees. |\n| market | string | The trading market. |\n| baseMinSize | string | The minimum order quantity requried to place an order. |\n| quoteMinSize | string | The minimum order funds required to place a market order. |\n| baseMaxSize | string | The maximum order size required to place an order. |\n| quoteMaxSize | string | The maximum order funds required to place a market order. |\n| baseIncrement | string | Quantity increment: The quantity for an order must be a positive integer multiple of this increment. Here, the size refers to the quantity of the base currency for the order. For example, for the ETH-USDT trading pair, if the baseIncrement is 0.0000001, the order quantity can be 1.0000001 but not 1.00000001. |\n| quoteIncrement | string | Quote increment: The funds for a market order must be a positive integer multiple of this increment. The funds refer to the quote currency amount. For example, for the ETH-USDT trading pair, if the quoteIncrement is 0.000001, the amount of USDT for the order can be 3000.000001 but not 3000.0000001. |\n| priceIncrement | string | Price increment: The price of an order must be a positive integer multiple of this increment. For example, for the ETH-USDT trading pair, if the priceIncrement is 0.01, the order price can be 3000.01 but not 3000.001. |\n| priceLimitRate | string | Threshold for price portection |\n| minFunds | string | the minimum trading amounts |\n| isMarginEnabled | boolean | Available for margin or not. |\n| enableTrading | boolean | Available for transaction or not. |\n| feeCategory | integer | [Fee Type](https://www.kucoin.com/vip/privilege) |\n| makerFeeCoefficient | string | The maker fee coefficient. The actual fee needs to be multiplied by this coefficient to get the final fee. Most currencies have a coefficient of 1. If set to 0, it means no fee |\n| takerFeeCoefficient | string | The taker fee coefficient. The actual fee needs to be multiplied by this coefficient to get the final fee. Most currencies have a coefficient of 1. If set to 0, it means no fee |\n| st | boolean | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "symbols", + "{{symbol}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"BTC-USDT\",\n \"name\": \"BTC-USDT\",\n \"baseCurrency\": \"BTC\",\n \"quoteCurrency\": \"USDT\",\n \"feeCurrency\": \"USDT\",\n \"market\": \"USDS\",\n \"baseMinSize\": \"0.00001\",\n \"quoteMinSize\": \"0.1\",\n \"baseMaxSize\": \"10000000000\",\n \"quoteMaxSize\": \"99999999\",\n \"baseIncrement\": \"0.00000001\",\n \"quoteIncrement\": \"0.000001\",\n \"priceIncrement\": \"0.1\",\n \"priceLimitRate\": \"0.1\",\n \"minFunds\": \"0.1\",\n \"isMarginEnabled\": true,\n \"enableTrading\": true,\n \"feeCategory\": 1,\n \"makerFeeCoefficient\": \"1.00\",\n \"takerFeeCoefficient\": \"1.00\",\n \"st\": false\n }\n}" + } + ] + }, + { + "name": "Get Ticker", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "orderbook", + "level1" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470160)\n\n:::info[Description]\nRequest via this endpoint to get Level 1 Market Data. The returned value includes the best bid price and size, the best ask price and size as well as the last traded price and the last traded size.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| time | integer | timestamp |\n| sequence | string | Sequence |\n| price | string | Last traded price |\n| size | string | Last traded size |\n| bestBid | string | Best bid price |\n| bestBidSize | string | Best bid size |\n| bestAsk | string | Best ask price |\n| bestAskSize | string | Best ask size |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "orderbook", + "level1" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"time\": 1729172965609,\n \"sequence\": \"14609309753\",\n \"price\": \"67269\",\n \"size\": \"0.000025\",\n \"bestBid\": \"67267.5\",\n \"bestBidSize\": \"0.000025\",\n \"bestAsk\": \"67267.6\",\n \"bestAskSize\": \"1.24808993\"\n }\n}" + } + ] + }, + { + "name": "Get 24hr Stats", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "stats" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470161)\n\n:::info[Description]\nRequest via this endpoint to get the statistics of the specified ticker in the last 24 hours.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| time | integer | timestamp |\n| symbol | string | Symbol |\n| buy | string | Best bid price
|\n| sell | string | Best ask price |\n| changeRate | string | 24h change rate |\n| changePrice | string | 24h change price |\n| high | string | Highest price in 24h |\n| low | string | Lowest price in 24h |\n| vol | string | 24h volume, executed based on base currency |\n| volValue | string | 24h traded amount |\n| last | string | Last traded price |\n| averagePrice | string | Average trading price in the last 24 hours |\n| takerFeeRate | string | Basic Taker Fee |\n| makerFeeRate | string | Basic Maker Fee |\n| takerCoefficient | string | The taker fee coefficient. The actual fee needs to be multiplied by this coefficient to get the final fee. Most currencies have a coefficient of 1. If set to 0, it means no fee |\n| makerCoefficient | string | The maker fee coefficient. The actual fee needs to be multiplied by this coefficient to get the final fee. Most currencies have a coefficient of 1. If set to 0, it means no fee |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "stats" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"time\": 1729175612158,\n \"symbol\": \"BTC-USDT\",\n \"buy\": \"66982.4\",\n \"sell\": \"66982.5\",\n \"changeRate\": \"-0.0114\",\n \"changePrice\": \"-778.1\",\n \"high\": \"68107.7\",\n \"low\": \"66683.3\",\n \"vol\": \"1738.02898182\",\n \"volValue\": \"117321982.415978333\",\n \"last\": \"66981.5\",\n \"averagePrice\": \"67281.21437289\",\n \"takerFeeRate\": \"0.001\",\n \"makerFeeRate\": \"0.001\",\n \"takerCoefficient\": \"1\",\n \"makerCoefficient\": \"1\"\n }\n}" + } + ] + }, + { + "name": "Get Trade History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "histories" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470162)\n\n:::info[Description]\nRequest via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| sequence | string | Sequence number |\n| price | string | Filled price |\n| size | string | Filled amount |\n| side | string | Filled side, The trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book. |\n| time | integer | Filled timestamp(nanosecond) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "histories" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"sequence\": \"10976028003549185\",\n \"price\": \"67122\",\n \"size\": \"0.000025\",\n \"side\": \"buy\",\n \"time\": 1729177117877000000\n },\n {\n \"sequence\": \"10976028003549188\",\n \"price\": \"67122\",\n \"size\": \"0.01792257\",\n \"side\": \"buy\",\n \"time\": 1729177117877000000\n },\n {\n \"sequence\": \"10976028003549191\",\n \"price\": \"67122.9\",\n \"size\": \"0.05654289\",\n \"side\": \"buy\",\n \"time\": 1729177117877000000\n }\n ]\n}" + } + ] + }, + { + "name": "Get Klines", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "candles" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": " symbol" + }, + { + "key": "type", + "value": "1min", + "description": "Type of candlestick patterns: 1min, 3min, 5min, 15min, 30min, 1hour, 2hour, 4hour, 6hour, 8hour, 12hour, 1day, 1week, 1month" + }, + { + "key": "startAt", + "value": "1566703297", + "description": "Start time (second), default is 0" + }, + { + "key": "endAt", + "value": "1566789757", + "description": "End time (second), default is 0" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470163)\n\n:::info[Description]\nGet the Kline of the symbol. Data are returned in grouped buckets based on requested type.\nFor each query, the system would return at most 1500 pieces of data. To obtain more data, please page the data by time.\n:::\n\n:::tip[Tips]\nKlines data may be incomplete. No data is published for intervals where there are no ticks.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "candles" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": " symbol" + }, + { + "key": "type", + "value": "1min", + "description": "Type of candlestick patterns: 1min, 3min, 5min, 15min, 30min, 1hour, 2hour, 4hour, 6hour, 8hour, 12hour, 1day, 1week, 1month" + }, + { + "key": "startAt", + "value": "1566703297", + "description": "Start time (second), default is 0" + }, + { + "key": "endAt", + "value": "1566789757", + "description": "End time (second), default is 0" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n [\n \"1566789720\",\n \"10411.5\",\n \"10401.9\",\n \"10411.5\",\n \"10396.3\",\n \"29.11357276\",\n \"302889.301529914\"\n ],\n [\n \"1566789660\",\n \"10416\",\n \"10411.5\",\n \"10422.3\",\n \"10411.5\",\n \"15.61781842\",\n \"162703.708997029\"\n ],\n [\n \"1566789600\",\n \"10408.6\",\n \"10416\",\n \"10416\",\n \"10405.4\",\n \"12.45584973\",\n \"129666.51508559\"\n ]\n ]\n}" + } + ] + }, + { + "name": "Get Full OrderBook", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "market", + "orderbook", + "level2" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470164)\n\n:::info[Description]\nQuery for Full orderbook depth data. (aggregated by price)\n\nIt is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control.\n\nTo maintain up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| time | integer | Timestamp(millisecond) |\n| sequence | string | Sequence number |\n| bids | array | Refer to the schema section of bids |\n| asks | array | Refer to the schema section of asks |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "market", + "orderbook", + "level2" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"time\": 1729176273859,\n \"sequence\": \"14610502970\",\n \"bids\": [\n [\n \"66976.4\",\n \"0.69109872\"\n ],\n [\n \"66976.3\",\n \"0.14377\"\n ]\n ],\n \"asks\": [\n [\n \"66976.5\",\n \"0.05408199\"\n ],\n [\n \"66976.8\",\n \"0.0005\"\n ]\n ]\n }\n}" + } + ] + }, + { + "name": "Get Part OrderBook", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "orderbook", + "level2_{size}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470165)\n\n:::info[Description]\nQuery for part orderbook depth data. (aggregated by price)\n\nYou are recommended to request via this endpoint as the system reponse would be faster and cosume less traffic.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| time | integer | Timestamp(millisecond) |\n| sequence | string | Sequence number |\n| bids | array | Refer to the schema section of bids |\n| asks | array | Refer to the schema section of asks |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "orderbook", + "level2_{size}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"time\": 1729176273859,\n \"sequence\": \"14610502970\",\n \"bids\": [\n [\n \"66976.4\",\n \"0.69109872\"\n ],\n [\n \"66976.3\",\n \"0.14377\"\n ]\n ],\n \"asks\": [\n [\n \"66976.5\",\n \"0.05408199\"\n ],\n [\n \"66976.8\",\n \"0.0005\"\n ]\n ]\n }\n}" + } + ] + }, + { + "name": "Get Market List", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "markets" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470166)\n\n:::info[Description]\nRequest via this endpoint to get the transaction currency for the entire trading market.\n:::\n\n:::tip[Tips]\nSC has been changed to USDS, but you can still use SC as a query parameter\n\nThe three markets of ETH, NEO and TRX are merged into the ALTS market. You can query the trading pairs of the ETH, NEO and TRX markets through the ALTS trading area.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "markets" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n \"USDS\",\n \"TON\",\n \"AI\",\n \"DePIN\",\n \"PoW\",\n \"BRC-20\",\n \"ETF\",\n \"KCS\",\n \"Meme\",\n \"Solana\",\n \"FIAT\",\n \"VR&AR\",\n \"DeFi\",\n \"Polkadot\",\n \"BTC\",\n \"ALTS\",\n \"Layer 1\"\n ]\n}" + } + ] + }, + { + "name": "Get All Tickers", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "allTickers" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470167)\n\n:::info[Description]\nRequest market tickers for all the trading pairs in the market (including 24h volume), takes a snapshot every 2 seconds.\n\nOn the rare occasion that we will change the currency name, if you still want the changed symbol name, you can use the symbolName field instead of the symbol field via “Get Symbols List” endpoint.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| time | integer | timestamp |\n| ticker | array | Refer to the schema section of ticker |\n\n**root.data.ticker Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol |\n| symbolName | string | Name of trading pairs, it would change after renaming |\n| buy | string | Best bid price |\n| bestBidSize | string | Best bid size |\n| sell | string | Best ask price |\n| bestAskSize | string | Best ask size |\n| changeRate | string | 24h change rate |\n| changePrice | string | 24h change price |\n| high | string | Highest price in 24h |\n| low | string | Lowest price in 24h |\n| vol | string | 24h volume, executed based on base currency |\n| volValue | string | 24h traded amount |\n| last | string | Last traded price |\n| averagePrice | string | Average trading price in the last 24 hours |\n| takerFeeRate | string | Basic Taker Fee |\n| makerFeeRate | string | Basic Maker Fee |\n| takerCoefficient | string | The taker fee coefficient. The actual fee needs to be multiplied by this coefficient to get the final fee. Most currencies have a coefficient of 1. If set to 0, it means no fee |\n| makerCoefficient | string | The maker fee coefficient. The actual fee needs to be multiplied by this coefficient to get the final fee. Most currencies have a coefficient of 1. If set to 0, it means no fee |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "market", + "allTickers" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"time\": 1729173207043,\n \"ticker\": [\n {\n \"symbol\": \"BTC-USDT\",\n \"symbolName\": \"BTC-USDT\",\n \"buy\": \"67192.5\",\n \"bestBidSize\": \"0.000025\",\n \"sell\": \"67192.6\",\n \"bestAskSize\": \"1.24949204\",\n \"changeRate\": \"-0.0014\",\n \"changePrice\": \"-98.5\",\n \"high\": \"68321.4\",\n \"low\": \"66683.3\",\n \"vol\": \"1836.03034612\",\n \"volValue\": \"124068431.06726933\",\n \"last\": \"67193\",\n \"averagePrice\": \"67281.21437289\",\n \"takerFeeRate\": \"0.001\",\n \"makerFeeRate\": \"0.001\",\n \"takerCoefficient\": \"1\",\n \"makerCoefficient\": \"1\"\n }\n ]\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Orders", + "item": [ + { + "name": "Batch Add Orders", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "multi" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470168)\n\n:::info[Description]\nThis endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.\n:::\n\n\n\n:::tip[Tips]\nThis endpoint only supports order placement requests. To obtain the results of the order placement, you will need to check the order status or subscribe to websocket to obtain information about he order.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type `limit` and `market` |\n| side | String | Yes | `buy` or `sell` |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| tags | String | No | Order tag, length cannot exceed `20` characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed `20` characters (ASCII) |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderList | array | Refer to the schema section of orderList |\n\n**root.orderList Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.
|\n| symbol | string | symbol |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading |\n| side | string | Specify if the order is to 'buy' or 'sell' |\n| price | string | Specify price for order |\n| size | string | Specify quantity for order

When **type** is limit, select one out of two: size or funds, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| tags | string | Order tag, length cannot exceed 20 characters (ASCII) |\n| remark | string | Order placement remarks, length cannot exceed 20 characters (ASCII) |\n| funds | string | When **type** is market, select one out of two: size or funds |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| clientOid | string | The user self-defined order id. |\n| success | boolean | Add order success/failure |\n| failMsg | string | error message |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"orderList\": [\n {\n \"clientOid\": \"client order id 12\",\n \"symbol\": \"BTC-USDT\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"30000\",\n \"size\": \"0.00001\"\n },\n {\n \"clientOid\": \"client order id 13\",\n \"symbol\": \"ETH-USDT\",\n \"type\": \"limit\",\n \"side\": \"sell\",\n \"price\": \"2000\",\n \"size\": \"0.00001\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "multi" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"orderId\": \"6710d8336afcdb0007319c27\",\n \"clientOid\": \"client order id 12\",\n \"success\": true\n },\n {\n \"success\": false,\n \"failMsg\": \"The order funds should more then 0.1 USDT.\"\n }\n ]\n}" + } + ] + }, + { + "name": "Batch Add Orders Sync", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "multi", + "sync" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470169)\n\n:::info[Description]\nThis endpoint supports sequential batch order placement from a single endpoint. A maximum of 20 orders can be placed simultaneously.\n\nThe difference between this interface and \"Batch Add Orders\" is that this interface will synchronously return the order information after the order matching is completed.\n\nFor higher latency requirements, please select the \"Batch Add Orders\" interface. If there is a requirement for returning data integrity, please select this interface\n:::\n\n\n\n:::tip[Tips]\nThis endpoint only supports order placement requests. To obtain the results of the order placement, you will need to check the order status or subscribe to websocket to obtain information about he order.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type `limit` and `market` |\n| side | String | Yes | `buy` or `sell` |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| tags | String | No | Order tag, length cannot exceed `20` characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed `20` characters (ASCII) |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderList | array | Refer to the schema section of orderList |\n\n**root.orderList Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.
|\n| symbol | string | symbol |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading |\n| side | string | Specify if the order is to 'buy' or 'sell' |\n| price | string | Specify price for order |\n| size | string | Specify quantity for order

When **type** is limit, select one out of two: size or funds, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| tags | string | Order tag, length cannot exceed 20 characters (ASCII) |\n| remark | string | Order placement remarks, length cannot exceed 20 characters (ASCII) |\n| funds | string | When **type** is market, select one out of two: size or funds |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| clientOid | string | The user self-defined order id. |\n| orderTime | integer | |\n| originSize | string | original order size |\n| dealSize | string | deal size |\n| remainSize | string | remain size |\n| canceledSize | string | Cumulative canceled size |\n| status | string | Order Status. open：order is active; done：order has been completed |\n| matchTime | integer | |\n| success | boolean | Add order success/failure |\n| failMsg | string | error message |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"orderList\": [\n {\n \"clientOid\": \"client order id 13\",\n \"symbol\": \"BTC-USDT\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"30000\",\n \"size\": \"0.00001\"\n },\n {\n \"clientOid\": \"client order id 14\",\n \"symbol\": \"ETH-USDT\",\n \"type\": \"limit\",\n \"side\": \"sell\",\n \"price\": \"2000\",\n \"size\": \"0.00001\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "multi", + "sync" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"orderId\": \"6711195e5584bc0007bd5aef\",\n \"clientOid\": \"client order id 13\",\n \"orderTime\": 1729173854299,\n \"originSize\": \"0.00001\",\n \"dealSize\": \"0\",\n \"remainSize\": \"0.00001\",\n \"canceledSize\": \"0\",\n \"status\": \"open\",\n \"matchTime\": 1729173854326,\n \"success\": true\n },\n {\n \"success\": false,\n \"failMsg\": \"The order funds should more then 0.1 USDT.\"\n }\n ]\n}" + } + ] + }, + { + "name": "Add Order Sync", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "sync" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470170)\n\n:::info[Description]\nPlace order to the spot trading system\n\nThe difference between this interface and \"Add order\" is that this interface will synchronously return the order information after the order matching is completed.\n\nFor higher latency requirements, please select the \"Add order\" interface. If there is a requirement for returning data integrity, please select this interface\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type `limit` and `market` |\n| side | String | Yes | `buy` or `sell` |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| tags | String | No | Order tag, length cannot exceed `20` characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed `20` characters (ASCII) |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. |\n| remark | string | Order placement remarks, length cannot exceed 20 characters (ASCII) |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| tags | string | Order tag, length cannot exceed 20 characters (ASCII) |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| funds | string | When **type** is market, select one out of two: size or funds |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| clientOid | string | The user self-defined order id. |\n| orderTime | integer | |\n| originSize | string | original order size |\n| dealSize | string | deal size |\n| remainSize | string | remain size |\n| canceledSize | string | Cumulative canceled size |\n| status | string | Order Status. open：order is active; done：order has been completed |\n| matchTime | integer | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493f\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\",\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\",\n// }\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "sync" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"67111a7cb7cbdf000703e1f6\",\n \"clientOid\": \"5c52e11203aa677f33e493f\",\n \"orderTime\": 1729174140586,\n \"originSize\": \"0.00001\",\n \"dealSize\": \"0\",\n \"remainSize\": \"0.00001\",\n \"canceledSize\": \"0\",\n \"status\": \"open\",\n \"matchTime\": 1729174140588\n }\n}" + } + ] + }, + { + "name": "Modify Order", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "alter" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470171)\n\n:::info[Description]\nThis interface can modify the price and quantity of the order according to orderId or clientOid.\n\nThe implementation of this interface is: cancel the order and place a new order on the same trading pair, and return the modification result to the client synchronously\n\nWhen the quantity of the new order updated by the user is less than the filled quantity of this order, the order will be considered as completed, and the order will be cancelled, and no new order will be placed\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | The old client order id,orderId and clientOid must choose one |\n| symbol | string | symbol |\n| orderId | string | The old order id, orderId and clientOid must choose one |\n| newPrice | string | The modified price of the new order, newPrice and newSize must choose one |\n| newSize | string | The modified size of the new order, newPrice and newSize must choose one |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| newOrderId | string | The new order id |\n| clientOid | string | The original client order id |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "alter" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"newOrderId\": \"67112258f9406e0007408827\",\n \"clientOid\": \"client order id 12\"\n }\n}" + } + ] + }, + { + "name": "Get DCP", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "dead-cancel-all", + "query" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470172)\n\n:::info[Description]\nGet Disconnection Protect(Deadman Swich)Through this interface, you can query the settings of automatic order cancellation\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| timeout | integer | Auto cancel order trigger setting time, the unit is second. range: timeout=-1 (meaning unset) or 5 <= timeout <= 86400 |\n| symbols | string | List of trading pairs. Separated by commas, empty means all trading pairs |\n| currentTime | integer | System current time (in seconds) |\n| triggerTime | integer | Trigger cancellation time (in seconds) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "dead-cancel-all", + "query" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"timeout\": 5,\n \"symbols\": \"BTC-USDT,ETH-USDT\",\n \"currentTime\": 1729241305,\n \"triggerTime\": 1729241308\n }\n}" + } + ] + }, + { + "name": "Set DCP", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "dead-cancel-all" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470173)\n\n:::info[Description]\nSet Disconnection Protect(Deadman Swich)Through this interface, Call this interface to automatically cancel all orders of the set trading pair after the specified time. If this interface is not called again for renewal or cancellation before the set time, the system will help the user to cancel the order of the corresponding trading pair. Otherwise it will not.\n:::\n\n:::tip[Tips]\nThe order cancellation delay is between 0 and 10 seconds, and the order will not be canceled in real time. When the system cancels the order, if the transaction pair status is no longer operable to cancel the order, it will not cancel the order\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| timeout | integer | Auto cancel order trigger setting time, the unit is second. range: timeout=-1 (meaning unset) or 5 <= timeout <= 86400. For example, timeout=5 means that the order will be automatically canceled if no user request is received for more than 5 seconds. When this parameter is changed, the previous setting will be overwritten. |\n| symbols | string | List of trading pairs. When this parameter is not empty, separate it with commas and support up to 50 trading pairs. Empty means all trading pairs. When this parameter is changed, the previous setting will be overwritten. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentTime | integer | System current time (in seconds) |\n| triggerTime | integer | Trigger cancellation time (in seconds) |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"timeout\": 5,\n \"symbols\": \"BTC-USDT,ETH-USDT\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "dead-cancel-all" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentTime\": 1729656588,\n \"triggerTime\": 1729656593\n }\n}" + } + ] + }, + { + "name": "Cancel Order By OrderId", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470174)\n\n:::info[Description]\nThis endpoint can be used to cancel a spot order by orderId.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | order id |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"671124f9365ccb00073debd4\"\n }\n}" + } + ] + }, + { + "name": "Cancel Stop Order By OrderId", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order", + "{{orderId}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470335)\n\n:::info[Description]\nRequest via this endpoint to cancel a single stop order previously placed.\n\nYou will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the websocket pushes.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order", + "{{orderId}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"671124f9365ccb00073debd4\"\n ]\n }\n}" + } + ] + }, + { + "name": "Cancel All Orders By Symbol", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470175)\n\n:::info[Description]\nThis endpoint can cancel all spot orders for specific symbol.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": \"success\"\n}" + } + ] + }, + { + "name": "Cancel All Orders", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "cancelAll" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470176)\n\n:::info[Description]\nThis endpoint can cancel all spot orders for all symbol.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| succeedSymbols | array | Refer to the schema section of succeedSymbols |\n| failedSymbols | array | Refer to the schema section of failedSymbols |\n\n**root.data.failedSymbols Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | symbol |\n| error | string | error message |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "cancelAll" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"succeedSymbols\": [\n \"ETH-USDT\",\n \"BTC-USDT\"\n ],\n \"failedSymbols\": []\n }\n}" + } + ] + }, + { + "name": "Cancel OCO Order By OrderId", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "order", + "{{orderId}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470354)\n\n:::info[Description]\nRequest via this endpoint to cancel a single oco order previously placed.\n\nYou will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "order", + "{{orderId}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"vs93gpqc6kkmkk57003gok16\",\n \"vs93gpqc6kkmkk57003gok17\"\n ]\n }\n}" + } + ] + }, + { + "name": "Get Symbols With Open Order", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "active", + "symbols" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470177)\n\n:::info[Description]\nThis interface can query all spot symbol that has active orders\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbols | array | Refer to the schema section of symbols |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "active", + "symbols" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbols\": [\n \"ETH-USDT\",\n \"BTC-USDT\"\n ]\n }\n}" + } + ] + }, + { + "name": "Get Open Orders", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "active" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470178)\n\n:::info[Description]\nThis interface is to obtain all Spot active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nFor high-frequency trading users, we recommend locally caching, maintaining your own order records, and using market data streams to update your order information in real time.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | The unique order id generated by the trading system |\n| symbol | string | symbol |\n| opType | string | |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| side | string | Buy or sell |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| dealSize | string | Number of filled transactions |\n| dealFunds | string | Funds of filled transactions |\n| fee | string | [Handling fees](https://www.kucoin.com/docs-new/api-5327739) |\n| feeCurrency | string | currency used to calculate trading fee |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) |\n| timeInForce | string | Time in force |\n| postOnly | boolean | Whether its a postOnly order. |\n| hidden | boolean | Whether its a hidden order. |\n| iceberg | boolean | Whether its a iceberg order. |\n| visibleSize | string | Visible size of iceberg order in order book. |\n| cancelAfter | integer | A GTT timeInForce that expires in n seconds |\n| channel | string | |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| remark | string | Order placement remarks |\n| tags | string | Order tag |\n| cancelExist | boolean | Whether there is a cancellation record for the order. |\n| createdAt | integer | |\n| lastUpdatedAt | integer | |\n| tradeType | string | Trade type, redundancy param |\n| inOrderBook | boolean | Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook |\n| cancelledSize | string | Number of canceled transactions |\n| cancelledFunds | string | Funds of canceled transactions |\n| remainSize | string | Number of remain transactions |\n| remainFunds | string | Funds of remain transactions |\n| tax | string | Users in some regions need query this field |\n| active | boolean | Order status: true-The status of the order isactive; false-The status of the order is done |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "active" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"67120bbef094e200070976f6\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"funds\": \"0.5\",\n \"dealSize\": \"0\",\n \"dealFunds\": \"0\",\n \"fee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"remark\": \"order remarks\",\n \"tags\": \"order tags\",\n \"cancelExist\": false,\n \"tradeType\": \"TRADE\",\n \"inOrderBook\": true,\n \"cancelledSize\": \"0\",\n \"cancelledFunds\": \"0\",\n \"remainSize\": \"0.00001\",\n \"remainFunds\": \"0.5\",\n \"tax\": \"0\",\n \"active\": true,\n \"createdAt\": 1729235902748,\n \"lastUpdatedAt\": 1729235909862\n }\n ]\n}" + } + ] + }, + { + "name": "Get Stop Orders List", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470338)\n\n:::info[Description]\nRequest via this endpoint to get your current untriggered stop order list. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n\n:::\n\n\n:::tip[Example]\n```json\n{\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"id\": \"vs8hoo8kqjnklv4m0038lrfq\",\n \"symbol\": \"KCS-USDT\",\n \"userId\": \"60fe4956c43cbc0006562c2c\",\n \"status\": \"NEW\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.01000000000000000000\",\n \"size\": \"0.01000000000000000000\",\n \"funds\": null,\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": -1,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"clientOid\": \"404814a0fb4311eb9098acde48001122\",\n \"remark\": null,\n \"tags\": null,\n \"orderTime\": 1628755183702150167,\n \"domainId\": \"kucoin\",\n \"tradeSource\": \"USER\",\n \"tradeType\": \"TRADE\",\n \"feeCurrency\": \"USDT\",\n \"takerFeeRate\": \"0.00200000000000000000\",\n \"makerFeeRate\": \"0.00200000000000000000\",\n \"createdAt\": 1628755183704,\n \"stop\": \"loss\",\n \"stopTriggerTime\": null,\n \"stopPrice\": \"10.00000000000000000000\"\n }\n ]\n}\n```\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Only list orders for a specific symbol |\n| side | string | buy or sell |\n| type | string | limit, market, limit_stop or market_stop |\n| tradeType | string | The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE |\n| startAt | number | Start time (milisecond) |\n| endAt | number | End time (milisecond) |\n| currentPage | integer | current page |\n| orderIds | string | comma seperated order ID list |\n| pageSize | integer | page size |\n| stop | string | Order type: stop: stop loss order, oco: oco order |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | current page id |\n| pageSize | integer | |\n| totalNum | integer | the stop order count |\n| totalPage | integer | total page count of the list |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Order ID, the ID of an order. |\n| symbol | string | Symbol name |\n| userId | string | User ID |\n| status | string | Order status, include NEW, TRIGGERED |\n| type | string | Order type,limit, market, limit_stop or market_stop |\n| side | string | transaction direction,include buy and sell |\n| price | string | order price |\n| size | string | order quantity |\n| funds | string | order funds |\n| stp | string | |\n| timeInForce | string | time InForce,include GTC,GTT,IOC,FOK |\n| cancelAfter | integer | cancel orders after n seconds，requires timeInForce to be GTT |\n| postOnly | boolean | postOnly |\n| hidden | boolean | hidden order |\n| iceberg | boolean | Iceberg order |\n| visibleSize | string | displayed quantity for iceberg order |\n| channel | string | order source |\n| clientOid | string | user-entered order unique mark |\n| remark | string | Remarks at stop order creation |\n| tags | string | tag order source |\n| orderTime | integer | Time of place a stop order, accurate to nanoseconds |\n| domainId | string | domainId, e.g: kucoin |\n| tradeSource | string | trade source: USER（Order by user）, MARGIN_SYSTEM（Order by margin system） |\n| tradeType | string | The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). |\n| feeCurrency | string | The currency of the fee |\n| takerFeeRate | string | Fee Rate of taker |\n| makerFeeRate | string | Fee Rate of maker |\n| createdAt | integer | order creation time |\n| stop | string | Stop order type, include loss and entry |\n| stopTriggerTime | integer | The trigger time of the stop order |\n| stopPrice | string | stop price |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"symbol\": \"BTC-USDT\",\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"newPrice\": \"30000\",\n \"newSize\": \"0.0001\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"id\": \"vs8hoo8kqjnklv4m0038lrfq\",\n \"symbol\": \"KCS-USDT\",\n \"userId\": \"60fe4956c43cbc0006562c2c\",\n \"status\": \"NEW\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.01000000000000000000\",\n \"size\": \"0.01000000000000000000\",\n \"funds\": null,\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": -1,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"clientOid\": \"404814a0fb4311eb9098acde48001122\",\n \"remark\": null,\n \"tags\": null,\n \"orderTime\": 1628755183702150100,\n \"domainId\": \"kucoin\",\n \"tradeSource\": \"USER\",\n \"tradeType\": \"TRADE\",\n \"feeCurrency\": \"USDT\",\n \"takerFeeRate\": \"0.00200000000000000000\",\n \"makerFeeRate\": \"0.00200000000000000000\",\n \"createdAt\": 1628755183704,\n \"stop\": \"loss\",\n \"stopTriggerTime\": null,\n \"stopPrice\": \"10.00000000000000000000\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Closed Orders", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "done" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "side", + "value": null, + "description": "specify if the order is to 'buy' or 'sell'" + }, + { + "key": "type", + "value": null, + "description": "specify if the order is an 'limit' order or 'market' order. " + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page." + }, + { + "key": "limit", + "value": "20", + "description": "Default20，Max100" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470179)\n\n:::info[Description]\nThis interface is to obtain all Spot Closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| lastId | integer | The id of the last set of data from the previous batch of data. By default, the latest information is given.
lastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page. |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | The unique order id generated by the trading system |\n| symbol | string | symbol |\n| opType | string | |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| side | string | Buy or sell |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| dealSize | string | Number of filled transactions |\n| dealFunds | string | Funds of filled transactions |\n| fee | string | [Handling fees](https://www.kucoin.com/docs-new/api-5327739) |\n| feeCurrency | string | currency used to calculate trading fee |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) |\n| timeInForce | string | Time in force |\n| postOnly | boolean | Whether its a postOnly order. |\n| hidden | boolean | Whether its a hidden order. |\n| iceberg | boolean | Whether its a iceberg order. |\n| visibleSize | string | Visible size of iceberg order in order book. |\n| cancelAfter | integer | A GTT timeInForce that expires in n seconds |\n| channel | string | |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| remark | string | Order placement remarks |\n| tags | string | Order tag |\n| cancelExist | boolean | Whether there is a cancellation record for the order. |\n| createdAt | integer | |\n| lastUpdatedAt | integer | |\n| tradeType | string | Trade type, redundancy param |\n| inOrderBook | boolean | Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook |\n| cancelledSize | string | Number of canceled transactions |\n| cancelledFunds | string | Funds of canceled transactions |\n| remainSize | string | Number of remain transactions |\n| remainFunds | string | Funds of remain transactions |\n| tax | string | Users in some regions need query this field |\n| active | boolean | Order status: true-The status of the order isactive; false-The status of the order is done |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "done" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "side", + "value": null, + "description": "specify if the order is to 'buy' or 'sell'" + }, + { + "key": "type", + "value": null, + "description": "specify if the order is an 'limit' order or 'market' order. " + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page." + }, + { + "key": "limit", + "value": "20", + "description": "Default20，Max100" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"lastId\": 19814995255305,\n \"items\": [\n {\n \"id\": \"6717422bd51c29000775ea03\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"70000\",\n \"size\": \"0.00001\",\n \"funds\": \"0.7\",\n \"dealSize\": \"0.00001\",\n \"dealFunds\": \"0.677176\",\n \"remainSize\": \"0\",\n \"remainFunds\": \"0.022824\",\n \"cancelledSize\": \"0\",\n \"cancelledFunds\": \"0\",\n \"fee\": \"0.000677176\",\n \"feeCurrency\": \"USDT\",\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"remark\": \"order remarks\",\n \"tags\": null,\n \"cancelExist\": false,\n \"tradeType\": \"TRADE\",\n \"inOrderBook\": false,\n \"active\": false,\n \"tax\": \"0\",\n \"createdAt\": 1729577515444,\n \"lastUpdatedAt\": 1729577515481\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Stop Order By OrderId", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order", + "{{orderId}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470339)\n\n:::info[Description]\nRequest via this interface to get a stop order information via the order ID.\n\n:::\n\n\n:::tip[Example]\n```json\n{\n \"id\": \"vs8hoo8q2ceshiue003b67c0\",\n \"symbol\": \"KCS-USDT\",\n \"userId\": \"60fe4956c43cbc0006562c2c\",\n \"status\": \"NEW\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.01000000000000000000\",\n \"size\": \"0.01000000000000000000\",\n \"funds\": null,\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": -1,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"clientOid\": \"40e0eb9efe6311eb8e58acde48001122\",\n \"remark\": null,\n \"tags\": null,\n \"orderTime\": 1629098781127530345,\n \"domainId\": \"kucoin\",\n \"tradeSource\": \"USER\",\n \"tradeType\": \"TRADE\",\n \"feeCurrency\": \"USDT\",\n \"takerFeeRate\": \"0.00200000000000000000\",\n \"makerFeeRate\": \"0.00200000000000000000\",\n \"createdAt\": 1629098781128,\n \"stop\": \"loss\",\n \"stopTriggerTime\": null,\n \"stopPrice\": \"10.00000000000000000000\"\n}\n```\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Only list orders for a specific symbol |\n| side | string | buy or sell |\n| type | string | limit, market, limit_stop or market_stop |\n| tradeType | string | The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE |\n| startAt | number | Start time (milisecond) |\n| endAt | number | End time (milisecond) |\n| currentPage | integer | current page |\n| orderIds | string | comma seperated order ID list |\n| pageSize | integer | page size |\n| stop | string | Order type: stop: stop loss order, oco: oco order |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| data | object | Refer to the schema section of data |\n| code | string | return status code |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Order ID, the ID of an order. |\n| symbol | string | Symbol name |\n| userId | string | User ID |\n| status | string | Order status, include NEW, TRIGGERED |\n| type | string | Order type,limit, market, limit_stop or market_stop |\n| side | string | transaction direction,include buy and sell |\n| price | string | order price |\n| size | string | order quantity |\n| funds | string | order funds |\n| stp | string | |\n| timeInForce | string | time InForce,include GTC,GTT,IOC,FOK |\n| cancelAfter | integer | cancel orders after n seconds，requires timeInForce to be GTT |\n| postOnly | boolean | postOnly |\n| hidden | boolean | hidden order |\n| iceberg | boolean | Iceberg order |\n| visibleSize | string | displayed quantity for iceberg order |\n| channel | string | order source |\n| clientOid | string | user-entered order unique mark |\n| remark | string | Remarks at stop order creation |\n| tags | string | tag order source |\n| domainId | string | domainId, e.g: kucoin |\n| tradeSource | string | trade source: USER（Order by user）, MARGIN_SYSTEM（Order by margin system） |\n| tradeType | string | The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). |\n| feeCurrency | string | The currency of the fee |\n| takerFeeRate | string | Fee Rate of taker |\n| makerFeeRate | string | Fee Rate of maker |\n| createdAt | integer | order creation time |\n| stop | string | Stop order type, include loss and entry |\n| stopTriggerTime | integer | The trigger time of the stop order |\n| stopPrice | string | stop price |\n| orderTime | integer | Time of place a stop order, accurate to nanoseconds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order", + "{{orderId}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"vs8hoo8q2ceshiue003b67c0\",\n \"symbol\": \"KCS-USDT\",\n \"userId\": \"60fe4956c43cbc0006562c2c\",\n \"status\": \"NEW\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.01000000000000000000\",\n \"size\": \"0.01000000000000000000\",\n \"funds\": null,\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": -1,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"clientOid\": \"40e0eb9efe6311eb8e58acde48001122\",\n \"remark\": null,\n \"tags\": null,\n \"orderTime\": 1629098781127530200,\n \"domainId\": \"kucoin\",\n \"tradeSource\": \"USER\",\n \"tradeType\": \"TRADE\",\n \"feeCurrency\": \"USDT\",\n \"takerFeeRate\": \"0.00200000000000000000\",\n \"makerFeeRate\": \"0.00200000000000000000\",\n \"createdAt\": 1629098781128,\n \"stop\": \"loss\",\n \"stopTriggerTime\": null,\n \"stopPrice\": \"10.00000000000000000000\"\n }\n}" + } + ] + }, + { + "name": "Get Stop Order By ClientOid", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order", + "queryOrderByClientOid" + ], + "query": [ + { + "key": "clientOid", + "value": null, + "description": "The client order id" + }, + { + "key": "symbol", + "value": null, + "description": "symbol name" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470340)\n\n:::info[Description]\nRequest via this interface to get a stop order information via the clientOid.\n\n:::\n\n\n:::tip[Example]\n```json\n{\n \"id\": \"vs8hoo8q2ceshiue003b67c0\",\n \"symbol\": \"KCS-USDT\",\n \"userId\": \"60fe4956c43cbc0006562c2c\",\n \"status\": \"NEW\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.01000000000000000000\",\n \"size\": \"0.01000000000000000000\",\n \"funds\": null,\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": -1,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"clientOid\": \"40e0eb9efe6311eb8e58acde48001122\",\n \"remark\": null,\n \"tags\": null,\n \"orderTime\": 1629098781127530345,\n \"domainId\": \"kucoin\",\n \"tradeSource\": \"USER\",\n \"tradeType\": \"TRADE\",\n \"feeCurrency\": \"USDT\",\n \"takerFeeRate\": \"0.00200000000000000000\",\n \"makerFeeRate\": \"0.00200000000000000000\",\n \"createdAt\": 1629098781128,\n \"stop\": \"loss\",\n \"stopTriggerTime\": null,\n \"stopPrice\": \"10.00000000000000000000\"\n}\n```\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Only list orders for a specific symbol |\n| side | string | buy or sell |\n| type | string | limit, market, limit_stop or market_stop |\n| tradeType | string | The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE |\n| startAt | integer | Start time (milisecond) |\n| endAt | integer | End time (milisecond) |\n| currentPage | integer | current page |\n| orderIds | string | comma seperated order ID list |\n| pageSize | integer | page size |\n| stop | string | Order type: stop: stop loss order, oco: oco order |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | the return code |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Order ID, the ID of an order. |\n| symbol | string | Symbol name |\n| userId | string | User ID |\n| status | string | Order status, include NEW, TRIGGERED |\n| type | string | Order type,limit, market, limit_stop or market_stop |\n| side | string | transaction direction,include buy and sell |\n| price | string | order price |\n| size | string | order quantity |\n| funds | string | order funds |\n| stp | string | |\n| timeInForce | string | time InForce,include GTC,GTT,IOC,FOK |\n| cancelAfter | integer | cancel orders after n seconds，requires timeInForce to be GTT |\n| postOnly | boolean | postOnly |\n| hidden | boolean | hidden order |\n| iceberg | boolean | Iceberg order |\n| visibleSize | string | displayed quantity for iceberg order |\n| channel | string | order source |\n| clientOid | string | user-entered order unique mark |\n| remark | string | Remarks at stop order creation |\n| tags | string | tag order source |\n| domainId | string | domainId, e.g: kucoin |\n| tradeSource | string | trade source: USER（Order by user）, MARGIN_SYSTEM（Order by margin system） |\n| tradeType | string | The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). |\n| feeCurrency | string | The currency of the fee |\n| takerFeeRate | string | Fee Rate of taker |\n| makerFeeRate | string | Fee Rate of maker |\n| createdAt | integer | order creation time |\n| stop | string | Stop order type, include loss and entry |\n| stopTriggerTime | integer | The trigger time of the stop order |\n| stopPrice | string | stop price |\n| orderTime | integer | Time of place a stop order, accurate to nanoseconds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order", + "queryOrderByClientOid" + ], + "query": [ + { + "key": "clientOid", + "value": null, + "description": "The client order id" + }, + { + "key": "symbol", + "value": null, + "description": "symbol name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"vs8hoo8os561f5np0032vngj\",\n \"symbol\": \"KCS-USDT\",\n \"userId\": \"60fe4956c43cbc0006562c2c\",\n \"status\": \"NEW\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.01000000000000000000\",\n \"size\": \"0.01000000000000000000\",\n \"funds\": null,\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"cancelAfter\": -1,\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": null,\n \"channel\": \"API\",\n \"clientOid\": \"2b700942b5db41cebe578cff48960e09\",\n \"remark\": null,\n \"tags\": null,\n \"orderTime\": 1629020492834532600,\n \"domainId\": \"kucoin\",\n \"tradeSource\": \"USER\",\n \"tradeType\": \"TRADE\",\n \"feeCurrency\": \"USDT\",\n \"takerFeeRate\": \"0.00200000000000000000\",\n \"makerFeeRate\": \"0.00200000000000000000\",\n \"createdAt\": 1629020492837,\n \"stop\": \"loss\",\n \"stopTriggerTime\": null,\n \"stopPrice\": \"1.00000000000000000000\"\n }\n ]\n}" + } + ] + }, + { + "name": "Batch Cancel Stop Orders", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order", + "cancel" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "Cancel the open order for the specified symbol" + }, + { + "key": "tradeType", + "value": null, + "description": "The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE" + }, + { + "key": "orderIds", + "value": null, + "description": "Comma seperated order IDs." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470337)\n\n:::info[Description]\nRequest via this interface to cancel a batch of stop orders.\n\nThe count of orderId in the parameter now is not limited.\n\nAn example is:\n ```/api/v1/stop-order/cancel?symbol=ETH-BTC&tradeType=TRADE&orderIds=5bd6e9286d99522a52e458de,5bd6e9286d99522a52e458df```\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order", + "cancel" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "Cancel the open order for the specified symbol" + }, + { + "key": "tradeType", + "value": null, + "description": "The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE" + }, + { + "key": "orderIds", + "value": null, + "description": "Comma seperated order IDs." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"671124f9365ccb00073debd4\"\n ]\n }\n}" + } + ] + }, + { + "name": "Batch Cancel OCO Order", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "orders" + ], + "query": [ + { + "key": "orderIds", + "value": "674c388172cf2800072ee746,674c38bdfd8300000795167e", + "description": "Specify the order id, there can be multiple orders, separated by commas. If not passed, all oco orders will be canceled by default." + }, + { + "key": "symbol", + "value": "BTC-USDT", + "description": "trading pair. If not passed, the oco orders of all symbols will be canceled by default." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470356)\n\n:::info[Description]\nThis interface can batch cancel OCO orders through orderIds.\n\nYou will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "orders" + ], + "query": [ + { + "key": "orderIds", + "value": "674c388172cf2800072ee746,674c38bdfd8300000795167e", + "description": "Specify the order id, there can be multiple orders, separated by commas. If not passed, all oco orders will be canceled by default." + }, + { + "key": "symbol", + "value": "BTC-USDT", + "description": "trading pair. If not passed, the oco orders of all symbols will be canceled by default." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"vs93gpqc750mkk57003gok6i\",\n \"vs93gpqc750mkk57003gok6j\",\n \"vs93gpqc75c39p83003tnriu\",\n \"vs93gpqc75c39p83003tnriv\"\n ]\n }\n}" + } + ] + }, + { + "name": "Get Trade History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "fills" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "orderId", + "value": null, + "description": "The unique order id generated by the trading system\n(If orderId is specified，please ignore the other query parameters)" + }, + { + "key": "side", + "value": null, + "description": "specify if the order is to 'buy' or 'sell'" + }, + { + "key": "type", + "value": null, + "description": "specify if the order is an 'limit' order or 'market' order. " + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page." + }, + { + "key": "limit", + "value": "100", + "description": "Default20，Max100" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470180)\n\n:::info[Description]\nThis endpoint can be used to obtain a list of the latest Spot transaction details. \nThe returned data is sorted in descending order according to the latest update time of the order.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| items | array | Refer to the schema section of items |\n| lastId | integer | The id of the last set of data from the previous batch of data. By default, the latest information is given.
lastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page. |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | integer | Id of transaction detail |\n| symbol | string | symbol |\n| tradeId | integer | Trade Id, symbol latitude increment |\n| orderId | string | The unique order id generated by the trading system |\n| counterOrderId | string | Counterparty order Id |\n| side | string | Buy or sell |\n| liquidity | string | Liquidity type: taker or maker |\n| forceTaker | boolean | |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| fee | string | [Handling fees](https://www.kucoin.com/docs-new/api-5327739) |\n| feeRate | string | Fee rate
|\n| feeCurrency | string | currency used to calculate trading fee |\n| stop | string | Take Profit and Stop Loss type, currently HFT does not support the Take Profit and Stop Loss type, so it is empty |\n| tradeType | string | Trade type, redundancy param |\n| taxRate | string | Tax Rate, Users in some regions need query this field |\n| tax | string | Users in some regions need query this field |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| createdAt | integer | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "fills" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "orderId", + "value": null, + "description": "The unique order id generated by the trading system\n(If orderId is specified，please ignore the other query parameters)" + }, + { + "key": "side", + "value": null, + "description": "specify if the order is to 'buy' or 'sell'" + }, + { + "key": "type", + "value": null, + "description": "specify if the order is an 'limit' order or 'market' order. " + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page." + }, + { + "key": "limit", + "value": "100", + "description": "Default20，Max100" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"items\": [\n {\n \"id\": 19814995255305,\n \"orderId\": \"6717422bd51c29000775ea03\",\n \"counterOrderId\": \"67174228135f9e000709da8c\",\n \"tradeId\": 11029373945659392,\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"type\": \"limit\",\n \"forceTaker\": false,\n \"price\": \"67717.6\",\n \"size\": \"0.00001\",\n \"funds\": \"0.677176\",\n \"fee\": \"0.000677176\",\n \"feeRate\": \"0.001\",\n \"feeCurrency\": \"USDT\",\n \"stop\": \"\",\n \"tradeType\": \"TRADE\",\n \"taxRate\": \"0\",\n \"tax\": \"0\",\n \"createdAt\": 1729577515473\n }\n ],\n \"lastId\": 19814995255305\n }\n}" + } + ] + }, + { + "name": "Get OCO Order By OrderId", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "order", + "{{orderId}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470357)\n\n:::info[Description]\nRequest via this interface to get a oco order information via the order ID.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | symbol |\n| clientOid | string | Client Order Id |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| orderTime | integer | Order placement time, milliseconds |\n| status | string | Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELLED: Cancelled |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "order", + "{{orderId}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"674c3b6e688dea0007c7bab2\",\n \"symbol\": \"BTC-USDT\",\n \"clientOid\": \"5c52e1203aa6f37f1e493fb\",\n \"orderTime\": 1733049198863,\n \"status\": \"NEW\"\n }\n}" + } + ] + }, + { + "name": "Get OCO Order List", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "symbol" + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milliseconds)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milliseconds)" + }, + { + "key": "orderIds", + "value": null, + "description": "Specify orderId collection, up to 500 orders\n" + }, + { + "key": "pageSize", + "value": null, + "description": "Size per page, minimum value 10, maximum value 500" + }, + { + "key": "currentPage", + "value": null, + "description": "Page number, minimum value 1\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470360)\n\n:::info[Description]\nRequest via this endpoint to get your current OCO order list. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | |\n| pageSize | integer | |\n| totalNum | integer | |\n| totalPage | integer | |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| symbol | string | symbol |\n| clientOid | string | Client Order Id |\n| orderTime | integer | Order placement time, milliseconds |\n| status | string | Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELLED: Cancelled |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "symbol" + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milliseconds)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milliseconds)" + }, + { + "key": "orderIds", + "value": null, + "description": "Specify orderId collection, up to 500 orders\n" + }, + { + "key": "pageSize", + "value": null, + "description": "Size per page, minimum value 10, maximum value 500" + }, + { + "key": "currentPage", + "value": null, + "description": "Page number, minimum value 1\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"orderId\": \"674c3cfa72cf2800072ee7ce\",\n \"symbol\": \"BTC-USDT\",\n \"clientOid\": \"5c52e1203aa6f3g7f1e493fb\",\n \"orderTime\": 1733049594803,\n \"status\": \"NEW\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get OCO Order Detail By OrderId", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "order", + "details", + "{{orderId}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470359)\n\n:::info[Description]\nRequest via this interface to get a oco order detail via the order ID.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| symbol | string | symbol |\n| clientOid | string | Client Order Id |\n| orderTime | integer | Order placement time, milliseconds |\n| status | string | Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELLED: Cancelled |\n| orders | array | Refer to the schema section of orders |\n\n**root.data.orders Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | |\n| symbol | string | |\n| side | string | |\n| price | string | |\n| stopPrice | string | |\n| size | string | |\n| status | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "order", + "details", + "{{orderId}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"674c3b6e688dea0007c7bab2\",\n \"symbol\": \"BTC-USDT\",\n \"clientOid\": \"5c52e1203aa6f37f1e493fb\",\n \"orderTime\": 1733049198863,\n \"status\": \"NEW\",\n \"orders\": [\n {\n \"id\": \"vs93gpqc7dn6h3fa003sfelj\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"94000.00000000000000000000\",\n \"stopPrice\": \"94000.00000000000000000000\",\n \"size\": \"0.10000000000000000000\",\n \"status\": \"NEW\"\n },\n {\n \"id\": \"vs93gpqc7dn6h3fa003sfelk\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"96000.00000000000000000000\",\n \"stopPrice\": \"98000.00000000000000000000\",\n \"size\": \"0.10000000000000000000\",\n \"status\": \"NEW\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Order By OrderId", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470181)\n\n:::info[Description]\nThis endpoint can be used to obtain information for a single Spot order using the order id.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | The unique order id generated by the trading system |\n| symbol | string | symbol |\n| opType | string | |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| side | string | Buy or sell |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| dealSize | string | Number of filled transactions |\n| dealFunds | string | Funds of filled transactions |\n| fee | string | [Handling fees](https://www.kucoin.com/docs-new/api-5327739) |\n| feeCurrency | string | currency used to calculate trading fee |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) |\n| timeInForce | string | Time in force |\n| postOnly | boolean | Whether its a postOnly order. |\n| hidden | boolean | Whether its a hidden order. |\n| iceberg | boolean | Whether its a iceberg order. |\n| visibleSize | string | Visible size of iceberg order in order book. |\n| cancelAfter | integer | A GTT timeInForce that expires in n seconds |\n| channel | string | |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| remark | string | Order placement remarks |\n| tags | string | Order tag |\n| cancelExist | boolean | Whether there is a cancellation record for the order. |\n| createdAt | integer | |\n| lastUpdatedAt | integer | |\n| tradeType | string | Trade type, redundancy param |\n| inOrderBook | boolean | Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook |\n| cancelledSize | string | Number of canceled transactions |\n| cancelledFunds | string | Funds of canceled transactions |\n| remainSize | string | Number of remain transactions |\n| remainFunds | string | Funds of remain transactions |\n| tax | string | Users in some regions need query this field |\n| active | boolean | Order status: true-The status of the order isactive; false-The status of the order is done |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"6717422bd51c29000775ea03\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"70000\",\n \"size\": \"0.00001\",\n \"funds\": \"0.7\",\n \"dealSize\": \"0.00001\",\n \"dealFunds\": \"0.677176\",\n \"remainSize\": \"0\",\n \"remainFunds\": \"0.022824\",\n \"cancelledSize\": \"0\",\n \"cancelledFunds\": \"0\",\n \"fee\": \"0.000677176\",\n \"feeCurrency\": \"USDT\",\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"remark\": \"order remarks\",\n \"tags\": null,\n \"cancelExist\": false,\n \"tradeType\": \"TRADE\",\n \"inOrderBook\": false,\n \"active\": false,\n \"tax\": \"0\",\n \"createdAt\": 1729577515444,\n \"lastUpdatedAt\": 1729577515481\n }\n}" + } + ] + }, + { + "name": "Get OCO Order By ClientOid", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "client-order", + "{{clientOid}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470358)\n\n:::info[Description]\nRequest via this interface to get a oco order information via the client order ID.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | symbol |\n| clientOid | string | Client Order Id |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| orderTime | integer | Order placement time, milliseconds |\n| status | string | Order status: NEW: New, DONE: Completed, TRIGGERED: Triggered, CANCELLED: Cancelled |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "client-order", + "{{clientOid}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"674c3cfa72cf2800072ee7ce\",\n \"symbol\": \"BTC-USDT\",\n \"clientOid\": \"5c52e1203aa6f3g7f1e493fb\",\n \"orderTime\": 1733049594803,\n \"status\": \"NEW\"\n }\n}" + } + ] + }, + { + "name": "Get Order By ClientOid", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470182)\n\n:::info[Description]\nThis endpoint can be used to obtain information for a single Spot order using the client order id.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | The unique order id generated by the trading system |\n| symbol | string | symbol |\n| opType | string | |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| side | string | Buy or sell |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| dealSize | string | Number of filled transactions |\n| dealFunds | string | Funds of filled transactions |\n| fee | string | [Handling fees](https://www.kucoin.com/docs-new/api-5327739) |\n| feeCurrency | string | currency used to calculate trading fee |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) |\n| timeInForce | string | Time in force |\n| postOnly | boolean | Whether its a postOnly order. |\n| hidden | boolean | Whether its a hidden order. |\n| iceberg | boolean | Whether its a iceberg order. |\n| visibleSize | string | Visible size of iceberg order in order book. |\n| cancelAfter | integer | A GTT timeInForce that expires in n seconds |\n| channel | string | |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| remark | string | Order placement remarks |\n| tags | string | Order tag |\n| cancelExist | boolean | Whether there is a cancellation record for the order. |\n| createdAt | integer | |\n| lastUpdatedAt | integer | |\n| tradeType | string | Trade type, redundancy param |\n| inOrderBook | boolean | Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook |\n| cancelledSize | string | Number of canceled transactions |\n| cancelledFunds | string | Funds of canceled transactions |\n| remainSize | string | Number of remain transactions |\n| remainFunds | string | Funds of remain transactions |\n| tax | string | Users in some regions need query this field |\n| active | boolean | Order status: true-The status of the order isactive; false-The status of the order is done |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"6717422bd51c29000775ea03\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"70000\",\n \"size\": \"0.00001\",\n \"funds\": \"0.7\",\n \"dealSize\": \"0.00001\",\n \"dealFunds\": \"0.677176\",\n \"remainSize\": \"0\",\n \"remainFunds\": \"0.022824\",\n \"cancelledSize\": \"0\",\n \"cancelledFunds\": \"0\",\n \"fee\": \"0.000677176\",\n \"feeCurrency\": \"USDT\",\n \"stp\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"remark\": \"order remarks\",\n \"tags\": null,\n \"cancelExist\": false,\n \"tradeType\": \"TRADE\",\n \"inOrderBook\": false,\n \"active\": false,\n \"tax\": \"0\",\n \"createdAt\": 1729577515444,\n \"lastUpdatedAt\": 1729577515481\n }\n}" + } + ] + }, + { + "name": "Cancel OCO Order By ClientOid", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "client-order", + "{{clientOid}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470355)\n\n:::info[Description]\nRequest via this interface to cancel a stop order via the clientOid.\n\nYou will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "client-order", + "{{clientOid}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"vs93gpqc6r0mkk57003gok3h\",\n \"vs93gpqc6r0mkk57003gok3i\"\n ]\n }\n}" + } + ] + }, + { + "name": "Cancel Partial Order", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "cancel", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "cancelSize", + "value": "0.00001", + "description": "The size you want cancel" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470183)\n\n:::info[Description]\nThis interface can cancel the specified quantity of the order according to the orderId.\nThe order execution order is: price first, time first, this interface will not change the queue order\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | order id |\n| cancelSize | string | The size you canceled |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "cancel", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "cancelSize", + "value": "0.00001", + "description": "The size you want cancel" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"6711f73c1ef16c000717bb31\",\n \"cancelSize\": \"0.00001\"\n }\n}" + } + ] + }, + { + "name": "Cancel Order By ClientOid", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470184)\n\n:::info[Description]\nThis endpoint can be used to cancel a spot order by clientOid.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"clientOid\": \"5c52e11203aa677f33e493fb\"\n }\n}" + } + ] + }, + { + "name": "Cancel Stop Order By ClientOid", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order", + "cancelOrderByClientOid" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "clientOid", + "value": "689ff597f4414061aa819cc414836abd", + "description": "Unique order id created by users to identify their orders" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470336)\n\n:::info[Description]\nThis endpoint can be used to cancel a spot order by clientOid.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| cancelledOrderId | string | Unique ID of the cancelled order |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order", + "cancelOrderByClientOid" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "clientOid", + "value": "689ff597f4414061aa819cc414836abd", + "description": "Unique order id created by users to identify their orders" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderId\": \"vs8hoo8ksc8mario0035a74n\",\n \"clientOid\": \"689ff597f4414061aa819cc414836abd\"\n }\n}" + } + ] + }, + { + "name": "Cancel Order By OrderId Sync", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "sync", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470185)\n\n:::info[Description]\nThis endpoint can be used to cancel a spot order by orderId.\n\nThe difference between this interface and \"Cancel Order By OrderId\" is that this interface will synchronously return the order information after the order canceling is completed.\n\nFor higher latency requirements, please select the \"Cancel Order By OrderId\" interface. If there is a requirement for returning data integrity, please select this interface\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | order id |\n| originSize | string | original order size |\n| dealSize | string | deal size |\n| remainSize | string | remain size |\n| canceledSize | string | Cumulative canceled size |\n| status | string | Order Status. open：order is active; done：order has been completed |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "sync", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"671128ee365ccb0007534d45\",\n \"originSize\": \"0.00001\",\n \"dealSize\": \"0\",\n \"remainSize\": \"0\",\n \"canceledSize\": \"0.00001\",\n \"status\": \"done\"\n }\n}" + } + ] + }, + { + "name": "Cancel Order By ClientOid Sync", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "sync", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470186)\n\n:::info[Description]\nThis endpoint can be used to cancel a spot order by clientOid.\n\nThe difference between this interface and \"Cancel Order By ClientOid\" is that this interface will synchronously return the order information after the order canceling is completed.\n\nFor higher latency requirements, please select the \"Cancel Order By ClientOid\" interface. If there is a requirement for returning data integrity, please select this interface\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| originSize | string | original order size |\n| dealSize | string | deal size |\n| remainSize | string | remain size |\n| canceledSize | string | Cumulative canceled size |\n| status | string | Order Status. open：order is active; done：order has been completed |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "sync", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"originSize\": \"0.00001\",\n \"dealSize\": \"0\",\n \"remainSize\": \"0\",\n \"canceledSize\": \"0.00001\",\n \"status\": \"done\"\n }\n}" + } + ] + }, + { + "name": "Add Order Test", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "test" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470187)\n\n:::info[Description]\nOrder test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type `limit` and `market` |\n| side | String | Yes | `buy` or `sell` |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| tags | String | No | Order tag, length cannot exceed `20` characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed `20` characters (ASCII) |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. |\n| remark | string | Order placement remarks, length cannot exceed 20 characters (ASCII) |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| tags | string | Order tag, length cannot exceed 20 characters (ASCII) |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| funds | string | When **type** is market, select one out of two: size or funds |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| clientOid | string | The user self-defined order id. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493f\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\",\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\",\n// }\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders", + "test" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\"\n }\n}" + } + ] + }, + { + "name": "Add Order", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470188)\n\n:::info[Description]\nPlace order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | No | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| type | String | Yes | Order type `limit` and `market` |\n| side | String | Yes | `buy` or `sell` |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| tags | String | No | Order tag, length cannot exceed `20` characters (ASCII) |\n| remark | String | No | Order placement remarks, length cannot exceed `20` characters (ASCII) |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. |\n| remark | string | Order placement remarks, length cannot exceed 20 characters (ASCII) |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| tags | string | Order tag, length cannot exceed 20 characters (ASCII) |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| funds | string | When **type** is market, select one out of two: size or funds |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| clientOid | string | The user self-defined order id. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "hf", + "orders" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\"\n }\n}" + } + ] + }, + { + "name": "Add OCO Order", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "order" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470353)\n\n:::info[Description]\nPlace OCO order to the Spot trading system\n:::\n\n:::tip[Tips]\nThe maximum untriggered stop orders for a single trading pair in one account is 20.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| remark | string | Order placement remarks, length cannot exceed 20 characters (ASCII) |\n| price | string | Specify price for order |\n| size | string | Specify quantity for order |\n| stopPrice | string | trigger price. |\n| limitPrice | string | The limit order price after take-profit and stop-loss are triggered. |\n| tradeType | string | Transaction Type, currently only supports TRADE (spot transactions), the default is TRADE |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"94000\",\n \"size\": \"0.1\",\n \"clientOid\": \"5c52e11203aa67f1e493fb\",\n \"stopPrice\": \"98000\",\n \"limitPrice\": \"96000\",\n \"remark\": \"this is remark\",\n \"tradeType\": \"TRADE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "oco", + "order" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"674c316e688dea0007c7b986\"\n }\n}" + } + ] + }, + { + "name": "Add Stop Order", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470334)\n\n:::info[Description]\nPlace stop order to the Spot trading system. The maximum untriggered stop orders for a single trading pair in one account is 20.\n:::\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. |\n| remark | string | Order placement remarks, length cannot exceed 20 characters (ASCII) |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order, not need for market order.

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading. Required for limit orders. |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK if **type** is limit. |\n| hidden | boolean | [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) |\n| visibleSize | string | When **type** is limit, this is Maximum visible quantity in iceberg orders. |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT when **type** is limit. |\n| funds | string | When **type** is market, select one out of two: size or funds |\n| stopPrice | string | The trigger price. |\n| tradeType | string | The type of trading : TRADE（Spot）, MARGIN_TRADE (Cross Margin), MARGIN_ISOLATED_TRADE (Isolated Margin). Default is TRADE |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| clientOid | string | The user self-defined order id. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "stop-order" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"670fd33bf9406e0007ab3945\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\"\n }\n}" + } + ] + } + ], + "description": "" + } + ], + "description": "" + }, + { + "name": "Margin Trading", + "item": [ + { + "name": "Market Data", + "item": [ + { + "name": "Get Symbols - Cross Margin", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "symbols" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "If not provided, all cross margin symbol will be queried. If provided, only the specified symbol will be queried." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470189)\n\n:::info[Description]\nThis endpoint allows querying the configuration of cross margin symbol.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| timestamp | integer | |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | symbol |\n| name | string | symbol name |\n| enableTrading | boolean | Whether trading is enabled: true for enabled, false for disabled |\n| market | string | Trading market |\n| baseCurrency | string | Base currency,e.g. BTC. |\n| quoteCurrency | string | Quote currency,e.g. USDT. |\n| baseIncrement | string | Quantity increment: The quantity for an order must be a positive integer multiple of this increment. Here, the size refers to the quantity of the base currency for the order. For example, for the ETH-USDT trading pair, if the baseIncrement is 0.0000001, the order quantity can be 1.0000001 but not 1.00000001. |\n| baseMinSize | string | The minimum order quantity requried to place an order. |\n| quoteIncrement | string | Quote increment: The funds for a market order must be a positive integer multiple of this increment. The funds refer to the quote currency amount. For example, for the ETH-USDT trading pair, if the quoteIncrement is 0.000001, the amount of USDT for the order can be 3000.000001 but not 3000.0000001. |\n| quoteMinSize | string | The minimum order funds required to place a market order. |\n| baseMaxSize | string | The maximum order size required to place an order. |\n| quoteMaxSize | string | The maximum order funds required to place a market order. |\n| priceIncrement | string | Price increment: The price of an order must be a positive integer multiple of this increment. For example, for the ETH-USDT trading pair, if the priceIncrement is 0.01, the order price can be 3000.01 but not 3000.001.

specifies the min order price as well as the price increment.This also applies to quote currency. |\n| feeCurrency | string | The currency of charged fees. |\n| priceLimitRate | string | Threshold for price portection |\n| minFunds | string | the minimum trading amounts |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "symbols" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "If not provided, all cross margin symbol will be queried. If provided, only the specified symbol will be queried." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"timestamp\": 1729665839353,\n \"items\": [\n {\n \"symbol\": \"BTC-USDT\",\n \"name\": \"BTC-USDT\",\n \"enableTrading\": true,\n \"market\": \"USDS\",\n \"baseCurrency\": \"BTC\",\n \"quoteCurrency\": \"USDT\",\n \"baseIncrement\": \"0.00000001\",\n \"baseMinSize\": \"0.00001\",\n \"baseMaxSize\": \"10000000000\",\n \"quoteIncrement\": \"0.000001\",\n \"quoteMinSize\": \"0.1\",\n \"quoteMaxSize\": \"99999999\",\n \"priceIncrement\": \"0.1\",\n \"feeCurrency\": \"USDT\",\n \"priceLimitRate\": \"0.1\",\n \"minFunds\": \"0.1\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Margin Config", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "config" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470190)\n\n:::info[Description]\nRequest via this endpoint to get the configure info of the cross margin.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currencyList | array | Refer to the schema section of currencyList |\n| maxLeverage | integer | Max leverage available |\n| warningDebtRatio | string | The warning debt ratio of the forced liquidation |\n| liqDebtRatio | string | The debt ratio of the forced liquidation |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "config" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"maxLeverage\": 5,\n \"warningDebtRatio\": \"0.95\",\n \"liqDebtRatio\": \"0.97\",\n \"currencyList\": [\n \"VRA\",\n \"APT\",\n \"IOTX\",\n \"SHIB\",\n \"KDA\",\n \"BCHSV\",\n \"NEAR\",\n \"CLV\",\n \"AUDIO\",\n \"AIOZ\",\n \"FLOW\",\n \"WLD\",\n \"COMP\",\n \"MEME\",\n \"SLP\",\n \"STX\",\n \"ZRO\",\n \"QI\",\n \"PYTH\",\n \"RUNE\",\n \"DGB\",\n \"IOST\",\n \"SUI\",\n \"BCH\",\n \"CAKE\",\n \"DOT\",\n \"OMG\",\n \"POL\",\n \"GMT\",\n \"1INCH\",\n \"RSR\",\n \"NKN\",\n \"BTC\",\n \"AR\",\n \"ARB\",\n \"TON\",\n \"LISTA\",\n \"AVAX\",\n \"SEI\",\n \"FTM\",\n \"ERN\",\n \"BB\",\n \"BTT\",\n \"JTO\",\n \"ONE\",\n \"RLC\",\n \"ANKR\",\n \"SUSHI\",\n \"CATI\",\n \"ALGO\",\n \"PEPE2\",\n \"ATOM\",\n \"LPT\",\n \"BIGTIME\",\n \"CFX\",\n \"DYM\",\n \"VELO\",\n \"XPR\",\n \"SNX\",\n \"JUP\",\n \"MANA\",\n \"API3\",\n \"PYR\",\n \"ROSE\",\n \"GLMR\",\n \"SATS\",\n \"TIA\",\n \"GALAX\",\n \"SOL\",\n \"DAO\",\n \"FET\",\n \"ETC\",\n \"MKR\",\n \"WOO\",\n \"DODO\",\n \"OGN\",\n \"BNB\",\n \"ICP\",\n \"BLUR\",\n \"ETH\",\n \"ZEC\",\n \"NEO\",\n \"CELO\",\n \"REN\",\n \"MANTA\",\n \"LRC\",\n \"STRK\",\n \"ADA\",\n \"STORJ\",\n \"REQ\",\n \"TAO\",\n \"VET\",\n \"FITFI\",\n \"USDT\",\n \"DOGE\",\n \"HBAR\",\n \"SXP\",\n \"NEIROCTO\",\n \"CHR\",\n \"ORDI\",\n \"DASH\",\n \"PEPE\",\n \"ONDO\",\n \"ILV\",\n \"WAVES\",\n \"CHZ\",\n \"DOGS\",\n \"XRP\",\n \"CTSI\",\n \"JASMY\",\n \"FLOKI\",\n \"TRX\",\n \"KAVA\",\n \"SAND\",\n \"C98\",\n \"UMA\",\n \"NOT\",\n \"IMX\",\n \"WIF\",\n \"ENA\",\n \"EGLD\",\n \"BOME\",\n \"LTC\",\n \"USDC\",\n \"METIS\",\n \"WIN\",\n \"THETA\",\n \"FXS\",\n \"ENJ\",\n \"CRO\",\n \"AEVO\",\n \"INJ\",\n \"LTO\",\n \"CRV\",\n \"GRT\",\n \"DYDX\",\n \"FLUX\",\n \"ENS\",\n \"WAX\",\n \"MASK\",\n \"POND\",\n \"UNI\",\n \"AAVE\",\n \"LINA\",\n \"TLM\",\n \"BONK\",\n \"QNT\",\n \"LDO\",\n \"ALICE\",\n \"XLM\",\n \"LINK\",\n \"CKB\",\n \"LUNC\",\n \"YFI\",\n \"ETHW\",\n \"XTZ\",\n \"LUNA\",\n \"OP\",\n \"SUPER\",\n \"EIGEN\",\n \"KSM\",\n \"ELON\",\n \"EOS\",\n \"FIL\",\n \"ZETA\",\n \"SKL\",\n \"BAT\",\n \"APE\",\n \"HMSTR\",\n \"YGG\",\n \"MOVR\",\n \"PEOPLE\",\n \"KCS\",\n \"AXS\",\n \"ARPA\",\n \"ZIL\"\n ]\n }\n}" + } + ] + }, + { + "name": "Get ETF Info", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "etf", + "info" + ], + "query": [ + { + "key": "currency", + "value": "BTCUP", + "description": "ETF Currency, if empty query all currencies\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470191)\n\n:::info[Description]\nThis interface returns leveraged token information\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | ETF Currency |\n| netAsset | string | Net worth |\n| targetLeverage | string | Target leverage |\n| actualLeverage | string | Actual leverage |\n| issuedSize | string | The amount of currency issued |\n| basket | string | Basket information |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "etf", + "info" + ], + "query": [ + { + "key": "currency", + "value": "BTCUP", + "description": "ETF Currency, if empty query all currencies\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"currency\": \"BTCUP\",\n \"netAsset\": \"33.846\",\n \"targetLeverage\": \"2-4\",\n \"actualLeverage\": \"2.1648\",\n \"issuedSize\": \"107134.87655291\",\n \"basket\": \"118.324559 XBTUSDTM\"\n }\n ]\n}" + } + ] + }, + { + "name": "Get Mark Price List", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "mark-price", + "all-symbols" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470192)\n\n:::info[Description]\nThis endpoint returns the current Mark price for all margin trading pairs.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | symbol |\n| timePoint | integer | Timestamp (milliseconds) |\n| value | number | Mark price |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "mark-price", + "all-symbols" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"USDT-BTC\",\n \"timePoint\": 1729676522000,\n \"value\": 1.504e-05\n },\n {\n \"symbol\": \"USDC-BTC\",\n \"timePoint\": 1729676522000,\n \"value\": 1.5049024e-05\n }\n ]\n}" + } + ] + }, + { + "name": "Get Mark Price Detail", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "mark-price", + "{{symbol}}", + "current" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470193)\n\n:::info[Description]\nThis endpoint returns the current Mark price for specified margin trading pairs.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | symbol |\n| timePoint | integer | Timestamp (milliseconds) |\n| value | number | Mark price |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "mark-price", + "{{symbol}}", + "current" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"USDT-BTC\",\n \"timePoint\": 1729676888000,\n \"value\": 1.5045e-05\n }\n}" + } + ] + }, + { + "name": "Get Symbols - Isolated Margin", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "isolated", + "symbols" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470194)\n\n:::info[Description]\nThis endpoint allows querying the configuration of isolated margin symbol.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | symbol |\n| symbolName | string | symbol name |\n| baseCurrency | string | Base currency,e.g. BTC. |\n| quoteCurrency | string | Quote currency,e.g. USDT. |\n| maxLeverage | integer | Max leverage of this symbol |\n| flDebtRatio | string | |\n| tradeEnable | boolean | |\n| autoRenewMaxDebtRatio | string | |\n| baseBorrowEnable | boolean | |\n| quoteBorrowEnable | boolean | |\n| baseTransferInEnable | boolean | |\n| quoteTransferInEnable | boolean | |\n| baseBorrowCoefficient | string | |\n| quoteBorrowCoefficient | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "isolated", + "symbols" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"BTC-USDT\",\n \"symbolName\": \"BTC-USDT\",\n \"baseCurrency\": \"BTC\",\n \"quoteCurrency\": \"USDT\",\n \"maxLeverage\": 10,\n \"flDebtRatio\": \"0.97\",\n \"tradeEnable\": true,\n \"autoRenewMaxDebtRatio\": \"0.96\",\n \"baseBorrowEnable\": true,\n \"quoteBorrowEnable\": true,\n \"baseTransferInEnable\": true,\n \"quoteTransferInEnable\": true,\n \"baseBorrowCoefficient\": \"1\",\n \"quoteBorrowCoefficient\": \"1\"\n }\n ]\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Orders", + "item": [ + { + "name": "Cancel Order By OrderId", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470195)\n\n:::info[Description]\nThis endpoint can be used to cancel a margin order by orderId.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | order id |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"671663e02188630007e21c9c\"\n }\n}" + } + ] + }, + { + "name": "Get Symbols With Open Order", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "order", + "active", + "symbols" + ], + "query": [ + { + "key": "tradeType", + "value": "MARGIN_TRADE", + "description": "Cross Margin: MARGIN_TRADE, Isolated Margin: MARGIN_ISOLATED_TRADE\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470196)\n\n:::info[Description]\nThis interface can query all Margin symbol that has active orders\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbolSize | integer | Symbol Size |\n| symbols | array | Refer to the schema section of symbols |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "order", + "active", + "symbols" + ], + "query": [ + { + "key": "tradeType", + "value": "MARGIN_TRADE", + "description": "Cross Margin: MARGIN_TRADE, Isolated Margin: MARGIN_ISOLATED_TRADE\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbolSize\": 1,\n \"symbols\": [\n \"BTC-USDT\"\n ]\n }\n}" + } + ] + }, + { + "name": "Cancel All Orders By Symbol", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "tradeType", + "value": "MARGIN_TRADE", + "description": "Transaction type: MARGIN_TRADE - cross margin trade, MARGIN_ISOLATED_TRADE - isolated margin trade" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470197)\n\n:::info[Description]\nThis interface can cancel all open Margin orders by symbol\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "tradeType", + "value": "MARGIN_TRADE", + "description": "Transaction type: MARGIN_TRADE - cross margin trade, MARGIN_ISOLATED_TRADE - isolated margin trade" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": \"success\"\n}" + } + ] + }, + { + "name": "Get Open Orders", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "active" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "tradeType", + "value": "MARGIN_TRADE", + "description": "Order type: MARGIN_TRADE - cross margin trading order, MARGIN_ISOLATED_TRADE - isolated margin trading order" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470198)\n\n:::info[Description]\nThis interface is to obtain all Margin active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nFor high-frequency trading users, we recommend locally caching, maintaining your own order records, and using market data streams to update your order information in real time.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | The unique order id generated by the trading system |\n| symbol | string | symbol |\n| opType | string | |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| side | string | Buy or sell |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| dealSize | string | Number of filled transactions |\n| dealFunds | string | Funds of filled transactions |\n| fee | string | trading fee |\n| feeCurrency | string | currency used to calculate trading fee |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC |\n| stop | string | |\n| stopTriggered | boolean | |\n| stopPrice | string | |\n| timeInForce | string | Time in force |\n| postOnly | boolean | Whether its a postOnly order. |\n| hidden | boolean | Whether its a hidden order. |\n| iceberg | boolean | Whether its a iceberg order. |\n| visibleSize | string | Visible size of iceberg order in order book. |\n| cancelAfter | integer | A GTT timeInForce that expires in n seconds |\n| channel | string | |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| remark | string | Order placement remarks |\n| tags | string | Order tag |\n| cancelExist | boolean | Whether there is a cancellation record for the order. |\n| createdAt | integer | |\n| lastUpdatedAt | integer | |\n| tradeType | string | Trade type, redundancy param |\n| inOrderBook | boolean | Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook |\n| cancelledSize | string | Number of canceled transactions |\n| cancelledFunds | string | Funds of canceled transactions |\n| remainSize | string | Number of remain transactions |\n| remainFunds | string | Funds of remain transactions |\n| tax | string | Users in some regions need query this field |\n| active | boolean | Order status: true-The status of the order isactive; false-The status of the order is done |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "active" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "tradeType", + "value": "MARGIN_TRADE", + "description": "Order type: MARGIN_TRADE - cross margin trading order, MARGIN_ISOLATED_TRADE - isolated margin trading order" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"671667306afcdb000723107f\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"funds\": \"0.5\",\n \"dealSize\": \"0\",\n \"dealFunds\": \"0\",\n \"remainSize\": \"0.00001\",\n \"remainFunds\": \"0.5\",\n \"cancelledSize\": \"0\",\n \"cancelledFunds\": \"0\",\n \"fee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"stp\": null,\n \"stop\": null,\n \"stopTriggered\": false,\n \"stopPrice\": \"0\",\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"remark\": null,\n \"tags\": null,\n \"cancelExist\": false,\n \"tradeType\": \"MARGIN_TRADE\",\n \"inOrderBook\": true,\n \"active\": true,\n \"tax\": \"0\",\n \"createdAt\": 1729521456248,\n \"lastUpdatedAt\": 1729521460940\n }\n ]\n}" + } + ] + }, + { + "name": "Get Closed Orders", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "done" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "tradeType", + "value": "MARGIN_TRADE", + "description": "Transaction type: MARGIN_TRADE - cross margin trade, MARGIN_ISOLATED_TRADE - isolated margin trade" + }, + { + "key": "side", + "value": null, + "description": "specify if the order is to 'buy' or 'sell'" + }, + { + "key": "type", + "value": null, + "description": "specify if the order is an 'limit' order or 'market' order. " + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page." + }, + { + "key": "limit", + "value": "20", + "description": "Default20，Max100" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470199)\n\n:::info[Description]\nThis interface is to obtain all Margin Closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| lastId | integer | The id of the last set of data from the previous batch of data. By default, the latest information is given.
lastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page. |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | The unique order id generated by the trading system |\n| symbol | string | symbol |\n| opType | string | |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| side | string | Buy or sell |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| dealSize | string | Number of filled transactions |\n| dealFunds | string | Funds of filled transactions |\n| fee | string | [Handling fees](https://www.kucoin.com/docs-new/api-5327739) |\n| feeCurrency | string | currency used to calculate trading fee |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC |\n| stop | string | |\n| stopTriggered | boolean | |\n| stopPrice | string | |\n| timeInForce | string | Time in force |\n| postOnly | boolean | Whether its a postOnly order. |\n| hidden | boolean | Whether its a hidden order. |\n| iceberg | boolean | Whether its a iceberg order. |\n| visibleSize | string | Visible size of iceberg order in order book. |\n| cancelAfter | integer | A GTT timeInForce that expires in n seconds |\n| channel | string | |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| remark | string | Order placement remarks |\n| tags | string | Order tag |\n| cancelExist | boolean | Whether there is a cancellation record for the order. |\n| createdAt | integer | |\n| lastUpdatedAt | integer | |\n| tradeType | string | Trade type, redundancy param |\n| inOrderBook | boolean | Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook |\n| cancelledSize | string | Number of canceled transactions |\n| cancelledFunds | string | Funds of canceled transactions |\n| remainSize | string | Number of remain transactions |\n| remainFunds | string | Funds of remain transactions |\n| tax | string | Users in some regions need query this field |\n| active | boolean | Order status: true-The status of the order isactive; false-The status of the order is done |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "done" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "tradeType", + "value": "MARGIN_TRADE", + "description": "Transaction type: MARGIN_TRADE - cross margin trade, MARGIN_ISOLATED_TRADE - isolated margin trade" + }, + { + "key": "side", + "value": null, + "description": "specify if the order is to 'buy' or 'sell'" + }, + { + "key": "type", + "value": null, + "description": "specify if the order is an 'limit' order or 'market' order. " + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page." + }, + { + "key": "limit", + "value": "20", + "description": "Default20，Max100" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"lastId\": 136112949351,\n \"items\": [\n {\n \"id\": \"6716491f6afcdb00078365c8\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"funds\": \"0.5\",\n \"dealSize\": \"0\",\n \"dealFunds\": \"0\",\n \"remainSize\": \"0\",\n \"remainFunds\": \"0\",\n \"cancelledSize\": \"0.00001\",\n \"cancelledFunds\": \"0.5\",\n \"fee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"stp\": null,\n \"stop\": null,\n \"stopTriggered\": false,\n \"stopPrice\": \"0\",\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"remark\": null,\n \"tags\": null,\n \"cancelExist\": true,\n \"tradeType\": \"MARGIN_TRADE\",\n \"inOrderBook\": false,\n \"active\": false,\n \"tax\": \"0\",\n \"createdAt\": 1729513759162,\n \"lastUpdatedAt\": 1729521126597\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Trade History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "fills" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "tradeType", + "value": "MARGIN_TRADE", + "description": "Trade type: MARGIN_TRADE - cross margin trade, MARGIN_ISOLATED_TRADE - isolated margin trade" + }, + { + "key": "orderId", + "value": null, + "description": "The unique order id generated by the trading system\n(If orderId is specified，please ignore the other query parameters)" + }, + { + "key": "side", + "value": null, + "description": "specify if the order is to 'buy' or 'sell'" + }, + { + "key": "type", + "value": null, + "description": "specify if the order is an 'limit' order or 'market' order. " + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page." + }, + { + "key": "limit", + "value": "100", + "description": "Default100，Max200" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470200)\n\n:::info[Description]\nThis endpoint can be used to obtain a list of the latest Margin transaction details. \nThe returned data is sorted in descending order according to the latest update time of the order.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| items | array | Refer to the schema section of items |\n| lastId | integer | The id of the last set of data from the previous batch of data. By default, the latest information is given.
lastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page. |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | integer | Id of transaction detail |\n| symbol | string | symbol |\n| tradeId | integer | Trade Id, symbol latitude increment |\n| orderId | string | The unique order id generated by the trading system |\n| counterOrderId | string | Counterparty order Id |\n| side | string | Buy or sell |\n| liquidity | string | Liquidity type: taker or maker |\n| forceTaker | boolean | |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| fee | string | [Handling fees](https://www.kucoin.com/docs-new/api-5327739) |\n| feeRate | string | Fee rate
|\n| feeCurrency | string | currency used to calculate trading fee |\n| stop | string | Take Profit and Stop Loss type, currently HFT does not support the Take Profit and Stop Loss type, so it is empty |\n| tradeType | string | Trade type, redundancy param |\n| tax | string | Users in some regions need query this field |\n| taxRate | string | Tax Rate, Users in some regions need query this field |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| createdAt | integer | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "fills" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + }, + { + "key": "tradeType", + "value": "MARGIN_TRADE", + "description": "Trade type: MARGIN_TRADE - cross margin trade, MARGIN_ISOLATED_TRADE - isolated margin trade" + }, + { + "key": "orderId", + "value": null, + "description": "The unique order id generated by the trading system\n(If orderId is specified，please ignore the other query parameters)" + }, + { + "key": "side", + "value": null, + "description": "specify if the order is to 'buy' or 'sell'" + }, + { + "key": "type", + "value": null, + "description": "specify if the order is an 'limit' order or 'market' order. " + }, + { + "key": "lastId", + "value": "254062248624417", + "description": "The id of the last set of data from the previous batch of data. By default, the latest information is given.\nlastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page." + }, + { + "key": "limit", + "value": "100", + "description": "Default100，Max200" + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"items\": [\n {\n \"id\": 137891621991,\n \"symbol\": \"BTC-USDT\",\n \"tradeId\": 11040911994273793,\n \"orderId\": \"671868085584bc0007d85f46\",\n \"counterOrderId\": \"67186805b7cbdf00071621f9\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"forceTaker\": false,\n \"price\": \"67141.6\",\n \"size\": \"0.00001\",\n \"funds\": \"0.671416\",\n \"fee\": \"0.000671416\",\n \"feeRate\": \"0.001\",\n \"feeCurrency\": \"USDT\",\n \"stop\": \"\",\n \"tradeType\": \"MARGIN_TRADE\",\n \"tax\": \"0\",\n \"taxRate\": \"0\",\n \"type\": \"limit\",\n \"createdAt\": 1729652744998\n }\n ],\n \"lastId\": 137891621991\n }\n}" + } + ] + }, + { + "name": "Cancel Order By ClientOid", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470201)\n\n:::info[Description]\nThis endpoint can be used to cancel a margin order by clientOid.\nThis endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"clientOid\": \"5c52e11203aa677f33e1493fb\"\n }\n}" + } + ] + }, + { + "name": "Get Order By OrderId", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470202)\n\n:::info[Description]\nThis endpoint can be used to obtain information for a single Margin order using the order id.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | The unique order id generated by the trading system |\n| symbol | string | symbol |\n| opType | string | |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| side | string | Buy or sell |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| dealSize | string | Number of filled transactions |\n| dealFunds | string | Funds of filled transactions |\n| fee | string | [Handling fees](https://www.kucoin.com/docs-new/api-5327739) |\n| feeCurrency | string | currency used to calculate trading fee |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC |\n| stop | string | |\n| stopTriggered | boolean | |\n| stopPrice | string | |\n| timeInForce | string | Time in force |\n| postOnly | boolean | Whether its a postOnly order. |\n| hidden | boolean | Whether its a hidden order. |\n| iceberg | boolean | Whether its a iceberg order. |\n| visibleSize | string | Visible size of iceberg order in order book. |\n| cancelAfter | integer | A GTT timeInForce that expires in n seconds |\n| channel | string | |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| remark | string | Order placement remarks |\n| tags | string | Order tag |\n| cancelExist | boolean | Whether there is a cancellation record for the order. |\n| createdAt | integer | |\n| lastUpdatedAt | integer | |\n| tradeType | string | Trade type, redundancy param |\n| inOrderBook | boolean | Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook |\n| cancelledSize | string | Number of canceled transactions |\n| cancelledFunds | string | Funds of canceled transactions |\n| remainSize | string | Number of remain transactions |\n| remainFunds | string | Funds of remain transactions |\n| tax | string | Users in some regions need query this field |\n| active | boolean | Order status: true-The status of the order isactive; false-The status of the order is done |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "{{orderId}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"671667306afcdb000723107f\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"funds\": \"0.5\",\n \"dealSize\": \"0\",\n \"dealFunds\": \"0\",\n \"fee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"stp\": null,\n \"stop\": null,\n \"stopTriggered\": false,\n \"stopPrice\": \"0\",\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": null,\n \"tags\": null,\n \"cancelExist\": false,\n \"createdAt\": 1729521456248,\n \"lastUpdatedAt\": 1729651011877,\n \"tradeType\": \"MARGIN_TRADE\",\n \"inOrderBook\": true,\n \"cancelledSize\": \"0\",\n \"cancelledFunds\": \"0\",\n \"remainSize\": \"0.00001\",\n \"remainFunds\": \"0.5\",\n \"tax\": \"0\",\n \"active\": true\n }\n}" + } + ] + }, + { + "name": "Get Order By ClientOid", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470203)\n\n:::info[Description]\nThis endpoint can be used to obtain information for a single Margin order using the client order id.\n\nAfter the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status.\n:::\n\n:::tip[Tips]\nIf the order is not an active order, you can only get data within the time range of 3 _ 24 hours (ie: from the current time to 3 _ 24 hours ago). If the time range is exceeded, the system will query the data within the time range of 3 * 24 hours by default.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | The unique order id generated by the trading system |\n| symbol | string | symbol |\n| opType | string | |\n| type | string | Specify if the order is an 'limit' order or 'market' order. |\n| side | string | Buy or sell |\n| price | string | Order price |\n| size | string | Order size |\n| funds | string | Order Funds |\n| dealSize | string | Number of filled transactions |\n| dealFunds | string | Funds of filled transactions |\n| fee | string | [Handling fees](https://www.kucoin.com/docs-new/api-5327739) |\n| feeCurrency | string | currency used to calculate trading fee |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC |\n| stop | string | |\n| stopTriggered | boolean | |\n| stopPrice | string | |\n| timeInForce | string | Time in force |\n| postOnly | boolean | Whether its a postOnly order. |\n| hidden | boolean | Whether its a hidden order. |\n| iceberg | boolean | Whether its a iceberg order. |\n| visibleSize | string | Visible size of iceberg order in order book. |\n| cancelAfter | integer | A GTT timeInForce that expires in n seconds |\n| channel | string | |\n| clientOid | string | Client Order Id，unique identifier created by the user |\n| remark | string | Order placement remarks |\n| tags | string | Order tag |\n| cancelExist | boolean | Whether there is a cancellation record for the order. |\n| createdAt | integer | |\n| lastUpdatedAt | integer | |\n| tradeType | string | Trade type, redundancy param |\n| inOrderBook | boolean | Whether to enter the orderbook: true: enter the orderbook; false: not enter the orderbook |\n| cancelledSize | string | Number of canceled transactions |\n| cancelledFunds | string | Funds of canceled transactions |\n| remainSize | string | Number of remain transactions |\n| remainFunds | string | Funds of remain transactions |\n| tax | string | Users in some regions need query this field |\n| active | boolean | Order status: true-The status of the order isactive; false-The status of the order is done |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "orders", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "BTC-USDT", + "description": "symbol" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"671667306afcdb000723107f\",\n \"symbol\": \"BTC-USDT\",\n \"opType\": \"DEAL\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"funds\": \"0.5\",\n \"dealSize\": \"0\",\n \"dealFunds\": \"0\",\n \"fee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"stp\": null,\n \"stop\": null,\n \"stopTriggered\": false,\n \"stopPrice\": \"0\",\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"visibleSize\": \"0\",\n \"cancelAfter\": 0,\n \"channel\": \"API\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": null,\n \"tags\": null,\n \"cancelExist\": false,\n \"createdAt\": 1729521456248,\n \"lastUpdatedAt\": 1729651011877,\n \"tradeType\": \"MARGIN_TRADE\",\n \"inOrderBook\": true,\n \"cancelledSize\": \"0\",\n \"cancelledFunds\": \"0\",\n \"remainSize\": \"0.00001\",\n \"remainFunds\": \"0.5\",\n \"tax\": \"0\",\n \"active\": true\n }\n}" + } + ] + }, + { + "name": "Add Order", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "order" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470204)\n\n:::info[Description]\nPlace order to the Cross-margin or Isolated-margin trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | Yes | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| side | String | Yes | `buy` or `sell` |\n| type | String | No | Order type `limit` and `market`, defult is limit |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| isIsolated | boolean | No | true - isolated margin ,false - cross margin. defult as false |\n| autoBorrow | boolean | No | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | No | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| funds | string | When **type** is market, select one out of two: size or funds |\n| isIsolated | boolean | true - isolated margin ,false - cross margin. defult as false |\n| autoBorrow | boolean | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| loanApplyId | string | Borrow order id. The field is returned only after placing the order under the mode of Auto-Borrow. |\n| borrowSize | string | Borrowed amount. The field is returned only after placing the order under the mode of Auto-Borrow. |\n| clientOid | string | The user self-defined order id. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "order" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"success\": true,\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"671663e02188630007e21c9c\",\n \"clientOid\": \"5c52e11203aa677f33e1493fb\",\n \"borrowSize\": \"10.2\",\n \"loanApplyId\": \"600656d9a33ac90009de4f6f\"\n }\n}" + } + ] + }, + { + "name": "Add Order Test", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "order", + "test" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470205)\n\n:::info[Description]\nOrder test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\n:::\n\n:::tip[Tips]\nPlease note that once your order enters the order book, the system will freeze the handling fees for the order ahead of time.\n\nBefore placing orders, please be sure to fully understand the meaning of the parameters for each trading pair.\n:::\n\n:::tip[Tips]\nThe maximum number of active orders per account is 2000, with a maximum of 200 active orders per trading pair.\n:::\n\n\n**Public order placement request parameters**\n\n| Param | Type | Mandatory | Description |\n| --------- | ------ | --------- | ----------- |\n| clientOid | String | Yes | Client Order Id，unique identifier created by the user, the use of UUID is recommended |\n| symbol | String | Yes | symbol |\n| side | String | Yes | `buy` or `sell` |\n| type | String | No | Order type `limit` and `market`, defult is limit |\n| stp | String | No | self trade prevention is divided into four strategies: `CN`, `CO`, `CB` , and `DC` |\n| isIsolated | boolean | No | true - isolated margin ,false - cross margin. defult as false |\n| autoBorrow | boolean | No | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | No | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n\n**Additional Request Parameters Required by `limit` Orders**\n\n| Param | Type | Mandatory | Description |\n| ----------- | ------- | --------- | ----------- |\n| price | String | Yes | Specify price for currency |\n| size | String | Yes | Specify quantity for currency |\n| timeInForce | String | No | Order timing strategy `GTC`, `GTT`, `IOC`, `FOK` (The default is `GTC`) |\n| cancelAfter | long | No | Cancel after `n` seconds，the order timing strategy is `GTT` |\n| postOnly | boolean | No | passive order labels, this is disabled when the order timing strategy is `IOC` or `FOK` |\n| hidden | boolean | No | Hidden or not (not shown in order book) |\n| iceberg | boolean | No | Whether or not only visible portions of orders are shown in iceberg orders |\n| visibleSize | String | No | Maximum visible quantity in iceberg orders |\n\n**Additional request parameters required by `market` orders**\n\n| Param | Type | Mandatory | Description |\n| ----- | ------ | --------- | ------------------------------------------ |\n| size | String | No | (Select one out of two: `size` or `funds`) |\n| funds | String | No | (Select one out of two: `size` or `funds`) |\n\n\n**Hold**\n\nFor limit price purchase orders, we will hold the amount of funds (price * size) required for your purchase order. Similarly, for limit price sell orders, we will also hold you sell order assets. When the transaction is executed, the service fees will be calculated. If you cancel a portion of a filled or unfilled order, then the remaining funds or amounts will be released and returned to your account. For market price buy/sell orders that require specific funds, we will hold the required funds in from your account. If only the size is specified, we may freeze (usually for a very short amount of time) all of the funds in your account prior to the order being filled or cancelled.\n\n\n**Order Lifecycle**\n\nWhen an order placement request is successful (the matching engine receives the order) or denied (due to there being insufficient funds or illegal parameter values, etc.), the system will respond to the HTTP request. When an order is successfully placed, the order ID is returned. The order will be matched, which could result in it being fully or partially filled. When an order is fully or partially filled, the remaining portions of the order will be in an active state awaiting to be matched (this does not include IOC orders). Orders that are fully or partially filled(already cancelled) will be put into the “done” state.\n\nUsers that have subscribed to the Market Data Channel can use the order ID （orderId） and client ID （clientOid） to identify messages.\n\n**Price Protection Mechanisms**\n\nPrice protection mechanisms ae enabled for order placements. Rules are detailed below:\n\n- If the spot trading market order/limit order placed by the user can be directly matched with an order in the current order book, the system will judge whether deviation between the price corresponding to the transaction depth and the spread exceeds the threshold value （the threshold value can be obtained using the symbol API endpoint）；\n\n- If it is exceeded, for limit orders, the order will be directly cancelled;\n\n- If it is a market order, then the system will partially execute the order. The execution limit will be the order size within the price range corresponding to the threshold value. The remaining orders will not be filled.\n\nFor example: if the threshold value is 10%, when a user places a market price purchase order in the KCS/USDT trading market for 10,000 USDT (the selling price is currently 1.20000), the system will determine that after the order is completely filled, the final price will be 1.40000. (1.40000-1.20000)/1.20000=16.7%>10%. The threshold value is 1.32000. The user’s market price purchase order will be filled only to a maximum of 1.32000. The remaining order portions will not be matched with orders in the order book. Note: this feature may not be able to determine depth with complete accuracy. If your order is not completely filled, it may be because the portion exceeding the threshold value was not filled.\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters.

Please remember the orderId created by the service provider, it used to check for updates in order status. |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | symbol |\n| type | string | specify if the order is an 'limit' order or 'market' order.

The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine.

When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels.

Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC |\n| price | string | Specify price for order

When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. |\n| size | string | Specify quantity for order

When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize.

When **type** is market, select one out of two: size or funds |\n| timeInForce | string | [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading |\n| postOnly | boolean | passive order labels, this is disabled when the order timing strategy is IOC or FOK |\n| hidden | boolean | [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) |\n| iceberg | boolean | Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) |\n| visibleSize | string | Maximum visible quantity in iceberg orders |\n| cancelAfter | integer | Cancel after n seconds，the order timing strategy is GTT |\n| funds | string | When **type** is market, select one out of two: size or funds |\n| isIsolated | boolean | true - isolated margin ,false - cross margin. defult as false |\n| autoBorrow | boolean | When Margin Account has inefficient balance, our system autoborrows inefficient assets and opens positions according to the lowest market interest rate. |\n| autoRepay | boolean | AutoPay allows returning borrowed assets when you close a position. Our system automatically triggers the repayment and the maximum repayment amount equals to the filled-order amount. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| loanApplyId | string | Borrowed amount. The field is returned only after placing the order under the mode of Auto-Borrow. |\n| borrowSize | number | ID of the borrowing response. The field is returned only after placing the order under the mode of Auto-Borrow. |\n| clientOid | string | The user self-defined order id. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "//limit order\n{\n \"type\": \"limit\",\n \"symbol\": \"BTC-USDT\",\n \"side\": \"buy\",\n \"price\": \"50000\",\n \"size\": \"0.00001\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": \"order remarks\"\n}\n\n//market order 1\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"size\": \"0.00001\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n\n//market order 2\n// {\n// \"type\": \"market\",\n// \"symbol\": \"BTC-USDT\",\n// \"side\": \"buy\",\n// \"funds\": \"1\",\n// \"clientOid\": \"5c52e11203aa677f33e493fc\",\n// \"remark\": \"order remarks\"\n// }\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "hf", + "margin", + "order", + "test" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"success\": true,\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"5bd6e9286d99522a52e458de\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"borrowSize\": 10.2,\n \"loanApplyId\": \"600656d9a33ac90009de4f6f\"\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Debit", + "item": [ + { + "name": "Borrow", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "borrow" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470206)\n\n:::info[Description]\nThis API endpoint is used to initiate an application for cross or isolated margin borrowing.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| size | number | Borrow amount |\n| timeInForce | string | timeInForce: IOC, FOK |\n| symbol | string | symbol, mandatory for isolated margin account |\n| isIsolated | boolean | true-isolated, false-cross; default is false |\n| isHf | boolean | true: high frequency borrowing, false: low frequency borrowing; default false |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderNo | string | Borrow Order Id |\n| actualSize | string | Actual borrowed amount |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"USDT\",\n \"size\": 10,\n \"timeInForce\": \"FOK\",\n \"isIsolated\": false,\n \"isHf\": false\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "borrow" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderNo\": \"67187162c0d6990007717b15\",\n \"actualSize\": \"10\"\n }\n}" + } + ] + }, + { + "name": "Get Borrow History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "borrow" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + }, + { + "key": "isIsolated", + "value": null, + "description": "true-isolated, false-cross; default is false" + }, + { + "key": "symbol", + "value": null, + "description": "symbol, mandatory for isolated margin account" + }, + { + "key": "orderNo", + "value": null, + "description": "Borrow Order Id" + }, + { + "key": "startTime", + "value": null, + "description": "The start and end times are not restricted. If the start time is empty or less than 1680278400000, the default value is set to 1680278400000 (April 1, 2023, 00:00:00)" + }, + { + "key": "endTime", + "value": null, + "description": "End time" + }, + { + "key": "currentPage", + "value": null, + "description": "Current query page, with a starting value of 1. Default:1\n" + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per page. Default is 50, minimum is 10, maximum is 500" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470207)\n\n:::info[Description]\nThis API endpoint is used to get the borrowing orders for cross and isolated margin accounts\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| timestamp | integer | |\n| currentPage | integer | current page |\n| pageSize | integer | page size |\n| totalNum | integer | total number |\n| totalPage | integer | total page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderNo | string | Borrow Order Id |\n| symbol | string | Isolated Margin symbol; empty for cross margin |\n| currency | string | currency |\n| size | string | Initiated borrow amount |\n| actualSize | string | Actual borrow amount |\n| status | string | PENDING: Processing, SUCCESS: Successful, FAILED: Failed |\n| createdTime | integer | borrow time |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "borrow" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + }, + { + "key": "isIsolated", + "value": null, + "description": "true-isolated, false-cross; default is false" + }, + { + "key": "symbol", + "value": null, + "description": "symbol, mandatory for isolated margin account" + }, + { + "key": "orderNo", + "value": null, + "description": "Borrow Order Id" + }, + { + "key": "startTime", + "value": null, + "description": "The start and end times are not restricted. If the start time is empty or less than 1680278400000, the default value is set to 1680278400000 (April 1, 2023, 00:00:00)" + }, + { + "key": "endTime", + "value": null, + "description": "End time" + }, + { + "key": "currentPage", + "value": null, + "description": "Current query page, with a starting value of 1. Default:1\n" + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per page. Default is 50, minimum is 10, maximum is 500" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"timestamp\": 1729657580449,\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 2,\n \"totalPage\": 1,\n \"items\": [\n {\n \"orderNo\": \"67187162c0d6990007717b15\",\n \"symbol\": null,\n \"currency\": \"USDT\",\n \"size\": \"10\",\n \"actualSize\": \"10\",\n \"status\": \"SUCCESS\",\n \"createdTime\": 1729655138000\n },\n {\n \"orderNo\": \"67187155b088e70007149585\",\n \"symbol\": null,\n \"currency\": \"USDT\",\n \"size\": \"0.1\",\n \"actualSize\": \"0\",\n \"status\": \"FAILED\",\n \"createdTime\": 1729655125000\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Repay History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "repay" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + }, + { + "key": "isIsolated", + "value": null, + "description": "true-isolated, false-cross; default is false" + }, + { + "key": "symbol", + "value": null, + "description": "symbol, mandatory for isolated margin account" + }, + { + "key": "orderNo", + "value": null, + "description": "Repay Order Id" + }, + { + "key": "startTime", + "value": null, + "description": "The start and end times are not restricted. If the start time is empty or less than 1680278400000, the default value is set to 1680278400000 (April 1, 2023, 00:00:00)" + }, + { + "key": "endTime", + "value": null, + "description": "End time" + }, + { + "key": "currentPage", + "value": null, + "description": "Current query page, with a starting value of 1. Default:1\n" + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per page. Default is 50, minimum is 10, maximum is 500" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470208)\n\n:::info[Description]\nThis API endpoint is used to get the repayment orders for cross and isolated margin accounts\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| timestamp | integer | |\n| currentPage | integer | current page |\n| pageSize | integer | page size |\n| totalNum | integer | total number |\n| totalPage | integer | total page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderNo | string | Repay Order Id |\n| symbol | string | Isolated Margin symbol; empty for cross margin |\n| currency | string | currency |\n| size | string | Amount of initiated repay |\n| principal | string | Amount of principal paid |\n| interest | string | Amount of interest paid |\n| status | string | PENDING: Processing, SUCCESS: Successful, FAILED: Failed |\n| createdTime | integer | Repayment time |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "repay" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + }, + { + "key": "isIsolated", + "value": null, + "description": "true-isolated, false-cross; default is false" + }, + { + "key": "symbol", + "value": null, + "description": "symbol, mandatory for isolated margin account" + }, + { + "key": "orderNo", + "value": null, + "description": "Repay Order Id" + }, + { + "key": "startTime", + "value": null, + "description": "The start and end times are not restricted. If the start time is empty or less than 1680278400000, the default value is set to 1680278400000 (April 1, 2023, 00:00:00)" + }, + { + "key": "endTime", + "value": null, + "description": "End time" + }, + { + "key": "currentPage", + "value": null, + "description": "Current query page, with a starting value of 1. Default:1\n" + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per page. Default is 50, minimum is 10, maximum is 500" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"timestamp\": 1729663471891,\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"orderNo\": \"671873361d5bd400075096ad\",\n \"symbol\": null,\n \"currency\": \"USDT\",\n \"size\": \"10\",\n \"principal\": \"9.99986518\",\n \"interest\": \"0.00013482\",\n \"status\": \"SUCCESS\",\n \"createdTime\": 1729655606000\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Interest History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "interest" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + }, + { + "key": "isIsolated", + "value": null, + "description": "true-isolated, false-cross; default is false" + }, + { + "key": "symbol", + "value": null, + "description": "symbol, mandatory for isolated margin account" + }, + { + "key": "startTime", + "value": null, + "description": "The start and end times are not restricted. If the start time is empty or less than 1680278400000, the default value is set to 1680278400000 (April 1, 2023, 00:00:00)" + }, + { + "key": "endTime", + "value": null, + "description": "End time" + }, + { + "key": "currentPage", + "value": null, + "description": "Current query page, with a starting value of 1. Default:1\n" + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per page. Default is 50, minimum is 10, maximum is 500" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470209)\n\n:::info[Description]\nRequest via this endpoint to get the interest records of the cross/isolated margin lending.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| timestamp | integer | |\n| currentPage | integer | current page |\n| pageSize | integer | page size |\n| totalNum | integer | total number |\n| totalPage | integer | total page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| dayRatio | string | Daily interest rate |\n| interestAmount | string | Interest amount |\n| createdTime | integer | Interest Timestamp |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "interest" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + }, + { + "key": "isIsolated", + "value": null, + "description": "true-isolated, false-cross; default is false" + }, + { + "key": "symbol", + "value": null, + "description": "symbol, mandatory for isolated margin account" + }, + { + "key": "startTime", + "value": null, + "description": "The start and end times are not restricted. If the start time is empty or less than 1680278400000, the default value is set to 1680278400000 (April 1, 2023, 00:00:00)" + }, + { + "key": "endTime", + "value": null, + "description": "End time" + }, + { + "key": "currentPage", + "value": null, + "description": "Current query page, with a starting value of 1. Default:1\n" + }, + { + "key": "pageSize", + "value": null, + "description": "Number of results per page. Default is 50, minimum is 10, maximum is 500" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"timestamp\": 1729665170701,\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 3,\n \"totalPage\": 1,\n \"items\": [\n {\n \"currency\": \"USDT\",\n \"dayRatio\": \"0.000296\",\n \"interestAmount\": \"0.00000001\",\n \"createdTime\": 1729663213375\n },\n {\n \"currency\": \"USDT\",\n \"dayRatio\": \"0.000296\",\n \"interestAmount\": \"0.00000001\",\n \"createdTime\": 1729659618802\n },\n {\n \"currency\": \"USDT\",\n \"dayRatio\": \"0.000296\",\n \"interestAmount\": \"0.00000001\",\n \"createdTime\": 1729656028077\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Repay", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "repay" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470210)\n\n:::info[Description]\nThis API endpoint is used to initiate an application for cross or isolated margin repayment.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| size | number | Borrow amount |\n| symbol | string | symbol, mandatory for isolated margin account |\n| isIsolated | boolean | true-isolated, false-cross; default is false |\n| isHf | boolean | true: high frequency borrowing, false: low frequency borrowing; default false |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| timestamp | integer | |\n| orderNo | string | Repay Order Id |\n| actualSize | string | Actual repay amount |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"USDT\",\n \"size\": 10\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "repay" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"timestamp\": 1729655606816,\n \"orderNo\": \"671873361d5bd400075096ad\",\n \"actualSize\": \"10\"\n }\n}" + } + ] + }, + { + "name": "Modify Leverage", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "position", + "update-user-leverage" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470211)\n\n:::info[Description]\nThis endpoint allows modifying the leverage multiplier for cross margin or isolated margin.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | symbol, mandatory for isolated margin account |\n| isIsolated | boolean | true-isolated, false-cross; default is false |\n| leverage | string | New leverage multiplier. Must be greater than 1 and up to two decimal places, and cannot be less than the user's current debt leverage or greater than the system's maximum leverage |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | string | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"leverage\": \"5\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "position", + "update-user-leverage" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": null\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Credit", + "item": [ + { + "name": "Get Loan Market", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "project", + "list" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470212)\n\n:::info[Description]\nThis API endpoint is used to get the information about the currencies available for lending.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| purchaseEnable | boolean | Whether purchase is supported. |\n| redeemEnable | boolean | Whether redeem is supported. |\n| increment | string | Increment precision for purchase and redemption |\n| minPurchaseSize | string | Minimum purchase amount |\n| minInterestRate | string | Minimum lending rate |\n| maxInterestRate | string | Maximum lending rate |\n| interestIncrement | string | Increment precision for interest; default is 0.0001 |\n| maxPurchaseSize | string | Maximum purchase amount |\n| marketInterestRate | string | Latest market lending rate |\n| autoPurchaseEnable | boolean | Whether to allow automatic purchase: true: on, false: off |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "project", + "list" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"currency\": \"BTC\",\n \"purchaseEnable\": true,\n \"redeemEnable\": true,\n \"increment\": \"0.00000001\",\n \"minPurchaseSize\": \"0.001\",\n \"maxPurchaseSize\": \"40\",\n \"interestIncrement\": \"0.0001\",\n \"minInterestRate\": \"0.005\",\n \"marketInterestRate\": \"0.005\",\n \"maxInterestRate\": \"0.32\",\n \"autoPurchaseEnable\": false\n }\n ]\n}" + } + ] + }, + { + "name": "Get Purchase Orders", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "purchase", + "orders" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + }, + { + "key": "status", + "value": null, + "description": "DONE-completed; PENDING-settling" + }, + { + "key": "purchaseOrderNo", + "value": null, + "description": "" + }, + { + "key": "currentPage", + "value": null, + "description": "Current page; default is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "Page size; 1<=pageSize<=100; default is 50" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470213)\n\n:::info[Description]\nThis API endpoint provides pagination query for the purchase orders.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | Current Page |\n| pageSize | integer | Page Size |\n| totalNum | integer | Total Number |\n| totalPage | integer | Total Page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| purchaseOrderNo | string | Purchase order id |\n| purchaseSize | string | Total purchase size |\n| matchSize | string | Executed size |\n| interestRate | string | Target annualized interest rate |\n| incomeSize | string | Redeemed amount |\n| applyTime | integer | Time of purchase |\n| status | string | Status: DONE-completed; PENDING-settling |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "purchase", + "orders" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + }, + { + "key": "status", + "value": null, + "description": "DONE-completed; PENDING-settling" + }, + { + "key": "purchaseOrderNo", + "value": null, + "description": "" + }, + { + "key": "currentPage", + "value": null, + "description": "Current page; default is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "Page size; 1<=pageSize<=100; default is 50" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 10,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"currency\": \"BTC\",\n \"purchaseOrderNo\": \"671bb15a3b3f930007880bae\",\n \"purchaseSize\": \"0.001\",\n \"matchSize\": \"0\",\n \"interestRate\": \"0.1\",\n \"incomeSize\": \"0\",\n \"applyTime\": 1729868122172,\n \"status\": \"PENDING\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Redeem Orders", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "redeem", + "orders" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + }, + { + "key": "status", + "value": null, + "description": "DONE-completed; PENDING-settling" + }, + { + "key": "redeemOrderNo", + "value": null, + "description": "Redeem order id" + }, + { + "key": "currentPage", + "value": null, + "description": "Current page; default is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "Page size; 1<=pageSize<=100; default is 50" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470214)\n\n:::info[Description]\nThis API endpoint provides pagination query for the redeem orders.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | Current Page |\n| pageSize | integer | Page Size |\n| totalNum | integer | Total Number |\n| totalPage | integer | Total Page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| purchaseOrderNo | string | Purchase order id |\n| redeemOrderNo | string | Redeem order id |\n| redeemSize | string | Redemption size |\n| receiptSize | string | Redeemed size |\n| applyTime | string | Time of redeem |\n| status | string | Status: DONE-completed; PENDING-settling |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "redeem", + "orders" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "currency" + }, + { + "key": "status", + "value": null, + "description": "DONE-completed; PENDING-settling" + }, + { + "key": "redeemOrderNo", + "value": null, + "description": "Redeem order id" + }, + { + "key": "currentPage", + "value": null, + "description": "Current page; default is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "Page size; 1<=pageSize<=100; default is 50" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 10,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"currency\": \"BTC\",\n \"purchaseOrderNo\": \"671bafa804c26d000773c533\",\n \"redeemOrderNo\": \"671bb01004c26d000773c55c\",\n \"redeemSize\": \"0.001\",\n \"receiptSize\": \"0.001\",\n \"applyTime\": null,\n \"status\": \"DONE\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Loan Market Interest Rate", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "project", + "marketInterestRate" + ], + "query": [ + { + "key": "currency", + "value": "USDT", + "description": "currency" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470215)\n\n:::info[Description]\nThis API endpoint is used to get the interest rates of the margin lending market over the past 7 days.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| time | string | Time: YYYYMMDDHH00 |\n| marketInterestRate | string | Market lending rate |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "project", + "marketInterestRate" + ], + "query": [ + { + "key": "currency", + "value": "USDT", + "description": "currency" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"time\": \"202410170000\",\n \"marketInterestRate\": \"0.005\"\n },\n {\n \"time\": \"202410170100\",\n \"marketInterestRate\": \"0.005\"\n }\n ]\n}" + } + ] + }, + { + "name": "Purchase", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "purchase" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470216)\n\n:::info[Description]\nInvest credit in the market and earn interest,Please ensure that the funds are in the main(funding) account\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| size | string | purchase amount |\n| interestRate | string | purchase interest rate |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderNo | string | Purchase order id |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"BTC\",\n \"size\": \"0.001\",\n \"interestRate\": \"0.1\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "purchase" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderNo\": \"671bafa804c26d000773c533\"\n }\n}" + } + ] + }, + { + "name": "Modify Purchase", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "lend", + "purchase", + "update" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470217)\n\n:::info[Description]\nThis API endpoint is used to update the interest rates of subscription orders, which will take effect at the beginning of the next hour.,Please ensure that the funds are in the main(funding) account\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| interestRate | string | Modified purchase interest rate |\n| purchaseOrderNo | string | Purchase order id |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | string | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"BTC\",\n \"purchaseOrderNo\": \"671bafa804c26d000773c533\",\n \"interestRate\": \"0.09\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "lend", + "purchase", + "update" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": null\n}" + } + ] + }, + { + "name": "Redeem", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "redeem" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470218)\n\n:::info[Description]\nRedeem your loan order\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| size | string | Redemption amount |\n| purchaseOrderNo | string | Purchase order id |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderNo | string | Redeem order id |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"BTC\",\n \"size\": \"0.001\",\n \"purchaseOrderNo\": \"671bafa804c26d000773c533\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "redeem" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderNo\": \"671bafa804c26d000773c533\"\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Risk Limit", + "item": [ + { + "name": "Get Margin Risk Limit", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "currencies" + ], + "query": [ + { + "key": "isIsolated", + "value": "false", + "description": "true-isolated, false-cross" + }, + { + "key": "currency", + "value": "BTC", + "description": "currency, This field is only required for cross margin" + }, + { + "key": "symbol", + "value": null, + "description": "symbol, This field is only required for isolated margin" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470219)\n\n:::info[Description]\nRequest via this endpoint to get the Configure and Risk limit info of the margin.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| timestamp | integer | Time stamp |\n| currency | string | CROSS MARGIN RESPONSES, Currency |\n| borrowMaxAmount | string | CROSS MARGIN RESPONSES, Maximum personal borrow amount. If the platform has no borrowing amount, this value will still be displayed. |\n| buyMaxAmount | string | CROSS MARGIN RESPONSES, Maximum buy amount |\n| holdMaxAmount | string | CROSS MARGIN RESPONSES, Maximum holding amount |\n| borrowCoefficient | string | CROSS MARGIN RESPONSES, [Borrow Coefficient](https://www.kucoin.com/land/price-protect) |\n| marginCoefficient | string | CROSS MARGIN RESPONSES, [Margin Coefficient](https://www.kucoin.com/land/price-protect) |\n| precision | integer | CROSS MARGIN RESPONSES, Currency precision. the minimum repayment amount of a single transaction should be >= currency precision, for example, the precision of ETH is 8, and the minimum repayment amount is 0.00000001 |\n| borrowMinAmount | string | CROSS MARGIN RESPONSES, Minimum personal borrow amount |\n| borrowMinUnit | string | CROSS MARGIN RESPONSES, Minimum unit for borrowing, the borrowed amount must be an integer multiple of this value |\n| borrowEnabled | boolean | CROSS MARGIN RESPONSES, Whether to support borrowing |\n| symbol | string | ISOLATED MARGIN RESPONSES, Symbol |\n| baseMaxBorrowAmount | string | ISOLATED MARGIN RESPONSES, Base maximum personal borrow amount. If the platform has no borrowing amount, this value will still be displayed. |\n| quoteMaxBorrowAmount | string | ISOLATED MARGIN RESPONSES, Quote maximum personal borrow amount. If the platform has no borrowing amount, this value will still be displayed. |\n| baseMaxBuyAmount | string | ISOLATED MARGIN RESPONSES, Base maximum buy amount
|\n| quoteMaxBuyAmount | string | ISOLATED MARGIN RESPONSES, Quote maximum buy amount |\n| baseMaxHoldAmount | string | ISOLATED MARGIN RESPONSES, Base maximum holding amount
|\n| quoteMaxHoldAmount | string | ISOLATED MARGIN RESPONSES, Quote maximum holding amount
|\n| basePrecision | integer | ISOLATED MARGIN RESPONSES, Base currency precision. the minimum repayment amount of a single transaction should be >= currency precision, for example, the precision of ETH is 8, and the minimum repayment amount is 0.00000001 |\n| quotePrecision | integer | ISOLATED MARGIN RESPONSES, Quote currency precision. the minimum repayment amount of a single transaction should be >= currency precision, for example, the precision of ETH is 8, and the minimum repayment amount is 0.00000001
|\n| baseBorrowMinAmount | string | ISOLATED MARGIN RESPONSES, Base minimum personal borrow amount
|\n| quoteBorrowMinAmount | string | ISOLATED MARGIN RESPONSES, Quote minimum personal borrow amount |\n| baseBorrowMinUnit | string | ISOLATED MARGIN RESPONSES, Base minimum unit for borrowing, the borrowed amount must be an integer multiple of this value |\n| quoteBorrowMinUnit | string | ISOLATED MARGIN RESPONSES, Quote minimum unit for borrowing, the borrowed amount must be an integer multiple of this value |\n| baseBorrowEnabled | boolean | ISOLATED MARGIN RESPONSES, Base whether to support borrowing
|\n| quoteBorrowEnabled | boolean | ISOLATED MARGIN RESPONSES, Quote whether to support borrowing
|\n| baseBorrowCoefficient | string | ISOLATED MARGIN RESPONSES, [Base Borrow Coefficient](https://www.kucoin.com/land/price-protect) |\n| quoteBorrowCoefficient | string | ISOLATED MARGIN RESPONSES, [Quote Borrow Coefficient](https://www.kucoin.com/land/price-protect) |\n| baseMarginCoefficient | string | ISOLATED MARGIN RESPONSES, [Base Margin Coefficient](https://www.kucoin.com/land/price-protect) |\n| quoteMarginCoefficient | string | ISOLATED MARGIN RESPONSES, [Quote Margin Coefficient](https://www.kucoin.com/land/price-protect) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v3", + "margin", + "currencies" + ], + "query": [ + { + "key": "isIsolated", + "value": "false", + "description": "true-isolated, false-cross" + }, + { + "key": "currency", + "value": "BTC", + "description": "currency, This field is only required for cross margin" + }, + { + "key": "symbol", + "value": null, + "description": "symbol, This field is only required for isolated margin" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "//Cross Margin\n{\n \"code\": \"200000\",\n \"data\": [\n {\n \"timestamp\": 1729678659275,\n \"currency\": \"BTC\",\n \"borrowMaxAmount\": \"75.15\",\n \"buyMaxAmount\": \"217.12\",\n \"holdMaxAmount\": \"217.12\",\n \"borrowCoefficient\": \"1\",\n \"marginCoefficient\": \"1\",\n \"precision\": 8,\n \"borrowMinAmount\": \"0.001\",\n \"borrowMinUnit\": \"0.0001\",\n \"borrowEnabled\": true\n }\n ]\n}\n\n//Isolated Margin\n//{\n// \"code\": \"200000\",\n// \"data\": [\n// {\n// \"timestamp\": 1729685173576,\n// \"symbol\": \"BTC-USDT\",\n// \"baseMaxBorrowAmount\": \"75.4\",\n// \"quoteMaxBorrowAmount\": \"6000000\",\n// \"baseMaxBuyAmount\": \"217.84\",\n// \"quoteMaxBuyAmount\": \"8000000\",\n// \"baseMaxHoldAmount\": \"217.84\",\n// \"quoteMaxHoldAmount\": \"8000000\",\n// \"basePrecision\": 8,\n// \"quotePrecision\": 8,\n// \"baseBorrowCoefficient\": \"1\",\n// \"quoteBorrowCoefficient\": \"1\",\n// \"baseMarginCoefficient\": \"1\",\n// \"quoteMarginCoefficient\": \"1\",\n// \"baseBorrowMinAmount\": \"0.001\",\n// \"baseBorrowMinUnit\": \"0.0001\",\n// \"quoteBorrowMinAmount\": \"10\",\n// \"quoteBorrowMinUnit\": \"1\",\n// \"baseBorrowEnabled\": true,\n// \"quoteBorrowEnabled\": true\n// }\n// ]\n//}" + } + ] + } + ], + "description": "" + } + ], + "description": "" + }, + { + "name": "Futures Trading", + "item": [ + { + "name": "Market Data", + "item": [ + { + "name": "Get All Symbols", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "contracts", + "active" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470220)\n\n:::info[Description]\nGet detailed information of all contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | 200000 is for success, other is error |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol |\n| rootSymbol | string | Contract group |\n| type | string | Type of the contract |\n| firstOpenDate | integer | First Open Date(millisecond) |\n| expireDate | integer | Expiration date(millisecond). Null means it will never expire |\n| settleDate | integer | Settlement date(millisecond). Null indicates that automatic settlement is not supported |\n| baseCurrency | string | Base currency |\n| quoteCurrency | string | Quote currency |\n| settleCurrency | string | Currency used to clear and settle the trades |\n| maxOrderQty | integer | Maximum order quantity |\n| maxPrice | number | Maximum order price |\n| lotSize | integer | Minimum lot size |\n| tickSize | number | Minimum price changes |\n| indexPriceTickSize | number | Index price of tick size |\n| multiplier | number | The basic unit of the contract API is lots. For the number of coins in each lot, please refer to the param multiplier. For example, for XBTUSDTM, multiplier=0.001, which corresponds to the value of each XBTUSDTM contract being 0.001 BTC. There is also a special case. All coin-swap contracts, such as each XBTUSDM contract, correspond to 1 USD. |\n| initialMargin | number | Initial margin requirement |\n| maintainMargin | number | Maintenance margin requirement |\n| maxRiskLimit | integer | Maximum risk limit (unit: XBT) |\n| minRiskLimit | integer | Minimum risk limit (unit: XBT) |\n| riskStep | integer | Risk limit increment value (unit: XBT) |\n| makerFeeRate | number | Maker fee rate |\n| takerFeeRate | number | Taker fee rate |\n| takerFixFee | number | Deprecated param |\n| makerFixFee | number | Deprecated param |\n| settlementFee | number | Settlement fee |\n| isDeleverage | boolean | Enabled ADL or not |\n| isQuanto | boolean | Deprecated param |\n| isInverse | boolean | Whether it is a reverse contract |\n| markMethod | string | Marking method |\n| fairMethod | string | Fair price marking method, The Futures contract is null |\n| fundingBaseSymbol | string | Ticker symbol of the based currency |\n| fundingQuoteSymbol | string | Ticker symbol of the quote currency |\n| fundingRateSymbol | string | Funding rate symbol |\n| indexSymbol | string | Index symbol |\n| settlementSymbol | string | Settlement Symbol |\n| status | string | Contract status |\n| fundingFeeRate | number | Funding fee rate |\n| predictedFundingFeeRate | number | Predicted funding fee rate |\n| fundingRateGranularity | integer | Funding interval(millisecond) |\n| openInterest | string | Open interest |\n| turnoverOf24h | number | 24-hour turnover |\n| volumeOf24h | number | 24-hour volume |\n| markPrice | number | Mark price |\n| indexPrice | number | Index price |\n| lastTradePrice | number | Last trade price |\n| nextFundingRateTime | integer | Next funding rate time(millisecond) |\n| maxLeverage | integer | Maximum leverage |\n| sourceExchanges | array | Refer to the schema section of sourceExchanges |\n| premiumsSymbol1M | string | Premium index symbol(1 minute) |\n| premiumsSymbol8H | string | Premium index symbol(8 hours) |\n| fundingBaseSymbol1M | string | Base currency interest rate symbol(1 minute) |\n| fundingQuoteSymbol1M | string | Quote currency interest rate symbol(1 minute) |\n| lowPrice | number | 24-hour lowest price |\n| highPrice | number | 24-hour highest price |\n| priceChgPct | number | 24-hour price change% |\n| priceChg | number | 24-hour price change |\n| k | number | |\n| m | number | |\n| f | number | |\n| mmrLimit | number | |\n| mmrLevConstant | number | |\n| supportCross | boolean | Whether support Cross Margin |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "contracts", + "active" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"XBTUSDTM\",\n \"rootSymbol\": \"USDT\",\n \"type\": \"FFWCSX\",\n \"firstOpenDate\": 1585555200000,\n \"expireDate\": null,\n \"settleDate\": null,\n \"baseCurrency\": \"XBT\",\n \"quoteCurrency\": \"USDT\",\n \"settleCurrency\": \"USDT\",\n \"maxOrderQty\": 1000000,\n \"maxPrice\": 1000000.0,\n \"lotSize\": 1,\n \"tickSize\": 0.1,\n \"indexPriceTickSize\": 0.01,\n \"multiplier\": 0.001,\n \"initialMargin\": 0.008,\n \"maintainMargin\": 0.004,\n \"maxRiskLimit\": 100000,\n \"minRiskLimit\": 100000,\n \"riskStep\": 50000,\n \"makerFeeRate\": 0.0002,\n \"takerFeeRate\": 0.0006,\n \"takerFixFee\": 0.0,\n \"makerFixFee\": 0.0,\n \"settlementFee\": null,\n \"isDeleverage\": true,\n \"isQuanto\": true,\n \"isInverse\": false,\n \"markMethod\": \"FairPrice\",\n \"fairMethod\": \"FundingRate\",\n \"fundingBaseSymbol\": \".XBTINT8H\",\n \"fundingQuoteSymbol\": \".USDTINT8H\",\n \"fundingRateSymbol\": \".XBTUSDTMFPI8H\",\n \"indexSymbol\": \".KXBTUSDT\",\n \"settlementSymbol\": \"\",\n \"status\": \"Open\",\n \"fundingFeeRate\": 0.000153,\n \"predictedFundingFeeRate\": 8e-05,\n \"fundingRateGranularity\": 28800000,\n \"openInterest\": \"6384957\",\n \"turnoverOf24h\": 578840222.0999069,\n \"volumeOf24h\": 8274.432,\n \"markPrice\": 69732.33,\n \"indexPrice\": 69732.32,\n \"lastTradePrice\": 69732,\n \"nextFundingRateTime\": 21265941,\n \"maxLeverage\": 125,\n \"sourceExchanges\": [\n \"okex\",\n \"binance\",\n \"kucoin\",\n \"bybit\",\n \"bitmart\",\n \"gateio\"\n ],\n \"premiumsSymbol1M\": \".XBTUSDTMPI\",\n \"premiumsSymbol8H\": \".XBTUSDTMPI8H\",\n \"fundingBaseSymbol1M\": \".XBTINT\",\n \"fundingQuoteSymbol1M\": \".USDTINT\",\n \"lowPrice\": 68817.5,\n \"highPrice\": 71615.8,\n \"priceChgPct\": 0.0006,\n \"priceChg\": 48.0,\n \"k\": 490.0,\n \"m\": 300.0,\n \"f\": 1.3,\n \"mmrLimit\": 0.3,\n \"mmrLevConstant\": 125.0,\n \"supportCross\": true\n }\n ]\n}" + } + ] + }, + { + "name": "Get Symbol", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "contracts", + "{{symbol}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470221)\n\n:::info[Description]\nGet information of specified contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | 200000 is for success, other is error |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol |\n| rootSymbol | string | Contract group |\n| type | string | Type of the contract |\n| firstOpenDate | integer | First Open Date(millisecond) |\n| expireDate | integer | Expiration date(millisecond). Null means it will never expire |\n| settleDate | integer | Settlement date(millisecond). Null indicates that automatic settlement is not supported |\n| baseCurrency | string | Base currency |\n| quoteCurrency | string | Quote currency |\n| settleCurrency | string | Currency used to clear and settle the trades |\n| maxOrderQty | integer | Maximum order quantity |\n| maxPrice | number | Maximum order price |\n| lotSize | integer | Minimum lot size |\n| tickSize | number | Minimum price changes |\n| indexPriceTickSize | number | Index price of tick size |\n| multiplier | number | The basic unit of the contract API is lots. For the number of coins in each lot, please refer to the param multiplier. For example, for XBTUSDTM, multiplier=0.001, which corresponds to the value of each XBTUSDTM contract being 0.001 BTC. There is also a special case. All coin-swap contracts, such as each XBTUSDM contract, correspond to 1 USD. |\n| initialMargin | number | Initial margin requirement |\n| maintainMargin | number | Maintenance margin requirement |\n| maxRiskLimit | integer | Maximum risk limit (unit: XBT) |\n| minRiskLimit | integer | Minimum risk limit (unit: XBT) |\n| riskStep | integer | Risk limit increment value (unit: XBT) |\n| makerFeeRate | number | Maker fee rate |\n| takerFeeRate | number | Taker fee rate |\n| takerFixFee | number | Deprecated param |\n| makerFixFee | number | Deprecated param |\n| settlementFee | number | Settlement fee |\n| isDeleverage | boolean | Enabled ADL or not |\n| isQuanto | boolean | Deprecated param |\n| isInverse | boolean | Whether it is a reverse contract |\n| markMethod | string | Marking method |\n| fairMethod | string | Fair price marking method, The Futures contract is null |\n| fundingBaseSymbol | string | Ticker symbol of the based currency |\n| fundingQuoteSymbol | string | Ticker symbol of the quote currency |\n| fundingRateSymbol | string | Funding rate symbol |\n| indexSymbol | string | Index symbol |\n| settlementSymbol | string | Settlement Symbol |\n| status | string | Contract status |\n| fundingFeeRate | number | Funding fee rate |\n| predictedFundingFeeRate | number | Predicted funding fee rate |\n| fundingRateGranularity | integer | Funding interval(millisecond) |\n| openInterest | string | Open interest |\n| turnoverOf24h | number | 24-hour turnover |\n| volumeOf24h | number | 24-hour volume |\n| markPrice | number | Mark price |\n| indexPrice | number | Index price |\n| lastTradePrice | number | Last trade price |\n| nextFundingRateTime | integer | Next funding rate time(millisecond) |\n| maxLeverage | integer | Maximum leverage |\n| sourceExchanges | array | Refer to the schema section of sourceExchanges |\n| premiumsSymbol1M | string | Premium index symbol(1 minute) |\n| premiumsSymbol8H | string | Premium index symbol(8 hours) |\n| fundingBaseSymbol1M | string | Base currency interest rate symbol(1 minute) |\n| fundingQuoteSymbol1M | string | Quote currency interest rate symbol(1 minute) |\n| lowPrice | number | 24-hour lowest price |\n| highPrice | number | 24-hour highest price |\n| priceChgPct | number | 24-hour price change% |\n| priceChg | number | 24-hour price change |\n| k | number | |\n| m | number | |\n| f | number | |\n| mmrLimit | number | |\n| mmrLevConstant | number | |\n| supportCross | boolean | Whether support Cross Margin |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "contracts", + "{{symbol}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"XBTUSDM\",\n \"rootSymbol\": \"XBT\",\n \"type\": \"FFWCSX\",\n \"firstOpenDate\": 1552638575000,\n \"expireDate\": null,\n \"settleDate\": null,\n \"baseCurrency\": \"XBT\",\n \"quoteCurrency\": \"USD\",\n \"settleCurrency\": \"XBT\",\n \"maxOrderQty\": 10000000,\n \"maxPrice\": 1000000.0,\n \"lotSize\": 1,\n \"tickSize\": 0.1,\n \"indexPriceTickSize\": 0.1,\n \"multiplier\": -1.0,\n \"initialMargin\": 0.014,\n \"maintainMargin\": 0.007,\n \"maxRiskLimit\": 1,\n \"minRiskLimit\": 1,\n \"riskStep\": 0,\n \"makerFeeRate\": 0.0002,\n \"takerFeeRate\": 0.0006,\n \"takerFixFee\": 0.0,\n \"makerFixFee\": 0.0,\n \"settlementFee\": null,\n \"isDeleverage\": true,\n \"isQuanto\": false,\n \"isInverse\": true,\n \"markMethod\": \"FairPrice\",\n \"fairMethod\": \"FundingRate\",\n \"fundingBaseSymbol\": \".XBTINT8H\",\n \"fundingQuoteSymbol\": \".USDINT8H\",\n \"fundingRateSymbol\": \".XBTUSDMFPI8H\",\n \"indexSymbol\": \".BXBT\",\n \"settlementSymbol\": null,\n \"status\": \"Open\",\n \"fundingFeeRate\": 0.000175,\n \"predictedFundingFeeRate\": 0.000176,\n \"fundingRateGranularity\": 28800000,\n \"openInterest\": \"61725904\",\n \"turnoverOf24h\": 209.56303473,\n \"volumeOf24h\": 14354731.0,\n \"markPrice\": 68336.7,\n \"indexPrice\": 68335.29,\n \"lastTradePrice\": 68349.3,\n \"nextFundingRateTime\": 17402942,\n \"maxLeverage\": 75,\n \"sourceExchanges\": [\n \"kraken\",\n \"bitstamp\",\n \"crypto\"\n ],\n \"premiumsSymbol1M\": \".XBTUSDMPI\",\n \"premiumsSymbol8H\": \".XBTUSDMPI8H\",\n \"fundingBaseSymbol1M\": \".XBTINT\",\n \"fundingQuoteSymbol1M\": \".USDINT\",\n \"lowPrice\": 67436.7,\n \"highPrice\": 69471.8,\n \"priceChgPct\": 0.0097,\n \"priceChg\": 658.7,\n \"k\": 2645000.0,\n \"m\": 1640000.0,\n \"f\": 1.3,\n \"mmrLimit\": 0.3,\n \"mmrLevConstant\": 75.0,\n \"supportCross\": true\n }\n}" + } + ] + }, + { + "name": "Get Ticker", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "ticker" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) \n\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470222)\n\n:::info[Description]\nThis endpoint returns \"last traded price/size\"、\"best bid/ask price/size\" etc. of a single symbol.\nThese messages can also be obtained through Websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | 200000 is for success, other is error |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| sequence | integer | Sequence number, used to judge whether the messages pushed by Websocket is continuous. |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| side | string | Filled side, The trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book. |\n| size | integer | Filled quantity |\n| tradeId | string | Transaction ID |\n| price | string | Filled price |\n| bestBidPrice | string | Best bid price |\n| bestBidSize | integer | Best bid size |\n| bestAskPrice | string | Best ask price |\n| bestAskSize | integer | Best ask size |\n| ts | integer | Filled time(nanosecond) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "ticker" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) \n\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"sequence\": 1697895100310,\n \"symbol\": \"XBTUSDM\",\n \"side\": \"sell\",\n \"size\": 2936,\n \"tradeId\": \"1697901180000\",\n \"price\": \"67158.4\",\n \"bestBidPrice\": \"67169.6\",\n \"bestBidSize\": 32345,\n \"bestAskPrice\": \"67169.7\",\n \"bestAskSize\": 7251,\n \"ts\": 1729163001780000000\n }\n}" + } + ] + }, + { + "name": "Get All Tickers", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "allTickers" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470223)\n\n:::info[Description]\nThis endpoint returns \"last traded price/size\"、\"best bid/ask price/size\" etc. of all symbol.\nThese messages can also be obtained through Websocket.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | 200000 is for success, other is error |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| sequence | integer | Sequence number, used to judge whether the messages pushed by Websocket is continuous. |\n| symbol | string | Symbol |\n| side | string | Trade direction |\n| size | integer | Filled side, The trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book. |\n| tradeId | string | Transaction ID |\n| price | string | Filled price |\n| bestBidPrice | string | Best bid price |\n| bestBidSize | integer | Best bid size |\n| bestAskPrice | string | Best ask price |\n| bestAskSize | integer | Best ask size |\n| ts | integer | Filled time(nanosecond) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "allTickers" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"sequence\": 1707992727046,\n \"symbol\": \"XBTUSDTM\",\n \"side\": \"sell\",\n \"size\": 21,\n \"tradeId\": \"1784299761369\",\n \"price\": \"67153\",\n \"bestBidPrice\": \"67153\",\n \"bestBidSize\": 2767,\n \"bestAskPrice\": \"67153.1\",\n \"bestAskSize\": 5368,\n \"ts\": 1729163466659000000\n },\n {\n \"sequence\": 1697895166299,\n \"symbol\": \"XBTUSDM\",\n \"side\": \"sell\",\n \"size\": 1956,\n \"tradeId\": \"1697901245065\",\n \"price\": \"67145.2\",\n \"bestBidPrice\": \"67135.3\",\n \"bestBidSize\": 1,\n \"bestAskPrice\": \"67135.8\",\n \"bestAskSize\": 3,\n \"ts\": 1729163445340000000\n }\n ]\n}" + } + ] + }, + { + "name": "Get Full OrderBook", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "level2", + "snapshot" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) \n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470224)\n\n:::info[Discription]\nQuery for Full orderbook depth data. (aggregated by price)\n\nIt is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control.\n\nTo maintain up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | 200000 is for success, other is error |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| sequence | integer | Sequence number |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| bids | array | Refer to the schema section of bids |\n| asks | array | Refer to the schema section of asks |\n| ts | integer | Timestamp(nanosecond) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "level2", + "snapshot" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) \n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"sequence\": 1697895963339,\n \"symbol\": \"XBTUSDM\",\n \"bids\": [\n [\n 66968,\n 2\n ],\n [\n 66964.8,\n 25596\n ]\n ],\n \"asks\": [\n [\n 66968.1,\n 13501\n ],\n [\n 66968.7,\n 2032\n ]\n ],\n \"ts\": 1729168101216000000\n }\n}" + } + ] + }, + { + "name": "Get Part OrderBook", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "level2", + "depth{size}" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470225)\n\n:::info[Discription]\nQuery for part orderbook depth data. (aggregated by price)\n\nYou are recommended to request via this endpoint as the system reponse would be faster and cosume less traffic.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| sequence | integer | Sequence number |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| bids | array | Refer to the schema section of bids |\n| asks | array | Refer to the schema section of asks |\n| ts | integer | Timestamp(nanosecond) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "level2", + "depth{size}" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"sequence\": 1697895963339,\n \"symbol\": \"XBTUSDM\",\n \"bids\": [\n [\n 66968,\n 2\n ],\n [\n 66964.8,\n 25596\n ]\n ],\n \"asks\": [\n [\n 66968.1,\n 13501\n ],\n [\n 66968.7,\n 2032\n ]\n ],\n \"ts\": 1729168101216000000\n }\n}" + } + ] + }, + { + "name": "Get Interest Rate Index", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "interest", + "query" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "reverse", + "value": "true", + "description": "This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default." + }, + { + "key": "offset", + "value": "254062248624417", + "description": "Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default." + }, + { + "key": "forward", + "value": "true", + "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" + }, + { + "key": "maxCount", + "value": "10", + "description": "Max record count. The default record count is 10, The maximum length cannot exceed 100" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470226)\n\n:::info[Discription]\nGet interest rate Index.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| dataList | array | Refer to the schema section of dataList |\n| hasMore | boolean | Whether there are more pages |\n\n**root.data.dataList Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) |\n| granularity | integer | Granularity (milisecond) |\n| timePoint | integer | Timestamp(milisecond) |\n| value | number | Interest rate value |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "interest", + "query" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "reverse", + "value": "true", + "description": "This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default." + }, + { + "key": "offset", + "value": "254062248624417", + "description": "Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default." + }, + { + "key": "forward", + "value": "true", + "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" + }, + { + "key": "maxCount", + "value": "10", + "description": "Max record count. The default record count is 10, The maximum length cannot exceed 100" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"dataList\": [\n {\n \"symbol\": \".XBTINT\",\n \"granularity\": 60000,\n \"timePoint\": 1728692100000,\n \"value\": 0.0003\n },\n {\n \"symbol\": \".XBTINT\",\n \"granularity\": 60000,\n \"timePoint\": 1728692040000,\n \"value\": 0.0003\n }\n ],\n \"hasMore\": true\n }\n}" + } + ] + }, + { + "name": "Get Premium Index", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "premium", + "query" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "reverse", + "value": "true", + "description": "This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default." + }, + { + "key": "offset", + "value": "254062248624417", + "description": "Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default." + }, + { + "key": "forward", + "value": "true", + "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" + }, + { + "key": "maxCount", + "value": "10", + "description": "Max record count. The default record count is 10, The maximum length cannot exceed 100" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470227)\n\n:::info[Discription]\nSubmit request to get premium index.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| dataList | array | Refer to the schema section of dataList |\n| hasMore | boolean | Whether there are more pages |\n\n**root.data.dataList Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) |\n| granularity | integer | Granularity(milisecond) |\n| timePoint | integer | Timestamp(milisecond) |\n| value | number | Premium index |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "premium", + "query" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "startAt", + "value": "1728663338000", + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": "1728692138000", + "description": "End time (milisecond)" + }, + { + "key": "reverse", + "value": "true", + "description": "This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default." + }, + { + "key": "offset", + "value": "254062248624417", + "description": "Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default." + }, + { + "key": "forward", + "value": "true", + "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" + }, + { + "key": "maxCount", + "value": "10", + "description": "Max record count. The default record count is 10, The maximum length cannot exceed 100" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"hasMore\": true,\n \"dataList\": [\n {\n \"symbol\": \".XBTUSDTMPI\",\n \"granularity\": 60000,\n \"timePoint\": 1730558040000,\n \"value\": 6e-05\n },\n {\n \"symbol\": \".XBTUSDTMPI\",\n \"granularity\": 60000,\n \"timePoint\": 1730557980000,\n \"value\": -2.5e-05\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get 24hr Stats", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "trade-statistics" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470228)\n\n:::info[Discription]\nGet the statistics of the platform futures trading volume in the last 24 hours.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| turnoverOf24h | number | 24-hour platform Futures trading volume. Unit is USD |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "trade-statistics" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"turnoverOf24h\": 1115573341.3273683\n }\n}" + } + ] + }, + { + "name": "Get Server Time", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "timestamp" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470229)\n\n:::info[Discription]\nGet the API server time. This is the Unix timestamp.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | integer | ServerTime(millisecond) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "timestamp" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": 1729260030774\n}" + } + ] + }, + { + "name": "Get Service Status", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "status" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470230)\n\n:::info[Discription]\nGet the service status.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| msg | string | |\n| status | string | Status of service: open：normal transaction, close：Stop Trading/Maintenance, cancelonly：can only cancel the order but not place order |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "status" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"msg\": \"\",\n \"status\": \"open\"\n }\n}" + } + ] + }, + { + "name": "Get Spot Index Price", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "index", + "query" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milisecond)" + }, + { + "key": "reverse", + "value": null, + "description": "This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default." + }, + { + "key": "offset", + "value": null, + "description": "Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default." + }, + { + "key": "forward", + "value": null, + "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" + }, + { + "key": "maxCount", + "value": null, + "description": "Max record count. The default record count is 10, The maximum length cannot exceed 100" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470231)\n\n:::info[Discription]\nGet Spot Index price\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| dataList | array | Refer to the schema section of dataList |\n| hasMore | boolean | Whether there are more pages |\n\n**root.data.dataList Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) |\n| granularity | integer | Granularity (milisecond) |\n| timePoint | integer | Timestamp (milisecond) |\n| value | number | Index Value |\n| decomposionList | array | Refer to the schema section of decomposionList |\n\n**root.data.dataList.decomposionList Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| exchange | string | Exchange |\n| price | number | Price |\n| weight | number | Weight |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "index", + "query" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milisecond)" + }, + { + "key": "reverse", + "value": null, + "description": "This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default." + }, + { + "key": "offset", + "value": null, + "description": "Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default." + }, + { + "key": "forward", + "value": null, + "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" + }, + { + "key": "maxCount", + "value": null, + "description": "Max record count. The default record count is 10, The maximum length cannot exceed 100" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"hasMore\": true,\n \"dataList\": [\n {\n \"symbol\": \".KXBTUSDT\",\n \"granularity\": 1000,\n \"timePoint\": 1730557515000,\n \"value\": 69202.94,\n \"decomposionList\": [\n {\n \"exchange\": \"gateio\",\n \"price\": 69209.27,\n \"weight\": 0.0533\n },\n {\n \"exchange\": \"bitmart\",\n \"price\": 69230.77,\n \"weight\": 0.0128\n },\n {\n \"exchange\": \"okex\",\n \"price\": 69195.34,\n \"weight\": 0.11\n },\n {\n \"exchange\": \"bybit\",\n \"price\": 69190.33,\n \"weight\": 0.0676\n },\n {\n \"exchange\": \"binance\",\n \"price\": 69204.55,\n \"weight\": 0.6195\n },\n {\n \"exchange\": \"kucoin\",\n \"price\": 69202.91,\n \"weight\": 0.1368\n }\n ]\n },\n {\n \"symbol\": \".KXBTUSDT\",\n \"granularity\": 1000,\n \"timePoint\": 1730557514000,\n \"value\": 69204.98,\n \"decomposionList\": [\n {\n \"exchange\": \"gateio\",\n \"price\": 69212.71,\n \"weight\": 0.0808\n },\n {\n \"exchange\": \"bitmart\",\n \"price\": 69230.77,\n \"weight\": 0.0134\n },\n {\n \"exchange\": \"okex\",\n \"price\": 69195.49,\n \"weight\": 0.0536\n },\n {\n \"exchange\": \"bybit\",\n \"price\": 69195.97,\n \"weight\": 0.0921\n },\n {\n \"exchange\": \"binance\",\n \"price\": 69204.56,\n \"weight\": 0.5476\n },\n {\n \"exchange\": \"kucoin\",\n \"price\": 69207.8,\n \"weight\": 0.2125\n }\n ]\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Trade History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "trade", + "history" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470232)\n\n:::info[Discription]\nRequest via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| sequence | integer | Sequence number |\n| contractId | integer | Deprecated param |\n| tradeId | string | Transaction ID |\n| makerOrderId | string | Maker order ID |\n| takerOrderId | string | Taker order ID |\n| ts | integer | Filled timestamp(nanosecond) |\n| size | integer | Filled amount |\n| price | string | Filled price |\n| side | string | Filled side, The trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book. |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "trade", + "history" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"sequence\": 1697915257909,\n \"contractId\": 1,\n \"tradeId\": \"1697915257909\",\n \"makerOrderId\": \"236679665752801280\",\n \"takerOrderId\": \"236679667975745536\",\n \"ts\": 1729242032152000000,\n \"size\": 1,\n \"price\": \"67878\",\n \"side\": \"sell\"\n },\n {\n \"sequence\": 1697915257749,\n \"contractId\": 1,\n \"tradeId\": \"1697915257749\",\n \"makerOrderId\": \"236679660971245570\",\n \"takerOrderId\": \"236679665400492032\",\n \"ts\": 1729242031535000000,\n \"size\": 1,\n \"price\": \"67867.8\",\n \"side\": \"sell\"\n },\n {\n \"sequence\": 1697915257701,\n \"contractId\": 1,\n \"tradeId\": \"1697915257701\",\n \"makerOrderId\": \"236679660971245570\",\n \"takerOrderId\": \"236679661919211521\",\n \"ts\": 1729242030932000000,\n \"size\": 1,\n \"price\": \"67867.8\",\n \"side\": \"sell\"\n }\n ]\n}" + } + ] + }, + { + "name": "Get Mark Price", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "mark-price", + "{{symbol}}", + "current" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470233)\n\n:::info[Discription]\nGet current mark price\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| granularity | integer | Granularity (milisecond) |\n| timePoint | integer | Time point (milisecond) |\n| value | number | Mark price |\n| indexPrice | number | Index price |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "mark-price", + "{{symbol}}", + "current" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"XBTUSDTM\",\n \"granularity\": 1000,\n \"timePoint\": 1729254307000,\n \"value\": 67687.08,\n \"indexPrice\": 67683.58\n }\n}" + } + ] + }, + { + "name": "Get Klines", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "kline", + "query" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "granularity", + "value": "", + "description": "Type of candlestick patterns(minute)" + }, + { + "key": "from", + "value": "1728552342000", + "description": "Start time (milisecond)" + }, + { + "key": "to", + "value": "1729243542000", + "description": "End time (milisecond)" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470234)\n\n:::info[Description]\nGet the Kline of the symbol. Data are returned in grouped buckets based on requested type.\nFor each query, the system would return at most 500 pieces of data. To obtain more data, please page the data by time.\n:::\n\n:::tip[Tips]\nKlines data may be incomplete. No data is published for intervals where there are no ticks.\n\nIf the specified start/end time and the time granularity exceeds the maximum size allowed for a single request, the system will only return 500 pieces of data for your request. If you want to get fine-grained data in a larger time range, you will need to specify the time ranges and make multiple requests for multiple times.\n\nIf you’ve specified only the start time in your request, the system will return 500 pieces of data from the specified start time to the current time of the system; If only the end time is specified, the system will return 500 pieces of data closest to the end time; If neither the start time nor the end time is specified, the system will return the 500 pieces of data closest to the current time of the system.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "kline", + "query" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "granularity", + "value": "", + "description": "Type of candlestick patterns(minute)" + }, + { + "key": "from", + "value": "1728552342000", + "description": "Start time (milisecond)" + }, + { + "key": "to", + "value": "1729243542000", + "description": "End time (milisecond)" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n [\n 1728576000000,\n 60791.1,\n 61035,\n 58940,\n 60300,\n 5501167\n ],\n [\n 1728604800000,\n 60299.9,\n 60924.1,\n 60077.4,\n 60666.1,\n 1220980\n ],\n [\n 1728633600000,\n 60665.7,\n 62436.8,\n 60650.1,\n 62255.1,\n 3386359\n ]\n ]\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Orders", + "item": [ + { + "name": "Add Order", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470235)\n\n:::info[Description]\nPlace order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n:::\n\n:::tip[Tips]\nThe maximum limit orders for a single contract is 100 per account, and the maximum stop orders for a single contract is 200 per account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| leverage | integer | Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. |\n| type | string | specify if the order is an 'limit' order or 'market' order |\n| remark | string | remark for the order, length cannot exceed 100 utf8 characters |\n| stop | string | Either 'down' or 'up'. If stop is used,parameter stopPrice and stopPriceType also need to be provieded. |\n| stopPriceType | string | Either 'TP', 'IP' or 'MP', Need to be defined if stop is specified. |\n| stopPrice | string | Need to be defined if stop is specified. |\n| reduceOnly | boolean | A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. If set to true, only the orders reducing the position size will be executed. If the reduce-only order size exceeds the position size, the extra size will be canceled. |\n| closeOrder | boolean | A mark to close the position. Set to false by default. If closeOrder is set to true, the system will close the position and the position size will become 0. Side, Size and Leverage fields can be left empty and the system will determine the side and size automatically. |\n| forceHold | boolean | A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. |\n| marginMode | string | Margin mode: ISOLATED, CROSS, default: ISOLATED |\n| price | string | Required for type is 'limit' order, indicating the operating price |\n| size | integer | **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. |\n| timeInForce | string | Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC |\n| postOnly | boolean | Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. |\n| hidden | boolean | Optional for type is 'limit' order, orders not displaying in order book. When hidden chose, not allowed choose postOnly. |\n| iceberg | boolean | Optional for type is 'limit' order, Only visible portion of the order is displayed in the order book. When iceberg chose, not allowed choose postOnly. |\n| visibleSize | string | Optional for type is 'limit' order, The maximum visible size of an iceberg order. please place order in size (lots), The units of qty (base currency) and valueQty (value) are not supported. |\n| qty | string | **Choose one of size, qty, valueQty**, Order size (Base currency) must be an integer multiple of the multiplier. The unit of the quantity of coin-swap is size(lot), which is not supported |\n| valueQty | string | **Choose one of size, qty, valueQty**, Order size (Value), USDS-Swap correspond to USDT or USDC. The unit of the quantity of coin-swap is size(lot), which is not supported |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| clientOid | string | The user self-defined order id. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"side\": \"buy\",\n \"symbol\": \"XBTUSDTM\",\n \"leverage\": 3,\n \"type\": \"limit\",\n \"remark\": \"order remarks\",\n \"reduceOnly\": false,\n \"marginMode\": \"ISOLATED\",\n \"price\": \"0.1\",\n \"size\": 1,\n \"timeInForce\": \"GTC\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"234125150956625920\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\"\n }\n}" + } + ] + }, + { + "name": "Get Trade History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "fills" + ], + "query": [ + { + "key": "orderId", + "value": "236655147005071361", + "description": "List fills for a specific order only (If you specify orderId, other parameters can be ignored)" + }, + { + "key": "symbol", + "value": null, + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "side", + "value": null, + "description": "Order side" + }, + { + "key": "type", + "value": null, + "description": "Order Type" + }, + { + "key": "tradeTypes", + "value": null, + "description": "Transaction type: trade, adl, liquid, settlement. Supports querying multiple types at the same time, separated by commas. Query all type when empty" + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page, The default currentPage is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "pageSize, The default pageSize is 50, The maximum cannot exceed 1000" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470248)\n\n:::info[Description]\nGet a list of recent fills. If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time.\n:::\n\n**Data Time Range**\n\nThe system allows you to retrieve data up to one week (start from the last day by default). If the time period of the queried data exceeds one week (time range from the start time to end time exceeded 24*7 hours), the system will prompt to remind you that you have exceeded the time limit. If you only specified the start time, the system will automatically calculate the end time (end time = start time + 24 hours). On the contrary, if you only specified the end time, the system will calculate the start time (start time= end time - 24 hours) the same way.\n\n**Fee**\n\nOrders on KuCoin Futures platform are classified into two types, taker and maker. A taker order matches other resting orders on the exchange order book, and gets executed immediately after order entry. A maker order, on the contrary, stays on the exchange order book and awaits to be matched. Taker orders will be charged taker fees, while maker orders will receive maker rebates. Please note that market orders, iceberg orders and hidden orders are always charged taker fees.\n\nThe system will pre-freeze a predicted taker fee when you place an order.The liquidity field indicates if the fill was charged taker or maker fees.\n\nThe system will pre-freeze the predicted fees (including the maintenance margin needed for the position, entry fees and fees to close positions) if you added the position, and will not pre-freeze fees if you reduced the position. After the order is executed, if you added positions, the system will deduct entry fees from your balance, if you closed positions, the system will deduct the close fees.\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | |\n| pageSize | integer | |\n| totalNum | integer | |\n| totalPage | integer | |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| tradeId | string | Trade ID
|\n| orderId | string | Order ID
|\n| side | string | Transaction side |\n| liquidity | string | Liquidity- taker or maker |\n| forceTaker | boolean | Whether to force processing as a taker
|\n| price | string | Filled price |\n| size | integer | Filled amount |\n| value | string | Order value |\n| openFeePay | string | Opening transaction fee |\n| closeFeePay | string | Closing transaction fee |\n| stop | string | A mark to the stop order type |\n| feeRate | string | Fee Rate |\n| fixFee | string | Fixed fees(Deprecated field, no actual use of the value field) |\n| feeCurrency | string | Charging currency |\n| tradeTime | integer | trade time in nanosecond |\n| subTradeType | string | Deprecated field, no actual use of the value field |\n| marginMode | string | Margin mode: ISOLATED (isolated), CROSS (cross margin). |\n| settleCurrency | string | Settle Currency |\n| displayType | string | Order Type |\n| fee | string | |\n| orderType | string | Order type |\n| tradeType | string | Trade type (trade, liquid, adl or settlement)
|\n| createdAt | integer | Time the order created
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "fills" + ], + "query": [ + { + "key": "orderId", + "value": "236655147005071361", + "description": "List fills for a specific order only (If you specify orderId, other parameters can be ignored)" + }, + { + "key": "symbol", + "value": null, + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "side", + "value": null, + "description": "Order side" + }, + { + "key": "type", + "value": null, + "description": "Order Type" + }, + { + "key": "tradeTypes", + "value": null, + "description": "Transaction type: trade, adl, liquid, settlement. Supports querying multiple types at the same time, separated by commas. Query all type when empty" + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page, The default currentPage is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "pageSize, The default pageSize is 50, The maximum cannot exceed 1000" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 2,\n \"totalPage\": 1,\n \"items\": [\n {\n \"symbol\": \"XBTUSDTM\",\n \"tradeId\": \"1784277229880\",\n \"orderId\": \"236317213710184449\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"forceTaker\": false,\n \"price\": \"67430.9\",\n \"size\": 1,\n \"value\": \"67.4309\",\n \"openFeePay\": \"0.04045854\",\n \"closeFeePay\": \"0\",\n \"stop\": \"\",\n \"feeRate\": \"0.00060\",\n \"fixFee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"settleCurrency\": \"USDT\",\n \"fee\": \"0.04045854\",\n \"orderType\": \"market\",\n \"displayType\": \"market\",\n \"tradeType\": \"trade\",\n \"subTradeType\": null,\n \"tradeTime\": 1729155616320000000,\n \"createdAt\": 1729155616493\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"tradeId\": \"1784277132002\",\n \"orderId\": \"236317094436728832\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"forceTaker\": false,\n \"price\": \"67445\",\n \"size\": 1,\n \"value\": \"67.445\",\n \"openFeePay\": \"0\",\n \"closeFeePay\": \"0.040467\",\n \"stop\": \"\",\n \"feeRate\": \"0.00060\",\n \"fixFee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"settleCurrency\": \"USDT\",\n \"fee\": \"0.040467\",\n \"orderType\": \"market\",\n \"displayType\": \"market\",\n \"tradeType\": \"trade\",\n \"subTradeType\": null,\n \"tradeTime\": 1729155587944000000,\n \"createdAt\": 1729155588104\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Batch Add Orders", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "multi" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470236)\n\n:::info[Description]\nPlace multiple order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\nYou can place up to 20 orders at one time, including limit orders, market orders, and stop orders\n\nPlease be noted that the system would hold the fees from the orders entered the orderbook in advance.\n\nDo NOT include extra spaces in JSON strings.\n\nPlace Order Limit\nThe maximum limit orders for a single contract is 100 per account, and the maximum stop orders for a single contract is 50 per account.\n:::\n\n:::tip[Tips]\n- The maximum limit orders for a single contract is 100 per account, and the maximum stop orders for a single contract is 50 per account.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) |\n| leverage | integer | Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. |\n| type | string | specify if the order is an 'limit' order or 'market' order |\n| remark | string | remark for the order, length cannot exceed 100 utf8 characters |\n| stop | string | Either 'down' or 'up'. If stop is used,parameter stopPrice and stopPriceType also need to be provieded. |\n| stopPriceType | string | Either 'TP', 'IP' or 'MP', Need to be defined if stop is specified. |\n| stopPrice | string | Need to be defined if stop is specified. |\n| reduceOnly | boolean | A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. If set to true, only the orders reducing the position size will be executed. If the reduce-only order size exceeds the position size, the extra size will be canceled. |\n| closeOrder | boolean | A mark to close the position. Set to false by default. If closeOrder is set to true, the system will close the position and the position size will become 0. Side, Size and Leverage fields can be left empty and the system will determine the side and size automatically. |\n| forceHold | boolean | A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. |\n| marginMode | string | Margin mode: ISOLATED, CROSS, default: ISOLATED |\n| price | string | Required for type is 'limit' order, indicating the operating price |\n| size | integer | **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. |\n| timeInForce | string | Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC |\n| postOnly | boolean | Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. |\n| hidden | boolean | Optional for type is 'limit' order, orders not displaying in order book. When hidden chose, not allowed choose postOnly. |\n| iceberg | boolean | Optional for type is 'limit' order, Only visible portion of the order is displayed in the order book. When iceberg chose, not allowed choose postOnly. |\n| visibleSize | string | Optional for type is 'limit' order, The maximum visible size of an iceberg order. please place order in size (lots), The units of qty (base currency) and valueQty (value) are not supported. |\n| qty | string | **Choose one of size, qty, valueQty**, Order size (Base currency) must be an integer multiple of the multiplier. The unit of the quantity of coin-swap is size(lot), which is not supported |\n| valueQty | string | **Choose one of size, qty, valueQty**, Order size (Value), USDS-Swap correspond to USDT or USDC. The unit of the quantity of coin-swap is size(lot), which is not supported |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| clientOid | string | Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| code | string | |\n| msg | string | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "[\n {\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"side\": \"buy\",\n \"symbol\": \"XBTUSDTM\",\n \"leverage\": 3,\n \"type\": \"limit\",\n \"remark\": \"order remarks\",\n \"reduceOnly\": false,\n \"marginMode\": \"ISOLATED\",\n \"price\": \"0.1\",\n \"size\": 1,\n \"timeInForce\": \"GTC\"\n },\n {\n \"clientOid\": \"5c52e11203aa677f33e493fc\",\n \"side\": \"buy\",\n \"symbol\": \"XBTUSDTM\",\n \"leverage\": 3,\n \"type\": \"limit\",\n \"remark\": \"order remarks\",\n \"reduceOnly\": false,\n \"marginMode\": \"ISOLATED\",\n \"price\": \"0.1\",\n \"size\": 1,\n \"timeInForce\": \"GTC\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "multi" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"orderId\": \"235919387779985408\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"symbol\": \"XBTUSDTM\",\n \"code\": \"200000\",\n \"msg\": \"success\"\n },\n {\n \"orderId\": \"235919387855482880\",\n \"clientOid\": \"5c52e11203aa677f33e493fc\",\n \"symbol\": \"XBTUSDTM\",\n \"code\": \"200000\",\n \"msg\": \"success\"\n }\n ]\n}" + } + ] + }, + { + "name": "Get Recent Trade History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "recentFills" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470249)\n\n:::info[Description]\nGet a list of recent 1000 fills in the last 24 hours. If you need to get your recent traded order history with low latency, you may query this endpoint.\n\nIf you need to get your recent traded order history with low latency, you may query this endpoint.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| tradeId | string | Trade ID
|\n| orderId | string | Order ID
|\n| side | string | Transaction side
|\n| liquidity | string | Liquidity- taker or maker
|\n| forceTaker | boolean | Whether to force processing as a taker
|\n| price | string | Filled price
|\n| size | integer | Filled amount
|\n| value | string | Order value
|\n| openFeePay | string | Opening transaction fee
|\n| closeFeePay | string | Closing transaction fee
|\n| stop | string | A mark to the stop order type
|\n| feeRate | string | Fee Rate |\n| fixFee | string | Fixed fees(Deprecated field, no actual use of the value field)
|\n| feeCurrency | string | Charging currency
|\n| tradeTime | integer | trade time in nanosecond
|\n| subTradeType | string | Deprecated field, no actual use of the value field |\n| marginMode | string | Margin mode: ISOLATED (isolated), CROSS (cross margin).
|\n| displayType | string | Order Type |\n| fee | string | Transaction fee
|\n| settleCurrency | string | Settle Currency |\n| orderType | string | Order type
|\n| tradeType | string | Trade type (trade, liquid, cancel, adl or settlement)
|\n| createdAt | integer | Time the order created
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "recentFills" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"XBTUSDTM\",\n \"tradeId\": \"1784277229880\",\n \"orderId\": \"236317213710184449\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"forceTaker\": false,\n \"price\": \"67430.9\",\n \"size\": 1,\n \"value\": \"67.4309\",\n \"openFeePay\": \"0.04045854\",\n \"closeFeePay\": \"0\",\n \"stop\": \"\",\n \"feeRate\": \"0.00060\",\n \"fixFee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"fee\": \"0.04045854\",\n \"settleCurrency\": \"USDT\",\n \"orderType\": \"market\",\n \"displayType\": \"market\",\n \"tradeType\": \"trade\",\n \"subTradeType\": null,\n \"tradeTime\": 1729155616320000000,\n \"createdAt\": 1729155616493\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"tradeId\": \"1784277132002\",\n \"orderId\": \"236317094436728832\",\n \"side\": \"buy\",\n \"liquidity\": \"taker\",\n \"forceTaker\": false,\n \"price\": \"67445\",\n \"size\": 1,\n \"value\": \"67.445\",\n \"openFeePay\": \"0\",\n \"closeFeePay\": \"0.040467\",\n \"stop\": \"\",\n \"feeRate\": \"0.00060\",\n \"fixFee\": \"0\",\n \"feeCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"fee\": \"0.040467\",\n \"settleCurrency\": \"USDT\",\n \"orderType\": \"market\",\n \"displayType\": \"market\",\n \"tradeType\": \"trade\",\n \"subTradeType\": null,\n \"tradeTime\": 1729155587944000000,\n \"createdAt\": 1729155588104\n }\n ]\n}" + } + ] + }, + { + "name": "Add Take Profit And Stop Loss Order", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "st-orders" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470237)\n\n:::info[Description]\nPlace take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order interface.\n\nYou can place two types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified.\n\nPlease be noted that the system would hold the fees from the orders entered the orderbook in advance. \n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| leverage | integer | Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. |\n| type | string | specify if the order is an 'limit' order or 'market' order |\n| remark | string | remark for the order, length cannot exceed 100 utf8 characters |\n| stopPriceType | string | Either 'TP', 'IP' or 'MP' |\n| reduceOnly | boolean | A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. If set to true, only the orders reducing the position size will be executed. If the reduce-only order size exceeds the position size, the extra size will be canceled. |\n| closeOrder | boolean | A mark to close the position. Set to false by default. If closeOrder is set to true, the system will close the position and the position size will become 0. Side, Size and Leverage fields can be left empty and the system will determine the side and size automatically. |\n| forceHold | boolean | A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. |\n| marginMode | string | Margin mode: ISOLATED, CROSS, default: ISOLATED |\n| price | string | Required for type is 'limit' order, indicating the operating price |\n| size | integer | **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. |\n| timeInForce | string | Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC |\n| postOnly | boolean | Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. |\n| hidden | boolean | Optional for type is 'limit' order, orders not displaying in order book. When hidden chose, not allowed choose postOnly. |\n| iceberg | boolean | Optional for type is 'limit' order, Only visible portion of the order is displayed in the order book. When iceberg chose, not allowed choose postOnly. |\n| visibleSize | string | Optional for type is 'limit' order, The maximum visible size of an iceberg order. please place order in size (lots), The units of qty (base currency) and valueQty (value) are not supported. |\n| triggerStopUpPrice | string | Take profit price |\n| triggerStopDownPrice | string | Stop loss price |\n| qty | string | **Choose one of size, qty, valueQty**, Order size (Base currency) must be an integer multiple of the multiplier. The unit of the quantity of coin-swap is size(lot), which is not supported |\n| valueQty | string | **Choose one of size, qty, valueQty**, Order size (Value), USDS-Swap correspond to USDT or USDC. The unit of the quantity of coin-swap is size(lot), which is not supported |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| clientOid | string | The user self-defined order id. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"side\": \"buy\",\n \"symbol\": \"XBTUSDTM\",\n \"leverage\": 3,\n \"type\": \"limit\",\n \"remark\": \"order remarks\",\n \"reduceOnly\": false,\n \"marginMode\": \"ISOLATED\",\n \"price\": \"0.2\",\n \"size\": 1,\n \"timeInForce\": \"GTC\",\n \"triggerStopUpPrice\": \"0.3\",\n \"triggerStopDownPrice\": \"0.1\",\n \"stopPriceType\": \"TP\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "st-orders" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"234125150956625920\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\"\n }\n}" + } + ] + }, + { + "name": "Get Open Order Value", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "openOrderStatistics" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470250)\n\n:::info[Description]\nYou can query this endpoint to get the the total number and value of the all your active orders.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| openOrderBuySize | integer | Total number of the unexecuted buy orders
|\n| openOrderSellSize | integer | Total number of the unexecuted sell orders
|\n| openOrderBuyCost | string | Value of all the unexecuted buy orders
|\n| openOrderSellCost | string | Value of all the unexecuted sell orders
|\n| settleCurrency | string | settlement currency
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "openOrderStatistics" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"openOrderBuySize\": 1,\n \"openOrderSellSize\": 0,\n \"openOrderBuyCost\": \"0.0001\",\n \"openOrderSellCost\": \"0\",\n \"settleCurrency\": \"USDT\"\n }\n}" + } + ] + }, + { + "name": "Add Order Test", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "test" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470238)\n\n:::info[Description]\nOrder test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) |\n| side | string | specify if the order is to 'buy' or 'sell' |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| leverage | integer | Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. |\n| type | string | specify if the order is an 'limit' order or 'market' order |\n| remark | string | remark for the order, length cannot exceed 100 utf8 characters |\n| stop | string | Either 'down' or 'up'. If stop is used,parameter stopPrice and stopPriceType also need to be provieded. |\n| stopPriceType | string | Either 'TP', 'IP' or 'MP', Need to be defined if stop is specified. |\n| stopPrice | string | Need to be defined if stop is specified. |\n| reduceOnly | boolean | A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. If set to true, only the orders reducing the position size will be executed. If the reduce-only order size exceeds the position size, the extra size will be canceled. |\n| closeOrder | boolean | A mark to close the position. Set to false by default. If closeOrder is set to true, the system will close the position and the position size will become 0. Side, Size and Leverage fields can be left empty and the system will determine the side and size automatically. |\n| forceHold | boolean | A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. |\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. |\n| marginMode | string | Margin mode: ISOLATED, CROSS, default: ISOLATED |\n| price | string | Required for type is 'limit' order, indicating the operating price |\n| size | integer | **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. |\n| timeInForce | string | Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC |\n| postOnly | boolean | Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. |\n| hidden | boolean | Optional for type is 'limit' order, orders not displaying in order book. When hidden chose, not allowed choose postOnly. |\n| iceberg | boolean | Optional for type is 'limit' order, Only visible portion of the order is displayed in the order book. When iceberg chose, not allowed choose postOnly. |\n| visibleSize | string | Optional for type is 'limit' order, The maximum visible size of an iceberg order. please place order in size (lots), The units of qty (base currency) and valueQty (value) are not supported. |\n| qty | string | **Choose one of size, qty, valueQty**, Order size (Base currency) must be an integer multiple of the multiplier. The unit of the quantity of coin-swap is size(lot), which is not supported |\n| valueQty | string | **Choose one of size, qty, valueQty**, Order size (Value), USDS-Swap correspond to USDT or USDC. The unit of the quantity of coin-swap is size(lot), which is not supported |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. |\n| clientOid | string | The user self-defined order id. |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"side\": \"buy\",\n \"symbol\": \"XBTUSDTM\",\n \"leverage\": 3,\n \"type\": \"limit\",\n \"remark\": \"order remarks\",\n \"reduceOnly\": false,\n \"marginMode\": \"ISOLATED\",\n \"price\": \"0.1\",\n \"size\": 1,\n \"timeInForce\": \"GTC\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "test" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"234125150956625920\",\n \"clientOid\": \"5c52e11203aa677f33e493fb\"\n }\n}" + } + ] + }, + { + "name": "Cancel Order By OrderId", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "{{orderId}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470239)\n\n:::info[Description]\nCancel an order (including a stop order).\n\nYou will receive success message once the system has received the cancellation request. The cancellation request will be processed by matching engine in sequence. To know if the request has been processed, you may check the order status or update message from the websocket pushes.\n\nThe `orderId` is the server-assigned order id, not the specified clientOid.\n\nIf the order can not be canceled (already filled or previously canceled, etc), then an error response will indicate the reason in the message field.\n:::\n\n**API KEY PERMISSIONS**\nThis endpoint requires the Futures Trading permission.\n\n**REQUEST URL**\nThis endpoint support Futures URL\n\n**REQUEST RATE LIMIT**\nFutures weight：1\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "{{orderId}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"235303670076489728\"\n ]\n }\n}" + } + ] + }, + { + "name": "Cancel Order By ClientOid", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470240)\n\n:::info[Description]\nCancel an order (including a stop order).\n\nYou will receive success message once the system has received the cancellation request. The cancellation request will be processed by matching engine in sequence. To know if the request has been processed, you may check the order status or update message from the pushes.\n\nResponse the ID created by the client (clientOid).\n\nIf the order can not be canceled (already filled or previously canceled, etc), then an error response will indicate the reason in the message field.\n:::\n\n**API KEY PERMISSIONS**\nThis endpoint requires the Futures Trading permission.\n\n**REQUEST URL**\nThis endpoint support Futures URL\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| clientOid | string | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "client-order", + "{{clientOid}}" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"clientOid\": \"017485b0-2957-4681-8a14-5d46b35aee0d\"\n }\n}" + } + ] + }, + { + "name": "Batch Cancel Orders", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "multi-cancel" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470241)\n\n:::info[Description]\nUsing this endpoint, orders can be canceled in batches, If there are both normal orders and conditional orders with the same clientOid (it is not recommended to use the same clientOrderId), when cancelling orders in batches by clientOid, normal orders will be canceled and conditional orders will be retained.\n\nSupports batch cancellation of orders by orderId or clientOid. When orderIdsList and clientOidsList are used at the same time, orderIdsList shall prevail. A maximum of 10 orders can be canceled at a time.\n\nWhen using orderId to cancel order, the response will return the orderId.\nWhen using clientOid to cancel order, the response will return the clientOid.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderIdsList | array | Refer to the schema section of orderIdsList |\n| clientOidsList | array | Refer to the schema section of clientOidsList |\n\n**root.clientOidsList Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| clientOid | string | |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | |\n| clientOid | string | |\n| code | string | |\n| msg | string | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"orderIdsList\":\n [\n \"250445104152670209\",\n \"250445181751463936\"\n ]\n}\n\n\n//{\n// \"clientOidsList\":\n// [\n// {\n// \"symbol\": \"XRPUSDTM\",\n// \"clientOid\": \"5c52e11203aa1677f133e493fb\"\n// },\n// {\n// \"symbol\": \"ETHUSDTM\",\n// \"clientOid\": \"5c52214e112\"\n// }\n// ]\n//}\n", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "multi-cancel" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"orderId\": \"250445104152670209\",\n \"clientOid\": null,\n \"code\": \"200\",\n \"msg\": \"success\"\n },\n {\n \"orderId\": \"250445181751463936\",\n \"clientOid\": null,\n \"code\": \"200\",\n \"msg\": \"success\"\n }\n ]\n}\n\n//{\n// \"code\": \"200000\",\n// \"data\": [\n// {\n// \"orderId\": null,\n// \"clientOid\": \"5c52e11203aa1677f133e493fb\",\n// \"code\": \"200\",\n// \"msg\": \"success\"\n// },\n// {\n// \"orderId\": null,\n// \"clientOid\": \"5c52214e112\",\n// \"code\": \"200\",\n// \"msg\": \"success\"\n// }\n// ]\n//}" + } + ] + }, + { + "name": "Cancel All Orders", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v3", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470242)\n\n:::info[Description]\nUsing this endpoint, all open orders (excluding stop orders) can be canceled in batches.\n\nThe response is a list of orderIDs of the canceled orders.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v3", + "orders" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"235919172150824960\",\n \"235919172150824961\"\n ]\n }\n}" + } + ] + }, + { + "name": "Cancel All Stop orders", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "stopOrders" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470243)\n\n:::info[Description]\nUsing this endpoint, all untriggered stop orders can be canceled in batches.\n\nSupports batch cancellation of untriggered stop orders by symbol. Cancel all all untriggered stop orders for a specific contract symbol only , If not specified, all the all untriggered stop orders will be canceled.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| cancelledOrderIds | array | Refer to the schema section of cancelledOrderIds |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "stopOrders" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"cancelledOrderIds\": [\n \"235919172150824960\",\n \"235919172150824961\"\n ]\n }\n}" + } + ] + }, + { + "name": "Get Order List", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [ + { + "key": "status", + "value": "done", + "description": "active or done, done as default. Only list orders for a specific status" + }, + { + "key": "symbol", + "value": null, + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "side", + "value": null, + "description": "buy or sell" + }, + { + "key": "type", + "value": null, + "description": "limit, market, limit_stop or market_stop" + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page, The default currentPage is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "pageSize, The default pageSize is 50, The maximum cannot exceed 1000" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470244)\n\n:::info[Description]\nList your current orders.\n\nAny limit order on the exchange order book is in active status. Orders removed from the order book will be marked with done status. After an order becomes done, there may be a few milliseconds latency before it’s fully settled.\n\nYou can check the orders in any status. If the status parameter is not specified, orders of done status will be returned by default.\n\nWhen you query orders in active status, there is no time limit. However, when you query orders in done status, the start and end time range cannot exceed 24 * 7 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.\n\n**POLLING**\nFor high-volume trading, it is highly recommended that you maintain your own list of open orders and use one of the streaming market data feeds to keep it updated. You should poll the open orders endpoint to obtain the current state of any open order.\n\nIf you need to get your recent trade history with low latency, you may query the endpoint Get List of Orders Completed in 24h.\n:::\n\n**API KEY PERMISSIONS**\nThis endpoint requires the General permission.\n\n**REQUEST URL**\nThis endpoint support Futures URL\n\n**REQUEST RATE LIMIT**\nFutures weight：2\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | Current request page, The default currentPage is 1 |\n| pageSize | integer | pageSize, The default pageSize is 50, The maximum cannot exceed 1000 |\n| totalNum | integer | |\n| totalPage | integer | |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Order ID |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| type | string | Order type, market order or limit order
|\n| side | string | Transaction side |\n| price | string | Order price |\n| size | integer | Order quantity |\n| value | string | Order value |\n| dealValue | string | Executed size of funds
|\n| dealSize | integer | Executed quantity |\n| stp | string | self trade prevention |\n| stop | string | Stop order type (stop limit or stop market) |\n| stopPriceType | string | Trigger price type of stop orders |\n| stopTriggered | boolean | Mark to show whether the stop order is triggered |\n| stopPrice | integer | Trigger price of stop orders |\n| timeInForce | string | Time in force policy type |\n| postOnly | boolean | Mark of post only |\n| hidden | boolean | Mark of the hidden order |\n| iceberg | boolean | Mark of the iceberg order |\n| leverage | string | Leverage of the order |\n| forceHold | boolean | A mark to forcely hold the funds for an order |\n| closeOrder | boolean | A mark to close the position |\n| visibleSize | integer | Visible size of the iceberg order |\n| clientOid | string | Unique order id created by users to identify their orders |\n| remark | string | Remark of the order |\n| tags | string | tag order source |\n| isActive | boolean | Mark of the active orders |\n| cancelExist | boolean | Mark of the canceled orders |\n| createdAt | integer | Time the order created |\n| updatedAt | integer | last update time |\n| endAt | integer | End time |\n| orderTime | integer | Order create time in nanosecond |\n| settleCurrency | string | settlement currency |\n| marginMode | string | Margin mode: ISOLATED (isolated), CROSS (cross margin). |\n| avgDealPrice | string | Average transaction price, forward contract average transaction price = sum (transaction value) / sum (transaction quantity), reverse contract average transaction price = sum (transaction quantity) / sum (transaction value). Transaction quantity = lots * multiplier |\n| status | string | order status: “open” or “done” |\n| filledSize | integer | Value of the executed orders |\n| filledValue | string | Executed order quantity |\n| reduceOnly | boolean | A mark to reduce the position size only |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders" + ], + "query": [ + { + "key": "status", + "value": "done", + "description": "active or done, done as default. Only list orders for a specific status" + }, + { + "key": "symbol", + "value": null, + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "side", + "value": null, + "description": "buy or sell" + }, + { + "key": "type", + "value": null, + "description": "limit, market, limit_stop or market_stop" + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page, The default currentPage is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "pageSize, The default pageSize is 50, The maximum cannot exceed 1000" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"id\": \"230181737576050688\",\n \"symbol\": \"PEOPLEUSDTM\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.05\",\n \"size\": 10,\n \"value\": \"5\",\n \"dealValue\": \"0\",\n \"dealSize\": 0,\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopPriceType\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"leverage\": \"1\",\n \"forceHold\": false,\n \"closeOrder\": false,\n \"visibleSize\": 0,\n \"clientOid\": \"5a80bd847f1811ef8a7faa665a37b3d7\",\n \"remark\": null,\n \"tags\": \"\",\n \"isActive\": true,\n \"cancelExist\": false,\n \"createdAt\": 1727692804813,\n \"updatedAt\": 1727692804813,\n \"endAt\": null,\n \"orderTime\": 1727692804808418000,\n \"settleCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"avgDealPrice\": \"0\",\n \"filledSize\": 0,\n \"filledValue\": \"0\",\n \"status\": \"open\",\n \"reduceOnly\": false\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Order By OrderId", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "{{order-id}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470245)\n\n:::info[Description]\nGet a single order by order id (including a stop order).\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Order ID |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| type | string | Order type, market order or limit order |\n| side | string | Transaction side |\n| price | string | Order price |\n| size | integer | Order quantity |\n| value | string | Order value
|\n| dealValue | string | Executed size of funds
|\n| dealSize | integer | Executed quantity
|\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. |\n| stop | string | Stop order type (stop limit or stop market)
|\n| stopPriceType | string | Trigger price type of stop orders |\n| stopTriggered | boolean | Mark to show whether the stop order is triggered |\n| stopPrice | number | Trigger price of stop orders |\n| timeInForce | string | Time in force policy type
|\n| postOnly | boolean | Mark of post only
|\n| hidden | boolean | Mark of the hidden order
|\n| iceberg | boolean | Mark of the iceberg order
|\n| leverage | string | Leverage of the order
|\n| forceHold | boolean | A mark to forcely hold the funds for an order
|\n| closeOrder | boolean | A mark to close the position
|\n| visibleSize | integer | Visible size of the iceberg order
|\n| clientOid | string | Unique order id created by users to identify their orders
|\n| remark | string | Remark |\n| tags | string | tag order source
|\n| isActive | boolean | Mark of the active orders
|\n| cancelExist | boolean | Mark of the canceled orders
|\n| createdAt | integer | Time the order created
|\n| updatedAt | integer | last update time
|\n| endAt | integer | Order Endtime |\n| orderTime | integer | Order create time in nanosecond
|\n| settleCurrency | string | settlement currency
|\n| marginMode | string | Margin mode: ISOLATED (isolated), CROSS (cross margin).
|\n| avgDealPrice | string | Average transaction price, forward contract average transaction price = sum (transaction value) / sum (transaction quantity), reverse contract average transaction price = sum (transaction quantity) / sum (transaction value). Transaction quantity = lots * multiplier
|\n| filledSize | integer | Value of the executed orders
|\n| filledValue | string | Executed order quantity
|\n| status | string | order status: “open” or “done”
|\n| reduceOnly | boolean | A mark to reduce the position size only
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "{{order-id}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"236655147005071361\",\n \"symbol\": \"XBTUSDTM\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.1\",\n \"size\": 1,\n \"value\": \"0.0001\",\n \"dealValue\": \"0\",\n \"dealSize\": 0,\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopPriceType\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"leverage\": \"3\",\n \"forceHold\": false,\n \"closeOrder\": false,\n \"visibleSize\": 0,\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": null,\n \"tags\": \"\",\n \"isActive\": true,\n \"cancelExist\": false,\n \"createdAt\": 1729236185949,\n \"updatedAt\": 1729236185949,\n \"endAt\": null,\n \"orderTime\": 1729236185885647952,\n \"settleCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"avgDealPrice\": \"0\",\n \"filledSize\": 0,\n \"filledValue\": \"0\",\n \"status\": \"open\",\n \"reduceOnly\": false\n }\n}" + } + ] + }, + { + "name": "Get Order By ClientOid", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "byClientOid" + ], + "query": [ + { + "key": "clientOid", + "value": "5c52e11203aa677f33e493fb", + "description": "The user self-defined order id." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470352)\n\n:::info[Description]\nGet a single order by client order id (including a stop order).\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Order ID |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| type | string | Order type, market order or limit order |\n| side | string | Transaction side |\n| price | string | Order price |\n| size | integer | Order quantity |\n| value | string | Order value
|\n| dealValue | string | Executed size of funds
|\n| dealSize | integer | Executed quantity
|\n| stp | string | [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. |\n| stop | string | Stop order type (stop limit or stop market)
|\n| stopPriceType | string | Trigger price type of stop orders |\n| stopTriggered | boolean | Mark to show whether the stop order is triggered |\n| stopPrice | number | Trigger price of stop orders |\n| timeInForce | string | Time in force policy type
|\n| postOnly | boolean | Mark of post only
|\n| hidden | boolean | Mark of the hidden order
|\n| iceberg | boolean | Mark of the iceberg order
|\n| leverage | string | Leverage of the order
|\n| forceHold | boolean | A mark to forcely hold the funds for an order
|\n| closeOrder | boolean | A mark to close the position
|\n| visibleSize | integer | Visible size of the iceberg order
|\n| clientOid | string | Unique order id created by users to identify their orders
|\n| remark | string | Remark |\n| tags | string | tag order source
|\n| isActive | boolean | Mark of the active orders
|\n| cancelExist | boolean | Mark of the canceled orders
|\n| createdAt | integer | Time the order created
|\n| updatedAt | integer | last update time
|\n| endAt | integer | Order Endtime |\n| orderTime | integer | Order create time in nanosecond
|\n| settleCurrency | string | settlement currency
|\n| marginMode | string | Margin mode: ISOLATED (isolated), CROSS (cross margin).
|\n| avgDealPrice | string | Average transaction price, forward contract average transaction price = sum (transaction value) / sum (transaction quantity), reverse contract average transaction price = sum (transaction quantity) / sum (transaction value). Transaction quantity = lots * multiplier
|\n| filledSize | integer | Value of the executed orders
|\n| filledValue | string | Executed order quantity
|\n| status | string | order status: “open” or “done”
|\n| reduceOnly | boolean | A mark to reduce the position size only
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "orders", + "byClientOid" + ], + "query": [ + { + "key": "clientOid", + "value": "5c52e11203aa677f33e493fb", + "description": "The user self-defined order id." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"250444645610336256\",\n \"symbol\": \"XRPUSDTM\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.1\",\n \"size\": 1,\n \"value\": \"1\",\n \"dealValue\": \"0\",\n \"dealSize\": 0,\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopPriceType\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"leverage\": \"3\",\n \"forceHold\": false,\n \"closeOrder\": false,\n \"visibleSize\": 0,\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": null,\n \"tags\": \"\",\n \"isActive\": true,\n \"cancelExist\": false,\n \"createdAt\": 1732523858568,\n \"updatedAt\": 1732523858568,\n \"endAt\": null,\n \"orderTime\": 1732523858550892322,\n \"settleCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"avgDealPrice\": \"0\",\n \"filledSize\": 0,\n \"filledValue\": \"0\",\n \"status\": \"open\",\n \"reduceOnly\": false\n }\n}" + } + ] + }, + { + "name": "Get Recent Closed Orders", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "recentDoneOrders" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470246)\n\n:::info[Description]\nGet a list of recent 1000 closed orders in the last 24 hours.\n\nIf you need to get your recent traded order history with low latency, you may query this endpoint.\n\n\nAny limit order on the exchange order book is in active status. Orders removed from the order book will be marked with done status. After an order becomes done, there may be a few milliseconds latency before it’s fully settled.\n\nYou can check the orders in any status. If the status parameter is not specified, orders of done status will be returned by default.\n\nWhen you query orders in active status, there is no time limit. However, when you query orders in done status, the start and end time range cannot exceed 24*7 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.\n\n**POLLING**\nFor high-volume trading, it is highly recommended that you maintain your own list of open orders and use one of the streaming market data feeds to keep it updated. You should poll the open orders endpoint to obtain the current state of any open order.\n\nIf you need to get your recent trade history with low latency, you may query the endpoint Get List of Orders Completed in 24h.\n:::\n\n**API KEY PERMISSIONS**\nThis endpoint requires the General permission.\n\n**REQUEST URL**\nThis endpoint support Futures URL\n\n**REQUEST RATE LIMIT**\nFutures weight：2\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Order ID |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| type | string | Order type, market order or limit order |\n| side | string | Transaction side |\n| price | string | Order price |\n| size | integer | Order quantity |\n| value | string | Order value
|\n| dealValue | string | Executed size of funds
|\n| dealSize | integer | Executed quantity
|\n| stp | string | self trade prevention |\n| stop | string | Stop order type (stop limit or stop market)
|\n| stopPriceType | string | Trigger price type of stop orders
|\n| stopTriggered | boolean | Mark to show whether the stop order is triggered |\n| stopPrice | integer | Trigger price of stop orders
|\n| timeInForce | string | Time in force policy type
|\n| postOnly | boolean | Mark of post only
|\n| hidden | boolean | Mark of the hidden order
|\n| iceberg | boolean | Mark of the iceberg order
|\n| leverage | string | Leverage of the order
|\n| forceHold | boolean | A mark to forcely hold the funds for an order
|\n| closeOrder | boolean | A mark to close the position
|\n| visibleSize | integer | Visible size of the iceberg order
|\n| clientOid | string | Unique order id created by users to identify their orders
|\n| remark | string | Remark of the order
|\n| tags | string | tag order source
|\n| isActive | boolean | Mark of the active orders
|\n| cancelExist | boolean | Mark of the canceled orders
|\n| createdAt | integer | Time the order created
|\n| updatedAt | integer | last update time
|\n| endAt | integer | End time
|\n| orderTime | integer | Order create time in nanosecond
|\n| settleCurrency | string | settlement currency
|\n| marginMode | string | Margin mode: ISOLATED (isolated), CROSS (cross margin).
|\n| avgDealPrice | string | Average transaction price, forward contract average transaction price = sum (transaction value) / sum (transaction quantity), reverse contract average transaction price = sum (transaction quantity) / sum (transaction value). Transaction quantity = lots * multiplier
|\n| filledSize | integer | Value of the executed orders
|\n| filledValue | string | Executed order quantity
|\n| status | string | order status: “open” or “done”
|\n| reduceOnly | boolean | A mark to reduce the position size only
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "recentDoneOrders" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"236387137732231168\",\n \"symbol\": \"XRPUSDTM\",\n \"type\": \"market\",\n \"side\": \"buy\",\n \"price\": \"0\",\n \"size\": 1,\n \"value\": \"5.51\",\n \"dealValue\": \"5.511\",\n \"dealSize\": 1,\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopPriceType\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"leverage\": \"10.0\",\n \"forceHold\": false,\n \"closeOrder\": false,\n \"visibleSize\": 0,\n \"clientOid\": \"16698fe6-2746-4aeb-a7fa-61f633ab6090\",\n \"remark\": null,\n \"tags\": \"\",\n \"isActive\": false,\n \"cancelExist\": false,\n \"createdAt\": 1729172287496,\n \"updatedAt\": 1729172287568,\n \"endAt\": 1729172287568,\n \"orderTime\": 1729172287496950800,\n \"settleCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"avgDealPrice\": \"0.5511\",\n \"filledSize\": 1,\n \"filledValue\": \"5.511\",\n \"status\": \"done\",\n \"reduceOnly\": false\n },\n {\n \"id\": \"236317213710184449\",\n \"symbol\": \"XBTUSDTM\",\n \"type\": \"market\",\n \"side\": \"buy\",\n \"price\": \"0\",\n \"size\": 1,\n \"value\": \"67.4309\",\n \"dealValue\": \"67.4309\",\n \"dealSize\": 1,\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopPriceType\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"leverage\": \"3\",\n \"forceHold\": false,\n \"closeOrder\": false,\n \"visibleSize\": 0,\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": null,\n \"tags\": \"\",\n \"isActive\": false,\n \"cancelExist\": false,\n \"createdAt\": 1729155616310,\n \"updatedAt\": 1729155616324,\n \"endAt\": 1729155616324,\n \"orderTime\": 1729155616310180400,\n \"settleCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"avgDealPrice\": \"67430.9\",\n \"filledSize\": 1,\n \"filledValue\": \"67.4309\",\n \"status\": \"done\",\n \"reduceOnly\": false\n },\n {\n \"id\": \"236317094436728832\",\n \"symbol\": \"XBTUSDTM\",\n \"type\": \"market\",\n \"side\": \"buy\",\n \"price\": \"0\",\n \"size\": 1,\n \"value\": \"67.445\",\n \"dealValue\": \"67.445\",\n \"dealSize\": 1,\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopPriceType\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"leverage\": \"3\",\n \"forceHold\": false,\n \"closeOrder\": false,\n \"visibleSize\": 0,\n \"clientOid\": \"5c52e11203aa677f33e493fb\",\n \"remark\": null,\n \"tags\": \"\",\n \"isActive\": false,\n \"cancelExist\": false,\n \"createdAt\": 1729155587873,\n \"updatedAt\": 1729155587946,\n \"endAt\": 1729155587946,\n \"orderTime\": 1729155587873332000,\n \"settleCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"avgDealPrice\": \"67445.0\",\n \"filledSize\": 1,\n \"filledValue\": \"67.445\",\n \"status\": \"done\",\n \"reduceOnly\": false\n }\n ]\n}" + } + ] + }, + { + "name": "Get Stop Order List", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "stopOrders" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "side", + "value": null, + "description": "buy or sell" + }, + { + "key": "type", + "value": null, + "description": "limit, market" + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page, The default currentPage is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "pageSize, The default pageSize is 50, The maximum cannot exceed 1000" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470247)\n\n:::info[Description]\nGet the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order interface\n:::\n\nAny limit order on the exchange order book is in active status. Orders removed from the order book will be marked with done status. After an order becomes done, there may be a few milliseconds latency before it’s fully settled.\n\nYou can check the orders in any status. If the status parameter is not specified, orders of done status will be returned by default.\n\nWhen you query orders in active status, there is no time limit. However, when you query orders in done status, the start and end time range cannot exceed 24*7 hours. An error will occur if the specified time window exceeds the range. If you specify the end time only, the system will automatically calculate the start time as end time minus 24 hours, and vice versa.\n\nPOLLING\nFor high-volume trading, it is highly recommended that you maintain your own list of open orders and use one of the streaming market data feeds to keep it updated. You should poll the open orders endpoint to obtain the current state of any open order.\n\nIf you need to get your recent trade history with low latency, you may query the endpoint Get List of Orders Completed in 24h.\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | Current request page, The default currentPage is 1 |\n| pageSize | integer | pageSize, The default pageSize is 50, The maximum cannot exceed 1000 |\n| totalNum | integer | |\n| totalPage | integer | |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Order ID |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| type | string | Order type, market order or limit order
|\n| side | string | Transaction side |\n| price | string | Order price |\n| size | integer | Order quantity |\n| value | string | Order value |\n| dealValue | string | Executed size of funds
|\n| dealSize | integer | Executed quantity |\n| stp | string | self trade prevention |\n| stop | string | Stop order type (stop limit or stop market) |\n| stopPriceType | string | Trigger price type of stop orders |\n| stopTriggered | boolean | Mark to show whether the stop order is triggered |\n| stopPrice | string | Trigger price of stop orders |\n| timeInForce | string | Time in force policy type |\n| postOnly | boolean | Mark of post only |\n| hidden | boolean | Mark of the hidden order |\n| iceberg | boolean | Mark of the iceberg order |\n| leverage | string | Leverage of the order |\n| forceHold | boolean | A mark to forcely hold the funds for an order |\n| closeOrder | boolean | A mark to close the position |\n| visibleSize | integer | Visible size of the iceberg order |\n| clientOid | string | Unique order id created by users to identify their orders |\n| remark | string | Remark of the order |\n| tags | string | tag order source |\n| isActive | boolean | Mark of the active orders |\n| cancelExist | boolean | Mark of the canceled orders |\n| createdAt | integer | Time the order created |\n| updatedAt | integer | last update time |\n| endAt | integer | End time |\n| orderTime | integer | Order create time in nanosecond |\n| settleCurrency | string | settlement currency |\n| marginMode | string | Margin mode: ISOLATED (isolated), CROSS (cross margin). |\n| avgDealPrice | string | Average transaction price, forward contract average transaction price = sum (transaction value) / sum (transaction quantity), reverse contract average transaction price = sum (transaction quantity) / sum (transaction value). Transaction quantity = lots * multiplier |\n| filledSize | integer | Value of the executed orders |\n| filledValue | string | Executed order quantity |\n| status | string | order status: “open” or “done” |\n| reduceOnly | boolean | A mark to reduce the position size only |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "stopOrders" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "side", + "value": null, + "description": "buy or sell" + }, + { + "key": "type", + "value": null, + "description": "limit, market" + }, + { + "key": "startAt", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endAt", + "value": null, + "description": "End time (milisecond)" + }, + { + "key": "currentPage", + "value": null, + "description": "Current request page, The default currentPage is 1" + }, + { + "key": "pageSize", + "value": null, + "description": "pageSize, The default pageSize is 50, The maximum cannot exceed 1000" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"id\": \"230181737576050688\",\n \"symbol\": \"PEOPLEUSDTM\",\n \"type\": \"limit\",\n \"side\": \"buy\",\n \"price\": \"0.05\",\n \"size\": 10,\n \"value\": \"5\",\n \"dealValue\": \"0\",\n \"dealSize\": 0,\n \"stp\": \"\",\n \"stop\": \"\",\n \"stopPriceType\": \"\",\n \"stopTriggered\": false,\n \"stopPrice\": null,\n \"timeInForce\": \"GTC\",\n \"postOnly\": false,\n \"hidden\": false,\n \"iceberg\": false,\n \"leverage\": \"1\",\n \"forceHold\": false,\n \"closeOrder\": false,\n \"visibleSize\": 0,\n \"clientOid\": \"5a80bd847f1811ef8a7faa665a37b3d7\",\n \"remark\": null,\n \"tags\": \"\",\n \"isActive\": true,\n \"cancelExist\": false,\n \"createdAt\": 1727692804813,\n \"updatedAt\": 1727692804813,\n \"endAt\": null,\n \"orderTime\": 1727692804808418000,\n \"settleCurrency\": \"USDT\",\n \"marginMode\": \"ISOLATED\",\n \"avgDealPrice\": \"0\",\n \"filledSize\": 0,\n \"filledValue\": \"0\",\n \"status\": \"open\",\n \"reduceOnly\": false\n }\n ]\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Positions", + "item": [ + { + "name": "Get Max Open Size", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v2", + "getMaxOpenSize" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "price", + "value": null, + "description": "Order price\n" + }, + { + "key": "leverage", + "value": null, + "description": "Leverage\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470251)\n\n:::info[Description]\nGet Maximum Open Position Size.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| maxBuyOpenSize | integer | Maximum buy size
|\n| maxSellOpenSize | integer | Maximum buy size
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v2", + "getMaxOpenSize" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "price", + "value": null, + "description": "Order price\n" + }, + { + "key": "leverage", + "value": null, + "description": "Leverage\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"XBTUSDTM\",\n \"maxBuyOpenSize\": 0,\n \"maxSellOpenSize\": 0\n }\n}" + } + ] + }, + { + "name": "Get Isolated Margin Risk Limit", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "contracts", + "risk-limit", + "{{symbol}}" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470263)\n\n:::info[Description]\nThis interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| level | integer | level
|\n| maxRiskLimit | integer | Upper limit USDT(includes)
|\n| minRiskLimit | integer | Lower limit USDT
|\n| maxLeverage | integer | Max leverage
|\n| initialMargin | number | Initial margin rate
|\n| maintainMargin | number | Maintenance margin rate
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "contracts", + "risk-limit", + "{{symbol}}" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 1,\n \"maxRiskLimit\": 100000,\n \"minRiskLimit\": 0,\n \"maxLeverage\": 125,\n \"initialMargin\": 0.008,\n \"maintainMargin\": 0.004\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 2,\n \"maxRiskLimit\": 500000,\n \"minRiskLimit\": 100000,\n \"maxLeverage\": 100,\n \"initialMargin\": 0.01,\n \"maintainMargin\": 0.005\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 3,\n \"maxRiskLimit\": 1000000,\n \"minRiskLimit\": 500000,\n \"maxLeverage\": 75,\n \"initialMargin\": 0.014,\n \"maintainMargin\": 0.007\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 4,\n \"maxRiskLimit\": 2000000,\n \"minRiskLimit\": 1000000,\n \"maxLeverage\": 50,\n \"initialMargin\": 0.02,\n \"maintainMargin\": 0.01\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 5,\n \"maxRiskLimit\": 3000000,\n \"minRiskLimit\": 2000000,\n \"maxLeverage\": 30,\n \"initialMargin\": 0.034,\n \"maintainMargin\": 0.017\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 6,\n \"maxRiskLimit\": 5000000,\n \"minRiskLimit\": 3000000,\n \"maxLeverage\": 20,\n \"initialMargin\": 0.05,\n \"maintainMargin\": 0.025\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 7,\n \"maxRiskLimit\": 8000000,\n \"minRiskLimit\": 5000000,\n \"maxLeverage\": 10,\n \"initialMargin\": 0.1,\n \"maintainMargin\": 0.05\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 8,\n \"maxRiskLimit\": 12000000,\n \"minRiskLimit\": 8000000,\n \"maxLeverage\": 5,\n \"initialMargin\": 0.2,\n \"maintainMargin\": 0.1\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 9,\n \"maxRiskLimit\": 20000000,\n \"minRiskLimit\": 12000000,\n \"maxLeverage\": 4,\n \"initialMargin\": 0.25,\n \"maintainMargin\": 0.125\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 10,\n \"maxRiskLimit\": 30000000,\n \"minRiskLimit\": 20000000,\n \"maxLeverage\": 3,\n \"initialMargin\": 0.334,\n \"maintainMargin\": 0.167\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 11,\n \"maxRiskLimit\": 40000000,\n \"minRiskLimit\": 30000000,\n \"maxLeverage\": 2,\n \"initialMargin\": 0.5,\n \"maintainMargin\": 0.25\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"level\": 12,\n \"maxRiskLimit\": 50000000,\n \"minRiskLimit\": 40000000,\n \"maxLeverage\": 1,\n \"initialMargin\": 1.0,\n \"maintainMargin\": 0.5\n }\n ]\n}" + } + ] + }, + { + "name": "Get Position Details", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "position" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470252)\n\n:::info[Description]\nGet the position details of a specified position.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Position ID
|\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| crossMode | boolean | Whether it is cross margin. |\n| delevPercentage | number | ADL ranking percentile
|\n| openingTimestamp | integer | Open time
|\n| currentTimestamp | integer | Current timestamp
|\n| currentQty | integer | Current postion quantity
|\n| currentCost | number | Current postion value
|\n| currentComm | number | Current commission
|\n| unrealisedCost | number | Unrealised value
|\n| realisedGrossCost | number | Accumulated realised gross profit value
|\n| realisedCost | number | Current realised position value
|\n| isOpen | boolean | Opened position or not
|\n| markPrice | number | Mark price
|\n| markValue | number | Mark Value
|\n| posCost | number | Position value
|\n| posInit | number | Inital margin Cross = opening value/cross leverage; isolated = accumulation of initial margin for each transaction
|\n| posMargin | number | Bankruptcy cost Cross = mark value * imr; Isolated = position margin (accumulation of initial margin, additional margin, generated funding fees, etc.)
|\n| realisedGrossPnl | number | Accumulated realised gross profit value
|\n| realisedPnl | number | Realised profit and loss
|\n| unrealisedPnl | number | Unrealised profit and loss
|\n| unrealisedPnlPcnt | number | Profit-loss ratio of the position
|\n| unrealisedRoePcnt | number | Rate of return on investment
|\n| avgEntryPrice | number | Average entry price
|\n| liquidationPrice | number | Liquidation price For Cross Margin, you can refer to the liquidationPrice, and the liquidation is based on the risk rate.
|\n| bankruptPrice | number | Bankruptcy price For Cross Margin, you can refer to the bankruptPrice, and the liquidation is based on the risk rate.
|\n| settleCurrency | string | Currency used to clear and settle the trades
|\n| isInverse | boolean | Reverse contract or not
|\n| marginMode | string | Margin Mode: CROSS，ISOLATED
|\n| positionSide | string | Position Side
|\n| leverage | number | Leverage |\n| autoDeposit | boolean | Auto deposit margin or not **Only applicable to Isolated Margin**
|\n| maintMarginReq | number | Maintenance margin requirement **Only applicable to Isolated Margin**
|\n| riskLimit | integer | Risk limit **Only applicable to Isolated Margin**
|\n| realLeverage | number | Leverage of the order **Only applicable to Isolated Margin**
|\n| posCross | number | added margin **Only applicable to Isolated Margin**
|\n| posCrossMargin | integer | Additional margin calls (automatic, manual, adjusted risk limits) **Only applicable to Isolated Margin**
|\n| posComm | number | Bankruptcy cost **Only applicable to Isolated Margin**
|\n| posCommCommon | number | Part of bankruptcy cost (positioning, add margin) **Only applicable to Isolated Margin**
|\n| posLoss | number | Funding fees paid out **Only applicable to Isolated Margin**
|\n| posFunding | number | The current remaining unsettled funding fee for the position **Only applicable to Isolated Margin**
|\n| posMaint | number | Maintenance margin **Only applicable to Isolated Margin**
|\n| maintMargin | number | Position margin **Only applicable to Isolated Margin**
|\n| maintainMargin | number | Maintenance margin rate **Only applicable to Isolated Margin**
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "position" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "//ISOLATED MARGIN\n{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"500000000000988255\",\n \"symbol\": \"XBTUSDTM\",\n \"autoDeposit\": false,\n \"crossMode\": false,\n \"maintMarginReq\": 0.005,\n \"riskLimit\": 500000,\n \"realLeverage\": 2.88,\n \"delevPercentage\": 0.18,\n \"openingTimestamp\": 1729155616322,\n \"currentTimestamp\": 1729482542135,\n \"currentQty\": 1,\n \"currentCost\": 67.4309,\n \"currentComm\": 0.01925174,\n \"unrealisedCost\": 67.4309,\n \"realisedGrossCost\": 0.0,\n \"realisedCost\": 0.01925174,\n \"isOpen\": true,\n \"markPrice\": 68900.7,\n \"markValue\": 68.9007,\n \"posCost\": 67.4309,\n \"posCross\": 0.01645214,\n \"posCrossMargin\": 0,\n \"posInit\": 22.4769666644,\n \"posComm\": 0.0539546299,\n \"posCommCommon\": 0.0539447199,\n \"posLoss\": 0.03766885,\n \"posMargin\": 22.5097045843,\n \"posFunding\": -0.0212068,\n \"posMaint\": 0.3931320569,\n \"maintMargin\": 23.9795045843,\n \"realisedGrossPnl\": 0.0,\n \"realisedPnl\": -0.06166534,\n \"unrealisedPnl\": 1.4698,\n \"unrealisedPnlPcnt\": 0.0218,\n \"unrealisedRoePcnt\": 0.0654,\n \"avgEntryPrice\": 67430.9,\n \"liquidationPrice\": 45314.33,\n \"bankruptPrice\": 44975.16,\n \"settleCurrency\": \"USDT\",\n \"maintainMargin\": 0.005,\n \"riskLimitLevel\": 2,\n \"marginMode\": \"ISOLATED\",\n \"positionSide\": \"BOTH\",\n \"leverage\": 2.88\n }\n}\n\n//CROSS MARGIN\n//{\n// \"code\": \"200000\",\n// \"data\": {\n// \"id\": \"500000000001046430\",\n// \"symbol\": \"ETHUSDM\",\n// \"crossMode\": true,\n// \"delevPercentage\": 0.71,\n// \"openingTimestamp\": 1730635780702,\n// \"currentTimestamp\": 1730636040926,\n// \"currentQty\": 1,\n// \"currentCost\": -0.0004069805,\n// \"currentComm\": 2.441e-7,\n// \"unrealisedCost\": -0.0004069805,\n// \"realisedGrossCost\": 0,\n// \"realisedCost\": 2.441e-7,\n// \"isOpen\": true,\n// \"markPrice\": 2454.12,\n// \"markValue\": -0.000407478,\n// \"posCost\": -0.0004069805,\n// \"posInit\": 0.0000406981,\n// \"posMargin\": 0.0000407478,\n// \"realisedGrossPnl\": 0,\n// \"realisedPnl\": -2.441e-7,\n// \"unrealisedPnl\": -4.975e-7,\n// \"unrealisedPnlPcnt\": -0.0012,\n// \"unrealisedRoePcnt\": -0.0122,\n// \"avgEntryPrice\": 2457.12,\n// \"liquidationPrice\": 1429.96,\n// \"bankruptPrice\": 1414.96,\n// \"settleCurrency\": \"ETH\",\n// \"isInverse\": true,\n// \"marginMode\": \"CROSS\",\n// \"positionSide\": \"BOTH\",\n// \"leverage\": 10\n// }\n//}" + } + ] + }, + { + "name": "Modify Isolated Margin Risk Limit", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "position", + "risk-limit-level", + "change" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470264)\n\n:::info[Description]\nThis interface is for the adjustment of the risk limit level(Only valid for isolated Margin). To adjust the level will cancel the open order, the response can only indicate whether the submit of the adjustment request is successful or not. The result of the adjustment can be achieved by WebSocket information: Position Change Events\n\n:::\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| level | integer | level |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | boolean | To adjust the level will cancel the open order, the response can only indicate whether the submit of the adjustment request is successful or not.
|\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"symbol\" : \"XBTUSDTM\",\n \"level\" : 2\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "position", + "risk-limit-level", + "change" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": true\n}" + } + ] + }, + { + "name": "Get Position List", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "positions" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "Currency code, Please refer to [rootSymbol](https://www.kucoin.com/docs-new/api-221752070) , such as USDT,XBT. Query all positions when empty" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470253)\n\n:::info[Description]\nGet the position details of a specified position.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Position ID
|\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| crossMode | boolean | Whether it is cross margin. |\n| delevPercentage | number | ADL ranking percentile
|\n| openingTimestamp | integer | Open time
|\n| currentTimestamp | integer | Current timestamp
|\n| currentQty | integer | Current postion quantity
|\n| currentCost | number | Current postion value
|\n| currentComm | number | Current commission
|\n| unrealisedCost | number | Unrealised value
|\n| realisedGrossCost | number | Accumulated realised gross profit value
|\n| realisedCost | number | Current realised position value
|\n| isOpen | boolean | Opened position or not
|\n| markPrice | number | Mark price
|\n| markValue | number | Mark Value
|\n| posCost | number | Position value
|\n| posInit | number | Inital margin Cross = opening value/cross leverage; isolated = accumulation of initial margin for each transaction
|\n| posMargin | number | Bankruptcy cost Cross = mark value * imr; Isolated = position margin (accumulation of initial margin, additional margin, generated funding fees, etc.)
|\n| realisedGrossPnl | number | Accumulated realised gross profit value
|\n| realisedPnl | number | Realised profit and loss
|\n| unrealisedPnl | number | Unrealised profit and loss
|\n| unrealisedPnlPcnt | number | Profit-loss ratio of the position
|\n| unrealisedRoePcnt | number | Rate of return on investment
|\n| avgEntryPrice | number | Average entry price
|\n| liquidationPrice | number | Liquidation price For Cross Margin, you can refer to the liquidationPrice, and the liquidation is based on the risk rate.
|\n| bankruptPrice | number | Bankruptcy price For Cross Margin, you can refer to the bankruptPrice, and the liquidation is based on the risk rate.
|\n| settleCurrency | string | Currency used to clear and settle the trades
|\n| isInverse | boolean | Reverse contract or not
|\n| marginMode | string | Margin Mode: CROSS，ISOLATED
|\n| positionSide | string | Position Side
|\n| leverage | number | Leverage |\n| autoDeposit | boolean | Auto deposit margin or not **Only applicable to Isolated Margin**
|\n| maintMarginReq | number | Maintenance margin requirement **Only applicable to Isolated Margin**
|\n| riskLimit | number | Risk limit **Only applicable to Isolated Margin**
|\n| realLeverage | number | Leverage of the order **Only applicable to Isolated Margin**
|\n| posCross | number | added margin **Only applicable to Isolated Margin**
|\n| posCrossMargin | number | Additional margin calls (automatic, manual, adjusted risk limits) **Only applicable to Isolated Margin**
|\n| posComm | number | Bankruptcy cost **Only applicable to Isolated Margin**
|\n| posCommCommon | number | Part of bankruptcy cost (positioning, add margin) **Only applicable to Isolated Margin**
|\n| posLoss | number | Funding fees paid out **Only applicable to Isolated Margin**
|\n| posFunding | number | The current remaining unsettled funding fee for the position **Only applicable to Isolated Margin**
|\n| posMaint | number | Maintenance margin **Only applicable to Isolated Margin**
|\n| maintMargin | number | Position margin **Only applicable to Isolated Margin**
|\n| maintainMargin | number | Maintenance margin rate **Only applicable to Isolated Margin**
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "positions" + ], + "query": [ + { + "key": "currency", + "value": null, + "description": "Currency code, Please refer to [rootSymbol](https://www.kucoin.com/docs-new/api-221752070) , such as USDT,XBT. Query all positions when empty" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"500000000001046430\",\n \"symbol\": \"ETHUSDM\",\n \"crossMode\": true,\n \"delevPercentage\": 0.71,\n \"openingTimestamp\": 1730635780702,\n \"currentTimestamp\": 1730636040926,\n \"currentQty\": 1,\n \"currentCost\": -0.0004069805,\n \"currentComm\": 2.441e-07,\n \"unrealisedCost\": -0.0004069805,\n \"realisedGrossCost\": 0.0,\n \"realisedCost\": 2.441e-07,\n \"isOpen\": true,\n \"markPrice\": 2454.12,\n \"markValue\": -0.000407478,\n \"posCost\": -0.0004069805,\n \"posInit\": 4.06981e-05,\n \"posMargin\": 4.07478e-05,\n \"realisedGrossPnl\": 0.0,\n \"realisedPnl\": -2.441e-07,\n \"unrealisedPnl\": -4.975e-07,\n \"unrealisedPnlPcnt\": -0.0012,\n \"unrealisedRoePcnt\": -0.0122,\n \"avgEntryPrice\": 2457.12,\n \"liquidationPrice\": 1429.96,\n \"bankruptPrice\": 1414.96,\n \"settleCurrency\": \"ETH\",\n \"isInverse\": true,\n \"marginMode\": \"CROSS\",\n \"positionSide\": \"BOTH\",\n \"leverage\": 10\n },\n {\n \"id\": \"500000000000988255\",\n \"symbol\": \"XBTUSDTM\",\n \"autoDeposit\": true,\n \"crossMode\": false,\n \"maintMarginReq\": 0.005,\n \"riskLimit\": 500000,\n \"realLeverage\": 2.97,\n \"delevPercentage\": 0.5,\n \"openingTimestamp\": 1729155616322,\n \"currentTimestamp\": 1730636040926,\n \"currentQty\": 1,\n \"currentCost\": 67.4309,\n \"currentComm\": -0.15936162,\n \"unrealisedCost\": 67.4309,\n \"realisedGrossCost\": 0.0,\n \"realisedCost\": -0.15936162,\n \"isOpen\": true,\n \"markPrice\": 68323.06,\n \"markValue\": 68.32306,\n \"posCost\": 67.4309,\n \"posCross\": 0.06225152,\n \"posCrossMargin\": 0,\n \"posInit\": 22.2769666644,\n \"posComm\": 0.0539821899,\n \"posCommCommon\": 0.0539447199,\n \"posLoss\": 0.26210915,\n \"posMargin\": 22.1310912243,\n \"posFunding\": -0.19982016,\n \"posMaint\": 0.4046228699,\n \"maintMargin\": 23.0232512243,\n \"realisedGrossPnl\": 0.0,\n \"realisedPnl\": -0.2402787,\n \"unrealisedPnl\": 0.89216,\n \"unrealisedPnlPcnt\": 0.0132,\n \"unrealisedRoePcnt\": 0.04,\n \"avgEntryPrice\": 67430.9,\n \"liquidationPrice\": 45704.44,\n \"bankruptPrice\": 45353.8,\n \"settleCurrency\": \"USDT\",\n \"isInverse\": false,\n \"maintainMargin\": 0.005,\n \"marginMode\": \"ISOLATED\",\n \"positionSide\": \"BOTH\",\n \"leverage\": 2.97\n }\n ]\n}" + } + ] + }, + { + "name": "Get Positions History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "history-positions" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "from", + "value": null, + "description": "Closing start time(ms)\n" + }, + { + "key": "to", + "value": null, + "description": "Closing end time(ms)\n" + }, + { + "key": "limit", + "value": null, + "description": "Number of requests per page, max 200, default 10\n" + }, + { + "key": "pageId", + "value": null, + "description": "Current page number, default 1\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470254)\n\n:::info[Description]\nThis interface can query position history information records.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | Current page number
|\n| pageSize | integer | Number of results per page
|\n| totalNum | integer | Total number of results
|\n| totalPage | integer | Total number of pages
|\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| closeId | string | Close ID
|\n| userId | string | User ID |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| settleCurrency | string | Currency used to settle trades
|\n| leverage | string | Leverage applied to the order
|\n| type | string | Type of closure
|\n| pnl | string | Net profit and loss (after deducting fees and funding costs)
|\n| realisedGrossCost | string | Accumulated realised gross profit value
|\n| withdrawPnl | string | Accumulated realised profit withdrawn from the position
|\n| tradeFee | string | Accumulated trading fees
|\n| fundingFee | string | Accumulated funding fees
|\n| openTime | integer | Time when the position was opened
|\n| closeTime | integer | Time when the position was closed (default sorted in descending order)
|\n| openPrice | string | Opening price of the position
|\n| closePrice | string | Closing price of the position
|\n| marginMode | string | Margin Mode: CROSS，ISOLATED |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "history-positions" + ], + "query": [ + { + "key": "symbol", + "value": "", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "from", + "value": null, + "description": "Closing start time(ms)\n" + }, + { + "key": "to", + "value": null, + "description": "Closing end time(ms)\n" + }, + { + "key": "limit", + "value": null, + "description": "Number of requests per page, max 200, default 10\n" + }, + { + "key": "pageId", + "value": null, + "description": "Current page number, default 1\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 10,\n \"totalNum\": 3,\n \"totalPage\": 1,\n \"items\": [\n {\n \"closeId\": \"500000000027312193\",\n \"userId\": \"633559791e1cbc0001f319bc\",\n \"symbol\": \"XBTUSDTM\",\n \"settleCurrency\": \"USDT\",\n \"leverage\": \"0.0\",\n \"type\": \"CLOSE_SHORT\",\n \"pnl\": \"-3.79237944\",\n \"realisedGrossCost\": \"3.795\",\n \"withdrawPnl\": \"0.0\",\n \"tradeFee\": \"0.078657\",\n \"fundingFee\": \"0.08127756\",\n \"openTime\": 1727073653603,\n \"closeTime\": 1729155587945,\n \"openPrice\": \"63650.0\",\n \"closePrice\": \"67445.0\",\n \"marginMode\": \"ISOLATED\"\n },\n {\n \"closeId\": \"500000000026809668\",\n \"userId\": \"633559791e1cbc0001f319bc\",\n \"symbol\": \"SUIUSDTM\",\n \"settleCurrency\": \"USDT\",\n \"leverage\": \"0.0\",\n \"type\": \"LIQUID_SHORT\",\n \"pnl\": \"-1.10919296\",\n \"realisedGrossCost\": \"1.11297635\",\n \"withdrawPnl\": \"0.0\",\n \"tradeFee\": \"0.00200295\",\n \"fundingFee\": \"0.00578634\",\n \"openTime\": 1726473389296,\n \"closeTime\": 1728738683541,\n \"openPrice\": \"1.1072\",\n \"closePrice\": \"2.22017635\",\n \"marginMode\": \"ISOLATED\"\n },\n {\n \"closeId\": \"500000000026819355\",\n \"userId\": \"633559791e1cbc0001f319bc\",\n \"symbol\": \"XBTUSDTM\",\n \"settleCurrency\": \"USDT\",\n \"leverage\": \"0.0\",\n \"type\": \"LIQUID_SHORT\",\n \"pnl\": \"-5.941896296\",\n \"realisedGrossCost\": \"5.86937042\",\n \"withdrawPnl\": \"0.0\",\n \"tradeFee\": \"0.074020096\",\n \"fundingFee\": \"0.00149422\",\n \"openTime\": 1726490775358,\n \"closeTime\": 1727061049859,\n \"openPrice\": \"58679.6\",\n \"closePrice\": \"64548.97042\",\n \"marginMode\": \"ISOLATED\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Remove Isolated Margin", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "withdrawMargin" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470256)\n\n:::info[Description]\nRemove Isolated Margin Manually.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| withdrawAmount | string | The size of the position that can be deposited. If it is USDT-margin, it represents the amount of USDT. If it is coin-margin, this value represents the number of coins
|\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | string | The size of the position deposited. If it is USDT-margin, it represents the amount of USDT. If it is coin-margin, this value represents the number of coins
|\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"symbol\": \"XBTUSDTM\",\n \"withdrawAmount\": \"0.0000001\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "withdrawMargin" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": \"0.1\"\n}" + } + ] + }, + { + "name": "Add Isolated Margin", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "position", + "margin", + "deposit-margin" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470257)\n\n:::info[Description]\nAdd Isolated Margin Manually.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| margin | number | Margin amount (min. margin amount≥0.00001667XBT） |\n| bizNo | string | A unique ID generated by the user, to ensure the operation is processed by the system only once, The maximum length cannot exceed 36 |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Position ID |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| autoDeposit | boolean | Auto deposit margin or not |\n| maintMarginReq | number | Maintenance margin requirement

|\n| riskLimit | integer | Risk limit
|\n| realLeverage | number | Leverage o the order |\n| crossMode | boolean | Cross mode or not |\n| delevPercentage | number | ADL ranking percentile |\n| openingTimestamp | integer | Open time |\n| currentTimestamp | integer | Current timestamp
|\n| currentQty | integer | Current postion quantity |\n| currentCost | number | Current postion value |\n| currentComm | number | Current commission |\n| unrealisedCost | number | Unrealised value |\n| realisedGrossCost | number | Accumulated realised gross profit value |\n| realisedCost | number | Current realised position value |\n| isOpen | boolean | Opened position or not |\n| markPrice | number | Mark price |\n| markValue | number | Mark value
|\n| posCost | number | Position value |\n| posCross | number | added margin |\n| posInit | number | Leverage margin |\n| posComm | number | Bankruptcy cost |\n| posLoss | number | Funding fees paid out |\n| posMargin | number | Position margin |\n| posMaint | number | Maintenance margin |\n| maintMargin | number | Position margin |\n| realisedGrossPnl | number | Accumulated realised gross profit value |\n| realisedPnl | number | Realised profit and loss |\n| unrealisedPnl | number | Unrealised profit and loss |\n| unrealisedPnlPcnt | number | Profit-loss ratio of the position |\n| unrealisedRoePcnt | number | Rate of return on investment |\n| avgEntryPrice | number | Average entry price |\n| liquidationPrice | number | Liquidation price |\n| bankruptPrice | number | Bankruptcy price |\n| userId | integer | userId |\n| settleCurrency | string | Currency used to clear and settle the trades |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"symbol\": \"string\",\n \"margin\": 0,\n \"bizNo\": \"string\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "position", + "margin", + "deposit-margin" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"id\": \"6200c9b83aecfb000152ddcd\",\n \"symbol\": \"XBTUSDTM\",\n \"autoDeposit\": false,\n \"maintMarginReq\": 0.005,\n \"riskLimit\": 500000,\n \"realLeverage\": 18.72,\n \"crossMode\": false,\n \"delevPercentage\": 0.66,\n \"openingTimestamp\": 1646287090131,\n \"currentTimestamp\": 1646295055021,\n \"currentQty\": 1,\n \"currentCost\": 43.388,\n \"currentComm\": 0.0260328,\n \"unrealisedCost\": 43.388,\n \"realisedGrossCost\": 0,\n \"realisedCost\": 0.0260328,\n \"isOpen\": true,\n \"markPrice\": 43536.65,\n \"markValue\": 43.53665,\n \"posCost\": 43.388,\n \"posCross\": 2.4985e-05,\n \"posInit\": 2.1694,\n \"posComm\": 0.02733446,\n \"posLoss\": 0,\n \"posMargin\": 2.19675944,\n \"posMaint\": 0.24861326,\n \"maintMargin\": 2.34540944,\n \"realisedGrossPnl\": 0,\n \"realisedPnl\": -0.0260328,\n \"unrealisedPnl\": 0.14865,\n \"unrealisedPnlPcnt\": 0.0034,\n \"unrealisedRoePcnt\": 0.0685,\n \"avgEntryPrice\": 43388,\n \"liquidationPrice\": 41440,\n \"bankruptPrice\": 41218,\n \"userId\": 1234321123,\n \"settleCurrency\": \"USDT\"\n }\n}" + } + ] + }, + { + "name": "Get Max Withdraw Margin", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "maxWithdrawMargin" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470258)\n\n:::info[Description]\nThis interface can query the maximum amount of margin that the current position supports withdrawal.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | string | The size of the position that can be deposited. If it is USDT-margin, it represents the amount of USDT. If it is coin-margin, this value represents the number of coins
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "margin", + "maxWithdrawMargin" + ], + "query": [ + { + "key": "symbol", + "value": null, + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": \"21.1135719252\"\n}" + } + ] + }, + { + "name": "Get Margin Mode", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v2", + "position", + "getMarginMode" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470259)\n\n:::info[Description]\nThis interface can query the margin mode of the current symbol.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| marginMode | string | Margin mode: ISOLATED (isolated), CROSS (cross margin). |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v2", + "position", + "getMarginMode" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"XBTUSDTM\",\n \"marginMode\": \"ISOLATED\"\n }\n}" + } + ] + }, + { + "name": "Get Cross Margin Leverage", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v2", + "getCrossUserLeverage" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470260)\n\n:::info[Description]\nThis interface can query the current symbol’s cross-margin leverage multiple.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| leverage | string | Leverage multiple |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v2", + "getCrossUserLeverage" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"XBTUSDTM\",\n \"leverage\": \"3\"\n }\n}" + } + ] + }, + { + "name": "Modify Cross Margin Leverage", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v2", + "changeCrossUserLeverage" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470261)\n\n:::info[Description]\nThis interface can modify the current symbol’s cross-margin leverage multiple.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| leverage | string | Leverage multiple |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | |\n| leverage | string | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"symbol\": \"XBTUSDTM\",\n \"leverage\" : \"10\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v2", + "changeCrossUserLeverage" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"XBTUSDTM\",\n \"leverage\": \"3\"\n }\n}" + } + ] + }, + { + "name": "Switch Margin Mode", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v2", + "position", + "changeMarginMode" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470262)\n\n:::info[Description]\nModify the margin mode of the current symbol.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| marginMode | string | Modified margin model: ISOLATED (isolated), CROSS (cross margin). |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| marginMode | string | Margin mode: ISOLATED (isolated), CROSS (cross margin). |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"symbol\": \"XBTUSDTM\",\n \"marginMode\": \"ISOLATED\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v2", + "position", + "changeMarginMode" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \"XBTUSDTM\",\n \"marginMode\": \"ISOLATED\"\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Funding Fees", + "item": [ + { + "name": "Get Current Funding Rate", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "funding-rate", + "{{symbol}}", + "current" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470265)\n\n:::info[Description]\nGet Current Funding Rate\n\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Funding Rate Symbol
|\n| granularity | integer | Granularity (milisecond)
|\n| timePoint | integer | The funding rate settlement time point of the previous cycle
(milisecond)
|\n| value | number | Current cycle funding rate
|\n| predictedValue | number | Predicted funding rate
|\n| fundingRateCap | number | Maximum Funding Rate |\n| fundingRateFloor | number | Minimum Funding Rate |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "funding-rate", + "{{symbol}}", + "current" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"symbol\": \".XBTUSDTMFPI8H\",\n \"granularity\": 28800000,\n \"timePoint\": 1731441600000,\n \"value\": 0.000641,\n \"predictedValue\": 5.2e-05,\n \"fundingRateCap\": 0.003,\n \"fundingRateFloor\": -0.003\n }\n}" + } + ] + }, + { + "name": "Get Public Funding History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "contract", + "funding-rates" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "from", + "value": "1700310700000", + "description": "Begin time (milisecond)\n" + }, + { + "key": "to", + "value": "1702310700000", + "description": "End time (milisecond)\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470266)\n\n:::info[Description]\nQuery the funding rate at each settlement time point within a certain time range of the corresponding contract\n\n:::\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| fundingRate | number | Funding rate |\n| timepoint | integer | Time point (milisecond)

|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "contract", + "funding-rates" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "from", + "value": "1700310700000", + "description": "Begin time (milisecond)\n" + }, + { + "key": "to", + "value": "1702310700000", + "description": "End time (milisecond)\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.00021,\n \"timepoint\": 1702296000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000347,\n \"timepoint\": 1702267200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000452,\n \"timepoint\": 1702238400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000513,\n \"timepoint\": 1702209600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000421,\n \"timepoint\": 1702180800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000506,\n \"timepoint\": 1702152000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000768,\n \"timepoint\": 1702123200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000482,\n \"timepoint\": 1702094400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.0004,\n \"timepoint\": 1702065600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000546,\n \"timepoint\": 1702036800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000797,\n \"timepoint\": 1702008000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000576,\n \"timepoint\": 1701979200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000422,\n \"timepoint\": 1701950400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000392,\n \"timepoint\": 1701921600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.00041,\n \"timepoint\": 1701892800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000448,\n \"timepoint\": 1701864000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000368,\n \"timepoint\": 1701835200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000351,\n \"timepoint\": 1701806400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000144,\n \"timepoint\": 1701777600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000425,\n \"timepoint\": 1701748800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": -8.2e-05,\n \"timepoint\": 1701720000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000464,\n \"timepoint\": 1701691200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000414,\n \"timepoint\": 1701662400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000244,\n \"timepoint\": 1701633600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000199,\n \"timepoint\": 1701604800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000179,\n \"timepoint\": 1701576000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 8.7e-05,\n \"timepoint\": 1701547200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 1.6e-05,\n \"timepoint\": 1701518400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": -3.7e-05,\n \"timepoint\": 1701489600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 1.5e-05,\n \"timepoint\": 1701460800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 6.8e-05,\n \"timepoint\": 1701432000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 7.2e-05,\n \"timepoint\": 1701403200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000145,\n \"timepoint\": 1701374400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000141,\n \"timepoint\": 1701345600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 9.4e-05,\n \"timepoint\": 1701316800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000108,\n \"timepoint\": 1701288000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 7.6e-05,\n \"timepoint\": 1701259200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 1e-05,\n \"timepoint\": 1701230400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 1e-05,\n \"timepoint\": 1701201600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000116,\n \"timepoint\": 1701172800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000204,\n \"timepoint\": 1701144000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.00023,\n \"timepoint\": 1701115200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 6.2e-05,\n \"timepoint\": 1701086400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000133,\n \"timepoint\": 1701057600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 8e-05,\n \"timepoint\": 1701028800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000111,\n \"timepoint\": 1701000000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 7.4e-05,\n \"timepoint\": 1700971200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000101,\n \"timepoint\": 1700942400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 3.9e-05,\n \"timepoint\": 1700913600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 1.1e-05,\n \"timepoint\": 1700884800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 3e-06,\n \"timepoint\": 1700856000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000103,\n \"timepoint\": 1700827200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 3e-06,\n \"timepoint\": 1700798400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 6.7e-05,\n \"timepoint\": 1700769600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000147,\n \"timepoint\": 1700740800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 7.8e-05,\n \"timepoint\": 1700712000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000139,\n \"timepoint\": 1700683200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 7.5e-05,\n \"timepoint\": 1700654400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000111,\n \"timepoint\": 1700625600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 9.8e-05,\n \"timepoint\": 1700596800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000118,\n \"timepoint\": 1700568000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000116,\n \"timepoint\": 1700539200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.00016,\n \"timepoint\": 1700510400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000192,\n \"timepoint\": 1700481600000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000113,\n \"timepoint\": 1700452800000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000247,\n \"timepoint\": 1700424000000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.00023,\n \"timepoint\": 1700395200000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000263,\n \"timepoint\": 1700366400000\n },\n {\n \"symbol\": \"XBTUSDTM\",\n \"fundingRate\": 0.000132,\n \"timepoint\": 1700337600000\n }\n ]\n}" + } + ] + }, + { + "name": "Get Private Funding History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "funding-history" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "from", + "value": "1700310700000", + "description": "Begin time (milisecond)\n" + }, + { + "key": "to", + "value": "1702310700000", + "description": "End time (milisecond)\n" + }, + { + "key": "reverse", + "value": null, + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default\n" + }, + { + "key": "offset", + "value": null, + "description": "Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default.\n" + }, + { + "key": "forward", + "value": null, + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default\n" + }, + { + "key": "maxCount", + "value": null, + "description": "Max record count. The default record count is 10" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470267)\n\n:::info[Description]\nSubmit request to get the funding history.\n:::\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| dataList | array | Refer to the schema section of dataList |\n| hasMore | boolean | Whether there are more pages
|\n\n**root.data.dataList Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | integer | id |\n| symbol | string | Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) |\n| timePoint | integer | Time point (milisecond)
|\n| fundingRate | number | Funding rate
|\n| markPrice | number | Mark price
|\n| positionQty | integer | Position size |\n| positionCost | number | Position value at settlement period
|\n| funding | number | Settled funding fees. A positive number means that the user received the funding fee, and vice versa.
|\n| settleCurrency | string | settlement currency
|\n| context | string | context |\n| marginMode | string | Margin mode: ISOLATED (isolated), CROSS (cross margin). |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{futures_endpoint}}" + ], + "path": [ + "api", + "v1", + "funding-history" + ], + "query": [ + { + "key": "symbol", + "value": "XBTUSDTM", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " + }, + { + "key": "from", + "value": "1700310700000", + "description": "Begin time (milisecond)\n" + }, + { + "key": "to", + "value": "1702310700000", + "description": "End time (milisecond)\n" + }, + { + "key": "reverse", + "value": null, + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default\n" + }, + { + "key": "offset", + "value": null, + "description": "Start offset. The unique attribute of the last returned result of the last request. The data of the first page will be returned by default.\n" + }, + { + "key": "forward", + "value": null, + "description": "This parameter functions to judge whether the lookup is forward or not. True means “yes” and False means “no”. This parameter is set as true by default\n" + }, + { + "key": "maxCount", + "value": null, + "description": "Max record count. The default record count is 10" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"dataList\": [\n {\n \"id\": 1472387374042586,\n \"symbol\": \"XBTUSDTM\",\n \"timePoint\": 1731470400000,\n \"fundingRate\": 0.000641,\n \"markPrice\": 87139.92,\n \"positionQty\": 1,\n \"positionCost\": 87.13992,\n \"funding\": -0.05585669,\n \"settleCurrency\": \"USDT\",\n \"context\": \"{\\\"marginMode\\\": \\\"ISOLATED\\\", \\\"positionSide\\\": \\\"BOTH\\\"}\",\n \"marginMode\": \"ISOLATED\"\n }\n ],\n \"hasMore\": true\n }\n}" + } + ] + } + ], + "description": "" + } + ], + "description": "" + }, + { + "name": "Earn", + "item": [ + { + "name": "purchase", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "orders" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470268)\n\n:::info[Description]\nThis endpoint allows subscribing earn product\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| productId | string | Product Id |\n| amount | string | Subscription amount |\n| accountType | string | MAIN (funding account), TRADE (spot trading account) |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | Holding ID |\n| orderTxId | string | Subscription order ID |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"productId\": \"2611\",\n \"amount\": \"1\",\n \"accountType\": \"TRADE\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "orders" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"2767291\",\n \"orderTxId\": \"6603694\"\n }\n}" + } + ] + }, + { + "name": "Get Redeem Preview", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "redeem-preview" + ], + "query": [ + { + "key": "orderId", + "value": "2767291", + "description": "Holding ID" + }, + { + "key": "fromAccountType", + "value": "MAIN", + "description": "Account type: MAIN (funding account), TRADE (spot trading account). This parameter is valid only when orderId=ETH2" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470269)\n\n:::info[Description]\nThis endpoint can get redemption preview information by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | currency |\n| redeemAmount | string | Expected redemption amount |\n| penaltyInterestAmount | string | Penalty interest amount, incurred for early redemption of fixed-term products |\n| redeemPeriod | integer | Redemption waiting period (days) |\n| deliverTime | integer | Expected deliver time (milliseconds) |\n| manualRedeemable | boolean | Whether manual redemption is possible |\n| redeemAll | boolean | Whether the entire holding must be redeemed, required for early redemption of fixed-term products |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "redeem-preview" + ], + "query": [ + { + "key": "orderId", + "value": "2767291", + "description": "Holding ID" + }, + { + "key": "fromAccountType", + "value": "MAIN", + "description": "Account type: MAIN (funding account), TRADE (spot trading account). This parameter is valid only when orderId=ETH2" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currency\": \"KCS\",\n \"redeemAmount\": \"1\",\n \"penaltyInterestAmount\": \"0\",\n \"redeemPeriod\": 3,\n \"deliverTime\": 1729518951000,\n \"manualRedeemable\": true,\n \"redeemAll\": false\n }\n}" + } + ] + }, + { + "name": "Redeem", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "orders" + ], + "query": [ + { + "key": "orderId", + "value": "2767291", + "description": "Holding ID" + }, + { + "key": "amount", + "value": null, + "description": "Redemption amount" + }, + { + "key": "fromAccountType", + "value": null, + "description": "Account type: MAIN (funding account), TRADE (spot trading account). This parameter is valid only when orderId=ETH2" + }, + { + "key": "confirmPunishRedeem", + "value": null, + "description": "Confirmation field for early redemption penalty: 1 (confirm early redemption, and the current holding will be fully redeemed). This parameter is valid only for fixed-term products" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470270)\n\n:::info[Description]\nThis endpoint allows initiating redemption by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderTxId | string | Redemption order ID |\n| deliverTime | integer | Expected deliver time (milliseconds) |\n| status | string | Redemption status: SUCCESS (successful), PENDING (redemption pending) |\n| amount | string | Redemption amount |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "orders" + ], + "query": [ + { + "key": "orderId", + "value": "2767291", + "description": "Holding ID" + }, + { + "key": "amount", + "value": null, + "description": "Redemption amount" + }, + { + "key": "fromAccountType", + "value": null, + "description": "Account type: MAIN (funding account), TRADE (spot trading account). This parameter is valid only when orderId=ETH2" + }, + { + "key": "confirmPunishRedeem", + "value": null, + "description": "Confirmation field for early redemption penalty: 1 (confirm early redemption, and the current holding will be fully redeemed). This parameter is valid only for fixed-term products" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderTxId\": \"6603700\",\n \"deliverTime\": 1729517805000,\n \"status\": \"PENDING\",\n \"amount\": \"1\"\n }\n}" + } + ] + }, + { + "name": "Get Savings Products", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "saving", + "products" + ], + "query": [ + { + "key": "currency", + "value": "BTC", + "description": "currency" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470271)\n\n:::info[Description]\nThis endpoint can get available savings products. If no products are available, an empty list is returned.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Product ID |\n| currency | string | currency |\n| category | string | Product category: DEMAND (savings) |\n| type | string | Product subtype: TIME (fixed), DEMAND (demand) |\n| precision | integer | Maximum precision supported |\n| productUpperLimit | string | Products total subscribe amount |\n| userUpperLimit | string | Max user subscribe amount |\n| userLowerLimit | string | Min user subscribe amount |\n| redeemPeriod | integer | Redemption waiting period (days) |\n| lockStartTime | integer | Product earliest interest start time, in milliseconds |\n| lockEndTime | integer | Product maturity time, in milliseconds |\n| applyStartTime | integer | Subscription start time, in milliseconds |\n| applyEndTime | integer | Subscription end time, in milliseconds |\n| returnRate | string | Annualized Rate of Return, for example, 0.035 is equal to 3.5% annualized rate of return |\n| incomeCurrency | string | Income currency |\n| earlyRedeemSupported | integer | Whether the fixed product supports early redemption: 0 (no), 1 (yes) |\n| productRemainAmount | string | Products remain subscribe amount |\n| status | string | Product status: ONGOING(Subscription in progress), PENDING(Preheating Subscription), FULL(Subscribed), INTERESTING (Interest in progress) |\n| redeemType | string | Redemption channel: MANUAL (manual redemption), TRANS_DEMAND (transfer to corresponding demand product upon maturity), AUTO (redeem to funding account upon maturity) |\n| incomeReleaseType | string | Income release type: DAILY (daily release), AFTER (release after product ends) |\n| interestDate | integer | Most recent interest date(millisecond) |\n| duration | integer | Product duration (days) |\n| newUserOnly | integer | Whether the product is exclusive for new users: 0 (no), 1 (yes) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "saving", + "products" + ], + "query": [ + { + "key": "currency", + "value": "BTC", + "description": "currency" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"2172\",\n \"currency\": \"BTC\",\n \"category\": \"DEMAND\",\n \"type\": \"DEMAND\",\n \"precision\": 8,\n \"productUpperLimit\": \"480\",\n \"productRemainAmount\": \"132.36153083\",\n \"userUpperLimit\": \"20\",\n \"userLowerLimit\": \"0.01\",\n \"redeemPeriod\": 0,\n \"lockStartTime\": 1644807600000,\n \"lockEndTime\": null,\n \"applyStartTime\": 1644807600000,\n \"applyEndTime\": null,\n \"returnRate\": \"0.00047208\",\n \"incomeCurrency\": \"BTC\",\n \"earlyRedeemSupported\": 0,\n \"status\": \"ONGOING\",\n \"redeemType\": \"MANUAL\",\n \"incomeReleaseType\": \"DAILY\",\n \"interestDate\": 1729267200000,\n \"duration\": 0,\n \"newUserOnly\": 0\n }\n ]\n}" + } + ] + }, + { + "name": "Get Promotion Products", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "promotion", + "products" + ], + "query": [ + { + "key": "currency", + "value": "BTC", + "description": "currency" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470272)\n\n:::info[Description]\nThis endpoint can get available limited-time promotion products. If no products are available, an empty list is returned.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Product ID |\n| currency | string | currency |\n| category | string | Product category: ACTIVITY |\n| type | string | Product subtype: TIME (fixed), DEMAND (demand) |\n| precision | integer | Maximum precision supported |\n| productUpperLimit | string | Products total subscribe amount |\n| userUpperLimit | string | Max user subscribe amount |\n| userLowerLimit | string | Min user subscribe amount |\n| redeemPeriod | integer | Redemption waiting period (days) |\n| lockStartTime | integer | Product earliest interest start time, in milliseconds |\n| lockEndTime | integer | Product earliest interest end time, in milliseconds |\n| applyStartTime | integer | Subscription start time, in milliseconds |\n| applyEndTime | integer | Subscription end time, in milliseconds |\n| returnRate | string | Annualized Rate of Return, for example, 0.035 is equal to 3.5% annualized rate of return |\n| incomeCurrency | string | Income currency |\n| earlyRedeemSupported | integer | Whether the fixed product supports early redemption: 0 (no), 1 (yes) |\n| productRemainAmount | string | Products remain subscribe amount |\n| status | string | Product status: ONGOING(Subscription in progress), PENDING(Preheating Subscription), FULL(Subscribed), INTERESTING (Interest in progress) |\n| redeemType | string | Redemption channel: MANUAL (manual redemption), TRANS_DEMAND (transfer to corresponding demand product upon maturity), AUTO (redeem to funding account upon maturity) |\n| incomeReleaseType | string | Income release type: DAILY (daily release), AFTER (release after product ends) |\n| interestDate | integer | Most recent interest date(millisecond) |\n| duration | integer | Product duration (days) |\n| newUserOnly | integer | Whether the product is exclusive for new users: 0 (no), 1 (yes) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "promotion", + "products" + ], + "query": [ + { + "key": "currency", + "value": "BTC", + "description": "currency" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"2685\",\n \"currency\": \"BTC\",\n \"category\": \"ACTIVITY\",\n \"type\": \"TIME\",\n \"precision\": 8,\n \"productUpperLimit\": \"50\",\n \"userUpperLimit\": \"1\",\n \"userLowerLimit\": \"0.001\",\n \"redeemPeriod\": 0,\n \"lockStartTime\": 1702371601000,\n \"lockEndTime\": 1729858405000,\n \"applyStartTime\": 1702371600000,\n \"applyEndTime\": null,\n \"returnRate\": \"0.03\",\n \"incomeCurrency\": \"BTC\",\n \"earlyRedeemSupported\": 0,\n \"productRemainAmount\": \"49.78203998\",\n \"status\": \"ONGOING\",\n \"redeemType\": \"TRANS_DEMAND\",\n \"incomeReleaseType\": \"DAILY\",\n \"interestDate\": 1729253605000,\n \"duration\": 7,\n \"newUserOnly\": 1\n }\n ]\n}" + } + ] + }, + { + "name": "Get Account Holding", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "hold-assets" + ], + "query": [ + { + "key": "currency", + "value": "KCS", + "description": "currency" + }, + { + "key": "productId", + "value": "", + "description": "Product ID" + }, + { + "key": "productCategory", + "value": "", + "description": "Product category" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current request page." + }, + { + "key": "pageSize", + "value": "10", + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470273)\n\n:::info[Description]\nThis endpoint can get current holding assets information. If no current holding assets are available, an empty list is returned.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| totalNum | integer | total number |\n| items | array | Refer to the schema section of items |\n| currentPage | integer | current page |\n| pageSize | integer | page size |\n| totalPage | integer | total page |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | Holding ID |\n| productId | string | Product ID |\n| productCategory | string | Product category |\n| productType | string | Product sub-type |\n| currency | string | currency |\n| incomeCurrency | string | Income currency |\n| returnRate | string | Annualized Rate of Return, for example, 0.035 is equal to 3.5% annualized rate of return |\n| holdAmount | string | Holding amount |\n| redeemedAmount | string | Redeemed amount |\n| redeemingAmount | string | Redeeming amount |\n| lockStartTime | integer | Product earliest interest start time, in milliseconds |\n| lockEndTime | integer | Product maturity time, in milliseconds |\n| purchaseTime | integer | Most recent subscription time, in milliseconds |\n| redeemPeriod | integer | Redemption waiting period (days) |\n| status | string | Status: LOCKED (holding), REDEEMING (redeeming) |\n| earlyRedeemSupported | integer | Whether the fixed product supports early redemption: 0 (no), 1 (yes) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "hold-assets" + ], + "query": [ + { + "key": "currency", + "value": "KCS", + "description": "currency" + }, + { + "key": "productId", + "value": "", + "description": "Product ID" + }, + { + "key": "productCategory", + "value": "", + "description": "Product category" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current request page." + }, + { + "key": "pageSize", + "value": "10", + "description": "Number of results per request. Minimum is 10, maximum is 500." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"currentPage\": 1,\n \"pageSize\": 15,\n \"items\": [\n {\n \"orderId\": \"2767291\",\n \"productId\": \"2611\",\n \"productCategory\": \"KCS_STAKING\",\n \"productType\": \"DEMAND\",\n \"currency\": \"KCS\",\n \"incomeCurrency\": \"KCS\",\n \"returnRate\": \"0.03471727\",\n \"holdAmount\": \"1\",\n \"redeemedAmount\": \"0\",\n \"redeemingAmount\": \"1\",\n \"lockStartTime\": 1701252000000,\n \"lockEndTime\": null,\n \"purchaseTime\": 1729257513000,\n \"redeemPeriod\": 3,\n \"status\": \"REDEEMING\",\n \"earlyRedeemSupported\": 0\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Staking Products", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "staking", + "products" + ], + "query": [ + { + "key": "currency", + "value": "STX", + "description": "currency" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470274)\n\n:::info[Description]\nThis endpoint can get available staking products. If no products are available, an empty list is returned.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Product ID |\n| currency | string | currency |\n| category | string | Product category: STAKING |\n| type | string | Product subtype: TIME (fixed), DEMAND (demand) |\n| precision | integer | Maximum precision supported |\n| productUpperLimit | string | Products total subscribe amount |\n| userUpperLimit | string | Max user subscribe amount |\n| userLowerLimit | string | Min user subscribe amount |\n| redeemPeriod | integer | Redemption waiting period (days) |\n| lockStartTime | integer | Product earliest interest start time, in milliseconds |\n| lockEndTime | integer | Product maturity time, in milliseconds |\n| applyStartTime | integer | Subscription start time, in milliseconds |\n| applyEndTime | integer | Subscription end time, in milliseconds |\n| returnRate | string | Annualized Rate of Return, for example, 0.035 is equal to 3.5% annualized rate of return |\n| incomeCurrency | string | Income currency |\n| earlyRedeemSupported | integer | Whether the fixed product supports early redemption: 0 (no), 1 (yes) |\n| productRemainAmount | string | Products remain subscribe amount |\n| status | string | Product status: ONGOING(Subscription in progress), PENDING(Preheating Subscription), FULL(Subscribed), INTERESTING (Interest in progress) |\n| redeemType | string | Redemption channel: MANUAL (manual redemption), TRANS_DEMAND (transfer to corresponding demand product upon maturity), AUTO (redeem to funding account upon maturity) |\n| incomeReleaseType | string | Income release type: DAILY (daily release), AFTER (release after product ends) |\n| interestDate | integer | Most recent interest date(millisecond) |\n| duration | integer | Product duration (days) |\n| newUserOnly | integer | Whether the product is exclusive for new users: 0 (no), 1 (yes) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "staking", + "products" + ], + "query": [ + { + "key": "currency", + "value": "STX", + "description": "currency" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"2535\",\n \"currency\": \"STX\",\n \"category\": \"STAKING\",\n \"type\": \"DEMAND\",\n \"precision\": 8,\n \"productUpperLimit\": \"1000000\",\n \"userUpperLimit\": \"10000\",\n \"userLowerLimit\": \"1\",\n \"redeemPeriod\": 14,\n \"lockStartTime\": 1688614514000,\n \"lockEndTime\": null,\n \"applyStartTime\": 1688614512000,\n \"applyEndTime\": null,\n \"returnRate\": \"0.045\",\n \"incomeCurrency\": \"BTC\",\n \"earlyRedeemSupported\": 0,\n \"productRemainAmount\": \"254032.90178701\",\n \"status\": \"ONGOING\",\n \"redeemType\": \"MANUAL\",\n \"incomeReleaseType\": \"DAILY\",\n \"interestDate\": 1729267200000,\n \"duration\": 0,\n \"newUserOnly\": 0\n }\n ]\n}" + } + ] + }, + { + "name": "Get KCS Staking Products", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "kcs-staking", + "products" + ], + "query": [ + { + "key": "currency", + "value": "KCS", + "description": "currency" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470275)\n\n:::info[Description]\nThis endpoint can get available KCS staking products. If no products are available, an empty list is returned.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Product ID |\n| currency | string | currency |\n| category | string | Product category: KCS_STAKING |\n| type | string | Product subtype: TIME (fixed), DEMAND (demand) |\n| precision | integer | Maximum precision supported |\n| productUpperLimit | string | Products total subscribe amount |\n| userUpperLimit | string | Max user subscribe amount |\n| userLowerLimit | string | Min user subscribe amount |\n| redeemPeriod | integer | Redemption waiting period (days) |\n| lockStartTime | integer | Product earliest interest start time, in milliseconds |\n| lockEndTime | integer | Product maturity time, in milliseconds |\n| applyStartTime | integer | Subscription start time, in milliseconds |\n| applyEndTime | integer | Subscription end time, in milliseconds |\n| returnRate | string | Annualized Rate of Return, for example, 0.035 is equal to 3.5% annualized rate of return |\n| incomeCurrency | string | Income currency |\n| earlyRedeemSupported | integer | Whether the fixed product supports early redemption: 0 (no), 1 (yes) |\n| productRemainAmount | string | Products remain subscribe amount |\n| status | string | Product status: ONGOING(Subscription in progress), PENDING(Preheating Subscription), FULL(Subscribed), INTERESTING (Interest in progress) |\n| redeemType | string | Redemption channel: MANUAL (manual redemption), TRANS_DEMAND (transfer to corresponding demand product upon maturity), AUTO (redeem to funding account upon maturity) |\n| incomeReleaseType | string | Income release type: DAILY (daily release), AFTER (release after product ends) |\n| interestDate | integer | Most recent interest date(millisecond) |\n| duration | integer | Product duration (days) |\n| newUserOnly | integer | Whether the product is exclusive for new users: 0 (no), 1 (yes) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "kcs-staking", + "products" + ], + "query": [ + { + "key": "currency", + "value": "KCS", + "description": "currency" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"2611\",\n \"currency\": \"KCS\",\n \"category\": \"KCS_STAKING\",\n \"type\": \"DEMAND\",\n \"precision\": 8,\n \"productUpperLimit\": \"100000000\",\n \"userUpperLimit\": \"100000000\",\n \"userLowerLimit\": \"1\",\n \"redeemPeriod\": 3,\n \"lockStartTime\": 1701252000000,\n \"lockEndTime\": null,\n \"applyStartTime\": 1701252000000,\n \"applyEndTime\": null,\n \"returnRate\": \"0.03471727\",\n \"incomeCurrency\": \"KCS\",\n \"earlyRedeemSupported\": 0,\n \"productRemainAmount\": \"58065850.54998251\",\n \"status\": \"ONGOING\",\n \"redeemType\": \"MANUAL\",\n \"incomeReleaseType\": \"DAILY\",\n \"interestDate\": 1729267200000,\n \"duration\": 0,\n \"newUserOnly\": 0\n }\n ]\n}" + } + ] + }, + { + "name": "Get ETH Staking Products", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "eth-staking", + "products" + ], + "query": [ + { + "key": "currency", + "value": "ETH", + "description": "currency" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470276)\n\n:::info[Description]\nThis endpoint can get available ETH staking products. If no products are available, an empty list is returned.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Product ID |\n| category | string | Product category: ETH2 (ETH Staking) |\n| type | string | Product subtype: DEMAND (demand) |\n| precision | integer | Maximum precision supported |\n| currency | string | currency |\n| incomeCurrency | string | Income currency |\n| returnRate | string | Annualized Rate of Return, for example, 0.035 is equal to 3.5% annualized rate of return |\n| userLowerLimit | string | Min user subscribe amount |\n| userUpperLimit | string | Max user subscribe amount |\n| productUpperLimit | string | Products total subscribe amount |\n| productRemainAmount | string | Products remain subscribe amount |\n| redeemPeriod | integer | Redemption waiting period (days) |\n| redeemType | string | Redemption channel: MANUAL (manual redemption), TRANS_DEMAND (transfer to corresponding demand product upon maturity), AUTO (redeem to funding account upon maturity) |\n| incomeReleaseType | string | Income release type: DAILY (daily release), AFTER (release after product ends) |\n| applyStartTime | integer | Subscription start time, in milliseconds |\n| applyEndTime | integer | Subscription end time, in milliseconds |\n| lockStartTime | integer | Product earliest interest start time, in milliseconds |\n| lockEndTime | integer | Product maturity time, in milliseconds |\n| interestDate | integer | Most recent interest date(millisecond) |\n| newUserOnly | integer | Whether the product is exclusive for new users: 0 (no), 1 (yes) |\n| earlyRedeemSupported | integer | Whether the fixed product supports early redemption: 0 (no), 1 (yes) |\n| duration | integer | Product duration (days) |\n| status | string | Product status: ONGOING(Subscription in progress), PENDING(Preheating Subscription), FULL(Subscribed), INTERESTING (Interest in progress) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "earn", + "eth-staking", + "products" + ], + "query": [ + { + "key": "currency", + "value": "ETH", + "description": "currency" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"id\": \"ETH2\",\n \"category\": \"ETH2\",\n \"type\": \"DEMAND\",\n \"precision\": 8,\n \"currency\": \"ETH\",\n \"incomeCurrency\": \"ETH2\",\n \"returnRate\": \"0.028\",\n \"userLowerLimit\": \"0.01\",\n \"userUpperLimit\": \"8557.3597075\",\n \"productUpperLimit\": \"8557.3597075\",\n \"productRemainAmount\": \"8557.3597075\",\n \"redeemPeriod\": 5,\n \"redeemType\": \"MANUAL\",\n \"incomeReleaseType\": \"DAILY\",\n \"applyStartTime\": 1729255485000,\n \"applyEndTime\": null,\n \"lockStartTime\": 1729255485000,\n \"lockEndTime\": null,\n \"interestDate\": 1729267200000,\n \"newUserOnly\": 0,\n \"earlyRedeemSupported\": 0,\n \"duration\": 0,\n \"status\": \"ONGOING\"\n }\n ]\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "VIP Lending", + "item": [ + { + "name": "Get Account Detail", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "otc-loan", + "loan" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470277)\n\n:::info[Description]\nThe following information is only applicable to loans. \nGet information on off-exchange funding and loans, This endpoint is only for querying accounts that are currently involved in loans.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| parentUid | string | Master UID |\n| orders | array | Refer to the schema section of orders |\n| ltv | object | Refer to the schema section of ltv |\n| totalMarginAmount | string | Total Margin Amount (USDT) |\n| transferMarginAmount | string | Total Maintenance Margin for Restricted Transfers (USDT) |\n| margins | array | Refer to the schema section of margins |\n\n**root.data.ltv Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| transferLtv | string | LTV of Restricted Transfers to Funding Account |\n| onlyClosePosLtv | string | LTV of Reduce Only (Restricted Open Positions) |\n| delayedLiquidationLtv | string | LTV of Delayed Liquidation |\n| instantLiquidationLtv | string | LTV of Instant Liquidation |\n| currentLtv | string | Current LTV |\n\n**root.data.ltv.orders Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | Loan Orders ID |\n| principal | string | Principal to Be Repaid |\n| interest | string | Interest to Be Repaid |\n| currency | string | Loan Currency |\n\n**root.data.ltv.orders.margins Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| marginCcy | string | Margin Currency |\n| marginQty | string | Maintenance Quantity (Calculated with Margin Coefficient) |\n| marginFactor | string | Margin Coefficient return real time margin discount rate to USDT |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "otc-loan", + "loan" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"parentUid\": \"1260004199\",\n \"orders\": [\n {\n \"orderId\": \"671a2be815f4140007a588e1\",\n \"principal\": \"100\",\n \"interest\": \"0\",\n \"currency\": \"USDT\"\n }\n ],\n \"ltv\": {\n \"transferLtv\": \"0.6000\",\n \"onlyClosePosLtv\": \"0.7500\",\n \"delayedLiquidationLtv\": \"0.7500\",\n \"instantLiquidationLtv\": \"0.8000\",\n \"currentLtv\": \"0.1111\"\n },\n \"totalMarginAmount\": \"900.00000000\",\n \"transferMarginAmount\": \"166.66666666\",\n \"margins\": [\n {\n \"marginCcy\": \"USDT\",\n \"marginQty\": \"1000.00000000\",\n \"marginFactor\": \"0.9000000000\"\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get Accounts", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "otc-loan", + "accounts" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470278)\n\n:::info[Description]\nAccounts participating in OTC lending, This interface is only for querying accounts currently running OTC lending.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| uid | string | UID |\n| marginCcy | string | Margin Currency |\n| marginQty | string | Maintenance Quantity (Calculated with Margin Coefficient) |\n| marginFactor | string | Margin Coefficient |\n| accountType | string | Account Type: TRADE - Trading Account CONTRACT - Futures Account (for Total Futures Equity) |\n| isParent | boolean | If It Is Master Account |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "otc-loan", + "accounts" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"uid\": \"1260004199\",\n \"marginCcy\": \"USDT\",\n \"marginQty\": \"900\",\n \"marginFactor\": \"0.9000000000\",\n \"accountType\": \"TRADE\",\n \"isParent\": true\n }\n ]\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Affiliate", + "item": [ + { + "name": "Get Account", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "affiliate", + "inviter", + "statistics" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470279)\n\n:::info[Description]\nThis endpoint allows getting affiliate user rebate information.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| parentUid | string | Master account UID |\n| orders | array | Refer to the schema section of orders |\n| ltv | object | Refer to the schema section of ltv |\n| totalMarginAmount | string | Total Margin Amount (USDT) |\n| transferMarginAmount | string | Total Maintenance Margin for Restricted Transfers (USDT) |\n| margins | array | Refer to the schema section of margins |\n\n**root.data.ltv Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| transferLtv | string | LTV of Restricted Transfers to Funding Account |\n| onlyClosePosLtv | string | LTV of Reduce Only (Restricted Open Positions) |\n| delayedLiquidationLtv | string | LTV of Delayed Liquidation |\n| instantLiquidationLtv | string | LTV of Instant Liquidation |\n| currentLtv | string | Current LTV |\n\n**root.data.ltv.orders Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | Loan Orders ID |\n| currency | string | Loan Currency |\n| principal | string | Principal to Be Repaid |\n| interest | string | Interest to Be Repaid |\n\n**root.data.ltv.orders.margins Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| marginCcy | string | Margin Currency |\n| marginQty | string | Maintenance Quantity (Calculated with Margin Coefficient) |\n| marginFactor | string | Margin Coefficient return real time margin discount rate to USDT |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v2", + "affiliate", + "inviter", + "statistics" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"parentUid\": \"1000000\",\n \"orders\": [\n {\n \"orderId\": \"1668458892612980737\",\n \"currency\": \"USDT\",\n \"principal\": \"100\",\n \"interest\": \"0\"\n }\n ],\n \"ltv\": {\n \"transferLtv\": \"0.6000\",\n \"onlyClosePosLtv\": \"0.7500\",\n \"delayedLiquidationLtv\": \"0.9000\",\n \"instantLiquidationLtv\": \"0.9500\",\n \"currentLtv\": \"0.0854\"\n },\n \"totalMarginAmount\": \"1170.36181573\",\n \"transferMarginAmount\": \"166.66666666\",\n \"margins\": [\n {\n \"marginCcy\": \"USDT\",\n \"marginQty\": \"1170.36181573\",\n \"marginFactor\": \"1.000000000000000000\"\n }\n ]\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Broker", + "item": [ + { + "name": "Beginners", + "item": [], + "description": "" + }, + { + "name": "API Broker", + "item": [ + { + "name": "Get Broker Rebate", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "api", + "rebase", + "download" + ], + "query": [ + { + "key": "begin", + "value": "20240610", + "description": "Start time, for example: 20240610" + }, + { + "key": "end", + "value": "20241010", + "description": "End time, for example: 20241010 (query data with a maximum interval of 6 months)\n" + }, + { + "key": "tradeType", + "value": "1", + "description": "Transaction type, 1: spot 2: futures" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470280)\n\n:::info[Description]\nThis interface supports downloading Broker rebate orders\n:::\n\n### Excel Response\n\n| Param | Description | Example |\n| ------------------- | ----------------- |--------- |\n| Date | Date | 2024/9/1 |\n| BrokerUID | Broker's UID | 3243241 |\n| AffiliateUID | Affiliate's UID | 2354546 |\n| UID | User's UID | 6345466 |\n| BizLine | Business Line(Spot、Futures) | Spot |\n| Volume | Volume | 0 |\n| TotalCommission | Total Commission = BrokerCommission + UserCommission + AffiliateCommission | 0 |\n| BrokerCommission | Broker Commission | 0 |\n| UserCommission | User Commission | 0 |\n| AffiliateCommission | Affiliate Commission | 0 |\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| url | string | Rebate order file (link is valid for 1 day) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{spot_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "api", + "rebase", + "download" + ], + "query": [ + { + "key": "begin", + "value": "20240610", + "description": "Start time, for example: 20240610" + }, + { + "key": "end", + "value": "20241010", + "description": "End time, for example: 20241010 (query data with a maximum interval of 6 months)\n" + }, + { + "key": "tradeType", + "value": "1", + "description": "Transaction type, 1: spot 2: futures" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"url\": \"https://kc-v2-promotion.s3.ap-northeast-1.amazonaws.com/broker/671aec522593f600019766d0_file.csv?X-Amz-Security-Token=IQo*********2cd90f14efb\"\n }\n}" + } + ] + } + ], + "description": "" + }, + { + "name": "Exchange Broker", + "item": [ + { + "name": "Get Broker Rebate", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "rebase", + "download" + ], + "query": [ + { + "key": "begin", + "value": "20240610", + "description": "Start time, for example: 20240610" + }, + { + "key": "end", + "value": "20241010", + "description": "End time, for example: 20241010 (query data with a maximum interval of 6 months)\n" + }, + { + "key": "tradeType", + "value": "1", + "description": "Transaction type, 1: spot 2: futures" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470281)\n\n:::info[Description]\nThis interface supports downloading Broker rebate orders\n:::\n\n### Excel Response\n\n| Param | Description | Example |\n| ------------------- | ----------------- |--------- |\n| Date | Date | 2024/9/1 |\n| BrokerUID | Broker's UID | 3243241 |\n| AffiliateUID | Affiliate's UID | 2354546 |\n| UID | User's UID | 6345466 |\n| BizLine | Business Line(Spot、Futures) | Spot |\n| Volume | Volume | 0 |\n| TotalCommission | Total Commission = BrokerCommission + UserCommission + AffiliateCommission | 0 |\n| BrokerCommission | Broker Commission | 0 |\n| UserCommission | User Commission | 0 |\n| AffiliateCommission | Affiliate Commission | 0 |\n\n\n\n\n\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| url | string | Rebate order file (link is valid for 1 day) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "rebase", + "download" + ], + "query": [ + { + "key": "begin", + "value": "20240610", + "description": "Start time, for example: 20240610" + }, + { + "key": "end", + "value": "20241010", + "description": "End time, for example: 20241010 (query data with a maximum interval of 6 months)\n" + }, + { + "key": "tradeType", + "value": "1", + "description": "Transaction type, 1: spot 2: futures" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"url\": \"https://kc-v2-promotion.s3.ap-northeast-1.amazonaws.com/broker/671aec522593f600019766d0_file.csv?X-Amz-Security-Token=IQo*********2cd90f14efb\"\n }\n}" + } + ] + }, + { + "name": "Get Broker Info", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "info" + ], + "query": [ + { + "key": "begin", + "value": "20240510", + "description": "Start time, for example: 20230110" + }, + { + "key": "end", + "value": "20241010", + "description": "End time, for example: 20230210 (query data with a maximum interval of 6 months)\n" + }, + { + "key": "tradeType", + "value": "1", + "description": "Transaction type, 1: spot 2: futures" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470282)\n\n:::info[Description]\nThis endpoint supports querying the basic information of the current Broker\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| accountSize | integer | Number of sub-accounts created |\n| maxAccountSize | integer | The maximum number of sub-accounts allowed to be created, null means no limit |\n| level | integer | Broker level |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "info" + ], + "query": [ + { + "key": "begin", + "value": "20240510", + "description": "Start time, for example: 20230110" + }, + { + "key": "end", + "value": "20241010", + "description": "End time, for example: 20230210 (query data with a maximum interval of 6 months)\n" + }, + { + "key": "tradeType", + "value": "1", + "description": "Transaction type, 1: spot 2: futures" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"accountSize\": 0,\n \"maxAccountSize\": null,\n \"level\": 0\n }\n}" + } + ] + }, + { + "name": "Get SubAccount", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account" + ], + "query": [ + { + "key": "uid", + "value": "226383154", + "description": "Sub-account UID" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current page, default is 1" + }, + { + "key": "pageSize", + "value": "20", + "description": "The number returned per page, the default is 20, the maximum is 100" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470283)\n\n:::info[Description]\nThis interface supports querying sub-accounts created by Broker\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currentPage | integer | Current page |\n| pageSize | integer | Page Size |\n| totalNum | integer | Total Number |\n| totalPage | integer | Total Page |\n| items | array | Refer to the schema section of items |\n\n**root.data.items Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| accountName | string | Sub-account name |\n| uid | string | Sub-account UID |\n| createdAt | integer | Creation time, unix timestamp (milliseconds) |\n| level | integer | Sub-account VIP level
|\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account" + ], + "query": [ + { + "key": "uid", + "value": "226383154", + "description": "Sub-account UID" + }, + { + "key": "currentPage", + "value": "1", + "description": "Current page, default is 1" + }, + { + "key": "pageSize", + "value": "20", + "description": "The number returned per page, the default is 20, the maximum is 100" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 20,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"accountName\": \"Account15\",\n \"uid\": \"226383154\",\n \"createdAt\": 1729819382000,\n \"level\": 0\n }\n ]\n }\n}" + } + ] + }, + { + "name": "Get SubAccount API", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account", + "apikey" + ], + "query": [ + { + "key": "uid", + "value": "226383154", + "description": "Sub-account UID" + }, + { + "key": "apiKey", + "value": "671afb36cee20f00015cfaf1", + "description": "Sub-account apiKey\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470284)\n\n:::info[Description]\nThis interface supports querying the Broker’s sub-account APIKEY\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| uid | string | Sub-Account UID |\n| label | string | apikey remarks |\n| apiKey | string | apiKey |\n| apiVersion | integer | apiVersion |\n| permissions | array | Refer to the schema section of permissions |\n| ipWhitelist | array | Refer to the schema section of ipWhitelist |\n| createdAt | integer | Creation time, unix timestamp (milliseconds) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account", + "apikey" + ], + "query": [ + { + "key": "uid", + "value": "226383154", + "description": "Sub-account UID" + }, + { + "key": "apiKey", + "value": "671afb36cee20f00015cfaf1", + "description": "Sub-account apiKey\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"uid\": \"226383154\",\n \"label\": \"This is remarks\",\n \"apiKey\": \"671afb36cee20f00015cfaf1\",\n \"apiVersion\": 3,\n \"permissions\": [\n \"General\",\n \"Spot\"\n ],\n \"ipWhitelist\": [\n \"127.**.1\",\n \"203.**.154\"\n ],\n \"createdAt\": 1729821494000\n }\n ]\n}" + } + ] + }, + { + "name": "Get Deposit List", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "asset", + "ndbroker", + "deposit", + "list" + ], + "query": [ + { + "key": "currency", + "value": "USDT", + "description": "currency" + }, + { + "key": "status", + "value": "SUCCESS", + "description": "Status. Available value: PROCESSING, SUCCESS, FAILURE" + }, + { + "key": "hash", + "value": null, + "description": "hash" + }, + { + "key": "startTimestamp", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endTimestamp", + "value": null, + "description": "End time (milisecond)，Default sorting in descending order" + }, + { + "key": "limit", + "value": "100", + "description": "Maximum number of returned items, maximum 1000, default 1000" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470285)\n\n:::info[Description]\nThis endpoint can obtain the deposit records of each sub-account under the ND Broker.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| success | boolean | |\n| code | string | |\n| msg | string | |\n| retry | boolean | |\n| data | array | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| uid | number | deposit uid |\n| hash | string | hash |\n| address | string | Deposit address |\n| memo | string | Address remark. If there’s no remark, it is empty. When you withdraw from other platforms to the KuCoin, you need to fill in memo(tag). If you do not fill memo (tag), your deposit may not be available, please be cautious. |\n| amount | string | Deposit amount |\n| fee | string | Fees charged for deposit |\n| currency | string | currency |\n| isInner | boolean | Internal deposit or not |\n| walletTxId | string | Wallet Txid |\n| status | string | Status. Available value: PROCESSING, SUCCESS, FAILURE |\n| remark | string | remark |\n| chain | string | chain name of currency |\n| createdAt | integer | Creation time of the database record |\n| updatedAt | integer | Update time of the database record |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "asset", + "ndbroker", + "deposit", + "list" + ], + "query": [ + { + "key": "currency", + "value": "USDT", + "description": "currency" + }, + { + "key": "status", + "value": "SUCCESS", + "description": "Status. Available value: PROCESSING, SUCCESS, FAILURE" + }, + { + "key": "hash", + "value": null, + "description": "hash" + }, + { + "key": "startTimestamp", + "value": null, + "description": "Start time (milisecond)" + }, + { + "key": "endTimestamp", + "value": null, + "description": "End time (milisecond)，Default sorting in descending order" + }, + { + "key": "limit", + "value": "100", + "description": "Maximum number of returned items, maximum 1000, default 1000" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": [\n {\n \"uid\": 165111215,\n \"hash\": \"6724e363a492800007ec602b\",\n \"address\": \"xxxxxxx@gmail.com\",\n \"memo\": \"\",\n \"amount\": \"3.0\",\n \"fee\": \"0.0\",\n \"currency\": \"USDT\",\n \"isInner\": true,\n \"walletTxId\": \"bbbbbbbbb\",\n \"status\": \"SUCCESS\",\n \"chain\": \"\",\n \"remark\": \"\",\n \"createdAt\": 1730470760000,\n \"updatedAt\": 1730470760000\n }\n ]\n}" + } + ] + }, + { + "name": "Get Transfer History", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v3", + "broker", + "nd", + "transfer", + "detail" + ], + "query": [ + { + "key": "orderId", + "value": "671b4600c1e3dd000726866d", + "description": "Transfer Order ID" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470286)\n\n:::info[Description]\nThis endpoint supports querying transfer records of the broker itself and its created sub-accounts.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | Transfer Order ID |\n| currency | string | Currency |\n| amount | string | Transfer Amount |\n| fromUid | integer | UID of the user transferring out |\n| fromAccountType | string | From Account Type:Account Type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED |\n| fromAccountTag | string | Trading pair, required if the account type is ISOLATED, e.g., BTC-USDT |\n| toUid | integer | UID of the user transferring in |\n| toAccountType | string | Account Type:Account Type: MAIN, TRADE, CONTRACT, MARGIN, ISOLATED |\n| toAccountTag | string | To Trading pair, required if the account type is ISOLATED, e.g., BTC-USDT |\n| status | string | Status: PROCESSING (processing), SUCCESS (successful), FAILURE (failed) |\n| reason | string | Failure Reason |\n| createdAt | integer | Creation Time (Unix timestamp in milliseconds) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v3", + "broker", + "nd", + "transfer", + "detail" + ], + "query": [ + { + "key": "orderId", + "value": "671b4600c1e3dd000726866d", + "description": "Transfer Order ID" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"671b4600c1e3dd000726866d\",\n \"currency\": \"USDT\",\n \"amount\": \"1\",\n \"fromUid\": 165111215,\n \"fromAccountType\": \"MAIN\",\n \"fromAccountTag\": \"DEFAULT\",\n \"toUid\": 226383154,\n \"toAccountType\": \"MAIN\",\n \"toAccountTag\": \"DEFAULT\",\n \"status\": \"SUCCESS\",\n \"reason\": null,\n \"createdAt\": 1729840640000\n }\n}" + } + ] + }, + { + "name": "Get Withdraw Detail", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v3", + "broker", + "nd", + "withdraw", + "detail" + ], + "query": [ + { + "key": "withdrawalId", + "value": "66617a2***3c9a", + "description": "Withdrawal ID" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470287)\n\n:::info[Description]\nThis endpoint supports querying the withdrawal records of sub-accounts created by a Broker (excluding main account of nd broker).\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| data | object | Refer to the schema section of data |\n| code | string | |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| id | string | Withdrawal ID |\n| chain | string | chain id of currency |\n| walletTxId | string | Wallet Transaction ID |\n| uid | integer | UID |\n| updatedAt | integer | Update Time (milliseconds) |\n| amount | string | Amount |\n| memo | string | Memo |\n| fee | string | Fee |\n| address | string | Address |\n| remark | string | Remark |\n| isInner | boolean | Is Internal (true or false) |\n| currency | string | Currency |\n| status | string | Status (PROCESSING, WALLET_PROCESSING, REVIEW, SUCCESS, FAILURE) |\n| createdAt | integer | Creation Time (milliseconds) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v3", + "broker", + "nd", + "withdraw", + "detail" + ], + "query": [ + { + "key": "withdrawalId", + "value": "66617a2***3c9a", + "description": "Withdrawal ID" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"data\": {\n \"id\": \"66617a2***3c9a\",\n \"chain\": \"ton\",\n \"walletTxId\": \"AJ***eRI=\",\n \"uid\": 157267400,\n \"amount\": \"1.00000000\",\n \"memo\": \"7025734\",\n \"fee\": \"0.00000000\",\n \"address\": \"EQDn***dKbGzr\",\n \"remark\": \"\",\n \"isInner\": false,\n \"currency\": \"USDT\",\n \"status\": \"SUCCESS\",\n \"createdAt\": 1717664288000,\n \"updatedAt\": 1717664375000\n },\n \"code\": \"200000\"\n}" + } + ] + }, + { + "name": "Get Deposit Detail", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v3", + "broker", + "nd", + "deposit", + "detail" + ], + "query": [ + { + "key": "currency", + "value": "USDT", + "description": "Currency" + }, + { + "key": "hash", + "value": "30bb0e0b***4156c5188", + "description": "Hash Value" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470288)\n\n:::info[Description]\nThis endpoint supports querying the deposit record of sub-accounts created by a Broker (excluding main account of nd broker)\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| data | object | Refer to the schema section of data |\n| code | string | |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| chain | string | chain id of currency |\n| hash | string | Hash |\n| walletTxId | string | Wallet Transaction ID |\n| uid | integer | UID |\n| updatedAt | integer | Update Time (milliseconds) |\n| amount | string | Amount |\n| memo | string | Memo |\n| fee | string | Fee |\n| address | string | Address |\n| remark | string | Remark |\n| isInner | boolean | Is Internal (true or false) |\n| currency | string | Currency |\n| status | string | Status (PROCESSING, SUCCESS, FAILURE) |\n| createdAt | integer | Creation Time (milliseconds) |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v3", + "broker", + "nd", + "deposit", + "detail" + ], + "query": [ + { + "key": "currency", + "value": "USDT", + "description": "Currency" + }, + { + "key": "hash", + "value": "30bb0e0b***4156c5188", + "description": "Hash Value" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"data\": {\n \"chain\": \"trx\",\n \"hash\": \"30bb0e0b***4156c5188\",\n \"walletTxId\": \"30bb0***610d1030f\",\n \"uid\": 201496341,\n \"updatedAt\": 1713429174000,\n \"amount\": \"8.5\",\n \"memo\": \"\",\n \"fee\": \"0.0\",\n \"address\": \"THLPzUrbd1o***vP7d\",\n \"remark\": \"Deposit\",\n \"isInner\": false,\n \"currency\": \"USDT\",\n \"status\": \"SUCCESS\",\n \"createdAt\": 1713429173000\n },\n \"code\": \"200000\"\n}" + } + ] + }, + { + "name": "Delete SubAccount API", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account", + "apikey" + ], + "query": [ + { + "key": "uid", + "value": "226383154", + "description": "Sub-account UID" + }, + { + "key": "apiKey", + "value": "671afb36cee20f00015cfaf1", + "description": "Sub-account apiKey\n" + } + ] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470289)\n\n:::info[Description]\nThis interface supports deleting Broker’s sub-account APIKEY\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n **None** \n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | boolean | |\n\n---\n", + "body": {} + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account", + "apikey" + ], + "query": [ + { + "key": "uid", + "value": "226383154", + "description": "Sub-account UID" + }, + { + "key": "apiKey", + "value": "671afb36cee20f00015cfaf1", + "description": "Sub-account apiKey\n" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": true\n}" + } + ] + }, + { + "name": "Add SubAccount", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470290)\n\n:::info[Description]\nThis endpoint supports Broker users to create sub-accounts\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| accountName | string | Sub Account Name, Note that this name is unique across the exchange. It is recommended to add a special identifier to prevent name duplication. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| accountName | string | Sub-Account name
|\n| uid | string | Sub-Account UID |\n| createdAt | integer | Creation time, unix timestamp (milliseconds) |\n| level | integer | Subaccount VIP level |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"accountName\": \"Account1\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"accountName\": \"Account15\",\n \"uid\": \"226383154\",\n \"createdAt\": 1729819381908,\n \"level\": 0\n }\n}" + } + ] + }, + { + "name": "Add SubAccount API", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account", + "apikey" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470291)\n\n:::info[Description]\nThis interface supports the creation of Broker sub-account APIKEY\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| uid | string | Subaccount UID |\n| passphrase | string | API passphrase |\n| ipWhitelist | array | Refer to the schema section of ipWhitelist |\n| permissions | array | Refer to the schema section of permissions |\n| label | string | apikey remarks (length 4~32)
|\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| uid | string | Sub-Account UID |\n| label | string | apikey remarks |\n| apiKey | string | apiKey |\n| secretKey | string | secretKey |\n| apiVersion | integer | apiVersion |\n| permissions | array | Refer to the schema section of permissions |\n| ipWhitelist | array | Refer to the schema section of ipWhitelist |\n| createdAt | integer | Creation time, unix timestamp (milliseconds) |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"uid\": \"226383154\",\n \"passphrase\": \"11223344\",\n \"ipWhitelist\": [\n \"127.0.0.1\",\"123.123.123.123\"\n ],\n \"permissions\": [\n \"general\",\"spot\"\n ],\n \"label\": \"This is remarks\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account", + "apikey" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"uid\": \"226383154\",\n \"label\": \"This is remarks\",\n \"apiKey\": \"671afb36cee20f00015cfaf1\",\n \"secretKey\": \"d694df2******5bae05b96\",\n \"apiVersion\": 3,\n \"permissions\": [\n \"General\",\n \"Spot\"\n ],\n \"ipWhitelist\": [\n \"127.0.0.1\",\n \"123.123.123.123\"\n ],\n \"createdAt\": 1729821494000\n }\n}" + } + ] + }, + { + "name": "Modify SubAccount API", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account", + "update-apikey" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470292)\n\n:::info[Description]\nThis interface supports modify the Broker’s sub-account APIKEY\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| uid | string | Subaccount UID |\n| ipWhitelist | array | Refer to the schema section of ipWhitelist |\n| permissions | array | Refer to the schema section of permissions |\n| label | string | apikey remarks (length 4~32)
|\n| apiKey | string | Subaccount apiKey |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| uid | string | Sub-Account UID |\n| label | string | apikey remarks |\n| apiKey | string | apiKey |\n| apiVersion | integer | apiVersion |\n| permissions | array | Refer to the schema section of permissions |\n| ipWhitelist | array | Refer to the schema section of ipWhitelist |\n| createdAt | integer | Creation time, unix timestamp (milliseconds) |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"uid\": \"226383154\",\n \"apiKey\": \"671afb36cee20f00015cfaf1\",\n \"ipWhitelist\": [\n \"127.0.0.1\",\n \"123.123.123.123\"\n ],\n \"permissions\": [\n \"general\",\n \"spot\"\n ],\n \"label\": \"This is remarks\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "account", + "update-apikey" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"uid\": \"226383154\",\n \"label\": \"This is remarks\",\n \"apiKey\": \"671afb36cee20f00015cfaf1\",\n \"apiVersion\": 3,\n \"permissions\": [\n \"General\",\n \"Spot\"\n ],\n \"ipWhitelist\": [\n \"127.**.1\",\n \"123.**.123\"\n ],\n \"createdAt\": 1729821494000\n }\n}" + } + ] + }, + { + "name": "Transfer", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "transfer" + ], + "query": [] + }, + "description": "# API Description\n\nFor the complete API documentation, please refer to [doc](https://www.kucoin.com/docs-new/api-3470293)\n\n:::info[Description]\nThis endpoint supports fund transfer between Broker account and Broker sub-accounts.\n\nPlease be aware that withdrawal from sub-account is not directly supported. Broker has to transfer funds from broker sub-account to broker account to initiate the withdrawals.\n:::\n# API Schema\n\n## Request Schema\n\n\n**Request Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| currency | string | Currency |\n| amount | string | Transfer Amount (must be a positive integer in the currency's precision) |\n| direction | string | Fund transfer direction: OUT (Broker account is transferred to Broker sub-account), IN (Broker sub-account is transferred to Broker account) |\n| accountType | string | Broker account types: MAIN (Funding account), TRADE (Spot trading account) |\n| specialUid | string | Broker subaccount uid, must be the Broker subaccount created by the current Broker user. |\n| specialAccountType | string | Broker sub-account types: MAIN (Funding account), TRADE (Spot trading account) |\n| clientOid | string | Client Order Id, The unique identifier created by the client. It is recommended to use UUID. The maximum length is 128 bits. |\n\n---\n## Response Schema\n\n\n**Response Body**\n\n---\n**root Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| code | string | |\n| data | object | Refer to the schema section of data |\n\n**root.data Schema**\n\n| name | type | description |\n| --- | --- | --- |\n| orderId | string | |\n\n---\n", + "body": { + "mode": "raw", + "raw": "{\n \"currency\": \"USDT\",\n \"amount\": \"1\",\n \"clientOid\": \"e6c24d23-6bc2-401b-bf9e-55e2daddfbc1\",\n \"direction\": \"OUT\",\n \"accountType\": \"MAIN\",\n \"specialUid\": \"226383154\",\n \"specialAccountType\": \"MAIN\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ + { + "name": "Successful Response", + "originalRequest": { + "method": "POST", + "header": [], + "url": { + "raw": "", + "protocol": "https", + "host": [ + "{{broker_endpoint}}" + ], + "path": [ + "api", + "v1", + "broker", + "nd", + "transfer" + ], + "query": [] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "gw-ratelimit-remaining", + "value": 1997, + "name": "gw-ratelimit-remaining" + }, + { + "key": "gw-ratelimit-limit", + "value": 2000, + "name": "gw-ratelimit-limit" + }, + { + "key": "gw-ratelimit-reset", + "value": 29990, + "name": "gw-ratelimit-reset" + } + ], + "cookie": [], + "body": "{\n \"code\": \"200000\",\n \"data\": {\n \"orderId\": \"671b4600c1e3dd000726866d\"\n }\n}" + } + ] + } + ], + "description": "" + } + ], + "description": "", + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "\nfunction extractPathVariable(str) {\n const regex = /^\\{\\{(.+?)\\}\\}$/;\n const match = str.match(regex);\n if (match) {\n return match[1];\n }\n return null;\n}\n\nfunction hasAnyFieldEmpty(obj) {\n for (const key in obj) {\n if (obj[key] === \"\" || obj[key] === null || obj[key] === undefined) {\n return true;\n }\n }\n return false;\n}\n\nfunction sign(text, secret) {\n const hash = CryptoJS.HmacSHA256(text, secret);\n return CryptoJS.enc.Base64.stringify(hash)\n}\n\nfunction auth(apiKey, method, url, data) {\n if (hasAnyFieldEmpty(apiKey)) {\n console.warn('The API key-related (or broker-related) information is not configured. Please check the fields in the environment variables.')\n return {'User-Agent': `Kucoin-Universal-Postman-SDK/`}\n }\n\n\n const timestamp = Date.now();\n const text = timestamp + method.toUpperCase() + url + data;\n const signature = sign(text, apiKey.secret);\n const brokerText = timestamp + apiKey.partner + apiKey.key;\n const brokerSignature = sign(brokerText, apiKey.brokerKey);\n return {\n 'KC-API-KEY': apiKey.key,\n 'KC-API-SIGN': signature,\n 'KC-API-TIMESTAMP': timestamp.toString(),\n 'KC-API-PASSPHRASE': sign(apiKey.passphrase || '', apiKey.secret),\n 'Content-Type': 'application/json',\n 'User-Agent': `Kucoin-Universal-Postman-SDK/`,\n 'KC-API-KEY-VERSION': 2,\n 'KC-API-PARTNER': apiKey.partner,\n 'KC-BROKER-NAME': apiKey.brokerName,\n 'KC-API-PARTNER-VERIFY': 'true',\n 'KC-API-PARTNER-SIGN': brokerSignature,\n };\n}\n\nlet key = pm.environment.get('API_KEY')\nlet secret = pm.environment.get('API_SECRET')\nlet passphrase = pm.environment.get('API_PASSPHRASE')\n\nlet brokerName = pm.environment.get('BROKER_NAME')\nlet partner = pm.environment.get('BROKER_PARTNER')\nlet brokerKey = pm.environment.get('BROKER_KEY')\n\nlet url = pm.request.url.getPathWithQuery()\nlet method = pm.request.method\nlet body = pm.request.body ? pm.request.body.toString() : ''\n\nfor (const index in pm.request.url.path) {\n path = pm.request.url.path[index]\n pathVar = extractPathVariable(path)\n if (pathVar != null) {\n let collectionVariable = pm.collectionVariables.get(pathVar);\n if (collectionVariable != null) {\n url = url.replace(path, collectionVariable)\n } else {\n console.warn('no path variable set: ' + path)\n }\n }\n}\n\nheader = auth({\n key: key, passphrase: passphrase, secret: secret, brokerName: brokerName, partner: partner, brokerKey: brokerKey\n}, method, url, body)\n\nfor (const [headerName, headerValue] of Object.entries(header)) {\n pm.request.headers.add({ key: headerName, value: headerValue })\n}" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + } + ] + } + ], + "variable": [ + { + "key": "accountId", + "value": "" + }, + { + "key": "clientOid", + "value": "" + }, + { + "key": "currency", + "value": "" + }, + { + "key": "order-id", + "value": "" + }, + { + "key": "orderId", + "value": "" + }, + { + "key": "size", + "value": "" + }, + { + "key": "subUserId", + "value": "" + }, + { + "key": "symbol", + "value": "" + }, + { + "key": "withdrawalId", + "value": "" + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "function extractPathVariable(str) {\n const regex = /^\\{\\{(.+?)\\}\\}$/;\n const match = str.match(regex);\n if (match) {\n return match[1];\n }\n return null;\n}\n\nfunction hasAnyFieldEmpty(obj) {\n for (const key in obj) {\n if (obj[key] === \"\" || obj[key] === null || obj[key] === undefined) {\n return true;\n }\n }\n return false;\n}\n\nfunction sign(text, secret) {\n const hash = CryptoJS.HmacSHA256(text, secret);\n return CryptoJS.enc.Base64.stringify(hash)\n}\n\nfunction auth(apiKey, method, url, data) {\n if (hasAnyFieldEmpty(apiKey)) {\n console.warn('The API key-related information is not configured; only the public channel API is accessible.')\n return {'User-Agent': `Kucoin-Universal-Postman-SDK/`}\n }\n\n const timestamp = Date.now();\n const text = timestamp + method.toUpperCase() + url + data;\n const signature = sign(text, apiKey.secret);\n return {\n 'KC-API-KEY': apiKey.key,\n 'KC-API-SIGN': signature,\n 'KC-API-TIMESTAMP': timestamp.toString(),\n 'KC-API-PASSPHRASE': sign(apiKey.passphrase || '', apiKey.secret),\n 'Content-Type': 'application/json',\n 'User-Agent': `Kucoin-Universal-Postman-SDK/`,\n 'KC-API-KEY-VERSION': 2,\n };\n}\n\nlet key = pm.environment.get('API_KEY')\nlet secret = pm.environment.get('API_SECRET')\nlet passphrase = pm.environment.get('API_PASSPHRASE')\n\nlet url = pm.request.url.getPathWithQuery()\nlet method = pm.request.method\nlet body = pm.request.body ? pm.request.body.toString() : ''\n\nfor (const index in pm.request.url.path) {\n path = pm.request.url.path[index]\n pathVar = extractPathVariable(path)\n if (pathVar != null) {\n let collectionVariable = pm.collectionVariables.get(pathVar);\n if (collectionVariable != null) {\n url = url.replace(path, collectionVariable)\n } else {\n console.warn('no path variable set: ' + path)\n }\n }\n}\n\nheader = auth({ key: key, passphrase: passphrase, secret: secret }, method, url, body)\n\nfor (const [headerName, headerValue] of Object.entries(header)) {\n pm.request.headers.add({ key: headerName, value: headerValue })\n}" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "packages": {}, + "exec": [ + "" + ] + } + } + ] +} \ No newline at end of file diff --git a/sdk/postman/env.json b/sdk/postman/env.json new file mode 100644 index 0000000..97ba483 --- /dev/null +++ b/sdk/postman/env.json @@ -0,0 +1,61 @@ +{ + "id": "0deee4de-080a-4246-a95d-3eee14126248", + "name": "KuCoin API Production", + "values": [ + { + "key": "spot_endpoint", + "value": "api.kucoin.com", + "type": "default", + "enable": true + }, + { + "key": "futures_endpoint", + "value": "api-futures.kucoin.com", + "type": "default", + "enable": true + }, + { + "key": "broker_endpoint", + "value": "api-broker.kucoin.com", + "type": "default", + "enable": true + }, + { + "key": "API_KEY", + "value": "", + "type": "secret", + "enabled": true + }, + { + "key": "API_SECRET", + "value": "", + "type": "secret", + "enabled": true + }, + { + "key": "API_PASSPHRASE", + "value": "", + "type": "secret", + "enabled": true + }, + { + "key": "BROKER_NAME", + "value": "", + "type": "secret", + "enabled": true + }, + { + "key": "BROKER_PARTNER", + "value": "", + "type": "secret", + "enabled": true + }, + { + "key": "BROKER_KEY", + "value": "", + "type": "secret", + "enabled": true + } + ], + "_postman_variable_scope": "environment" +} \ No newline at end of file diff --git a/sdk/postman/img/endpoints.png b/sdk/postman/img/endpoints.png new file mode 100644 index 0000000..ac2a44f Binary files /dev/null and b/sdk/postman/img/endpoints.png differ diff --git a/sdk/postman/img/env.png b/sdk/postman/img/env.png new file mode 100644 index 0000000..2431aad Binary files /dev/null and b/sdk/postman/img/env.png differ diff --git a/sdk/postman/img/overview.png b/sdk/postman/img/overview.png new file mode 100644 index 0000000..68c6009 Binary files /dev/null and b/sdk/postman/img/overview.png differ diff --git a/sdk/postman/img/response.png b/sdk/postman/img/response.png new file mode 100644 index 0000000..9d382d7 Binary files /dev/null and b/sdk/postman/img/response.png differ diff --git a/sdk/postman/img/send.png b/sdk/postman/img/send.png new file mode 100644 index 0000000..3282210 Binary files /dev/null and b/sdk/postman/img/send.png differ diff --git a/sdk/python/README.md b/sdk/python/README.md index fa8b726..5b97c19 100644 --- a/sdk/python/README.md +++ b/sdk/python/README.md @@ -7,12 +7,12 @@ Welcome to the **Python** implementation of the KuCoin Universal SDK. This SDK i For an overview of the project and SDKs in other languages, refer to the [Main README](https://github.com/kucoin/kucoin-universal-sdk). ## 📦 Installation -**Note:** This SDK is currently in the **Alpha phase**. We are actively iterating and improving its features, stability, and documentation. Feedback and contributions are highly encouraged to help us refine the SDK. +### Latest Version: `1.0.0` Install the Python SDK using `pip`: ```bash -pip install kucoin-universal-sdk==0.1.1a1 +pip install kucoin-universal-sdk ``` ## 📖 Getting Started diff --git a/sdk/python/kucoin_universal_sdk/generate/account/account/api_account.py b/sdk/python/kucoin_universal_sdk/generate/account/account/api_account.py index 639937d..1bc8c96 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/account/api_account.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/account/api_account.py @@ -40,6 +40,7 @@ def get_futures_account(self, req: GetFuturesAccountReq, """ summary: Get Account - Futures description: Request via this endpoint to get the info of the futures account. + documentation: https://www.kucoin.com/docs-new/api-3470129 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -58,6 +59,7 @@ def get_spot_account_detail(self, req: GetSpotAccountDetailReq, """ summary: Get Account Detail - Spot description: get Information for a single spot account. Use this endpoint when you know the accountId. + documentation: https://www.kucoin.com/docs-new/api-3470126 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -76,6 +78,7 @@ def get_spot_account_list(self, req: GetSpotAccountListReq, """ summary: Get Account List - Spot description: Get a list of accounts. Please Deposit to the main account firstly, then transfer the funds to the trade account via Inner Transfer before transaction. + documentation: https://www.kucoin.com/docs-new/api-3470125 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -94,6 +97,7 @@ def get_spot_ledger(self, req: GetSpotLedgerReq, """ summary: Get Account Ledgers - Spot/Margin description: This interface is for transaction records from all types of your accounts, supporting inquiry of various currencies. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page. + documentation: https://www.kucoin.com/docs-new/api-3470121 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -112,6 +116,7 @@ def get_spot_hf_ledger(self, req: GetSpotHfLedgerReq, """ summary: Get Account Ledgers - Trade_hf description: This API endpoint returns all transfer (in and out) records in high-frequency trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id. + documentation: https://www.kucoin.com/docs-new/api-3470122 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -129,6 +134,7 @@ def get_spot_account_type(self, **kwargs: Any) -> GetSpotAccountTypeResp: """ summary: Get Account Type - Spot description: This interface determines whether the current user is a spot high-frequency user or a spot low-frequency user. + documentation: https://www.kucoin.com/docs-new/api-3470120 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -149,6 +155,7 @@ def get_isolated_margin_account_detail_v1( """ summary: Get Account Detail - Isolated Margin - V1 description: Request via this endpoint to get the info of the isolated margin account. + documentation: https://www.kucoin.com/docs-new/api-3470315 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -169,6 +176,7 @@ def get_isolated_margin_account_list_v1( """ summary: Get Account List - Isolated Margin - V1 description: Request via this endpoint to get the info list of the isolated margin account. + documentation: https://www.kucoin.com/docs-new/api-3470314 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -188,6 +196,7 @@ def get_margin_account_detail(self, """ summary: Get Account Detail - Margin description: Request via this endpoint to get the info of the margin account. + documentation: https://www.kucoin.com/docs-new/api-3470311 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -206,6 +215,7 @@ def get_futures_ledger(self, req: GetFuturesLedgerReq, """ summary: Get Account Ledgers - Futures description: This interface can query the ledger records of the futures business line + documentation: https://www.kucoin.com/docs-new/api-3470124 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -221,8 +231,9 @@ def get_futures_ledger(self, req: GetFuturesLedgerReq, @abstractmethod def get_apikey_info(self, **kwargs: Any) -> GetApikeyInfoResp: """ - summary: Get API Key Info + summary: Get Apikey Info description: Get the information of the api key. Use the api key pending to be checked to call the endpoint. Both master and sub user's api key are applicable. + documentation: https://www.kucoin.com/docs-new/api-3470130 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -240,6 +251,7 @@ def get_account_info(self, **kwargs: Any) -> GetAccountInfoResp: """ summary: Get Account Summary Info description: This endpoint can be used to obtain account summary information. + documentation: https://www.kucoin.com/docs-new/api-3470119 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -258,6 +270,7 @@ def get_margin_hf_ledger(self, req: GetMarginHfLedgerReq, """ summary: Get Account Ledgers - Margin_hf description: This API endpoint returns all transfer (in and out) records in high-frequency margin trading account and supports multi-coin queries. The query results are sorted in descending order by createdAt and id. + documentation: https://www.kucoin.com/docs-new/api-3470123 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -277,6 +290,7 @@ def get_isolated_margin_account( """ summary: Get Account - Isolated Margin description: Request via this endpoint to get the info of the isolated margin account. + documentation: https://www.kucoin.com/docs-new/api-3470128 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -295,6 +309,7 @@ def get_cross_margin_account(self, req: GetCrossMarginAccountReq, """ summary: Get Account - Cross Margin description: Request via this endpoint to get the info of the cross margin account. + documentation: https://www.kucoin.com/docs-new/api-3470127 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/account/account/api_account.template b/sdk/python/kucoin_universal_sdk/generate/account/account/api_account.template index 8bfb169..2eb462f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/account/api_account.template +++ b/sdk/python/kucoin_universal_sdk/generate/account/account/api_account.template @@ -188,7 +188,7 @@ def test_get_futures_ledger_req(self): def test_get_apikey_info_req(self): """ get_apikey_info - Get API Key Info + Get Apikey Info /api/v1/user/api-key """ diff --git a/sdk/python/kucoin_universal_sdk/generate/account/account/api_account_test.py b/sdk/python/kucoin_universal_sdk/generate/account/account/api_account_test.py index 070fa6c..214e529 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/account/api_account_test.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/account/api_account_test.py @@ -103,7 +103,7 @@ def test_get_spot_ledger_resp_model(self): Get Account Ledgers - Spot/Margin /api/v1/accounts/ledgers """ - data = "{\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\": \"\u5b50\u8d26\u53f7\u8f6c\u8d26\",\n \"direction\": \"out\",\n \"createdAt\": 1728658481484,\n \"context\": \"\"\n }\n ]\n }\n}" + data = "{\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}" common_response = RestResponse.from_json(data) resp = GetSpotLedgerResp.from_dict(common_response.data) @@ -222,14 +222,14 @@ def test_get_futures_ledger_resp_model(self): def test_get_apikey_info_req_model(self): """ get_apikey_info - Get API Key Info + Get Apikey Info /api/v1/user/api-key """ def test_get_apikey_info_resp_model(self): """ get_apikey_info - Get API Key Info + Get Apikey Info /api/v1/user/api-key """ data = "{\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}" diff --git a/sdk/python/kucoin_universal_sdk/generate/account/account/model_get_apikey_info_resp.py b/sdk/python/kucoin_universal_sdk/generate/account/account/model_get_apikey_info_resp.py index 5249b36..d26b63f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/account/model_get_apikey_info_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/account/model_get_apikey_info_resp.py @@ -20,7 +20,7 @@ class GetApikeyInfoResp(BaseModel, Response): remark (str): Remarks api_key (str): Apikey api_version (int): API Version - permission (str): [Permissions](doc://link/pages/338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn + permission (str): [Permissions](https://www.kucoin.com/docs-new/doc-338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn ip_whitelist (str): IP whitelist created_at (int): Apikey create time uid (int): Account UID @@ -40,7 +40,7 @@ class GetApikeyInfoResp(BaseModel, Response): permission: Optional[str] = Field( default=None, description= - "[Permissions](doc://link/pages/338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn" + "[Permissions](https://www.kucoin.com/docs-new/doc-338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn" ) ip_whitelist: Optional[str] = Field(default=None, description="IP whitelist ", diff --git a/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit.py b/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit.py index 4ae5f49..e100ba1 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit.py @@ -29,6 +29,7 @@ def get_deposit_address_v1(self, req: GetDepositAddressV1Req, """ summary: Get Deposit Addresses - V1 description: Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first. + documentation: https://www.kucoin.com/docs-new/api-3470305 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -48,6 +49,7 @@ def add_deposit_address_v1(self, req: AddDepositAddressV1Req, """ summary: Add Deposit Address - V1 description: Request via this endpoint to create a deposit address for a currency you intend to deposit. + documentation: https://www.kucoin.com/docs-new/api-3470309 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -66,6 +68,7 @@ def get_deposit_history(self, req: GetDepositHistoryReq, """ summary: Get Deposit History description: Request via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page. + documentation: https://www.kucoin.com/docs-new/api-3470141 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -85,6 +88,7 @@ def get_deposit_history_old(self, req: GetDepositHistoryOldReq, """ summary: Get Deposit History - Old description: Request via this endpoint to get the V1 historical deposits list on KuCoin. The return value is the data after Pagination, sorted in descending order according to time. + documentation: https://www.kucoin.com/docs-new/api-3470306 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -104,6 +108,7 @@ def get_deposit_address_v2(self, req: GetDepositAddressV2Req, """ summary: Get Deposit Addresses(V2) description: Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first. + documentation: https://www.kucoin.com/docs-new/api-3470300 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -122,6 +127,7 @@ def add_deposit_address_v3(self, req: AddDepositAddressV3Req, """ summary: Add Deposit Address(V3) description: Request via this endpoint to create a deposit address for a currency you intend to deposit. + documentation: https://www.kucoin.com/docs-new/api-3470142 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -138,8 +144,9 @@ def add_deposit_address_v3(self, req: AddDepositAddressV3Req, def get_deposit_address_v3(self, req: GetDepositAddressV3Req, **kwargs: Any) -> GetDepositAddressV3Resp: """ - summary: Get Deposit Addresses(V3) + summary: Get Deposit Address(V3) description: Get all deposit addresses for the currency you intend to deposit. If the returned data is empty, you may need to Add Deposit Address first. + documentation: https://www.kucoin.com/docs-new/api-3470140 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit.template b/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit.template index db9da05..cd98ad4 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit.template +++ b/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit.template @@ -118,7 +118,7 @@ def test_add_deposit_address_v3_req(self): def test_get_deposit_address_v3_req(self): """ get_deposit_address_v3 - Get Deposit Addresses(V3) + Get Deposit Address(V3) /api/v3/deposit-addresses """ diff --git a/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit_test.py b/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit_test.py index bd91faf..8b3a6d0 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit_test.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/deposit/api_deposit_test.py @@ -136,7 +136,7 @@ def test_add_deposit_address_v3_resp_model(self): def test_get_deposit_address_v3_req_model(self): """ get_deposit_address_v3 - Get Deposit Addresses(V3) + Get Deposit Address(V3) /api/v3/deposit-addresses """ data = "{\"currency\": \"BTC\", \"amount\": \"example_string_default_value\", \"chain\": \"example_string_default_value\"}" @@ -145,7 +145,7 @@ def test_get_deposit_address_v3_req_model(self): def test_get_deposit_address_v3_resp_model(self): """ get_deposit_address_v3 - Get Deposit Addresses(V3) + Get Deposit Address(V3) /api/v3/deposit-addresses """ data = "{\"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\"}]}" diff --git a/sdk/python/kucoin_universal_sdk/generate/account/fee/api_fee.py b/sdk/python/kucoin_universal_sdk/generate/account/fee/api_fee.py index 03fc693..dd7d771 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/fee/api_fee.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/fee/api_fee.py @@ -19,6 +19,7 @@ def get_basic_fee(self, req: GetBasicFeeReq, """ summary: Get Basic Fee - Spot/Margin description: This interface is for the spot/margin basic fee rate of users + documentation: https://www.kucoin.com/docs-new/api-3470149 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -37,6 +38,7 @@ def get_spot_actual_fee(self, req: GetSpotActualFeeReq, """ summary: Get Actual Fee - Spot/Margin description: This interface is for the actual fee rate of the trading pair. You can inquire about fee rates of 10 trading pairs each time at most. The fee rate of your sub-account is the same as that of the master account. + documentation: https://www.kucoin.com/docs-new/api-3470150 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -55,6 +57,7 @@ def get_futures_actual_fee(self, req: GetFuturesActualFeeReq, """ summary: Get Actual Fee - Futures description: This interface is for the actual futures fee rate of the trading pair. The fee rate of your sub-account is the same as that of the master account. + documentation: https://www.kucoin.com/docs-new/api-3470151 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/api_sub_account.py b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/api_sub_account.py index eaed240..c793b53 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/api_sub_account.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/api_sub_account.py @@ -39,6 +39,7 @@ def get_futures_sub_account_list_v2( """ summary: Get SubAccount List - Futures Balance(V2) description: This endpoint can be used to get Futures sub-account information. + documentation: https://www.kucoin.com/docs-new/api-3470134 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -58,6 +59,7 @@ def get_spot_sub_account_list_v1( """ summary: Get SubAccount List - Spot Balance(V1) description: This endpoint returns the account info of all sub-users. + documentation: https://www.kucoin.com/docs-new/api-3470299 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -77,6 +79,7 @@ def get_spot_sub_account_detail( """ summary: Get SubAccount Detail - Balance description: This endpoint returns the account info of a sub-user specified by the subUserId. + documentation: https://www.kucoin.com/docs-new/api-3470132 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -95,6 +98,7 @@ def delete_sub_account_api(self, req: DeleteSubAccountApiReq, """ summary: Delete SubAccount API description: This endpoint can be used to delete sub-account APIs. + documentation: https://www.kucoin.com/docs-new/api-3470137 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -113,6 +117,7 @@ def get_sub_account_api_list(self, req: GetSubAccountApiListReq, """ summary: Get SubAccount API List description: This endpoint can be used to obtain a list of APIs pertaining to a sub-account.(Not contain ND Broker Sub Account) + documentation: https://www.kucoin.com/docs-new/api-3470136 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -131,6 +136,7 @@ def add_sub_account_api(self, req: AddSubAccountApiReq, """ summary: Add SubAccount API description: This endpoint can be used to create APIs for sub-accounts. + documentation: https://www.kucoin.com/docs-new/api-3470138 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -149,6 +155,7 @@ def modify_sub_account_api(self, req: ModifySubAccountApiReq, """ summary: Modify SubAccount API description: This endpoint can be used to modify sub-account APIs. + documentation: https://www.kucoin.com/docs-new/api-3470139 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -168,6 +175,7 @@ def get_spot_sub_accounts_summary_v1( """ summary: Get SubAccount List - Summary Info(V1) 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 + documentation: https://www.kucoin.com/docs-new/api-3470298 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -187,6 +195,7 @@ def get_spot_sub_account_list_v2( """ summary: Get SubAccount List - Spot Balance(V2) description: This endpoint can be used to get paginated Spot sub-account information. Pagination is required. + documentation: https://www.kucoin.com/docs-new/api-3470133 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -205,6 +214,7 @@ def add_sub_account(self, req: AddSubAccountReq, """ summary: Add SubAccount description: This endpoint can be used to create sub-accounts. + documentation: https://www.kucoin.com/docs-new/api-3470135 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -224,6 +234,7 @@ def get_spot_sub_accounts_summary_v2( """ summary: Get SubAccount List - Summary Info description: This endpoint can be used to get a paginated list of sub-accounts. Pagination is required. + documentation: https://www.kucoin.com/docs-new/api-3470131 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -243,6 +254,7 @@ def add_sub_account_futures_permission( """ summary: Add SubAccount Futures Permission description: This endpoint can be used to add sub-accounts Futures permission. Before using this endpoints, you need to ensure that the master account apikey has Futures permissions and the Futures function has been activated. + documentation: https://www.kucoin.com/docs-new/api-3470332 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -262,6 +274,7 @@ def add_sub_account_margin_permission( """ summary: Add SubAccount Margin Permission description: This endpoint can be used to add sub-accounts Margin permission. Before using this endpoints, you need to ensure that the master account apikey has Margin permissions and the Margin function has been activated. + documentation: https://www.kucoin.com/docs-new/api-3470331 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_add_sub_account_api_req.py b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_add_sub_account_api_req.py index 8826b3c..c119243 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_add_sub_account_api_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_add_sub_account_api_req.py @@ -18,7 +18,7 @@ class AddSubAccountApiReq(BaseModel): Attributes: passphrase (str): Password(Must contain 7-32 characters. Cannot contain any spaces.) remark (str): Remarks(1~24 characters) - permission (str): [Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\") + permission (str): [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\") ip_whitelist (str): IP whitelist(You may add up to 20 IPs. Use a halfwidth comma to each IP) expire (ExpireEnum): API expiration time; Never expire(default)-1，30Day30，90Day90，180Day180，360Day360 sub_name (str): Sub-account name, create sub account name of API Key. @@ -48,7 +48,7 @@ class ExpireEnum(Enum): permission: Optional[str] = Field( default='General', description= - "[Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")" + "[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\")" ) ip_whitelist: Optional[str] = Field( default=None, @@ -143,7 +143,7 @@ def set_remark(self, value: str) -> AddSubAccountApiReqBuilder: def set_permission(self, value: str) -> AddSubAccountApiReqBuilder: """ - [Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\") + [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\") """ self.obj['permission'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_add_sub_account_api_resp.py b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_add_sub_account_api_resp.py index c172ad2..fc5b20e 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_add_sub_account_api_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_add_sub_account_api_resp.py @@ -23,7 +23,7 @@ class AddSubAccountApiResp(BaseModel, Response): api_secret (str): API Secret Key api_version (int): API Version passphrase (str): Password - permission (str): [Permissions](doc://link/pages/338144) + permission (str): [Permissions](https://www.kucoin.com/docs-new/doc-338144) ip_whitelist (str): IP whitelist created_at (int): Time of the event """ @@ -45,7 +45,9 @@ class AddSubAccountApiResp(BaseModel, Response): alias="apiVersion") passphrase: Optional[str] = Field(default=None, description="Password") permission: Optional[str] = Field( - default=None, description="[Permissions](doc://link/pages/338144)") + default=None, + description="[Permissions](https://www.kucoin.com/docs-new/doc-338144)" + ) ip_whitelist: Optional[str] = Field(default=None, description="IP whitelist", alias="ipWhitelist") diff --git a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_get_sub_account_api_list_data.py b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_get_sub_account_api_list_data.py index d374db3..c8a7a47 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_get_sub_account_api_list_data.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_get_sub_account_api_list_data.py @@ -19,7 +19,7 @@ class GetSubAccountApiListData(BaseModel): remark (str): Remarks api_key (str): API Key api_version (int): API Version - permission (str): [Permissions](doc://link/pages/338144) + permission (str): [Permissions](https://www.kucoin.com/docs-new/doc-338144) ip_whitelist (str): IP whitelist created_at (int): Apikey create time uid (int): Sub-account UID @@ -37,7 +37,9 @@ class GetSubAccountApiListData(BaseModel): description="API Version", alias="apiVersion") permission: Optional[str] = Field( - default=None, description="[Permissions](doc://link/pages/338144)") + default=None, + description="[Permissions](https://www.kucoin.com/docs-new/doc-338144)" + ) ip_whitelist: Optional[str] = Field(default=None, description="IP whitelist", alias="ipWhitelist") diff --git a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_modify_sub_account_api_req.py b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_modify_sub_account_api_req.py index 98eef14..4f4c43b 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_modify_sub_account_api_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_modify_sub_account_api_req.py @@ -17,7 +17,7 @@ class ModifySubAccountApiReq(BaseModel): Attributes: passphrase (str): Password(Must contain 7-32 characters. Cannot contain any spaces.) - permission (str): [Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\") + permission (str): [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\") ip_whitelist (str): IP whitelist(You may add up to 20 IPs. Use a halfwidth comma to each IP) expire (ExpireEnum): API expiration time; Never expire(default)-1，30Day30，90Day90，180Day180，360Day360 sub_name (str): Sub-account name, create sub account name of API Key. @@ -46,7 +46,7 @@ class ExpireEnum(Enum): permission: Optional[str] = Field( default='General', description= - "[Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")" + "[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\")" ) ip_whitelist: Optional[str] = Field( default=None, @@ -137,7 +137,7 @@ def set_passphrase(self, value: str) -> ModifySubAccountApiReqBuilder: def set_permission(self, value: str) -> ModifySubAccountApiReqBuilder: """ - [Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\") + [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\") """ self.obj['permission'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_modify_sub_account_api_resp.py b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_modify_sub_account_api_resp.py index 8c458fd..9a0a966 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_modify_sub_account_api_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/subaccount/model_modify_sub_account_api_resp.py @@ -19,7 +19,7 @@ class ModifySubAccountApiResp(BaseModel, Response): Attributes: sub_name (str): Sub-account name api_key (str): API Key - permission (str): [Permissions](doc://link/pages/338144) + permission (str): [Permissions](https://www.kucoin.com/docs-new/doc-338144) ip_whitelist (str): IP whitelist """ @@ -32,7 +32,9 @@ class ModifySubAccountApiResp(BaseModel, Response): description="API Key", alias="apiKey") permission: Optional[str] = Field( - default=None, description="[Permissions](doc://link/pages/338144)") + default=None, + description="[Permissions](https://www.kucoin.com/docs-new/doc-338144)" + ) ip_whitelist: Optional[str] = Field(default=None, description="IP whitelist", alias="ipWhitelist") diff --git a/sdk/python/kucoin_universal_sdk/generate/account/transfer/api_transfer.py b/sdk/python/kucoin_universal_sdk/generate/account/transfer/api_transfer.py index 5708e7f..7a56534 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/transfer/api_transfer.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/transfer/api_transfer.py @@ -28,6 +28,7 @@ def get_transfer_quotas(self, req: GetTransferQuotasReq, """ summary: Get Transfer Quotas description: This endpoint returns the transferable balance of a specified account. + documentation: https://www.kucoin.com/docs-new/api-3470148 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -48,6 +49,7 @@ def futures_account_transfer_in( """ summary: Futures Account Transfer In 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. + documentation: https://www.kucoin.com/docs-new/api-3470304 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -68,6 +70,7 @@ def get_futures_account_transfer_out_ledger( """ summary: Get Futures Account Transfer Out Ledger description: This endpoint can get futures account transfer out ledger + documentation: https://www.kucoin.com/docs-new/api-3470307 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -87,6 +90,7 @@ def inner_transfer(self, req: InnerTransferReq, """ summary: Inner Transfer description: This API endpoint can be used to transfer funds between accounts internally. Users can transfer funds between their account free of charge. + documentation: https://www.kucoin.com/docs-new/api-3470302 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -106,6 +110,7 @@ def sub_account_transfer(self, req: SubAccountTransferReq, """ summary: SubAccount Transfer 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. + documentation: https://www.kucoin.com/docs-new/api-3470301 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -124,6 +129,7 @@ def flex_transfer(self, req: FlexTransferReq, """ summary: Flex Transfer description: This interface can be used for transfers between master and sub accounts and inner transfers + documentation: https://www.kucoin.com/docs-new/api-3470147 +---------------------+---------------+ | Extra API Info | Value | +---------------------+---------------+ @@ -144,6 +150,7 @@ def futures_account_transfer_out( """ summary: Futures Account Transfer Out 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. + documentation: https://www.kucoin.com/docs-new/api-3470303 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/account/withdrawal/api_withdrawal.py b/sdk/python/kucoin_universal_sdk/generate/account/withdrawal/api_withdrawal.py index 0658df1..fd0f1e7 100644 --- a/sdk/python/kucoin_universal_sdk/generate/account/withdrawal/api_withdrawal.py +++ b/sdk/python/kucoin_universal_sdk/generate/account/withdrawal/api_withdrawal.py @@ -28,6 +28,7 @@ def get_withdrawal_history_old( """ summary: Get Withdrawal History - Old description: Request via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page. + documentation: https://www.kucoin.com/docs-new/api-3470308 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -46,6 +47,7 @@ def get_withdrawal_history(self, req: GetWithdrawalHistoryReq, """ summary: Get Withdrawal History description: Request via this endpoint to get deposit list Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page. + documentation: https://www.kucoin.com/docs-new/api-3470145 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -65,6 +67,7 @@ def withdrawal_v1(self, req: WithdrawalV1Req, """ summary: Withdraw - V1 description: Use this interface to withdraw the specified currency + documentation: https://www.kucoin.com/docs-new/api-3470310 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -83,6 +86,7 @@ def get_withdrawal_quotas(self, req: GetWithdrawalQuotasReq, """ summary: Get Withdrawal Quotas description: This interface can obtain the withdrawal quotas information of this currency. + documentation: https://www.kucoin.com/docs-new/api-3470143 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -101,6 +105,7 @@ def cancel_withdrawal(self, req: CancelWithdrawalReq, """ summary: Cancel Withdrawal description: This interface can cancel the withdrawal, Only withdrawals requests of PROCESSING status could be canceled. + documentation: https://www.kucoin.com/docs-new/api-3470144 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -119,6 +124,7 @@ def withdrawal_v3(self, req: WithdrawalV3Req, """ summary: Withdraw(V3) description: Use this interface to withdraw the specified currency + documentation: https://www.kucoin.com/docs-new/api-3470146 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/affiliate/affiliate/api_affiliate.py b/sdk/python/kucoin_universal_sdk/generate/affiliate/affiliate/api_affiliate.py index 13c7fcc..920bb4b 100644 --- a/sdk/python/kucoin_universal_sdk/generate/affiliate/affiliate/api_affiliate.py +++ b/sdk/python/kucoin_universal_sdk/generate/affiliate/affiliate/api_affiliate.py @@ -13,6 +13,7 @@ def get_account(self, **kwargs: Any) -> GetAccountResp: """ summary: Get Account description: This endpoint allows getting affiliate user rebate information. + documentation: https://www.kucoin.com/docs-new/api-3470279 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/broker/apibroker/api_api_broker.py b/sdk/python/kucoin_universal_sdk/generate/broker/apibroker/api_api_broker.py index 96a85e4..d30bfa5 100644 --- a/sdk/python/kucoin_universal_sdk/generate/broker/apibroker/api_api_broker.py +++ b/sdk/python/kucoin_universal_sdk/generate/broker/apibroker/api_api_broker.py @@ -14,6 +14,7 @@ def get_rebase(self, req: GetRebaseReq, **kwargs: Any) -> GetRebaseResp: """ summary: Get Broker Rebate description: This interface supports downloading Broker rebate orders + documentation: https://www.kucoin.com/docs-new/api-3470280 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/api_nd_broker.py b/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/api_nd_broker.py index 62643bd..809ea8c 100644 --- a/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/api_nd_broker.py +++ b/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/api_nd_broker.py @@ -39,6 +39,7 @@ def get_deposit_list(self, req: GetDepositListReq, """ summary: Get Deposit List description: This endpoint can obtain the deposit records of each sub-account under the ND Broker. + documentation: https://www.kucoin.com/docs-new/api-3470285 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -57,6 +58,7 @@ def delete_sub_account_api(self, req: DeleteSubAccountApiReq, """ summary: Delete SubAccount API description: This interface supports deleting Broker’s sub-account APIKEY + documentation: https://www.kucoin.com/docs-new/api-3470289 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -75,6 +77,7 @@ def get_sub_account_api(self, req: GetSubAccountApiReq, """ summary: Get SubAccount API description: This interface supports querying the Broker’s sub-account APIKEY + documentation: https://www.kucoin.com/docs-new/api-3470284 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -93,6 +96,7 @@ def add_sub_account_api(self, req: AddSubAccountApiReq, """ summary: Add SubAccount API description: This interface supports the creation of Broker sub-account APIKEY + documentation: https://www.kucoin.com/docs-new/api-3470291 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -111,6 +115,7 @@ def get_sub_account(self, req: GetSubAccountReq, """ summary: Get SubAccount description: This interface supports querying sub-accounts created by Broker + documentation: https://www.kucoin.com/docs-new/api-3470283 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -129,6 +134,7 @@ def add_sub_account(self, req: AddSubAccountReq, """ summary: Add SubAccount description: This endpoint supports Broker users to create sub-accounts + documentation: https://www.kucoin.com/docs-new/api-3470290 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -147,6 +153,7 @@ def modify_sub_account_api(self, req: ModifySubAccountApiReq, """ summary: Modify SubAccount API description: This interface supports modify the Broker’s sub-account APIKEY + documentation: https://www.kucoin.com/docs-new/api-3470292 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -165,6 +172,7 @@ def get_broker_info(self, req: GetBrokerInfoReq, """ summary: Get Broker Info description: This endpoint supports querying the basic information of the current Broker + documentation: https://www.kucoin.com/docs-new/api-3470282 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -182,6 +190,7 @@ def get_rebase(self, req: GetRebaseReq, **kwargs: Any) -> GetRebaseResp: """ summary: Get Broker Rebate description: This interface supports downloading Broker rebate orders + documentation: https://www.kucoin.com/docs-new/api-3470281 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -199,6 +208,7 @@ def transfer(self, req: TransferReq, **kwargs: Any) -> TransferResp: """ summary: Transfer description: This endpoint supports fund transfer between Broker account and Broker sub-accounts. Please be aware that withdrawal from sub-account is not directly supported. Broker has to transfer funds from broker sub-account to broker account to initiate the withdrawals. + documentation: https://www.kucoin.com/docs-new/api-3470293 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -217,6 +227,7 @@ def get_deposit_detail(self, req: GetDepositDetailReq, """ summary: Get Deposit Detail description: This endpoint supports querying the deposit record of sub-accounts created by a Broker (excluding main account of nd broker) + documentation: https://www.kucoin.com/docs-new/api-3470288 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -235,6 +246,7 @@ def get_transfer_history(self, req: GetTransferHistoryReq, """ summary: Get Transfer History description: This endpoint supports querying transfer records of the broker itself and its created sub-accounts. + documentation: https://www.kucoin.com/docs-new/api-3470286 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -253,6 +265,7 @@ def get_withdraw_detail(self, req: GetWithdrawDetailReq, """ summary: Get Withdraw Detail description: This endpoint supports querying the withdrawal records of sub-accounts created by a Broker (excluding main account of nd broker). + documentation: https://www.kucoin.com/docs-new/api-3470287 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_add_sub_account_api_resp.py b/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_add_sub_account_api_resp.py index 61f0047..e57e877 100644 --- a/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_add_sub_account_api_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_add_sub_account_api_resp.py @@ -22,7 +22,7 @@ class AddSubAccountApiResp(BaseModel, Response): api_key (str): apiKey secret_key (str): secretKey api_version (int): apiVersion - permissions (list[str]): [Permissions](doc://link/pages/338144) group list + permissions (list[str]): [Permissions](https://www.kucoin.com/docs-new/doc-338144) group list ip_whitelist (list[str]): IP whitelist list created_at (int): Creation time, unix timestamp (milliseconds) """ @@ -42,7 +42,8 @@ class AddSubAccountApiResp(BaseModel, Response): alias="apiVersion") permissions: Optional[List[str]] = Field( default=None, - description="[Permissions](doc://link/pages/338144) group list") + description= + "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list") ip_whitelist: Optional[List[str]] = Field(default=None, description="IP whitelist list", alias="ipWhitelist") diff --git a/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_get_sub_account_api_data.py b/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_get_sub_account_api_data.py index eecf7e1..537848a 100644 --- a/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_get_sub_account_api_data.py +++ b/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_get_sub_account_api_data.py @@ -20,7 +20,7 @@ class GetSubAccountApiData(BaseModel): label (str): apikey remarks api_key (str): apiKey api_version (int): apiVersion - permissions (list[PermissionsEnum]): [Permissions](doc://link/pages/338144) group list + permissions (list[PermissionsEnum]): [Permissions](https://www.kucoin.com/docs-new/doc-338144) group list ip_whitelist (list[str]): IP whitelist list created_at (int): Creation time, unix timestamp (milliseconds) """ @@ -46,7 +46,8 @@ class PermissionsEnum(Enum): alias="apiVersion") permissions: Optional[List[PermissionsEnum]] = Field( default=None, - description="[Permissions](doc://link/pages/338144) group list") + description= + "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list") ip_whitelist: Optional[List[str]] = Field(default=None, description="IP whitelist list", alias="ipWhitelist") diff --git a/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_modify_sub_account_api_req.py b/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_modify_sub_account_api_req.py index ee96576..8a1d705 100644 --- a/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_modify_sub_account_api_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_modify_sub_account_api_req.py @@ -18,7 +18,7 @@ class ModifySubAccountApiReq(BaseModel): Attributes: uid (str): Subaccount UID ip_whitelist (list[str]): IP whitelist list, supports up to 20 IPs - permissions (list[PermissionsEnum]): [Permissions](doc://link/pages/338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". ) + permissions (list[PermissionsEnum]): [Permissions](https://www.kucoin.com/docs-new/doc-338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". ) label (str): apikey remarks (length 4~32) api_key (str): Subaccount apiKey """ @@ -42,7 +42,7 @@ class PermissionsEnum(Enum): permissions: Optional[List[PermissionsEnum]] = Field( default=None, description= - "[Permissions](doc://link/pages/338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". ) " + "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". ) " ) label: Optional[str] = Field(default=None, description="apikey remarks (length 4~32) ") @@ -121,7 +121,7 @@ def set_permissions( self, value: list[ModifySubAccountApiReq.PermissionsEnum] ) -> ModifySubAccountApiReqBuilder: """ - [Permissions](doc://link/pages/338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". ) + [Permissions](https://www.kucoin.com/docs-new/doc-338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". ) """ self.obj['permissions'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_modify_sub_account_api_resp.py b/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_modify_sub_account_api_resp.py index 40e8895..1f06f91 100644 --- a/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_modify_sub_account_api_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/broker/ndbroker/model_modify_sub_account_api_resp.py @@ -21,7 +21,7 @@ class ModifySubAccountApiResp(BaseModel, Response): label (str): apikey remarks api_key (str): apiKey api_version (int): apiVersion - permissions (list[str]): [Permissions](doc://link/pages/338144) group list + permissions (list[str]): [Permissions](https://www.kucoin.com/docs-new/doc-338144) group list ip_whitelist (list[str]): IP whitelist list created_at (int): Creation time, unix timestamp (milliseconds) """ @@ -38,7 +38,8 @@ class ModifySubAccountApiResp(BaseModel, Response): alias="apiVersion") permissions: Optional[List[str]] = Field( default=None, - description="[Permissions](doc://link/pages/338144) group list") + description= + "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list") ip_whitelist: Optional[List[str]] = Field(default=None, description="IP whitelist list", alias="ipWhitelist") diff --git a/sdk/python/kucoin_universal_sdk/generate/earn/earn/api_earn.py b/sdk/python/kucoin_universal_sdk/generate/earn/earn/api_earn.py index 84e80b7..fbc8579 100644 --- a/sdk/python/kucoin_universal_sdk/generate/earn/earn/api_earn.py +++ b/sdk/python/kucoin_universal_sdk/generate/earn/earn/api_earn.py @@ -31,6 +31,7 @@ def get_eth_staking_products(self, req: GetEthStakingProductsReq, """ summary: Get ETH Staking Products description: This endpoint can get available ETH staking products. If no products are available, an empty list is returned. + documentation: https://www.kucoin.com/docs-new/api-3470276 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -49,6 +50,7 @@ def get_account_holding(self, req: GetAccountHoldingReq, """ summary: Get Account Holding description: This endpoint can get current holding assets information. If no current holding assets are available, an empty list is returned. + documentation: https://www.kucoin.com/docs-new/api-3470273 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -67,6 +69,7 @@ def get_kcs_staking_products(self, req: GetKcsStakingProductsReq, """ summary: Get KCS Staking Products description: This endpoint can get available KCS staking products. If no products are available, an empty list is returned. + documentation: https://www.kucoin.com/docs-new/api-3470275 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -84,6 +87,7 @@ def redeem(self, req: RedeemReq, **kwargs: Any) -> RedeemResp: """ summary: Redeem description: This endpoint allows initiating redemption by holding ID. If the current holding is fully redeemed or in the process of being redeemed, it indicates that the holding does not exist. + documentation: https://www.kucoin.com/docs-new/api-3470270 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -101,6 +105,7 @@ def purchase(self, req: PurchaseReq, **kwargs: Any) -> PurchaseResp: """ summary: purchase description: This endpoint allows subscribing earn product + documentation: https://www.kucoin.com/docs-new/api-3470268 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -119,6 +124,7 @@ def get_promotion_products(self, req: GetPromotionProductsReq, """ summary: Get Promotion Products description: This endpoint can get available limited-time promotion products. If no products are available, an empty list is returned. + documentation: https://www.kucoin.com/docs-new/api-3470272 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -137,6 +143,7 @@ def get_redeem_preview(self, req: GetRedeemPreviewReq, """ summary: Get Redeem Preview description: This endpoint allows subscribing earn products + documentation: https://www.kucoin.com/docs-new/api-3470269 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -155,6 +162,7 @@ def get_savings_products(self, req: GetSavingsProductsReq, """ summary: Get Savings Products description: This endpoint can get available savings products. If no products are available, an empty list is returned. + documentation: https://www.kucoin.com/docs-new/api-3470271 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -173,6 +181,7 @@ def get_staking_products(self, req: GetStakingProductsReq, """ summary: Get Staking Products description: This endpoint can get available staking products. If no products are available, an empty list is returned. + documentation: https://www.kucoin.com/docs-new/api-3470274 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/api_funding_fees.py b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/api_funding_fees.py index e94bbb1..d3f1612 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/api_funding_fees.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/api_funding_fees.py @@ -20,6 +20,7 @@ def get_public_funding_history( """ summary: Get Public Funding History description: Query the funding rate at each settlement time point within a certain time range of the corresponding contract + documentation: https://www.kucoin.com/docs-new/api-3470266 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -39,6 +40,7 @@ def get_private_funding_history( """ summary: Get Private Funding History description: Submit request to get the funding history. + documentation: https://www.kucoin.com/docs-new/api-3470267 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -57,6 +59,7 @@ def get_current_funding_rate(self, req: GetCurrentFundingRateReq, """ summary: Get Current Funding Rate description: get Current Funding Rate + documentation: https://www.kucoin.com/docs-new/api-3470265 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_current_funding_rate_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_current_funding_rate_req.py index 09fcb84..7521ecf 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_current_funding_rate_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_current_funding_rate_req.py @@ -15,14 +15,14 @@ class GetCurrentFundingRateReq(BaseModel): GetCurrentFundingRateReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, path_variable="True", description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -72,7 +72,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetCurrentFundingRateReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_private_funding_history_data_list.py b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_private_funding_history_data_list.py index f60df1e..1a6d582 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_private_funding_history_data_list.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_private_funding_history_data_list.py @@ -17,7 +17,7 @@ class GetPrivateFundingHistoryDataList(BaseModel): Attributes: id (int): id - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) time_point (int): Time point (milisecond) funding_rate (float): Funding rate mark_price (float): Mark price @@ -42,7 +42,7 @@ class MarginModeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) time_point: Optional[int] = Field(default=None, description="Time point (milisecond) ", diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_private_funding_history_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_private_funding_history_req.py index ffe2f77..3f9be0a 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_private_funding_history_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_private_funding_history_req.py @@ -15,7 +15,7 @@ class GetPrivateFundingHistoryReq(BaseModel): GetPrivateFundingHistoryReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) from_ (int): Begin time (milisecond) to (int): End time (milisecond) reverse (bool): 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 @@ -27,7 +27,7 @@ class GetPrivateFundingHistoryReq(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) from_: Optional[int] = Field(default=None, description="Begin time (milisecond) ", @@ -111,7 +111,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetPrivateFundingHistoryReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_public_funding_history_data.py b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_public_funding_history_data.py index 5b64ee2..9525176 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_public_funding_history_data.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_public_funding_history_data.py @@ -15,7 +15,7 @@ class GetPublicFundingHistoryData(BaseModel): GetPublicFundingHistoryData Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) funding_rate (float): Funding rate timepoint (int): Time point (milisecond) """ @@ -23,7 +23,7 @@ class GetPublicFundingHistoryData(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) funding_rate: Optional[float] = Field(default=None, description="Funding rate", diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_public_funding_history_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_public_funding_history_req.py index 54dad4e..5485a60 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_public_funding_history_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/fundingfees/model_get_public_funding_history_req.py @@ -15,7 +15,7 @@ class GetPublicFundingHistoryReq(BaseModel): GetPublicFundingHistoryReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) from_ (int): Begin time (milisecond) to (int): End time (milisecond) """ @@ -23,7 +23,7 @@ class GetPublicFundingHistoryReq(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) from_: Optional[int] = Field(default=None, description="Begin time (milisecond) ", @@ -82,7 +82,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetPublicFundingHistoryReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_all_order_event.py b/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_all_order_event.py index 630ac2d..7217b32 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_all_order_event.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_all_order_event.py @@ -18,7 +18,7 @@ class AllOrderEvent(BaseModel): AllOrderEvent Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) order_type (OrderTypeEnum): User-specified order type side (SideEnum): buy or sell canceled_size (str): Cumulative number of cancellations @@ -32,7 +32,7 @@ class AllOrderEvent(BaseModel): remain_size (str): Remain size status (StatusEnum): Order Status ts (int): Push time(Nanosecond) - liquidity (LiquidityEnum): Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** + liquidity (LiquidityEnum): Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** fee_type (FeeTypeEnum): Actual Fee Type match_price (str): Match Price(when the type is \"match\") match_size (str): Match Size (when the type is \"match\") @@ -127,7 +127,7 @@ class TradeTypeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) " ) order_type: Optional[OrderTypeEnum] = Field( default=None, @@ -166,7 +166,7 @@ class TradeTypeEnum(Enum): liquidity: Optional[LiquidityEnum] = Field( default=None, description= - "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** " + "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** " ) fee_type: Optional[FeeTypeEnum] = Field(default=None, description="Actual Fee Type", diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_all_position_event.py b/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_all_position_event.py index 5b8e6e2..c8512f2 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_all_position_event.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_all_position_event.py @@ -18,7 +18,7 @@ class AllPositionEvent(BaseModel): AllPositionEvent Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) cross_mode (bool): Whether it is cross margin. delev_percentage (float): ADL ranking percentile opening_timestamp (int): Open time @@ -87,7 +87,7 @@ class PositionSideEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) " ) cross_mode: Optional[bool] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_order_event.py b/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_order_event.py index a480638..1cf3217 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_order_event.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_order_event.py @@ -18,7 +18,7 @@ class OrderEvent(BaseModel): OrderEvent Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) order_type (OrderTypeEnum): User-specified order type side (SideEnum): buy or sell canceled_size (str): Cumulative number of cancellations @@ -32,7 +32,7 @@ class OrderEvent(BaseModel): remain_size (str): Remain size status (StatusEnum): Order Status ts (int): Push time(Nanosecond) - liquidity (LiquidityEnum): Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** + liquidity (LiquidityEnum): Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** fee_type (FeeTypeEnum): Actual Fee Type match_price (str): Match Price(when the type is \"match\") match_size (str): Match Size (when the type is \"match\") @@ -127,7 +127,7 @@ class TradeTypeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) " ) order_type: Optional[OrderTypeEnum] = Field( default=None, @@ -166,7 +166,7 @@ class TradeTypeEnum(Enum): liquidity: Optional[LiquidityEnum] = Field( default=None, description= - "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** " + "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** " ) fee_type: Optional[FeeTypeEnum] = Field(default=None, description="Actual Fee Type", diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_position_event.py b/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_position_event.py index 2998565..ee2cd6c 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_position_event.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_position_event.py @@ -18,7 +18,7 @@ class PositionEvent(BaseModel): PositionEvent Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) cross_mode (bool): Whether it is cross margin. delev_percentage (float): ADL ranking percentile opening_timestamp (int): Open time @@ -87,7 +87,7 @@ class PositionSideEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) " ) cross_mode: Optional[bool] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_stop_orders_event.py b/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_stop_orders_event.py index 9aafb55..f0b4cc4 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_stop_orders_event.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/futures_private/model_stop_orders_event.py @@ -28,7 +28,7 @@ class StopOrdersEvent(BaseModel): stop (StopEnum): Either 'down' or 'up' stop_price (str): Stop Price stop_price_type (str): - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) ts (int): type (TypeEnum): Order Type """ @@ -107,7 +107,7 @@ class TypeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) " ) ts: Optional[int] = None type: Optional[TypeEnum] = Field(default=None, description="Order Type") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/futures_public/model_klines_event.py b/sdk/python/kucoin_universal_sdk/generate/futures/futures_public/model_klines_event.py index 66782a2..51d7d92 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/futures_public/model_klines_event.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/futures_public/model_klines_event.py @@ -17,7 +17,7 @@ class KlinesEvent(BaseModel): KlinesEvent Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) candles (list[str]): Start time, open price, close price, high price, low price, Transaction volume(This value is incorrect, please do not use it, we will fix it in subsequent versions), Transaction amount time (int): timestamp(ms) """ @@ -27,7 +27,7 @@ class KlinesEvent(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) candles: Optional[List[str]] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/api_market.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/api_market.py index 457f922..0862a93 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/api_market.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/api_market.py @@ -39,6 +39,7 @@ def get_all_tickers(self, **kwargs: Any) -> GetAllTickersResp: """ summary: Get All Tickers description: This endpoint returns \"last traded price/size\"、\"best bid/ask price/size\" etc. of a single symbol. These messages can also be obtained through Websocket. + documentation: https://www.kucoin.com/docs-new/api-3470223 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -56,6 +57,7 @@ def get_private_token(self, **kwargs: Any) -> GetPrivateTokenResp: """ summary: Get Private Token - Futures description: This interface can obtain the token required for websocket to establish a Futures private connection. If you need use private channels(e.g. account balance notice), please make request as follows to obtain the server list and private token + documentation: https://www.kucoin.com/docs-new/api-3470296 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -73,6 +75,7 @@ def get_public_token(self, **kwargs: Any) -> GetPublicTokenResp: """ summary: Get Public Token - Futures description: This interface can obtain the token required for websocket to establish a Futures connection. If you need use public channels (e.g. all public market data), please make request as follows to obtain the server list and public token + documentation: https://www.kucoin.com/docs-new/api-3470297 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -90,6 +93,7 @@ def get_all_symbols(self, **kwargs: Any) -> GetAllSymbolsResp: """ summary: Get All Symbols description: Get detailed information of all contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc. + documentation: https://www.kucoin.com/docs-new/api-3470220 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -107,6 +111,7 @@ def get_symbol(self, req: GetSymbolReq, **kwargs: Any) -> GetSymbolResp: """ summary: Get Symbol description: Get information of specified contracts that can be traded. This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc. + documentation: https://www.kucoin.com/docs-new/api-3470221 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -125,6 +130,7 @@ def get_spot_index_price(self, req: GetSpotIndexPriceReq, """ summary: Get Spot Index Price description: Get Spot Index Price + documentation: https://www.kucoin.com/docs-new/api-3470231 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -143,6 +149,7 @@ def get_interest_rate_index(self, req: GetInterestRateIndexReq, """ summary: Get Interest Rate Index description: Get interest rate Index. + documentation: https://www.kucoin.com/docs-new/api-3470226 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -160,6 +167,7 @@ def get_klines(self, req: GetKlinesReq, **kwargs: Any) -> GetKlinesResp: """ summary: Get Klines description: Get the Kline of the symbol. Data are returned in grouped buckets based on requested type. For each query, the system would return at most 500 pieces of data. To obtain more data, please page the data by time. + documentation: https://www.kucoin.com/docs-new/api-3470234 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -178,6 +186,7 @@ def get_part_order_book(self, req: GetPartOrderBookReq, """ summary: Get Part OrderBook description: Query for part orderbook depth data. (aggregated by price) You are recommended to request via this endpoint as the system reponse would be faster and cosume less traffic. + documentation: https://www.kucoin.com/docs-new/api-3470225 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -196,6 +205,7 @@ def get_full_order_book(self, req: GetFullOrderBookReq, """ summary: Get Full OrderBook description: Query for Full orderbook depth data. (aggregated by price) It is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control. To maintain up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook. + documentation: https://www.kucoin.com/docs-new/api-3470224 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -214,6 +224,7 @@ def get_mark_price(self, req: GetMarkPriceReq, """ summary: Get Mark Price description: Get current mark price + documentation: https://www.kucoin.com/docs-new/api-3470233 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -232,6 +243,7 @@ def get_premium_index(self, req: GetPremiumIndexReq, """ summary: Get Premium Index description: Submit request to get premium index. + documentation: https://www.kucoin.com/docs-new/api-3470227 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -249,6 +261,7 @@ def get_service_status(self, **kwargs: Any) -> GetServiceStatusResp: """ summary: Get Service Status description: Get the service status. + documentation: https://www.kucoin.com/docs-new/api-3470230 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -266,6 +279,7 @@ def get_ticker(self, req: GetTickerReq, **kwargs: Any) -> GetTickerResp: """ summary: Get Ticker description: This endpoint returns \"last traded price/size\"、\"best bid/ask price/size\" etc. of a single symbol. These messages can also be obtained through Websocket. + documentation: https://www.kucoin.com/docs-new/api-3470222 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -283,6 +297,7 @@ def get_server_time(self, **kwargs: Any) -> GetServerTimeResp: """ summary: Get Server Time description: Get the API server time. This is the Unix timestamp. + documentation: https://www.kucoin.com/docs-new/api-3470229 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -301,6 +316,7 @@ def get_trade_history(self, req: GetTradeHistoryReq, """ summary: Get Trade History description: Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records. + documentation: https://www.kucoin.com/docs-new/api-3470232 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -318,6 +334,7 @@ def get24hr_stats(self, **kwargs: Any) -> Get24hrStatsResp: """ summary: Get 24hr Stats description: Get the statistics of the platform futures trading volume in the last 24 hours. + documentation: https://www.kucoin.com/docs-new/api-3470228 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_full_order_book_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_full_order_book_req.py index 48d257b..2a36785 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_full_order_book_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_full_order_book_req.py @@ -15,13 +15,13 @@ class GetFullOrderBookReq(BaseModel): GetFullOrderBookReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -70,7 +70,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetFullOrderBookReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_full_order_book_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_full_order_book_resp.py index 96a22b9..5aeadc8 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_full_order_book_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_full_order_book_resp.py @@ -18,7 +18,7 @@ class GetFullOrderBookResp(BaseModel, Response): Attributes: sequence (int): Sequence number - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) bids (list[list[float]]): bids, from high to low asks (list[list[float]]): asks, from low to high ts (int): Timestamp(nanosecond) @@ -31,7 +31,7 @@ class GetFullOrderBookResp(BaseModel, Response): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) bids: Optional[List[List[float]]] = Field( default=None, description="bids, from high to low") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_interest_rate_index_data_list.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_interest_rate_index_data_list.py index 1abcb8e..d401ef6 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_interest_rate_index_data_list.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_interest_rate_index_data_list.py @@ -15,7 +15,7 @@ class GetInterestRateIndexDataList(BaseModel): GetInterestRateIndexDataList Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) granularity (int): Granularity (milisecond) time_point (int): Timestamp(milisecond) value (float): Interest rate value @@ -24,7 +24,7 @@ class GetInterestRateIndexDataList(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) " ) granularity: Optional[int] = Field(default=None, description="Granularity (milisecond)") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_interest_rate_index_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_interest_rate_index_req.py index 7a062b4..3cd1b9f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_interest_rate_index_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_interest_rate_index_req.py @@ -16,7 +16,7 @@ class GetInterestRateIndexReq(BaseModel): GetInterestRateIndexReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) start_at (int): Start time (milisecond) end_at (int): End time (milisecond) reverse (bool): This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default. @@ -28,7 +28,7 @@ class GetInterestRateIndexReq(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) " ) start_at: Optional[int] = Field(default=None, description="Start time (milisecond)", @@ -122,7 +122,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetInterestRateIndexReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_klines_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_klines_req.py index d6a9575..eb87ab4 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_klines_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_klines_req.py @@ -16,7 +16,7 @@ class GetKlinesReq(BaseModel): GetKlinesReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) granularity (GranularityEnum): Type of candlestick patterns(minute) from_ (int): Start time (milisecond) to (int): End time (milisecond) @@ -52,7 +52,7 @@ class GranularityEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) " ) granularity: Optional[GranularityEnum] = Field( default=None, description="Type of candlestick patterns(minute)") @@ -112,7 +112,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetKlinesReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_mark_price_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_mark_price_req.py index c8ad5b0..daabfd5 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_mark_price_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_mark_price_req.py @@ -15,14 +15,14 @@ class GetMarkPriceReq(BaseModel): GetMarkPriceReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, path_variable="True", description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -70,7 +70,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetMarkPriceReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_mark_price_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_mark_price_resp.py index 7cc0991..ba053e2 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_mark_price_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_mark_price_resp.py @@ -17,7 +17,7 @@ class GetMarkPriceResp(BaseModel, Response): GetMarkPriceResp Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) granularity (int): Granularity (milisecond) time_point (int): Time point (milisecond) value (float): Mark price @@ -29,7 +29,7 @@ class GetMarkPriceResp(BaseModel, Response): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) granularity: Optional[int] = Field(default=None, description="Granularity (milisecond)") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_part_order_book_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_part_order_book_req.py index 4ce2ed1..0b3aaf2 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_part_order_book_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_part_order_book_req.py @@ -15,14 +15,14 @@ class GetPartOrderBookReq(BaseModel): GetPartOrderBookReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) size (str): Get the depth layer, optional value: 20, 100 """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) size: Optional[str] = Field( default=None, @@ -78,7 +78,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetPartOrderBookReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_part_order_book_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_part_order_book_resp.py index 6c80a9f..722a07f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_part_order_book_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_part_order_book_resp.py @@ -18,7 +18,7 @@ class GetPartOrderBookResp(BaseModel, Response): Attributes: sequence (int): Sequence number - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) bids (list[list[float]]): bids, from high to low asks (list[list[float]]): asks, from low to high ts (int): Timestamp(nanosecond) @@ -31,7 +31,7 @@ class GetPartOrderBookResp(BaseModel, Response): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) bids: Optional[List[List[float]]] = Field( default=None, description="bids, from high to low") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_premium_index_data_list.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_premium_index_data_list.py index 9c697f7..ca2236d 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_premium_index_data_list.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_premium_index_data_list.py @@ -15,7 +15,7 @@ class GetPremiumIndexDataList(BaseModel): GetPremiumIndexDataList Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) granularity (int): Granularity(milisecond) time_point (int): Timestamp(milisecond) value (float): Premium index @@ -24,7 +24,7 @@ class GetPremiumIndexDataList(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) " ) granularity: Optional[int] = Field(default=None, description="Granularity(milisecond)") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_premium_index_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_premium_index_req.py index b634f42..7d55252 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_premium_index_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_premium_index_req.py @@ -16,7 +16,7 @@ class GetPremiumIndexReq(BaseModel): GetPremiumIndexReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) start_at (int): Start time (milisecond) end_at (int): End time (milisecond) reverse (bool): This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default. @@ -28,7 +28,7 @@ class GetPremiumIndexReq(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) " ) start_at: Optional[int] = Field(default=None, description="Start time (milisecond)", @@ -121,7 +121,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetPremiumIndexReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_spot_index_price_data_list.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_spot_index_price_data_list.py index ae4166e..e3475f0 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_spot_index_price_data_list.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_spot_index_price_data_list.py @@ -16,7 +16,7 @@ class GetSpotIndexPriceDataList(BaseModel): GetSpotIndexPriceDataList Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) granularity (int): Granularity (milisecond) time_point (int): Timestamp (milisecond) value (float): Index Value @@ -26,7 +26,7 @@ class GetSpotIndexPriceDataList(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) " ) granularity: Optional[int] = Field(default=None, description="Granularity (milisecond)") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_spot_index_price_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_spot_index_price_req.py index 827316f..3d75c83 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_spot_index_price_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_spot_index_price_req.py @@ -16,7 +16,7 @@ class GetSpotIndexPriceReq(BaseModel): GetSpotIndexPriceReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) start_at (int): Start time (milisecond) end_at (int): End time (milisecond) reverse (bool): This parameter functions to judge whether the lookup is reverse. True means “yes”. False means no. This parameter is set as True by default. @@ -28,7 +28,7 @@ class GetSpotIndexPriceReq(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) " ) start_at: Optional[int] = Field(default=None, description="Start time (milisecond)", @@ -121,7 +121,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetSpotIndexPriceReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_ticker_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_ticker_req.py index 7ee8150..79a1426 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_ticker_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_ticker_req.py @@ -15,13 +15,13 @@ class GetTickerReq(BaseModel): GetTickerReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -69,7 +69,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetTickerReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_ticker_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_ticker_resp.py index 69dae6f..0647bff 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_ticker_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_ticker_resp.py @@ -19,7 +19,7 @@ class GetTickerResp(BaseModel, Response): Attributes: sequence (int): Sequence number, used to judge whether the messages pushed by Websocket is continuous. - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) side (SideEnum): Filled side, The trade side indicates the taker order side. A taker order is the order that was matched with orders opened on the order book. size (int): Filled quantity trade_id (str): Transaction ID @@ -50,7 +50,7 @@ class SideEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) side: Optional[SideEnum] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_trade_history_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_trade_history_req.py index d9a4a70..5ee5853 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_trade_history_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/market/model_get_trade_history_req.py @@ -15,13 +15,13 @@ class GetTradeHistoryReq(BaseModel): GetTradeHistoryReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -70,7 +70,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetTradeHistoryReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/api_order.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/api_order.py index a958d6f..ecf2acc 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/api_order.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/api_order.py @@ -50,6 +50,7 @@ def get_trade_history(self, req: GetTradeHistoryReq, """ summary: Get Trade History description: Get a list of recent fills. If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time. + documentation: https://www.kucoin.com/docs-new/api-3470248 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -68,6 +69,7 @@ def get_open_order_value(self, req: GetOpenOrderValueReq, """ summary: Get Open Order Value description: You can query this endpoint to get the the total number and value of the all your active orders. + documentation: https://www.kucoin.com/docs-new/api-3470250 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -86,6 +88,7 @@ def get_order_by_client_oid(self, req: GetOrderByClientOidReq, """ summary: Get Order By ClientOid description: Get a single order by client order id (including a stop order). + documentation: https://www.kucoin.com/docs-new/api-3470352 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -105,6 +108,7 @@ def cancel_order_by_client_oid( """ summary: Cancel Order By ClientOid description: Cancel order by client defined orderId. + documentation: https://www.kucoin.com/docs-new/api-3470240 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -124,6 +128,7 @@ def cancel_all_orders_v1(self, req: CancelAllOrdersV1Req, """ summary: Cancel All Orders - V1 description: Cancel all open orders (excluding stop orders). The response is a list of orderIDs of the canceled orders. + documentation: https://www.kucoin.com/docs-new/api-3470362 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -131,7 +136,7 @@ def cancel_all_orders_v1(self, req: CancelAllOrdersV1Req, | API-CHANNEL | PRIVATE | | API-PERMISSION | FUTURES | | API-RATE-LIMIT-POOL | FUTURES | - | API-RATE-LIMIT | 30 | + | API-RATE-LIMIT | 200 | +---------------------+---------+ """ pass @@ -142,6 +147,7 @@ def get_order_list(self, req: GetOrderListReq, """ summary: Get Order List description: List your current orders. + documentation: https://www.kucoin.com/docs-new/api-3470244 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -160,6 +166,7 @@ def batch_cancel_orders(self, req: BatchCancelOrdersReq, """ summary: Batch Cancel Orders description: Cancel a bach of orders by client defined orderId or system generated orderId + documentation: https://www.kucoin.com/docs-new/api-3470241 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -178,6 +185,7 @@ def batch_add_orders(self, req: BatchAddOrdersReq, """ summary: Batch Add Orders description: Place multiple order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. You can place up to 20 orders at one time, including limit orders, market orders, and stop orders Please be noted that the system would hold the fees from the orders entered the orderbook in advance. + documentation: https://www.kucoin.com/docs-new/api-3470236 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -196,6 +204,7 @@ def cancel_order_by_id(self, req: CancelOrderByIdReq, """ summary: Cancel Order By OrderId description: Cancel order by system generated orderId. + documentation: https://www.kucoin.com/docs-new/api-3470239 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -214,6 +223,7 @@ def get_order_by_order_id(self, req: GetOrderByOrderIdReq, """ summary: Get Order By OrderId description: Get a single order by order id (including a stop order). + documentation: https://www.kucoin.com/docs-new/api-3470245 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -231,6 +241,7 @@ def add_order(self, req: AddOrderReq, **kwargs: Any) -> AddOrderResp: """ summary: Add Order description: Place order to the futures trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + documentation: https://www.kucoin.com/docs-new/api-3470235 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -249,6 +260,7 @@ def add_order_test(self, req: AddOrderTestReq, """ summary: Add Order Test description: Place order to the futures trading system just for validation + documentation: https://www.kucoin.com/docs-new/api-3470238 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -267,6 +279,7 @@ def get_recent_closed_orders(self, req: GetRecentClosedOrdersReq, """ summary: Get Recent Closed Orders description: Get a list of recent 1000 closed orders in the last 24 hours. If you need to get your recent traded order history with low latency, you may query this endpoint. + documentation: https://www.kucoin.com/docs-new/api-3470246 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -285,6 +298,7 @@ def get_recent_trade_history(self, req: GetRecentTradeHistoryReq, """ summary: Get Recent Trade History description: Get a list of recent 1000 fills in the last 24 hours. If you need to get your recent traded order history with low latency, you may query this endpoint. + documentation: https://www.kucoin.com/docs-new/api-3470249 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -303,6 +317,7 @@ def add_tpsl_order(self, req: AddTpslOrderReq, """ summary: Add Take Profit And Stop Loss Order description: Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order interface. + documentation: https://www.kucoin.com/docs-new/api-3470237 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -321,6 +336,7 @@ def cancel_all_stop_orders(self, req: CancelAllStopOrdersReq, """ summary: Cancel All Stop orders description: Cancel all untriggered stop orders. The response is a list of orderIDs of the canceled stop orders. To cancel triggered stop orders, please use 'Cancel Multiple Futures Limit orders'. + documentation: https://www.kucoin.com/docs-new/api-3470243 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -339,6 +355,7 @@ def get_stop_order_list(self, req: GetStopOrderListReq, """ summary: Get Stop Order List description: Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order interface + documentation: https://www.kucoin.com/docs-new/api-3470247 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -357,6 +374,7 @@ def cancel_all_orders_v3(self, req: CancelAllOrdersV3Req, """ summary: Cancel All Orders description: Cancel all open orders (excluding stop orders). The response is a list of orderIDs of the canceled orders. + documentation: https://www.kucoin.com/docs-new/api-3470242 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_order_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_order_req.py index 506f967..30eec5d 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_order_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_order_req.py @@ -18,7 +18,7 @@ class AddOrderReq(BaseModel): Attributes: client_oid (str): Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) side (SideEnum): specify if the order is to 'buy' or 'sell' - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) leverage (int): Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. type (TypeEnum): specify if the order is an 'limit' order or 'market' order remark (str): remark for the order, length cannot exceed 100 utf8 characters @@ -28,11 +28,11 @@ class AddOrderReq(BaseModel): reduce_only (bool): A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. If set to true, only the orders reducing the position size will be executed. If the reduce-only order size exceeds the position size, the extra size will be canceled. close_order (bool): A mark to close the position. Set to false by default. If closeOrder is set to true, the system will close the position and the position size will become 0. Side, Size and Leverage fields can be left empty and the system will determine the side and size automatically. force_hold (bool): A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. margin_mode (MarginModeEnum): Margin mode: ISOLATED, CROSS, default: ISOLATED price (str): Required for type is 'limit' order, indicating the operating price size (int): **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. - time_in_force (TimeInForceEnum): Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + time_in_force (TimeInForceEnum): Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC post_only (bool): Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. hidden (bool): Optional for type is 'limit' order, orders not displaying in order book. When hidden chose, not allowed choose postOnly. iceberg (bool): Optional for type is 'limit' order, Only visible portion of the order is displayed in the order book. When iceberg chose, not allowed choose postOnly. @@ -118,7 +118,7 @@ class TimeInForceEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) leverage: Optional[int] = Field( default=None, @@ -165,7 +165,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." ) margin_mode: Optional[MarginModeEnum] = Field( default=MarginModeEnum.ISOLATED, @@ -183,7 +183,7 @@ class TimeInForceEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GOOD_TILL_CANCELED, description= - "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -332,7 +332,7 @@ def set_side(self, value: AddOrderReq.SideEnum) -> AddOrderReqBuilder: def set_symbol(self, value: str) -> AddOrderReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self @@ -403,7 +403,7 @@ def set_force_hold(self, value: bool) -> AddOrderReqBuilder: def set_stp(self, value: AddOrderReq.StpEnum) -> AddOrderReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. """ self.obj['stp'] = value return self @@ -433,7 +433,7 @@ def set_size(self, value: int) -> AddOrderReqBuilder: def set_time_in_force( self, value: AddOrderReq.TimeInForceEnum) -> AddOrderReqBuilder: """ - Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC """ self.obj['timeInForce'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_order_test_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_order_test_req.py index eb99480..01b921f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_order_test_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_order_test_req.py @@ -18,7 +18,7 @@ class AddOrderTestReq(BaseModel): Attributes: client_oid (str): Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) side (SideEnum): specify if the order is to 'buy' or 'sell' - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) leverage (int): Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. type (TypeEnum): specify if the order is an 'limit' order or 'market' order remark (str): remark for the order, length cannot exceed 100 utf8 characters @@ -28,11 +28,11 @@ class AddOrderTestReq(BaseModel): reduce_only (bool): A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. If set to true, only the orders reducing the position size will be executed. If the reduce-only order size exceeds the position size, the extra size will be canceled. close_order (bool): A mark to close the position. Set to false by default. If closeOrder is set to true, the system will close the position and the position size will become 0. Side, Size and Leverage fields can be left empty and the system will determine the side and size automatically. force_hold (bool): A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. margin_mode (MarginModeEnum): Margin mode: ISOLATED, CROSS, default: ISOLATED price (str): Required for type is 'limit' order, indicating the operating price size (int): **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. - time_in_force (TimeInForceEnum): Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + time_in_force (TimeInForceEnum): Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC post_only (bool): Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. hidden (bool): Optional for type is 'limit' order, orders not displaying in order book. When hidden chose, not allowed choose postOnly. iceberg (bool): Optional for type is 'limit' order, Only visible portion of the order is displayed in the order book. When iceberg chose, not allowed choose postOnly. @@ -118,7 +118,7 @@ class TimeInForceEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) leverage: Optional[int] = Field( default=None, @@ -165,7 +165,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." ) margin_mode: Optional[MarginModeEnum] = Field( default=MarginModeEnum.ISOLATED, @@ -183,7 +183,7 @@ class TimeInForceEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GOOD_TILL_CANCELED, description= - "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -334,7 +334,7 @@ def set_side(self, def set_symbol(self, value: str) -> AddOrderTestReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self @@ -409,7 +409,7 @@ def set_force_hold(self, value: bool) -> AddOrderTestReqBuilder: def set_stp(self, value: AddOrderTestReq.StpEnum) -> AddOrderTestReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. """ self.obj['stp'] = value return self @@ -441,7 +441,7 @@ def set_time_in_force( self, value: AddOrderTestReq.TimeInForceEnum) -> AddOrderTestReqBuilder: """ - Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC """ self.obj['timeInForce'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_tpsl_order_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_tpsl_order_req.py index e06425b..db07ae8 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_tpsl_order_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_add_tpsl_order_req.py @@ -18,7 +18,7 @@ class AddTpslOrderReq(BaseModel): Attributes: client_oid (str): Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) side (SideEnum): specify if the order is to 'buy' or 'sell' - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) leverage (int): Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. type (TypeEnum): specify if the order is an 'limit' order or 'market' order remark (str): remark for the order, length cannot exceed 100 utf8 characters @@ -26,11 +26,11 @@ class AddTpslOrderReq(BaseModel): reduce_only (bool): A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. If set to true, only the orders reducing the position size will be executed. If the reduce-only order size exceeds the position size, the extra size will be canceled. close_order (bool): A mark to close the position. Set to false by default. If closeOrder is set to true, the system will close the position and the position size will become 0. Side, Size and Leverage fields can be left empty and the system will determine the side and size automatically. force_hold (bool): A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. margin_mode (MarginModeEnum): Margin mode: ISOLATED, CROSS, default: ISOLATED price (str): Required for type is 'limit' order, indicating the operating price size (int): **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. - time_in_force (TimeInForceEnum): Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + time_in_force (TimeInForceEnum): Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC post_only (bool): Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. hidden (bool): Optional for type is 'limit' order, orders not displaying in order book. When hidden chose, not allowed choose postOnly. iceberg (bool): Optional for type is 'limit' order, Only visible portion of the order is displayed in the order book. When iceberg chose, not allowed choose postOnly. @@ -109,7 +109,7 @@ class TimeInForceEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) leverage: Optional[int] = Field( default=None, @@ -146,7 +146,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." ) margin_mode: Optional[MarginModeEnum] = Field( default=MarginModeEnum.ISOLATED, @@ -164,7 +164,7 @@ class TimeInForceEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GOOD_TILL_CANCELED, description= - "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -324,7 +324,7 @@ def set_side(self, def set_symbol(self, value: str) -> AddTpslOrderReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self @@ -384,7 +384,7 @@ def set_force_hold(self, value: bool) -> AddTpslOrderReqBuilder: def set_stp(self, value: AddTpslOrderReq.StpEnum) -> AddTpslOrderReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. """ self.obj['stp'] = value return self @@ -416,7 +416,7 @@ def set_time_in_force( self, value: AddTpslOrderReq.TimeInForceEnum) -> AddTpslOrderReqBuilder: """ - Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC """ self.obj['timeInForce'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_add_orders_data.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_add_orders_data.py index dd19231..89bd252 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_add_orders_data.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_add_orders_data.py @@ -17,7 +17,7 @@ class BatchAddOrdersData(BaseModel): Attributes: order_id (str): The unique order id generated by the trading system,which can be used later for further actions such as canceling the order. client_oid (str): Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) code (str): msg (str): """ @@ -35,7 +35,7 @@ class BatchAddOrdersData(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) code: Optional[str] = None msg: Optional[str] = None diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_add_orders_item.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_add_orders_item.py index fb0e10c..099c24f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_add_orders_item.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_add_orders_item.py @@ -18,7 +18,7 @@ class BatchAddOrdersItem(BaseModel): Attributes: client_oid (str): Unique order id created by users to identify their orders, the maximum length cannot exceed 40, e.g. UUID, Only allows numbers, characters, underline(_), and separator(-) side (SideEnum): specify if the order is to 'buy' or 'sell' - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) leverage (int): Used to calculate the margin to be frozen for the order. If you are to close the position, this parameter is not required. type (TypeEnum): specify if the order is an 'limit' order or 'market' order remark (str): remark for the order, length cannot exceed 100 utf8 characters @@ -28,11 +28,11 @@ class BatchAddOrdersItem(BaseModel): reduce_only (bool): A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. If set to true, only the orders reducing the position size will be executed. If the reduce-only order size exceeds the position size, the extra size will be canceled. close_order (bool): A mark to close the position. Set to false by default. If closeOrder is set to true, the system will close the position and the position size will become 0. Side, Size and Leverage fields can be left empty and the system will determine the side and size automatically. force_hold (bool): A mark to forcely hold the funds for an order, even though it's an order to reduce the position size. This helps the order stay on the order book and not get canceled when the position size changes. Set to false by default. The system will forcely freeze certain amount of funds for this order, including orders whose direction is opposite to the current positions. This feature is to ensure that the order won’t be canceled by the matching engine in such a circumstance that not enough funds are frozen for the order. - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. margin_mode (MarginModeEnum): Margin mode: ISOLATED, CROSS, default: ISOLATED price (str): Required for type is 'limit' order, indicating the operating price size (int): **Choose one of size, qty, valueQty**, Order size (Lot), must be a positive integer. The quantity unit of coin-swap contracts is size(lot), and other units are not supported. - time_in_force (TimeInForceEnum): Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + time_in_force (TimeInForceEnum): Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC post_only (bool): Optional for type is 'limit' order, post only flag, invalid when timeInForce is IOC. When postOnly is true, not allowed choose hidden or iceberg. The post-only flag ensures that the trader always pays the maker fee and provides liquidity to the order book. If any part of the order is going to pay taker fee, the order will be fully rejected. hidden (bool): Optional for type is 'limit' order, orders not displaying in order book. When hidden chose, not allowed choose postOnly. iceberg (bool): Optional for type is 'limit' order, Only visible portion of the order is displayed in the order book. When iceberg chose, not allowed choose postOnly. @@ -118,7 +118,7 @@ class TimeInForceEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) " ) leverage: Optional[int] = Field( default=None, @@ -165,7 +165,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." ) margin_mode: Optional[MarginModeEnum] = Field( default=MarginModeEnum.ISOLATED, @@ -183,7 +183,7 @@ class TimeInForceEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GOOD_TILL_CANCELED, description= - "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -336,7 +336,7 @@ def set_side( def set_symbol(self, value: str) -> BatchAddOrdersItemBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) """ self.obj['symbol'] = value return self @@ -414,7 +414,7 @@ def set_stp( self, value: BatchAddOrdersItem.StpEnum) -> BatchAddOrdersItemBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. """ self.obj['stp'] = value return self @@ -446,7 +446,7 @@ def set_time_in_force( self, value: BatchAddOrdersItem.TimeInForceEnum ) -> BatchAddOrdersItemBuilder: """ - Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC + Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC """ self.obj['timeInForce'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_cancel_orders_client_oids_list.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_cancel_orders_client_oids_list.py index 6684004..edcaca1 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_cancel_orders_client_oids_list.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_batch_cancel_orders_client_oids_list.py @@ -15,14 +15,14 @@ class BatchCancelOrdersClientOidsList(BaseModel): BatchCancelOrdersClientOidsList Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) client_oid (str): """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) client_oid: Optional[str] = Field(default=None, alias="clientOid") @@ -76,7 +76,7 @@ def __init__(self): def set_symbol(self, value: str) -> BatchCancelOrdersClientOidsListBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_orders_v1_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_orders_v1_req.py index dc98bc6..121ab05 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_orders_v1_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_orders_v1_req.py @@ -15,13 +15,13 @@ class CancelAllOrdersV1Req(BaseModel): CancelAllOrdersV1Req Attributes: - symbol (str): Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -70,7 +70,7 @@ def __init__(self): def set_symbol(self, value: str) -> CancelAllOrdersV1ReqBuilder: """ - Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_orders_v3_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_orders_v3_req.py index 630343c..1ab329f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_orders_v3_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_orders_v3_req.py @@ -15,13 +15,13 @@ class CancelAllOrdersV3Req(BaseModel): CancelAllOrdersV3Req Attributes: - symbol (str): Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -70,7 +70,7 @@ def __init__(self): def set_symbol(self, value: str) -> CancelAllOrdersV3ReqBuilder: """ - Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_stop_orders_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_stop_orders_req.py index 80b384f..9c7a009 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_stop_orders_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_all_stop_orders_req.py @@ -15,13 +15,13 @@ class CancelAllStopOrdersReq(BaseModel): CancelAllStopOrdersReq Attributes: - symbol (str): Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -70,7 +70,7 @@ def __init__(self): def set_symbol(self, value: str) -> CancelAllStopOrdersReqBuilder: """ - Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_order_by_client_oid_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_order_by_client_oid_req.py index 0b7a35d..3cb9b87 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_order_by_client_oid_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_cancel_order_by_client_oid_req.py @@ -15,14 +15,14 @@ class CancelOrderByClientOidReq(BaseModel): CancelOrderByClientOidReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) client_oid (str): client order id """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) client_oid: Optional[str] = Field(default=None, path_variable="True", @@ -79,7 +79,7 @@ def __init__(self): def set_symbol(self, value: str) -> CancelOrderByClientOidReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_open_order_value_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_open_order_value_req.py index 2bec65a..ec721ef 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_open_order_value_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_open_order_value_req.py @@ -15,13 +15,13 @@ class GetOpenOrderValueReq(BaseModel): GetOpenOrderValueReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -70,7 +70,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetOpenOrderValueReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_by_client_oid_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_by_client_oid_resp.py index a09a967..04fd844 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_by_client_oid_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_by_client_oid_resp.py @@ -19,7 +19,7 @@ class GetOrderByClientOidResp(BaseModel, Response): Attributes: id (str): Order ID - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) type (TypeEnum): Order type, market order or limit order side (SideEnum): Transaction side price (str): Order price @@ -27,7 +27,7 @@ class GetOrderByClientOidResp(BaseModel, Response): value (str): Order value deal_value (str): Executed size of funds deal_size (int): Executed quantity - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. stop (str): Stop order type (stop limit or stop market) stop_price_type (StopPriceTypeEnum): Trigger price type of stop orders stop_triggered (bool): Mark to show whether the stop order is triggered @@ -126,7 +126,7 @@ class StatusEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) type: Optional[TypeEnum] = Field( default=None, description="Order type, market order or limit order") @@ -144,7 +144,7 @@ class StatusEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." ) stop: Optional[str] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_by_order_id_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_by_order_id_resp.py index a5d7c46..24e79a9 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_by_order_id_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_by_order_id_resp.py @@ -19,7 +19,7 @@ class GetOrderByOrderIdResp(BaseModel, Response): Attributes: id (str): Order ID - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) type (TypeEnum): Order type, market order or limit order side (SideEnum): Transaction side price (str): Order price @@ -27,7 +27,7 @@ class GetOrderByOrderIdResp(BaseModel, Response): value (str): Order value deal_value (str): Executed size of funds deal_size (int): Executed quantity - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment. stop (str): Stop order type (stop limit or stop market) stop_price_type (StopPriceTypeEnum): Trigger price type of stop orders stop_triggered (bool): Mark to show whether the stop order is triggered @@ -126,7 +126,7 @@ class StatusEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) type: Optional[TypeEnum] = Field( default=None, description="Order type, market order or limit order") @@ -144,7 +144,7 @@ class StatusEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment." ) stop: Optional[str] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_list_items.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_list_items.py index 7c475df..e1cde1f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_list_items.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_list_items.py @@ -16,7 +16,7 @@ class GetOrderListItems(BaseModel): Attributes: id (str): Order ID - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) type (str): Order type, market order or limit order side (str): Transaction side price (str): Order price @@ -59,7 +59,7 @@ class GetOrderListItems(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) type: Optional[str] = Field( default=None, description="Order type, market order or limit order ") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_list_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_list_req.py index 8932711..9844b3d 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_list_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_order_list_req.py @@ -17,7 +17,7 @@ class GetOrderListReq(BaseModel): Attributes: status (StatusEnum): active or done, done as default. Only list orders for a specific status - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) side (SideEnum): buy or sell type (TypeEnum): limit, market, limit_stop or market_stop start_at (int): Start time (milisecond) @@ -61,7 +61,7 @@ class TypeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) side: Optional[SideEnum] = Field(default=None, description="buy or sell") type: Optional[TypeEnum] = Field( @@ -147,7 +147,7 @@ def set_status( def set_symbol(self, value: str) -> GetOrderListReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_closed_orders_data.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_closed_orders_data.py index 1251530..07e2b50 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_closed_orders_data.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_closed_orders_data.py @@ -16,7 +16,7 @@ class GetRecentClosedOrdersData(BaseModel): Attributes: id (str): Order ID - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) type (str): Order type, market order or limit order side (str): Transaction side price (str): Order price @@ -59,7 +59,7 @@ class GetRecentClosedOrdersData(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) type: Optional[str] = Field( default=None, description="Order type, market order or limit order") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_closed_orders_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_closed_orders_req.py index 672a6e8..8043664 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_closed_orders_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_closed_orders_req.py @@ -15,13 +15,13 @@ class GetRecentClosedOrdersReq(BaseModel): GetRecentClosedOrdersReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -71,7 +71,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetRecentClosedOrdersReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_trade_history_data.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_trade_history_data.py index fc4cc96..568b136 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_trade_history_data.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_trade_history_data.py @@ -16,7 +16,7 @@ class GetRecentTradeHistoryData(BaseModel): GetRecentTradeHistoryData Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) trade_id (str): Trade ID order_id (str): Order ID side (SideEnum): Transaction side @@ -109,7 +109,7 @@ class TradeTypeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) trade_id: Optional[str] = Field(default=None, description="Trade ID ", diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_trade_history_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_trade_history_req.py index a85532f..0d2ef71 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_trade_history_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_recent_trade_history_req.py @@ -15,13 +15,13 @@ class GetRecentTradeHistoryReq(BaseModel): GetRecentTradeHistoryReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -71,7 +71,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetRecentTradeHistoryReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_stop_order_list_items.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_stop_order_list_items.py index b7020b5..583eeac 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_stop_order_list_items.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_stop_order_list_items.py @@ -16,7 +16,7 @@ class GetStopOrderListItems(BaseModel): Attributes: id (str): Order ID - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) type (str): Order type, market order or limit order side (str): Transaction side price (str): Order price @@ -59,7 +59,7 @@ class GetStopOrderListItems(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) type: Optional[str] = Field( default=None, description="Order type, market order or limit order ") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_stop_order_list_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_stop_order_list_req.py index f60ad44..4639175 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_stop_order_list_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_stop_order_list_req.py @@ -17,7 +17,7 @@ class GetStopOrderListReq(BaseModel): GetStopOrderListReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) side (SideEnum): buy or sell type (TypeEnum): limit, market start_at (int): Start time (milisecond) @@ -47,7 +47,7 @@ class TypeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) side: Optional[SideEnum] = Field(default=None, description="buy or sell") type: Optional[TypeEnum] = Field(default=None, description="limit, market") @@ -130,7 +130,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetStopOrderListReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_trade_history_items.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_trade_history_items.py index 11341b1..01bc072 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_trade_history_items.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_trade_history_items.py @@ -16,7 +16,7 @@ class GetTradeHistoryItems(BaseModel): GetTradeHistoryItems Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) trade_id (str): Trade ID order_id (str): Order ID side (SideEnum): Transaction side @@ -107,7 +107,7 @@ class TradeTypeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) trade_id: Optional[str] = Field(default=None, description="Trade ID ", diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_trade_history_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_trade_history_req.py index ec54771..aef3038 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_trade_history_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/order/model_get_trade_history_req.py @@ -18,7 +18,7 @@ class GetTradeHistoryReq(BaseModel): Attributes: order_id (str): List fills for a specific order only (If you specify orderId, other parameters can be ignored) - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) side (SideEnum): Order side type (TypeEnum): Order Type trade_types (str): Transaction type: trade, adl, liquid, settlement. Supports querying multiple types at the same time, separated by commas. Query all type when empty @@ -58,7 +58,7 @@ class TypeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) side: Optional[SideEnum] = Field(default=None, description="Order side") type: Optional[TypeEnum] = Field(default=None, description="Order Type") @@ -159,7 +159,7 @@ def set_order_id(self, value: str) -> GetTradeHistoryReqBuilder: def set_symbol(self, value: str) -> GetTradeHistoryReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/api_positions.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/api_positions.py index 369eed5..18883c7 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/api_positions.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/api_positions.py @@ -43,6 +43,7 @@ def get_isolated_margin_risk_limit( """ summary: Get Isolated Margin Risk Limit description: This interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin). + documentation: https://www.kucoin.com/docs-new/api-3470263 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -61,6 +62,7 @@ def get_positions_history(self, req: GetPositionsHistoryReq, """ summary: Get Positions History description: This interface can query position history information records. + documentation: https://www.kucoin.com/docs-new/api-3470254 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -79,6 +81,7 @@ def get_max_withdraw_margin(self, req: GetMaxWithdrawMarginReq, """ summary: Get Max Withdraw Margin description: This interface can query the maximum amount of margin that the current position supports withdrawal. + documentation: https://www.kucoin.com/docs-new/api-3470258 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -97,6 +100,7 @@ def remove_isolated_margin(self, req: RemoveIsolatedMarginReq, """ summary: Remove Isolated Margin description: Remove Isolated Margin Manually. + documentation: https://www.kucoin.com/docs-new/api-3470256 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -115,6 +119,7 @@ def get_position_details(self, req: GetPositionDetailsReq, """ summary: Get Position Details description: Get the position details of a specified position. + documentation: https://www.kucoin.com/docs-new/api-3470252 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -135,6 +140,7 @@ def modify_auto_deposit_status( """ summary: Modify Isolated Margin Auto-Deposit Status description: This endpoint is only applicable to isolated margin and is no longer recommended. It is recommended to use cross margin instead. + documentation: https://www.kucoin.com/docs-new/api-3470255 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -153,6 +159,7 @@ def add_isolated_margin(self, req: AddIsolatedMarginReq, """ summary: Add Isolated Margin description: Add Isolated Margin Manually. + documentation: https://www.kucoin.com/docs-new/api-3470257 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -172,6 +179,7 @@ def modify_isolated_margin_risk_limt( """ summary: Modify Isolated Margin Risk Limit description: This interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin). + documentation: https://www.kucoin.com/docs-new/api-3470264 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -190,6 +198,7 @@ def get_position_list(self, req: GetPositionListReq, """ summary: Get Position List description: Get the position details of a specified position. + documentation: https://www.kucoin.com/docs-new/api-3470253 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -208,6 +217,7 @@ def modify_margin_leverage(self, req: ModifyMarginLeverageReq, """ summary: Modify Cross Margin Leverage description: This interface can modify the current symbol’s cross-margin leverage multiple. + documentation: https://www.kucoin.com/docs-new/api-3470261 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -226,6 +236,7 @@ def get_cross_margin_leverage(self, req: GetCrossMarginLeverageReq, """ summary: Get Cross Margin Leverage description: This interface can query the current symbol’s cross-margin leverage multiple. + documentation: https://www.kucoin.com/docs-new/api-3470260 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -244,6 +255,7 @@ def get_max_open_size(self, req: GetMaxOpenSizeReq, """ summary: Get Max Open Size description: Get Maximum Open Position Size. + documentation: https://www.kucoin.com/docs-new/api-3470251 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -262,6 +274,7 @@ def switch_margin_mode(self, req: SwitchMarginModeReq, """ summary: Switch Margin Mode description: This interface can modify the margin mode of the current symbol. + documentation: https://www.kucoin.com/docs-new/api-3470262 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -280,6 +293,7 @@ def get_margin_mode(self, req: GetMarginModeReq, """ summary: Get Margin Mode description: This interface can query the margin mode of the current symbol. + documentation: https://www.kucoin.com/docs-new/api-3470259 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_add_isolated_margin_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_add_isolated_margin_req.py index 4708a6c..91bac85 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_add_isolated_margin_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_add_isolated_margin_req.py @@ -15,7 +15,7 @@ class AddIsolatedMarginReq(BaseModel): AddIsolatedMarginReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) margin (float): Margin amount (min. margin amount≥0.00001667XBT） biz_no (str): A unique ID generated by the user, to ensure the operation is processed by the system only once, The maximum length cannot exceed 36 """ @@ -23,7 +23,7 @@ class AddIsolatedMarginReq(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) margin: Optional[float] = Field( default=None, @@ -84,7 +84,7 @@ def __init__(self): def set_symbol(self, value: str) -> AddIsolatedMarginReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_add_isolated_margin_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_add_isolated_margin_resp.py index d3905bf..54ea9a9 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_add_isolated_margin_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_add_isolated_margin_resp.py @@ -18,7 +18,7 @@ class AddIsolatedMarginResp(BaseModel, Response): Attributes: id (str): Position ID - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) auto_deposit (bool): Auto deposit margin or not maint_margin_req (float): Maintenance margin requirement risk_limit (int): Risk limit @@ -62,7 +62,7 @@ class AddIsolatedMarginResp(BaseModel, Response): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) auto_deposit: Optional[bool] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_cross_margin_leverage_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_cross_margin_leverage_req.py index 152df18..2eeb2d2 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_cross_margin_leverage_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_cross_margin_leverage_req.py @@ -15,13 +15,13 @@ class GetCrossMarginLeverageReq(BaseModel): GetCrossMarginLeverageReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -71,7 +71,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetCrossMarginLeverageReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_cross_margin_leverage_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_cross_margin_leverage_resp.py index 20e27cb..ec90c5f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_cross_margin_leverage_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_cross_margin_leverage_resp.py @@ -17,7 +17,7 @@ class GetCrossMarginLeverageResp(BaseModel, Response): GetCrossMarginLeverageResp Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) leverage (str): Leverage multiple """ @@ -26,7 +26,7 @@ class GetCrossMarginLeverageResp(BaseModel, Response): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) leverage: Optional[str] = Field(default=None, description="Leverage multiple") diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_isolated_margin_risk_limit_data.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_isolated_margin_risk_limit_data.py index e9e5eba..889a64d 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_isolated_margin_risk_limit_data.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_isolated_margin_risk_limit_data.py @@ -15,7 +15,7 @@ class GetIsolatedMarginRiskLimitData(BaseModel): GetIsolatedMarginRiskLimitData Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) level (int): level max_risk_limit (int): Upper limit USDT(includes) min_risk_limit (int): Lower limit USDT @@ -27,7 +27,7 @@ class GetIsolatedMarginRiskLimitData(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) level: Optional[int] = Field(default=None, description="level ") max_risk_limit: Optional[int] = Field( diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_isolated_margin_risk_limit_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_isolated_margin_risk_limit_req.py index 0ee409f..227b10e 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_isolated_margin_risk_limit_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_isolated_margin_risk_limit_req.py @@ -15,14 +15,14 @@ class GetIsolatedMarginRiskLimitReq(BaseModel): GetIsolatedMarginRiskLimitReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, path_variable="True", description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -73,7 +73,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetIsolatedMarginRiskLimitReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_margin_mode_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_margin_mode_req.py index 599293a..c1a101f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_margin_mode_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_margin_mode_req.py @@ -15,13 +15,13 @@ class GetMarginModeReq(BaseModel): GetMarginModeReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -69,7 +69,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetMarginModeReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_margin_mode_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_margin_mode_resp.py index 47fa998..21f0013 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_margin_mode_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_margin_mode_resp.py @@ -18,7 +18,7 @@ class GetMarginModeResp(BaseModel, Response): GetMarginModeResp Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) margin_mode (MarginModeEnum): Margin mode: ISOLATED (isolated), CROSS (cross margin). """ @@ -36,7 +36,7 @@ class MarginModeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) margin_mode: Optional[MarginModeEnum] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_open_size_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_open_size_req.py index 97d8fe3..54838ed 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_open_size_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_open_size_req.py @@ -15,7 +15,7 @@ class GetMaxOpenSizeReq(BaseModel): GetMaxOpenSizeReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) price (str): Order price leverage (int): Leverage """ @@ -23,7 +23,7 @@ class GetMaxOpenSizeReq(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) price: Optional[str] = Field(default=None, description="Order price ") leverage: Optional[int] = Field(default=None, description="Leverage ") @@ -77,7 +77,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetMaxOpenSizeReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_open_size_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_open_size_resp.py index 53d5064..41e34a3 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_open_size_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_open_size_resp.py @@ -17,7 +17,7 @@ class GetMaxOpenSizeResp(BaseModel, Response): GetMaxOpenSizeResp Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) max_buy_open_size (int): Maximum buy size max_sell_open_size (int): Maximum buy size """ @@ -27,7 +27,7 @@ class GetMaxOpenSizeResp(BaseModel, Response): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) max_buy_open_size: Optional[int] = Field(default=None, description="Maximum buy size ", diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_withdraw_margin_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_withdraw_margin_req.py index 09def63..9621fcd 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_withdraw_margin_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_max_withdraw_margin_req.py @@ -15,13 +15,13 @@ class GetMaxWithdrawMarginReq(BaseModel): GetMaxWithdrawMarginReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -71,7 +71,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetMaxWithdrawMarginReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_details_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_details_req.py index cbd1560..c3d845f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_details_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_details_req.py @@ -15,13 +15,13 @@ class GetPositionDetailsReq(BaseModel): GetPositionDetailsReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) __properties: ClassVar[List[str]] = ["symbol"] @@ -70,7 +70,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetPositionDetailsReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_details_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_details_resp.py index 92427c1..4bc19b4 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_details_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_details_resp.py @@ -19,7 +19,7 @@ class GetPositionDetailsResp(BaseModel, Response): Attributes: id (str): Position ID - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) cross_mode (bool): Whether it is cross margin. delev_percentage (float): ADL ranking percentile opening_timestamp (int): Open time @@ -86,7 +86,7 @@ class PositionSideEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) cross_mode: Optional[bool] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_list_data.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_list_data.py index 60b4985..dcc1d5a 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_list_data.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_list_data.py @@ -17,7 +17,7 @@ class GetPositionListData(BaseModel): Attributes: id (str): Position ID - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) cross_mode (bool): Whether it is cross margin. delev_percentage (float): ADL ranking percentile opening_timestamp (int): Open time @@ -82,7 +82,7 @@ class PositionSideEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) cross_mode: Optional[bool] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_list_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_list_req.py index 1628953..3e7ce1a 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_list_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_position_list_req.py @@ -15,13 +15,13 @@ class GetPositionListReq(BaseModel): GetPositionListReq Attributes: - currency (str): Currency code, Please refer to [rootSymbol](apidog://link/endpoint/221752070) , such as USDT,XBT. Query all positions when empty + currency (str): Currency code, Please refer to [rootSymbol](https://www.kucoin.com/docs-new/api-221752070) , such as USDT,XBT. Query all positions when empty """ currency: Optional[str] = Field( default=None, description= - "Currency code, Please refer to [rootSymbol](apidog://link/endpoint/221752070) , such as USDT,XBT. Query all positions when empty" + "Currency code, Please refer to [rootSymbol](https://www.kucoin.com/docs-new/api-221752070) , such as USDT,XBT. Query all positions when empty" ) __properties: ClassVar[List[str]] = ["currency"] @@ -70,7 +70,7 @@ def __init__(self): def set_currency(self, value: str) -> GetPositionListReqBuilder: """ - Currency code, Please refer to [rootSymbol](apidog://link/endpoint/221752070) , such as USDT,XBT. Query all positions when empty + Currency code, Please refer to [rootSymbol](https://www.kucoin.com/docs-new/api-221752070) , such as USDT,XBT. Query all positions when empty """ self.obj['currency'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_positions_history_items.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_positions_history_items.py index c6f8734..d594be1 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_positions_history_items.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_positions_history_items.py @@ -18,7 +18,7 @@ class GetPositionsHistoryItems(BaseModel): Attributes: close_id (str): Close ID user_id (str): User ID - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) settle_currency (str): Currency used to settle trades leverage (str): Leverage applied to the order type (str): Type of closure @@ -52,7 +52,7 @@ class MarginModeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) settle_currency: Optional[str] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_positions_history_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_positions_history_req.py index 615735a..80fee9e 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_positions_history_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_get_positions_history_req.py @@ -16,7 +16,7 @@ class GetPositionsHistoryReq(BaseModel): GetPositionsHistoryReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) from_ (int): Closing start time(ms) to (int): Closing end time(ms) limit (int): Number of requests per page, max 200, default 10 @@ -26,7 +26,7 @@ class GetPositionsHistoryReq(BaseModel): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) from_: Optional[int] = Field(default=None, description="Closing start time(ms) ", @@ -100,7 +100,7 @@ def __init__(self): def set_symbol(self, value: str) -> GetPositionsHistoryReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_modify_isolated_margin_risk_limt_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_modify_isolated_margin_risk_limt_req.py index 32e6f02..8160897 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_modify_isolated_margin_risk_limt_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_modify_isolated_margin_risk_limt_req.py @@ -15,14 +15,14 @@ class ModifyIsolatedMarginRiskLimtReq(BaseModel): ModifyIsolatedMarginRiskLimtReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) level (int): level """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) level: Optional[int] = Field(default=None, description="level") @@ -76,7 +76,7 @@ def __init__(self): def set_symbol(self, value: str) -> ModifyIsolatedMarginRiskLimtReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_modify_margin_leverage_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_modify_margin_leverage_req.py index f99a05a..b6aa3a6 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_modify_margin_leverage_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_modify_margin_leverage_req.py @@ -15,14 +15,14 @@ class ModifyMarginLeverageReq(BaseModel): ModifyMarginLeverageReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) leverage (str): Leverage multiple """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) leverage: Optional[str] = Field(default=None, description="Leverage multiple") @@ -77,7 +77,7 @@ def __init__(self): def set_symbol(self, value: str) -> ModifyMarginLeverageReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_remove_isolated_margin_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_remove_isolated_margin_req.py index 92a9adb..f6d5edd 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_remove_isolated_margin_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_remove_isolated_margin_req.py @@ -15,14 +15,14 @@ class RemoveIsolatedMarginReq(BaseModel): RemoveIsolatedMarginReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) withdraw_amount (str): The size of the position that can be deposited. If it is USDT-margin, it represents the amount of USDT. If it is coin-margin, this value represents the number of coins """ symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) withdraw_amount: Optional[str] = Field( default=None, @@ -80,7 +80,7 @@ def __init__(self): def set_symbol(self, value: str) -> RemoveIsolatedMarginReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_switch_margin_mode_req.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_switch_margin_mode_req.py index 86d3a93..3cef833 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_switch_margin_mode_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_switch_margin_mode_req.py @@ -16,7 +16,7 @@ class SwitchMarginModeReq(BaseModel): SwitchMarginModeReq Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) margin_mode (MarginModeEnum): Modified margin model: ISOLATED (isolated), CROSS (cross margin). """ @@ -32,7 +32,7 @@ class MarginModeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) margin_mode: Optional[MarginModeEnum] = Field( default=None, @@ -89,7 +89,7 @@ def __init__(self): def set_symbol(self, value: str) -> SwitchMarginModeReqBuilder: """ - Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) """ self.obj['symbol'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_switch_margin_mode_resp.py b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_switch_margin_mode_resp.py index 8fb8a44..773ec82 100644 --- a/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_switch_margin_mode_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/futures/positions/model_switch_margin_mode_resp.py @@ -18,7 +18,7 @@ class SwitchMarginModeResp(BaseModel, Response): SwitchMarginModeResp Attributes: - symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) + symbol (str): Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) margin_mode (MarginModeEnum): Margin mode: ISOLATED (isolated), CROSS (cross margin). """ @@ -36,7 +36,7 @@ class MarginModeEnum(Enum): symbol: Optional[str] = Field( default=None, description= - "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " ) margin_mode: Optional[MarginModeEnum] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/credit/api_credit.py b/sdk/python/kucoin_universal_sdk/generate/margin/credit/api_credit.py index 9ffb66b..203878d 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/credit/api_credit.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/credit/api_credit.py @@ -27,6 +27,7 @@ def modify_purchase(self, req: ModifyPurchaseReq, """ summary: Modify Purchase description: This API endpoint is used to update the interest rates of subscription orders, which will take effect at the beginning of the next hour.,Please ensure that the funds are in the main(funding) account + documentation: https://www.kucoin.com/docs-new/api-3470217 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -45,6 +46,7 @@ def get_loan_market(self, req: GetLoanMarketReq, """ summary: Get Loan Market description: This API endpoint is used to get the information about the currencies available for lending. + documentation: https://www.kucoin.com/docs-new/api-3470212 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -64,6 +66,7 @@ def get_loan_market_interest_rate( """ summary: Get Loan Market Interest Rate description: This API endpoint is used to get the interest rates of the margin lending market over the past 7 days. + documentation: https://www.kucoin.com/docs-new/api-3470215 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -82,6 +85,7 @@ def get_purchase_orders(self, req: GetPurchaseOrdersReq, """ summary: Get Purchase Orders description: This API endpoint provides pagination query for the purchase orders. + documentation: https://www.kucoin.com/docs-new/api-3470213 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -99,6 +103,7 @@ def purchase(self, req: PurchaseReq, **kwargs: Any) -> PurchaseResp: """ summary: Purchase description: Invest credit in the market and earn interest + documentation: https://www.kucoin.com/docs-new/api-3470216 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -117,6 +122,7 @@ def get_redeem_orders(self, req: GetRedeemOrdersReq, """ summary: Get Redeem Orders description: This API endpoint provides pagination query for the redeem orders. + documentation: https://www.kucoin.com/docs-new/api-3470214 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -134,6 +140,7 @@ def redeem(self, req: RedeemReq, **kwargs: Any) -> RedeemResp: """ summary: Redeem description: Redeem your loan order + documentation: https://www.kucoin.com/docs-new/api-3470218 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/debit/api_debit.py b/sdk/python/kucoin_universal_sdk/generate/margin/debit/api_debit.py index fe9b690..3c3ba7d 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/debit/api_debit.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/debit/api_debit.py @@ -25,6 +25,7 @@ def get_borrow_history(self, req: GetBorrowHistoryReq, """ summary: Get Borrow History description: This API endpoint is used to get the borrowing orders for cross and isolated margin accounts + documentation: https://www.kucoin.com/docs-new/api-3470207 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -42,6 +43,7 @@ def borrow(self, req: BorrowReq, **kwargs: Any) -> BorrowResp: """ summary: Borrow description: This API endpoint is used to initiate an application for cross or isolated margin borrowing. + documentation: https://www.kucoin.com/docs-new/api-3470206 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -60,6 +62,7 @@ def get_interest_history(self, req: GetInterestHistoryReq, """ summary: Get Interest History description: Request via this endpoint to get the interest records of the cross/isolated margin lending. + documentation: https://www.kucoin.com/docs-new/api-3470209 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -78,6 +81,7 @@ def get_repay_history(self, req: GetRepayHistoryReq, """ summary: Get Repay History description: This API endpoint is used to get the borrowing orders for cross and isolated margin accounts + documentation: https://www.kucoin.com/docs-new/api-3470208 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -95,6 +99,7 @@ def repay(self, req: RepayReq, **kwargs: Any) -> RepayResp: """ summary: Repay description: This API endpoint is used to initiate an application for cross or isolated margin repayment. + documentation: https://www.kucoin.com/docs-new/api-3470210 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -113,6 +118,7 @@ def modify_leverage(self, req: ModifyLeverageReq, """ summary: Modify Leverage description: This endpoint allows modifying the leverage multiplier for cross margin or isolated margin. + documentation: https://www.kucoin.com/docs-new/api-3470211 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/market/api_market.py b/sdk/python/kucoin_universal_sdk/generate/margin/market/api_market.py index c00665d..8720352 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/market/api_market.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/market/api_market.py @@ -22,6 +22,7 @@ def get_isolated_margin_symbols( """ summary: Get Symbols - Isolated Margin description: This endpoint allows querying the configuration of isolated margin symbol. + documentation: https://www.kucoin.com/docs-new/api-3470194 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -39,6 +40,7 @@ def get_margin_config(self, **kwargs: Any) -> GetMarginConfigResp: """ summary: Get Margin Config description: Request via this endpoint to get the configure info of the cross margin. + documentation: https://www.kucoin.com/docs-new/api-3470190 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -57,6 +59,7 @@ def get_mark_price_detail(self, req: GetMarkPriceDetailReq, """ summary: Get Mark Price Detail description: This endpoint returns the current Mark price for specified margin trading pairs. + documentation: https://www.kucoin.com/docs-new/api-3470193 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -75,6 +78,7 @@ def get_etf_info(self, req: GetEtfInfoReq, """ summary: Get ETF Info description: This interface returns leveraged token information + documentation: https://www.kucoin.com/docs-new/api-3470191 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -93,6 +97,7 @@ def get_cross_margin_symbols(self, req: GetCrossMarginSymbolsReq, """ summary: Get Symbols - Cross Margin description: This endpoint allows querying the configuration of cross margin symbol. + documentation: https://www.kucoin.com/docs-new/api-3470189 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -110,6 +115,7 @@ def get_mark_price_list(self, **kwargs: Any) -> GetMarkPriceListResp: """ summary: Get Mark Price List description: This endpoint returns the current Mark price for all margin trading pairs. + documentation: https://www.kucoin.com/docs-new/api-3470192 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/order/api_order.py b/sdk/python/kucoin_universal_sdk/generate/margin/order/api_order.py index 6edb3da..9a46736 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/order/api_order.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/order/api_order.py @@ -41,6 +41,7 @@ def add_order_v1(self, req: AddOrderV1Req, """ summary: Add Order - V1 description: Place order to the Cross-margin or Isolated-margin trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + documentation: https://www.kucoin.com/docs-new/api-3470312 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -60,6 +61,7 @@ def add_order_test_v1(self, req: AddOrderTestV1Req, """ summary: Add Order Test - V1 description: Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried. + documentation: https://www.kucoin.com/docs-new/api-3470313 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -78,6 +80,7 @@ def get_trade_history(self, req: GetTradeHistoryReq, """ summary: Get Trade History description: This endpoint can be used to obtain a list of the latest Margin transaction details. The returned data is sorted in descending order according to the latest update time of the order. + documentation: https://www.kucoin.com/docs-new/api-3470200 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -97,6 +100,7 @@ def get_symbols_with_open_order( """ summary: Get Symbols With Open Order description: This interface can query all Margin symbol that has active orders + documentation: https://www.kucoin.com/docs-new/api-3470196 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -114,6 +118,7 @@ def add_order(self, req: AddOrderReq, **kwargs: Any) -> AddOrderResp: """ summary: Add Order description: Place order to the Cross-margin or Isolated-margin trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + documentation: https://www.kucoin.com/docs-new/api-3470204 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -132,6 +137,7 @@ def add_order_test(self, req: AddOrderTestReq, """ summary: Add Order Test description: Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried. + documentation: https://www.kucoin.com/docs-new/api-3470205 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -150,6 +156,7 @@ def get_open_orders(self, req: GetOpenOrdersReq, """ summary: Get Open Orders description: This interface is to obtain all Margin active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + documentation: https://www.kucoin.com/docs-new/api-3470198 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -169,6 +176,7 @@ def cancel_order_by_client_oid( """ summary: Cancel Order By ClientOid description: This endpoint can be used to cancel a margin order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + documentation: https://www.kucoin.com/docs-new/api-3470201 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -187,6 +195,7 @@ def get_order_by_client_oid(self, req: GetOrderByClientOidReq, """ summary: Get Order By ClientOid description: This endpoint can be used to obtain information for a single Margin order using the client order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + documentation: https://www.kucoin.com/docs-new/api-3470203 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -206,6 +215,7 @@ def cancel_all_orders_by_symbol( """ summary: Cancel All Orders By Symbol description: This interface can cancel all open Margin orders by symbol This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + documentation: https://www.kucoin.com/docs-new/api-3470197 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -224,6 +234,7 @@ def get_closed_orders(self, req: GetClosedOrdersReq, """ summary: Get Closed Orders description: This interface is to obtain all Margin closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + documentation: https://www.kucoin.com/docs-new/api-3470199 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -242,6 +253,7 @@ def cancel_order_by_order_id(self, req: CancelOrderByOrderIdReq, """ summary: Cancel Order By OrderId description: This endpoint can be used to cancel a margin order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + documentation: https://www.kucoin.com/docs-new/api-3470195 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -260,6 +272,7 @@ def get_order_by_order_id(self, req: GetOrderByOrderIdReq, """ summary: Get Order By OrderId description: This endpoint can be used to obtain information for a single Margin order using the order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + documentation: https://www.kucoin.com/docs-new/api-3470202 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_req.py b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_req.py index fdef573..152b8ad 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_req.py @@ -20,13 +20,13 @@ class AddOrderReq(BaseModel): side (SideEnum): specify if the order is to 'buy' or 'sell' symbol (str): symbol type (TypeEnum): specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC price (str): Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/5176570) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK - hidden (bool): [Hidden order](doc://link/pages/338146) or not (not shown in order book) - iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + hidden (bool): [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) + iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) visible_size (str): Maximum visible quantity in iceberg orders cancel_after (int): Cancel after n seconds，the order timing strategy is GTT funds (str): When **type** is market, select one out of two: size or funds @@ -95,7 +95,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -110,7 +110,7 @@ class TimeInForceEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -120,12 +120,12 @@ class TimeInForceEnum(Enum): hidden: Optional[bool] = Field( default=False, description= - "[Hidden order](doc://link/pages/338146) or not (not shown in order book)" + "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)" ) iceberg: Optional[bool] = Field( default=False, description= - "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)" + "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)" ) visible_size: Optional[str] = Field( default=None, @@ -270,7 +270,7 @@ def set_type(self, value: AddOrderReq.TypeEnum) -> AddOrderReqBuilder: def set_stp(self, value: AddOrderReq.StpEnum) -> AddOrderReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -292,7 +292,7 @@ def set_size(self, value: str) -> AddOrderReqBuilder: def set_time_in_force( self, value: AddOrderReq.TimeInForceEnum) -> AddOrderReqBuilder: """ - [Time in force](doc://link/pages/5176570) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading """ self.obj['timeInForce'] = value return self @@ -306,14 +306,14 @@ def set_post_only(self, value: bool) -> AddOrderReqBuilder: def set_hidden(self, value: bool) -> AddOrderReqBuilder: """ - [Hidden order](doc://link/pages/338146) or not (not shown in order book) + [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) """ self.obj['hidden'] = value return self def set_iceberg(self, value: bool) -> AddOrderReqBuilder: """ - Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) """ self.obj['iceberg'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_test_req.py b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_test_req.py index 2f531aa..039e5bc 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_test_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_test_req.py @@ -20,13 +20,13 @@ class AddOrderTestReq(BaseModel): side (SideEnum): specify if the order is to 'buy' or 'sell' symbol (str): symbol type (TypeEnum): specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC price (str): Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/5176570) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK - hidden (bool): [Hidden order](doc://link/pages/338146) or not (not shown in order book) - iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + hidden (bool): [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) + iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) visible_size (str): Maximum visible quantity in iceberg orders cancel_after (int): Cancel after n seconds，the order timing strategy is GTT funds (str): When **type** is market, select one out of two: size or funds @@ -95,7 +95,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -110,7 +110,7 @@ class TimeInForceEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -120,12 +120,12 @@ class TimeInForceEnum(Enum): hidden: Optional[bool] = Field( default=False, description= - "[Hidden order](doc://link/pages/338146) or not (not shown in order book)" + "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)" ) iceberg: Optional[bool] = Field( default=False, description= - "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)" + "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)" ) visible_size: Optional[str] = Field( default=None, @@ -274,7 +274,7 @@ def set_type(self, def set_stp(self, value: AddOrderTestReq.StpEnum) -> AddOrderTestReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -297,7 +297,7 @@ def set_time_in_force( self, value: AddOrderTestReq.TimeInForceEnum) -> AddOrderTestReqBuilder: """ - [Time in force](doc://link/pages/5176570) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading """ self.obj['timeInForce'] = value return self @@ -311,14 +311,14 @@ def set_post_only(self, value: bool) -> AddOrderTestReqBuilder: def set_hidden(self, value: bool) -> AddOrderTestReqBuilder: """ - [Hidden order](doc://link/pages/338146) or not (not shown in order book) + [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) """ self.obj['hidden'] = value return self def set_iceberg(self, value: bool) -> AddOrderTestReqBuilder: """ - Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) """ self.obj['iceberg'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_test_v1_req.py b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_test_v1_req.py index e1f523b..803451f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_test_v1_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_test_v1_req.py @@ -20,10 +20,10 @@ class AddOrderTestV1Req(BaseModel): side (SideEnum): specify if the order is to 'buy' or 'sell' symbol (str): symbol type (TypeEnum): specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. - stp (StpEnum): [Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) is divided into four strategies: CN, CO, CB , and DC price (str): Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/5176570) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK hidden (bool): Hidden or not (not shown in order book) iceberg (bool): Whether or not only visible portions of orders are shown in iceberg orders @@ -104,7 +104,7 @@ class MarginModelEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) is divided into four strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -119,7 +119,7 @@ class MarginModelEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -283,7 +283,7 @@ def set_type( def set_stp(self, value: AddOrderTestV1Req.StpEnum) -> AddOrderTestV1ReqBuilder: """ - [Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -306,7 +306,7 @@ def set_time_in_force( self, value: AddOrderTestV1Req.TimeInForceEnum ) -> AddOrderTestV1ReqBuilder: """ - [Time in force](doc://link/pages/5176570) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading """ self.obj['timeInForce'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_v1_req.py b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_v1_req.py index 5d24a91..fbff0a0 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_v1_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_add_order_v1_req.py @@ -20,10 +20,10 @@ class AddOrderV1Req(BaseModel): side (SideEnum): specify if the order is to 'buy' or 'sell' symbol (str): symbol type (TypeEnum): specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. - stp (StpEnum): [Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC price (str): Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/5176570) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK hidden (bool): Hidden or not (not shown in order book) iceberg (bool): Whether or not only visible portions of orders are shown in iceberg orders @@ -104,7 +104,7 @@ class MarginModelEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -119,7 +119,7 @@ class MarginModelEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -278,7 +278,7 @@ def set_type(self, value: AddOrderV1Req.TypeEnum) -> AddOrderV1ReqBuilder: def set_stp(self, value: AddOrderV1Req.StpEnum) -> AddOrderV1ReqBuilder: """ - [Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -301,7 +301,7 @@ def set_time_in_force( self, value: AddOrderV1Req.TimeInForceEnum) -> AddOrderV1ReqBuilder: """ - [Time in force](doc://link/pages/5176570) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading """ self.obj['timeInForce'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_closed_orders_items.py b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_closed_orders_items.py index b8e43a4..f5e2ab4 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_closed_orders_items.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_closed_orders_items.py @@ -26,9 +26,9 @@ class GetClosedOrdersItems(BaseModel): funds (str): Order Funds deal_size (str): Number of filled transactions deal_funds (str): Funds of filled transactions - fee (str): [Handling fees](doc://link/pages/5327739) + fee (str): [Handling fees](https://www.kucoin.com/docs-new/api-5327739) fee_currency (str): currency used to calculate trading fee - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC stop (str): stop_triggered (bool): stop_price (str): @@ -112,7 +112,9 @@ class TimeInForceEnum(Enum): description="Funds of filled transactions", alias="dealFunds") fee: Optional[str] = Field( - default=None, description="[Handling fees](doc://link/pages/5327739)") + default=None, + description= + "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)") fee_currency: Optional[str] = Field( default=None, description="currency used to calculate trading fee", @@ -120,7 +122,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC" ) stop: Optional[str] = None stop_triggered: Optional[bool] = Field(default=None, alias="stopTriggered") diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_open_orders_data.py b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_open_orders_data.py index 133cc1e..114198e 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_open_orders_data.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_open_orders_data.py @@ -28,7 +28,7 @@ class GetOpenOrdersData(BaseModel): deal_funds (str): Funds of filled transactions fee (str): trading fee fee_currency (str): currency used to calculate trading fee - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC stop (str): stop_triggered (bool): stop_price (str): @@ -128,7 +128,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC" ) stop: Optional[str] = None stop_triggered: Optional[bool] = Field(default=None, alias="stopTriggered") diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_order_by_client_oid_resp.py b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_order_by_client_oid_resp.py index 37b0a36..e5ed522 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_order_by_client_oid_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_order_by_client_oid_resp.py @@ -28,9 +28,9 @@ class GetOrderByClientOidResp(BaseModel, Response): funds (str): Order Funds deal_size (str): Number of filled transactions deal_funds (str): Funds of filled transactions - fee (str): [Handling fees](doc://link/pages/5327739) + fee (str): [Handling fees](https://www.kucoin.com/docs-new/api-5327739) fee_currency (str): currency used to calculate trading fee - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC stop (str): stop_triggered (bool): stop_price (str): @@ -125,7 +125,9 @@ class TimeInForceEnum(Enum): description="Funds of filled transactions", alias="dealFunds") fee: Optional[str] = Field( - default=None, description="[Handling fees](doc://link/pages/5327739)") + default=None, + description= + "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)") fee_currency: Optional[str] = Field( default=None, description="currency used to calculate trading fee", @@ -133,7 +135,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC" ) stop: Optional[str] = None stop_triggered: Optional[bool] = Field(default=None, alias="stopTriggered") diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_order_by_order_id_resp.py b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_order_by_order_id_resp.py index b60d8af..48e4679 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_order_by_order_id_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_order_by_order_id_resp.py @@ -28,9 +28,9 @@ class GetOrderByOrderIdResp(BaseModel, Response): funds (str): Order Funds deal_size (str): Number of filled transactions deal_funds (str): Funds of filled transactions - fee (str): [Handling fees](doc://link/pages/5327739) + fee (str): [Handling fees](https://www.kucoin.com/docs-new/api-5327739) fee_currency (str): currency used to calculate trading fee - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC stop (str): stop_triggered (bool): stop_price (str): @@ -125,7 +125,9 @@ class TimeInForceEnum(Enum): description="Funds of filled transactions", alias="dealFunds") fee: Optional[str] = Field( - default=None, description="[Handling fees](doc://link/pages/5327739)") + default=None, + description= + "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)") fee_currency: Optional[str] = Field( default=None, description="currency used to calculate trading fee", @@ -133,7 +135,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC" ) stop: Optional[str] = None stop_triggered: Optional[bool] = Field(default=None, alias="stopTriggered") diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_trade_history_items.py b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_trade_history_items.py index 55b81cd..7fee453 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_trade_history_items.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/order/model_get_trade_history_items.py @@ -27,7 +27,7 @@ class GetTradeHistoryItems(BaseModel): price (str): Order price size (str): Order size funds (str): Order Funds - fee (str): [Handling fees](doc://link/pages/5327739) + fee (str): [Handling fees](https://www.kucoin.com/docs-new/api-5327739) fee_rate (str): Fee rate fee_currency (str): currency used to calculate trading fee stop (str): Take Profit and Stop Loss type, currently HFT does not support the Take Profit and Stop Loss type, so it is empty @@ -88,7 +88,9 @@ class TypeEnum(Enum): size: Optional[str] = Field(default=None, description="Order size") funds: Optional[str] = Field(default=None, description="Order Funds") fee: Optional[str] = Field( - default=None, description="[Handling fees](doc://link/pages/5327739)") + default=None, + description= + "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)") fee_rate: Optional[str] = Field(default=None, description="Fee rate ", alias="feeRate") diff --git a/sdk/python/kucoin_universal_sdk/generate/margin/risklimit/api_risk_limit.py b/sdk/python/kucoin_universal_sdk/generate/margin/risklimit/api_risk_limit.py index f578770..a59466b 100644 --- a/sdk/python/kucoin_universal_sdk/generate/margin/risklimit/api_risk_limit.py +++ b/sdk/python/kucoin_universal_sdk/generate/margin/risklimit/api_risk_limit.py @@ -15,6 +15,7 @@ def get_margin_risk_limit(self, req: GetMarginRiskLimitReq, """ summary: Get Margin Risk Limit description: Request via this endpoint to get the Configure and Risk limit info of the margin. + documentation: https://www.kucoin.com/docs-new/api-3470219 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/market/api_market.py b/sdk/python/kucoin_universal_sdk/generate/spot/market/api_market.py index 8ee6fc2..10b188f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/market/api_market.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/market/api_market.py @@ -41,6 +41,7 @@ def get_private_token(self, **kwargs: Any) -> GetPrivateTokenResp: """ summary: Get Private Token - Spot/Margin description: This interface can obtain the token required for websocket to establish a Spot/Margin private connection. If you need use private channels(e.g. account balance notice), please make request as follows to obtain the server list and private token + documentation: https://www.kucoin.com/docs-new/api-3470295 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -58,6 +59,7 @@ def get_public_token(self, **kwargs: Any) -> GetPublicTokenResp: """ summary: Get Public Token - Spot/Margin description: This interface can obtain the token required for websocket to establish a Spot/Margin connection. If you need use public channels (e.g. all public market data), please make request as follows to obtain the server list and public token + documentation: https://www.kucoin.com/docs-new/api-3470294 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -75,6 +77,7 @@ def get_all_tickers(self, **kwargs: Any) -> GetAllTickersResp: """ summary: Get All Tickers description: Request market tickers for all the trading pairs in the market (including 24h volume), takes a snapshot every 2 seconds. On the rare occasion that we will change the currency name, if you still want the changed symbol name, you can use the symbolName field instead of the symbol field via “Get all tickers” endpoint. + documentation: https://www.kucoin.com/docs-new/api-3470167 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -92,6 +95,7 @@ def get_klines(self, req: GetKlinesReq, **kwargs: Any) -> GetKlinesResp: """ summary: Get Klines description: Get the Kline of the symbol. Data are returned in grouped buckets based on requested type. For each query, the system would return at most 1500 pieces of data. To obtain more data, please page the data by time. + documentation: https://www.kucoin.com/docs-new/api-3470163 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -110,6 +114,7 @@ def get_trade_history(self, req: GetTradeHistoryReq, """ summary: Get Trade History description: Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records. + documentation: https://www.kucoin.com/docs-new/api-3470162 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -127,6 +132,7 @@ def get_ticker(self, req: GetTickerReq, **kwargs: Any) -> GetTickerResp: """ summary: Get Ticker description: Request via this endpoint to get Level 1 Market Data. The returned value includes the best bid price and size, the best ask price and size as well as the last traded price and the last traded size. + documentation: https://www.kucoin.com/docs-new/api-3470160 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -145,6 +151,7 @@ def get_part_order_book(self, req: GetPartOrderBookReq, """ summary: Get Part OrderBook description: Query for part orderbook depth data. (aggregated by price) You are recommended to request via this endpoint as the system reponse would be faster and cosume less traffic. + documentation: https://www.kucoin.com/docs-new/api-3470165 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -163,6 +170,7 @@ def get24hr_stats(self, req: Get24hrStatsReq, """ summary: Get 24hr Stats description: Request via this endpoint to get the statistics of the specified ticker in the last 24 hours. + documentation: https://www.kucoin.com/docs-new/api-3470161 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -180,6 +188,7 @@ def get_market_list(self, **kwargs: Any) -> GetMarketListResp: """ summary: Get Market List description: Request via this endpoint to get the transaction currency for the entire trading market. + documentation: https://www.kucoin.com/docs-new/api-3470166 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -198,6 +207,7 @@ def get_fiat_price(self, req: GetFiatPriceReq, """ summary: Get Fiat Price description: Request via this endpoint to get the fiat price of the currencies for the available trading pairs. + documentation: https://www.kucoin.com/docs-new/api-3470153 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -215,6 +225,7 @@ def get_service_status(self, **kwargs: Any) -> GetServiceStatusResp: """ summary: Get Service Status description: Get the service status + documentation: https://www.kucoin.com/docs-new/api-3470158 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -232,6 +243,7 @@ def get_server_time(self, **kwargs: Any) -> GetServerTimeResp: """ summary: Get Server Time description: Get the server time. + documentation: https://www.kucoin.com/docs-new/api-3470156 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -250,6 +262,7 @@ def get_all_symbols(self, req: GetAllSymbolsReq, """ summary: Get All Symbols description: Request via this endpoint to get a list of available currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers. + documentation: https://www.kucoin.com/docs-new/api-3470154 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -267,6 +280,7 @@ def get_symbol(self, req: GetSymbolReq, **kwargs: Any) -> GetSymbolResp: """ summary: Get Symbol description: Request via this endpoint to get detail currency pairs for trading. If you want to get the market information of the trading symbol, please use Get All Tickers. + documentation: https://www.kucoin.com/docs-new/api-3470159 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -285,6 +299,7 @@ def get_announcements(self, req: GetAnnouncementsReq, """ summary: Get Announcements description: This interface can obtain the latest news announcements, and the default page search is for announcements within a month. + documentation: https://www.kucoin.com/docs-new/api-3470157 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -303,6 +318,7 @@ def get_currency(self, req: GetCurrencyReq, """ summary: Get Currency description: Request via this endpoint to get the currency details of a specified currency + documentation: https://www.kucoin.com/docs-new/api-3470155 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -320,6 +336,7 @@ def get_all_currencies(self, **kwargs: Any) -> GetAllCurrenciesResp: """ summary: Get All Currencies description: Request via this endpoint to get the currency list.Not all currencies currently can be used for trading. + documentation: https://www.kucoin.com/docs-new/api-3470152 +---------------------+--------+ | Extra API Info | Value | +---------------------+--------+ @@ -338,6 +355,7 @@ def get_full_order_book(self, req: GetFullOrderBookReq, """ summary: Get Full OrderBook description: Query for Full orderbook depth data. (aggregated by price) It is generally used by professional traders because it uses more server resources and traffic, and we have strict access rate limit control. To maintain up-to-date Order Book, please use Websocket incremental feed after retrieving the OrderBook. + documentation: https://www.kucoin.com/docs-new/api-3470164 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/market/model_get_all_symbols_req.py b/sdk/python/kucoin_universal_sdk/generate/spot/market/model_get_all_symbols_req.py index 52c64d1..7fc2140 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/market/model_get_all_symbols_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/market/model_get_all_symbols_req.py @@ -15,12 +15,13 @@ class GetAllSymbolsReq(BaseModel): GetAllSymbolsReq Attributes: - market (str): [The trading market](apidog://link/endpoint/222921786) + market (str): [The trading market](https://www.kucoin.com/docs-new/api-222921786) """ market: Optional[str] = Field( default=None, - description="[The trading market](apidog://link/endpoint/222921786)") + description= + "[The trading market](https://www.kucoin.com/docs-new/api-222921786)") __properties: ClassVar[List[str]] = ["market"] @@ -67,7 +68,7 @@ def __init__(self): def set_market(self, value: str) -> GetAllSymbolsReqBuilder: """ - [The trading market](apidog://link/endpoint/222921786) + [The trading market](https://www.kucoin.com/docs-new/api-222921786) """ self.obj['market'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/api_order.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/api_order.py index 9c73db6..8f52688 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/api_order.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/api_order.py @@ -108,6 +108,7 @@ def get_trade_history_old(self, req: GetTradeHistoryOldReq, """ summary: Get Trade History - Old description: Request via this endpoint to get the recent fills. The return value is the data after Pagination, sorted in descending order according to time. + documentation: https://www.kucoin.com/docs-new/api-3470350 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -126,6 +127,7 @@ def get_trade_history(self, req: GetTradeHistoryReq, """ summary: Get Trade History description: This endpoint can be used to obtain a list of the latest Spot transaction details. The returned data is sorted in descending order according to the latest update time of the order. + documentation: https://www.kucoin.com/docs-new/api-3470180 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -144,6 +146,7 @@ def get_open_orders(self, req: GetOpenOrdersReq, """ summary: Get Open Orders description: This interface is to obtain all Spot active order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + documentation: https://www.kucoin.com/docs-new/api-3470178 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -162,6 +165,7 @@ def get_symbols_with_open_order( """ summary: Get Symbols With Open Order description: This interface can query all spot symbol that has active orders + documentation: https://www.kucoin.com/docs-new/api-3470177 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -180,6 +184,7 @@ def modify_order(self, req: ModifyOrderReq, """ summary: Modify Order description: This interface can modify the price and quantity of the order according to orderId or clientOid. The implementation of this interface is: cancel the order and place a new order on the same trading pair, and return the modification result to the client synchronously When the quantity of the new order updated by the user is less than the filled quantity of this order, the order will be considered as completed, and the order will be cancelled, and no new order will be placed + documentation: https://www.kucoin.com/docs-new/api-3470171 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -197,6 +202,7 @@ def cancel_all_orders(self, **kwargs: Any) -> CancelAllOrdersResp: """ summary: Cancel All Orders description: This endpoint can cancel all spot orders for all symbol. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + documentation: https://www.kucoin.com/docs-new/api-3470176 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -215,6 +221,7 @@ def cancel_partial_order(self, req: CancelPartialOrderReq, """ summary: Cancel Partial Order description: This interface can cancel the specified quantity of the order according to the orderId. The order execution order is: price first, time first, this interface will not change the queue order + documentation: https://www.kucoin.com/docs-new/api-3470183 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -234,6 +241,7 @@ def cancel_order_by_client_oid( """ summary: Cancel Order By ClientOid description: This endpoint can be used to cancel a spot order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + documentation: https://www.kucoin.com/docs-new/api-3470184 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -252,6 +260,7 @@ def get_order_by_client_oid(self, req: GetOrderByClientOidReq, """ summary: Get Order By ClientOid description: This endpoint can be used to obtain information for a single Spot order using the client order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + documentation: https://www.kucoin.com/docs-new/api-3470182 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -269,6 +278,7 @@ def set_dcp(self, req: SetDcpReq, **kwargs: Any) -> SetDcpResp: """ summary: Set DCP description: Set Disconnection Protect(Deadman Swich)Through this interface, Call this interface to automatically cancel all orders of the set trading pair after the specified time. If this interface is not called again for renewal or cancellation before the set time, the system will help the user to cancel the order of the corresponding trading pair. Otherwise it will not. + documentation: https://www.kucoin.com/docs-new/api-3470173 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -286,6 +296,7 @@ def get_dcp(self, **kwargs: Any) -> GetDcpResp: """ summary: Get DCP description: Get Disconnection Protect(Deadman Swich)Through this interface, you can query the settings of automatic order cancellation + documentation: https://www.kucoin.com/docs-new/api-3470172 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -305,6 +316,7 @@ def cancel_all_orders_by_symbol( """ summary: Cancel All Orders By Symbol description: This endpoint can cancel all spot orders for specific symbol. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + documentation: https://www.kucoin.com/docs-new/api-3470175 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -323,6 +335,7 @@ def get_closed_orders(self, req: GetClosedOrdersReq, """ summary: Get Closed Orders description: This interface is to obtain all Spot closed order lists, and the return value of the active order interface is the paged data of all uncompleted order lists. The returned data is sorted in descending order according to the latest update time of the order. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + documentation: https://www.kucoin.com/docs-new/api-3470179 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -341,6 +354,7 @@ def batch_add_orders(self, req: BatchAddOrdersReq, """ summary: Batch Add Orders description: This endpoint supports sequential batch order placement from a single endpoint. A maximum of 5orders can be placed simultaneously. The order types must be limit orders of the same trading pair + documentation: https://www.kucoin.com/docs-new/api-3470168 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -359,6 +373,7 @@ def batch_add_orders_sync(self, req: BatchAddOrdersSyncReq, """ summary: Batch Add Orders Sync description: This endpoint supports sequential batch order placement from a single endpoint. A maximum of 5orders can be placed simultaneously. The order types must be limit orders of the same trading pair + documentation: https://www.kucoin.com/docs-new/api-3470169 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -377,6 +392,7 @@ def cancel_order_by_order_id(self, req: CancelOrderByOrderIdReq, """ summary: Cancel Order By OrderId description: This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + documentation: https://www.kucoin.com/docs-new/api-3470174 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -395,6 +411,7 @@ def get_order_by_order_id(self, req: GetOrderByOrderIdReq, """ summary: Get Order By OrderId description: This endpoint can be used to obtain information for a single Spot order using the order id. After the user successfully places an order, the order is in Active state, and the user can use inOrderBook to determine whether the order has entered the order. Canceled or fully filled orders are marked as completed Done status. + documentation: https://www.kucoin.com/docs-new/api-3470181 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -412,6 +429,7 @@ def add_order(self, req: AddOrderReq, **kwargs: Any) -> AddOrderResp: """ summary: Add Order description: Place order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + documentation: https://www.kucoin.com/docs-new/api-3470188 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -431,6 +449,7 @@ def cancel_order_by_client_oid_sync( """ summary: Cancel Order By ClientOid Sync description: This endpoint can be used to cancel a spot order by orderId. + documentation: https://www.kucoin.com/docs-new/api-3470186 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -450,6 +469,7 @@ def cancel_order_by_order_id_sync( """ summary: Cancel Order By OrderId Sync description: This endpoint can be used to cancel a spot order by orderId. + documentation: https://www.kucoin.com/docs-new/api-3470185 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -468,6 +488,7 @@ def add_order_sync(self, req: AddOrderSyncReq, """ summary: Add Order Sync description: Place order to the spot trading system The difference between this interface and \"Add order\" is that this interface will synchronously return the order information after the order matching is completed. For higher latency requirements, please select the \"Add order\" interface. If there is a requirement for returning data integrity, please select this interface + documentation: https://www.kucoin.com/docs-new/api-3470170 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -486,6 +507,7 @@ def add_order_test(self, req: AddOrderTestReq, """ summary: Add Order Test description: Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried. + documentation: https://www.kucoin.com/docs-new/api-3470187 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -506,6 +528,7 @@ def get_recent_trade_history_old( """ summary: Get Recent Trade History - Old description: Request via this endpoint to get a list of 1000 fills in the last 24 hours. The return value is the data after Pagination, sorted in descending order according to time. + documentation: https://www.kucoin.com/docs-new/api-3470351 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -526,6 +549,7 @@ def get_recent_orders_list_old( """ summary: Get Recent Orders List - Old description: Request via this endpoint to get your current order list. The return value is the data after Pagination, sorted in descending order according to time. + documentation: https://www.kucoin.com/docs-new/api-3470347 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -545,6 +569,7 @@ def cancel_order_by_client_oid_old( """ summary: Cancel Order By ClientOid - Old description: This endpoint can be used to cancel a spot order by clientOid. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + documentation: https://www.kucoin.com/docs-new/api-3470344 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -565,6 +590,7 @@ def get_order_by_client_oid_old( """ summary: Get Order By ClientOid - Old description: Request via this interface to check the information of a single active order via clientOid. The system will prompt that the order does not exists if the order does not exist or has been settled. + documentation: https://www.kucoin.com/docs-new/api-3470349 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -584,6 +610,7 @@ def batch_cancel_order_old(self, req: BatchCancelOrderOldReq, """ summary: Batch Cancel Order - Old description: Request via this endpoint to cancel all open orders. The response is a list of ids of the canceled orders. + documentation: https://www.kucoin.com/docs-new/api-3470345 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -603,6 +630,7 @@ def get_orders_list_old(self, req: GetOrdersListOldReq, """ summary: Get Orders List - Old description: Request via this endpoint to get your current order list. The return value is the data after Pagination, sorted in descending order according to time. + documentation: https://www.kucoin.com/docs-new/api-3470346 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -622,6 +650,7 @@ def batch_add_orders_old(self, req: BatchAddOrdersOldReq, """ summary: Batch Add Orders - Old description: Request via this endpoint to place 5 orders at the same time. The order type must be a limit order of the same symbol. + documentation: https://www.kucoin.com/docs-new/api-3470342 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -642,6 +671,7 @@ def cancel_order_by_order_id_old( """ summary: Cancel Order By OrderId - Old description: This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + documentation: https://www.kucoin.com/docs-new/api-3470343 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -661,6 +691,7 @@ def get_order_by_order_id_old(self, req: GetOrderByOrderIdOldReq, """ summary: Get Order By OrderId - Old description: Request via this endpoint to get a single order info by order ID. + documentation: https://www.kucoin.com/docs-new/api-3470348 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -680,6 +711,7 @@ def add_order_old(self, req: AddOrderOldReq, """ summary: Add Order - Old description: Place order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + documentation: https://www.kucoin.com/docs-new/api-3470333 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -699,6 +731,7 @@ def add_order_test_old(self, req: AddOrderTestOldReq, """ summary: Add Order Test - Old description: Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations. After placing an order, the order will not enter the matching system, and the order cannot be queried. + documentation: https://www.kucoin.com/docs-new/api-3470341 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -717,6 +750,7 @@ def batch_cancel_stop_order(self, req: BatchCancelStopOrderReq, """ summary: Batch Cancel Stop Orders description: This endpoint can be used to cancel a spot stop orders by batch. + documentation: https://www.kucoin.com/docs-new/api-3470337 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -737,6 +771,7 @@ def cancel_stop_order_by_client_oid( """ summary: Cancel Stop Order By ClientOid description: This endpoint can be used to cancel a spot stop order by clientOid. + documentation: https://www.kucoin.com/docs-new/api-3470336 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -755,6 +790,7 @@ def get_stop_orders_list(self, req: GetStopOrdersListReq, """ summary: Get Stop Orders List description: This interface is to obtain all Spot active stop order lists + documentation: https://www.kucoin.com/docs-new/api-3470338 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -775,6 +811,7 @@ def cancel_stop_order_by_order_id( """ summary: Cancel Stop Order By OrderId description: This endpoint can be used to cancel a spot stop order by orderId. + documentation: https://www.kucoin.com/docs-new/api-3470335 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -793,6 +830,7 @@ def get_stop_order_by_order_id(self, req: GetStopOrderByOrderIdReq, """ summary: Get Stop Order By OrderId description: This interface is to obtain Spot stop order details by orderId + documentation: https://www.kucoin.com/docs-new/api-3470339 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -812,6 +850,7 @@ def add_stop_order(self, req: AddStopOrderReq, """ summary: Add Stop Order description: Place stop order to the Spot trading system, you can place two major types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your funds will be put on hold for the duration of the order. The amount of funds on hold depends on the order type and parameters specified. + documentation: https://www.kucoin.com/docs-new/api-3470334 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -831,6 +870,7 @@ def get_stop_order_by_client_oid( """ summary: Get Stop Order By ClientOid description: This interface is to obtain Spot stop order details by orderId + documentation: https://www.kucoin.com/docs-new/api-3470340 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -851,6 +891,7 @@ def cancel_oco_order_by_client_oid( """ summary: Cancel OCO Order By ClientOid description: Request via this interface to cancel a stop order via the clientOid. You will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes. + documentation: https://www.kucoin.com/docs-new/api-3470355 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -871,6 +912,7 @@ def get_oco_order_by_client_oid( """ summary: Get OCO Order By ClientOid description: Request via this interface to get a oco order information via the client order ID. + documentation: https://www.kucoin.com/docs-new/api-3470358 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -891,6 +933,7 @@ def get_oco_order_detail_by_order_id( """ summary: Get OCO Order Detail By OrderId description: Request via this interface to get a oco order detail via the order ID. + documentation: https://www.kucoin.com/docs-new/api-3470359 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -911,6 +954,7 @@ def cancel_oco_order_by_order_id( """ summary: Cancel OCO Order By OrderId description: This endpoint can be used to cancel a spot order by orderId. This endpoint only sends cancellation requests. The results of the requests must be obtained by checking the order status or subscribing to websocket. + documentation: https://www.kucoin.com/docs-new/api-3470354 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -930,6 +974,7 @@ def get_oco_order_by_order_id(self, req: GetOcoOrderByOrderIdReq, """ summary: Get OCO Order By OrderId description: Request via this interface to get a oco order information via the order ID. + documentation: https://www.kucoin.com/docs-new/api-3470357 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -949,6 +994,7 @@ def add_oco_order(self, req: AddOcoOrderReq, """ summary: Add OCO Order description: Place OCO order to the Spot trading system + documentation: https://www.kucoin.com/docs-new/api-3470353 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -968,6 +1014,7 @@ def batch_cancel_oco_orders(self, req: BatchCancelOcoOrdersReq, """ summary: Batch Cancel OCO Order description: This interface can batch cancel OCO orders through orderIds. You will receive cancelledOrderIds field once the system has received the cancellation request. The cancellation request will be processed by the matching engine in sequence. To know if the request is processed (successfully or not), you may check the order status or the update message from the pushes. + documentation: https://www.kucoin.com/docs-new/api-3470356 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ @@ -987,6 +1034,7 @@ def get_oco_order_list(self, req: GetOcoOrderListReq, """ summary: Get OCO Order List description: Request via this endpoint to get your current OCO order list. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page. + documentation: https://www.kucoin.com/docs-new/api-3470360 +---------------------+---------+ | Extra API Info | Value | +---------------------+---------+ diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_old_req.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_old_req.py index 0b13d9a..a5dea8d 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_old_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_old_req.py @@ -21,10 +21,10 @@ class AddOrderOldReq(BaseModel): symbol (str): symbol type (TypeEnum): specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. remark (str): Order placement remarks, length cannot exceed 20 characters (ASCII) - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC price (str): Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/338146) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK hidden (bool): Hidden or not (not shown in order book) iceberg (bool): Whether or not only visible portions of orders are shown in iceberg orders @@ -107,7 +107,7 @@ class TradeTypeEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -122,7 +122,7 @@ class TradeTypeEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -276,7 +276,7 @@ def set_remark(self, value: str) -> AddOrderOldReqBuilder: def set_stp(self, value: AddOrderOldReq.StpEnum) -> AddOrderOldReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -299,7 +299,7 @@ def set_time_in_force( self, value: AddOrderOldReq.TimeInForceEnum) -> AddOrderOldReqBuilder: """ - [Time in force](doc://link/pages/338146) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading """ self.obj['timeInForce'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_req.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_req.py index 53b8837..85a6d2b 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_req.py @@ -21,13 +21,13 @@ class AddOrderReq(BaseModel): symbol (str): symbol type (TypeEnum): specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. remark (str): Order placement remarks, length cannot exceed 20 characters (ASCII) - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC price (str): Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/338146) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK - hidden (bool): [Hidden order](doc://link/pages/338146) or not (not shown in order book) - iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + hidden (bool): [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) + iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) visible_size (str): Maximum visible quantity in iceberg orders tags (str): Order tag, length cannot exceed 20 characters (ASCII) cancel_after (int): Cancel after n seconds，the order timing strategy is GTT @@ -98,7 +98,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -113,7 +113,7 @@ class TimeInForceEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -123,12 +123,12 @@ class TimeInForceEnum(Enum): hidden: Optional[bool] = Field( default=False, description= - "[Hidden order](doc://link/pages/338146) or not (not shown in order book)" + "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)" ) iceberg: Optional[bool] = Field( default=False, description= - "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)" + "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)" ) visible_size: Optional[str] = Field( default=None, @@ -263,7 +263,7 @@ def set_remark(self, value: str) -> AddOrderReqBuilder: def set_stp(self, value: AddOrderReq.StpEnum) -> AddOrderReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -285,7 +285,7 @@ def set_size(self, value: str) -> AddOrderReqBuilder: def set_time_in_force( self, value: AddOrderReq.TimeInForceEnum) -> AddOrderReqBuilder: """ - [Time in force](doc://link/pages/338146) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading """ self.obj['timeInForce'] = value return self @@ -299,14 +299,14 @@ def set_post_only(self, value: bool) -> AddOrderReqBuilder: def set_hidden(self, value: bool) -> AddOrderReqBuilder: """ - [Hidden order](doc://link/pages/338146) or not (not shown in order book) + [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) """ self.obj['hidden'] = value return self def set_iceberg(self, value: bool) -> AddOrderReqBuilder: """ - Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) """ self.obj['iceberg'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_sync_req.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_sync_req.py index 75cf94b..0f6d28c 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_sync_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_sync_req.py @@ -21,13 +21,13 @@ class AddOrderSyncReq(BaseModel): symbol (str): symbol type (TypeEnum): specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. remark (str): Order placement remarks, length cannot exceed 20 characters (ASCII) - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC price (str): Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/338146) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK - hidden (bool): [Hidden order](doc://link/pages/338146) or not (not shown in order book) - iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + hidden (bool): [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) + iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) visible_size (str): Maximum visible quantity in iceberg orders tags (str): Order tag, length cannot exceed 20 characters (ASCII) cancel_after (int): Cancel after n seconds，the order timing strategy is GTT @@ -98,7 +98,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -113,7 +113,7 @@ class TimeInForceEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -123,12 +123,12 @@ class TimeInForceEnum(Enum): hidden: Optional[bool] = Field( default=False, description= - "[Hidden order](doc://link/pages/338146) or not (not shown in order book)" + "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)" ) iceberg: Optional[bool] = Field( default=False, description= - "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)" + "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)" ) visible_size: Optional[str] = Field( default=None, @@ -267,7 +267,7 @@ def set_remark(self, value: str) -> AddOrderSyncReqBuilder: def set_stp(self, value: AddOrderSyncReq.StpEnum) -> AddOrderSyncReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -290,7 +290,7 @@ def set_time_in_force( self, value: AddOrderSyncReq.TimeInForceEnum) -> AddOrderSyncReqBuilder: """ - [Time in force](doc://link/pages/338146) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading """ self.obj['timeInForce'] = value return self @@ -304,14 +304,14 @@ def set_post_only(self, value: bool) -> AddOrderSyncReqBuilder: def set_hidden(self, value: bool) -> AddOrderSyncReqBuilder: """ - [Hidden order](doc://link/pages/338146) or not (not shown in order book) + [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) """ self.obj['hidden'] = value return self def set_iceberg(self, value: bool) -> AddOrderSyncReqBuilder: """ - Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) """ self.obj['iceberg'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_test_old_req.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_test_old_req.py index 69b31ea..54f13d9 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_test_old_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_test_old_req.py @@ -21,10 +21,10 @@ class AddOrderTestOldReq(BaseModel): symbol (str): symbol type (TypeEnum): specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. remark (str): Order placement remarks, length cannot exceed 20 characters (ASCII) - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC price (str): Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/338146) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK hidden (bool): Hidden or not (not shown in order book) iceberg (bool): Whether or not only visible portions of orders are shown in iceberg orders @@ -107,7 +107,7 @@ class TradeTypeEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -122,7 +122,7 @@ class TradeTypeEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -281,7 +281,7 @@ def set_stp( self, value: AddOrderTestOldReq.StpEnum) -> AddOrderTestOldReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -304,7 +304,7 @@ def set_time_in_force( self, value: AddOrderTestOldReq.TimeInForceEnum ) -> AddOrderTestOldReqBuilder: """ - [Time in force](doc://link/pages/338146) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading """ self.obj['timeInForce'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_test_req.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_test_req.py index 8136cc9..c3c0857 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_test_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_order_test_req.py @@ -21,13 +21,13 @@ class AddOrderTestReq(BaseModel): symbol (str): symbol type (TypeEnum): specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. remark (str): Order placement remarks, length cannot exceed 20 characters (ASCII) - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC price (str): Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/338146) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK - hidden (bool): [Hidden order](doc://link/pages/338146) or not (not shown in order book) - iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + hidden (bool): [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) + iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) visible_size (str): Maximum visible quantity in iceberg orders tags (str): Order tag, length cannot exceed 20 characters (ASCII) cancel_after (int): Cancel after n seconds，the order timing strategy is GTT @@ -98,7 +98,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -113,7 +113,7 @@ class TimeInForceEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -123,12 +123,12 @@ class TimeInForceEnum(Enum): hidden: Optional[bool] = Field( default=False, description= - "[Hidden order](doc://link/pages/338146) or not (not shown in order book)" + "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)" ) iceberg: Optional[bool] = Field( default=False, description= - "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)" + "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)" ) visible_size: Optional[str] = Field( default=None, @@ -267,7 +267,7 @@ def set_remark(self, value: str) -> AddOrderTestReqBuilder: def set_stp(self, value: AddOrderTestReq.StpEnum) -> AddOrderTestReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -290,7 +290,7 @@ def set_time_in_force( self, value: AddOrderTestReq.TimeInForceEnum) -> AddOrderTestReqBuilder: """ - [Time in force](doc://link/pages/338146) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading """ self.obj['timeInForce'] = value return self @@ -304,14 +304,14 @@ def set_post_only(self, value: bool) -> AddOrderTestReqBuilder: def set_hidden(self, value: bool) -> AddOrderTestReqBuilder: """ - [Hidden order](doc://link/pages/338146) or not (not shown in order book) + [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) """ self.obj['hidden'] = value return self def set_iceberg(self, value: bool) -> AddOrderTestReqBuilder: """ - Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) """ self.obj['iceberg'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_stop_order_req.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_stop_order_req.py index e2b0a2f..273eb26 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_stop_order_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_add_stop_order_req.py @@ -21,13 +21,13 @@ class AddStopOrderReq(BaseModel): symbol (str): symbol type (TypeEnum): specify if the order is an 'limit' order or 'market' order. The type of order you specify when you place your order determines whether or not you need to request other parameters and also affects the execution of the matching engine. When placing a limit order, you must specify a price and size. The system will try to match the order according to market price or a price better than market price. If the order cannot be immediately matched, it will stay in the order book until it is matched or the user cancels. Unlike limit orders, the price for market orders fluctuates with market prices. When placing a market order, you do not need to specify a price, you only need to specify a quantity. Market orders are filled immediately and will not enter the order book. All market orders are takers and a taker fee will be charged. remark (str): Order placement remarks, length cannot exceed 20 characters (ASCII) - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC price (str): Specify price for order, not need for market order. When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/338146) is a special strategy used during trading. Required for limit orders. + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading. Required for limit orders. post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK if **type** is limit. - hidden (bool): [Hidden order](doc://link/pages/338146) or not (not shown in order book) - iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + hidden (bool): [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) + iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) visible_size (str): When **type** is limit, this is Maximum visible quantity in iceberg orders. cancel_after (int): Cancel after n seconds，the order timing strategy is GTT when **type** is limit. funds (str): When **type** is market, select one out of two: size or funds @@ -99,7 +99,7 @@ class TimeInForceEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -114,7 +114,7 @@ class TimeInForceEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/338146) is a special strategy used during trading. Required for limit orders.", + "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading. Required for limit orders.", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -124,12 +124,12 @@ class TimeInForceEnum(Enum): hidden: Optional[bool] = Field( default=False, description= - "[Hidden order](doc://link/pages/338146) or not (not shown in order book)" + "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)" ) iceberg: Optional[bool] = Field( default=False, description= - "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)" + "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)" ) visible_size: Optional[str] = Field( default=None, @@ -277,7 +277,7 @@ def set_remark(self, value: str) -> AddStopOrderReqBuilder: def set_stp(self, value: AddStopOrderReq.StpEnum) -> AddStopOrderReqBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -300,7 +300,7 @@ def set_time_in_force( self, value: AddStopOrderReq.TimeInForceEnum) -> AddStopOrderReqBuilder: """ - [Time in force](doc://link/pages/338146) is a special strategy used during trading. Required for limit orders. + [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading. Required for limit orders. """ self.obj['timeInForce'] = value return self @@ -314,14 +314,14 @@ def set_post_only(self, value: bool) -> AddStopOrderReqBuilder: def set_hidden(self, value: bool) -> AddStopOrderReqBuilder: """ - [Hidden order](doc://link/pages/338146) or not (not shown in order book) + [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) """ self.obj['hidden'] = value return self def set_iceberg(self, value: bool) -> AddStopOrderReqBuilder: """ - Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) """ self.obj['iceberg'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_old_order_list.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_old_order_list.py index 324da80..aff128c 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_old_order_list.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_old_order_list.py @@ -21,10 +21,10 @@ class BatchAddOrdersOldOrderList(BaseModel): symbol (str): symbol type (TypeEnum): only limit (default is limit) remark (str): Order placement remarks, length cannot exceed 20 characters (ASCII) - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC price (str): Specify price for order When placing a limit order, the price must be based on priceIncrement for the trading pair. The price increment (priceIncrement) is the price precision for the trading pair. For example, for the BTC-USDT trading pair, the priceIncrement is 0.00001000. So the price for your orders cannot be less than 0.00001000 and must be a multiple of priceIncrement. Otherwise, the order will return an invalid priceIncrement error. size (str): Specify quantity for order When **type** is limit, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/338146) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK hidden (bool): Hidden or not (not shown in order book) iceberg (bool): Whether or not only visible portions of orders are shown in iceberg orders @@ -110,7 +110,7 @@ class StopEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC" ) price: Optional[str] = Field( default=None, @@ -125,7 +125,7 @@ class StopEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", alias="timeInForce") post_only: Optional[bool] = Field( default=False, @@ -289,7 +289,7 @@ def set_stp( self, value: BatchAddOrdersOldOrderList.StpEnum ) -> BatchAddOrdersOldOrderListBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -312,7 +312,7 @@ def set_time_in_force( self, value: BatchAddOrdersOldOrderList.TimeInForceEnum ) -> BatchAddOrdersOldOrderListBuilder: """ - [Time in force](doc://link/pages/338146) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading """ self.obj['timeInForce'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_order_list.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_order_list.py index c0c0b29..370eb4a 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_order_list.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_order_list.py @@ -19,15 +19,15 @@ class BatchAddOrdersOrderList(BaseModel): client_oid (str): Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters. symbol (str): symbol type (TypeEnum): Specify if the order is an 'limit' order or 'market' order. - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/338146) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading side (SideEnum): Specify if the order is to 'buy' or 'sell' price (str): Specify price for order size (str): Specify quantity for order When **type** is limit, select one out of two: size or funds, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC cancel_after (int): Cancel after n seconds，the order timing strategy is GTT post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK - hidden (bool): [Hidden order](doc://link/pages/338146) or not (not shown in order book) - iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + hidden (bool): [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) + iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) visible_size (str): Maximum visible quantity in iceberg orders tags (str): Order tag, length cannot exceed 20 characters (ASCII) remark (str): Order placement remarks, length cannot exceed 20 characters (ASCII) @@ -89,7 +89,7 @@ class StpEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", alias="timeInForce") side: Optional[SideEnum] = Field( default=None, description="Specify if the order is to 'buy' or 'sell'") @@ -103,7 +103,7 @@ class StpEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC" ) cancel_after: Optional[int] = Field( default=None, @@ -117,12 +117,12 @@ class StpEnum(Enum): hidden: Optional[bool] = Field( default=False, description= - "[Hidden order](doc://link/pages/338146) or not (not shown in order book)" + "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)" ) iceberg: Optional[bool] = Field( default=False, description= - "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)" + "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)" ) visible_size: Optional[str] = Field( default=None, @@ -250,7 +250,7 @@ def set_time_in_force( self, value: BatchAddOrdersOrderList.TimeInForceEnum ) -> BatchAddOrdersOrderListBuilder: """ - [Time in force](doc://link/pages/338146) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading """ self.obj['timeInForce'] = value return self @@ -282,7 +282,7 @@ def set_stp( self, value: BatchAddOrdersOrderList.StpEnum ) -> BatchAddOrdersOrderListBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -303,14 +303,14 @@ def set_post_only(self, value: bool) -> BatchAddOrdersOrderListBuilder: def set_hidden(self, value: bool) -> BatchAddOrdersOrderListBuilder: """ - [Hidden order](doc://link/pages/338146) or not (not shown in order book) + [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) """ self.obj['hidden'] = value return self def set_iceberg(self, value: bool) -> BatchAddOrdersOrderListBuilder: """ - Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) """ self.obj['iceberg'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_sync_order_list.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_sync_order_list.py index bfcc0be..a89b265 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_sync_order_list.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_batch_add_orders_sync_order_list.py @@ -19,15 +19,15 @@ class BatchAddOrdersSyncOrderList(BaseModel): client_oid (str): Client Order Id，The ClientOid field is a unique ID created by the user（we recommend using a UUID）, and can only contain numbers, letters, underscores （_）, and hyphens （-）. This field is returned when order information is obtained. You can use clientOid to tag your orders. ClientOid is different from the order ID created by the service provider. Please do not initiate requests using the same clientOid. The maximum length for the ClientOid is 40 characters. symbol (str): symbol type (TypeEnum): Specify if the order is an 'limit' order or 'market' order. - time_in_force (TimeInForceEnum): [Time in force](doc://link/pages/338146) is a special strategy used during trading + time_in_force (TimeInForceEnum): [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading side (SideEnum): Specify if the order is to 'buy' or 'sell' price (str): Specify price for order size (str): Specify quantity for order When **type** is limit, select one out of two: size or funds, size refers to the amount of trading targets (the asset name written in front) for the trading pair. Teh Size must be based on the baseIncrement of the trading pair. The baseIncrement represents the precision for the trading pair. The size of an order must be a positive-integer multiple of baseIncrement and must be between baseMinSize and baseMaxSize. When **type** is market, select one out of two: size or funds - stp (StpEnum): [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC cancel_after (int): Cancel after n seconds，the order timing strategy is GTT post_only (bool): passive order labels, this is disabled when the order timing strategy is IOC or FOK - hidden (bool): [Hidden order](doc://link/pages/338146) or not (not shown in order book) - iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + hidden (bool): [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) + iceberg (bool): Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) visible_size (str): Maximum visible quantity in iceberg orders tags (str): Order tag, length cannot exceed 20 characters (ASCII) remark (str): Order placement remarks, length cannot exceed 20 characters (ASCII) @@ -89,7 +89,7 @@ class StpEnum(Enum): time_in_force: Optional[TimeInForceEnum] = Field( default=TimeInForceEnum.GTC, description= - "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", alias="timeInForce") side: Optional[SideEnum] = Field( default=None, description="Specify if the order is to 'buy' or 'sell'") @@ -103,7 +103,7 @@ class StpEnum(Enum): stp: Optional[StpEnum] = Field( default=None, description= - "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC" + "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC" ) cancel_after: Optional[int] = Field( default=None, @@ -117,12 +117,12 @@ class StpEnum(Enum): hidden: Optional[bool] = Field( default=False, description= - "[Hidden order](doc://link/pages/338146) or not (not shown in order book)" + "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)" ) iceberg: Optional[bool] = Field( default=False, description= - "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)" + "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)" ) visible_size: Optional[str] = Field( default=None, @@ -250,7 +250,7 @@ def set_time_in_force( self, value: BatchAddOrdersSyncOrderList.TimeInForceEnum ) -> BatchAddOrdersSyncOrderListBuilder: """ - [Time in force](doc://link/pages/338146) is a special strategy used during trading + [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading """ self.obj['timeInForce'] = value return self @@ -282,7 +282,7 @@ def set_stp( self, value: BatchAddOrdersSyncOrderList.StpEnum ) -> BatchAddOrdersSyncOrderListBuilder: """ - [Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC + [Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC """ self.obj['stp'] = value return self @@ -304,14 +304,14 @@ def set_post_only(self, value: bool) -> BatchAddOrdersSyncOrderListBuilder: def set_hidden(self, value: bool) -> BatchAddOrdersSyncOrderListBuilder: """ - [Hidden order](doc://link/pages/338146) or not (not shown in order book) + [Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book) """ self.obj['hidden'] = value return self def set_iceberg(self, value: bool) -> BatchAddOrdersSyncOrderListBuilder: """ - Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146) + Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146) """ self.obj['iceberg'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_closed_orders_items.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_closed_orders_items.py index be2eecd..2e862ca 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_closed_orders_items.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_closed_orders_items.py @@ -26,9 +26,9 @@ class GetClosedOrdersItems(BaseModel): funds (str): Order Funds deal_size (str): Number of filled transactions deal_funds (str): Funds of filled transactions - fee (str): [Handling fees](doc://link/pages/5327739) + fee (str): [Handling fees](https://www.kucoin.com/docs-new/api-5327739) fee_currency (str): currency used to calculate trading fee - stp (StpEnum): [Self Trade Prevention](doc://link/pages/5176570) + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) time_in_force (TimeInForceEnum): Time in force post_only (bool): Whether its a postOnly order. hidden (bool): Whether its a hidden order. @@ -118,14 +118,17 @@ class TimeInForceEnum(Enum): description="Funds of filled transactions", alias="dealFunds") fee: Optional[str] = Field( - default=None, description="[Handling fees](doc://link/pages/5327739)") + default=None, + description= + "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)") fee_currency: Optional[str] = Field( default=None, description="currency used to calculate trading fee", alias="feeCurrency") stp: Optional[StpEnum] = Field( default=None, - description="[Self Trade Prevention](doc://link/pages/5176570)") + description= + "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)") time_in_force: Optional[TimeInForceEnum] = Field( default=None, description="Time in force", alias="timeInForce") post_only: Optional[bool] = Field( diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_open_orders_data.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_open_orders_data.py index 3a6331f..ce89672 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_open_orders_data.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_open_orders_data.py @@ -26,9 +26,9 @@ class GetOpenOrdersData(BaseModel): funds (str): Order Funds deal_size (str): Number of filled transactions deal_funds (str): Funds of filled transactions - fee (str): [Handling fees](doc://link/pages/5327739) + fee (str): [Handling fees](https://www.kucoin.com/docs-new/api-5327739) fee_currency (str): currency used to calculate trading fee - stp (StpEnum): [Self Trade Prevention](doc://link/pages/5176570) + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) time_in_force (TimeInForceEnum): Time in force post_only (bool): Whether its a postOnly order. hidden (bool): Whether its a hidden order. @@ -118,14 +118,17 @@ class TimeInForceEnum(Enum): description="Funds of filled transactions", alias="dealFunds") fee: Optional[str] = Field( - default=None, description="[Handling fees](doc://link/pages/5327739)") + default=None, + description= + "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)") fee_currency: Optional[str] = Field( default=None, description="currency used to calculate trading fee", alias="feeCurrency") stp: Optional[StpEnum] = Field( default=None, - description="[Self Trade Prevention](doc://link/pages/5176570)") + description= + "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)") time_in_force: Optional[TimeInForceEnum] = Field( default=None, description="Time in force", alias="timeInForce") post_only: Optional[bool] = Field( diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_order_by_client_oid_resp.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_order_by_client_oid_resp.py index 1fb2cf3..374eeda 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_order_by_client_oid_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_order_by_client_oid_resp.py @@ -28,9 +28,9 @@ class GetOrderByClientOidResp(BaseModel, Response): funds (str): Order Funds deal_size (str): Number of filled transactions deal_funds (str): Funds of filled transactions - fee (str): [Handling fees](doc://link/pages/5327739) + fee (str): [Handling fees](https://www.kucoin.com/docs-new/api-5327739) fee_currency (str): currency used to calculate trading fee - stp (StpEnum): [Self Trade Prevention](doc://link/pages/5176570) + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) time_in_force (TimeInForceEnum): Time in force post_only (bool): Whether its a postOnly order. hidden (bool): Whether its a hidden order. @@ -122,14 +122,17 @@ class TimeInForceEnum(Enum): description="Funds of filled transactions", alias="dealFunds") fee: Optional[str] = Field( - default=None, description="[Handling fees](doc://link/pages/5327739)") + default=None, + description= + "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)") fee_currency: Optional[str] = Field( default=None, description="currency used to calculate trading fee", alias="feeCurrency") stp: Optional[StpEnum] = Field( default=None, - description="[Self Trade Prevention](doc://link/pages/5176570)") + description= + "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)") time_in_force: Optional[TimeInForceEnum] = Field( default=None, description="Time in force", alias="timeInForce") post_only: Optional[bool] = Field( diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_order_by_order_id_resp.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_order_by_order_id_resp.py index 87a8a32..61e03c1 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_order_by_order_id_resp.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_order_by_order_id_resp.py @@ -28,9 +28,9 @@ class GetOrderByOrderIdResp(BaseModel, Response): funds (str): Order Funds deal_size (str): Number of filled transactions deal_funds (str): Funds of filled transactions - fee (str): [Handling fees](doc://link/pages/5327739) + fee (str): [Handling fees](https://www.kucoin.com/docs-new/api-5327739) fee_currency (str): currency used to calculate trading fee - stp (StpEnum): [Self Trade Prevention](doc://link/pages/5176570) + stp (StpEnum): [Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) time_in_force (TimeInForceEnum): Time in force post_only (bool): Whether its a postOnly order. hidden (bool): Whether its a hidden order. @@ -122,14 +122,17 @@ class TimeInForceEnum(Enum): description="Funds of filled transactions", alias="dealFunds") fee: Optional[str] = Field( - default=None, description="[Handling fees](doc://link/pages/5327739)") + default=None, + description= + "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)") fee_currency: Optional[str] = Field( default=None, description="currency used to calculate trading fee", alias="feeCurrency") stp: Optional[StpEnum] = Field( default=None, - description="[Self Trade Prevention](doc://link/pages/5176570)") + description= + "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)") time_in_force: Optional[TimeInForceEnum] = Field( default=None, description="Time in force", alias="timeInForce") post_only: Optional[bool] = Field( diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_items.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_items.py index 7f656ec..627ba17 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_items.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_items.py @@ -27,7 +27,7 @@ class GetTradeHistoryItems(BaseModel): price (str): Order price size (str): Order size funds (str): Order Funds - fee (str): [Handling fees](doc://link/pages/5327739) + fee (str): [Handling fees](https://www.kucoin.com/docs-new/api-5327739) fee_rate (str): Fee rate fee_currency (str): currency used to calculate trading fee stop (str): Take Profit and Stop Loss type, currently HFT does not support the Take Profit and Stop Loss type, so it is empty @@ -88,7 +88,9 @@ class TypeEnum(Enum): size: Optional[str] = Field(default=None, description="Order size") funds: Optional[str] = Field(default=None, description="Order Funds") fee: Optional[str] = Field( - default=None, description="[Handling fees](doc://link/pages/5327739)") + default=None, + description= + "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)") fee_rate: Optional[str] = Field(default=None, description="Fee rate ", alias="feeRate") diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_old_items.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_old_items.py index 0e15b15..e68b203 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_old_items.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_old_items.py @@ -25,7 +25,7 @@ class GetTradeHistoryOldItems(BaseModel): price (str): Order price size (str): Order size funds (str): Order Funds - fee (str): [Handling fees](doc://link/pages/5327739) + fee (str): [Handling fees](https://www.kucoin.com/docs-new/api-5327739) fee_rate (str): Fee rate fee_currency (str): currency used to calculate trading fee stop (str): Take Profit and Stop Loss type, currently HFT does not support the Take Profit and Stop Loss type, so it is empty @@ -52,7 +52,9 @@ class GetTradeHistoryOldItems(BaseModel): size: Optional[str] = Field(default=None, description="Order size") funds: Optional[str] = Field(default=None, description="Order Funds") fee: Optional[str] = Field( - default=None, description="[Handling fees](doc://link/pages/5327739)") + default=None, + description= + "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)") fee_rate: Optional[str] = Field(default=None, description="Fee rate ", alias="feeRate") diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_req.py b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_req.py index 179f288..f988295 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_req.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/order/model_get_trade_history_req.py @@ -22,7 +22,7 @@ class GetTradeHistoryReq(BaseModel): side (SideEnum): specify if the order is to 'buy' or 'sell' type (TypeEnum): specify if the order is an 'limit' order or 'market' order. last_id (int): The id of the last set of data from the previous batch of data. By default, the latest information is given. lastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page. - limit (int): Default100，Max100 + limit (int): Default20，Max100 start_at (int): Start time (milisecond) end_at (int): End time (milisecond) """ @@ -63,7 +63,7 @@ class TypeEnum(Enum): "The id of the last set of data from the previous batch of data. By default, the latest information is given. lastId is used to filter data and paginate. If lastId is not entered, the default is a maximum of 100 returned data items. The return results include lastId，which can be used as a query parameter to look up new data from the next page.", alias="lastId") limit: Optional[Annotated[int, Field(le=100, strict=True, ge=1)]] = Field( - default=20, description="Default100，Max100") + default=20, description="Default20，Max100") start_at: Optional[int] = Field(default=None, description="Start time (milisecond)", alias="startAt") @@ -176,7 +176,7 @@ def set_last_id(self, value: int) -> GetTradeHistoryReqBuilder: def set_limit(self, value: int) -> GetTradeHistoryReqBuilder: """ - Default100，Max100 + Default20，Max100 """ self.obj['limit'] = value return self diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/spot_private/model_order_v1_event.py b/sdk/python/kucoin_universal_sdk/generate/spot/spot_private/model_order_v1_event.py index 61e8430..e32906f 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/spot_private/model_order_v1_event.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/spot_private/model_order_v1_event.py @@ -36,7 +36,7 @@ class OrderV1Event(BaseModel): type (TypeEnum): Order Type old_size (str): The size before order update fee_type (FeeTypeEnum): Actual Fee Type - liquidity (LiquidityEnum): Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** + liquidity (LiquidityEnum): Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** match_price (str): Match Price (when the type is \"match\") match_size (str): Match Size (when the type is \"match\") trade_id (str): Trade id, it is generated by Matching engine. @@ -161,7 +161,7 @@ class LiquidityEnum(Enum): liquidity: Optional[LiquidityEnum] = Field( default=None, description= - "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** " + "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** " ) match_price: Optional[str] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/spot/spot_private/model_order_v2_event.py b/sdk/python/kucoin_universal_sdk/generate/spot/spot_private/model_order_v2_event.py index e32b134..19e3d7c 100644 --- a/sdk/python/kucoin_universal_sdk/generate/spot/spot_private/model_order_v2_event.py +++ b/sdk/python/kucoin_universal_sdk/generate/spot/spot_private/model_order_v2_event.py @@ -36,7 +36,7 @@ class OrderV2Event(BaseModel): type (TypeEnum): Order Type old_size (str): The size before order update fee_type (FeeTypeEnum): Actual Fee Type - liquidity (LiquidityEnum): Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** + liquidity (LiquidityEnum): Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** match_price (str): Match Price (when the type is \"match\") match_size (str): Match Size (when the type is \"match\") trade_id (str): Trade id, it is generated by Matching engine. @@ -162,7 +162,7 @@ class LiquidityEnum(Enum): liquidity: Optional[LiquidityEnum] = Field( default=None, description= - "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** " + "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** " ) match_price: Optional[str] = Field( default=None, diff --git a/sdk/python/kucoin_universal_sdk/generate/version.py b/sdk/python/kucoin_universal_sdk/generate/version.py index 5224fcb..f09ff01 100644 --- a/sdk/python/kucoin_universal_sdk/generate/version.py +++ b/sdk/python/kucoin_universal_sdk/generate/version.py @@ -1,2 +1,2 @@ -sdk_version = "v0.1.1-alpha" -sdk_generate_date = "2024-12-17" +sdk_version = "v1.0.0" +sdk_generate_date = "2024-12-30" diff --git a/sdk/python/kucoin_universal_sdk/generate/viplending/viplending/api_vip_lending.py b/sdk/python/kucoin_universal_sdk/generate/viplending/viplending/api_vip_lending.py index a361cac..cc089fb 100644 --- a/sdk/python/kucoin_universal_sdk/generate/viplending/viplending/api_vip_lending.py +++ b/sdk/python/kucoin_universal_sdk/generate/viplending/viplending/api_vip_lending.py @@ -14,6 +14,7 @@ def get_accounts(self, **kwargs: Any) -> GetAccountsResp: """ summary: Get Accounts description: Accounts participating in OTC lending, This interface is only for querying accounts currently running OTC lending. + documentation: https://www.kucoin.com/docs-new/api-3470278 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ @@ -31,6 +32,7 @@ def get_account_detail(self, **kwargs: Any) -> GetAccountDetailResp: """ summary: Get Account Detail description: The following information is only applicable to loans. Get information on off-exchange funding and loans, This endpoint is only for querying accounts that are currently involved in loans. + documentation: https://www.kucoin.com/docs-new/api-3470277 +---------------------+------------+ | Extra API Info | Value | +---------------------+------------+ diff --git a/sdk/python/setup.py b/sdk/python/setup.py index dc38b7d..aed9d18 100644 --- a/sdk/python/setup.py +++ b/sdk/python/setup.py @@ -2,7 +2,7 @@ setup( name="kucoin-universal-sdk", - version="0.1.1a1", + version="1.0.0", description="Official KuCoin Universal SDK", author="KuCoin", author_email="api@kucoin.com", diff --git a/spec/apis.csv b/spec/apis.csv index ec85c89..a9eb5a6 100644 --- a/spec/apis.csv +++ b/spec/apis.csv @@ -10,7 +10,7 @@ account,account,/api/v1/accounts/{accountId},get,Get Account Detail - Spot account,account,/api/v3/margin/accounts,get,Get Account - Cross Margin account,account,/api/v3/isolated/accounts,get,Get Account - Isolated Margin account,account,/api/v1/account-overview,get,Get Account - Futures -account,account,/api/v1/user/api-key,get,Get API Key Info +account,account,/api/v1/user/api-key,get,Get Apikey Info account,account,/api/v1/margin/account,get,Get Account Detail - Margin account,account,/api/v1/isolated/accounts,get,Get Account List - Isolated Margin - V1 account,account,/api/v1/isolated/account/{symbol},get,Get Account Detail - Isolated Margin - V1 @@ -27,7 +27,7 @@ account,subaccount,/api/v1/sub/api-key,post,Add SubAccount API account,subaccount,/api/v1/sub/api-key/update,post,Modify SubAccount API account,subaccount,/api/v1/sub/user,get,Get SubAccount List - Summary Info(V1) account,subaccount,/api/v1/sub-accounts,get,Get SubAccount List - Spot Balance(V1) -account,deposit,/api/v3/deposit-addresses,get,Get Deposit Addresses(V3) +account,deposit,/api/v3/deposit-addresses,get,Get Deposit Address(V3) account,deposit,/api/v1/deposits,get,Get Deposit History account,deposit,/api/v3/deposit-address/create,post,Add Deposit Address(V3) account,deposit,/api/v2/deposit-addresses,get,Get Deposit Addresses(V2) diff --git a/spec/original/meta.json b/spec/original/meta.json index 5055313..5a45118 100644 --- a/spec/original/meta.json +++ b/spec/original/meta.json @@ -6,7 +6,7 @@ "description": "", "items": [ { - "name": "API User Service", + "name": "User Service", "id": 348126, "description": "", "items": [] @@ -428,7 +428,7 @@ "responseExamples": [ { "name": "Success", - "data": "{\n \"code\": \"200000\",\n \"data\": {\n \"currentPage\": 1,\n \"pageSize\": 50,\n \"totalNum\": 1,\n \"totalPage\": 1,\n \"items\": [\n {\n \"id\": \"265329987780896\",\n \"currency\": \"USDT\",\n \"amount\": \"0.01\",\n \"fee\": \"0\",\n \"balance\": \"0\",\n \"accountType\": \"TRADE\",\n \"bizType\": \"子账号转账\",\n \"direction\": \"out\",\n \"createdAt\": 1728658481484,\n \"context\": \"\"\n }\n ]\n }\n}", + "data": "{\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}", "responseId": 10085, "ordering": 1 } @@ -2061,7 +2061,7 @@ } }, { - "name": "Get API Key Info", + "name": "Get Apikey Info", "api": { "id": "3470130", "method": "get", @@ -3912,13 +3912,12 @@ "description": "", "items": [ { - "name": "Get Deposit Addresses(V3)", + "name": "Get Deposit Address(V3)", "api": { "id": "3470140", "method": "get", "path": "/api/v3/deposit-addresses", "parameters": { - "path": [], "query": [ { "id": "iIrspuNh6x", @@ -3934,23 +3933,27 @@ "ETH", "USDT" ] - } + }, + "enable": true }, { "id": "xpmD1ldX5o", "name": "amount", "required": false, "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.", - "type": "string" + "type": "string", + "enable": true }, { "id": "eO27DXUL3U", "name": "chain", "required": false, "description": "The chain Id of currency.", - "type": "string" + "type": "string", + "enable": true } ], + "path": [], "cookie": [], "header": [] }, @@ -5087,8 +5090,8 @@ "method": "post", "path": "/api/v3/withdrawals", "parameters": { - "path": [], "query": [], + "path": [], "cookie": [], "header": [] }, @@ -5191,7 +5194,13 @@ }, "toAddress": { "type": "string", - "description": "Withdrawal address" + "description": "Withdrawal address", + "examples": [ + "0x023****2355", + "1572**401", + "a431***1e@gmail.com", + "55-12341234" + ] }, "withdrawType": { "type": "string", @@ -15877,7 +15886,7 @@ "id": "heQ8W6yKwm", "name": "limit", "required": false, - "description": "Default100，Max100", + "description": "Default20，Max100", "example": "100", "type": "integer", "schema": { @@ -45518,7 +45527,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](apidog://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](apidog://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -45558,7 +45567,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](apidog://link/pages/5176570) is a special strategy used during trading", + "description": "[Time in force](apidog://link/pages/338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -46590,7 +46599,7 @@ "mediaType": "" }, "description": ":::tip[TIPS]\nIt is recommended to use the **DELETE /api/v3/orders** endpoint instead of this endpoint\n:::\n\n:::info[Description]\nUsing this endpoint, all open orders (excluding stop orders) can be canceled in batches.\n\nThe response is a list of orderIDs of the canceled orders.\n:::\n", - "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllOrdersV1\",\"sdk-method-description\":\"Cancel all open orders (excluding stop orders). The response is a list of orderIDs of the canceled orders.\",\"api-rate-limit\":30}" + "customApiFields": "{\"abandon\":\"abandon\",\"domain\":\"Futures\",\"api-channel\":\"Private\",\"api-permission\":\"Futures\",\"api-rate-limit-pool\":\"Futures\",\"sdk-service\":\"Futures\",\"sdk-sub-service\":\"Order\",\"sdk-method-name\":\"cancelAllOrdersV1\",\"sdk-method-description\":\"Cancel all open orders (excluding stop orders). The response is a list of orderIDs of the canceled orders.\",\"api-rate-limit\":200}" } } ] @@ -51562,5 +51571,32 @@ } ] } + ], + "doc_id": [ + 338144, + 338145, + 338146, + 338147, + 338148, + 338149, + 338150, + 338151, + 338152, + 338153, + 338154, + 338155, + 338156, + 338157, + 338158, + 338159, + 338160, + 338161, + 338162, + 338163, + 338164, + 338165, + 338166, + 338167, + 338168 ] } \ No newline at end of file diff --git a/spec/rest/api/openapi-account-account.json b/spec/rest/api/openapi-account-account.json index 8c4404e..7f5ab32 100644 --- a/spec/rest/api/openapi-account-account.json +++ b/spec/rest/api/openapi-account-account.json @@ -102,6 +102,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470119", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -147,6 +148,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470120", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -351,6 +353,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470121", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -361,7 +364,7 @@ "x-sdk-method-name": "getSpotLedger", "x-sdk-method-description": "This interface is for transaction records from all types of your accounts, supporting inquiry of various currencies. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.", "x-api-rate-limit": 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\\\": \\\"\\u5b50\\u8d26\\u53f7\\u8f6c\\u8d26\\\",\\n \\\"direction\\\": \\\"out\\\",\\n \\\"createdAt\\\": 1728658481484,\\n \\\"context\\\": \\\"\\\"\\n }\\n ]\\n }\\n}", + "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}" } }, @@ -575,6 +578,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470122", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -755,6 +759,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470123", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -936,6 +941,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470124", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1069,6 +1075,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470125", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1148,6 +1155,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470126", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1368,6 +1376,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470127", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1665,6 +1674,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470128", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1779,6 +1789,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470129", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1795,7 +1806,7 @@ }, "/api/v1/user/api-key": { "get": { - "summary": "Get API Key Info", + "summary": "Get Apikey Info", "deprecated": false, "description": "Get the information of the api key. Use the api key pending to be checked to call the endpoint. Both master and sub user's api key are applicable.", "tags": [], @@ -1828,7 +1839,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn" }, "ipWhitelist": { "type": "string", @@ -1872,6 +1883,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470130", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1967,6 +1979,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470311", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -2215,6 +2228,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470314", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -2419,6 +2433,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470315", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-account-deposit.json b/spec/rest/api/openapi-account-deposit.json index 74a68a3..8e6c3e6 100644 --- a/spec/rest/api/openapi-account-deposit.json +++ b/spec/rest/api/openapi-account-deposit.json @@ -9,7 +9,7 @@ "paths": { "/api/v3/deposit-addresses": { "get": { - "summary": "Get Deposit Addresses(V3)", + "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 Deposit Address first.", "tags": [], @@ -134,6 +134,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470140", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -386,6 +387,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470141", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -486,6 +488,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470142", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -688,6 +691,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470300", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -842,6 +846,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470305", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -962,6 +967,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470309", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -1192,6 +1198,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470306", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-account-fee.json b/spec/rest/api/openapi-account-fee.json index 247ac1e..ea46adb 100644 --- a/spec/rest/api/openapi-account-fee.json +++ b/spec/rest/api/openapi-account-fee.json @@ -82,6 +82,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470149", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -163,6 +164,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470150", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -240,6 +242,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470151", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-account-subaccount.json b/spec/rest/api/openapi-account-subaccount.json index 4e83d25..e6aa903 100644 --- a/spec/rest/api/openapi-account-subaccount.json +++ b/spec/rest/api/openapi-account-subaccount.json @@ -200,6 +200,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470131", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -409,6 +410,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470132", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -655,6 +657,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470133", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -818,6 +821,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470134", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -887,6 +891,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470135", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -988,6 +993,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470331", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1053,6 +1059,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470332", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1147,7 +1154,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144)" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)" }, "ipWhitelist": { "type": "string", @@ -1179,6 +1186,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470136", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1264,6 +1272,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470137", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1323,7 +1332,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144)" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)" }, "ipWhitelist": { "type": "string", @@ -1356,6 +1365,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470138", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1383,7 +1393,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")", + "description": "[Permissions](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" @@ -1485,7 +1495,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144)" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)" }, "ipWhitelist": { "type": "string", @@ -1508,6 +1518,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470139", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1531,7 +1542,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")", + "description": "[Permissions](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" @@ -1669,6 +1680,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470298", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -1861,6 +1873,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470299", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-account-transfer.json b/spec/rest/api/openapi-account-transfer.json index bd5af58..954df24 100644 --- a/spec/rest/api/openapi-account-transfer.json +++ b/spec/rest/api/openapi-account-transfer.json @@ -47,6 +47,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470147", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -380,6 +381,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470148", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -434,6 +436,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470301", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -615,6 +618,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470302", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -892,6 +896,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470303", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", @@ -989,6 +994,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470304", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", @@ -1288,6 +1294,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470307", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-account-withdrawal.json b/spec/rest/api/openapi-account-withdrawal.json index 48d13a5..59dfd01 100644 --- a/spec/rest/api/openapi-account-withdrawal.json +++ b/spec/rest/api/openapi-account-withdrawal.json @@ -166,6 +166,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470143", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -221,6 +222,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470144", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -486,6 +488,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470145", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -538,6 +541,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470310", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -661,6 +665,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470146", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -727,7 +732,13 @@ }, "toAddress": { "type": "string", - "description": "Withdrawal address" + "description": "Withdrawal address", + "example": [ + "0x023****2355", + "1572**401", + "a431***1e@gmail.com", + "55-12341234" + ] }, "withdrawType": { "type": "string", @@ -979,6 +990,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470308", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-affiliate-affiliate.json b/spec/rest/api/openapi-affiliate-affiliate.json index 00f40e1..9241aa9 100644 --- a/spec/rest/api/openapi-affiliate-affiliate.json +++ b/spec/rest/api/openapi-affiliate-affiliate.json @@ -150,6 +150,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470279", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-broker-apibroker.json b/spec/rest/api/openapi-broker-apibroker.json index 408b0cc..04b1563 100644 --- a/spec/rest/api/openapi-broker-apibroker.json +++ b/spec/rest/api/openapi-broker-apibroker.json @@ -91,6 +91,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470280", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-broker-ndbroker.json b/spec/rest/api/openapi-broker-ndbroker.json index 6fc2a65..78e25f3 100644 --- a/spec/rest/api/openapi-broker-ndbroker.json +++ b/spec/rest/api/openapi-broker-ndbroker.json @@ -91,6 +91,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470281", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -199,6 +200,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470282", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -332,6 +334,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470283", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -400,6 +403,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470290", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -518,7 +522,7 @@ } ] }, - "description": "[Permissions](doc://link/pages/338144) group list" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list" }, "ipWhitelist": { "type": "array", @@ -554,6 +558,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470284", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -616,6 +621,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470289", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -674,7 +680,7 @@ "items": { "type": "string" }, - "description": "[Permissions](doc://link/pages/338144) group list" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list" }, "ipWhitelist": { "type": "array", @@ -710,6 +716,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470291", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -996,6 +1003,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470285", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1216,6 +1224,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470286", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1381,6 +1390,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470287", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1543,6 +1553,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470288", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1599,7 +1610,7 @@ "items": { "type": "string" }, - "description": "[Permissions](doc://link/pages/338144) group list" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list" }, "ipWhitelist": { "type": "array", @@ -1634,6 +1645,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470292", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1688,7 +1700,7 @@ } ] }, - "description": "[Permissions](doc://link/pages/338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". )\n" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". )\n" }, "label": { "type": "string", @@ -1756,6 +1768,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470293", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-earn-earn.json b/spec/rest/api/openapi-earn-earn.json index 0af1f59..2619ec5 100644 --- a/spec/rest/api/openapi-earn-earn.json +++ b/spec/rest/api/openapi-earn-earn.json @@ -52,6 +52,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470268", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -237,6 +238,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470270", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -362,6 +364,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470269", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -683,6 +686,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470271", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1004,6 +1008,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470272", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1292,6 +1297,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470273", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1613,6 +1619,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470274", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1932,6 +1939,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470275", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2243,6 +2251,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470276", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-futures-fundingfees.json b/spec/rest/api/openapi-futures-fundingfees.json index 8d6dbcc..f8091bd 100644 --- a/spec/rest/api/openapi-futures-fundingfees.json +++ b/spec/rest/api/openapi-futures-fundingfees.json @@ -17,7 +17,7 @@ { "name": "symbol", "in": "path", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -88,6 +88,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470265", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -112,7 +113,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -157,7 +158,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "fundingRate": { "type": "number", @@ -186,6 +187,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470266", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -210,7 +212,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -299,7 +301,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "timePoint": { "type": "integer", @@ -390,6 +392,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470267", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-futures-market.json b/spec/rest/api/openapi-futures-market.json index eb25f4a..b043802 100644 --- a/spec/rest/api/openapi-futures-market.json +++ b/spec/rest/api/openapi-futures-market.json @@ -448,6 +448,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470220", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -910,6 +911,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470221", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -934,7 +936,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) \n\n", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) \n\n", "required": true, "schema": { "type": "string", @@ -968,7 +970,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "side": { "type": "string", @@ -1048,6 +1050,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470222", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1174,6 +1177,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470223", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1197,7 +1201,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) \n", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) \n", "required": false, "schema": { "type": "string" @@ -1226,7 +1230,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "bids": { "type": "array", @@ -1274,6 +1278,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470224", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1298,7 +1303,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -1335,7 +1340,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "bids": { "type": "array", @@ -1383,6 +1388,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470225", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1407,7 +1413,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string", @@ -1503,7 +1509,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) " }, "granularity": { "type": "integer", @@ -1547,6 +1553,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470226", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1571,7 +1578,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string", @@ -1665,7 +1672,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) " }, "granularity": { "type": "integer", @@ -1709,6 +1716,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470227", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1763,6 +1771,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470228", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1809,6 +1818,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470229", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1888,6 +1898,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470230", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1911,7 +1922,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string", @@ -2005,7 +2016,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) " }, "granularity": { "type": "integer", @@ -2076,6 +2087,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470231", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -2100,7 +2112,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -2201,6 +2213,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470232", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -2225,7 +2238,7 @@ { "name": "symbol", "in": "path", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -2248,7 +2261,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "granularity": { "type": "integer", @@ -2286,6 +2299,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470233", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -2310,7 +2324,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string", @@ -2454,6 +2468,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470234", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -2554,6 +2569,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470296", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -2653,6 +2669,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470297", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", diff --git a/spec/rest/api/openapi-futures-order.json b/spec/rest/api/openapi-futures-order.json index a18d86b..091b3ec 100644 --- a/spec/rest/api/openapi-futures-order.json +++ b/spec/rest/api/openapi-futures-order.json @@ -52,6 +52,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470235", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -100,7 +101,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM" ] @@ -207,7 +208,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "CN", "CO", @@ -265,7 +266,7 @@ }, "timeInForce": { "type": "string", - "description": "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "description": "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", "enum": [ "GTC", "IOC" @@ -360,7 +361,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -494,7 +495,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "type": { "type": "string", @@ -706,6 +707,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470244", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -728,7 +730,7 @@ { "name": "symbol", "in": "query", - "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -771,6 +773,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470362", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", @@ -780,7 +783,7 @@ "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelAllOrdersV1", "x-sdk-method-description": "Cancel all open orders (excluding stop orders). The response is a list of orderIDs of the canceled orders.", - "x-api-rate-limit": 30, + "x-api-rate-limit": 200, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderIds\\\": [\\n \\\"235919172150824960\\\",\\n \\\"235919172150824961\\\"\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"XBTUSDTM\\\"}" } @@ -804,7 +807,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -963,7 +966,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "tradeId": { "type": "string", @@ -1226,6 +1229,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470248", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1273,7 +1277,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "code": { "type": "string" @@ -1301,6 +1305,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470236", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1351,7 +1356,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) ", "example": [ "XBTUSDTM" ] @@ -1458,7 +1463,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "CN", "CO", @@ -1516,7 +1521,7 @@ }, "timeInForce": { "type": "string", - "description": "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "description": "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", "enum": [ "GTC", "IOC" @@ -1590,7 +1595,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -1615,7 +1620,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "tradeId": { "type": "string", @@ -1876,6 +1881,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470249", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1935,6 +1941,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470237", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1983,7 +1990,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM" ] @@ -2066,7 +2073,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "CN", "CO", @@ -2124,7 +2131,7 @@ }, "timeInForce": { "type": "string", - "description": "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "description": "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", "enum": [ "GTC", "IOC" @@ -2205,7 +2212,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -2265,6 +2272,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470250", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -2324,6 +2332,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470238", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -2372,7 +2381,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM" ] @@ -2479,7 +2488,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "CN", "CO", @@ -2537,7 +2546,7 @@ }, "timeInForce": { "type": "string", - "description": "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "description": "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", "enum": [ "GTC", "IOC" @@ -2653,6 +2662,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470239", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -2677,7 +2687,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -2725,6 +2735,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470240", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -2793,6 +2804,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470241", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -2824,7 +2836,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "clientOid": { "type": "string" @@ -2861,7 +2873,7 @@ { "name": "symbol", "in": "query", - "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -2904,6 +2916,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470242", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -2928,7 +2941,7 @@ { "name": "symbol", "in": "query", - "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -2971,6 +2984,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470243", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -2993,7 +3007,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -3129,7 +3143,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "type": { "type": "string", @@ -3341,6 +3355,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470247", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -3392,7 +3407,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "type": { "type": "string", @@ -3456,7 +3471,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "", "CN", @@ -3713,6 +3728,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470245", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -3764,7 +3780,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "type": { "type": "string", @@ -3828,7 +3844,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "", "CN", @@ -4086,6 +4102,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470352", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -4110,7 +4127,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -4139,7 +4156,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "type": { "type": "string", @@ -4342,6 +4359,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470246", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-futures-positions.json b/spec/rest/api/openapi-futures-positions.json index b34a1bf..c76a190 100644 --- a/spec/rest/api/openapi-futures-positions.json +++ b/spec/rest/api/openapi-futures-positions.json @@ -17,7 +17,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string", @@ -63,7 +63,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "maxBuyOpenSize": { "type": "integer", @@ -90,6 +90,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470251", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -114,7 +115,7 @@ { "name": "symbol", "in": "path", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -139,7 +140,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "level": { "type": "integer", @@ -187,6 +188,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470263", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -211,7 +213,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -238,7 +240,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM", "XBTUSDM", @@ -486,6 +488,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470252", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -532,6 +535,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470264", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -550,7 +554,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "level": { "type": "integer", @@ -580,7 +584,7 @@ { "name": "currency", "in": "query", - "description": "Currency code, Please refer to [rootSymbol](apidog://link/endpoint/221752070) , such as USDT,XBT. Query all positions when empty", + "description": "Currency code, Please refer to [rootSymbol](https://www.kucoin.com/docs-new/api-221752070) , such as USDT,XBT. Query all positions when empty", "required": false, "schema": { "type": "string", @@ -614,7 +618,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM", "XBTUSDM", @@ -863,6 +867,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470253", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -887,7 +892,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -980,7 +985,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "settleCurrency": { "type": "string", @@ -1092,6 +1097,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470254", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1138,6 +1144,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470256", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1156,7 +1163,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "withdrawAmount": { "type": "string", @@ -1203,7 +1210,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "autoDeposit": { "type": "boolean", @@ -1398,6 +1405,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470257", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1416,7 +1424,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "margin": { "type": "number", @@ -1451,7 +1459,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -1483,6 +1491,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470258", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1507,7 +1516,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -1530,7 +1539,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "marginMode": { "type": "string", @@ -1568,6 +1577,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470259", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1592,7 +1602,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -1615,7 +1625,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "leverage": { "type": "string", @@ -1637,6 +1647,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470260", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1694,6 +1705,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470261", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1712,7 +1724,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "leverage": { "type": "string", @@ -1755,7 +1767,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "marginMode": { "type": "string", @@ -1793,6 +1805,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470262", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1811,7 +1824,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM", "XBTUSDCM", @@ -1883,6 +1896,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470255", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-margin-credit.json b/spec/rest/api/openapi-margin-credit.json index 09dee95..53b51a4 100644 --- a/spec/rest/api/openapi-margin-credit.json +++ b/spec/rest/api/openapi-margin-credit.json @@ -103,6 +103,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470212", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -316,6 +317,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470213", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -507,6 +509,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470214", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -584,6 +587,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470215", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -638,6 +642,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470216", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -717,6 +722,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470217", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -805,6 +811,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470218", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-margin-debit.json b/spec/rest/api/openapi-margin-debit.json index b033e76..20ebe1f 100644 --- a/spec/rest/api/openapi-margin-debit.json +++ b/spec/rest/api/openapi-margin-debit.json @@ -52,6 +52,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470206", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -357,6 +358,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470207", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -595,6 +597,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470208", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -657,6 +660,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470210", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -892,6 +896,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470209", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -937,6 +942,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470211", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-margin-market.json b/spec/rest/api/openapi-margin-market.json index 54de054..ce43f52 100644 --- a/spec/rest/api/openapi-margin-market.json +++ b/spec/rest/api/openapi-margin-market.json @@ -153,6 +153,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470189", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -225,6 +226,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470190", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -316,6 +318,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470191", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -384,6 +387,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470192", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -458,6 +462,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470193", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -571,6 +576,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470194", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", diff --git a/spec/rest/api/openapi-margin-order.json b/spec/rest/api/openapi-margin-order.json index 87eecae..23e5ad6 100644 --- a/spec/rest/api/openapi-margin-order.json +++ b/spec/rest/api/openapi-margin-order.json @@ -71,6 +71,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470195", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -206,7 +207,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -214,7 +215,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -412,6 +413,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470202", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -500,6 +502,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470196", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -585,6 +588,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470197", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -748,7 +752,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -946,6 +950,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470198", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1185,7 +1190,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -1193,7 +1198,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -1397,6 +1402,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470199", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1662,7 +1668,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeRate": { "type": "string", @@ -1758,6 +1764,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470200", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1836,6 +1843,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470201", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1971,7 +1979,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -1979,7 +1987,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -2176,6 +2184,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470203", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2245,6 +2254,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470204", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2323,7 +2333,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -2363,7 +2373,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -2401,12 +2411,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -2507,6 +2517,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470205", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2585,7 +2596,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -2625,7 +2636,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -2663,12 +2674,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -2769,6 +2780,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470312", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -2847,7 +2859,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -2887,7 +2899,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -3047,6 +3059,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470313", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -3125,7 +3138,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -3165,7 +3178,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading", "enum": [ "GTC", "GTT", diff --git a/spec/rest/api/openapi-margin-risklimit.json b/spec/rest/api/openapi-margin-risklimit.json index 349bac1..9bc6489 100644 --- a/spec/rest/api/openapi-margin-risklimit.json +++ b/spec/rest/api/openapi-margin-risklimit.json @@ -197,6 +197,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470219", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-spot-market.json b/spec/rest/api/openapi-spot-market.json index 4aa0744..45c0d62 100644 --- a/spec/rest/api/openapi-spot-market.json +++ b/spec/rest/api/openapi-spot-market.json @@ -183,6 +183,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470152", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -3839,6 +3840,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470153", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -3863,7 +3865,7 @@ { "name": "market", "in": "query", - "description": "[The trading market](apidog://link/endpoint/222921786)", + "description": "[The trading market](https://www.kucoin.com/docs-new/api-222921786)", "required": false, "schema": { "type": "string", @@ -4046,6 +4048,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470154", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4252,6 +4255,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470155", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4299,6 +4303,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470156", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4672,6 +4677,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470157", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4753,6 +4759,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470158", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4950,6 +4957,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470159", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5050,6 +5058,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470160", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5190,6 +5199,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470161", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5294,6 +5304,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470162", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5475,6 +5486,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470163", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5569,6 +5581,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470164", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5672,6 +5685,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470165", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5720,6 +5734,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470166", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5907,6 +5922,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470167", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -6006,6 +6022,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470294", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -6105,6 +6122,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470295", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/api/openapi-spot-order.json b/spec/rest/api/openapi-spot-order.json index 6d79852..e701956 100644 --- a/spec/rest/api/openapi-spot-order.json +++ b/spec/rest/api/openapi-spot-order.json @@ -62,6 +62,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470168", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -112,7 +113,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -173,7 +174,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -215,12 +216,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -361,6 +362,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470169", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -411,7 +413,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -472,7 +474,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -514,12 +516,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -657,6 +659,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470170", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -741,7 +744,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -781,7 +784,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -819,12 +822,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -904,6 +907,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470171", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1012,6 +1016,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470172", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1071,6 +1076,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470173", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1175,6 +1181,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470174", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1310,7 +1317,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -1318,7 +1325,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570)", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", @@ -1504,6 +1511,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470181", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1571,6 +1579,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470335", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -1755,6 +1764,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470339", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1815,6 +1825,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470175", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1872,6 +1883,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470188", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1956,7 +1968,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -1996,7 +2008,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -2034,12 +2046,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -2140,6 +2152,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470176", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2206,6 +2219,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470354", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -2317,6 +2331,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470357", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -2374,6 +2389,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470177", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2503,7 +2519,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -2511,7 +2527,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570)", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", @@ -2698,6 +2714,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470178", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2894,6 +2911,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470338", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3070,6 +3088,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470334", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -3154,7 +3173,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -3194,7 +3213,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading. Required for limit orders.", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading. Required for limit orders.", "enum": [ "GTC", "GTT", @@ -3232,12 +3251,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -3493,7 +3512,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -3501,7 +3520,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570)", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", @@ -3694,6 +3713,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470179", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3892,6 +3912,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470340", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3977,6 +3998,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470337", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4053,6 +4075,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470356", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -4247,6 +4270,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470360", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -4354,7 +4378,7 @@ { "name": "limit", "in": "query", - "description": "Default100，Max100", + "description": "Default20，Max100", "required": false, "schema": { "type": "integer", @@ -4487,7 +4511,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeRate": { "type": "string", @@ -4583,6 +4607,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470180", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4707,6 +4732,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470359", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -4792,6 +4818,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470358", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -4857,6 +4884,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470355", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -4994,7 +5022,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -5002,7 +5030,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570)", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", @@ -5188,6 +5216,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470182", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5264,6 +5293,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470184", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5356,6 +5386,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470183", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5439,6 +5470,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470336", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -5558,6 +5590,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470185", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5677,6 +5710,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470186", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5736,6 +5770,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470187", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5820,7 +5855,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -5860,7 +5895,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -5898,12 +5933,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -5978,6 +6013,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470353", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -6152,6 +6188,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470343", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -6330,6 +6367,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470348", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -6704,6 +6742,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470346", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -6805,6 +6844,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470345", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -6857,6 +6897,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470333", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -6939,7 +6980,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -6979,7 +7020,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -7256,6 +7297,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470347", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -7436,6 +7478,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470349", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -7520,6 +7563,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470344", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -7779,7 +7823,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeRate": { "type": "string", @@ -7827,6 +7871,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470350", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -7954,6 +7999,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470351", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -8098,6 +8144,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470342", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -8179,7 +8226,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -8219,7 +8266,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -8379,6 +8426,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470341", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -8461,7 +8509,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -8501,7 +8549,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", diff --git a/spec/rest/api/openapi-viplending-viplending.json b/spec/rest/api/openapi-viplending-viplending.json index 8f8d785..1ef345f 100644 --- a/spec/rest/api/openapi-viplending-viplending.json +++ b/spec/rest/api/openapi-viplending-viplending.json @@ -149,6 +149,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470277", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -230,6 +231,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470278", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/entry/openapi-account.json b/spec/rest/entry/openapi-account.json index 772dce2..0a1596d 100644 --- a/spec/rest/entry/openapi-account.json +++ b/spec/rest/entry/openapi-account.json @@ -102,6 +102,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470119", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -147,6 +148,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470120", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -351,6 +353,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470121", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -361,7 +364,7 @@ "x-sdk-method-name": "getSpotLedger", "x-sdk-method-description": "This interface is for transaction records from all types of your accounts, supporting inquiry of various currencies. Items are paginated and sorted to show the latest first. See the Pagination section for retrieving additional entries after the first page.", "x-api-rate-limit": 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\\\": \\\"\\u5b50\\u8d26\\u53f7\\u8f6c\\u8d26\\\",\\n \\\"direction\\\": \\\"out\\\",\\n \\\"createdAt\\\": 1728658481484,\\n \\\"context\\\": \\\"\\\"\\n }\\n ]\\n }\\n}", + "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}" } }, @@ -575,6 +578,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470122", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -755,6 +759,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470123", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -936,6 +941,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470124", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1069,6 +1075,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470125", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1148,6 +1155,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470126", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1368,6 +1376,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470127", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1665,6 +1674,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470128", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1779,6 +1789,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470129", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -1795,7 +1806,7 @@ }, "/api/v1/user/api-key": { "get": { - "summary": "Get API Key Info", + "summary": "Get Apikey Info", "deprecated": false, "description": "Get the information of the api key. Use the api key pending to be checked to call the endpoint. Both master and sub user's api key are applicable.", "tags": [], @@ -1828,7 +1839,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144), possible values: General, Spot, Margin, Futures, InnerTransfer, Transfer, Earn" }, "ipWhitelist": { "type": "string", @@ -1872,6 +1883,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470130", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2078,6 +2090,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470131", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2287,6 +2300,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470132", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2533,6 +2547,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470133", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2696,6 +2711,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470134", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -2765,6 +2781,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470135", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2866,6 +2883,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470331", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2931,6 +2949,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470332", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3025,7 +3044,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144)" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)" }, "ipWhitelist": { "type": "string", @@ -3057,6 +3076,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470136", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3142,6 +3162,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470137", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3201,7 +3222,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144)" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)" }, "ipWhitelist": { "type": "string", @@ -3234,6 +3255,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470138", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3261,7 +3283,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")", + "description": "[Permissions](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" @@ -3363,7 +3385,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144)" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144)" }, "ipWhitelist": { "type": "string", @@ -3386,6 +3408,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470139", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3409,7 +3432,7 @@ }, "permission": { "type": "string", - "description": "[Permissions](doc://link/pages/338144)(Only General、Spot、Futures、Margin、InnerTransfer(Flex Transfer) permissions can be set, such as \"General, Trade\". The default is \"General\")", + "description": "[Permissions](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" @@ -3486,7 +3509,7 @@ }, "/api/v3/deposit-addresses": { "get": { - "summary": "Get Deposit Addresses(V3)", + "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 Deposit Address first.", "tags": [], @@ -3611,6 +3634,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470140", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3863,6 +3887,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470141", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3963,6 +3988,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470142", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4202,6 +4228,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470143", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4257,6 +4284,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470144", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4522,6 +4550,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470145", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4574,6 +4603,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470310", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -4697,6 +4727,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470146", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4763,7 +4794,13 @@ }, "toAddress": { "type": "string", - "description": "Withdrawal address" + "description": "Withdrawal address", + "example": [ + "0x023****2355", + "1572**401", + "a431***1e@gmail.com", + "55-12341234" + ] }, "withdrawType": { "type": "string", @@ -4853,6 +4890,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470147", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5186,6 +5224,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470148", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5275,6 +5314,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470149", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5356,6 +5396,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470150", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5433,6 +5474,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470151", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -5511,6 +5553,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470298", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -5703,6 +5746,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470299", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -5838,6 +5882,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470300", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -5892,6 +5937,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470301", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -6073,6 +6119,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470302", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -6350,6 +6397,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470303", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", @@ -6447,6 +6495,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470304", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", @@ -6652,6 +6701,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470305", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -6772,6 +6822,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470309", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -7002,6 +7053,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470306", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -7250,6 +7302,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470307", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", @@ -7466,6 +7519,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470308", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -7562,6 +7616,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470311", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -7810,6 +7865,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470314", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -8014,6 +8070,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470315", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/entry/openapi-affiliate.json b/spec/rest/entry/openapi-affiliate.json index 95f8369..552d6ce 100644 --- a/spec/rest/entry/openapi-affiliate.json +++ b/spec/rest/entry/openapi-affiliate.json @@ -150,6 +150,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470279", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/entry/openapi-broker.json b/spec/rest/entry/openapi-broker.json index 9d220cc..706c42f 100644 --- a/spec/rest/entry/openapi-broker.json +++ b/spec/rest/entry/openapi-broker.json @@ -91,6 +91,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470280", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -189,6 +190,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470281", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -297,6 +299,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470282", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -430,6 +433,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470283", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -498,6 +502,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470290", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -616,7 +621,7 @@ } ] }, - "description": "[Permissions](doc://link/pages/338144) group list" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list" }, "ipWhitelist": { "type": "array", @@ -652,6 +657,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470284", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -714,6 +720,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470289", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -772,7 +779,7 @@ "items": { "type": "string" }, - "description": "[Permissions](doc://link/pages/338144) group list" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list" }, "ipWhitelist": { "type": "array", @@ -808,6 +815,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470291", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1094,6 +1102,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470285", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1314,6 +1323,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470286", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1479,6 +1489,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470287", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1641,6 +1652,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470288", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1697,7 +1709,7 @@ "items": { "type": "string" }, - "description": "[Permissions](doc://link/pages/338144) group list" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list" }, "ipWhitelist": { "type": "array", @@ -1732,6 +1744,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470292", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", @@ -1786,7 +1799,7 @@ } ] }, - "description": "[Permissions](doc://link/pages/338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". )\n" + "description": "[Permissions](https://www.kucoin.com/docs-new/doc-338144) group list(Only General、Spot、Futures permissions can be set, such as \"General, Trade\". )\n" }, "label": { "type": "string", @@ -1854,6 +1867,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470293", "x-abandon": "normal", "x-domain": "Broker", "x-api-channel": "Private", diff --git a/spec/rest/entry/openapi-earn.json b/spec/rest/entry/openapi-earn.json index b921dc5..f445a1d 100644 --- a/spec/rest/entry/openapi-earn.json +++ b/spec/rest/entry/openapi-earn.json @@ -52,6 +52,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470268", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -237,6 +238,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470270", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -362,6 +364,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470269", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -683,6 +686,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470271", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1004,6 +1008,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470272", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1292,6 +1297,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470273", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1613,6 +1619,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470274", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1932,6 +1939,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470275", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2243,6 +2251,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470276", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/rest/entry/openapi-futures.json b/spec/rest/entry/openapi-futures.json index 779d5ff..bc486a4 100644 --- a/spec/rest/entry/openapi-futures.json +++ b/spec/rest/entry/openapi-futures.json @@ -448,6 +448,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470220", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -910,6 +911,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470221", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -934,7 +936,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) \n\n", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) \n\n", "required": true, "schema": { "type": "string", @@ -968,7 +970,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "side": { "type": "string", @@ -1048,6 +1050,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470222", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1174,6 +1177,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470223", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1197,7 +1201,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) \n", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) \n", "required": false, "schema": { "type": "string" @@ -1226,7 +1230,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "bids": { "type": "array", @@ -1274,6 +1278,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470224", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1298,7 +1303,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -1335,7 +1340,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "bids": { "type": "array", @@ -1383,6 +1388,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470225", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1407,7 +1413,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string", @@ -1503,7 +1509,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: fundingBaseSymbol, fundingQuoteSymbol, fundingBaseSymbol1M, fundingQuoteSymbol1M](https://www.kucoin.com/docs-new/api-3470220) " }, "granularity": { "type": "integer", @@ -1547,6 +1553,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470226", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1571,7 +1578,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string", @@ -1665,7 +1672,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) " }, "granularity": { "type": "integer", @@ -1709,6 +1716,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470227", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1763,6 +1771,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470228", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1809,6 +1818,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470229", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1888,6 +1898,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470230", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -1911,7 +1922,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string", @@ -2005,7 +2016,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: indexSymbol](https://www.kucoin.com/docs-new/api-3470220) " }, "granularity": { "type": "integer", @@ -2076,6 +2087,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470231", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -2100,7 +2112,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -2201,6 +2213,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470232", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -2225,7 +2238,7 @@ { "name": "symbol", "in": "path", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -2248,7 +2261,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "granularity": { "type": "integer", @@ -2286,6 +2299,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470233", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -2310,7 +2324,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol, indexSymbol, premiumsSymbol1M, premiumsSymbol8H](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string", @@ -2454,6 +2468,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470234", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -2513,6 +2528,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470235", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -2561,7 +2577,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM" ] @@ -2668,7 +2684,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "CN", "CO", @@ -2726,7 +2742,7 @@ }, "timeInForce": { "type": "string", - "description": "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "description": "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", "enum": [ "GTC", "IOC" @@ -2821,7 +2837,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -2955,7 +2971,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "type": { "type": "string", @@ -3167,6 +3183,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470244", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -3189,7 +3206,7 @@ { "name": "symbol", "in": "query", - "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -3232,6 +3249,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470362", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", @@ -3241,7 +3259,7 @@ "x-sdk-sub-service": "Order", "x-sdk-method-name": "cancelAllOrdersV1", "x-sdk-method-description": "Cancel all open orders (excluding stop orders). The response is a list of orderIDs of the canceled orders.", - "x-api-rate-limit": 30, + "x-api-rate-limit": 200, "x-response-example": "{\\n \\\"code\\\": \\\"200000\\\",\\n \\\"data\\\": {\\n \\\"cancelledOrderIds\\\": [\\n \\\"235919172150824960\\\",\\n \\\"235919172150824961\\\"\\n ]\\n }\\n}", "x-request-example": "{\\\"symbol\\\": \\\"XBTUSDTM\\\"}" } @@ -3265,7 +3283,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -3424,7 +3442,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "tradeId": { "type": "string", @@ -3687,6 +3705,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470248", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -3734,7 +3753,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "code": { "type": "string" @@ -3762,6 +3781,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470236", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -3812,7 +3832,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) ", "example": [ "XBTUSDTM" ] @@ -3919,7 +3939,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "CN", "CO", @@ -3977,7 +3997,7 @@ }, "timeInForce": { "type": "string", - "description": "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "description": "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", "enum": [ "GTC", "IOC" @@ -4051,7 +4071,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -4076,7 +4096,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "tradeId": { "type": "string", @@ -4337,6 +4357,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470249", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -4396,6 +4417,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470237", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -4444,7 +4466,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM" ] @@ -4527,7 +4549,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "CN", "CO", @@ -4585,7 +4607,7 @@ }, "timeInForce": { "type": "string", - "description": "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "description": "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", "enum": [ "GTC", "IOC" @@ -4666,7 +4688,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -4726,6 +4748,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470250", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -4785,6 +4808,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470238", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -4833,7 +4857,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM" ] @@ -4940,7 +4964,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "CN", "CO", @@ -4998,7 +5022,7 @@ }, "timeInForce": { "type": "string", - "description": "Optional for type is 'limit' order, [Time in force](doc://link/pages/338146) is a special strategy used during trading, default is GTC", + "description": "Optional for type is 'limit' order, [Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading, default is GTC", "enum": [ "GTC", "IOC" @@ -5114,6 +5138,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470239", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -5138,7 +5163,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -5186,6 +5211,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470240", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -5254,6 +5280,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470241", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -5285,7 +5312,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "clientOid": { "type": "string" @@ -5322,7 +5349,7 @@ { "name": "symbol", "in": "query", - "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -5365,6 +5392,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470242", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -5389,7 +5417,7 @@ { "name": "symbol", "in": "query", - "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Cancel all limit orders for a specific contract only, If not specified, all the limit orders will be deleted, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -5432,6 +5460,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470243", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -5454,7 +5483,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -5590,7 +5619,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "type": { "type": "string", @@ -5802,6 +5831,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470247", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -5853,7 +5883,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "type": { "type": "string", @@ -5917,7 +5947,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "", "CN", @@ -6174,6 +6204,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470245", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -6225,7 +6256,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "type": { "type": "string", @@ -6289,7 +6320,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB. Not supported DC at the moment.", "enum": [ "", "CN", @@ -6547,6 +6578,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470352", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -6571,7 +6603,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -6600,7 +6632,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "type": { "type": "string", @@ -6803,6 +6835,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470246", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -6827,7 +6860,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string", @@ -6873,7 +6906,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "maxBuyOpenSize": { "type": "integer", @@ -6900,6 +6933,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470251", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -6924,7 +6958,7 @@ { "name": "symbol", "in": "path", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -6949,7 +6983,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "level": { "type": "integer", @@ -6997,6 +7031,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470263", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -7021,7 +7056,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -7048,7 +7083,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM", "XBTUSDM", @@ -7296,6 +7331,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470252", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -7342,6 +7378,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470264", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -7360,7 +7397,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "level": { "type": "integer", @@ -7390,7 +7427,7 @@ { "name": "currency", "in": "query", - "description": "Currency code, Please refer to [rootSymbol](apidog://link/endpoint/221752070) , such as USDT,XBT. Query all positions when empty", + "description": "Currency code, Please refer to [rootSymbol](https://www.kucoin.com/docs-new/api-221752070) , such as USDT,XBT. Query all positions when empty", "required": false, "schema": { "type": "string", @@ -7424,7 +7461,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM", "XBTUSDM", @@ -7673,6 +7710,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470253", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -7697,7 +7735,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": false, "schema": { "type": "string" @@ -7790,7 +7828,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "settleCurrency": { "type": "string", @@ -7902,6 +7940,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470254", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -7948,6 +7987,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470256", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -7966,7 +8006,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "withdrawAmount": { "type": "string", @@ -8013,7 +8053,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "autoDeposit": { "type": "boolean", @@ -8208,6 +8248,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470257", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -8226,7 +8267,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "margin": { "type": "number", @@ -8261,7 +8302,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -8293,6 +8334,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470258", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -8317,7 +8359,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -8340,7 +8382,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "marginMode": { "type": "string", @@ -8378,6 +8420,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470259", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -8402,7 +8445,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -8425,7 +8468,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "leverage": { "type": "string", @@ -8447,6 +8490,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470260", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -8504,6 +8548,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470261", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -8522,7 +8567,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "leverage": { "type": "string", @@ -8565,7 +8610,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "marginMode": { "type": "string", @@ -8603,6 +8648,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470262", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -8621,7 +8667,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "example": [ "XBTUSDTM", "XBTUSDCM", @@ -8672,7 +8718,7 @@ { "name": "symbol", "in": "path", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -8743,6 +8789,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470265", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -8767,7 +8814,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -8812,7 +8859,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "fundingRate": { "type": "number", @@ -8841,6 +8888,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470266", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -8865,7 +8913,7 @@ { "name": "symbol", "in": "query", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](apidog://link/endpoint/3470220) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) ", "required": true, "schema": { "type": "string" @@ -8954,7 +9002,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "timePoint": { "type": "integer", @@ -9045,6 +9093,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470267", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -9145,6 +9194,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470296", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Private", @@ -9244,6 +9294,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470297", "x-abandon": "normal", "x-domain": "Futures", "x-api-channel": "Public", @@ -9288,6 +9339,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470255", "x-abandon": "abandon", "x-domain": "Futures", "x-api-channel": "Private", diff --git a/spec/rest/entry/openapi-margin.json b/spec/rest/entry/openapi-margin.json index faf2259..aeba004 100644 --- a/spec/rest/entry/openapi-margin.json +++ b/spec/rest/entry/openapi-margin.json @@ -153,6 +153,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470189", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -225,6 +226,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470190", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -316,6 +318,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470191", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -384,6 +387,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470192", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -458,6 +462,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470193", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -571,6 +576,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470194", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -648,6 +654,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470195", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -783,7 +790,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -791,7 +798,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -989,6 +996,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470202", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1077,6 +1085,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470196", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1162,6 +1171,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470197", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1325,7 +1335,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -1523,6 +1533,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470198", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -1762,7 +1773,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -1770,7 +1781,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -1974,6 +1985,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470199", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2239,7 +2251,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeRate": { "type": "string", @@ -2335,6 +2347,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470200", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2413,6 +2426,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470201", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2548,7 +2562,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -2556,7 +2570,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -2753,6 +2767,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470203", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2822,6 +2837,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470204", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -2900,7 +2916,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -2940,7 +2956,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -2978,12 +2994,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -3084,6 +3100,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470205", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3162,7 +3179,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into these strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into these strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -3202,7 +3219,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -3240,12 +3257,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -3336,6 +3353,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470206", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3641,6 +3659,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470207", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3879,6 +3898,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470208", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -3941,6 +3961,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470210", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4176,6 +4197,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470209", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4221,6 +4243,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470211", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4364,6 +4387,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470212", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4577,6 +4601,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470213", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4768,6 +4793,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470214", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4845,6 +4871,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470215", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4899,6 +4926,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470216", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -4978,6 +5006,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470217", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5066,6 +5095,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470218", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5304,6 +5334,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470219", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5373,6 +5404,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470312", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -5451,7 +5483,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -5491,7 +5523,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -5651,6 +5683,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470313", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -5729,7 +5762,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -5769,7 +5802,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/5176570) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/api-5176570) is a special strategy used during trading", "enum": [ "GTC", "GTT", diff --git a/spec/rest/entry/openapi-spot.json b/spec/rest/entry/openapi-spot.json index 59ce9b4..f216311 100644 --- a/spec/rest/entry/openapi-spot.json +++ b/spec/rest/entry/openapi-spot.json @@ -183,6 +183,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470152", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -3839,6 +3840,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470153", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -3863,7 +3865,7 @@ { "name": "market", "in": "query", - "description": "[The trading market](apidog://link/endpoint/222921786)", + "description": "[The trading market](https://www.kucoin.com/docs-new/api-222921786)", "required": false, "schema": { "type": "string", @@ -4046,6 +4048,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470154", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4252,6 +4255,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470155", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4299,6 +4303,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470156", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4672,6 +4677,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470157", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4753,6 +4759,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470158", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -4950,6 +4957,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470159", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5050,6 +5058,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470160", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5190,6 +5199,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470161", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5294,6 +5304,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470162", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5475,6 +5486,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470163", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5569,6 +5581,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470164", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -5672,6 +5685,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470165", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5720,6 +5734,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470166", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5907,6 +5922,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470167", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -5975,6 +5991,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470168", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -6025,7 +6042,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -6086,7 +6103,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -6128,12 +6145,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -6274,6 +6291,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470169", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -6324,7 +6342,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -6385,7 +6403,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -6427,12 +6445,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -6570,6 +6588,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470170", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -6654,7 +6673,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -6694,7 +6713,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -6732,12 +6751,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -6817,6 +6836,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470171", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -6925,6 +6945,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470172", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -6984,6 +7005,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470173", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -7088,6 +7110,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470174", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -7223,7 +7246,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -7231,7 +7254,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570)", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", @@ -7417,6 +7440,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470181", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -7484,6 +7508,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470335", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -7668,6 +7693,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470339", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -7728,6 +7754,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470175", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -7785,6 +7812,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470188", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -7869,7 +7897,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -7909,7 +7937,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -7947,12 +7975,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -8053,6 +8081,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470176", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -8119,6 +8148,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470354", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -8230,6 +8260,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470357", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -8287,6 +8318,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470177", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -8416,7 +8448,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -8424,7 +8456,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570)", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", @@ -8611,6 +8643,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470178", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -8807,6 +8840,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470338", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -8983,6 +9017,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470334", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -9067,7 +9102,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -9107,7 +9142,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading. Required for limit orders.", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading. Required for limit orders.", "enum": [ "GTC", "GTT", @@ -9145,12 +9180,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -9406,7 +9441,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -9414,7 +9449,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570)", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", @@ -9607,6 +9642,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470179", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -9805,6 +9841,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470340", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -9890,6 +9927,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470337", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -9966,6 +10004,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470356", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -10160,6 +10199,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470360", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -10267,7 +10307,7 @@ { "name": "limit", "in": "query", - "description": "Default100，Max100", + "description": "Default20，Max100", "required": false, "schema": { "type": "integer", @@ -10400,7 +10440,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeRate": { "type": "string", @@ -10496,6 +10536,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470180", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -10620,6 +10661,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470359", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -10705,6 +10747,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470358", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -10770,6 +10813,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470355", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -10907,7 +10951,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeCurrency": { "type": "string", @@ -10915,7 +10959,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/5176570)", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/api-5176570)", "enum": [ "DC", "CO", @@ -11101,6 +11145,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470182", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -11177,6 +11222,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470184", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -11269,6 +11315,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470183", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -11352,6 +11399,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470336", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -11471,6 +11519,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470185", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -11590,6 +11639,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470186", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -11649,6 +11699,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470187", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -11733,7 +11784,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -11773,7 +11824,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -11811,12 +11862,12 @@ }, "hidden": { "type": "boolean", - "description": "[Hidden order](doc://link/pages/338146) or not (not shown in order book)", + "description": "[Hidden order](https://www.kucoin.com/docs-new/doc-338146) or not (not shown in order book)", "default": false }, "iceberg": { "type": "boolean", - "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](doc://link/pages/338146)", + "description": "Whether or not only visible portions of orders are shown in [Iceberg orders](https://www.kucoin.com/docs-new/doc-338146)", "default": false }, "visibleSize": { @@ -11891,6 +11942,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470353", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -12085,6 +12137,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470294", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Public", @@ -12184,6 +12237,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470295", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -12263,6 +12317,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470343", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -12441,6 +12496,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470348", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -12815,6 +12871,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470346", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -12916,6 +12973,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470345", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -12968,6 +13026,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470333", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -13050,7 +13109,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -13090,7 +13149,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -13367,6 +13426,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470347", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -13547,6 +13607,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470349", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -13631,6 +13692,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470344", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -13890,7 +13952,7 @@ }, "fee": { "type": "string", - "description": "[Handling fees](doc://link/pages/5327739)" + "description": "[Handling fees](https://www.kucoin.com/docs-new/api-5327739)" }, "feeRate": { "type": "string", @@ -13938,6 +14000,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470350", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -14065,6 +14128,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470351", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -14209,6 +14273,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470342", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -14290,7 +14355,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -14330,7 +14395,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", @@ -14490,6 +14555,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470341", "x-abandon": "abandon", "x-domain": "Spot", "x-api-channel": "Private", @@ -14572,7 +14638,7 @@ }, "stp": { "type": "string", - "description": "[Self Trade Prevention](doc://link/pages/338146) is divided into four strategies: CN, CO, CB , and DC", + "description": "[Self Trade Prevention](https://www.kucoin.com/docs-new/doc-338146) is divided into four strategies: CN, CO, CB , and DC", "enum": [ "DC", "CO", @@ -14612,7 +14678,7 @@ }, "timeInForce": { "type": "string", - "description": "[Time in force](doc://link/pages/338146) is a special strategy used during trading", + "description": "[Time in force](https://www.kucoin.com/docs-new/doc-338146) is a special strategy used during trading", "enum": [ "GTC", "GTT", diff --git a/spec/rest/entry/openapi-viplending.json b/spec/rest/entry/openapi-viplending.json index 252a2e0..1be20aa 100644 --- a/spec/rest/entry/openapi-viplending.json +++ b/spec/rest/entry/openapi-viplending.json @@ -149,6 +149,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470277", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", @@ -230,6 +231,7 @@ } } }, + "x-api-doc": "https://www.kucoin.com/docs-new/api-3470278", "x-abandon": "normal", "x-domain": "Spot", "x-api-channel": "Private", diff --git a/spec/ws/openapi-futures-private.json b/spec/ws/openapi-futures-private.json index 624a36e..39e24e4 100644 --- a/spec/ws/openapi-futures-private.json +++ b/spec/ws/openapi-futures-private.json @@ -273,7 +273,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) " }, "orderType": { "type": "string", @@ -439,7 +439,7 @@ "taker", "maker" ], - "description": "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** ", + "description": "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** ", "x-api-enum": [ { "value": "taker", @@ -673,7 +673,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) ", "example": [ "XBTUSDTM", "XBTUSDM", @@ -1050,7 +1050,7 @@ }, "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) " }, "ts": { "type": "integer", @@ -1244,7 +1244,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) " }, "orderType": { "type": "string", @@ -1410,7 +1410,7 @@ "taker", "maker" ], - "description": "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** ", + "description": "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** ", "x-api-enum": [ { "value": "taker", @@ -1530,7 +1530,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/221752070) ", + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-221752070) ", "example": [ "XBTUSDTM", "XBTUSDM", diff --git a/spec/ws/openapi-futures-public.json b/spec/ws/openapi-futures-public.json index e83a0d3..c4b4c81 100644 --- a/spec/ws/openapi-futures-public.json +++ b/spec/ws/openapi-futures-public.json @@ -697,7 +697,7 @@ "properties": { "symbol": { "type": "string", - "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](doc://link/endpoint/3470220) " + "description": "Symbol of the contract, Please refer to [Get Symbol endpoint: symbol](https://www.kucoin.com/docs-new/api-3470220) " }, "candles": { "type": "array", diff --git a/spec/ws/openapi-spot-private.json b/spec/ws/openapi-spot-private.json index d1dc9b0..e9df26e 100644 --- a/spec/ws/openapi-spot-private.json +++ b/spec/ws/openapi-spot-private.json @@ -333,7 +333,7 @@ "taker", "maker" ], - "description": "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** ", + "description": "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** ", "x-api-enum": [ { "value": "taker", @@ -616,7 +616,7 @@ "taker", "maker" ], - "description": "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](doc://link/pages/338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** ", + "description": "Actual transaction order type, If the counterparty order is an [Hidden/Iceberg Order](https://www.kucoin.com/docs-new/doc-338146), even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the **feeType** ", "x-api-enum": [ { "value": "taker",