Skip to main content

Documentation Index

Fetch the complete documentation index at: https://kraken-sandbox.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

WSSfutures.kraken.com/ws/v1ticker_lite
The ticker_lite feed returns ticker information about listed products. Delta messages are throttled such that they are published every 1s.

​
Request

​
event
string
required
subscribe or unsubscribe
​
feed
string
required
The requested subscription feed. Value: ticker_lite
​
product_ids
list of strings
required
A list of strings which represent the products that user will receive information upon.
{
  "event": "subscribe",
  "feed": "ticker_lite",
  "product_ids": ["PF_XBTUSD", "PF_ETHUSD"]
}

​
Response Success

​
event
string
One of: subscribed, subscribed_failed, unsubscribed, unsubscribed_failedThe result.
​
feed
string
The requested subscription feed. Value: ticker_lite
​
product_ids
list of strings
required
A list of strings which represent the products that user will receive information upon.
{
  "event": "subscribed",
  "feed": "ticker_lite",
  "product_ids": ["PF_XBTUSD"]
}

​
Response Snapshot

​
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 perpetual, month, quarter, or semiannual. 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.
​
volumeQuote
positive float
The same as volume except that, for multi-collateral futures, it is converted to the non-base currency.
​
greeks
structure
The current Greeks, if this is an option.
{
  "feed": "ticker_lite",
  "product_id": "PF_XBTUSD",
  "bid": 34932,
  "ask": 34949.5,
  "change": 3.3705205220015966,
  "premium": 0.1,
  "volume": 264126741,
  "tag": "perpetual",
  "pair": "XBT:USD",
  "dtm": 0,
  "maturityTime": 0,
  "volumeQuote": 264126741
}

​
Response Error

​
event
string
Value: error
​
message
string
One of: Invalid product id, Invalid feed, Json ErrorAn error message.
{
  "event": "error",
  "message": "Invalid product id"
}