接口

本文主要从一下2个方面讲述接口的一些规范。

  • 请求标准
  • 鉴权类型

请求标准

1.Rest 接口

1.1 请求参数和格式

GET, DELETE 方法的接口, 参数必须在 query string中发送。

如:

curl https://api-cloud.bitmart.com/contract/v1/ifcontract/contracts?contractID=1

POST, PUT 方法的接口, 参数必须在 application/json 的 request body 中发送。

如:

curl https://api-cloud.bitmart.com/contract/v1/ifcontract/submitOrder
body: {"contract_id":1,"category":1,"way":1,"open_type":1,"leverage":10,"custom_id":1,"price":5000,"vol":10,"nonce":1589266686}
1.2 响应

服务端响应格式都是JSON。

{
  "code": 1000,
  "trace":"886fb6ae-456b-4654-b4e0-d681ac05cea1",
  "message": "OK",
  "data": [
    {
      "low": "130",
      "high": "130",
      "open": "130",
      "close": "130",
      "last_price": "130",
      "avg_price": "130",
      "volume": "0",
      "timestamp": 1532610000,
      "rise_fall_rate": "0",
      "rise_fall_value": "0"
    }
  ]
}
字段 描述
code 错误码,详细查看
message 错误描述
trace 每次请求事件跟踪ID,服务端对每次请求都会返回
data 服务端返回的数据

注意说明

1.对请求参数的顺序不做要求。

2.服务端返回的数据格式全部为json形式。

3.遇到错误自己不能解决时,报告给BitMart需要把code, trace和message提交上来。

2.WebSocket 接口

暂无描述。

鉴权类型

本章节主要为接口类型的细节分以下两个方面:

  • 公共接口
  • 私有接口

1.公共接口

公共接口可用于获取配置信息和行情数据。公共请求无需认证即可调用。

2.私有接口

私有接口可用于订单管理和账户管理。每个私有请求必须使用规范的验证形式进行签名。 私有接口需要使用您的API key进行验证。

results matching ""

    No results matching ""