Skip to main content Link Search Menu Expand Document (external link)

Change log:

2023-05-10: Added the from_address to_address parameter to the /openapi/transfer/v3/transfers endpoint.

2024-04-29: Added the inversePrice response parameter to the /openapi/convert/query-order-history endpoint.

2024-04-24: Add Sub-account endpoints : /openapi/v1/sub-account/list,/openapi/v1/sub-account/create,/openapi/v1/sub-account/asset,/openapi/v1/sub-account/transfer/universal-transfer,/openapi/v1/sub-account/transfer/sub-to-master,/openapi/v1/sub-account/transfer/universal-transfer-history,/openapi/v1/sub-account/transfer/sub-history,/openapi/v1/sub-account/apikey/ip-restriction,/openapi/v1/sub-account/apikey/add-ip-restriction,/openapi/v1/sub-account/apikey/delete-ip-restriction

2024-04-17: Added the targetAmount parameter to the /openapi/convert/v1/get-quote endpoint.

2024-02-19: Added the openapi/v1/user/ip endpoint.

2023-12-29: Added kyc remaining and limit to the /openapi/v1/account endpoint.

2023-12-06: Added the internalOrderId generate rule description to the /openapi/fiat/v1/cash-out endpoint.

2023-09-20: Added the message parameter to the /openapi/transfer/v3/transfers endpoint.

2023-08-30: Added /openapi/convert/v1/query-order-history, and updatedopenapi/fiat/v1/cash-out, openapi/fiat/v1/support-channel docs.

2023-08-17: Updated /openapi/convert/v1/accept-quote, openapi/fiat/v1/history, openapi/fiat/v1/cash-out, openapi/fiat/v1/support-channel, openapi/migration/v4/sellorder, openapi/migration/v4/validate-field, openapi/migration/v4/payout-outlets/{id}, openapi/migration/v4/payout-outlet-categories/{id}, openapi/migration/v4/payout-outlet-fees docs.

2023-08-08: Updated openapi/fiat/v1/history, openapi/fiat/v1/cash-out, openapi/fiat/v1/support-channel, openapi/migration/v4/sellorder, openapi/migration/v4/validate-field, openapi/migration/v4/payout-outlets/{id}, openapi/migration/v4/payout-outlet-categories/{id}, openapi/migration/v4/payout-outlet-fees docs.

2023-07-31: Added openapi/fiat/v1/history endpoint to query fiat currency order history

2023-07-15: Updated MARKET order type now supports quantity for buy and quoteOrderQty for sell

2023-07-15: Added stpFlag in the request of New order (TRADE) endpoint for anti self-trading behaviour.

2023-07-15: Added order status EXPIRED.

2023-06-08: Added the payment request interface.

2023-05-17: The disclaimer regarding the following endpoints being in the QA phase has been removed as the QA process has been successfully completed: /openapi/account/v3/crypto-accounts, /openapi/transfer/v3/transfers, and /openapi/transfer/v3/transfers/{id}.

2023-05-08: Added the following endpoints: /openapi/account/v3/crypto-accounts, /openapi/transfer/v3/transfers, and /openapi/transfer/v3/transfers/{id}. The endpoints are still in QA and are appropriately marked as such.

2023-05-04: Removed the endpoints /openapi/convert/v1/query-order-history and openapi/fiat/v1/history; removed a personal detail from a code sample in /openapi/fiat/v1/details.

2023-04-13: Added the invoice interface.

2023-04-10: Added the transfer interfaces.

2022-09-12: Modified the symbol in the Cancel All Open Orders on a Symbol API request as required.

2022-09-09: Changed the orderId/transactTime/time/updateTime response from string to number in order related interfaces.

2022-08-24: Updated the STOP_LOSS/TAKE_PROFIT description in the New order (TRADE) API.

2022-08-23: Fixed incorrect depth information.

2022-08-19: Added weight information for all interfaces.

2022-08-12: Changed maxNumOrders to 200 in filter MAX_NUM_ORDERS.

2022-08-12: Changed maxNumAlgoOrders to 5 in filter MAX_NUM_ALGO_ORDERS.

Public Rest API for Coins (2022-09-12)

General API Information

  • The base endpoint is: https://api.pro.coins.ph
  • 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.

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”.

  • A 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 iis 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.

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-APIKEYheader.
  • 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.
Security TypeDescription
NONEEndpoint can be accessed freely.
TRADEEndpoint requires sending a valid API Key and signature.
USER_DATAEndpoint requires sending a valid API Key and signature.
USER_STREAMEndpoint requires sending a valid API Key.
MARKET_DATAEndpoint requires sending a valid API Key.
  • TRADE and USER_DATA endpoints are SIGNED endpoints.

SIGNED (TRADE and USER_DATA) Endpoint Security

  • SIGNED endpoints require an additional parameter, signature, to be sent in the query string or request body.
  • 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.

Timing Security

  • A SIGNED endpoint requires an additional parameter, timestamp, to be included in the request. The timestamp should be the 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 recvWindowis 60,000 milliseconds and should not exceed this limit.

SIGNED Endpoint Examples for POST /openapi/v1/order

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:

KeyValue
apiKeytAQfOrPIZAhym0qHISRt8EFvxPemdBm5j5WMlkm3Ke9aFp0EGWC2CGM8GHV4kCYW
secretKeylH3ELTNiFxCQTmi9pPcWWikhsjO04Yoqw3euoHUuOLC3GYBW64ZqzQsiOEHXQS76
ParameterValue
symbolETHBTC
sideBUY
typeLIMIT
timeInForceGTC
quantity1
price0.1
recvWindow5000
timestamp1538323200000

Example 1: As a query string

  • queryString: symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000
  • HMAC SHA256 signature:
[linux]$ echo -n "symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000" | openssl dgst -sha256 -hmac "lH3ELTNiFxCQTmi9pPcWWikhsjO04Yoqw3euoHUuOLC3GYBW64ZqzQsiOEHXQS76"
(stdin)= 5f2750ad7589d1d40757a55342e621a44037dad23b5128cc70e18ec1d1c3f4c6
  • curl command:
(HMAC SHA256)
[linux]$ curl -H "X-COINS-APIKEY: tAQfOrPIZAhym0qHISRt8EFvxPemdBm5j5WMlkm3Ke9aFp0EGWC2CGM8GHV4kCYW" -X POST 'https://$HOST/openapi/v1/order?symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000&signature=5f2750ad7589d1d40757a55342e621a44037dad23b5128cc70e18ec1d1c3f4c6'

Example 2: As a request body

  • requestBody: symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000
  • HMAC SHA256 signature:
[linux]$ echo -n "symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000" | openssl dgst -sha256 -hmac "lH3ELTNiFxCQTmi9pPcWWikhsjO04Yoqw3euoHUuOLC3GYBW64ZqzQsiOEHXQS76"
(stdin)= 5f2750ad7589d1d40757a55342e621a44037dad23b5128cc70e18ec1d1c3f4c6
  • curl command:
(HMAC SHA256)
[linux]$ curl -H "X-COINS-APIKEY: tAQfOrPIZAhym0qHISRt8EFvxPemdBm5j5WMlkm3Ke9aFp0EGWC2CGM8GHV4kCYW" -X POST 'https://$HOST/openapi/v1/order' -d 'symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000&signature=5f2750ad7589d1d40757a55342e621a44037dad23b5128cc70e18ec1d1c3f4c6'

Example 3: Mixed query string and request body

  • queryString: symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC
  • requestBody: quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000
  • HMAC SHA256 signature:
[linux]$ echo -n "symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTCquantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000" | openssl dgst -sha256 -hmac "lH3ELTNiFxCQTmi9pPcWWikhsjO04Yoqw3euoHUuOLC3GYBW64ZqzQsiOEHXQS76"
(stdin)= 885c9e3dd89ccd13408b25e6d54c2330703759d7494bea6dd5a3d1fd16ba3afa
  • curl command:
(HMAC SHA256)
[linux]$ curl -H "X-COINS-APIKEY: tAQfOrPIZAhym0qHISRt8EFvxPemdBm5j5WMlkm3Ke9aFp0EGWC2CGM8GHV4kCYW" -X POST 'https://$HOST/openapi/v1/order?symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC' -d 'quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000&signature=885c9e3dd89ccd13408b25e6d54c2330703759d7494bea6dd5a3d1fd16ba3afa'

Note that in Example 3, the signature is different from the previous examples. Specifically, there is be no & character between GTC and quantity=1.

Public API Endpoints

Terminology

These terms will be used throughout the documentation, so it is recommended especially for new users to read to help their understanding of the API.

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

ENUM definitions

Symbol status:

  • TRADING
  • BREAK (ongoing)
  • CANCEL_ONLY (ongoing)

Order status:

StatusDescription
NEWThe order has been accepted by the engine.
PARTIALLY_FILLEDA part of the order has been filled.
FILLEDThe order has been completed.
PARTIALLY_CANCELEDA part of the order has been cancelled with self trade.
CANCELEDThe order has been canceled by user
EXPIREDThe order has been cancelled by matching-engine: LIMIT FOK order not filled, limit order not fully filled etc

Order types:

  • LIMIT
  • MARKET
  • LIMIT_MAKER
  • STOP_LOSS
  • STOP_LOSS_LIMIT
  • TAKE_PROFIT
  • TAKE_PROFIT_LIMIT

Order Response Type (newOrderRespType):

  • ACK

  • RESULT

  • FULL

Order side:

  • BUY
  • SELL

Anti self-trading behaviour(stpFlag):

ValueDescription
CBBoth orders will be cancelled by match engine
CNThe new order will be cancelled by match engine
COThe old order will be cancelled by match engine

Time in force (timeInForce):

This sets how long an order will be active before expiration.

StatusDescription
GTCGood Til Canceled
An order will be on the book unless the order is canceled.
IOCImmediate Or Cancel
An order will try to fill the order as much as it can before the order expires.
FOKFill or Kill
An order will expire if the full order cannot be filled upon execution.

Kline/Candlestick chart intervals:

m -> minutes; h -> hours; d -> days; w -> weeks; M -> months

  • 1m
  • 3m
  • 5m
  • 15m
  • 30m
  • 1h
  • 2h
  • 4h
  • 6h
  • 8h
  • 12h
  • 1d
  • 3d
  • 1w
  • 1M

Filters

Filters define trading rules on a symbol or an exchange. Filters come in two forms: symbol filters and exchange filters.

Symbol filters

PRICE_FILTER

The PRICE_FILTER defines the price rules for a symbol. There are 3 parts:

  • minPrice defines the minimum price/stopPrice allowed.
  • maxPrice defines the maximum price/stopPrice allowed.
  • tickSize defines the intervals that a price/stopPrice can be increased/decreased by.

In order to pass the price filter, the following must be true for price/stopPrice:

  • price >= minPrice
  • price <= maxPrice
  • (price-minPrice) % tickSize == 0

