1、Introduction

Welcome to the API documentation. This guide outlines the details of the fund transfer API interfaces, including instructions for access and signature authentication.

2、Connection Instructions

2.1 Access URLs

REST API

• https://api.satsresearch.com

2.2 Rate Limiting Rules

Rate limiting rules are applied to the interface. Currently, the restricting access to 10 requests per second per interface.

Users can adjust their access strategy based on the information in the HTTP Header.

• rateLimit-times： The upper limit of requests per round, unit: times
• rateLimit-interval：The time interval for resetting the request count, unit: milliseconds
• rateLimit-remaining：The remaining available requests in the current round, unit: times
• rateLimit-reset：The reset time for the request count upper limit, unit: milliseconds

3、Signature Authentication

3.1 Signature Instructions

API requests transmitted over the internet are highly likely to be tampered with. To ensure that the requests have not been altered, all private interfaces (excluding public interfaces such as basic information and market data) must use your API Key for signature authentication to verify whether the parameters or parameter values have been changed during transmission. (The encoding set is unified as "UTF-8")

A valid request consists of the following parts:

• Request Method Address: The server address to access, e.g., https://api.satsresearch.com，such as https://api.satsresearch.com/api/v1/broker/transferFunds
• API Access Key (AccessKeyId): The Access Key in your API Key.
• Signature Method (SignatureMethod): The hash-based protocol used by the user to calculate the signature, in this case, HmacSHA256.
• Signature Version (SignatureVersion): The version of the signature protocol, here it is 1.
• Timestamp: The current system time in milliseconds.
• Mandatory and Optional Parameters: Each method has a set of required and optional parameters that define the API call. These parameters and their meanings can be found in the description of each method. Please note: For GET requests, all parameters for each method must be included in the signature calculation.； For POST requests, the method's parameters do not require signature authentication. Only the following four parameters need to be included in the signature calculation: AccessKeyId, SignatureMethod, SignatureVersion, and Timestamp. All other parameters should be placed in the body of the POST request.
• Signature: The value derived from the signature calculation is used to ensure the validity and integrity of the signature, confirming it has not been tampered with.

3.2 Signature Steps

It's important to standardize the request before calculating the signature, because when using HmacSHA256 for signature calculation, different content will produce completely different results. Therefore, before calculating the signature, please ensure that the request is properly standardized. The following example demonstrates this process using a fund transfer request.

The reference for the API key and secret key for the request is as follows:

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

AccessSecret: 1KFjiTRVlGSyzoNIEXIx8boXe7njFmjeHwiK4kKkEOY=

The URL for initiating a fund transfer request is as follows:

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

1. Request method (GET or POST) followed by a newline character "\n"

POST\n

2. Add the lowercase access address followed by a newline character "\n"

api.satsresearch.com\n

3. Access method path followed by a newline character "\n"

/api/v1/broker/transferFunds\n

4. Sort the parameter names in ASCII order. For example, here is the original sequence of request parameters after encoding:

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

Use UTF-8 encoding and perform URI encoding. Hexadecimal characters must be uppercase, such as encoding ":" as "%3A" and space as "%20".

After sorting,

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

SignatureMethod=HmacSHA256

SignatureVersion=1

Timestamp=1662022581951

5. Connect the parameters using the character "&" according to the above order.

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

6. Form the final string to be used for signature calculation as follows:

POST\n

api.satsresearch.com\n

/api/v1/broker/transferFunds\n

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

7. Use the "request string" generated in the previous step and your Secret Key to generate a digital signature.

1KFjiTRVlGSyzoNIEXIx8boXe7njFmjeHwiK4kKkEOY=

1. Use the request string obtained in the previous step and the secret key as two parameters to call the HmacSHA256 signature function to obtain the signature information.
2. Encode this signature information using base-64, and use the resulting value as the digital signature for this API call.

8. Add the generated digital signature to the request's path parameters.

Finally, the API request sent to the server should be:

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

• Add all required authentication parameters to the URL path parameters.
• Add the URL-encoded digital signature to the path parameters with the parameter name "Signature".

4、Business Enumerations

Exchange Enumerations

*Account Type Enumerations *

5、API Details

5.1 Fund Transfer

HTTP Request

• POST /api/v1/broker/transferFunds

Request Parameters

Response:

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

Note

• AM Partnership currently does not support fund transfers between different business accounts under the same account.

Response Data

5.2 Query Fund Transfer Record

HTTP Request

• GET /api/v1/broker/transfer/record

Request Parameters

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
}

Response Data

5.3 Get Transfer Records

HTTP Request

• POST /api/v1/broker/transfer/recordList

Request Parameters

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
}

Response Data

6、Error Codes

7、Update Notes

20240716

• Initialize document