Introduction

Welcome to KuCoin’s trader and developer documentation. These documents outline the exchange functionality, market details, and APIs.

Key Upgrades

Compared with the old version of the API documentation, the main changes are as follows

• Support Online Debugging
  Each REST interface can be directly tested and run online, what you see is what you get

• SDK Refactoring
  We have rewritten the SDK in all languages, with more standardized data specifications and a more convenient user experience

• Support Offline Data Download
  Obtain market data through Offline Data Download function to facilitate backtesting

• Readability Improvements to API Documentation
  The API documentation has been revised and proofread to improve clarity and reduce confusion. Any parts of the previous documentation that were not clear have been revised to provide better explanations.

Document Structure

Under each endpoint, there are several modules as follow

1. domain

Prefix domain name, The request URL needs to be determined by BASE and specific endpoint combination.

• Spot & Margin REST: https://api.kucoin.com

• Futures REST: https://api-futures.kucoin.com

• Broker REST: https://api-broker.kucoin.com

• Spot & Margin Websocket: Please refer to Get Public Token or Get Private Token to dynamically obtain the base URL

• Futures Websocket: Please refer to Get Public Token or Get Private Token to dynamically obtain the base URL

2. api-channel

Private or Public endpoint, If it is a private interface, need to use apikey to access it

3. api-permission

You can manage the API permission on KuCoin’s official website. Please refer to the documentation below to see what API key permissions are required for a specific route. The permissions are:

• General: Limited to read-only operations such as querying account information, account statements, and order information. The API cannot be used to perform operations such as order placement or withdrawals.
• Spot: This API can be used for spot trading to perform order placement, order cancellation, etc.
• Margin: This API can be used for margin trading to perform order placement, order cancellation, etc.
• Futures: This API can be used for futures trading to perform order placement, order cancellation, etc.
• Earn: You may use this API to subscribe to, redeem, or make early redemptions of KuCoin Earn products.
• Withdrawal: This permission allows you to withdraw assets, acquire deposit addresses, cancel withdrawals, and execute other operations. To use this permission, you must enable IP Restriction. Please note that when authorizing the Transfer permission, you can use the API to transfer money without email verification and Google verification.
• FlexTransfers: Allow this API key for FlexTransfers. This will enable asset transfers across the multiple supported transfer types. The respective permissions for each individual transfer type remains unaffected. If this option is enabled, IP access restriction filters must also be applied.

4. api-rate-limit-pool

Each API resource pool has a certain quota, the specific amount depends on the VIP level, Please refer to Resource pool

5. api-rate-limit

When a user requests any API, the weight of this interface will be deducted and updated every 30s (starting from the arrival time of the user's first request), Please refer to Weight

6. sdk-service

The package name of this method in the SDK

7. sdk-sub-service

The sub package name of this method in the SDK

8. sdk-method-name

The method name of this method in the SDK