2023-05-22

• “User position history”
• “Query position adjustment history”
• “Query position settlement history”

2023-03-16

• “Acquire user futures market configuration”
• “Change user futures market configuration”

2023-02-22

• Supported new function of Futures Pyramiding Auto-Settlement

2023-02-15

• Added order currency fields in endpoints related to market orders, and supported submitting orders using specified cryptos

2023-02-08

• Added endpoint in Acquire Sub-Account
• Added endpoint in “General Asset Transfer in Sub-Accounts”
• Added endpoint in “Authorize Sub-Account”
• Added endpoint in “Acquire Sub-Account Authorizee List”
• Added endpoint in “Delete Sub-Account Authorization”
• Updated endpoint in “Spot Asset Transfer Between Main and Sub-Account”
  • POST /sub_account/transfer: Sub-account calls are no longer allowed
• Updated endpoint in “Acquire Transfer Record Between Main and Sub-Account”
  • GET /sub_account/transfer/history: Added request parameter start_time, end_time

2022-11-30

• Added function of querying and canceling orders by client_id

2022-11-08

• Added endpoint for “Market Price Subscription, Cancel Market Price Subscription” in Futures Perpetual WebSocket

2022-09-22

• Added tx_id parameter to GET /balance/coin/deposit endpoint, supporting filtering query by TxID

2022-09-21

• Supported subscription to the transaction data of all markets in the endpoint of “Latest Transaction Subscription” in Spot and Futures perpetual WebSocket

2022-09-06

• Added endpoint in “Position Adl History Query” for Futures perpetual contracts

2022-07-26

• Added subscription for “BBO (Best-bid-offer)” in Futures Perpetual WebSocket

2022-07-01

• Added endpoint in “Temporary Maintenance Notice Subscription”

2022-06-16

• Updated rules for API rate limit

2022-06-15

• Added endpoint for modifying normal orders
• Added endpoint for modifying stop orders

2022-05-30

• Updated the endpoint description in “Get Site-wide Maintenance Information”
• Updated the endpoint description in “Acquire Partial Maintenance Info”

2022-04-20

• Added Endpoint Error Code
• Added request header X-Ratelimit-Limit and X-Ratelimit-Remaining

2022-03-24

• Added start_time end_time parameter for GET /order/finished endpoint to support time rage query

2022-02-23

• Added return parameter withdrawal_precision for /common/asset/config endpoint

2022-02-11

• Added Endpoint Error Code

2022-01-14

• Added endpoint in Create Sub-Account APIKEY
  • Endpoint path: POST /sub_account/auth/api
• Added endpoint in Acquire Sub-Account APIKEY List
  • Endpoint path: GET /sub_account/auth/api
• Added endpoint in Acquire Sub-Account APIKEY Detail
  • Endpoint path: GET /sub_account/auth/api/<int:user_auth_id>
• Added endpoint in Edit Sub-Account APIKEY
  • Endpoint path: PUT /sub_account/auth/api/<int:user_auth_id>
• Added endpoint in Delete Sub-Account APIKEY
  • Endpoint path: DELETE /sub_account/auth/api/<int:user_auth_id>

2021-12-27

• Added endpoint in Temporary Maintenance Information Query
  • Endpoint path: GET /common/temp-maintain/info

2021-12-17

• Added endpoint in Edit Account Settings
  • Endpoint path: PUT /account/settings
  • Note: Added settings for CET deduction

2021-12-14

• Added endpoint in Create Sub-Account
  • Endpoint path: POST /sub_account/register
• Added endpoint in Freeze Sub-Account
  • Endpoint path: PUT /sub_account/frozen
• Added endpoint in Unfreeze Sub-Account
  • Endpoint path: PUT /sub_account/unfrozen

2021-11-22

• Refactored API documentation

CoinEx Market Makers are professional traders and everyone is welcome to apply with any one of the mentioned conditions met:

Individuals or professional institutions who trade via API services and reach a monthly trading volume of 5,000,000 USD in spot/futures markets.

Enjoy the below privileges by becoming CoinEx Market Maker:

• Trading Benefits
  • Special Fees
  • Exclusive Withdrawal Quota
  • Interest-free Credit
  • API Service
  • Fee Rebate
• Service Benefits
  • Exclusive MM Manager
  • 24/7 Customer Service
  • Holiday Gifts
  • Exclusive Events

CoinEx reserves the rights of final explanation of Market Maker application.

For more details, please refer to the page of CoinEx Market Maker >

Welcome to CoinEx Developer Documentation.

This documentation outlines trading functions, market data and other application development endpoints.The services and functions provided by CoinEx will be updated in this documentation. Please pay attention to the change log.

Through the API documentation, you can query the explanation of the endpoint to help you understand and develop the corresponding functions more easily.

