json

Change Log

Version 3.3.2 (29th March 2022)

Version 3.3.1 (2nd March 2022)

Version 3.3.0 (21st January 2022)

Version 3.2.9 (13th January 2022)

Version 3.2.8 (8th December 2021)

Version 3.2.7 (23rd November 2021)

Version 3.2.6 (19th November 2021)

Version 3.2.5 (25th October 2021)

Version 3.2.4 (1st July 2021)

Version 3.2.3 (2nd June 2021)

Version 3.2.2 (29th January 2021)

Existing endpoints will continue to be made available.

Version 3.2.1 (28th September 2020)

Version 3.2 (23rd June 2020)

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:

Endpoints

Authentication

Example 1: Place an order

HMAC SHA384 Signature

$ echo -n "/api/v3.2/order1624985375123{\"postOnly\":false,\"price\":8500.0,\"side\":\"BUY\",\"size\":0.002,\"stopPrice\":0.0,\"symbol\":\"BTC-USD\",\"time_in_force\":\"GTC\",\"trailValue\":0.0,\"triggerPrice\":0.0,\"txType\":\"LIMIT\",\"type\":\"LIMIT\"}" | openssl dgst -sha384 -hmac "848db84ac252b6726e5f6e7a711d9c96d9fd77d020151b45839a5b59c37203bx"
(stdin)=e9cd0babdf497b536d1e48bc9cf1fadad3426b36406b5747d77ae4e3cdc9ab556863f2d0cf78e0228c39a064ad43afb7

Rate Limits

Rate limits for BTSE is as follows:

Query

Orders

API Status Codes

Each API will return one of the following HTTP status:

API Enum

When connecting up the BTSE API, you will come across number codes that represents different states or status types in BTSE. The following section provides a list of codes that you are expecting to see.

Public Endpoints

Market Summary

Response

[
  {
    "symbol": "BTC-USD",
    "last": 36976,
    "lowestAsk": 37012,
    "highestBid": 36972,
    "percentageChange": -4.633438649,
    "volume": 81456627.51106991,
    "high24Hr": 39478.5,
    "low24Hr": 36821.5,
    "base": "BTC",
    "quote": "USD",
    "active": true,
    "size": 2117.88522,
    "minValidPrice": 0.5,
    "minPriceIncrement": 0.5,
    "minOrderSize": 0.00001,
    "maxOrderSize": 2000,
    "minSizeIncrement": 0.00001,
    "openInterest": 0,
    "openInterestUSD": 0,
    "contractStart": 0,
    "contractEnd": 0,
    "timeBasedContract": false,
    "openTime": 0,
    "closeTime": 0,
    "startMatching": 0,
    "inactiveTime": 0,
    "fundingRate": 0,
    "contractSize": 0,
    "maxPosition": 0,
    "minRiskLimit": 0,
    "maxRiskLimit": 0,
    "availableSettlement": null,
    "futures": false
  }
]

GET /api/v3.2/market_summary

Gets market summary information. If no symbol parameter is sent, then all markets will be retrieved.

Request Parameters

name type required description
symbol string no market symbol

Response Content

Name Type Required Description
symbol string Yes Market symbol
last double Yes Last price
lowestAsk double Yes Lowest ask price in the orderbook
highestBid double Yes Highest bid price in the orderbook
percentageChange double Yes Percentage change against the price within the last 24hours
volume double Yes Transacted volume
high24Hr double Yes Highest price over the last 24hours
low24Hr double Yes Lowest price over the last 24hours
base string Yes Base currency
quote string Yes Quote currency
active boolean Yes Indicator if market is active
size double Yes Transacted size
minValidPrice double Yes Minimum valid price
minPriceIncrement double Yes Price increment
minOrderSize double Yes Minimum tick size
minSizeIncrement double Yes Tick size
maxOrderSize double Yes Maximum order size
openInterest double No Not valid for spot
openInterestUSD double No Not valid for spot
contractStart date No Not valid for spot
contractEnd date No Not valid for spot
timeBasedContract boolean No Not valid for spot
openTime date Yes Market opening time
closeTime date Yes Market closing time
startMatching date Yes Matching start time
inactiveTime date Yes Time where market is inactive
fundingRate double No Not valid for spot
contractSize double No Not valid for spot
maxPosition double No Not valid for spot
minRiskLimit double No Not valid for spot
maxRiskLimit double No Not valid for spot
availableSettlement array No Not valid for spot
futures boolean Yes Indicator if symbol is a futures contract

Charting Data

Response

