跳到主要内容

接入指南

以下是快速上手使用该数字货币中心化交易所 API 的简要说明：

获取 API 密钥​

在申请 API 密钥之前，需要先在 CoinEx 申请账号，具体的申请流程可以参考帮助中心

准备好账号后，可以在开发者控制台中生成 API 密钥，确保具有所需的权限。

API 调用准备​

根据业务需求选择相应的 API 接口，查阅对应的 API 文档以了解请求方式、参数和返回结果。

具体可以查看业务分组查看，然后去对应的模块中寻找对应的 API 接口，或者使用搜索功能快速查找。

构建请求​

使用您选择的编程语言，构建符合 API 要求的请求，包括设置请求方法、URL、请求头和参数等。

信息

HTTP 的基础域名为：https://api.coinex.com/v2

WS 现货和合约的基础地址不同，分别如下：

公共参数：

信息

在接口文档页中标明需要签名的HTTP接口，需要使用以下两个公共 HTTP HEADER 参数来做请求的验证，具体的使用方法可以参考认证

  • X-COINEX-KEY
  • X-COINEX-SIGN
信息

如果需要限制请求的有效时间，在所有的HTTP接口都可以通过以下公共 HTTP HEADER 参数来限制请求的有效时间。

服务器收到请求时会判断请求中的时间戳X-COINEX-TIMESTAMP，如果是5000毫秒(默认值)之前发出的，则请求会被认为无效。这个时间窗口值可以通过发送可选参数X-COINEX-WINDOWTIME来自定义。

  • X-COINEX-TIMESTAMP。必选参数，用于指示为请求的发出时间。
  • X-COINEX-WINDOWTIME。可选参数，用于指示请求存活的窗口时间，默认为5000毫秒。
信息

在所有的 API 中，时间请求参数和响应字段都是毫秒级的时间戳。

处理响应​

解析 API 返回的响应数据，根据需要进行相应的处理，如错误处理、数据提取等。

HTTP 响应处理​

  1. HTTP响应应先判断 status_code 是否为200，然后进行下一步的处理。
  2. 正常的HTTP响应会有统一的响应结构，需要通过判断该结构中的code字段来确定响应是否正常，code在正常情况下应该为0。

HTTP正常响应的统一结构如下：

{
    "code": 0,
    "data": ...
    "message": "OK"
}

WS 响应处理​

  1. WS 应该先处理订阅请求的响应，当发送订阅请求后，服务器会先返回订阅结果响应，WS 服务器的响应是通过zip压缩的，需要先进行解压缩。
  2. 需判断响应结果中的code字段是否为0。

WS正常响应的统一结构如下：

{
  "id": 4,
  "message": "OK",
  "code": 0
}
  1. 在订阅成功后，服务器会在数据更新时进行推送，可根据业务需要来处理推送数据。

具体的错误解释可以参考错误处理

安全性注意事项​

警告

确保在 API 调用中使用 HTTPS 协议进行数据传输，同时妥善保管您的 API 密钥，避免泄露，API 密钥与您的账号密码的重要性是等同的，为了您的账号和资产安全，请妥善保管并定期更换密钥。一旦丢失密钥，请务必及时到 CoinEx 移除密钥。