/exchangeInfo format:

  {
    "filterType": "PRICE_FILTER",
    "minPrice": "0.00000100",
    "maxPrice": "100000.00000000",
    "tickSize": "0.00000100"
  }
PERCENT_PRICE

The PERCENT_PRICE filter defines valid range for a price based on the weighted average of the previous trades. avgPriceMins is the number of minutes the weighted average price is calculated over.

In order to pass the percent price, the following must be true for price:

  • price <= weightedAveragePrice * multiplierUp
  • price >= weightedAveragePrice * multiplierDown

/exchangeInfo format:

  {
    "filterType": "PERCENT_PRICE",
    "multiplierUp": "1.3000",
    "multiplierDown": "0.7000",
    "avgPriceMins": 5
  }
PERCENT_PRICE_SA

The PERCENT_PRICE_SA filter defines valid range for a price based on the simple average of the previous trades. avgPriceMins is the number of minutes the simple average price is calculated over.

In order to pass the percent_price_sa, the following must be true for price:

  • price <= simpleAveragePrice * multiplierUp
  • price >= simpleAveragePrice * multiplierDown

/exchangeInfo format:

  {
    "filterType": "PERCENT_PRICE_SA",
    "multiplierUp": "1.3000",
    "multiplierDown": "0.7000",
    "avgPriceMins": 5
  }
PERCENT_PRICE_BY_SIDE

The PERCENT_PRICE_BY_SIDE filter defines the valid range for the price based on the last price of the symbol. There is a different range depending on whether the order is placed on the BUY side or the SELL side.

Buy orders will succeed on this filter if:

  • Order price <= bidMultiplierUp * lastPrice
  • Order price >= bidMultiplierDown * lastPrice

Sell orders will succeed on this filter if:

  • Order Price <= askMultiplierUp * lastPrice
  • Order Price >= askMultiplierDown * lastPrice

/exchangeInfo format:

  {
    "filterType": "PERCENT_PRICE_BY_SIDE",
    "bidMultiplierUp": "1.2",
    "bidMultiplierDown": "0.2",
    "askMultiplierUp": "1.5",
    "askMultiplierDown": "0.8",
  }
PERCENT_PRICE_INDEX

The PERCENT_PRICE_INDEX filter defines valid range for a price based on the index price which is calculated based on several exhanges in the market by centain rule. (indexPrice wobsocket pushing will be available in future)

In order to pass the percent_price_index, the following must be true for price:

  • price <= indexPrice * multiplierUp
  • price >= indexPrice * multiplierDown

/exchangeInfo format:

  {
    "filterType": "PERCENT_PRICE_INDEX",
    "multiplierUp": "1.3000",
    "multiplierDown": "0.7000",
  }
PERCENT_PRICE_ORDER_SIZE

The PERCENT_PRICE_ORDER_SIZE filter is used to determine whether the execution of an order would cause the market price to fluctuate beyond the limit price, and if so, the order will be rejected.

In order to pass the percent_price_order_size, the following must be true:

  • A buy order needs to meet: the market price after the order get filled <askPrice * multiplierUp
  • A sell order needs to meet: the market price after the order get filled >bidPrice * multiplierDown

/exchangeInfo format:

  {
    "filterType": "PERCENT_PRICE_ORDER_SIZE",
    "multiplierUp": "1.3000",
    "multiplierDown": "0.7000"
  }
STATIC_PRICE_RANGE

The STATIC_PRICE_RANGE filter defines a static valid range for the price.

In order to pass the static_price_range, the following must be true for price:

  • price <= priceUp
  • price >= priceDown

/exchangeInfo format:

  {
    "filterType": "STATIC_PRICE_RANGE",
    "priceUp": "520",
    "priceDown": "160"
  }
LOT_SIZE

The LOT_SIZE filter defines the quantity (aka “lots” in auction terms) rules for a symbol. There are 3 parts:

  • minQty defines the minimum quantity allowed.
  • maxQty defines the maximum quantity allowed.
  • stepSize defines the intervals that a quantitycan be increased/decreased by.

In order to pass the lot size, the following must be true for quantity:

  • quantity >= minQty
  • quantity <= maxQty
  • (quantity-minQty) % stepSize == 0

/exchangeInfo format:

  {
    "filterType": "LOT_SIZE",
    "minQty": "0.00100000",
    "maxQty": "99999999.00000000",
    "stepSize": "0.00100000"
  }
NOTIONAL

The NOTIONAL filter defines the acceptable notional range allowed for an order on a symbol.

In order to pass this filter, the notional (price * quantity) has to pass the following conditions:

  • price * quantity <= maxNotional
  • price * quantity >= minNotional

/exchangeInfo format:

{
   "filterType": "NOTIONAL",
   "minNotional": "10.00000000",
   "maxNotional": "10000.00000000"
}
MAX_NUM_ORDERS

The MAX_NUM_ORDERS filter defines the maximum number of orders an account is allowed to have open on a symbol. Note that both triggered “algo” orders and normal orders are counted for this filter.

/exchangeInfo format:

  {
    "filterType": "MAX_NUM_ORDERS",
    "maxNumOrders": 200
  }
MAX_NUM_ALGO_ORDERS

The MAX_ALGO_ORDERS filter defines the maximum number of untriggered “algo” orders an account is allowed to have open on a symbol. “Algo” orders are STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.

/exchangeInfo format:

  {
    "filterType": "MAX_NUM_ALGO_ORDERS",
    "maxNumAlgoOrders": 5
  }

Exchange Filters

None for now

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"
}

Exchange information

GET /openapi/v1/exchangeInfo

Current exchange trading rules and symbol information

Weight: 1

Parameters:

NameTypeMandatoryDescription
symbolSTRINGNOSpecify a trading pair, for example symbol=ETHBTC
symbolsSTRINGNOx-Specify multiple trading pairs, such as symbol=%5B”ETHBTC”,”BTCUSDT”%5D, note that %5B represents ‘[’ left bracket, %5D represents ‘]’ right bracket. Direct use of the format [“ETHBTC”,”BTCUSDT”] is not supported as it is not RFC 3986 compliant.

Response:

{
  "timezone": "UTC",
  "serverTime": 1538323200000,
  "exchangeFilters": [],
  "symbols": [
    {
      "symbol": "ETHBTC",
      "status": "TRADING",
      "baseAsset": "ETH",
      "baseAssetPrecision": 8,
      "quoteAsset": "BTC",
      "quoteAssetPrecision": 8,
      "orderTypes": [
        "LIMIT",
        "MARKET",
        "LIMIT_MAKER",
        "STOP_LOSS_LIMIT",
        "STOP_LOSS",
        "TAKE_PROFIT_LIMIT",
        "TAKE_PROFIT"
      ],
      "filters": [
        {
          "filterType": "PRICE_FILTER",
          "minPrice": "0.00000100",
          "maxPrice": "100000.00000000",
          "tickSize": "0.00000100"
        },
        {
          "filterType": "LOT_SIZE",
          "minQty": "0.00100000",
          "maxQty": "100000.00000000",
          "stepSize": "0.00100000"
        },
        {
          "filterType": "NOTIONAL",
          "minNotional": "0.00100000"
        },
        {
          "filterType": "MIN_NOTIONAL",
          "minNotional": "0.00100000"
        },
        {
          "filterType": "MAX_NUM_ORDERS",
          "maxNumOrders": 200
        },
        {
          "filterType": "MAX_NUM_ALGO_ORDERS",
          "maxNumAlgoOrders": 5
        }
      ]
    }
  ]
}

Wallet endpoints

All Coins’ Information (USER_DATA)

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

Get information of coins (available for deposit and withdraw) for user.

Weight(IP): 10

Parameters:

NameTypeMandatoryDescription
recvWindowLONGNO 
timestampLONGYES 

Response:

[
    {
        "coin": "ETH",
        "name": "ETH",
        "depositAllEnable": true,
        "withdrawAllEnable": true,
        "free": "1.9144",
        "locked": "0.0426",
        "networkList": [
            {
                "addressRegex": "0x([0-9a-fA-F]){40}",
                "memoRegex": "^[0-9A-Za-z\\-_]{1,120}$",
                "network": "ETH",
                "name": "ERC20",
                "depositEnable": true,
                "minConfirm": 8,
                "unLockConfirm": 12,
                "withdrawDesc": "1234567890",
                "withdrawEnable": true,
                "withdrawFee": "0",
                "withdrawIntegerMultiple": "0.00000001",
                "withdrawMax": "1",
                "withdrawMin": "0.001",
                "sameAddress": false
            }
        ],
        "legalMoney": false
    }
  ]

Deposit Address (USER_DATA)

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

Fetch deposit address with network.

Weight(IP): 10

Parameters:

NameTypeMandatoryDescription
coinSTRINGYES 
networkSTRINGYES 
recvWindowLONGNO 
timestampLONGYES 

Response:

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

Withdraw(USER_DATA)

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

Submit a withdraw request.

Weight(UID): 100

Parameters:

NameTypeMandatoryDescription
coinSTRINGYES 
networkSTRINGYES 
addressSTRINGYES 
addressTagSTRINGNOSecondary address identifier for coins like XRP,XMR etc.
amountDECIMALYES 
withdrawOrderIdSTRINGNOclient id for withdraw, length is limited to 64.
recvWindowLONGNO 
timestampLONGYES 
  • Please notice coin/network/address/addressTag combination MUST be in withdraw address whitelist, it is needed to setup the withdraw address whitelist before doing 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:

NameTypeMandatoryDescription
coinSTRINGNO 
txIdSTRINGNO 
statusINTNO0-PROCESSING, 1-SUCCESS, 2-FAILED, 3-NEED_FILL_DATA(travel rule info)
startTimeLONGNODefault: 90 days from current timestamp
endTimeLONGNODefault: present timestamp
offsetINTNODefault:0
limitLONGNODefault:1000, Max:1000
recvWindowLONGNO 
timestampLONGYES 
  • Please notice the default startTime and endTime to make sure that 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": "BNB",
        "network": "BNB",
        "status": 0,
        "address": "bnb136ns6lfw4zs5hg4n85vdthaad7hq5m4gtkgf23",
        "addressTag": "101764890",
        "txId": "98A3EA560C6B3336D348B6C83F0F95ECE4F1F5919E94BD006E5BF3BF264FACFC",
        "insertTime": 1661493146000,
        "confirmNo": 10,
    },
    {
        "id": "d_769754833590042625",
        "amount":"0.5",
        "coin":"IOTA",
        "network":"IOTA",
        "status":1,
        "address":"SIZ9VLMHWATXKV99LH99CIGFJFUMLEHGWVZVNNZXRJJVWBPHYWPPBOSDORZ9EQSHCZAMPVAPGFYQAUUV9DROOXJLNW",
        "addressTag":"",
        "txId":"ESBFVQUTPIWQNJSPXFNHNYHSQNTGKRVKPRABQWTAXCDWOAKDKYWPTVG9BGXNVNKTLEJGESAVXIKIZ9999",
        "insertTime":1599620082000,
        "confirmNo": 20,
    }
]