[
  [
    1624987380,
    36477,
    36477,
    36473.5,
    36473.5,
    693.049
  ],
  [
    1624987320,
    36476.5,
    36481.5,
    36466,
    36466,
    2370.8095
  ],

GET /api/v3.2/ohlcv

Gets candle stick charting data. Default of 300 data points will be returned at any one time.

Request Parameters

name type required description
symbol string yes market symbol
start long no starting time (eg. 1624987283000)
end long no ending time (eg. 1624987283000)
resolution string yes supported resolutions are:
1: 1min
5: 5mins
15: 15mins
30: 30mins
60: 60mins
360: 6hours
1440: 1day

Response Content

Returns a 2D array with the indexes described in the table below

Index Type Required Description
0 long Yes Unix time
1 double Yes Open price
2 double Yes High Price
3 double Yes Low price
4 double Yes Closing price
5 double Yes Volume

Query Market price

Response

[
  {
    "symbol": "BTC-USD",
    "indexPrice": 36288.949684967,
    "lastPrice": 36286.5,
    "markPrice": 0
  }
]

GET /api/v3.2/price

Retrieve current prices on the platform. If no symbol specified, all symbols will be returned.

Request Parameters

Name Type Required Description
symbol string Yes Market symbol

Response Content

Name Type Required Description
symbol double Yes Market symbol
indexPrice double Yes Index price
lastPrice double Yes Last transacted price
markPrice double Yes Not valid for spot

Orderbook (By grouping)

Response

{
  "buyQuote": [
    {
      "price": "36371.0",
      "size": "0.01485"
    }
  ],
  "sellQuote": [
    {
      "price": "36380.5",
      "size": "0.01782"
    }
  ],
  "timestamp": 1624989459489,
  "symbol": "BTC-USD"
}

GET /api/v3.2/orderbook

Retrieves a Level 2 snapshot of the orderbook and allows you to specify grouping and also bid / asks depth

Request Parameters

Name Type Required Description
symbol string Yes Market symbol
group integer No Orderbook grouping. Valid values are:
0-9 where 0 indicates level 0 grouping (eg. for BTC, it will be 0.5)
Level 1 grouping for BTC would be 1
limit_bids integer No Orderbook depth on the bid side
limit_asks integer No Orderbook depth on the ask side

Response Content

Orderbook

Name Type Required Description
symbol string Yes Market symbol
buyQuote Quote Yes Array of Buy quotes
sellQuote Quote Yes Array of Sell quotes
timestamp double Yes Timestamp of orderbook

Quote

Name Type Required Description
price double Yes order price
size double Yes order size

Orderbook

Response

{
  "buyQuote": [
    {
      "price": "36235.0",
      "size": "7.67500"
    }
  ],
  "sellQuote": [
    {
      "price": "36241.5",
      "size": "0.60200"
    }
  ],
  "timestamp": 1624989977940,
  "symbol": "BTC-USD"
}

GET /api/v3.2/orderbook/L2

Retrieves a Level 2 snapshot of the orderbook

Request Parameters

Name Type Required Description
symbol string Yes Market symbol
depth integer No Orderbook depth

Response Content

Orderbook

Name Type Required Description
symbol string Yes Market symbol
buyQuote Quote Yes Array of Buy quotes
sellQuote Quote Yes Array of Sell quotes
timestamp double Yes Timestamp of orderbook

Quote

Name Type Required Description
price double Yes order price
size double Yes order size

Query Trades Fills

Response

[
  {
    "price": 36164,
    "size": 0.035,
    "side": "SELL",
    "symbol": "BTC-USD",
    "serialId": 85997835,
    "timestamp": 1624990097000
  }
]

GET /api/v3.2/trades

Get trade fills for the market specified by symbol

Request Parameters

Name Type Required Description
symbol string Yes Market symbol
startTime long No Starting time (eg. 1624987283000)
endTime long No Ending time (eg. 1624987283000)
beforeSerialId string No Condition to retrieve records before the specified serial Id. Used for pagination
afterSerialId string No Condition to retrieve records after the specified serial Id. Used for pagination
count integer No Number of records to return
includeOld boolean No Retrieve trade history records past 7 days

Response Content

Name Type Required Description
symbol string Yes Market symbol
side string Yes Trade side. Values are: [BUY, SELL]
price double Yes Transacted price
size double Yes Transacted size
serialId double Yes Serial Id, running sequence number
timestamp double Yes Transacted timestamp

Query Server Time

Response

{
  "iso": "2021-06-29T18:14:30.886Z",
  "epoch": 1624990470
}

GET /api/v3.2/time

Gets server time

Response Content

Name Type Required Description
iso long Yes Time in YYYY-MM-DDTHH24:MI:SS.Z format
epoch long Yes Returns epoch timestamp

Trade Endpoints

Create new order

Request

{
  "clOrderID": "string",
  "deviation": 0,
  "postOnly": false,
  "price": 7010,
  "side": "BUY",
  "size": 4,
  "stealth": 0,
  "stopPrice": 0,
  "symbol": "BTC-USD",
  "time_in_force": "GTC",
  "trailValue": 0,
  "triggerPrice": 0,
  "txType": "LIMIT",
  "type": "LIMIT"
}

Response

{
  "averageFillPrice": 0,
  "clOrderID": "string",
  "deviation": 0,
  "fillSize": 0,
  "message": "string",
  "orderID": "string",
  "orderType": 76,
  "price": 0,
  "side": "BUY",
  "size": 4,
  "status": 0,
  "stealth": 0,
  "stopPrice": 8300,
  "symbol": "BTC-USD",
  "timestamp": 1576812000872,
  "trigger": true,
  "triggerPrice": 8300,
  "remainingSize": 2,
  "orginialSize": 4
}

POST /api/v3.2/order

Creates a new order. Requires Trading permission

Request Parameters

Name Type Required Description
symbol string Yes Market symbol
price double Yes Order price
size double Yes Order size
side string Yes 'BUY' or 'SELL'
time_in_force string No Time validity of the order
GTC: Good till Cancel
IOC: Immediate or Cancel
FOK: Fill or Kill
HALFMIN: Order valid for 30 seconds
FIVEMIN: Order valid for 5 mins
HOUR: Order valid for an hour
TWELVEHOUR: Order valid for 12 hours
DAY: Order valid for a day
WEEK: Order valid for a week
MONTH: Order valid for a month
type string Yes Order type
LIMIT: Limit Orders
MARKET: Market Orders
OCO: One cancel the other
txType string Yes Used for Stop orders or trigger orders
STOP: Stop Order, stopPrice is mandatory
TRIGGER: Trigger order, triggerPrice is mandatory
LIMIT: Default, used when its not a Stop order nor Trigger order
stopPrice double No Mandatory when creating a Stop or OCO order. Indicates the stop price
triggerPrice double Yes Mandatory when creating a Trigger or OCO order. Indicates the trigger price
trailValue double Yes Trail value
postOnly boolean Yes Boolean to indicate if this is a post only order. For post only orders, traders are charged maker fees
clOrderID string Yes Custom order Id

Response Content

Name Type Required Description
symbol string Yes Market symbol
clOrderID string Yes Customer tag sent in by trader
fillSize string Yes Trade filled size
orderID string Yes Order ID
orderType string Yes Order type
76: Limit Order
77: Market order
80: Algo order
postOnly boolean Yes Indicates if order is a post only order
price double Yes Order price
side string Yes Order side
BUY or SELL
size double Yes Order size
status integer Yes Order status
2: Order Inserted
4: Order Fully Transacted
5: Order Partially Transacted
6: Order Cancelled
7: Order Refunded
8: Insufficient Balance
9: Trigger Inserted
10: Trigger Activated
15: Order Rejected
16: Order Not Found
17: Request Failed
stopPrice string Yes Stop price
time_in_force string Yes Order validity
timestamp string Yes Order timestamp
trigger string Yes Indicator if order is a trigger order
triggerPrice string Yes Order trigger price, returns 0 if order is not a trigger order
averageFillPrice string Yes Average filled price. Returns the average filled price for partially transacted orders
message string Yes Trade messages
stealth string Yes Only valid for Algo orders
deviation string Yes Only valid for Algo orders
remainingSize double Yes Size left to be transacted
originalSize double Yes Original order size

Create new algo order

Request

{
  "clOrderID": "string",
  "deviation": 0,
  "postOnly": false,
  "price": 7010,
  "side": "BUY",
  "size": 4,
  "stealth": 0,
  "stopPrice": 0,
  "symbol": "BTC-USD",
  "time_in_force": "GTC",
  "trailValue": 0,
  "triggerPrice": 0,
  "txType": "LIMIT",
  "type": "LIMIT"
}

Response

{
  "averageFillPrice": 0,
  "clOrderID": "string",
  "deviation": 0,
  "fillSize": 0,
  "message": "string",
  "orderID": "string",
  "orderType": 76,
  "price": 0,
  "side": "BUY",
  "size": 4,
  "status": 0,
  "stealth": 0,
  "stopPrice": 8300,
  "symbol": "BTC-USD",
  "timestamp": 1576812000872,
  "trigger": true,
  "triggerPrice": 8300,
  "remainingSize": 2,
  "orginialSize": 4
}

POST /api/v3.2/order/peg

Creates a new algo order. Algo order is an order that price will change according to market price. To create an algo order, user will need to enter additional parameters:

This API Requires Trading permission

Request Parameters

Name Type Required Description
symbol string Yes Market symbol
price double Yes Minimum price for a sell order, this is the lowest price that a user is willing to sell at. Maximum price for a buy order, this is the maximum price a user is willing to buy at.
size double Yes Order size
side string Yes 'BUY' or 'SELL'
time_in_force string No Time validity of the order
GTC: Good till Cancel
IOC: Immediate or Cancel
FOK: Fill or Kill
HALFMIN: Order valid for 30 seconds
FIVEMIN: Order valid for 5 mins
HOUR: Order valid for an hour
TWELVEHOUR: Order valid for 12 hours
DAY: Order valid for a day
WEEK: Order valid for a week
MONTH: Order valid for a month
type string Yes Order type
LIMIT: Limit Orders
MARKET: Market Orders
OCO: One cancel the other
txType string Yes Used for Stop orders or trigger orders
STOP: Stop Order, stopPrice is mandatory
TRIGGER: Trigger order, triggerPrice is mandatory
LIMIT: Default, used when its not a Stop order nor Trigger order
stopPrice double No Mandatory when creating a Stop or OCO order. Indicates the stop price
triggerPrice double Yes Mandatory when creating a Trigger or OCO order. Indicates the trigger price
trailValue double Yes Trail value
postOnly boolean Yes Boolean to indicate if this is a post only order. For post only orders, traders are charged maker fees
clOrderID string Yes Custom order Id
stealth double Yes How many percent of the order is to be displayed on the orderbook.
deviation double Yes How much should the order price deviate from index price. Value is in percentage and can range from -10 to 10

Response Content

Name Type Required Description
symbol string Yes Market symbol
clOrderID string Yes Customer tag sent in by trader
fillSize string Yes Trade filled size
orderID string Yes Order ID
orderType string Yes Order type
76: Limit Order
77: Market order
80: Algo order
postOnly boolean Yes Indicates if order is a post only order
price double Yes Order price
side string Yes Order side
BUY or SELL
size double Yes Order size
status integer Yes Order status
2: Order Inserted
4: Order Fully Transacted
5: Order Partially Transacted
6: Order Cancelled
7: Order Refunded
8: Insufficient Balance
9: Trigger Inserted
10: Trigger Activated
15: Order Rejected
16: Order Not Found
17: Request Failed
stopPrice string Yes Stop price
time_in_force string Yes Order validity
timestamp string Yes Order timestamp
trigger string Yes Indicator if order is a trigger order
triggerPrice string Yes Order trigger price, returns 0 if order is not a trigger order
averageFillPrice string Yes Average filled price. Returns the average filled price for partially transacted orders
message string Yes Trade messages
stealth string Yes Stealth value of order
deviation string Yes Deviation value of order
remainingSize double Yes Size left to be transacted
originalSize double Yes Original order size

Amend Order

Request

{
  "symbol": "BTC-USD",
  "type": "PRICE",
  "orderID": "Order ID",
  "clOrderID": "Custom Order ID",
  "value": 0,
  "slide": true,
  "orderSize": 12,
  "orderPrice": 40000
}

Response

{
  "averageFillPrice": 0,
  "clOrderID": "string",
  "deviation": -5,
  "fillSize": 0,
  "message": "string",
  "orderID": "string",
  "orderType": 76,
  "price": 0,
  "side": "BUY",
  "size": 4,
  "status": 0,
  "stealth": 10,
  "stopPrice": 8300,
  "symbol": "BTC-USD",
  "timestamp": 1576812000872,
  "trigger": true,
  "triggerPrice": 8300
}

PUT /api/v3.2/order

Amend the price or size or trigger price of an order. For trigger orders, if the order has already been triggered, the trigger price cannot be further amended. If an order is a POST-ONLY order, and slide option is set to true, then price will set to be the best bid/ask price. Amend order does not apply to algo orders

Request Parameters

Name Type Required Description
symbol string Yes Market symbol
orderID string No Internal order ID
clOrderID string No Custom order ID
type string Yes Type of amendmend
PRICE: To amend order price
SIZE: To amend order size
TRIGGER: To amend trigger price
ALL: to amend multiple fields
value number Yes The value to be amended to. Value depends on the type being set.
slide boolean No Used for Post-Only orders. When set to true will set price to best bid/ask
orderPrice number No order price to be amended
orderSize number No order size to be amended
triggerPrice number No trigger price to be amended

Response Content

Name Type Required Description
symbol string Yes Market symbol
clOrderID string Yes Customer tag sent in by trader
fillSize string Yes Trade filled size
orderID string Yes Order ID
orderType string Yes Order type
76: Limit Order
77: Market order
80: Algo order
postOnly boolean Yes Indicates if order is a post only order
price double Yes Order price
side string Yes Order side
BUY or SELL
size double Yes Order size
status integer Yes Order status
2: Order Inserted
4: Order Fully Transacted
5: Order Partially Transacted
6: Order Cancelled
7: Order Refunded
8: Insufficient Balance
9: Trigger Inserted
10: Trigger Activated
15: Order Rejected
16: Order Not Found
17: Request Failed
stopPrice string Yes Stop price
time_in_force string Yes Order validity
timestamp string Yes Order timestamp
trigger string Yes Indicator if order is a trigger order
triggerPrice string Yes Order trigger price, returns 0 if order is not a trigger order
averageFillPrice string Yes Average filled price. Returns the average filled price for partially transacted orders
message string Yes Trade messages
stealth string Yes Stealth value of order
deviation string Yes Deviation value of order

Cancel Order

Request

/api/v3.2/order?symbol=BTC-USD&clOrderID=my-order-id

Response

[
  {
    "price": 36164,
    "size": 0.035,
    "side": "SELL",
    "symbol": "BTC-USD",
    "serialId": 85997835,
    "timestamp": 1624990097000
  }
]

DELETE /api/v3.2/order

Cancels pending orders that has not yet been transacted. The orderID is a unique identifier to cancel a particular order. clOrderID is a custom ID sent in by the trader. When cancel by clOrderID, all orders having the same ID will be cancelled. If orderID and clOrderID is not sent in, then cancellation will be for all orders in the current market.

Request Parameters

Name Type Required Description
symbol string Yes Market symbol
orderID string No Unique identifier for an order
clOrderID string No Client custom order ID

Response Content

Name Type Required Description
symbol string Yes Market symbol
clOrderID string Yes Customer tag sent in by trader
fillSize string Yes Trade filled size
orderID string Yes Order ID
orderType string Yes Order type
76: Limit Order
77: Market order
80: Algo order
postOnly boolean Yes Indicates if order is a post only order
price double Yes Order price
side string Yes Order side
BUY or SELL
size double Yes Cancelled size
status integer Yes Order status
2: Order Inserted
3: Order Transacted
4: Order Fully Transacted
5: Order Partially Transacted
6: Order Cancelled
7: Order Refunded
9: Trigger Inserted
10: Trigger Activated
15: Order Rejected
16: Order Not Found
17: Request failed
stopPrice string Yes Stop price
time_in_force string Yes Order validity
timestamp string Yes Order timestamp
trigger string Yes Indicator if order is a trigger order
triggerPrice string Yes Order trigger price, returns 0 if order is not a trigger order
averageFillPrice string Yes Average filled price. Returns the average filled price for partially transacted orders
message string Yes Trade messages
stealth string Yes Stealth value of order
deviation string Yes Deviation value of order

Dead man's switch (Cancel all after)

Request

{
  "timeout": 60000
}

POST /api/v3.2/order/cancelAllAfter

Dead-man's switch allows the trader to send in a timeout value which is a Time to live (TTL) value for an order. Extension of the timeout is done by sending another cancelAllAfter request. If the server does not receive another request before the timeout is reached, all orders will be cancelled.

Request Parameters

Name Type Required Description
timeout long Yes Timeout value in milliseconds

Response Content

Query Open Orders

Response

{
  "orderType": 76,
  "price": 2142.5,
  "size": 0.001,
  "side": "BUY",
  "orderValue": 2.1425,
  "filledSize": 0,
  "pegPriceMin": 0,
  "pegPriceMax": 0,
  "pegPriceDeviation": 0,
  "cancelDuration": 0,
  "timestamp": 1642992096246,
  "orderID": "946ec252-2a85-40a1-9707-6b737c75b394",
  "triggerOrder": false,
  "triggerPrice": 0,
  "triggerOriginalPrice": 0,
  "triggerOrderType": 0,
  "triggerTrailingStopDeviation": 0,
  "triggerStopPrice": 0,
  "symbol": "ETH-USD",
  "trailValue": 0,
  "averageFillPrice": 0,
  "fillSize": 0,
  "clOrderID": "_rtifs1642992095163",
  "orderState": "STATUS_ACTIVE",
  "triggered": false
}

GET /api/v3.2/user/open_orders

Retrieves open orders that have not yet been matched or matched recently.

Request Parameters

Name Type Required Description
symbol string Yes Market symbol
orderID string No Query using internal order ID
clOrderID string No Query using custom order ID

Response Content

Name Type Required Description
orderType double Yes Order type
76: Limit Order
77: Market order
80: Algo order
price double Yes Order price
size double Yes Order size
side string Yes Order side
BUY or SELL
orderValue double Yes Total value of of this order
filledSize double Yes Filled size
pegPriceMin double Yes Minimum possible peg price this takes precedence over pegPriceDeviation
pegPriceMax double Yes Maximum possible peg price this takes precedence over pegPriceDeviation
pegPriceDeviation double Yes Percentage deviation from Index price
cancelDuration double Yes Order expiration time if not 0
timestamp double Yes Order placement time
orderID string Yes Order Id
triggerOrder bool Yes Indicator if order is a trigger order
triggerPrice double Yes Order trigger price, returns 0 if order is not a trigger order
triggerOriginalPrice double Yes Price of the original order. Only valid if it's a triggered order
triggerOrderType double Yes Order type
76: Limit Order
77: Market order
80: Algo order
triggerTrailingStopDeviation double Yes Percentage deviation from stop price
triggerStopPrice double Yes Stop price, Algo Order only
symbol string Yes Market name (e.g. BTC-USD)
trailValue double Yes Trail value
averageFillPrice string Yes Average filled price. Returns the average filled price for partially transacted orders
filledSize double Yes Filled size
clOrderID string Yes Customer order ID
orderState string Yes STATUS_ACTIVE, STATUS_INACTIVE
triggered bool Yes Indicate whether the order is triiggered

Query Trades Fills

Response

{
  "base": "string",
  "clOrderID": "string",
  "feeAmount": 0,
  "feeCurrency": "string",
  "filledPrice": 0,
  "filledSize": 0,
  "orderId": "string",
  "orderType": 0,
  "price": 0,
  "quote": "string",
  "realizedPnl": 0,
  "serialId": 0,
  "side": "string",
  "size": 0,
  "symbol": "string",
  "timestamp": 0,
  "total": 0,
  "tradeId": "string",
  "triggerPrice": 0,
  "triggerType": 0,
  "username": "string",
  "wallet": "string"
}

GET /api/v3.2/user/trade_history

Retrieves a user's trade history

Request Parameters

Name Type Required Description
symbol string Yes Market symbol
startTime long No Starting time (eg. 1624987283000)
endTime long No Ending time (eg. 1624987283000)
beforeSerialId string No Condition to retrieve records before the specified serial Id. Used for pagination
afterSerialId string No Condition to retrieve records after the specified serial Id. Used for pagination
count integer No Number of records to return
includeOld boolean Yes Retrieve trade history records past 7 days
clOrderID string No Query trade history by custom order ID
orderID string No Query trade history by order ID
isMatchSymbol boolean No Exact match on symbol. If this sets to true, will only match records for that symbol only

Response Content

Name Type Required Description
symbol string Yes Market symbol
side string Yes Trade side. Values are: [BUY, sell]
price double yes transacted price
size double yes transacted size
serialid long yes serial id, running sequence number
tradeid string yes trade identifier
timestamp double yes transacted timestamp
base long yes base currency
quote long yes quote currency
clorderid long yes custom order id
orderid long yes order id
feeamount long yes fee amount
feecurrency long yes fee currency
filledprice long yes filled price
filledsize long yes filled size
ordertype long yes order type
realizedpnl long yes not used in spot
total long yes not used in spot

query account fees

response

{
  "makerfee": 0,
  "symbol": "btc-usd",
  "takerfee": 0
}

get /api/v3.2/user/fees

retrieve user's trading fees

request parameters

name type required description
symbol string no market symbol to filter for specific market

response content

name type required description
symbol string yes market symbol
makerfee double yes maker fees
takerfee double yes taker fees

investment endpoints

query investment products

response

[
  {
    "id": "openeth00001",
    "name": "eth flex savings",
    "currency": "eth",
    "type": "flex",
    "startdate": 1610685918000,
    "intereststartdate": 1610719200000,
    "rates":
    [
      {
        "days": 1,
        "rate": 1.15
      }
    ],
    "compounding": true,
    "autorenewsupported": false,
    "dailylimit": 10.0,
    "minsize": 1.00000000,
    "incrementalsize": 1.00000000
  }
]

get /api/v3.2/invest/products

get all investment products

request parameters

(none)

response content

name type required description
id string yes product id
name string yes product name
currency string yes currency
type string yes product type
startdate long yes inventment start date
intereststartdate long yes interest start date
rates rateobject[] yes interest rate information
compounding double yes is product compounding
autorenewsupported double yes is product supported renew automatically
dailylimit double yes daily invent amount limit
minsize double yes minimum invest size
incrementalsize double yes invest step size

rateobject

name type required description
days integer yes duration in days
rate double yes interest rate

deposit investment

request

{
    "productid": "openusdt0001",
    "amount": 100.99,
    "renew": true,
    "rate": 6,
    "day": 7
}

post /api/v3.2/invest/deposit

deposit an investment

request parameters

name type required description
productid string yes invest product id
amount double yes invest amount
renew boolean yes renew automatically
rate double yes interest rate
day integer yes duration in days

renew investment

request

{
    "orderid": 1,
    "autorenew": false
}

response

{
    "orderid": 1,
    "autorenew": false
}

post /api/v3.2/invest/renew

renew an investment order

request parameters

name type required description
orderid integer yes investment order id
autorenew boolean yes renew automatically

response content

name type required description
orderid integer yes investment order id
autorenew boolean yes status of autorenew flag

redeem investment

request

{
    "orderid": 1,
    "amount": 12.34
}

post /api/v3.2/invest/redeem

redeem an investment order

request parameters

name type required description
orderid integer yes investment order id
amount double yes redeem amount

query investment orders

response

[
  {
    "id": 456,
    "name": "eth flex savings",
    "currency": "eth",
    "type": "flex",
    "rate": 1.15,
    "investamt": 10.00000000,
    "interestearned": 0.00031507,
    "nextinterestpayouttime": 1610632800000,
    "starttime": 0,
    "endtime": 0,
    "duration": 86400000,
    "payoutlocktime": 300000,
    "autorenew": false,
    "compounding": true,
    "autorenewsupported": false,
    "dailylimit": 0,
    "redemptionprocessing": false
  }
]

get /api/v3.2/invest/orders

query investment orders

response content

name type required description
id integer yes order id
name string yes product name
currency string yes currency
type string yes product type
rate boolean yes interest rate
investamt boolean yes amount
interestearned boolean yes intereset earned
nextinterestpayouttime boolean yes next interest payout time
starttime boolean yes start time
endtime boolean yes end time
duration boolean yes duration
payoutlocktime boolean yes lock time of payout
autorenew boolean yes renew automatically
compounding boolean yes is compounding
autorenewsupported boolean yes is renew automatically supported
redemptionprocessing boolean yes is redemption processing

query investment history

response

[
  {
    "txntime": 1598918400000,
    "name": "usdt flex savings",
    "currency": "usdt",
    "rate": 0.5,
    "type": "flex",
    "txntype": "invest_service_type_deposit",
    "amount": 100,
    "totalamount": 2000,
    "interestearned": 1.22,
    "duration": 0
  }
]

get /api/v3.2/invest/history

query investment history

response content

name type required description
txntime integer yes transaction time
name string yes product name
currency string yes currency
rate string yes interest rate
type boolean yes product type
txntype boolean yes transaction type
amount boolean yes transaction amount
totalamount boolean yes total amount of the investment
interestearned boolean yes interest earned
duration boolean yes duration

websocket streams

subscription

request

{
  "op": "subscribe",
  "args": [
    "orderbookapi:btc-usd_0"
  ]
}

response

{
  "event": "subscribe",
  "channel": [
    "orderbookapi:btc-usd_0"
  ]
}

to subscribe to a websocket feed

request parameters

name type required description
op string yes operation. subscribe will subscribe to the topics provided in args. unsubscribe will unsubscribe from the topics
args array yes topics to subscribe to.

response content

Name Type Required Description
event string Yes Respond with the event type
channel array Yes Topics which have been sucessfully subscribed

Orderbook Snapshot (By grouping)

Request

{
  "op": "subscribe",
  "args": [
    "orderBookApi:BTC-USD_0"
  ]
}

Response

{
  "topic": "orderBookApi",
  "data": {
    "buyQuote":
    [
      {
        "price": 0,
        "size": 0
      }
    ],
    "sellQuote":
    [
      {
        "price": 0,
        "size": 0
      }
    ],
    "symbol":"BTC-USD",
    "timestamp":1565135165600
  }
}

Subscribe to the Orderbook in different groupings. The format to subscribe to will be symbol_grouping.

Response Content

Orderbook Object

Name Type Required Description
topic string Yes Websocket topic
data Data Object Yes Refer to data object below

Data Object

Name Type Required Description
buyQuote Quote Object Yes Bid quotes
sellQuote Quote Object Yes Asks quotes
symbol string Yes Market symbol
timestamp long Yes Orderbook timestamp

Orderbook Snapshot (By depth)

Request

{
  "op": "subscribe",
  "args": [
    "orderBookL2Api:BTC-USD_0"
  ]
}

Response

{
  "topic": "orderBookL2Api",
  "data": {
    "buyQuote":
    [
      {
        "price": 0,
        "size": 0
      }
    ],
    "sellQuote":
    [
      {
        "price": 0,
        "size": 0
      }
    ],
    "symbol":"BTC-USD",
    "depth": 0,
    "timestamp":1565135165600
  }
}

Subscribe to the Level 2 Orderbook. The format to subscribe to will be symbol_depth.

Response Content

Orderbook Object

Name Type Required Description
topic string Yes Websocket topic
data Data Object Yes Refer to data object below

Data Object

Name Type Required Description
buyQuote Quote Object Yes Bid quotes
sellQuote Quote Object Yes Asks quotes
symbol string Yes Market symbol
depth int Yes Orderbook depth
timestamp long Yes Orderbook timestamp

Orderbook Incremental Updates

Request

{
  "op": "subscribe",
  "args": [
    "update:BTC-USD"
  ]
}
{
  "op": "unsubscribe",
  "args": [
    "update:BTC-USD"
  ]
}

Response

{
  "topic": "update:BTC-USD",
  "data": {
    "bids": [
      [
        "59252.5",
        "0.06865"
      ],
      [
        "59249.0",
        "0.24000"
      ],
      [
        "59235.5",
        "0.16073"
      ],
      [
        "59235.0",
        "0.26626"
      ],
      [
        "59233.0",
        "0.50000"
      ]
    ],
    "asks": [
      [
        "59292.0",
        "0.50000"
      ],
      [
        "59285.5",
        "0.24000"
      ],
      [
        "59285.0",
        "0.15598"
      ],
      [
        "59282.5",
        "0.06829"
      ],
      [
        "59278.5",
        "0.01472"
      ]
    ],
    "seqNum": 628282,
    "prevSeqNum": 628281,
    "type": "snapshot",
    "timestamp": 1565135165600,
    "symbol": "BTC-USD"
  }
}
{
  "topic": "update:BTC-USD",
  "data": {
    "bids": [],
    "asks": [
      [
        "59367.5",
        "2.15622"
      ],
      [
        "59325.5",
        "0"
      ]
    ],
    "seqNum": 628283,
    "prevSeqNum": 628282,
    "type": "delta",
    "timestamp": 1565135165600,
    "symbol": "BTC-USD"
  }
}

Subscribe to Orderbook incremental updates through the endpoint wss://ws.btse.com/ws/oss/spot. The topic to subscribe to will be update specifying the symbol (eg. update:BTC-USD). The first response received will be a snapshot of the current orderbook (this is indicated in the type field) and 50 levels will be returned. Incremental updates will be sent in subsequent packets with type delta.

Bids and asks will be sent in price and size tuples. The size sent will be the new updated size for the price. If a value of 0 is sent, the price should be removed from the local copy of the orderbook.

To ensure that the updates are received in sequence, seqNum indicates the current sequence and prevSeqNum refers to the packet before. seqNum will always be one after the prevSeqNum. If the sequence is out of order, you will need to unsubscribe and re-subscribe to the topic again.

Also if crossed orderbook ever occurs when the best bid higher or equal to the best ask, please unsubscribe and re-subscribe to the topic again.

Response Content

Orderbook Object

Name Type Required Description
topic string Yes Websocket topic
data Data Object Yes Refer to data object below

Data Object

Name Type Required Description
bids Quote Object Yes Bid quotes
asks Quote Object Yes Asks quotes
seqNum int Yes Current sequence number
prevSeqNum int Yes Previous sequence number
type string Yes snapshot - Snapshot of the orderbook with a maximum of 50 levels
delta - Updates of the orderbook
timestamp long Yes Timestamp of the orderbook
symbol string Yes Orderbook symbol

Public Trade Fills

Request

{
  "op": "subscribe",
  "args": [
    "tradeHistoryApi:BTC-USD"
  ]
}

Response

{
  "topic": "tradeHistoryApi:BTC-USD",
  "data": [
  {
    "symbol": "BTC-USD",
    "side": "SELL",
    "size": 0.007,
    "price": 5302.8,
    "tradeId": 118974855,
    "timestamp": 1584446020295
  }
  ]
}

Subscribe to recent trade feed for a market. The topic will be tradeHistoryApi:<market> where <market> is the market symbol.

Response Content

TradeHistory Object

Name Type Required Description
topic string Yes Websocket topic
data Data Object Yes Refer to data object below

Data Object

Name Type Required Description
symbol string Yes Market symbol
side string Yes Trade Side, BUY or SELL
size double Yes Transacted size
price double Yes Transacted price
tradeId long Yes Trade sequence Id
timestamp long Yes Trade timestamp

Authentication

Request

{
  "op":"authKeyExpires",
  "args":["APIKey", "nonce", "signature"]}
}

