Contract API

Base Info

The base url

Name	base endpoint
market-api	https://api-futures.trubit.com/market/api/v1
trade-api	https://api-futures.trubit.com/trade/api/v1
market-websocket	wss://api-futures.trubit.com/ws/market
trade-websocket	wss://api-futures.trubit.com/ws/trade

Time zone

The time zone for all times is UTC+0

WebSocket Overview

WebSocket is a new protocol for HTML5, which enables full-duplex communication between the client and the server, allowing data to travel in both directions quickly. The client and server connections can be established through a simple handshake, and the server can actively push information to the client according to the business rules. The advantages are as follows:

• When the client and the server perform data transmission, the request header information is relatively small, about 2 bytes.

• Both the client and the server can actively send data to the other party.

• There is no need to create TCP requests and destroy multiple times, saving bandwidth and server resources.

Market Endpoint

Contract info

Exchange trading rules and symbol information

Limit:

Speed limit: 1 times/second, Speed limit rule: IP

Request Url:

GET /basic/refData

Parameters：

Name	Type	Required	Default	Description
------------	------------	------------	------------	----

Response:

Name	Type	Example	Description
symbol	string	XRPUSDT	Contract name
lotSize	float	1.0	Defines the minimum quantity allowed
tick	float	0.00001	Minimal price value
type	string	USDT	Contract type, PERP => Perpetual Contract.

Example:

{
  "code": 0,
  "message": "OK",
  "result": [
    {
      "lotSize": 1.0,
      "symbol": "MASKUSDT",
      "tick": 0.001,
      "type": "PERP"
    }
  ]
}

Klines

Obtain K line by from and step

Limit:

Speed limit: 15 times/1min, Speed limit rule: IP

Request URL:

GET /kLine/byFrom

Parameters：

Name	Type	Required	Default	Description
symbol	string	YES	--	The contract symbol
type	string	YES	--	Interval of the kline. Identifiable values: 1M, 3M, 5M, 10M, 15M, 30M, 1H, 2H, 4H, 6H, 8H, 12H, D, 3D, W, MTH
from	integer	NO	0	Start from of K line, 0 means from the latest one
step	integer	NO	--	The number of K line, equal or less than 1500

Response:

Name	Type	Example	Description
[0]	string	26435.5	Close Price
[1]	string	26435.5	High Price
[2]	string	1686905040	*1000 timestamp(ms)
[3]	string	26435.5	Low Price
[4]	string	26435.5	Open Price
[6]	string	7.08	Volume eg:BTCUSDT The unit is BTC
[7]	string	181074.0	Turnover eg:BTCUSDT The unit is USDT

Example:

{
    "code": 0,
        "message": "OK",
        "result": [
        [
            "25559.4",
            "25559.7",
            "1686905040",
            "25553.2",
            "25554.1",
            "1",
            "7.08",
            "181074.0"
        ]
    ]
}

Klines By Time

Obtain K line by time and step

Limit:

Speed limit: 15 times/1min, Speed limit rule: IP

Request URL:

GET /kLine/byTime

Parameters：

Name	Type	Required	Default	Description
symbol	string	YES	--	The contract symbol
type	string	YES	--	Interval of the kline. Identifiable values: 1M, 3M, 5M, 10M, 15M, 30M, 1H, 2H, 4H, 6H, 8H, 12H, D, 3D, W, MTH
from	integer	NO	currentTimeMillis	Milli seconds of K line keyTime, query from the latest one if not provided
step	integer	YES	--	The number of K line, equal or less than 1500

Response:

Name	Type	Example	Description
[0]	string	26435.5	Close Price
[1]	string	26435.5	High Price
[2]	string	1686905040	*1000 timestamp(ms)
[3]	string	26435.5	Low Price
[4]	string	26435.5	Open Price
[6]	string	7.08	Volume eg:BTCUSDT The unit is BTC
[7]	string	181074.0	Turnover eg:BTCUSDT The unit is USDT

Example:

{
    "code": 0,
        "message": "OK",
        "result": [
        [
            "25559.4",
            "25559.7",
            "1686905040",
            "25553.2",
            "25554.1",
            "1",
            "7.08",
            "181074.0"
        ]
    ]
}

Index

Index price of underlying asset

Limit:

Speed limit: 10 times/second, Speed limit rule: IP

Request Url:

GET /basic/indexPrice

Parameters：

Name	Type	Required	Default	Description
symbols	string	NO	--	The contract symbol, multiple symbols separated by ',', eg: BTCUSDT,ETHUSDT

Response:

Name	Type	Example	Description
symbol	string	BTCUSDT	The contract symbol
price	float	8342.73	The index price of the underlying
time	long	1686196441142	The time of the underlying

Example:

{
    "code": 0,
        "message": "OK",
        "result": [
        {
            "symbol": "BTCUSDT",
            "price": 26442.32666666667,
            "time": 1686209050099
        }
    ]
}

Last Price

Query last price of instrument(s)

Limit:

Speed limit: 1 times/second, Speed limit rule: IP

Request Url:

GET /basic/lastPrice

Parameters：

Name	Type	Required	Default	Description
symbols	string	NO	--	The contract symbol, multiple symbols separated by ',', eg: BTCUSDT,ETHUSDT

Response:

Name	Type	Example	Description
symbol	string	BTCUSDT	The contract symbol
price	float	8342.73	The last price
time	long	1686196441142	The time

Example:

{
    "code": 0,
        "message": "OK",
        "result": [
        {
            "price": 26627.7,
            "symbol": "BTCUSDT",
            "time": 1686304783617
        }
    ]
}

Mark Price

Query mark price of instrument(s)

Limit:

Speed limit: 10 times/second, Speed limit rule: IP

Request Url:

GET /basic/markPrice

Parameters：

Name	Type	Required	Default	Description
symbols	string	NO	``	The contract symbol, multiple symbols separated by ',', eg: BTCUSDT,ETHUSDT

Response:

Name	Type	Example	Description
symbol	string	BTCUSDT	The contract symbol
price	float	8342.73	The mark price
time	long	1686196441142	The time

Example:

{
    "code": 0,
        "message": "OK",
        "result": [
        {
            "price": 26627.7,
            "symbol": "BTCUSDT",
            "time": 1686304783617
        }
    ]
}

Funding Rate

Obtain funding rate of instrument

Limit:

Speed limit: 5 times/second, Speed limit rule: IP

Request Url:

GET /kLine/fundingRate

Parameters：

Name	Type	Required	Default	Description
symbols	string	NO	The contract symbol, multiple symbols separated by ',', eg: BTCUSDT,ETHUSDT

Response:

Name	Type	Example	Description
symbol	string	BTCUSDT	The contract symbol
rate	double	0.0001	Funding rate
date	string	2023-06-08T07:00:00.000+00:00	Time
time	long	1686196441142	Timestamp

Example:

{
    "code": 0,
        "message": "OK",
        "result": [
        {
            "symbol": "BTCUSDT",
            "rate": 0.0001,
            "date": "2023-06-08T08:00:00.000+00:00",
            "timestamp": 1686207600020
        }
    ]
}

Depth

Query market depth Snapshot & trades of instrument

Limit:

Speed limit: 10 times/second, Speed limit rule: IP

Request Url:

GET /depth/list

Parameters:

Name	Type	Required	Default	Description
symbol	string	YES	--	The contract symbol to be retrieved
level	integer	NO	20	The number(5/10/20) of entries returned for bids and asks

Response:

Name	Type	Example	Description
price	double	26418.5	Price
qty	double	18873.0	Positive integer, 1Qty=1USDT
count	int	1	Order count
iceCount	int	1	Ice Count

Example:

{
    "code": 0,
        "message": "OK",
        "result": {
        "buyDepth": [
            {
                "price": 26418.5,
                "qty": 50056.0,
                "count": 6,
                "iceCount": 0
            },
            {
                "price": 26418.4,
                "qty": 80489.0,
                "count": 6,
                "iceCount": 0
            },
            {
                "price": 26418.1,
                "qty": 58500.0,
                "count": 4,
                "iceCount": 0
            }
        ],
            "sellDepth": [
            {
                "price": 26418.8,
                "qty": 7797.0,
                "count": 2,
                "iceCount": 0
            },
            {
                "price": 26418.9,
                "qty": 9891.0,
                "count": 2,
                "iceCount": 0
            },
            {
                "price": 26419.0,
                "qty": 17483.0,
                "count": 5,
                "iceCount": 0
            },
            {
                "price": 26419.1,
                "qty": 19006.0,
                "count": 6,
                "iceCount": 0
            },
            {
                "price": 26419.2,
                "qty": 17266.0,
                "count": 6,
                "iceCount": 0
            }
        ],
            "trades": null
    }
}

trades

Retrieve the latest trades that have occurred for a specific contract.

Limit:

Speed limit: 10 times/second, Speed limit rule: IP

Request URL:

GET /depth/trades

Parameters：

Parameter	type	required	default	description
symbol	string	YES	--	The contract symbol
sequence	string	NO	--	Sequence of last trade id, retrieve all trades if value is null

Response:

Name	Type	Example	Description
id	string	1686213904404000035	Trade id
symbol	string	BTCUSDT	The contract symbol
price	double	1295.0	Price
qty	double	1295.0	The quantity traded
buyActive	boolean	true	True is the buyer's active order, false is the seller's active order
tms	long	1537797044116	timestamp (ms)