Withdraw History (USER_DATA)

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

Fetch withdraw history.

Weight(IP): 2

Parameters:

NameTypeMandatoryDescription
coinSTRINGNO 
withdrawOrderIdSTRINGNO 
statusINTNO0-PROCESSING, 1-SUCCESS, 2-FAILED
startTimeLONGNODefault: 90 days from current timestamp
endTimeLONGNODefault: present timestamp
offsetINTNODefault:0
limitLONGNODefault:1000, Max:1000
recvWindowLONGNO 
timestampLONGYES 
  • Please notice the default startTime and endTime to make sure that 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, startTime and endTime are not sent, will return last 7 days records by default.

Response:

[
    {
        "id": "459890698271244288",
        "amount": "0.01",
        "transactionFee": "0",
        "coin": "ETH",
        "status": 1,
        "address": "0x386AE30AE2dA293987B5d51ddD03AEb70b21001F",
        "addressTag": "",
        "txId": "0x4ae2fed36a90aada978fc31c38488e8b60d7435cfe0b4daed842456b4771fcf7",
        "applyTime": 1673601139000,
        "network": "ETH",
        "withdrawOrderId": "thomas123",
        "info": "",
        "confirmNo": 100
    },
    {
        "id": "451899190746456064",
        "amount": "0.00063",
        "transactionFee": "0.00037",
        "coin": "ETH",
        "status": 1,
        "address": "0x386AE30AE2dA293987B5d51ddD03AEb70b21001F",
        "addressTag": "",
        "txId": "0x62690ca4f9d6a8868c258e2ce613805af614d9354dda7b39779c57b2e4da0260",
        "applyTime": 1671695815000,
        "network": "ETH",
        "withdrawOrderId": "",
        "info": "",
        "confirmNo": 100
    }
]

Market Data endpoints

Order book

GET /openapi/quote/v1/depth

Weight:

Adjusted based on the limit:

LimitWeight
5, 10, 20, 50, 1001
2005

Parameters:

NameTypeMandatoryDescription
symbolSTRINGYES 
limitINTNODefault 100; max 200.

Caution: setting limit=0 can return 200 records.

Response:

[PRICE, QTY]

{
  "lastUpdateId": 1027024,
  "bids": [
    [
      "4.90000000",   // PRICE
      "331.00000000"  // QTY
    ],
    [
      "4.00000000",
      "431.00000000"
    ]
  ],
  "asks": [
    [
      "4.00000200",  // PRICE
      "12.00000000"  // QTY
    ],
    [
      "5.10000000",
      "28.00000000"
    ]
  ]
}

Recent trades list

GET /openapi/quote/v1/trades

Get recent trades (up to last 60).

Weight: 1

Parameters:

NameTypeMandatoryDescription
symbolSTRINGYESEXP: BTCUSDT
limitINTNODefault 500; max 1000. if limit <=0 or > 1000 then return 1000

Response:

[
  {
    "id": 28457,
    "price": "4.00000100",
    "qty": "12.00000000",
    "quoteQty": "48.000012",
    "time": 1499865549590,
    "isBuyerMaker": true,
    "isBestMatch": true
  }
]

Kline/Candlestick data

GET /openapi/quote/v1/klines

Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.

Weight: 1

Parameters:

NameTypeMandatoryDescription
symbolSTRINGYESEXP: BTCUSDT
intervalENUMYES 
startTimeLONGNO 
endTimeLONGNO 
limitINTNODefault 500; max 1000.
  • If startTime and endTime are not sent, the most recent klines are returned.

Response:

[
  [
    1499040000000,      // Open time
    "0.01634790",       // Open
    "0.80000000",       // High
    "0.01575800",       // Low
    "0.01577100",       // Close
    "148976.11427815",  // Volume
    1499644799999,      // Close time
    "2434.19055334",    // Quote asset volume
    308,                // Number of trades
    "1756.87402397",    // Taker buy base asset volume
    "28.46694368"       // Taker buy quote asset volume
  ]
]

Current average price

GET /openapi/quote/v1/avgPrice

Current average price for a symbol.

Weight: 1

Parameters:

NameTypeMandatoryDescription
symbolSTRINGYESsymbol is not case sensitive, e.g. BTCUSDT or btcusdt

Response:

{
  "mins": 5,
  "price": "9.35751834"
}

24hr ticker price change statistics

GET /openapi/quote/v1/ticker/24hr

24 hour price change statistics. Careful when accessing this with no symbol.

Weight:

ParameterSymbols ProvidedWeight
symbol11
 symbol parameter is omitted40
symbols1-201
 21-10020
 101 or more40
 symbol parameter is omitted40

Parameters:

NameTypeMandatoryDescription
symbolSTRINGNOExample: BTCUSDT
symbolsSTRINGNO 
  • Parameter symbol and symbols cannot be used in combination.If neither parameter is sent, tickers for all symbols will be returned in an array.Examples of accepted format for the symbols parameter: [“BTCUSDT”,”BNBUSDT”] and not case sensitive

Response:

{
  "symbol": "BNBBTC",
  "priceChange": "-94.99999800",
  "priceChangePercent": "-95.960",
  "weightedAvgPrice": "0.29628482",
  "prevClosePrice": "0.10002000",
  "lastPrice": "4.00000200",
  "lastQty": "200.00000000",
  "bidPrice": "4.00000000",
  "bidQty": "100.00000000",
  "askPrice": "4.00000200",
  "askQty": "100.00000000",
  "openPrice": "99.00000000",
  "highPrice": "100.00000000",
  "lowPrice": "0.10000000",
  "volume": "8913.30000000",
  "quoteVolume": "15.30000000",
  "openTime": 1499783499040,
  "closeTime": 1499869899040,
  "firstId": 28385,   // first trade id
  "lastId": 28460,    // Last tradeId
  "count": 76         // Trade count
}

OR

[
  {
    "symbol": "BNBBTC",
    "priceChange": "-94.99999800",
    "priceChangePercent": "-95.960",
    "weightedAvgPrice": "0.29628482",
    "prevClosePrice": "0.10002000",
    "lastPrice": "4.00000200",
    "lastQty": "200.00000000",
    "bidPrice": "4.00000000",
    "bidQty": "100.00000000",
    "askPrice": "4.00000200",
    "askQty": "100.00000000",
    "openPrice": "99.00000000",
    "highPrice": "100.00000000",
    "lowPrice": "0.10000000",
    "volume": "8913.30000000",
    "quoteVolume": "15.30000000",
    "openTime": 1499783499040,
    "closeTime": 1499869899040,
    "firstId": 28385,   // First tradeId
    "lastId": 28460,    // Last tradeId
    "count": 76         // Trade count
  }
]

Symbol price ticker

GET /openapi/quote/v1/ticker/price

Latest price for a symbol or symbols.

Weight:

ParameterSymbols ProvidedWeight
symbol11
 symbol parameter is omitted2
symbolsAny2

Parameters:

NameTypeMandatoryDescription
symbolSTRINGNOExample: BTCUSDT
symbolsSTRINGNO 
  • Parameter symbol and symbols cannot be used in combination.If neither parameter is sent, prices for all symbols will be returned in an array.Examples of accepted format for the symbols parameter: [“BTCUSDT”,”BNBUSDT”] and not case sensitive

Response:

{
  "symbol": "LTCBTC",
  "price": "4.00000200"
}

OR

[
  {
    "symbol": "LTCBTC",
    "price": "4.00000200"
  },
  {
    "symbol": "ETHBTC",
    "price": "0.07946600"
  }
]

Symbol order book ticker

GET /openapi/quote/v1/ticker/bookTicker

Best price/qty on the order book for a symbol or symbols.

Weight:

ParameterSymbols ProvidedWeight
symbol11
 symbol parameter is omitted2
symbolsAny2

Parameters:

NameTypeMandatoryDescription
symbolSTRINGNO 
symbolsSTRINGNO 
  • Parameter symbol and symbols cannot be used in combination.If neither parameter is sent, bookTickers for all symbols will be returned in an array.Examples of accepted format for the symbols parameter: [“BTCUSDT”,”BNBUSDT”] and not case sensitive

Response:

{
  "symbol": "LTCBTC",
  "bidPrice": "4.00000000",
  "bidQty": "431.00000000",
  "askPrice": "4.00000200",
  "askQty": "9.00000000"
}

OR

[
  {
    "symbol": "LTCBTC",
    "bidPrice": "4.00000000",
    "bidQty": "431.00000000",
    "askPrice": "4.00000200",
    "askQty": "9.00000000"
  },
  {
    "symbol": "ETHBTC",
    "bidPrice": "0.07946700",
    "bidQty": "9.00000000",
    "askPrice": "100000.00000000",
    "askQty": "1000.00000000"
  }
]

Cryptoasset trading pairs

GET /openapi/v1/pairs

a summary on cryptoasset trading pairs available on the exchange

Weight: 1

Parameters:

None

Response:

[
  {
    "symbol": "LTCBTC",
    "quoteToken": "LTC",
    "baseToken": "BTC"
  },
  {
    "symbol": "BTCUSDT",
    "quoteToken": "BTC",
    "baseToken": "USDT"
  }
]

Spot Trading Endpoints

Test new order (TRADE)

POST /openapi/v1/order/test (HMAC SHA256)

Test new order creation and signature/recvWindow long. Creates and validates a new order but does not send it into the matching engine.

Weight: 1

Parameters:

Same as POST /openapi/v1/order

Response:

{}

New order (TRADE)

POST /openapi/v1/order  (HMAC SHA256)

Send in a new order.

Weight: 1

Parameters:

NameTypeMandatoryDescription
symbolSTRINGYES 
sideENUMYES 
typeENUMYES 
timeInForceENUMNO 
quantityDECIMALNO 
quoteOrderQtyDECIMALNO 
priceDECIMALNO 
newClientOrderIdSTRINGNOA unique id among open orders. Automatically generated if not sent. Orders with the same newClientOrderID can be accepted only when the previous one is filled, otherwise the order will be rejected.
stopPriceDECIMALNOUsed with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
newOrderRespTypeENUMNOSet the response JSON. ACK, RESULT, or FULL; MARKET and LIMIT order types default to FULL, all other orders default to ACK.
stpFlagENUMNOThe anti self-trading behaviour, Default anti self-dealing behaviour is CB
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Additional mandatory parameters based on type:

