Product Info - symbol

Description

Send symbol snapshot immediately after first subscription.

Pushing Frequency

Real Time

Channel

symbol

Request Parameters

Parameter	Required	Type	Description
event	Yes	String	Operation: subscribe, unsubscribe
channel	Yes	String	symbol
symbols	Yes	Array	trading pair array

Request Response:

Parameter	Type	Description
event	String	Operation: subscribe, unsubscribe
channel	String	symbol
symbols	Array	trading pair array
message	String	Error message

Push Data

Parameter	Type	Description
channel	String	symbol
data	Array	The subscribed data
> s	String	A trading pair, consisting of two currencies: base currency and quote currency
> visibleST	String	Visible startTime
> tradableST	String	Tradable startTime
> pxScale	String	Price precision, with X decimal places retained.
> lotSz	Integer	Order size precision. The amount of futures trades is measured in Cont, while the amount of spot trades is measured in the base currency.
> minSz	Integer	Minimum order size. The amount of futures trades is measured in Cont, while the amount of spot trades is measured in the base currency.
> ctVal	String	Contract face value, e.g., 0.001 BTC (per contract) - applicable only to futures trading
> status	Integer	Trading status. 0: Delisted; 1: Listed; 2: Pending; 3: Settlement; 4: Suspended
> maxPx	String	maximum price of an order
> minPx	String	minimum price of an order
> maxQty	String	Maximum size of an order
> minQty	String	Minimum size of an order
> maxLever	String	Maximum leverage
> lever	String	Default leverage
> ctType	String	Contract type - Linear: linear futures - Inverse: inverse futures - Applicable only to Delivery/Perpetual
> alias	String	THIS_WEEK: This week NEXT_WEEK: Next week THIS_MONTH: This month NEXT_MONTH: Next month QUARTER：This quarter NEXT_QUARTER: Next quarter
> bAsset	String	Underlying asset (e.g. BTCUSD index)
> bCcy	String	Base currency - In the BTCUSDT trading pair, it is BTC.
> qCcy	String	Quote currency - In the BTCUSDT trading pair, it is USDT.
> sCcy	String	Settlement currency
> tSz	String	Tick size. The minimum price movement of a symbol in the market, e.g., it is 0.001 for BTC.
> oDate	String	Listing date
> iM	String	Initial margin rate
> mM	String	Maintenance margin rate
> mR	String	Maximum risk limit
> ts	Long	Push time (millisecond)

Request Example

{
  "event": "subscribe",
  "channel": ["symbol"],
  "symbols": ["BTC_USDT_PERP"]
}

Push Data Example

{
    "channel": "symbol",
    "data": [
        {
            "symbol": "BTC_USDT_PERP",
            "visibleStartTime": "1584721775000",
            "tradableStartTime": "1584721775000",
            "pxScale": "0.01,0.1,1,10,100",
            "lotSz": 1,
            "minSz": 1,
            "ctVal": "0.001",
            "status": "OPEN",
            "maxPx": "1000000",
            "minPx": "0.01",
            "maxQty": "1000000",
            "minQty": "1",
            "maxLever": "75",
            "lever": "20",
            "ctType": "LINEAR",
            "alias": "",
            "buyLmt": "",
            "sellLmt": "",
            "bAsset": ".PXBTUSDT",
            "bCcy": "BTC",
            "qCcy": "USDT",
            "sCcy": "USDT",
            "tSz": "0.01",
            "oDate": "1547435912000",
            "iM": "0.0133",
            "mR": "5000",
            "mM": "0.006"
        }
    ],
    "action": "snapshot"
}