跳转到主要内容

REST API

生产环境: https://sapi.monochrome.exchange

接口的基本信息

鉴于延迟高和稳定性差等原因,不建议通过代理的方式访问API。 GET请求参数放入query Params中,POST请求参数放入request body中 请求头信息请设置为:Content-Type=application/json 对于/public以外开头的请求,需要对请求报文进行签名

限频规则

部分接口会有限流控制(对应接口下会有限流说明),限流主要分为网关限流和WAF限流。 若接口请求触发了网关限流则会返回429,表示警告访问频次超限,即将被封IP或者apiKey。 网关限流分为针对IP和apiKey限流。 IP限流示例说明:100/s/ip,表示每个IP每秒该接口请求次数限制。 apiKey限流示例说明:50/s/apiKey,表示每个apiKey每秒该接口请求次数限制。

签名说明

由于 Monochrome 需要为第三方平台提供一些开放性的接口,所以需要接口的数据安全问题,比如数据是否被篡改,数据是否已过时,数据是否可以重复提交,接口在某个时间内访问频率等问题。其中数据是否被篡改是最重要的。 1、先通过用户中心申请appkey和secretkey,针对不同的调用,提供不同的appkey和secretkey 2、加入timestamp(时间戳),其值应当是请求发送时刻的unix时间戳(毫秒),数据的有郊时间根据此值来计算。 3、加入signature(数据签名),所有数据的签名信息。 4、加入recvwindow(自定义请求有效时间),有效时间目前相对简单统一固定为某个值。 服务器收到请求时会判断请求中的时间戳,最长60秒,最小为2秒,如果是5000毫秒之前发出的,则请求会被认为无效。这个时间窗口值可以通过发送可选参数recvWindow来设置。 另外,如果服务器计算得出客户端时间戳在服务器时间的‘未来’一秒以上,也会拒绝请求。 关于交易时效性 互联网状况并不100%可靠,不可完全依赖,因此你的程序本地到 Monochrome 服务器的时延会有抖动. 这是我们设置recvwindow的目的所在,如果你从事高频交易,对交易时效性有较高的要求,可以灵活设置recvwindow以达到你的要求。 不推荐使用5秒以上的recvwindow 5、加入algorithms (签名方法/算法),用户计算签名是基于哈希的协议,推荐使用HmacSHA256。具体支持那些协议,请参见下面表格中所列出。

签名生成

以https://sapi.monochrome.exchange/v4/order为例。 以下是在linux bash环境下使用 echo openssl 和curl工具实现的一个调用接口下单的示例 appkey、secret仅供示范: appKey: 3976eb88-76d0-4f6e-a6b2-a57980770085 secretKey: bc6630d0231fda5cd98794f52c4998659beda290 Header部分数据:
请求数据:
1、数据部分
方法method示例:
路径path示例:
参数通过query示例:
参数通过body示例
混合使用query与body(分为表单与json两种格式)
整个数据最且拼接值由#符号分别与method、path、query、body进行拼接成#method、#path、#query、#body,最终拼接值记作为Y=#method#path#query#body。 注意:
2、请求头部分 将key按照字母自然升序后,使用&方式拼接在一起,作为X。如:
3、生成签名
4、样例

API 代码库

Java connector 一个轻量级的Java代码库,提供让用户直接调用API的方法。 各个语言的sdk:

响应格式

所有的接口返回都是JSON格式。
Response

响应代码

公共模块

查询类型

跟单用户类型

跟单员类型

跟随类型

跟单止损仓位处理

FAQ

1.AUTH_105:服务器在校验请求头参数validate-timestamp(validTimeStamp)、validate-recvwindow(recvwindow)时, 需要符合以下规则:dealTimeStamp(请求被处理时服务器时间,单位毫秒)- validTimeStamp < recvwindow ,否则就会返回AUTH_105,为了避免此错误,建议validate-timestamp 设置为请求发出的时间,以毫秒为单位,validate-recvwindow设置的大一点