TypeAdditional mandatory parametersAdditional Information
LIMITquantity, price 
MARKETquantity or quoteOrderQtyMARKET orders using quantity field specifies the amount of the base asset the user wants to buy/sell, E.g. MARKET order on BCHUSDT will specify how much BCH the user is buying/selling.
MARKET orders using quoteOrderQty field specifies the amount of the quote asset the user wants to buy/sell, E.g. MARKET order on BCHUSDT will specify how much USDT the user is buying/selling.
STOP_LOSSquantity or quoteOrderQty, stopPriceThis will execute a MARKET order whenstopPrice is met. Use quantity for selling, quoteOrderQty for buying.
STOP_LOSS_LIMITquantity, price, stopPriceThis will execute a LIMIT order whenstopPrice is met.
TAKE_PROFITquantity or quoteOrderQty, stopPriceThis will execute a MARKET order whenstopPrice is met. Use quantity for selling, quoteOrderQty for buying.
TAKE_PROFIT_LIMITquantity, price, stopPriceThis will execute a LIMIT order whenstopPrice is met.
LIMIT_MAKERquantity, priceThis is a LIMIT order that will be rejected if the order immediately matches and trades as a taker.

Trigger order price rules against market price for both MARKET and LIMIT versions:

  • Price above market price: STOP_LOSS/STOP_LOSS_LIMIT BUY, TAKE_PROFIT/TAKE_PROFIT_LIMIT SELL
  • Price below market price: STOP_LOSS/STOP_LOSS_LIMIT SELL, TAKE_PROFIT/TAKE_PROFIT_LIMIT BUY

Response ACK:

{
  "symbol": "BCHUSDT",
  "orderId": 1202289462787244800,
  "clientOrderId": "165806007267756",
  "transactTime": 1656900365976
}

Response RESULT:

{
    "symbol": "BCHUSDT",
    "orderId": 1202289462787244800,
    "clientOrderId": "165806007267756",
    "transactTime": 1656900365976,
    "price": "1",
    "origQty": "101",
    "executedQty": "101",
    "cummulativeQuoteQty": "101",
    "status": "FILLED",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "SELL",
    "stopPrice": "0",
    "origQuoteOrderQty": "0"
}

Response FULL:

{
    "symbol": "BCHUSDT",
    "orderId": 1202289462787244800,
    "clientOrderId": "165806007267756",
    "transactTime": 1656900365976,
    "price": "1",
    "origQty": "101",
    "executedQty": "101",
    "cummulativeQuoteQty": "101",
    "status": "FILLED",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "SELL",
    "stopPrice": "0",
    "origQuoteOrderQty": "0"
    "fills": [
        {
            "price": "2",
            "qty": "100",
            "commission": "0.01",
            "commissionAsset": "USDT",
            "tradeId": "1205027741844507648"
        },
        {
            "price": "1",
            "qty": "1",
            "commission": "0.005",
            "commissionAsset": "USDT",
            "tradeId": "1205027331347975169"
        }
    ]
}

Query order (USER_DATA)

GET /openapi/v1/order (HMAC SHA256)

Check an order’s status.

Weight: 2

Parameters:

NameTypeMandatoryDescription
orderIdLONGNO 
origClientOrderIdSTRINGNO 
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Notes:

  • Either orderId or origClientOrderId must be sent. If both parameters are sent, orderId takes precedence.

Response:

{
  "symbol": "LTCBTC",
  "orderId": 1202289462787244800,
  "clientOrderId": "165806007267756",
  "price": "0.1",
  "origQty": "1",
  "executedQty": "0",
  "cummulativeQuoteQty": "0",
  "status": "NEW",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "side": "BUY",
  "stopPrice": "0",
  "time": 1499827319559,
  "updateTime": 1499827319559,
  "isWorking": true,
  "origQuoteOrderQty": "0"
}

Cancel order (TRADE)

DELETE /openapi/v1/order  (HMAC SHA256)

Cancel an active order.

Weight: 1

Parameters:

NameTypeMandatoryDescription
orderIdLONGNO 
origClientOrderIdSTRINGNO 
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Notes:

  • Either orderId or origClientOrderId must be sent. If both parameters are sent, orderId takes precedence.

Response:

{
  "symbol": "BCHBUSD",
  "orderId": 1205324142243592448,
  "clientOrderId": "165830718862761",
  "price": "2",
  "origQty": "10",
  "executedQty": "8",
  "cummulativeQuoteQty": "16",
  "status": "CANCELED",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "side": "SELL",
  "stopPrice": "0",
  "origQuoteOrderQty": "0"
}

Cancel All Open Orders on a Symbol (TRADE)

DELETE /openapi/v1/openOrders  (HMAC SHA256)

Cancels all active orders on a symbol.

Weight: 1

Parameters:

NameTypeMandatoryDescription
symbolSTRINGYES 
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Response:

[
    {
        "symbol": "BTCUSDT",
        "orderId": 1200757068661824000,
        "clientOrderId": "165787739706155",
        "price": "19999",
        "origQty": "0.01",
        "executedQty": "0",
        "cummulativeQuoteQty": "0",
        "status": "CANCELED",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "BUY",
        "stopPrice": "0",
        "origQuoteOrderQty": "0"
    },
    {
        "symbol": "BTCUSDT",
        "orderId": 1200760572449167872,
        "clientOrderId": "165787781474653",
        "price": "19999",
        "origQty": "0.01",
        "executedQty": "0",
        "cummulativeQuoteQty": "0",
        "status": "CANCELED",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "BUY",
        "stopPrice": "0",
        "origQuoteOrderQty": "0"
    },
    {
        "symbol": "BTCUSDT",
        "orderId": 1200760629206489600,
        "clientOrderId": "165787782151456",
        "price": "19999",
        "origQty": "0.01",
        "executedQty": "0",
        "cummulativeQuoteQty": "0",
        "status": "CANCELED",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "BUY",
        "stopPrice": "0",
        "origQuoteOrderQty": "0"
    }
]

Current open orders (USER_DATA)

GET /openapi/v1/openOrders  (HMAC SHA256)

GET all open orders on a symbol. Careful when accessing this with no symbol.

Weight: 10

Parameters:

NameTypeMandatoryDescription
symbolStringNO 
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Response:

[
    {
        "symbol": "BTCUSDT",
        "orderId": 1200757068661824000,
        "clientOrderId": "165787739706155",
        "price": "19999",
        "origQty": "0.01",
        "executedQty": "0",
        "cummulativeQuoteQty": "0",
        "status": "NEW",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "BUY",
        "stopPrice": "0",
        "time": 1657877397079,
        "updateTime": 1657877397092,
        "isWorking": true,
        "origQuoteOrderQty": "0"
    },
    {
        "symbol": "BTCUSDT",
        "orderId": 1200760572449167872,
        "clientOrderId": "165787781474653",
        "price": "19999",
        "origQty": "0.01",
        "executedQty": "0",
        "cummulativeQuoteQty": "0",
        "status": "NEW",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "BUY",
        "stopPrice": "0",
        "time": 1657877814763,
        "updateTime": 1657877814776,
        "isWorking": true,
        "origQuoteOrderQty": "0"
    },
    {
        "symbol": "BTCUSDT",
        "orderId": 1200760629206489600,
        "clientOrderId": "165787782151456",
        "price": "19999",
        "origQty": "0.01",
        "executedQty": "0",
        "cummulativeQuoteQty": "0",
        "status": "NEW",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "BUY",
        "stopPrice": "0",
        "time": 1657877821529,
        "updateTime": 1657877821542,
        "isWorking": true,
        "origQuoteOrderQty": "0"
    }
]

History orders (USER_DATA)

GET /openapi/v1/historyOrders (HMAC SHA256)

GET all orders of the account; canceled, filled or rejected.

Weight: 10 with symbol, 40 when the symbol parameter is omitted;

Parameters:

NameTypeMandatoryDescription
symbolStringYES 
orderIdLONGNO 
startTimeLONGNO 
endTimeLONGNO 
limitINTNODefault 500; max 1000.
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Notes:

  • If orderId is set, it will get orders >= that orderId. Otherwise most recent orders are returned.

Response:

[
    {
        "symbol": "BCHBUSD",
        "orderId": 1194453962386908672,
        "clientOrderId": "1657126007990",
        "price": "4.56",
        "origQty": "1",
        "executedQty": "1",
        "cummulativeQuoteQty": "4.56",
        "status": "FILLED",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "SELL",
        "stopPrice": "0",
        "time": 1657126008273,
        "updateTime": 1657126008357,
        "isWorking": false,
        "origQuoteOrderQty": "0"
    },
    {
        "symbol": "BCHBUSD",
        "orderId": 1194453774196830976,
        "clientOrderId": "165712598575253",
        "price": "0",
        "origQty": "0",
        "executedQty": "4",
        "cummulativeQuoteQty": "18",
        "status": "FILLED",
        "timeInForce": "GTC",
        "type": "MARKET",
        "side": "BUY",
        "stopPrice": "0",
        "time": 1657126008363,
        "updateTime": 1657126008402,
        "isWorking": false,
        "origQuoteOrderQty": "18"
    },
    {
        "symbol": "BCHBUSD",
        "orderId": 1194460299787314688,
        "clientOrderId": "1657126763487",
        "price": "0.46",
        "origQty": "1",
        "executedQty": "1",
        "cummulativeQuoteQty": "4.56",
        "status": "FILLED",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "SELL",
        "stopPrice": "0",
        "time": 1657126763736,
        "updateTime": 1657126763786,
        "isWorking": false,
        "origQuoteOrderQty": "0"
    }
]

Account information (USER_DATA)

GET /openapi/v1/account (HMAC SHA256)

GET current account information.

Weight: 10

Parameters:

NameTypeMandatoryDescription
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Response:

{
  "canTrade": true,       
  "canWithdraw": true,    
  "canDeposit": true,     
  "updateTime": 123456789,
  "accountType": "SPOT",
  "balances": [
    {
      "asset": "BTC",
      "free": "4723846.89208129",
      "locked": "0.00000000"
    },
    {
      "asset": "LTC",
      "free": "4763368.68006011",
      "locked": "0.00000000"
    }
  ],
  "token": "PHP",
   "daily": {
      "cashInLimit": "10000",
      "cashInRemaining": "10000",
      "cashOutLimit": "0",
      "cashOutRemaining": "0",
      "totalWithdrawLimit": "0",
      "totalWithdrawRemaining": "0"
   },
   "monthly": {
      "cashInLimit": "10000",
      "cashInRemaining": "10000",
      "cashOutLimit": "0",
      "cashOutRemaining": "0",
      "totalWithdrawLimit": "0",
      "totalWithdrawRemaining": "0"
   },
   "annually": {
      "cashInLimit": "10000",
      "cashInRemaining": "10000",
      "cashOutLimit": "0",
      "cashOutRemaining": "0",
      "totalWithdrawLimit": "0",
      "totalWithdrawRemaining": "0"
   }
}

Account trade list (USER_DATA)

