Change Log

Version 1.1.2 (10th April 2024)

• Update description of status and type in Query Wallet History

Version 1.1.1 (08th April 2024)

• Add API for querying Subaccount Transfer History

Version 1.1.0 (16th November 2022)

• [IMPORTANT] BTSE will change futures market naming convention in December 2022 to provide more clarity to retail users and here are the rules:
  • Change the suffix for perpetual markets from PFC to PERP (ex: BTCPFC -> BTC-PERP)
  • Change the suffix for time-based markets from delivery month + year to settlement date (YYMMDD) (ex: BTCZ22 -> BTC-221230)
  • Added a new optional query parameter useNewSymbolNaming in Query Wallet History and Transfer Funds if user wants to use new market name

Version 1.0.4 (25th, August 2022)

• Adjust param description of currency in APIs: Get Wallet Address, Create Wallet Address.

Version 1.0.3 (13th, May 2022)

• Addition of a parameter includeWithdrawFee for withdraw funds to set the fee will be inclusive/extra added.

Version 1.0.2 (16th March 2022)

• Max decimal supported for withdraw funds is 8, will return CRYPTO_WITHDRAW_INVALID_AMOUNT (error code: 3506) if exceeds

Version 1.0.1 (25th January 2022)

• Addition of exchangeRate api to get current exchange rate between assets

Version 1.0.0 (13th January 2022)

• Migrate wallet related endpoints to this section

Overview

Generating API Key

You will need to create an API key on the BTSE platform before you can use authenticated APIs. To create API keys, you can follow the steps below:

• Login with your username / email and password into the BTSE website
• Click on “Account” on the top right hand corner
• Select the API tab
• Click on New API button to create an API key and passphrase. (Note: the passphrase will only appear once)
• Use your API key and passphrase to construct a signature.

Endpoints

• Production
  • HTTP
    • https://api.btse.com/spot
  • Websocket
    • wss://ws.btse.com/ws/spot
  • Websocket (for orderbook stream)
    • wss://ws.btse.com/ws/oss/spot (Used for Orderbook incremental update stream)
• Testnet
  • HTTP
    • https://testapi.btse.io/spot
  • Websocket
    • wss://testws.btse.io/ws/spot
  • Websocket (for orderbook stream)
  • wss://testws.btse.io/ws/oss/spot (Used for Orderbook incremental update stream)

Authentication

• API Key (request-api)

  • Parameter Name: request-api, in: header. API key is obtained from BTSE platform as a string

• API Key (request-nonce)

  • Parameter Name: request-nonce, in: header. Representation of current timestamp in long format

• API Key (request-sign)

  • Parameter Name: request-sign, in: header. A composite signature produced based on the following algorithm: Signature=HMAC.Sha384 (secretkey, (urlpath + request-nonce + bodyStr)) (note: bodyStr = '' when no data):

Example 1: Get Wallet

HMAC SHA384 Signature

$ echo -n "/api/v3.2/user/wallet1624984297330" | openssl dgst -sha384 -hmac "848db84ac252b6726e5f6e7a711d9c96d9fd77d020151b45839a5b59c37203bx"
(stdin)= 14b986706a4368221e0af14a6725377161805e7a57d568220478cb3590ce532d4fad4ac68e6c02a14afced6a0619bfd3

• Endpoint to get wallet is https://api.btse.com/spot/api/v3.2/user/wallet
• Assume we have the values as follows:
  • request-nonce: 1624984297330
  • request-api: 4e9536c79f0fdd72bf04f2430982d3f61d9d76c996f0175bbba470d69d59816x
  • secret: 848db84ac252b6726e5f6e7a711d9c96d9fd77d020151b45839a5b59c37203bx
  • Path: /api/v3.2/user/wallet
• Generated signature will be:
  • request-sign: 14b986706a4368221e0af14a6725377161805e7a57d568220478cb3590ce532d4fad4ac68e6c02a14afced6a0619bfd3

Rate Limits

• The following rate limits are enforced:

Rate limits for BTSE is as follows:

Wallet operation

• Per User: 5 requests/second

API Status Codes

Each API will return one of the following HTTP status:

• 200 - API request was successful, refer to the specific API response for expected payload
• 400 - Bad Request. Server will not process this request. This is usually due to invalid parameters sent in request
• 401 - Unauthorized request. Server will not process this request as it does not have valid authentication credentials
• 403 - Forbidden request. Credentials were provided but they were insufficient to perform the request
• 404 - Not found. Indicates that the server understood the request but could not find a correct representation for the target resource
• 405 - Method not allowed. Indicates that the request method is not known to the requested server
• 408 - Request timeout. Indicates that the server did not complete the request. BTSE API timeouts are set at 30secs
• 429 - Too many requests. Indicates that the client has exceeded the rates limits set by the server. Refer to Rate Limits for more details
• 500 - Internal server error. Indicates that the server encountered an unexpected condition resulting in not being able to fulfill the request

