iframe-proxy | Sunbelt Computer Software

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 for UTA API V2 are as follows:

Enhance Capital Efficiency
V2 provides users the ability to upgrade accounts to a unified account, allowing for sharing and cross-utilization of funds across Spot, Cross Margin, and Futures(Cross Futures and Isolated Futures). Users are also able to offset profit and losses across different positions, thus further enhancing capital efficiency.

Openapi Version	Account Type	Spot	Cross Margin	Cross Futures	Isolated Futures	Isolated Margin
V2	Unified Trading Account	✅	✅	✅	✅	❌

WebSocket Authentication Method Upgrade
V2 Websocket APIs(Private Channels & Websocket Trade) will adopt a new API authentication scheme, shifting the authentication mechanism from Connect Token‑based to Signature‑based authentication. This aligns with industry‑standard practices and lowers integration costs for users. For more details, please refer to: Websocket-api-introduction

Rate‑Limit Rules for V1 and V2

Requests to V1 and V2 APIs will jointly consume quota from the corresponding rate‑limit pool. Upgrading to V2 will not grant additional rate‑limit quotas separate from V1. Users need to reasonably schedule the request frequency for V1 and V2 APIs based on their actual API‑call volume.

Both V1 and V2 have adopted the Master-Sub Account shared rate limit model. For more details, please refer to: Rate limit for UTA

API Interface Naming Standard
V2 APIs offer clearer path definitions for improved clarity and reduced ambiguity. The new version divides the REST API categories into Market Data, Account Info, Orders, Positions, Affiliate, VIP Lending and divides the Websocket API categories into Public Channels, Private Channels, Trade.

Path	Description
/api/ua/v2/market/	Candlestick, orderbook, ticker, transaction data, futures open interest, funding rate, etc.
/api/ua/v2/asset/	Manage asset withdraw and deposit.
/api/ua/v2/oes/	Query information related to oes.
/api/ua/v2/user/	Query and manage basic user information related to KYC, client IP address, apikey, sub-accounts.
/api/ua/v2/account/	Operations across multiple accounts – asset management, fund management and operations within a single account.
/api/ua/v2/rate-limit/	Query and manage rate limit for accounts.
/api/ua/v2/sub-account/	Query and manage information for sub-accounts.
/api/ua/v2/withdrawals/	Get withdrawal quota, fee, and limit information for a specified currency and chain.
/api/ua/v2/affiliate/	Query information related to affiliate users.
/api/ua/v2/otc-loan/	Query information related to OTC lending.
/api/ua/v2/unified/order/	Order management.
/api/ua/v2/unified/position/	Position management.

Common response parameters

PARAMETER	TYPE	DESCRIPTION
`code`	string	Success/Error code. `"`200000`"` indicates a successful response
`msg`	string	Success/Error msg
`data`	object	Business data result

API Error Code Specification Upgrade

V2 APIs will adopt a brand‑new error code specification to implement unified and standardized management of API error codes. Meanwhile, we have optimized and detailed the error prompt messages to make error causes and resolutions clearer, helping users quickly identify and troubleshoot issues with API requests.

For example, all error codes will be changed to a unified 6‑digit format. Error codes are divided into several major categories as follows:

Categories	Error Code
General	4XX / 5XX
System	1000XX
VIP Lending	166XXX
Account & Balance	109XXX / 11XXXX / 16XXXX / 17XXXX
Position & Leverage	11XXXX
Order	11XXXX
Gateway & Authentication	11XXXX / 4XXXXX / 5XXXXX
Spot & Margin Trading	13XXXX
Market	13XXXX / 14XXXX
Futures	14XXXX
Assets	33XXXX
Earn	80XXXX
User	81XXXX / 82XXXX / 83XXXX
Fee	86XXXX

For more details, please refer to: UTA V2 error code

SDK for UTA API V2
A brand-new SDK supporting multiple programming languages for UTA mode will be released in September.

Offline Data Download Supported
Market data obtainable through Offline Data Download function to facilitate backtesting.

Readability and Correctness Improvements to API Documentation
To reduce confusion and improve clarity of API documentation, all outdated or inaccurate information has been updated. UTA API V2 covers all APIs except for Earn, Copy‑Trading and Broker interfaces and is fully adapted to the unified‑account trading mode while delivering latency optimizations for the core UTA trading. So we strongly recommend users to upgrade account type to unified account mode and then use UTA API V2 REST & Websocket to trade in a faster way.

Document Structure

Under each endpoint, there are several modules, as follows:

1. domain

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

Unified Account

REST: https://api.kucoin.com

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

Spot & Margin Public Websocket Push: wss://x-push-spot.kucoin.com

Futures Public Websocket Push: wss://x-push-futures.kucoin.com

Private Websocket Push: wss://wsapi-push.kucoin.com

Websocket Add/Cancel Order: wss://wsapi.kucoin.com

Classic Account

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

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

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

Spot & Margin Websocket Push: wss://ws-api-spot.kucoin.com

Futures Websocket Push: wss://ws-api-futures.kucoin.com

Websocket Add/Cancel Order: wss://wsapi.kucoin.com

2. api-channel

Private or Public endpoint. If it is a private interface, apikey is required 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 placements, order cancellations, etc.

Margin: This API can be used for margin trading to perform order placements, order cancellations, etc.

Futures: This API can be used for futures trading to perform order placements, order cancellations, 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 or 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.

LeadtradeFutures: Allow this apikey to use the Futures CopyTrading function. Please note that only the TRADER (Lead Trader) need use this permission, not the FOLLOWER (Copy Trader).

Unified ：Trade spot and derivatives simultaneously from a single account with multiple currencies, without needing to transfer between your different accounts.

4. api-rate-limit-pool

Each API resource pool has a certain quota, the specific amount of which depends on the VIP level. Please refer to UTA API Resource pool and Classic API Resource pool

5. api-rate-limit-weight

When a user requests any API, the weight of this interface will be deducted and updated every 30 seconds (starting from the arrival time of the user's first request), Please refer to UTA API Weight and Classic API 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.

Sunbelt Computer Software

PL/B Language Development and Support

Introduction

Key Upgrades

Document Structure

1. domain

Unified Account

Classic Account

2. api-channel

3. api-permission

4. api-rate-limit-pool

5. api-rate-limit-weight

6. sdk-service

7. sdk-sub-service

8. sdk-method-name

Sunbelt Computer Software

PL/B Language Development and Support

Introduction

Key Upgrades#

Document Structure#

1. domain#

Unified Account#

Classic Account#

2. api-channel#

3. api-permission#

4. api-rate-limit-pool#

5. api-rate-limit-weight#

6. sdk-service#

7. sdk-sub-service#

8. sdk-method-name#

Key Upgrades

Document Structure

1. domain

Unified Account

Classic Account

2. api-channel

3. api-permission

4. api-rate-limit-pool

5. api-rate-limit-weight

6. sdk-service

7. sdk-sub-service

8. sdk-method-name