跳转到主要内容

REST API

正式: U本位合约:https://fapi.monochrome.exchange 币本位合约:https://dapi.monochrome.exchange

接口的基本信息

鉴于延迟高和稳定性差等原因,不建议通过代理的方式访问API。 GET请求参数放入query Params中,POST请求参数放入request body中 请求头信息请设置为:Content-Type=application/x-www-form-urlencoded 除了接口本身所需的参数外,还需要在query Params 或 request body中传递 signature, 即签名参数,不需要传递签名参数的接口会额外说明。

限频规则

获取资产每秒3次,其他方法单个用户每秒10次,单个IP每分钟1000次,超出锁定账户10分钟。

签名说明

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

签名生成

http://fapi.monochrome.exchange/future/api/v1/public/symbol/detail?symbol=btc_usdt的示例 以下是在linux bash环境下使用 echo openssl 和curl工具实现的一个调用接口下单的示例 appkey、secret仅供示范: appKey: 3976eb88-76d0-4f6e-a6b2-a57980770085 secretKey: bc6630d0231fda5cd98794f52c4998659beda290 Header部分数据: validate-appkey: 3976eb88-76d0-4f6e-a6b2-a57980770085 validate-timestamp: 2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9 validate-algorithms: HmacSHA256 请求数据: { type: ‘LIMIT’, timeInForce: ‘GTC’, side: ‘BUY’, symbol: ‘btc_usdt’, price: ‘39000’, quantity: ‘2’ } 1、数据部分 path: 按照path中顺序将所有value进行拼接。形如/test/{var1}/{var2}/的restful路径将按填入的实际参数后路径拼接,示例:/sign/test/bb/aa query: 按照key的字典序排序,将所有key=value进行拼接。示例:userName=dfdfdf&password=ggg body: Json: 直接按JSON字符串不做转换或排序操作。
如果存在多种数据形式,则按照path、query、body的顺序进行再拼接,得到所有数据的拼接值。 路径Path示例:
示例 1: 所有参数通过 query string 发送
示例 2: 所有参数通过 request body 发送 x-www-form-urlencoded的request body string :
json的request body string :
示例 3: 混合使用 query string 与 request body(分为表单与json两种格式) queryString: symbol=btc_usdt&side=BUY&type=LIMIT&timeInForce=GTC 上述拼接值记作query requestBody: {“quantity”:2,”price”:39000} 上述拼接值记作body
2、请求头部分 X=”validate-appkey=3976eb88-76d0-4f6e-a6b2-a57980770085&validate-timestamp=1641446237201” 3、生成签名 最终把需要进行加密的字符串,记作为sign=XY 最后将最终拼接值按照如下方法进行加密得到签名。 signature=org.apache.commons.codec.digest.HmacUtils.hmacSha256Hex(secretkey, sign); 将生成的签名singature放到请求头中,以validate-signature为Key,以singature为值。

API 代码库

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

返回格式

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

错误代码