Change log:

**# Public Rest API for Coins (2025-06-20)

General API Information

• The base endpoint is: https://api.coins.co.th
• All endpoints return data in either a JSON object or array format.
• Data is returned in ascending order, with the oldest records appearing first and the newest records appearing last.
• All time and timestamp related fields are expressed in milliseconds.

HTTP Return Codes

• HTTP 4XX return codes are used for malformed requests; the issue is on the sender's side.
• HTTP 403 return code is used when the WAF Limit (Web Application Firewall) has been violated.
• HTTP 429 return code is used when breaking a request rate limit.
• HTTP 418 return code is used when an IP has been auto-banned for continuing to send requests after receiving 429 codes.
• HTTP 5XX return codes are used for internal errors; the issue is on exchange's side. It is important to NOT treat this as a failure operation; the execution status is UNKNOWN and could have been a success.

Error Codes

• Any endpoint can return an ERROR; the error payload is as follows:

{
  "code": -1000,
  "msg": "An unknown error occurred while processing the request."
}

• Specific error codes and messages are defined in another document.

API Library

Connectors

The following are lightweight libraries that work as connectors to the Coins public API, written in different languages:

• Python https://github.com/coins-docs/coins-connector-python

Postman Collections

Postman collections are available, and they are recommended for new users seeking a quick and easy start with the API.

• Postman https://github.com/coins-docs/coins.co.th-api-postman

General Information on Endpoints

• For GET endpoints, parameters must be sent as a query string.
• For POST, PUT, and DELETE endpoints, the parameters may be sent as a query string or in the request body with content type application/x-www-form-urlencoded. It is also possible to use a combination of parameters in both the query string and the request body if desired.
• Parameters can be sent in any order.
• If a parameter is included in both the query string and the request body, the value of the parameter from the query string will take precedence and be used.

LIMITS

General Info on Limits

• intervalNum describes the amount of the interval. For example, intervalNum 5 with intervalLetter M means "Every 5 minutes".

• An HTTP status code 429 will be returned when the rate limit is violated.

IP Limits

• Each route has a weight which determines the number of requests each endpoint counts for. Endpoints with heavier operations or those that involve multiple symbols will have a higher weight.
• When a 429 response code is received, it is mandatory for the API user to back off and refrain from making further requests.
• Repeated failure to comply with rate limits and a disregard for backing off after receiving 429 responses can result in an automated IP ban. The HTTP status code 418 is used for IP bans.
• IP bans are tracked and their duration increases for repeat offenders, ranging from 2 minutes to 3 days.
• A Retry-After header is included in 418 or 429 responses, indicating the number of seconds that need to be waited in order to prevent a ban (for 429) or until the ban is lifted (for 418).
• The limits imposed by the API are based on IP addresses rather than API keys.

Order Rate Limits

• When the order count exceeds the limit, you will receive a 429 error without the Retry-After header.

• The order rate limit is counted against each IP and UID.

Websocket Limits

• A single connection can listen to a maximum of 1024 streams.

/api/ Limit Introduction

