KuCoin API Documentation: A Comprehensive Guide

The KuCoin API offers a robust set of tools for developers and traders looking to interact programmatically with the KuCoin exchange. This guide will provide an in-depth overview of the KuCoin API, including its features, endpoints, and usage. We will cover the following sections: Authentication, Market Data Endpoints, Trading Endpoints, Account Endpoints, and Error Handling. Each section will be detailed to help you understand how to utilize the API effectively for your trading and development needs.

1. Authentication

To access the KuCoin API, you need to authenticate your requests. KuCoin uses API keys for authentication, which consist of an API Key, a Secret Key, and a Passphrase. Here's how to get started:

1. Generate API Keys: Log in to your KuCoin account and navigate to the API Management page. Create a new API key and make note of your API Key, Secret Key, and Passphrase.
2. Include Keys in Requests: All API requests must include these keys. The Secret Key is used to generate a signature for each request, which ensures the request is from a legitimate source.

Example Authentication Request

bash
curl -X GET "https://api.kucoin.com/api/v1/market/allSymbols" \
     -H "KC-API-KEY: " \
     -H "KC-API-SIGN: " \
     -H "KC-API-TIMESTAMP: " \
     -H "KC-API-PASSPHRASE: " \
     -H "KC-API-KEY-VERSION: 2"

2. Market Data Endpoints

The Market Data Endpoints provide information about trading pairs, order book data, and recent trades. Key endpoints include:

1. Get All Symbols: Retrieve information about all trading pairs available on KuCoin.

   • Endpoint: /api/v1/market/allSymbols
   • Method: GET
   • Response: Provides a list of all trading pairs, including their base and quote currencies.

2. Get Order Book: Fetch the order book for a specific trading pair.

   • Endpoint: /api/v1/market/orderbook/level2
   • Method: GET
   • Parameters: symbol (e.g., BTC-USDT)
   • Response: Includes bids and asks, their respective prices, and quantities.

3. Get Recent Trades: Retrieve recent trades for a given trading pair.

   • Endpoint: /api/v1/market/histories
   • Method: GET
   • Parameters: symbol (e.g., BTC-USDT)
   • Response: Includes trade history with timestamps, prices, and quantities.

Example Market Data Request

bash
curl -X GET "https://api.kucoin.com/api/v1/market/orderbook/level2?symbol=BTC-USDT"

3. Trading Endpoints

Trading Endpoints allow users to place and manage orders. The main endpoints are:

1. Place an Order: Submit a new order to buy or sell a trading pair.

   • Endpoint: /api/v1/orders
   • Method: POST
   • Parameters: symbol, side (buy/sell), type (limit/market), price, size
   • Response: Confirmation of the order with details.

2. Get Order Details: Retrieve details of a specific order.

   • Endpoint: /api/v1/orders/
   • Method: GET
   • Response: Information about the order, including its status and execution details.

3. Cancel an Order: Cancel an existing order.

   • Endpoint: /api/v1/orders//cancel
   • Method: POST
   • Response: Confirmation of the cancellation.

Example Trading Request

bash
curl -X POST "https://api.kucoin.com/api/v1/orders" \
     -H "KC-API-KEY: " \
     -H "KC-API-SIGN: " \
     -H "KC-API-TIMESTAMP: " \
     -H "KC-API-PASSPHRASE: " \
     -H "KC-API-KEY-VERSION: 2" \
     -d '{"symbol": "BTC-USDT", "side": "buy", "type": "limit", "price": "30000", "size": "0.01"}'

4. Account Endpoints

Account Endpoints are used to manage your account information, including balances and transaction history.

1. Get Account Balance: Retrieve the balance of your account for each currency.

   • Endpoint: /api/v1/accounts
   • Method: GET
   • Response: Balance details for each currency.

2. Get Transaction History: Fetch your transaction history, including deposits and withdrawals.

   • Endpoint: /api/v1/accounts//transactions
   • Method: GET
   • Response: Details of each transaction.

Example Account Request

bash
curl -X GET "https://api.kucoin.com/api/v1/accounts" \
     -H "KC-API-KEY: " \
     -H "KC-API-SIGN: " \
     -H "KC-API-TIMESTAMP: " \
     -H "KC-API-PASSPHRASE: " \
     -H "KC-API-KEY-VERSION: 2"

5. Error Handling

Understanding how to handle errors effectively is crucial for developing robust applications. KuCoin API provides error codes to help diagnose issues.

1. Common Error Codes:

   • 200000: Invalid Request
   • 300000: Permission Denied
   • 500000: Server Error

2. Handling Errors: Ensure your application can handle different error responses gracefully. Implement retry logic for transient errors and log errors for debugging.

Example Error Response

json
{
  "code": "200000",
  "message": "Invalid Request"
}

Conclusion

The KuCoin API offers a comprehensive set of endpoints to interact with the KuCoin exchange. By understanding authentication, market data, trading, account management, and error handling, you can build robust trading applications and tools. Refer to the official KuCoin API documentation for the latest updates and detailed information.