GET /openapi/v1/myTrades  (HMAC SHA256)

Get trades for a specific account and symbol.

Weight: 10

Parameters:

NameTypeMandatoryDescription
symbolSTRINGYES 
orderIdLONGNOThis can only be used in combination with symbol.
startTimeLONGNO 
endTimeLONGNO 
fromIdLONGNOTradeId to fetch from. Default gets most recent trades.
limitINTNODefault 500; max 1000.
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Notes:

  • If fromId (tradeId) is set, it will get id (tradeId) >= that fromId (tradeId). Otherwise most recent trades are returned.

Response:

[
  {
    "symbol": "BNBBTC",
    "id": 1194460299787317856,
    "orderId": 1194453774196830977,
    "price": "4.00000100",
    "qty": "12.00000000",
    "quoteQty": "48.000012",
    "commission": "10.10000000",
    "commissionAsset": "BNB",
    "time": 1499865549590,
    "isBuyer": true,
    "isMaker": false,
    "isBestMatch": true
  }
]

Trade Fee (USER_DATA)

GET /openapi/v1/asset/tradeFee (HMAC SHA256)

Fetch trade fee

Weight: 1

Parameters:

NameTypeMandatoryDescription
symbolSTRINGNO 
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Response:

  [
    {
      "symbol": "BTCUSDT",
      "makerCommission": "0.002",
      "takerCommission": "0.003"
    },
    {
      "symbol": "ETHUSDT",
      "makerCommission": "0.001",
      "takerCommission": "0.001"
    }
  ]

Payment request (USER_DATA)

POST /openapi/v3/payment-request/payment-requests (HMAC SHA256)

Initiate a new payment transaction by creating a payment request. Weight: 1

Parameters:

NameTypeMandatoryDescription
payer_contact_infoSTRINGYESThe contact information, typically an email address, to which the payment request should be sent.
receiving_accountSTRINGYESEither the token (e.g. PHP, BTC, ETH) or the Balance ID (e.g. 1447779051242545455) to be transferred.
amountDECIMALYESThe requested amount to be transferred to the requestor’s receiving_account.
messageLONGYESAn arbitrary message that will be attached to the payment request.
supported_payment_collectorsSTRINGNOMethods of payment that are available to a user when they view a payment request (e.g., [“coins_peso_wallet”])
expires_atSTRINGNOThe expiration date of the payment request. Expected to be in ISO 8601 datetime format (e.g., 2016-10-20T13:00:00.000000Z) or a time delta from the current time (e.g., 1w 3d 2h 32m 5s). The default expiration period is set to 7 days.
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Response:

{
    "payment-request": {
        "message": "i am boss",
        "id": "1433341829953096704",
        "invoice": "1433341829953096704",
        "amount": "20",
        "currency": "PHP",
        "status": "pending",
        "created_at": 1685603661217,
        "updated_at": 1685603661217,
        "expires_at": 1686208461219,
        "supported_payment_collectors": "[\"coins_peso_wallet\"]",
        "payment_url": "https://www.pro.coins.ph/payment/invoice/1433341829953096704",
        "payer_contact_info": "jennins@coins.ph"
    }
}

Get payment request

GET /openapi/v3/payment-request/get-payment-request (HMAC SHA256)

Retrieve either a single existing payment request or a list of existing payment requests.

Weight: 1

Parameters:

NameTypeMandatoryDescription
idSTRINGNOThe ID of a specific payment request to retrieve.
start_timeLONGNOThe start time of a time range within which to search for payment requests.
end_timeLONGNOThe end time of a time range within which to search for payment requests.
limitINTNOThe maximum number of records to return in a single response. The default value is 500, and the maximum allowed value is 1000.
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Response:

{
    "payment-request": {
        "message": "i am boss",
        "id": "1433341829953096704",
        "invoice": "1433341829953096704",
        "amount": "20",
        "currency": "PHP",
        "status": "pending",
        "created_at": 1685603661217,
        "updated_at": 1685603661217,
        "expires_at": 1686208461219,
        "supported_payment_collectors": "[\"coins_peso_wallet\"]",
        "payment_url": "https://www.pro.coins.ph/payment/invoice/1433341829953096704",
        "payer_contact_info": "jennins@coins.ph"
    }
}

Cancel payment request

POST /openapi/v3/payment-request/delete-payment-request (HMAC SHA256)

Cancel an existing payment request.

Weight: 1

Parameters:

NameTypeMandatoryDescription
idSTRINGYESThe ID the payment request that needs to be canceled.
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Response:

{
    "payment-request": {
        "message": "i am boss",
        "id": "1433341829953096704",
        "invoice": "1433341829953096704",
        "amount": "20",
        "currency": "PHP",
        "status": "pending",
        "created_at": 1685603661217,
        "updated_at": 1685603661217,
        "expires_at": 1686208461219,
        "supported_payment_collectors": "[\"coins_peso_wallet\"]",
        "payment_url": "https://www.pro.coins.ph/payment/invoice/1433341829953096704",
        "payer_contact_info": "jennins@coins.ph"
    }
}

Send reminder for payment request

POST /openapi/v3/payment-request/payment-request-reminder (HMAC SHA256)

Send a reminder to the recipient to fulfill the payment request.

Weight: 1

Parameters:

NameTypeMandatoryDescription
idSTRINGYESThe ID of the payment request for which the reminder notification needs to be sent.
recvWindowLONGNOThe value cannot be greater than 60000
timestampLONGYES 

Response:

true

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:

NameTypeMandatoryDescription
listenKeySTRINGYES 

Response:

{}

Close user data stream (USER_STREAM)

DELETE /openapi/v1/userDataStream

Close out a user data stream.

Weight: 1

Parameters:

NameTypeMandatoryDescription
listenKeySTRINGYES 

Response:

{}

Merchant Endpoints

Signature

Common Headers

The table below shows all of the common API Headers you will encounter in the Coins API.

Header NameRequiredTypeExampleDescription
X-Merchant-KeyYESSTRING The authorized merchant key
X-Merchant-SignYESSTRING The authorized merchant request sign
X-TimestampYESLONG1671158910Request initiation time
X-Trace-IdNOSTRING Request log trace ID

To craft an X-Merchant-Sign:

  1. Construct a message according to the following pseudo-grammar: ‘X-Timestamp’ +URL(http://127.0.0.1/merchant-api/account?paramKey=paramValue&paramKey2=paramValue2) + BODY(key1=value1&key=value2)
  2. Calculate an HMAC with the message string you just created, your API secret as the key, and SHA256 as the hash algorithm

Invoicing

An invoice is a document that outlines the details of a transaction between two parties, typically a seller and a buyer. The transaction could be for goods or services rendered, or it could be a transfer of funds from one user to another.

In an invoice, there are two main entities involved:

1) The payee, who is the recipient of the payment for the goods or services provided (the merchant). 2) The payer, who is the individual or organization making the payment to fulfill the invoice (the customer).

The API endpoints described in this section allow you to integrate invoicing functionality into your application. Creating, sending, and managing invoices directly from the application simplifies the invoicing process and improves the user experience.

Creating Invoices

POST /merchant-api/v1/invoices (HMAC SHA256)

This endpoint generates an invoice based on the provided parameters and returns a response with details of the created invoice.

Weight: 1

Parameters:

NameTypeMandatoryDescription
amountDECIMALYESThe amount expected from the customer.
currencySTRINGYESCurrency of transaction.
supported_payment_collectorsSTRINGYESMethods of payment that are available to a user when they view a payment request, e.g., [“coins_peso_wallet”]
external_transaction_idSTRINGYESTo maintain transactional integrity, each transaction_id must be unique.
expires_atSTRINGNOThe date and time at which the invoice will expire. This parameter accepts input in the ISO 8601 format for date and time, which is based on the Coordinated Universal Time (UTC) time zone (e.g., “2016-10-20T13:00:00.000000Z”). Alternatively, you can provide a time delta from the current time (e.g., “1w 3d 2h 32m 5s”).

Payment Options

CodeDescription
coins_peso_walletPay with the user’s Peso Coins wallet.

Request:

{
    "amount": 100,
    "currency": "PHP",
    "supported_payment_collectors": "["coins_peso_wallet"]",
    "external_transaction_id": "1",
    "expires_at": "1w"
}

Response:

{
    "invoice": {
        "id": "",
        "amount": "",
        "amount_due": "",
        "currency": "",
        "status": "",
        "external_transaction_id": "",
        "created_at": 0,
        "updated_at": 0,
        "expires_at": 0,
        "supported_payment_collectors": "",
        "payment_url": "",
        "expires_in_seconds": 0,
        "incoming_address":""
    }
}

Retrieving Invoices

GET /merchant-api/v1/get-invoices (HMAC SHA256)

This endpoint retrieves information about a specific invoice.

Weight: 1

Parameters:

NameTypeMandatoryDescription
invoice_idSTRINGNOThe ID of a specific invoice to retrieve.
start_timeLONGNOThe start time of a time range within which to search for invoices.
end_timeLONGNOThe end time of a time range within which to search for invoices.
limitINTNOThe maximum number of records to return in a single response. The default value is 500, and the maximum allowed value is 1000.

If the invoice_id parameter is provided, only the data for the specified invoice will be returned. If the start_time and end_time parameters are not provided, the response will include the records within the last 90 days by default. Developers can provide a specific time range by setting the time parameter to a value that specifies the start and end times of the desired range.

Response:

{
    "invoice": [{
        "id": "",
        "amount": "",
        "amount_due": "",
        "currency": "",
        "status": "",
        "external_transaction_id": "",
        "created_at": 0,
        "updated_at": 0,
        "expires_at": 0,
        "supported_payment_collectors": "",
        "payment_url": "",
        "expires_in_seconds": 0,
        "incoming_address":""
    }]
}

Canceling Invoices

POST /merchant-api/v1/invoices-cancel (HMAC SHA256)

This endpoint cancels an existing invoice.

Weight: 1

Parameters:

NameTypeMandatoryDescription
invoice_idSTRINGYESThe ID of a specific invoice to cancel.

Response:

{
    "invoice": {
        "id": "",
        "amount": "",
        "amount_due": "",
        "currency": "",
        "status": "",
        "external_transaction_id": "",
        "created_at": 0,
        "updated_at": 0,
        "expires_at": 0,
        "supported_payment_collectors": "",
        "payment_url": "",
        "expires_in_seconds": 0,
        "incoming_address":""
    }
}

Invoice Callbacks

During the lifecycle of an invoice, various events may occur. For example, when an invoice is fully paid, the invoice.fully_paid event is triggered. These events can be tracked and acted upon using the Coins API’s event system.

Merchants can specify a callback URL when creating or updating an invoice, which is a web address that the API will send event data to. When an event occurs, the API will send a POST request to the specified callback_URL, containing data about the event. The merchant can then process this data as needed, such as by updating their internal systems or notifying the customer.