Authenticate the websocket session to subscribe to authenticated websocket topics. Assume we have values as follows:

Our subscription request will be:

{
  "op":"authKeyExpires",
  "args":["4e9536c79f0fdd72bf04f2430982d3f61d9d76c996f0175bbba470d69d59816x", "1624985375123", "c410d38c681579adb335885800cff24c66171b7cc8376cfe43da1408c581748156b89bcc5a115bb496413bda481139fb"]}
}

Request Parameters

Below details the arguments needed to be sent in.

Index Type Required Description
0 string Yes First argument is the API key
1 long Yes Nonce which is the current timestamp
2 string Yes Generated signature

Generating a signature

echo -n "/ws/spot1624985375123"  | openssl dgst -sha384 -hmac "848db84ac252b6726e5f6e7a711d9c96d9fd77d020151b45839a5b59c37203bx"
(stdin)= c410d38c681579adb335885800cff24c66171b7cc8376cfe43da1408c581748156b89bcc5a115bb496413bda481139fb

Notifications

Request

{
  "op": "subscribe",
  "args": [
    "notificationApiV2"
  ]
}

Response

{
  "topic": "notificationApiV2",
  "data": [
    {
      "symbol": "Market Symbol (eg. BTC-USD)",
      "orderID": "BTSE internal order ID",
      "side": "BUY",
      "type": "76",
      "price": "Order price or transacted price",
      "size": "Order size or transacted size",
      "originalSize": "Order size",
      "avgFillPrice": 35000,
      "fillSize": 0.001,
      "status": "<Refer to Status description on the left>",
      "clOrderID": "<Client order ID>",
      "maker": "<Maker flag, if true indicates that trade is a maker trade>",
      "stealth": 1,
      "timestamp": 1624985375123,
      "pegPriceDeviation": "Indicate the deviation percentage. Valid for only algo orders.",
      "remainingSize": "<Remaining size on the order>",
      "time_in_force": "<Time where this order is valid>",
      "txType": "STOP | TAKE_PROFIT",
      "triggerPrice": "Trade Trigger Price"
    }
  ]

}

