一、API简介

欢迎使用API，此API文档将描述量化投资资金调拨关联API接口详情以及接入、验签说明。

二、接入说明

2.1 接入URLs

REST API

• https://api.satsresearch.com

2.2 限频规则

限频规则针对接口进行限频，目前每个接口访问限制为1s内10次

用户可根据Http Header中的信息调整访问策略

• rateLimit-times： 单轮请求数上限，单位：次数
• rateLimit-interval：请求数重置的时间间隔，单位：毫秒
• rateLimit-remaining：本轮剩余可用请求数，单位：次数
• rateLimit-reset：请求数上限重置时间，单位：毫秒

三、签名认证

3.1 签名说明

API 请求在通过 internet 传输的过程中极有可能被篡改，为了确保请求未被更改，除公共接口（基础信息，行情数据）外的私有接口均必须使用您的 API Key 做签名认证，以校验参数或参数值在传输途中是否发生了更改。（编码集统一 "UTF-8"）

一个合法的请求由以下几部分组成：

• 方法请求地址：即访问服务器地址 https://api.satsresearch.com ，比如https://api.satsresearch.com/api/v1/transferFunds
• API 访问密钥（AccessKeyId）：您申请的 API Key 中的 Access Key。
• 签名方法（SignatureMethod）：用户计算签名的基于哈希的协议，此处使用 HmacSHA256。
• 签名版本（SignatureVersion）：签名协议的版本，此处使用1。
• 时间戳（Timestamp）：系统当前毫秒数。
• 必选和可选参数：每个方法都有一组用于定义 API 调用的必需参数和可选参数。可以在每个方法的说明中查看这些参数及其含义。 请一定注意：对于 GET 请求，每个方法自带的参数都需要进行签名运算； 对于 POST 请求，每个方法自带的参数不进行签名认证，即 POST 请求中需要进行签名运算的只有 AccessKeyId、SignatureMethod、SignatureVersion、Timestamp 四个参数，其它参数放在 body 中。
• 签名：签名计算得出的值，用于确保签名有效和未被篡改。

3.2 签名步骤

规范要计算签名的请求因为使用 HmacSHA256进行签名计算时，使用不同内容计算得到的结果会完全不同。所以在进行签名计算前，请先对请求进行规范化处理。下面以发起资金调拨请求为例进行说明：

请求的API key与密钥对参考如下：

AccessKeyId: e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx

AccessSecret: 1KFjiTRVlGSyzoNIEXIx8boXe7njFmjeHwiK4kKkEOY=

资金调拨发起请求的URL如下：

• https://api.satsresearch.com/api/v1/transferFunds?AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&SignatureMethod=HmacSHA256&SignatureVersion=1&Timestamp=1662022581951

1. 请求方法（GET 或 POST），后面添加换行符 “\n”

POST\n

2. 添加小写的访问地址，后面添加换行符 “\n”

api.satsresearch.com\n

3. 访问方法的路径，后面添加换行符 “\n”

/api/v1/transferFunds\n

4. 按照ASCII码的顺序对参数名进行排序。例如，下面是请求参数的原始顺序，进行过编码后

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxxSignatureMethod=HmacSHA256SignatureVersion=1Timestamp=1662022581951

使用 UTF-8 编码，且进行了 URI 编码，十六进制字符必须大写，如 “:” 会被编码为 “%3A” ，空格被编码为 “%20”。

经过排序之后

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx

SignatureMethod=HmacSHA256

SignatureVersion=1

Timestamp=1662022581951

5. 按照以上顺序，将各参数使用字符 “&” 连接

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&SignatureMethod=HmacSHA256&SignatureVersion=1&Timestamp=16620225819511

6. 组成最终的要进行签名计算的字符串如下

POST\n

api.satsresearch.com\n

/api/v1/transferFunds\n

AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&SignatureMethod=HmacSHA256&SignatureVersion=1&Timestamp=1662022581951

7. 用上一步里生成的 “请求字符串” 和你的密钥 (Secret Key) 生成一个数字签名

1KFjiTRVlGSyzoNIEXIx8boXe7njFmjeHwiK4kKkEOY=

1. 将上一步得到的请求字符串和密钥作为两个参数，调用HmacSHA256验签函数获得验签信息。
2. 将此验签信息用base-64编码，得到的值作为此次接口调用的数字签名。

8. 将生成的数字签名加入到请求的路径参数里

最终，发送到服务器的 API 请求应该为

https://api.satsresearch.com/api/v1/transferFunds?AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&SignatureMethod=HmacSHA256&SignatureVersion=1&Timestamp=1662022581951&Signature=d5qMEazCAgwpLyUyhwsmIUYZytfzgPjBO6ykluyjzi4=

• 把所有必须的认证参数添加到接口调用的路径参数里
• 把数字签名在URL编码后加入到路径参数里，参数名为“Signature”。

四、业务枚举

交易所枚举（ExchangeEnum）

账户类型枚举（AccountTypeEnum）

toSubAccoun和fromSubAccount字段值说明

五、接口明细

5.1 资金调拨

HTTP 请求

• POST /api/v1/transferFunds

请求参数

Response:

{
  "msg": "success",
          "code": 200,
          "data": [
    {
      "clientTransferId": "4e8c51b7-97ac-4ef1-864f-7869f13c0c6f",
      "transferId": "4e8c51b797ac4ef1864f7869f13c0c6f"
    }
  ],
          "ts": 1679903538458
}

响应数据

5.2 查询资金调拨单个记录

HTTP 请求

• GET /api/v1/transfer/record

请求参数

Response:

{
    "msg": "success",
    "code": 200,
    "data": [
        {
            "clientTransferId": "4e8c51b7-97ac-4ef1-864f-7869f13c0c7f",
            "asset": "USDT",
            "fromExchange": "bingx",
            "fromSubAccount": "4665179554",
            "toExchange": "binance",
            "toSubAccount": "someacccount@binance.com",
            "applyAmount": "20",
            "realAmount": "19",
            "feeAmount": "1",
            "externalStatus": "done",
            "applyTime": 1715305243482,
            "arriveTime": null,
            "failReason": "exchange internal error."
        }
    ],
    "ts": 1715306224948
}

响应数据

5.3 查询资金调拨历史记录

HTTP 请求

• POST /api/v1/transfer/recordList

请求参数

Response:

{
  "msg": "success",
          "code": 200,
          "data": [
    {
      "clientTransferId": "4e8c51b7-97ac-4ef1-864f-7869f13c0c7f",
      "asset": "USDT",
      "fromExchange": "bingx",
      "fromSubAccount": "4665179554",
      "toExchange": "binance",
      "toSubAccount": "someacccount@binance.com",
      "applyAmount": "20",
      "realAmount": "19",
      "feeAmount": "1",
      "externalStatus": "done",
      "applyTime": 1715305243482,
      "arriveTime": null,
      "failReason": "exchange internal error."
    }
  ],
          "ts": 1715306224948
}

响应数据

六、错误码

七、更新说明

20240715

• 划转记录查询接口新增transferId参数支持；

20240628

• 新增支持火币交易所；
• 完善bingx出入金账户枚举；
• 新增错误码45169

20240615

• 补充出入金账户类型字段以及对应枚举说明

20240606

• 补充子账户各交易所默认转入转出账户