To ensure that the events are delivered securely, merchants must include an authorization header with their Merchant API key in each POST request. This header, with the format Authorization: Token MERCHANT_APIKEY, confirms that the request is coming from a trusted source and provides an additional layer of security for the event data.

Event payloads follow this convention:

{
  "event": {
    "name": "invoice.name",
    "data": {
        "id": "invoice_id",
        "currency": "PHP",
        "amount": "100",
        "amount_received": "0",
        "external_transaction_id": "1"
        }
    }
}

Events which may be consumed by callbacks are described in the table below:

Event NameDescription
invoice.createdThe invoice has been created.
invoice.updatedThe invoice has been updated. This may be due to the payment received for the invoice.
invoice.fully_paidThe invoice payment has been completed.
invoice.payment_reference_number_generatedThe invoice payment reference number has been generated.

Convert endpoints

Get supported trading pairs

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

This continuously updated endpoint returns a list of all available trading pairs. The response includes information on the minimum and maximum amounts that can be traded for the source currency, as well as the level of precision in decimal places used for the source currency.

Weight: 1

Parameters:

N/A

Response:

{
  "status":"Success",
  "error":"OK",
  "data":[
     {
      "sourceCurrency":"PHP",
      "targetCurrency":"BTC",
      "minSourceAmount":"1000",
      "maxSourceAmount":"15000",
      "precision":"2"
    },
    {
      "sourceCurrency":"BTC",
      "targetCurrency":"PHP",
      "minSourceAmount":"0.0001",
      "maxSourceAmount":"0.1",
      "precision":"8"
    },
    {
      "sourceCurrency":"PHP",
      "targetCurrency":"ETH",
      "minSourceAmount":"1000",
      "maxSourceAmount":"18000",
      "precision":"2"
    },
    {
      "sourceCurrency":"ETH",
      "targetCurrency":"PHP",
      "minSourceAmount":"0.003",
      "maxSourceAmount":"4.2",
      "precision":"8"
    }
  ]
}

Fetch a quote

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:

NameTypeMandatoryDescription
sourceCurrencySTRINGYESThe currency the user holds
targetCurrencySTRINGYESThe currency the user would like to obtain
sourceAmountSTRINGNOThe amount of sourceCurrency. You only need to fill in either the source amount or the target amount. If both are filled, it will result in an error.
targetAmountSTRINGNOThe amount of targetCurrency. You only need to fill in either the source amount or the target amount. If both are filled, it will result in an error.

Response:

{
  "status": 0, 
  "error": "OK", 
  "data": {
            "quoteId": "2182b4fc18ff4556a18332245dba75ea",
            "sourceCurrency": "BTC",
            "targetCurrency": "PHP",
            "sourceAmount": "0.1",
            "price": "59999",             //1BTC=59999PHP
            "targetAmount": "5999",       //The amount of PHP the user holds
            "expiry": "10"
  }
}

Accept the quote

POST /openapi/convert/v1/accept-quote

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

Weight: 1

Parameters:

NameTypeMandatoryDescription
quoteIdSTRINGYESThe ID assigned to the quote

Response:

{
  "status": 0, 
  "data": {
         "orderId" : "49d10b74c60a475298c6bbed08dd58fa",
         "status": "SUCCESS"
  },
  "error": "ok"
}

Retrieve order history

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:

NameTypeMandatoryDescription
startTimeSTRINGNoNumeric string representing milliseconds. The starting point of the required period. If no period is defined, the entire order history is returned.
endTimeSTRINGNoNumeric string representing milliseconds. The end point of the required period. If no period is defined, the entire order history is returned.
statusSTRINGNodeliveryStatus, If this field is available, use it with startTime. TODO, SUCCESS, FAILED, PROCESSING
pageintNo 
sizeintNo 

Response:

{
  "status": 0,
   "error": "OK",
   "data": [
    {
      "id":"",
      "orderId": "25a9b92bcd4d4b2598c8be97bc65b466",
      "quoteId": "1ecce9a7265a4a329cce80de46e2c583",
      "userId":"",
      "sourceCurrency": "BTC",
      "sourceCurrencyIcon":"",
      "targetCurrency": "PHP",
      "targetCurrencyIcon":"",
      "sourceAmount": "0.11",
      "targetAmount": "4466.89275956",
      "price": "40608.115996",
      "status": "SUCCESS",
      "createdAt": "1671797993000",
      "errorCode": "",
      "errorMessage": "",
      "inversePrice": "3306.115996"
    }
  ],
  "total": 23
}

Fiat endpoints

Get supported fiat channels

POST openapi/fiat/v1/support-channel

This continuously updated endpoint returns a list of all available fiat channels. Weight: 1

Parameters:

NameTypeMandatoryDescription
transactionTypeSTRINGYesSet this parameter to -1 to indicate a cash-out transaction. At present, only cash-out transactions are supported.
currencySTRINGYesThe parameter represents the currency used in the transaction and should be set to PHP as it is the only currency currently supported.
transactionChannelSTRINGNotransaction channel.
transactionSubjectSTRINGNoSubchannels under transactionChannel.
amountSTRINGNoIf not set, the default value is 0

Response:

{
  "status":0,
  "error":"OK",
  "data":
  [
    {
      "id": 782,
      "transactionChannel": "SWIFTPAY_PESONET",
      "transactionChannelName": "swiftpay_pesonet",
      "transactionSubject": "alamanah",
      "transactionSubjectType": "bank",
      "transactionSubjectTypeLabel": "Banks",
      "transactionSubjectName": "Al-Amanah Islamic Invest. Bank",
      "transactionType": -1,
      "paymentMethod": "BANK_TRANSFER",
      "channelIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/InstaPay+Pesonet+copy/PesoNet@136.png",
      "subjectIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/Al-Amanah+Islamic+Bank.png",
      "maximum": "100000000",
      "minimum": "5",
      "dailyLimit": "50",
      "monthlyLimit": "10000001",
      "annualLimit": "500000",
      "remainingDailyLimit": "50",
      "remainingMonthlyLimit": "10000001",
      "remainingAnnualLimit": "500000",
      "precision": "2",
      "fee": "5",
      "feeType": "fixed",
      "status": "1",
      "maxWithdrawBalance": "10000037084.37574788"
    },
    {
      "id": 622,
      "transactionChannel": "INSTAPAY",
      "transactionChannelName": "instapay",
      "transactionSubject": "allbank",
      "transactionSubjectType": "bank",
      "transactionSubjectTypeLabel": "Banks",
      "transactionSubjectName": "AllBank (A Thrift Bank), Inc.",
      "transactionType": -1,
      "paymentMethod": "BANK_TRANSFER",
      "channelIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/InstaPay+Pesonet+copy/InstaPay@136.png",
      "subjectIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/AllBank.png",
      "maximum": "50000",
      "minimum": "50",
      "dailyLimit": "100000",
      "monthlyLimit": "100000",
      "annualLimit": "1000000",
      "remainingDailyLimit": "100000",
      "remainingMonthlyLimit": "100000",
      "remainingAnnualLimit": "999656",
      "precision": "2",
      "fee": "10",
      "feeType": "fixed",
      "status": "1",
      "maxWithdrawBalance": "10000037084.37574788"
    },
    {
      "id": 783,
      "transactionChannel": "SWIFTPAY_PESONET",
      "transactionChannelName": "swiftpay_pesonet",
      "transactionSubject": "allbank",
      "transactionSubjectType": "bank",
      "transactionSubjectTypeLabel": "Banks",
      "transactionSubjectName": "AllBank (A Thrift Bank), Inc.",
      "transactionType": -1,
      "paymentMethod": "BANK_TRANSFER",
      "channelIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/InstaPay+Pesonet+copy/PesoNet@136.png",
      "subjectIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/AllBank.png",
      "maximum": "100000000",
      "minimum": "5",
      "dailyLimit": "50",
      "monthlyLimit": "10000001",
      "annualLimit": "500000",
      "remainingDailyLimit": "50",
      "remainingMonthlyLimit": "10000001",
      "remainingAnnualLimit": "500000",
      "precision": "2",
      "fee": "5",
      "feeType": "fixed",
      "status": "0",
      "maxWithdrawBalance": "10000037084.37574788"
    },
    {
      "id": 785,
      "transactionChannel": "SWIFTPAY_PESONET",
      "transactionChannelName": "swiftpay_pesonet",
      "transactionSubject": "anz",
      "transactionSubjectType": "bank",
      "transactionSubjectTypeLabel": "Banks",
      "transactionSubjectName": "ANZ Banking Group Ltd",
      "transactionType": -1,
      "paymentMethod": "BANK_TRANSFER",
      "channelIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/InstaPay+Pesonet+copy/PesoNet@136.png",
      "subjectIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/Australia+&+New+Zealand+Bank.png",
      "maximum": "100000000",
      "minimum": "5",
      "dailyLimit": "50",
      "monthlyLimit": "10000001",
      "annualLimit": "500000",
      "remainingDailyLimit": "50",
      "remainingMonthlyLimit": "10000001",
      "remainingAnnualLimit": "500000",
      "precision": "2",
      "fee": "5",
      "feeType": "fixed",
      "status": "1",
      "maxWithdrawBalance": "10000037084.37574788"
    },
    {
      "id": 647,
      "transactionChannel": "INSTAPAY",
      "transactionChannelName": "instapay",
      "transactionSubject": "guinobatan",
      "transactionSubjectType": "bank",
      "transactionSubjectTypeLabel": "Banks",
      "transactionSubjectName": "Asenso",
      "transactionType": -1,
      "paymentMethod": "BANK_TRANSFER",
      "channelIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/InstaPay+Pesonet+copy/InstaPay@136.png",
      "subjectIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/Asenso.png",
      "maximum": "50000",
      "minimum": "50",
      "dailyLimit": "100000",
      "monthlyLimit": "100000",
      "annualLimit": "1000000",
      "remainingDailyLimit": "100000",
      "remainingMonthlyLimit": "100000",
      "remainingAnnualLimit": "999656",
      "precision": "2",
      "fee": "10",
      "feeType": "fixed",
      "status": "1",
      "maxWithdrawBalance": "10000037084.37574788"
    },
    {
      "id": 837,
      "transactionChannel": "SWIFTPAY_PESONET",
      "transactionChannelName": "swiftpay_pesonet",
      "transactionSubject": "guinobatan",
      "transactionSubjectType": "bank",
      "transactionSubjectTypeLabel": "Banks",
      "transactionSubjectName": "Asenso",
      "transactionType": -1,
      "paymentMethod": "BANK_TRANSFER",
      "channelIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/InstaPay+Pesonet+copy/PesoNet@136.png",
      "subjectIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/Asenso.png",
      "maximum": "100000000",
      "minimum": "5",
      "dailyLimit": "50",
      "monthlyLimit": "10000001",
      "annualLimit": "500000",
      "remainingDailyLimit": "50",
      "remainingMonthlyLimit": "10000001",
      "remainingAnnualLimit": "500000",
      "precision": "2",
      "fee": "5",
      "feeType": "fixed",
      "status": "1",
      "maxWithdrawBalance": "10000037084.37574788"
    },
    {
      "id": 623,
      "transactionChannel": "INSTAPAY",
      "transactionChannelName": "instapay",
      "transactionSubject": "aub",
      "transactionSubjectType": "e-wallet",
      "transactionSubjectTypeLabel": "E-wallets",
      "transactionSubjectName": "Asia United Bank",
      "transactionType": -1,
      "paymentMethod": "BANK_TRANSFER",
      "channelIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/InstaPay+Pesonet+copy/InstaPay@136.png",
      "subjectIcon": "https://static.pro.coins.xyz/resource/images/fiat/fiat-png/AUB.png",
      "maximum": "50000",
      "minimum": "50",
      "dailyLimit": "100000",
      "monthlyLimit": "100000",
      "annualLimit": "1000000",
      "remainingDailyLimit": "100000",
      "remainingMonthlyLimit": "100000",
      "remainingAnnualLimit": "999656",
      "precision": "2",
      "fee": "10",
      "feeType": "fixed",
      "status": "1",
      "maxWithdrawBalance": "10000037084.37574788"
    }
  ]
}