• Base URL：https://api.coinex.com/v1
• All API request headers need to add Content-Type: "application/json" and User-Agent
• APIs that require signature need to add authorization in the header
• Please first check the HTTP status code of Response, and make sure that it indicates 200 before parsing Response
• All Requests and Responses use json.
• Account and transaction-related API endpoints require signatures, while market-related API endpoints do not

Before signing, you need to go to CoinEx-Personal Center-API Key and create a new API key

• Access_id: API key ID
• Secret_key: The secret key used to sign the requested data

Access_id and Secret_key are of the same importance as your account password. For account and assets safety, please change your secret key regularly.Once you lose your secret key, please go to CoinEx to remove the secret key in time.

• Each API endpoint has its corresponding group, and each group has a corresponding request limit rate

The rate limit in each group is set according to its characteristics. As a matter of fact, the rate limit is the request margin of the group, where the request frequency of each endpoint in the group will deduct its group margin, until all the deductions are made. In this case, all endpoint requests in the group will be limited.

E.g. The group rate limit for cancelling Spot orders is 120r/2s. If the endpoint request limit of POST /order/limit placing limit orders is 40/2s, then the remaining margin for the rest of endpoints in the group (DELETE /order /pending, POST /order/market, etc.) will be 80r/2s.

1. IP Rate Limit Rule

• Rate limit: 400/s

1. Account Rate Limit Rule (Spot)
   • The main and sub-accounts are separately rate-limited and do not affect each other.

1. Account Rate Limit Rule (Futures)
   • The main and sub-accounts are separately rate-limited and do not affect each other.

1. Error Codes and Methods

【Return example】:

# POST Request
{
    "access_id": "4DA36FFC61334695A66F8D29020EB589",
    "market": "BTCBCH",
    "type": "buy",
    "price": "10",
    "amount": "1.0",
    "tonce": 1513746038205
}

# GET Request
access_id=4DA36FFC61334695A66F8D29020EB589
&market=BTCBCH
&type=buy
&price=680
&amount=1.0
&tonce=1513746038205

# Sorted GET/POST request string and add secret_key
access_id=4DA36FFC61334695A66F8D29020EB589
&amount=1.0
&market=BTCBCH
&price=680
&tonce=1513746038205
&type=buy
&secret_key=B51068CF10B34E7789C374AB932696A05E0A629BE7BFC62F

• Each endpoint has its authorization type, which determines what kind of authorization should be performed when accessing.
• The endpoint requiring signature will be specified in the description. If there is no special statement, it doesn’t require signature by default.
• If authorization is required, it should be passed authorization.
• access_id and secret_key are case sensitive.

Signature Procedures

1. Sort parameters alphabetically
2. Add "&secret_key=your_secret_key" after the sorted string
3. Use 32-bit MD5 encrypt and capitalize and put it in the request header authorization
4. Click to view Demo for signature generation

• Public Parameter

  Parameter Name	Description
  authorization	Request header signature
  tonce	Millisecond timestamp, the acceptable error range from server time is ±60s
  access_id	API Key ID
  secret_key	API Key
  account_id	Used to distinguish different types of trading markets

• Endpoint Error Code

  Error Code	Description
  0	Succeeded
  1	Error
  2	Invalid argument
  3	Internal error
  23	IP Prohibited
  24	AccessID does not exist
  25	Signature error
  34	AccessID expired
  35	Service unavailable
  36	Service timeout
  40	Main account and sub-account do not match
  49	The transfer to the sub-account was rejected
  107	Insufficient balance
  158	No permission to use this API
  213	Requests submitted too frequently
  227	The timestamp is wrong, the timestamp must be within ±60s of the server time
  600	Order number does not exist
  601	Other users’ orders
  602	Below the minimum buying or selling limit
  606	The order price deviates too much from the latest transaction price
  651	Merge depth error
  3008	Service busy, please try again later.

• HTTP Error Code

  Error Code	Description
  200	Succeeded
  404	API does not exist

Return example

{
    "code": 0,
    "data": {},
    "message": "Success"
}

• GET /common/maintain/info

• Obtain site-wide maintenance information, which is applicable to scenarios where all functions of the site are out of service

• Return parameter description

  name	type	describe
  start_time	Integer	Maintenance start time
  end_time	Integer	Maintenance end time
  url	String	URL for maintenance announcement

Return example

{
    "code": 0,
    "data": [
        {
            "started_at": 1640707200,
            "ended_at": 1640793600,
            "scope": [
                "SPOT",
                "PERPETUAL"
            ]
        }
    ],
    "message": "Success"
}

• GET /common/temp-maintain/info

• Acquire partial maintenance information, applicable to the scenarios where some functions are out of service

• Return parameter description

  Name	Type	Description
  started_at	Integer	Maintenance start time
  ended_at	Integer	Maintenance end time
  scope	List	Maintenance scope: PERPETUAL: Perpetual SPOT: Spot