Public Endpoints

Query available crypto network list for currency

Response

[
  "Bitcoin",
  "Liquid"
]

GET /api/v3.2/availableCurrencyNetworks

Get available crypto network list for currency.

Request Parameters

Response Content

Query exchange rate between assets

Response

{
  "code": 1,
  "msg": "Success",
  "time": 1643085970137,
  "data": 36051.55950285,
  "success": true
}

GET /api/v3.2/exchangeRate

Get the exchange rate between assets.

Request Parameters

Response Content

Wallet Endpoints

Query Wallet Balance

Response

[
  {
    "available": 520.52,
    "currency": "USD",
    "total": 5566.5566
  }
]

GET /api/v3.2/user/wallet

Query user's wallet balance. Requires Read permissions on the API key.

Response Content

Query Wallet History

Response

[
  {
    "amount": 21.35823825,
    "currency": "USD",
    "description": "string",
    "fees": 0.06,
    "orderId": 20181213000239,
    "status": "COMPLETED",
    "timestamp": 1571630174639,
    "type": "Transfer_In",
    "username": "btseUser",
    "wallet": "Wallet",
    "txid": "<Blockchain Transaction ID>",
    "currencyNetwork": "<Blockchain currency network>"
  }
]

GET /api/v3.2/user/wallet_history

Get user's wallet history records on the spot wallet

Request Parameters

Response Content

Create Wallet Address

Request

{
  "currency": "BTC-LIQUID"
}

Response

[
  {
    "address": "Blockchain address",
    "created": 1592627542
  }
]

POST /api/v3.2/user/wallet/address

Creates a wallet address. If the address created has not been used before, a 400 error will return with the existing unused address. To use this API, Wallet permission is required.

Request Parameters

Response Content

Delete Wallet Address

Request

{
  "currency": "BTC",
  "network": "LIQUID",
  "address": "Blockchain address"
}

DELETE /api/v3.2/user/wallet/address

Delete wallet address. If the address has been delete, a 400 error will return. To use this API, Wallet permission is required.

Request Parameters

Get Wallet Address

Request

{
  "currency": "BTC",
  "network": "LIQUID"
}

Response

[
  {
    "address": "Blockchain address",
    "created": 1592627542
  }
]

GET /api/v3.2/user/wallet/address

Gets a wallet address. To use this API, Wallet permission is required.

Request Parameters

Response Content

Withdraw Funds

Request

{
  "currency": "BTC-Bitcoin",
  "address": "BTCAddress",
  "tag": "Tag",
  "amount": "0.001"
}

Response

{
  "withdraw_id": "<withdrawal ID>"
}

POST /api/v3.2/user/wallet/withdraw

Performs a wallet withdrawal. To use this API, Withdraw permission is required.

Request Parameters

Response Content

Query available currency list for wallet action

Response

[
  "USD",
  "JPY",
  "GBP",
  "HKD",
  "SGD"
]

GET /api/v3.2/availableCurrencies

Get available currency list for wallet action.

Request Parameters

Response Content

Convert funds

Request

{
  "amount": "1",
  "fromAsset": "BTC",
  "toAsset": "USD"
}

Response

{
    "amount": 1.0,
    "settlementAmount": 66680.43282,
    "amountCurrency": "BTC",
    "settlementCurrency": "USD",
    "rate": 66680.43282
}

POST /api/v3.2/user/wallet/convert

Performs a currency conversion from wallet. To use this API, Wallet permission is required. To get supported currency list please check Available currency list for action

Request Parameters

Response Content

Transfer Funds

Request

{
  "amount": "1.0",
  "asset": "BTC",
  "toUser": "jamesbond",
  "toUserMail": "james.bond@google.com"
}

Response

{
  "amount": "1",
  "asset": "BTC",
  "toUser": "jamesbond",
  "toUserMail": "james.bond@google.com"
}

POST /api/v3.2/user/wallet/transfer

Performs a internal currency transfer to other user from wallet. To use this API, Transfer permission is required. To get supported currency list please check Available currency list for action

Request Parameters

Response Content

Subaccount transfer history

Response

{
  "code": 1,
  "msg": "Success",
  "time": 1653964265608,
  "success": true,
  "data": {
    "totalRows": 2,
    "pageSize": 10,
    "currentPage": 1,
    "totalPages": 1,
    "data": [
      {
        "timestamp": 1711707874850,
        "fromUser": "uuooxxsub00002",
        "receiver": "uuooxx",
        "currency": "USDT",
        "amount": 11
      }
    ]
  }
}

POST /api/v3.2/subaccount/wallet/history

Query transfer history for subaccounts

Request Parameters

Response Content