Index
快速入门¶
Restful API¶
公共接口¶
用户接口¶
订单接口¶
WebSocket API¶
WebSocket接入说明¶
公共接口¶
用户接口¶
订单接口¶
接入准备¶
如需使用API ,请先登录网页端,完成API key的申请和权限配置,再据此文档详情进行开发和交易。
您可以点击 这里 创建 API Key。
创建成功后请务必记住以下信息:
- APIKey API交易的身份标识,随机算法生成。
- SecretKey 私钥,由系统随机生成,用于签名的生成。
风险提示 :这两个个密钥与账号安全密切相关,请牢记,无论何时都请勿向他人透露。 这两个个密钥任意一个泄露可能会造成您的资产损失,若发现APIKey泄露请尽快删除该APIKey。
接口类型¶
- 公共接口
- 私有接口
公共接口¶
公共接口可用于获取配置信息和行情数据。公共请求无需认证即可调用。
私有接口¶
私有接口可用于订单管理和账户管理。每个私有请求必须使用规范的验证形式进行签名。 私有接口需要使用您的APIKey进行验证。
API域名¶
您可以自行使用Rest API接入方式进行操作。
| 域名 | REST API |
|---|---|
| 主域名 | https://openapi.bitunix.com |
API验证¶
所有REST请求的header都必须包含以下key:
- api-key: 申请的api-key
- nonce: 随机字符串,32位, 调用方生成
- timestamp: 当前时间戳,毫秒
- sign: 签名字符串(请参阅签名说明)
- Content-Type:统一设置为application/json
请求交互¶
所有请求基于Https协议,POST 请求头信息中Content-Type 需要统一设置为: 'application/json'。
请求交互说明¶
- 请求参数:根据接口请求参数规定进行参数封装。
- 提交请求参数:将封装好的请求参数通过GET/POST方式提交至服务器。
- 服务器响应:服务器首先对用户请求数据进行参数安全校验,通过校验后根据业务逻辑将响应数据以JSON格式返回给用户。
- 数据处理:对服务器响应数据进行处理。
成功¶
HTTP状态码200表示成功响应,并可能包含内容。如果响应含有内容,则将显示在相应的返回内容里面。
常见错误码¶
- 400 Bad Request – Invalid request format 请求格式无效
- 403 Forbidden – You do not have access to the requested resource 请求无权限
- 404 Not Found 没有找到请求
- 500 Internal Server Error – We had a problem with our server 服务器内部错误; 如果失败body带有错误描述信息
- 更多详见错误码
标准规范¶
时间戳¶
请求签名中的timestamp的单位是毫秒, 统一使用标准UTC时间。请求的时间戳必须在API服务时间的60秒内,否则请求将被视为过期并被拒绝。
请求格式¶
目前只有两种格式的请求方法:GET和POST
- GET: 参数通过queryString在路径中传输到服务器。
- POST: 参数按照json格式发送body传输到服务器。