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":[ "PI_XBTUSD", "FI_ETHUSD_210625" ] } |
Sample Return if Successful. (A result message is received per product id) |
{ {
|
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 |
{ } { |
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 |
maturityTime | positive integer |
Maturity time in milliseconds |
Sample Return if Unsuccessful |
{ "event":"error", "message":"Invalid product id" } |
Field |
Type | Description |
event | string | Always error |
message | string |
An error message out of:
|