更新日誌

2024-02-01

  • 现货WebSocket新增买一卖一接口订阅

2024-01-25

  • 申請提現接口支援指定手續費幣種
  • 提現歷史記錄介面增加手續費幣種字段

2024-01-04

2023-09-20

  • 重要提示

CoinEx將對所有幣種的儲值地址進行升級,並將為所有用戶分配新的儲值地址。儲值前請務必再三確認地址! 如您有儲存先前產生的舊儲值地址,請不要再使用舊儲值地址進行儲值,否則資產可能無法到帳且永久遺失。 詳細進展請參閱公告:https://announcement.coinex.com/hc/articles/19187420867348

2023-08-22

2023-08-03

  • 做市商現貨交易費率調整,請參考連結

2023-06-15

2023-06-08

  • 現貨、永續合約WebSocket新增"自己的成交資訊"介面訂閱

2023-05-22

2023-03-16

2023-02-22

  • 支援合約浮盈加倉功能

2023-02-15

  • 市價委託單相關介面新增委託單幣種字段,支援指定幣種下單

2023-02-08

2022-11-30

  • 新增透過client_id查詢、撤銷委託單功能

2022-11-08

  • 永續合約WebSocket新增”市場價格訂閱、取消訂閱”接口

2022-09-22

  • GET /balance/coin/deposit 介面新增 tx_id 參數,支援使用交易ID過濾查詢

2022-09-21

  • 現貨、永續合約WebSocket的”最新成交訂閱”介面支援訂閱用戶所有市場的成交數據

2022-09-06

2022-07-26

  • 永續合約websocket新增」買一賣一「訂閱

2022-07-01

2022-06-16

  • 修改API限頻規則

2022-06-15

  • 新增修改普通委託單介面
  • 新增修改計畫委託單接口

2022-05-30

2022-04-20

  • 新增API介面錯誤碼
  • 新增 X-Ratelimit-LimitX-Ratelimit-Remaining 請求頭

2022-03-24

  • GET /order/finished 介面新增 start_time end_time 支援時間範圍查詢

2022-02-23

  • /common/asset/config 介面增加返回字段withdrawal_precision

2022-02-11

  • 新增API介面錯誤碼

2022-01-14

2021-12-27

2021-12-17

  • 新增修改帳戶設定接口
    • 介面路徑:PUT /account/settings
    • 備註:新增CET抵扣手續費設定功能

2021-12-14

2021-11-22

  • 重構API文檔

做市商簡介

CoinEx 做市商即為專業交易者,只要符合以下標準,即可申請:

使用API交易,並且現貨月交易量達到1,000,000 USD或合約月交易量達到5,000,000 USD的個人交易者或專業交易機構。

成為CoinEx 做市商,可以享受以下權益:

  • 交易權益
    • 專屬費率
    • 專屬提現額度
    • 免息授信
    • 穩定的API
    • 交易返現
  • 服務權益
    • 專屬大客戶經理
    • 7*24H客服支持
    • 節日禮物關懷
    • 做市商專屬活動

CoinEx 保留對做市商申請的最終解釋權

更多詳情,前往CoinEx做市商頁面 >

介紹

歡迎使用CoinEx 開發者文檔。

本文檔概述了交易功能、市場行情和其他應用開發接口。CoinEx 提供的服務和功能都會在此文檔中更新,請注意留意更新日誌。

通過API 文檔,您可以查詢對接口的解釋說明,幫助您更容易理解,開發對應功能。

基本信息

  • 基本URL:https://api.coinex.com/v1
  • 所有API 請求頭都需要添加Content-Type: "application/json"User-Agent
  • 需要簽名的API 需要在請求頭添加authorization
  • 請先檢查Response的http狀態碼,確保狀態碼是200時,再解析Response
  • 所有的Request 和Response 均以json的格式傳輸
  • 賬戶和交易相關的API 接口均需要簽名,行情相關的API 接口不需要簽名

在簽名之前,需要到CoinEx-個人中心-API 密鑰創建新的API 密鑰

  • Access_id: API 密鑰ID
  • Secret_key: 用於對請求數據簽名的密鑰

Access_id 和Secret_key 與您的賬號密碼的重要性是等同的,為了您的賬號和資產安全,請妥善保管並定期更換密鑰。一旦丟失密鑰,請務必及時到CoinEx 移除密鑰。

  • 每個API 接口都有其對應的分組,每個分組都有對應的請求限制頻率

我們根據每個分組的特性來設置的分組的限頻。限頻其實是分組的請求餘量, 分組內每個接口的請求頻率都會扣除每個分組的餘量, 直到全部扣完,那麼該分組內所有的接口請求將受到到限制。

eg: 對於現貨下單&撤單的分組限頻是120r/2s,如果 POST /order/limit 下限價單的接口請求的頻率為40/2S, 那麼該分組中其他接口(DELETE /order/pending, POST /order/market 等)的請求頻率的餘量就剩80r/2s

1.IP維度限頻規則

  • 限頻:400/s

