Instrument

Topic: /contract/instrument:{symbol}

Description

Subscribe this topic to get the mark Price, index Price or funding fee Rate

Push frequency: mark.index.price 1s, funding.rate 1min

{
  "id": 1545910660739,
  "type": "subscribe",
  "topic": "/contract/instrument:XBTUSDTM",
  "response": true
}

Response

Data Schema

instrument

topic

string

required

type

string

required

subject

enum<string>

required

Allowed values:

mark.index.pricefunding.rate

data

object

required

fundingRate

number

optional

markPrice

number

optional

indexPrice

number

optional

granularity

integer

required

Granularity (predicted funding rate: 1-min granularity: 60000; Funding rate: 8-hours granularity: 28800000.)

timestamp

integer <int64>

required

Example

//Mark Price & Index Price
{
    "topic": "/contract/instrument:XBTUSDTM",
    "type": "message",
    "subject": "mark.index.price",
    "data": {
        "markPrice": 90445.02,
        "indexPrice": 90445.02,
        "granularity": 1000,
        "timestamp": 1731899129000
    }
}
      
//Funding Rate
{
  "topic": "/contract/instrument:XBTUSDTM",
  "subject": "funding.rate",
  "data": {
    "granularity": 60000,
    "fundingRate": -0.002966,
    "timestamp": 1551770400000
  }
}

Request

Query Params

token

string

required

The token required to establish a websocket connection

Example:

2neAiuYvAU61ZDXANAGAsiL4-iAExhsBXZxftpOeh_55i3Ysy2q2LEsEWU64mdzUOPusi34M_wGoSf7iNyEWJ_cpz4VOPFmQFib6P8hYnrVkopegzA-XTtiYB9J6i9GjsxUuhPw3Blq6rhZlGykT3Vp1phUafnulOOpts-MEmEE_W_XygA1q6ypUyk3f_-aZJBvJHl5Vs9Y=.rIAVDSL657g7mnAiHkH5aA==

connectId

string

optional

Connection Id, a unique value taken from the client side. Both the id of the welcome message and the id of the error message are connectId.

Example:

121345

Topic: /contract/instrument:{symbol}#

Subscribe Message#

Response#

Request

Topic: /contract/instrument:{symbol}

Subscribe Message

Response