Subscribe

Send a subscription request to begin a stream of data from the Prime WebSocket API.

Public channel. Connect to: wss://wss.prime.kraken.com/ws/v1

Send a subscription request to begin a stream of data. An example request that subscribes to data.

Request

Request Schema

reqid · number · required

Request ID - will be echoed back in the response structure.

type · string · required

Request type for initializing a subscription. Value: subscribe

tag · string

Optional user generated tag to attach to stream data.

streams · array · required

Streams to subscribe to.

Show properties

name · string · required

Subscription name (e.g., “Security”, “MarketDataSnapshot”, “ExecutionReport”).

... · various

Any required or optional parameters described for the subscription names.

ts · string

An ISO-8601 UTC string of the form 2019-02-13T05:17:32.000000Z.

Example

{
  "reqid": 1,
  "type": "subscribe",
  "streams": [
    {
      "name": "MarketDataSnapshot",
      "Symbol": "BTC-USD"
    }
  ],
  "ts": "2019-02-13T05:17:32.000000Z"
}

Response

Response Schema

reqid · number · required

A number that relates this response to a request.

seqNum · number · required

The sequence number for this response per request. seqNum begins at 1 on the first message with this reqid and increments by one for each message sent on this reqid.

type · string · required

The type of message sent. This document describes all valid message types.

tag · string

An optional tag from the stream request.

ts · string · required

An ISO-8601 UTC string of the form 2019-02-13T05:17:32.000000Z.

initial · boolean

If this is initial data for a request, the initial flag will be set.

action · string

“Update” or “Remove” - tells the client if the given entity should be removed or added/updated.

total_count · number

The total number of records for this stream.

data · array · required

Array of response data structured per subscription type.

next · string

If paging, tag for next page of data.

Example

{
  "reqid": 1,
  "seqNum": 1,
  "type": "MarketDataSnapshot",
  "action": "Update",
  "data": [
    {
      "Symbol": "BTC-USD",
      "Status": "Online",
      "Bids": [
        {
          "Price": "46817.27965000",
          "Size": "1.00000000"
        }
      ],
      "Offers": [
        {
          "Price": "46868.59755873",
          "Size": "1.00000000"
        }
      ]
    }
  ],
  "ts": "2019-02-13T05:17:32.000000Z"
}

Notes

• reqid cannot be equal to 0.
• seqNum is for debug purposes only, the client is not required to do any sequencing.
• If a request requires responses with different types, then multiple responses may have the initial flag set for different types.
• action is either Update or Remove and tells the client if the given entity should be removed or added/updated. The key for a given entity depends on the message type.