2.賬戶維度限頻規則(現貨)

  • 主賬號和子賬號分別限頻,互不影響
接口類型 限頻 包含的接口路徑
現貨下單&撤單 60r/2s POST /order/limit 下限價單
POST /order/market 下市價訂單
POST /order/stop/limit 下計劃限價單
POST /order/stop/market 下計劃限價單
POST /order/ioc 立即成交或不能成交時取消下單
DELETE /order/pending 取消所有訂單
DELETE /order/stop/pending/<int:order_id> 取消未成交的計劃訂單
POST /order/modify 修改普通委託單
POST /order/stop/modify 修改計劃委託單
現貨批量下單&撤單 20r/2s POST /order/limit/batch 批量下限價單
DELETE /order/pending/batch批量取消訂單
DELETE /order/stop/pending 取消所有未成交的計劃訂單
現貨查詢訂單 100r/2s GET /order/status 查詢訂單狀態
GET /order/status/batch 批量查詢訂單狀態
GET /order/pending 查詢未成交的訂單
GET /order/stop/pending 查詢未成交的計劃訂單
現貨查詢訂單歷史 20r/2s GET /order/deals 查詢已完成訂單明細
GET /order/user/deals 查詢用戶成交記錄
GET /order/finished 查詢歷史訂單
GET /order/stop/finished 查詢歷史計劃訂單
現貨賬戶改動 20r/2s PUT /account/settings 修改賬戶設置
POST /margin/loan 在槓桿賬戶下貸款
POST /margin/flat 在槓桿賬戶下償還代幣
POST /margin/transfer 現貨-槓桿賬戶資產劃轉
PUT /sub_account/frozen 凍結子賬號
PUT /sub_account/unfrozen 解凍子賬號
PUT /sub_account/auth/api/<int:user_auth_id> 編輯子賬號APIKEY
POST /sub_account/transfer 現貨主賬號-子賬號資產劃轉
POST /sub_account/register 創建子賬號
POST /sub_account/auth/api 創建子賬號APIKEY
DELETE /sub_account/auth/api/<int:user_auth_id> 刪除子賬號APIKEY
PUT /balance/deposit/address/<string:coin_type> 更新充值地址
POST /balance/coin/withdraw 申請提現
DELETE /balance/coin/withdraw 取消提現
POST /contract/balance/transfer 現貨-合約資產劃轉
現貨賬戶查詢 20r/2s GET /balance/info 獲取賬戶信息,適用於現貨交易市場
GET /account/market/fee 獲取交易費率
GET /account/amm/balance 獲取AMM賬戶信息
GET /account/investment/balance 獲取理財賬戶信息
GET /credit/info 獲取賬戶授信信息
GET /credit/balance 獲取賬戶授信餘額
GET /sub_account/auth/api 獲取子賬號APIKEY列表
GET /sub_account/auth/api/<int:user_auth_id> 獲取子賬號APIKEY詳情
GET /balance/deposit/address/<string:coin_type> 查詢充值地址
現貨賬戶歷史數據查詢 20r/2s GET /balance/coin/withdraw 獲取提現歷史記錄
GET /balance/coin/deposit 獲取充值記錄
GET /account/balance/history 查詢用戶流水
GET /investment/transfer/history 現貨-理財賬戶轉賬記錄
GET /margin/transfer/history 槓桿-現貨賬戶劃轉記錄
GET /margin/loan/history 獲取槓桿賬戶借幣記錄
GET /contract/transfer/history 現貨-合約賬戶劃轉記錄
GET /sub_account/transfer/history 獲取主賬號-子賬號劃轉記錄

3.賬戶維度限頻規則(合約)

  • 主賬號和子賬號分別限頻,互不影響
接口類型 限頻 包含的接口路徑
合約下單&撤單 40r/2s POST:/perpetual/v1/order/put_limit 下限價單
POST:/perpetual/v1/order/put_market 下市價單
POST:/perpetual/v1/order/put_stop_limit 下計劃限價委託單
POST:/perpetual/v1/order/put_stop_market 下計劃市價委託單
POST:/perpetual/v1/order/cancel 取消委託單
POST:/perpetual/v1/order/cancel_stop 取消計劃委託單
POST:/perpetual/v1/order/close_limit 限價平倉
POST:/perpetual/v1/order/close_market 市價平倉
POST:/perpetual/v1/position/adjust_margin 調整倉位保證金
POST:/perpetual/v1/position/stop_loss 設置持倉止損
POST:/perpetual/v1/position/take_profit 設置持倉止盈
POST:/perpetual/v1/position/market_close 市價全平
POST:/perpetual/v1/order/modify 修改普通委託單
POST:/perpetual/v1/order/modify_stop 修改計劃委託單
合約批量撤單 20r/2s POST:/perpetual/v1/order/cancel_all 取消全部委託單
POST:/perpetual/v1/order/cancel_batch 批量取消委託單
POST:/perpetual/v1/order/cancel_stop_all 取消全部計劃委託單
合約查詢訂單 100r/2s GET:/perpetual/v1/order/pending 查詢pending狀態的委託單
GET:/perpetual/v1/order/stop_pending 查詢pending狀態的計劃委託單
GET:/perpetual/v1/order/status 訂單狀態
GET:/perpetual/v1/order/stop_status 計劃單狀態
合約查詢訂單歷史 20r/2s GET:/perpetual/v1/order/finished 查詢finished狀態的委託單
GET:/perpetual/v1/order/stop_finished 查詢finished狀態的計劃委託單
合約賬戶查詢 20r/2s GET:/perpetual/v1/asset/query 資產查詢
GET:/perpetual/v1/position/funding 查詢用戶歷史資金費率
GET:/perpetual/v1/position/pending 用戶持倉

