Skip to main content

instrument~{symbol}

CHANNEL 
wss://stream.crypto.com/fcm/v1/market
instrument~{symbol}
Single-instrument security definition snapshot. Subscribe with channel ["instrument~{symbol}"]. Returns a snapshot of the full instrument definition and current trading status on subscribe.

Request​

Body

required
    id integerrequired

    Request id

    method stringrequired

    Possible values: [subscribe]

    params objectrequired
    channels string[]required

    e.g. ["instrument~symbol"]

    nonce integerrequired

    Current timestamp in milliseconds

WebSocket response
Schema
    id int64
    method string
    code int32
    result object
    subscription string
    channel string
    l boolean

    Last-batch flag; true on the final batch of the snapshot (instrumentall only)

    data object[]
  • Array [
    • i stringrequired

    Instrument symbol

    sid string

    Security id

    d string

    Security description

    ccy string

    Currency

    mt string

    Maturity date (YYYYMMDD)

    p string

    Possible values: [COMMODITIES, CURRENCIES, EQUITY_IND, EVENTS, CROPS, EARNINGS, ECONOMIC_DERIV, ENERGY, HOUSING_PRICES, HURRICANES, MERGERS, MORTGAGE_RATES, REVENUES, DIGITAL_CURRENCIES, POLITICS, ECONOMIC_IND]

    Product / underlying product type

    tp string

    Security type

    subtp string

    Security sub-type (omitted when unset)

    op string

    Option payout type (omitted when unset)

    ex string

    Exchange (omitted when unset)

    spx string

    Strike price (omitted when unset)

    mpx string

    Minimum price increment (tick size)

    uom string

    Unit of measure (omitted when unset)

    cpx string

    Cap price (omitted when unset)

    fpx string

    Floor price (omitted when unset)

    und object[]
    Underlyings (omitted when empty)
  • Array [
    • ust string

    Underlying stip / product type

    usym string

    Underlying symbol

    uaid string

    Underlying security alt id

    umt string

    Underlying maturity month-year

  • ]
    • atts object
    Instrument attributes keyed by attribute name to string value (omitted when none). Known keys: OPEN_TIME, CLOSE_TIME, SETTLED_DATETIME, PERIOD_CODE, PERIOD_INDEX, STRIKE_OPERATOR, STRIKE_INDEX, DISPLAY_PRECISION, UNDERLYING_ROUNDING_VALUE, UNDERLYING_MONTH. Only attributes set on the instrument appear — any subset may be present.
    property name* string
    ed object

    Event definition nested JSON document (EVENT products only)

    s stringrequired

    Possible values: [OPEN, CLOSED, SETTLED, UNKNOWN]

    Trading status

  • ]