Receive trade notifications by subscribing to the topic notificationApiV2. The websocket feed will push trade level notifications to the subscriber. If topic is subscribed without being authenticated, no messages will be sent.

Response Content

Name Type Required Description
symbol string Yes Market symbol
orderID string Yes Internal order ID
side string Yes Trade side. BUY or SELL
type int Yes Order type. Valid values are:
76: Limit Order
77: Market Order
80: Algo orders
price double Yes Order price or transcated price
size double Yes Order size or transacted size
originalSize double Yes Original order size
avgFilledPrice double Yes Average filled price
fillSize double Yes Filled size of order
status integer Yes Status with values as follows:
1: MARKET_UNAVAILABLE, Market is currently unavailable
2: ORDER_INSERTED, Order is inserted successfully
4: ORDER_FULLY_TRANSACTED, Order is fully transacted
5: ORDER_PARTIALLY_TRANSACTED, Order is partially transacted
6: ORDER_CANCELLED, Order is cancelled successfully
8: INSUFFICIENT_BALANCE, Insufficient balance in account
9: TRIGGER_INSERTED, Trigger Order is inserted successfully
10: TRIGGER_ACTIVATED, Trigger Order is activated successfully
12: ERROR_UPDATE_RISK_LIMIT, Error in updating risk limit
15: ORDER_REJECTED, Change made to the order was unsuccessful
27: TRANSFER_SUCCESSFUL, Transfer funds between futures and spot is successful
28: TRANSFER_UNSUCCESSFUL, Transfer funds between spot and futures is unsuccessful
41: ERROR_INVALID_RISK_LIMIT, Invalid risk limit was specified
64: STATUS_LIQUIDATION, Account is undergoing liquidation
101: FUTURES_ORDER_PRICE_OUTSIDE_LIQUIDATION_PRICE, Futures order is outside of liquidation price
1003: ORDER_LIQUIDATION, Order is undergoing liquidation
1004: ORDER_ADL, Order is undergoing ADL
clOrderID string Yes Custom order ID
maker boolean Yes Indicator to indicate if trade is a maker trade
remainingSize double Yes Remaining size on the order
time_in_force string Yes Validity of the order
timestamp long Yes Order timestamp or transacted timestamp
txType string Yes Used by trigger or OCO orders. STOP indicates its a Stop order, TAKEPROFIT indicates its a take profit order, and LIMIT is when its not any of the above
stealth double Yes Percentage of orders to show on orderbook. Only for Algo orders
pegPriceDeviation double Yes Deviation percentage. Only for Algo orders

