Ticker Lite

The ticker lite feed returns ticker information about listed products

Authentication is not required.

Feed

Event Type

Perimissible API Keys
ticker_lite
subscribe / unsubscribe
N/A
Sample Sent Message
{  
    "event":"subscribe",
    "feed":"ticker_lite",
    "product_ids":[  
        "FI_XBTUSD_180921",
        "FV_XRPXBT_180615"
    ]
}

 

Sample Return if Successful. (A result message is received per product id)

{  
    "event":"subscribed ",
    "feed":"ticker_lite",
    "product_ids":[  
        "FI_XBTUSD_180921"
    ]
}

{  
    "event":"subscribed",
    "feed":"ticker_lite",
    "product_ids":[  
        "FV_XRPXBT_180615"
    ]
}

 

Field

Type Description
event
string The result, subscribed or subscribed_failed or
unsubscribed or unsubscribed_failed
feed string The requested subscription feed
product_ids list of strings A list of strings which represent the products that user will
receive information upon

 

Sample Subscription Data
{  
   "feed":"ticker_lite",
   "product_id":"FI_XBTUSD_180525",
   "bid":9425.0,
   "ask":9434.0,
   "change":-0.2,
   "premium":1.2,
   "volume":6288487.0,
   "tag":"month",
   "pair":"XBT:USD",
   "dtm":14
}

Field

Type Description
feed string The subscribed feed
product_id string The subscribed product (referred also as instrument or symbol)
bid positive float

The price of the current best bid

ask positive float

The price of the current best ask

change float

The 24h change in price

premium float

The premium associated with the product

volume positive float

The sum of the sizes of all fills observed in the last 24 hours

tag string

Currently can be 'week', 'month' or 'quarter'. Other tags may be added without notice.

pair string

The currency pair of the instrument

dtm integer

The days until maturity

 

Sample Return if Unsuccessful 
{  
    "event":"error",
    "message":"Invalid product id"
}

Field

Type Description
event string Always error
message string

An error message out of:

  • Invalid product id
  • Invalid feed
  • Json Error