4.常見錯誤碼及處理方式

常見錯誤碼 建議處理方式
35 服務暫時不可用,請稍後重試
213 觸發限頻,建議調整策略,降低請求頻率
3008 服務間歇繁忙,請稍後重試

【返回示例】:

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

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

# 排序後的GET/POST請求字符串加上secret_key
access_id=4DA36FFC61334695A66F8D29020EB589
&amount=1.0
&market=BTCBCH
&price=680
&tonce=1513746038205
&type=buy
&secret_key=B51068CF10B34E7789C374AB932696A05E0A629BE7BFC62F
  • 每個接口都有自己的鑑權類型,鑑權類型決定了訪問時應當進行何種鑑權。
  • 需要簽名的接口會在說明中指出,如果沒有特殊聲明默認為不需要簽名。
  • 如果需要鑑權,應當在HTTP 頭中以 authorization 字段傳遞。
  • access_idsecret_key 是大小寫敏感的。

簽名步驟

  1. 按字母順序將參數排序
  2. 在排序的字符串後面加上"&secret_key=your_secret_key"
  3. 用32 位MD5加密並大寫後放到請求頭authorization
  4. 查看簽名生成Demo
  • 公共參數

    參數名 描述
    authorization 請求頭簽名
    tonce 毫秒時間戳,與服務器時間可接受誤差範圍為±60s
    access_id api key id
    secret_key api key
    account_id 用於區分不同類型的交易市場
  • 接口錯誤碼

    錯誤碼 描述
    0 成功
    1 錯誤
    2 參數錯誤
    3 內部錯誤
    23 IP禁用
    24 Access id不存在
    25 簽名錯誤
    34 Access id過期
    35 服務不可用
    36 服務超時
    40 主賬號和子賬號不匹配
    49 轉賬到子賬號被拒絕
    107 餘額不足
    158 沒有使用此API的權限
    213 請求過於頻繁
    227 時間戳錯誤,時間戳必須為服務器時間±60s 以內
    600 訂單號不存在
    601 其他用戶的訂單
    602 低於買或賣的最低限額
    606 訂單價格和最新成交價偏差太大
    651 合併深度錯誤
    3008 服務間歇繁忙,請稍後重試
  • HTTP 錯誤碼

    錯誤碼 描述
    200 成功
    404 api 不存在

返回示例

{
    "code": 0,
    "data": {
        "started_at":1703833292,
        "ended_at":1703834254,
        "url": "",
        "protect_duration_start": 1703834254,
        "protect_duration_start": 1703834254, 383838370
    },
    "message": "Success"
}
  • GET /common/maintain/info

  • 獲取全站維護信息,適用於全站所有功能停服的場景

  • 返回參數說明

    名稱 類型 描述
    start_time Integer 維護開始時間
    end_time Integer 維護結束時間
    url String 維護公告的URL
    protect_duration_start Integer 保護期間開始時間
    protect_duration_end Integer 保護期結束時間

返回示例

{
    "code": 0,
    "data": [
        {
            "started_at": 1640707200,
            "ended_at": 1640793600, 5 "scope": [ 6 "SPOT", 7 "PERPETUAL" 8 ], 9 "scope": [ 6 "SPOT", 7 "PERPETUAL" 8 ],
            "scope": [ 6 "SPOT", 7 "PERPETUAL" 8 ], 9 "scope": [
                "SPOT", 7 "PERPETUAL" 8 ], 9 "scope": [ 6 "SPOT",
                "PERPETUAL"
            ],
            " protect_duration_start": 1640793600,
            "protect_duration_end": 1640794200
        }
    ],
    "message": "Success"
}
  • GET /common/temp-maintain/info

  • 獲取部分維護信息,適用於部分功能停服的場景

  • 返回參數說明

    名稱 類型 描述
    started_at Integer 維護開始時間
    ended_at Integer 維護結束時間
    scope List 維護範圍:
    PERPETUAL:合約
    SPOT:現貨
    ALL_SITE:全域維護
    protect_duration_start Integer 保護期間開始時間
    protect_duration_end Integer 保護期結束時間

做市商专属对接人
Telegram @CoinExvipmanager
Email vip@coinex.com