• For endpoints related to /api/*:

  • There are two modes of limit enforcement: IP limit and UID limit. Each mode operates independently.

  • The IP limit allows a maximum of 1200 requests per minute across all endpoints within the /api/* namespace.

  • The UID limit allows a maximum of 1800 requests per minute across all endpoints within the /api/* namespace.

Endpoint Security Type

• Each endpoint is associated with a security type, which indicates how you should interact with it. The security type is specified next to the name of the endpoint.
  • If no security type is mentioned, assume that the security type is NONE.
• API keys are passed to the Rest API via the X-COINS-APIKEY header.
• Both API keys and secret keys are case sensitive.
• API keys can be configured to have access only to specific types of secure endpoints. For example, one API key may be restricted to TRADE routes only, while another API key can have access to all routes except TRADE.
• By default, API keys have access to all secure routes.

• USER_DATA endpoints are SIGNED endpoints.

SIGNED (USER_DATA) Endpoint Security

• SIGNED endpoints require an additional parameter, signature, to be sent in the query string or form request body or header.
• Endpoints use HMAC SHA256 signatures. The HMAC SHA256 signature is a keyed HMAC SHA256 operation. Use your secretKey as the key and totalParams as the value for the HMAC operation.
• The signature is not case sensitive.
• totalParams is defined as the query string concatenated with the request body(exclude signature parameters and values If signature parameters are in both).
• We recommend the use of the query string for GET requests and the form request body for POST requests.

Timing Security

• A SIGNED endpoint requires an additional parameter, timestamp, to be sent in the query string or form request body or header(Not recommended). The timestamp should be in millisecond timestamp indicating when the request was created and sent.

• An optional parameter, recvWindow, can be included to specify the validity duration of the request in milliseconds after the timestamp. If recvWindow is not provided, it will default to 5000 milliseconds.

• The logic is as follows:

  if (timestamp < (serverTime + 1000) && (serverTime - timestamp) <= recvWindow) {
    // process request
  } else {
    // reject request
  }
  

Serious trading is about timing. Networks can be unstable and unreliable, which can lead to requests taking varying amounts of time to reach the servers. With recvWindow, you can specify that the request must be processed within a certain number of milliseconds or be rejected by the server.

To ensure optimal performance, it is recommended to use a recvWindow value of 5000 milliseconds or less. The maximum value allowed for recvWindow is 60,000 milliseconds and should not exceed this limit.

SIGNED Endpoint Examples for POST /openapi/convert/v1/get-quote

Here is a step-by-step example of how to send a valid signed payload from the Linux command line using echo, openssl, and curl:

Example 1: As a query string

• queryString: sourceCurrency=BTC&targetCurrency=THB&recvWindow=5000&timestamp=1538323200000
• HMAC SHA256 signature:

[linux]$ echo -n "sourceCurrency=BTC&targetCurrency=THB&recvWindow=5000&timestamp=1538323200000" | openssl dgst -sha256 -hmac "lH3ELTNiFxCQTmi9pPcWWikhsjO04Yoqw3euoHUuOLC3GYBW64ZqzQsiOEHXQS76"
(stdin)= 6a2cfc4f792ff338ed413ec2197540b46fead0e43c143eb5d04992a4d7d6622d

• curl command:

(HMAC SHA256)
[linux]$ curl -H "X-COINS-APIKEY: tAQfOrPIZAhym0qHISRt8EFvxPemdBm5j5WMlkm3Ke9aFp0EGWC2CGM8GHV4kCYW" -X POST 'https://$HOST/openapi/convert/v1/get-quote?sourceCurrency=BTC&targetCurrency=THB&recvWindow=5000&timestamp=1538323200000&signature=6a2cfc4f792ff338ed413ec2197540b46fead0e43c143eb5d04992a4d7d6622d'

Example 2: As a request body

• requestBody: sourceCurrency=BTC&targetCurrency=THB&recvWindow=5000&timestamp=1538323200000
• HMAC SHA256 signature:

[linux]$ echo -n "sourceCurrency=BTC&targetCurrency=THB&recvWindow=5000&timestamp=1538323200000" | openssl dgst -sha256 -hmac "lH3ELTNiFxCQTmi9pPcWWikhsjO04Yoqw3euoHUuOLC3GYBW64ZqzQsiOEHXQS76"
(stdin)= 6a2cfc4f792ff338ed413ec2197540b46fead0e43c143eb5d04992a4d7d6622d

• curl command:

(HMAC SHA256)
[linux]$ curl -H "X-COINS-APIKEY: tAQfOrPIZAhym0qHISRt8EFvxPemdBm5j5WMlkm3Ke9aFp0EGWC2CGM8GHV4kCYW" -X POST 'https://$HOST/openapi/convert/v1/get-quote' -d 'sourceCurrency=BTC&targetCurrency=THB&recvWindow=5000&timestamp=1538323200000&signature=6a2cfc4f792ff338ed413ec2197540b46fead0e43c143eb5d04992a4d7d6622d'

Example 3: Mixed query string and request body

• queryString: sourceCurrency=BTC&targetCurrency=THB
• requestBody: recvWindow=5000&timestamp=1538323200000
• HMAC SHA256 signature:

[linux]$ echo -n "sourceCurrency=BTC&targetCurrency=THBrecvWindow=5000&timestamp=1538323200000" | openssl dgst -sha256 -hmac "lH3ELTNiFxCQTmi9pPcWWikhsjO04Yoqw3euoHUuOLC3GYBW64ZqzQsiOEHXQS76"
(stdin)= ce922a44572e6433789c78f525738379ea0052551e4d65c1771ce8059c902b42

• curl command:

(HMAC SHA256)
[linux]$ curl -H "X-COINS-APIKEY: tAQfOrPIZAhym0qHISRt8EFvxPemdBm5j5WMlkm3Ke9aFp0EGWC2CGM8GHV4kCYW" -X POST 'https://$HOST/openapi/convert/v1/get-quote?sourceCurrency=BTC&targetCurrency=THB' -d 'recvWindow=5000&timestamp=1538323200000&signature=ce922a44572e6433789c78f525738379ea0052551e4d65c1771ce8059c902b42'

Note that in Example 3, the signature is different from the previous examples. Specifically, there should be no & character between THB and recvWindow=5000.

Public API Endpoints

Terminology

These terms will be used throughout the documentation, so new users are encouraged to read them to help their understanding of the API.

• base asset refers to the asset that is the quantity of a symbol. For the symbol BTCTHB, BTC would be the base asset.
• quote asset refers to the asset that is the price of a symbol. For the symbol BTCTHB, THB would be the quote asset.

General endpoints

Test connectivity

GET /openapi/v1/ping

Test connectivity to the Rest API.

Weight: 1

Parameters: NONE

Response:

{}

Check server time

GET /openapi/v1/time

Test connectivity to the Rest API and get the current server time.

Weight: 1

Parameters: NONE

Response:

{
  "serverTime": 1538323200000
}

Get user ip

GET /openapi/v1/user/ip

Get the user ip.

Weight: 1

Parameters: NONE

Response:

{
  "ip": "57.181.16.43"
}

Wallet endpoints

All Coins' Information (USER_DATA)

GET /openapi/wallet/v1/config/getall  (HMAC SHA256)

Get information on coins (available for deposit and withdrawal) for the user.

Weight(IP): 10

Parameters:

Response:

[
  {
    "coin": "THB",
    "depositAllEnable": false,
    "free": "161.61",
    "legalMoney": true,
    "locked": "0",
    "name": "THB",
    "networkList": [],
    "transferMinQuantity": "0",
    "transferPrecision": 2,
    "withdrawAllEnable": false
  },
  {
    "coin": "BTC",
    "depositAllEnable": true,
    "free": "0",
    "legalMoney": false,
    "locked": "0",
    "name": "BTC",
    "networkList": [
      {
        "addressRegex": "^[13][a-km-zA-HJ-NP-Z1-9]{25,34}$|^(bc1)[0-9A-Za-z]{39,59}$",
        "depositEnable": true,
        "memoRegex": "",
        "minConfirm": 1,
        "name": "Bitcoin",
        "network": "BTC",
        "sameAddress": false,
        "unLockConfirm": 2,
        "withdrawDesc": "",
        "withdrawEnable": true,
        "withdrawFee": "0.00009",
        "withdrawIntegerMultiple": "0.00000001",
        "withdrawMax": "5",
        "withdrawMin": "0.0005"
      }
    ],
    "transferMinQuantity": "0",
    "transferPrecision": 8,
    "withdrawAllEnable": true
  }
]

Deposit Address (USER_DATA)

GET /openapi/wallet/v1/deposit/address  (HMAC SHA256)

Fetch a deposit address along with its network.

Weight(IP): 10

Parameters:

Response:

{
  "address": "0x73d132fd814b860b52cc5e3f6360489babf6f170",
  "addressTag": "",
  "coin": "USDT"
}

Withdraw (USER_DATA)

POST /openapi/wallet/v1/withdraw/apply  (HMAC SHA256)

Submit a withdrawal request.

Weight(UID): 100

Parameters:

• Please note that the coin/network/address/addressTag combination MUST be in the withdrawal address whitelist. You must set up the withdrawal address whitelist before making this API call.

Response:

{
  "id":"459165282044051456"
}

Deposit History (USER_DATA)

GET /openapi/wallet/v1/deposit/history  (HMAC SHA256)

Fetch deposit history.

Weight(IP): 2

Parameters:

• Please note the default startTime and endTime to ensure the time interval is within 0-90 days.

• If both startTime and endTime are sent, time between startTime and endTime must be less than 90 days.

• Please note you can send either status or statuses, but not both.

Response:

[
  {
    "address": "0x73d132fd814b860b52cc5e3f6360489babf6f170",
    "addressTag": "",
    "amount": "24.085339",
    "coin": "USDT",
    "confirmNo": 100,
    "id": "d_250625000011140125",
    "insertTime": 1750838054000,
    "network": "BSC",
    "status": 1,
    "txId": "0x686594292283a496156d06a6db9caee824e44e48dd5690a541f88cb7bc1bd605"
  }
]

Withdraw History (USER_DATA)

GET /openapi/wallet/v1/withdraw/history  (HMAC SHA256)

Fetch withdrawal history.

Weight(IP): 2

Parameters:

• Please note the default startTime and endTime to ensure the time interval is within 0-90 days.

• If both startTime and endTime are sent, time between startTime and endTime must be less than 90 days.

• If withdrawOrderId is sent, time between startTime and endTime must be less than 7 days.

• If withdrawOrderId is sent and startTime and endTime are not provided, the API will return records from the last 7 days by default.

Response:

[
  {
    "address": "0x433ffedf286eac57243c9e6a92b5b4e38040fbc8",
    "addressTag": "",
    "amount": "9",
    "applyTime": 1750839129000,
    "coin": "USDT",
    "confirmNo": 0,
    "id": "1980576597216475392",
    "info": "",
    "network": "BSC",
    "status": 2,
    "transactionFee": "1",
    "txId": "",
    "withdrawOrderId": ""
  }
]

Transfers (USER_DATA)

POST /openapi/transfer/v3/transfers

This endpoint is used to transfer funds between two accounts.

Weight: 50

Parameters:

If the client_transfer_id or id parameter is passed in, the type parameter is invalid.

Request:

{
  "account": "1451431230880900352",
  "target_address": "christina@gmail.com",
  "amount": "1232"
}

Response:

{
  "transfer":
    {
      "id": "1451431230880900352",
      "status": "success",//status enum: pending,success,failed
      "account": "90dfg03goamdf02fs",
      "target_address": "testsub@gmail.com",
      "amount": "1",
      "exchange": "1",
      "payment": "23094j0amd0fmag9agjgasd",
      "client_transfer_id": "1487573639841995271",
      "message": "example",
      "errorMessage":""//Error message returned when transfer fails, eg: Insufficient balance
     }
}

Query transfers (USER_DATA)

GET /openapi/transfer/v3/transfers/{id}

If an ID is provided, this endpoint retrieves an existing transfer record; otherwise, it returns a paginated list of transfers.

Weight: 10

Parameters:

• If client_transfer_id both the id and parameters are passed, the id parameter will take precedence.
• If the client_transfer_id or id parameter is passed, then the client_transfer_id or id takes precedence.
• The from_address and to_address parameters cannot be passed simultaneously.

Response:

 {
  "transfers": [
    {
      "id": "2309rjw0amf0sq9me0gmadsmfoa",
      "client_transfer_id": "1487573639841995270",
      "account": "90dfg03goamdf02fs",
      "amount": "1",
      "fee_amount": "0",
      "currency": "BTC",
      "sourceAddress": "test1@gmail.com",
      "target_address": "test2@gmail.com",
      "payment": "23094j0amd0fmag9agjgasd",
      "type": 2,//2:transfer out,1:transfer in
      "status": "success",
      "message": "example",
      "created_at": "2019-07-04T03:28:50.531599Z"
    }
  ],
  "meta": {
    "total_count": 0,
    "next_page": 2,
    "previous_page": 0
  }
}

• Please note Email address should be encoded. e.g. test@gmail.com should be encoded into test%40gmail.com

Account information (USER_DATA)

GET /openapi/v1/account (HMAC SHA256)

GET current account information.

Weight: 10

Parameters:

Response:

{
  "annually": {
    "cashInLimit": "400000000",
    "cashInRemaining": "400000000",
    "cashOutLimit": "400000000",
    "cashOutRemaining": "400000000",
    "totalWithdrawLimit": "800000000",
    "totalWithdrawRemaining": "800000000"
  },
  "balances": [
    {
      "asset": "THB",
      "free": "161.61",
      "locked": "0"
    },
    {
      "asset": "USDT",
      "free": "19.085339",
      "locked": "0"
    }
  ],
  "canDeposit": true,
  "canTrade": true,
  "canWithdraw": true,
  "daily": {
    "cashInLimit": "2000000",
    "cashInRemaining": "2000000",
    "cashOutLimit": "2000000",
    "cashOutRemaining": "2000000",
    "totalWithdrawLimit": "4000000",
    "totalWithdrawRemaining": "4000000"
  },
  "monthly": {
    "cashInLimit": "60000000",
    "cashInRemaining": "60000000",
    "cashOutLimit": "60000000",
    "cashOutRemaining": "60000000",
    "totalWithdrawLimit": "120000000",
    "totalWithdrawRemaining": "120000000"
  },
  "token": "THB",
  "updateTime": 1750769650420
}

Query balance (USER_DATA)

GET /openapi/account/v3/crypto-accounts

This endpoint allows users to retrieve their current account balance.

Weight: 1 Parameters:

Response:

 {
  "crypto-accounts": [
    {
      "id": "1451431230880900352",
      "name": "name",
      "currency": "BTC",
      "balance": "1",
      "pending_balance": "2"
    }
  ]
}

Query transaction history (USER_DATA)

GET /openapi/v1/asset/transaction/history

Weight: 10

Parameters:

Response:

 {
  "meta": {
    "has_next": false,
    "next_page": 2,
    "previous_page": 0
  },
  "transactions": [
    {
      "bizSubject": "CONVERT",
      "changed": "-5",
      "status": "SUCCESS",
      "time": "1750838429677",
      "tokenId": "USDT",
      "txId": "19805707243820006402convert"
    },
    {
      "bizSubject": "CHAIN_DEPOSIT",
      "changed": "24.085339",
      "status": "SUCCESS",
      "time": "1750838101994",
      "tokenId": "USDT",
      "txId": "d_250625000011140125"
    }
  ]
}

Convert endpoints

Get supported trading pairs (TRADE)

POST /openapi/convert/v1/get-supported-trading-pairs

This continuously updated endpoint returns a list of all available trading pairs.

Weight: 1

Parameters:

N/A

Response:

{
  "data": [
    {
      "maxSourceAmount": "300000",
      "minSourceAmount": "50",
      "precision": "2",
      "sourceCurrency": "THB",
      "targetCurrency": "BTC"
    },
    {
      "maxSourceAmount": "0.09493131",
      "minSourceAmount": "0.00001294",
      "precision": "8",
      "sourceCurrency": "BTC",
      "targetCurrency": "THB"
    },
    {
      "maxSourceAmount": "200000",
      "minSourceAmount": "50",
      "precision": "2",
      "sourceCurrency": "THB",
      "targetCurrency": "BCH"
    },
    {
      "maxSourceAmount": "13.9699",
      "minSourceAmount": "0.0028",
      "precision": "8",
      "sourceCurrency": "BCH",
      "targetCurrency": "THB"
    },
    {
      "maxSourceAmount": "200000",
      "minSourceAmount": "50",
      "precision": "2",
      "sourceCurrency": "THB",
      "targetCurrency": "XRP"
    },
    {
      "maxSourceAmount": "3088.38",
      "minSourceAmount": "0.63",
      "precision": "6",
      "sourceCurrency": "XRP",
      "targetCurrency": "THB"
    },
    {
      "maxSourceAmount": "200000",
      "minSourceAmount": "50",
      "precision": "2",
      "sourceCurrency": "THB",
      "targetCurrency": "USDT"
    },
    {
      "maxSourceAmount": "6749.29",
      "minSourceAmount": "1.38",
      "precision": "8",
      "sourceCurrency": "USDT",
      "targetCurrency": "THB"
    },
    {
      "maxSourceAmount": "200000",
      "minSourceAmount": "50",
      "precision": "2",
      "sourceCurrency": "THB",
      "targetCurrency": "USDC"
    },
    {
      "maxSourceAmount": "6752.67",
      "minSourceAmount": "1.38",
      "precision": "8",
      "sourceCurrency": "USDC",
      "targetCurrency": "THB"
    },
    {
      "maxSourceAmount": "200000",
      "minSourceAmount": "50",
      "precision": "2",
      "sourceCurrency": "THB",
      "targetCurrency": "ETH"
    },
    {
      "maxSourceAmount": "2.75970265",
      "minSourceAmount": "0.00056448",
      "precision": "8",
      "sourceCurrency": "ETH",
      "targetCurrency": "THB"
    }
  ],
  "error": "OK",
  "status": 0
}

Fetch a quote (TRADE)

POST /openapi/convert/v1/get-quote

This endpoint returns a quote for a specified source currency (sourceCurrency) and target currency (targetCurrency) pair.

Weight: 1

Parameters:

Response:

{
  "data": {
    "expiry": "7",
    "price": "32.3229",                         //1 USDT = 32.3229 THB
    "quoteId": "19805702457826526722convert",
    "sourceAmount": "5",
    "sourceCurrency": "USDT",
    "targetAmount": "161.61",                   //The amount of THB the user holds
    "targetCurrency": "THB"
  },
  "error": "OK",
  "status": 0
}

Accept the quote (TRADE)

POST /openapi/convert/v1/accept-quote

Use this endpoint to accept the quote and receive the result instantly.

Weight: 1

Parameters:

Response:

{
  "data": {
    "orderId": "19805707243820006402convert",
    "status": "SUCCESS"
  },
  "error": "OK",
  "status": 0
}

Error code description:

Retrieve order history (USER_DATA)

POST /openapi/convert/v1/query-order-history

This endpoint retrieves order history with the option to define a specific time period using start and end times.

Weight: 1

Parameters:

Response:

{
  "data": [
    {
      "createdAt": "1750838429000",
      "errorCode": "",
      "errorMessage": "",
      "fee": "0",
      "inversePrice": null,
      "orderId": "19805707243820006402convert",
      "price": "32.3229",
      "quoteId": "19805707243820006402convert",
      "sourceAmount": "5",
      "sourceCurrency": "USDT",
      "status": "SUCCESS",
      "targetAmount": "161.61",
      "targetCurrency": "THB"
    }
  ],
  "error": "OK",
  "status": 0,
  "total": 1
}

User data stream endpoints

Specifics on how user data streams work is in another document(user-data-stream.md).

Start user data stream (USER_STREAM)

POST /openapi/v1/userDataStream

Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent.

Weight: 1

Parameters:

None

Response:

{
  "listenKey": "xDqtskqOciCzRashthgjTHBcymasBBShEEzPiXgOGEujviYWCuyYwcPDVPeezJOT"
}

Keepalive user data stream (USER_STREAM)

PUT /openapi/v1/userDataStream

Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes.

Weight: 1

Parameters:

Response:

{}

Close user data stream (USER_STREAM)

DELETE /openapi/v1/userDataStream

Close out a user data stream.

Weight: 1

Parameters:

Response:

{}

Sub-account endpoints

Query Sub-account List (For Master Account)

Applies to master accounts only.

GET /openapi/v1/sub-account/list

Weight: 1

Parameters:

Response:

{
  "subAccounts": [
    {
      "createTime": "1689744671462",
      "email": "testsub@gmail.com",
      "isFreeze": false
    },
    {
      "createTime": "1689744700710",
      "email": "testsub2@gmail.com",
      "isFreeze": false
    }
  ],
 "total": 2
}

Create a Virtual Sub-account(For Master Account)

This interface currently supports the creation of virtual sub-accounts (maximum 30).

POST /openapi/v1/sub-account/create

Weight: 1

Parameters:

Response:

{
  "email": "testsub@gmail.com",
  "createTime": 1689744700710,
  "isFreeze": false
}

Query Sub-account Assets (For Master Account)

Query detailed balance information of a sub-account via the master account (applies to master accounts only).

GET /openapi/v1/sub-account/asset

Weight: 1

Parameters:

Response:

{
  "balances": [
    {
      "asset": "BTC",
      "free": "0.1",
      "locked": "0"
    },
    {
      "asset": "ETH",
      "free": "0.1",
      "locked": "0"
    }
  ]
}

Universal Transfer (For Master Account)

Master account can initiate a transfer from any of its sub-accounts to the master account, or from the master account to any sub-account.

POST /openapi/v1/sub-account/transfer/universal-transfer

Weight: 1

Parameters:

• Transfer from master account by default if fromEmail is not sent.
• Transfer to master account by default if toEmail is not sent.
• Specify at least one of fromEmail and toEmail.
• Supported transfer scenarios:
  • Master account transfer to sub-account
  • Sub-account transfer to master account
  • Sub-account transfer to Sub-account

Response:

{
  "clientTransferId": "1487573639841995271",
  "result": true//true:success,false:failed
}

Transfer to Master (For Sub-account)

Sub-account can initiate a transfer from itself to the master account.

POST /openapi/v1/sub-account/transfer/sub-to-master

Weight: 1

Parameters:

Response:

{
  "clientTransferId": "1487573639841995271",
  "result": true//true:success,false:failed
}

Query Universal Transfer History (For Master Account)

Applies to master accounts only. If startTime and endTime are not sent, this will return records of the last 30 days by default.

GET /openapi/v1/sub-account/transfer/universal-transfer-history

Weight: 1

Parameters:

• fromEmail and toEmail cannot be sent at the same time.
• Return fromEmail equal master account email by default.
• The query time period must be less than 30 days.
• If startTime and endTime not sent, return records of the last 30 days by default.

Response:

{
  "result": [
    {
      "clientTranId": "1",
      "fromEmail": "testsub@gmail",
      "toEmail": "testsub1@gmail",
      "asset": "BTC",
      "amount": "0.1",
      "createdAt": 1689744700710,
      "status": "success"//success,pending,failed
    }
  ],
  "total": 1
}

Sub-account Transfer History (For Sub-account)

Applies to sub-accounts only. If startTime and endTime are not sent, this will return records of the last 30 days by default.

GET /openapi/v1/sub-account/transfer/sub-history

Weight: 1

Parameters:

• If type is not sent, the records of type 2: transfer out will be returned by default.
• If startTime and endTime are not sent, the recent 30-day data will be returned.

Response:

{
  "result": [
    {
      "clientTranId": "1",
      "fromEmail": "testsub@gmail",
      "toEmail": "testsub1@gmail",
      "asset": "BTC",
      "amount": "0.1",
      "createdAt": 1689744700710,
      "status": "success"//success,pending,failed
    }
  ],
  "total": 1
}

Get IP Restriction for a Sub-account API Key (For Master Account)

Query detailed IPs for a sub-account API key.

GET /openapi/v1/sub-account/apikey/ip-restriction

Weight: 1

Parameters:

Response:

{
  "apikey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "ipList": [
    "8.8.8.8"
  ],
  "ipRestrict": true,
  "role": "2,3,4,5,6",//0:READ_ONLY, 2:TRADE_ONLY, 3:CONVERT_ONLY, 4:CRYPTO_WALLET_ONLY, 5:FIAT_ONLY, 6:ACCOUNT_ONLY
  "updateTime": 1689744700710
}

Add IP Restriction for Sub-Account API key (For Master Account)

POST /openapi/v1/sub-account/apikey/add-ip-restriction

Weight: 1

Parameters:

Response:

{
  "apikey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "ipList": [
    "8.8.8.8"
  ],
  "ipRestrict": true,
  "role": "2,3,4,5,6",//0:READ_ONLY, 2:TRADE_ONLY, 3:CONVERT_ONLY, 4:CRYPTO_WALLET_ONLY, 5:FIAT_ONLY, 6:ACCOUNT_ONLY
  "updateTime": 1689744700710
}

Delete IP List For a Sub-account API Key (For Master Account)

POST /openapi/v1/sub-account/apikey/delete-ip-restriction

Weight: 1

Parameters:

Response:

{
  "apikey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "ipList": [
    "8.8.8.8"
  ],
  "ipRestrict": true,
  "role": "2,3,4,5,6",//0:READ_ONLY, 2:TRADE_ONLY, 3:CONVERT_ONLY, 4:CRYPTO_WALLET_ONLY, 5:FIAT_ONLY, 6:ACCOUNT_ONLY
  "updateTime": 1689744700710
}

Get Sub-account Deposit Address(For Master Account)

GET /openapi/v1/sub-account/wallet/deposit/address

Fetch sub account deposit address with network.

Weight: 10

Parameters:

Response:

{
  "coin": "ETH",
  "address": "0xfe98628173830bf79c59f04585ce41f7de168784",
  "addressTag": ""
}

Get Sub-account Deposit History(For Master Account)

GET /openapi/v1/sub-account/wallet/deposit/history

Fetch deposit history.

Weight(IP): 2

Parameters:

• Please note the default startTime and endTime to ensure the time interval is within 0-90 days.

• If both startTime and endTime are sent, time between startTime and endTime must be less than 90 days.

Response:

[
    {
        "id": "d_769800519366885376",
        "amount": "0.001",
        "coin": "BTC",
        "network": "BTC",
        "status": 0,
        "address": "15g7UoRTVjAdUnHyRMCt4RrZ4m1Aib61rr",
        "addressTag": "",
        "txId": "2e5adfb42d5b60582bfcddbf51b06fc7a9ee458f5e61b6a00e333329274a13e6",
        "insertTime": 1661493146000,
        "confirmNo": 10,
    },
    {
        "id": "d_769754833590042625",
        "amount":"0.5",
        "coin":"ETH",
        "network":"ETH",
        "status":1,
        "address":"0x386AE30AE2dA293987B5d51ddD03AEb70b21001F",
        "addressTag":"",
        "txId":"0x4ae2fed36a90aada978fc31c38488e8b60d7435cfe0b4daed842456b4771fcf7",
        "insertTime":1599620082000,
        "confirmNo": 20,
    }
]

Collect sub-account assets (For Master Account)

POST /openapi/v1/fund-collect/collect-from-sub-account

If there are tasks with a status of INIT, resubmission is not allowed. This interface will return {'code': -10324, 'msg': 'Request repeated.'}.

Weight: 1

Parameters:

Response:

{
  "clientRequestId": "777d3f71-4715-4150-9fd1-d13246d7e02b",
  "status": "INIT",
  "comment": ""
}

Response Description

Retrieve asset collection records (USER_DATA)

GET /openapi/v1/fund-collect/get-fund-record

Retrieve asset collection records.

Weight: 1

Parameters:

Response:

[
  {
    "clientRequestId": "09533266-1fea-11f0-8ff9-2a3efdea066c",
    "comment": "",
    "status": "SUCCESS"
  },
  {
    "clientRequestId": "09533266-1fea-11f0-8ff9-2a3efdea066b",
    "comment": "",
    "status": "SUCCESS"
  }
]

Collection Task Status: INIT, SUCCESS, PARTIAL_SUCCESS, PROCESSING,FAILED