Cash out

POST openapi/fiat/v1/cash-out

This endpoint allows users to withdraw funds from their fiat account.

Weight: 1

Parameters:

NameTypeMandatoryDescription
internalOrderIdSTRINGYesInternal ID assigned to the funds withdrawal order, all are numbers and not start with 0,Length is 10 to 20
currencySTRINGYesThe parameter represents the currency used in the transaction and should be set to PHP as it is the only currency currently supported.
amountSTRINGYesThe amount of currency to be withdrawn.
channelNameSTRINGYesThe payment channel or method that the user wishes to use for the cash-out transaction.
channelSubjectSTRINGYesAdditional information about the payment channel or method that the user wishes to use for the cash-out transaction.
extendInfoJSON ObjectNoA JSON object with additional information. Its structure and content may vary depending on the specific channel(Refer to demo below). The fields within the JSON object are: recipientName, recipientAccountNumber, recipientAddress, remarks, recipientFirstName,recipientMiddleName,recipientLastName,recipientBirthDate,recipientNationality,recipientStreetAddress,recipientStreet2Address,recipientCityAddress,recipientProvinceAddress,recipientCountryAddress,recipientBarangayAddress,recipientEmail,recipientMobile.

Request:

  • SWIFTPAY_OTC
    {
    "amount": "1000",
    "internalOrderId":"2023090410571114",
    "currency":"PHP",
    "channelName": "SWIFTPAY_OTC",
    "channelSubject":"MLH",
    "extendInfo":{
      "recipientProvinceAddress": "South Cotabato",
      "recipientLastName": "Fajagut",
      "recipientMiddleName": "Pal",
      "recipientFirstName": "Joseph",
      "recipientCityAddress": "Santo",
      "remarks": "OTC Cash out",
      "recipientBirthDate": "1974-06-19",
      "recipientStreetAddress": "Purok Magsaysay",
      "recipientNationality": "PH",
      "recipientBarangayAddress": "Katipunan",
      "recipientCountryAddress": "PH",
      "recipientEmail": "xxxx@gmail.com",
      "recipientMobile": "+63 9651960000"
    }
    }
    
  • SWIFTPAY_PESONET
    {
    "amount": "1000",
    "internalOrderId":"2023090410571114",
    "currency":"PHP",
    "channelName": "SWIFTPAY_PESONET",
    "channelSubject":"unionbank",
    "extendInfo":{    
      "recipientAccountNumber": "20232249",
      "recipientEmail": "xxxx@gmail.com",  
      "recipientMobile": "+639651960000",
      "recipientName":"Joseph Pal Fajagut",
      "recipientAddress": "Santo",
      "recipientLastName": "Fajagut",     //optional
      "recipientMiddleName": "Pal",       //optional
      "recipientFirstName": "Joseph",     //optional
      "remarks": ""                       //optional
    }
    }
    
  • INSTAPAY
    {
    "amount": "1000",
    "internalOrderId":"2023090410571114",
    "currency":"PHP",
    "channelName": "INSTAPAY",
    "channelSubject":"gcash",
    "extendInfo":{    
      "recipientAccountNumber": "20232249",
      "recipientEmail": "xxxx@gmail.com",  
      "recipientMobile": "+639651960000",
      "recipientName":"Joseph Pal Fajagut",
      "recipientAddress": "Santo",
      "recipientLastName": "Fajagut",     //optional
      "recipientMiddleName": "Pal",       //optional
      "recipientFirstName": "Joseph",     //optional
      "remarks": ""                       //optional
    }
    }
    

Response:

{
  "status": 0,
  "error": "OK", 
  "data": {
         "externalOrderId": "1380692028693995623",
         "internalOrderId": "1388420429697583896"
          },
  "params": null
}

Fiat order detail

GET openapi/fiat/v1/details

This endpoint retrieves information about a specific fiat currency order. The response provides detailed information about the respective trade, including the transaction date, transaction amount, and any associated fees.

Weight: 1

Parameters:

NameTypeMandatoryDescription
internalOrderIdSTRINGYesID of the order for which the user wishes to retrieve details.

Response:

{
  "status": 0,
  "error": "OK",
  "data": {
            "id": "1380692028693995623",
            "orderId": "1388420429697583896",
            "paymentOrderId": "455628",
            "fiatCurrency": "PHP",
            "fiatAmount": "60",
            "transactionType": -1,
            "transactionChannel": "INSTAPAY",
            "transactionSubject": "coins.ph",
            "transactionSubjectType": "bank",
            "transactionChannelName": "instapay",
            "transactionSubjectName": "DCPAY PHILIPPINES, INC.",
            "feeCurrency": "PHP",
            "channelFee": "0",
            "platformFee": "10",
            "status": "SUCCEEDED",
            "errorCode": "",
            "errorMessage": "",
            "completedTime": "2023-03-31T07:44:42.000+00:00",
            "source": "WEB",
            "createdAt": "2023-03-31T07:43:37.000+00:00",
            "orderExtendedMap": {
             "amount": "50",
              "sendAcctNo": "1326887193441018369",
              "tfrName": "Li Mei Ling",
              "tfrAcctNo": "447415103851",
              "channelName": "INSTAPAY",
              "currency": "PHP",
              "source": "WEB",
              "channelSubject": "coins.ph",
              "userId": 1326887193348759809,
              "orgId": 9001
    },
    "dealCancel": false
  }
}

Fiat order history

POST openapi/fiat/v1/history

This endpoint is used to query all fiat related history

Weight: 1

Parameters:

NameTypeMandatoryDescription
pageNumSTRINGNoPage number.
pageSizeSTRINGNoPage size.
internalOrderIdSTRINGNoCoins returns a unique tracking order number.
transactionTypeSTRINGNoOrder Transaction Type 1: cash-in, -1: cash-out.
transactionChannelSTRINGNoTransaction channel, example: instapay etc.
transactionSubjectSTRINGNoSecondary channels, such as Gcash supported under instapay.
statusSTRINGNoCoins fiat order status.
fiatCurrencySTRINGNofiat currecy.
startDateSTRINGNothe order’s create time will between startDate and endDate. This parameter accepts input in the ISO 8601 format for date and time, which is based on the Coordinated Universal Time (UTC) time zone (e.g., “2016-10-20T13:00:00.000000Z”). Alternatively, you can provide a time delta from the current time (e.g., “1w 3d 2h 32m 5s”).
endDateSTRINGNothe order’s create time will between startDate and endDate. This parameter accepts input in the ISO 8601 format for date and time, which is based on the Coordinated Universal Time (UTC) time zone (e.g., “2016-10-20T13:00:00.000000Z”). Alternatively, you can provide a time delta from the current time (e.g., “1w 3d 2h 32m 5s”).

Response:

{
    "status": 0,
    "error": "OK",
    "data": [
        {
            "externalOrderId": "1476829580936625682",
            "internalOrderId": "1476829580936625681",
            "paymentOrderId": "000008",
            "fiatCurrency": "PHP",
            "fiatAmount": "11111",
            "transactionType": 1,
            "transactionChannel": "INSTAPAY",
            "transactionSubject": "allbank",
            "transactionChannelName": "instapay",
            "transactionSubjectName": "AllBank (A Thrift Bank), Inc.",
            "transactionSubjectType": "bank",
            "feeCurrency": "PHP",
            "channelFee": "0",
            "platformFee": "0",
            "status": "SUCCEEDED",
            "errorCode": "SUCCEEDED",
            "errorMessage": "",
            "completedTime": "2023-07-31T07:16:47.000+00:00",
            "source": "WEBHOOK",
            "createdAt": "2023-07-31T07:16:46.000+00:00",
            "orderExtendedMap": {
                "channelReferenceNo": "000008",
                "senderAccountNumber": "8613989193526"
            },
            "dealCancel": false
        },
        {
            "externalOrderId": "1476829580936625686",
            "internalOrderId": "1474038775754799133",
            "paymentOrderId": "2023072799",
            "fiatCurrency": "PHP",
            "fiatAmount": "100",
            "transactionType": 1,
            "transactionChannel": "SWIFTPAY_PESONET",
            "transactionSubject": "aub",
            "transactionChannelName": "swiftpay_pesonet",
            "transactionSubjectName": "Asia United Bank",
            "transactionSubjectType": "e-wallet",
            "feeCurrency": "PHP",
            "channelFee": "0",
            "platformFee": "10",
            "status": "SUCCEEDED",
            "errorCode": "SUCCEEDED",
            "errorMessage": "",
            "completedTime": "2023-07-27T10:52:41.000+00:00",
            "source": "WEBHOOK",
            "createdAt": "2023-07-27T10:52:40.000+00:00",
            "orderExtendedMap": {
                "channelReferenceNo": "000008",
                "senderAccountNumber": "8613989193526"
            },
            "dealCancel": false
        }
    ],
    "total": 2
}

Old endpoints from coins.ph (Legacy)

Create a new sellorder

POST openapi/migration/v4/sellorder

This endpoint converts digital assets into real-world cash, making it easy for users to withdraw their funds as cash. It provides a streamlined and secure process for cashing out, ensuring that users can access their funds quickly and easily. Additionally, this API endpoint ensures that users’ financial information is kept secure and confidential, providing a safe and reliable way to withdraw funds. It is best to no longer use this endpoint, only compatible with the old endpoint.