Example:

{
    "code": 0,
        "message": "OK",
        "result": [
        {
            "id": "1686213904404000035",
            "symbol": "BTCUSDT",
            "price": 26428.9,
            "qty": 1295.0,
            "buyActive": false,
            "timestamp": "2023-06-08T08:45:04.404+00:00",
            "tms": "1686213904404"
        },
        {
            "id": "1686213899234000003",
            "symbol": "BTCUSDT",
            "price": 26438.2,
            "qty": 2000.0,
            "buyActive": false,
            "timestamp": "2023-06-08T08:44:59.234+00:00",
            "tms": "1686213899234"
        },
        {
            "id": "1686213884863000003",
            "symbol": "BTCUSDT",
            "price": 26433.3,
            "qty": 9100.0,
            "buyActive": true,
            "timestamp": "2023-06-08T08:44:44.863+00:00",
            "tms": "1686213884863"
        }
    ]
}

Trade Statistics in latest 24 hours

Trade Statistics in latest 24 hours

Limit:

Speed limit: 10 times/second, Speed limit rule: IP

Request URL:

GET /kLine/tradeStatistics

Parameters：

Name	Type	Required	Default	Description
symbols	string	YES	--	The contract symbol, multiple symbols separated by ',', eg: BTCUSDT,ETHUSDT

Response:

Name	Type	Example	Description
'symbol'	string	BTCUSDT	The contract symbol
'lastPrice'	double	BTCUSDT	The contract symbol
'maxPrice'	double	26420.9	Max price
'minPrice'	double	25713.4	Min price
'priceChange'	double	-142.0	Price change
'priceChangeRatio'	double	-0.005437842019200944	Price change ratio
'volume'	double	6.5697459E7	eg:BTCUSDT The unit is BTC
'turnover'	double	2483.5865212475437	eg:BTCUSDT The unit is USDT

Example:

{
    "code": 0,
        "message": "OK",
        "result": [
        {
            "lastPrice": 25971.3,
            "maxPrice": 26420.9,
            "minPrice": 25713.4,
            "priceChange": -142.0,
            "priceChangeRatio": -0.005437842019200944,
            "symbol": "BTCUSDT",
            "turnover": 16171.504782381482,
            "volume": 4.19809141E8
        }
    ]
}

Open Position In Exchange

Total Open Position In Exchange

Limit:

Speed limit: 5 times/second, Speed limit rule: IP

Request URL:

GET /kLine/openInterest

Parameters：

Name	Type	Required	Default	Description
symbol	string	YES	--	The contract symbol

Response:

Name	Type	Example	Description
'symbol'	string	BTCUSDT	The contract symbol
'date'	double	2023-06-19T02:37:53.617+00:00	Time
'qty'	double	1084388.0	eg:BTCUSDT The unit is USDT
'value'	double	41.035743951380205	eg:BTCUSDT The unit is BTC

Example:

{
    "code": 0,
        "message": "OK",
        "result": {
        "symbol": "BTCUSDT",
            "value": 41.035743951380205,
            "date": "2023-06-19T02:37:53.617+00:00",
            "qty": 1084388.0
    }
}

Public Websocket Endpoints

Receiving data requires an event subscription

Kline

Parameters:

Name	Type	Required	Default	Description
op	string	YES	--	subscribe/unsubscribe
key	string	YES	--	The contract symbol
type	string	YES	--	1M, 3M, 5M, 10M, 15M, 30M, 1H, 2H, 4H, 6H, 8H, 12H, D, 3D, W, MTH
channel	string	YES	--	Channel

Example:

{
  "op": "subscribe",
  "key": "BTCUSDT",
  "type": "1M",
  "channel": "kLine"
}

Response:

Name	Type	Example	Description
[0]	string	26435.5	Close Price
[1]	string	26435.5	High Price
[2]	string	1686905040	*1000 timestamp(ms)
[3]	string	26435.5	Low Price
[4]	string	26435.5	Open Price
[6]	string	7.08	Volume eg:BTCUSDT The unit is BTC
[7]	string	181074.0	Turnover eg:BTCUSDT The unit is USDT

Example:

{
    "hisPrice": [
    "25557.4",
    "25557.7",
    "1686905100",
    "25557.4",
    "25557.5",
    "1",
    "0.69",
    "17681.0"
],
    "isNew": false,
    "key": "MEXO_BTCUSDT_1M"
}

Depth

Parameters:

Name	Type	Required	Default	Description
op	string	YES	--	subscribe/unsubscribe
key	string	YES	--	The contract symbol
channel	string	YES	--	Channel
### Example:
```json
{
"op": "subscribe",
"key": "BTCUSDT",
"channel": "depthUpdate"
}
```
### Response:
Name	Type	Example	Description
------------