User Trade Fills

Request

{
    "op":"subscribe",
    "args":["fills"]
}

Response

{
  "topic": "fills",
  "data": [{
    "orderId": "order id", //string
    "serialId": "serial ID after insertion into DB", //integer / long
    "clOrderId": "Client Order ID", //string
    "type": "order type", //string
    "symbol": "ex: BTC-USD", //string
    "side": "BUY|SELL" //string
    "price": "filled price", //double (need to make sure no scientific notation)
    "size": "filled size", //double (no scientific notation)
    "feeAmount": "Fees charged to user, value to be String on API", //double (no scientific notation)
    "feeCurrency": "Fee currency, eg. Buy would be BTC, Sell would be USD" //string
    "base": "Base currency, eg. BTC",  //string
    "quote": "Quote currency eg. USD", //string
    "maker": "maker or taker",  //boolean (if maker, return true, else return false)
    "timestamp": "Time trade was matched in the engine" //long, field taken from DB,
    "tradeId": "Trade Unique ID"
  }]
}


When a trade has been transacted, this topic will send the trade information back to the subscriber.

Response Content

Name Type Required Description
symbol string Yes Market symbol
orderID string Yes Internal order ID
clOrderID string Yes Custom order ID
serialId string Yes Trade sequence ID
tradeId string Yes Trade unique identifier
type int Yes Order type. Valid values are:
76: Limit Order
77: Market Order
80: Algo orders
side string Yes Trade side. BUY or SELL
price double Yes Transcated price
size double Yes Transacted size
feeAmount double Yes Fee amount charged
feeCurrency string Yes Fee currency
base string Yes Base currency
quote string Yes Quote currency
maker boolean Yes Indicator to indicate if trade is a maker trade
timestamp long Yes Order timestamp or transacted timestamp