NameTypeMandatoryDescription
payment_outletSTRINGYesThe payment outlet used to transfer funds to another Coins wallet. Once the sell order is completed, the fiat cashout will be processed through the chosen payout outlet and the funds will be transferred to the specified destination wallet via coins_transfer.
base_amountSTRINGYesThe quantity of digital assets that the user wishes to sell and the corresponding amount of fiat cash that they will receive in exchange.
currencySTRINGYesThe currency symbol of the sell order.
bank_account_numberSTRINGYesCash out bank account number
bank_account_nameSTRINGYesCash out bank account name
recipient_phone_numberSTRINGYesRecipient phone number
recipient_bank_codeSTRINGNoRecipient bank code
external_transaction_idSTRINGNoA unique identifier for the sell order, should be number.
pay_with_walletSTRINGNoThe wallet code from which the user wishes to initiate the sell order.
sender_first_nameSTRINGNosender first name.
sender_middle_nameSTRINGNosender middle name.
sender_last_nameSTRINGNosender last name.
sender_addressSTRINGNosender address.
sender_citySTRINGNosender city.
sender_provinceSTRINGNosender province.
sender_countrySTRINGNosender country.
sender_postal_codeSTRINGNosender postal code.
sender_phoneSTRINGNosender phone.
sender_emailSTRINGNosender email.
sender_company_nameSTRINGNosender company name.

Request:

{
  "base_amount": "10",
  "external_transaction_id":"12121212212121212", // number not string
  "currency":"PHP",
  "bank_account_number":"9163011937",  // recipient phone (pesonet)or credit card numbers (instapy)
  "bank_account_name":"Mike",  // recipient name
  "recipient_phone_number":"9163011937", // recipient phone
  "payment_outlet":"citi_SWIFTPAY_PESONET"
}

Weight: 1

reference: https://docs.coins.asia/reference/sellorder-create


Retrieve an existing sellorder

GET openapi/migration/v4/sellorder/{sell_order_id}

This endpoint retrieves information about a previously executed sell order that involved a cash-out of fiat currency. It is best to no longer use this endpoint, only compatible with the old endpoint.

Parameters:

NameTypeMandatoryDescription
sell_order_idSTRINGNoA unique identifier that is used to specify the sell order that a user wants to retrieve information about.

Weight: 1

reference: https://docs.coins.asia/reference/sellorder-retrieve


Validate field values

POST openapi/migration/v4/validate-field

This endpoint validates field values for fiat sell order to ensure that the values provided for the different fields are valid before the actual cashout process begins. It is best to no longer use this endpoint, only compatible with the old endpoint.

Parameters:

NameTypeMandatoryDescription
field_typeSTRINGNoThe type of field that needs to be validated. Accepts two valid values: “account_number” and “mobile_number”..
account_numberSTRINGNoWhen the field_type parameter is set to “account_number”, this parameter is used to specify the account number that needs to be validated for the fiat sell order.
account_typeSTRINGNoWhen the field_type parameter is set to “account_number”, this parameter is used to specify the payment outlet ID where the account number field value should be validated against.
mobile_numberSTRINGNoWhen the field_type parameter is set to “mobile_number”, this parameter is used to specify the mobile number that needs to be validated for the fiat sell order. The mobile number provided must be in the correct format, following the E.164 phone number formatting, and associated with the correct user.
regionSTRINGNoWhen the field_type parameter is set to “mobile_number”, this parameter is used to specify the region of the mobile number that needs to be validated for the fiat sell order. Valid values for the region parameter are “PH” and “TH”, which represent the regions of the Philippines and Thailand, respectively.

Weight: 1

reference: https://docs.coins.asia/reference/validate-field


Retrieve supported payout-outlets

GET openapi/migration/v4/payout-outlets/{id}

This endpoint retrieves a list of supported payout outlets for fiat sell orders. It is designed to provide users with a comprehensive list of available payout options so they can select the one that is most convenient for them. It is best to no longer use this endpoint, only compatible with the old endpoint.

Parameters:

NameTypeMandatoryDescription
idSTRINGNoA unique identifier for the payout outlet.
outlet_categorySTRINGNoA payment outlet category ID that is used to filter the list of supported payout outlets.
nameSTRINGNoA payment outlet name that is used to filter the list of supported payout outlets.
regionSTRINGNoThe name of a region that is used to filter the list of supported payout outlets.
is_enabledSTRINGNoA boolean value that determines whether or not to include disabled payout outlets in the results.

Weight: 1

reference: https://docs.coins.asia/reference/payout-outlets


Retrieve supported payout-outlet-categories

GET openapi/migration/v4/payout-outlet-categories/{id}

This endpoint retrieves the list of payout outlet categories that are supported for fiat sell orders. Payout outlet categories are used to classify and organize the different payout outlet options that are available to users when they choose to cash out their fiat currency. This endpoint takes no parameters and returns a JSON response that includes an array of payout outlet categories. It is best to no longer use this endpoint, only compatible with the old endpoint.

Parameters:

NameTypeMandatoryDescription
idSTRINGNoID of a particular category to retrieve. If not provided, all categories will be retrieved.

Weight: 1

reference: https://docs.coins.asia/reference/payout-outlet-categories


Retrieve current payout-outlet-fees

GET openapi/migration/v4/payout-outlet-fees

This endpoint retrieves the current payout outlet fees for the supported payout outlets for fiat sell orders. Payout outlet fees are the fees charged by the payout outlet providers for processing the cash-out transactions. This endpoint takes no parameters and returns a JSON response that includes an array of payout outlet fees. It is best to no longer use this endpoint, only compatible with the old endpoint.

Parameters:

NameTypeMandatoryDescription
payment_outletSTRINGYesquery param to specify the target payout outlet.
currencySTRINGYesquery param to specify the target currency.

Weight: 1

reference: https://docs.coins.asia/reference/payout-outlet-fees

Query balance (USER_DATA)

GET /openapi/account/v3/crypto-accounts

This endpoint allows users to retrieve their current account balance.

Weight: 1 Parameters:

NameTypeMandatoryDescription
currencySTRINGNOThe currency for which the balance is being queried.
recvWindowLONGYESThis value cannot be greater than 60000
timestampLONGYESA point in time for which the balance is being queried.

Response:

 {
  "crypto-accounts": [
    {
      "id": "2309rjw0amf0sq9me0gmadsmfoa",
      "name": "name",
      "currency": "PBTC",
      "balance": "100",
      "pending_balance": "200"
    }
  ]
}

Transfers (USER_DATA)

POST /openapi/transfer/v3/transfers

This endpoint is used to transfer funds between two accounts.

Weight: 50

Parameters:

NameTypeMandatoryDescription
client_transfer_idSTRINGNOClient Transfer ID
accountSTRINGYESEither the token (e.g. PHP, BTC, ETH) or the Balance ID (e.g. 1447779051242545455) to be transferred.
target_addressSTRINGYESThe phone number or email for recipient account (e.g. +63 9686490252 or testsub@gmail.com)
amountBigDecimalYESThe amount being transferred
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time when the transfer is performed
messageSTRINGNOThe message sent to the recipient account

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

Response:

{
  "transfer":
    {
      "id": "2309rjw0amf0sq9me0gmadsmfoa",
      "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"
     }
}

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:

NameTypeMandatoryDescription
idSTRINGNOID of the transfer record
client_transfer_idSTRINGNOClient Transfer ID, Maximum length 100
pageINTNOCurrent page, default is 1
per_pageINTNOQuantity per page, default 2000, maximum 2000
from_addressSTRINGNOThe phone number or email for sender account (e.g. +63 9686490252 or testsub@gmail.com)
to_addressSTRINGNOThe phone number or email for recipient account (e.g. +63 9686490252 or testsub@gmail.com)
recvWindowLONGYESThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.
  • 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": "PBTC",
      "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
  }
}

Sub-account endpoints

Query Sub-account List (For Master Account)

Applies to master accounts only.

GET /openapi/v1/sub-account/list

Weight: 1

Parameters:

NameTypeMandatoryDescription
emailSTRINGNOSub-account email
pageINTNOCurrent page, default value: 1
limitINTNOQuantity per page, default value 10, maximum 200
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.

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:

NameTypeMandatoryDescription
accountNameSTRINGYESSub-account email
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.

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:

NameTypeMandatoryDescription
emailSTRINGYESSub-account email
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.

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:

NameTypeMandatoryDescription
fromEmailSTRINGNO 
toEmailSTRINGNO 
clientTranIdSTRINGNOMust be unique
assetSTRINGYES 
amountDECIMALYES 
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.
  • 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.

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:

NameTypeMandatoryDescription
assetSTRINGYES 
amountDECIMALYES 
clientTranIdSTRINGNOMust be unique
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.

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:

NameTypeMandatoryDescription
fromEmailSTRINGNO 
toEmailSTRINGNO 
clientTranIdSTRINGNO 
tokenIdSTRINGNO 
startTimeLONGNOMillisecond timestamp
endTimeLONGNOMillisecond timestamp,Data excluding the endTime.
pageINTNOCurrent page, default value: 1
limitINTNOQuantity per page, default value 500, maximum 500
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.
  • 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:

NameTypeMandatoryDescription
assetSTRINGNO 
typeINTNO1: transfer in, 2: transfer out. If the type parameter is not provided or provided incorrectly, the data returned will be for transfer out.
startTimeLONGNOMillisecond timestamp
endTimeLONGNOMillisecond timestamp,Data excluding the endTime.
pageINTNOCurrent page, default value: 1
limitINTNOQuantity per page, default value 500, maximum 500
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.
  • 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:

NameTypeMandatoryDescription
apikeySTRINGYES 
emailSTRINGYESSub-account email
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.

Response:

{
  "apikey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "ipList": [
    "8.8.8.8"
  ],
  "ipRestrict": true,
  "type": 1,//0:READ_ONLY,1:TRADE
  "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:

NameTypeMandatoryDescription
apikeySTRINGYES 
emailSTRINGYESSub-account email
ipAddressSTRINGNOCan be added in batches, separated by commas
ipRestrictionSTRINGYESIP Restriction status. 2 = IP Unrestricted. 1 = Restrict access to trusted IPs only.
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.

Response:

{
  "apikey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "ipList": [
    "8.8.8.8"
  ],
  "ipRestrict": true,
  "type": 1,//0:READ_ONLY,1:TRADE
  "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:

NameTypeMandatoryDescription
apikeySTRINGYES 
emailSTRINGYESSub-account email
ipAddressSTRINGYESCan be added in batches, separated by commas
recvWindowLONGNOThis value cannot be greater than 60000
timestampLONGYESA point in time for which transfers are being queried.

Response:

{
  "apikey": "k5V49ldtn4tszj6W3hystegdfvmGbqDzjmkCtpTvC0G74WhK7yd4rfCTo4lShf",
  "ipList": [
    "8.8.8.8"
  ],
  "ipRestrict": true,
  "type": 1,//0:READ_ONLY,1:TRADE
  "updateTime": 1689744700710
}

Note

Request Parameters

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