Skip to main content

Currency

CHANNEL
wss://wss.prime.kraken.com/ws/v1
currency

Request for stream of available currencies used within trading. On initial request, a snapshot of all available currencies is provided. All subsequent messages are deltas to the currency snapshot.

Subscribe Request​

reqid number required

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

type string required
Value: subscribe

Request type.

streams array [ required

Array containing the Currency stream configuration.

name string required
Value: Currency

Subscription name.

Symbols array [

Optional list of currency symbols to filter the subscription on.

]
]

Response​

reqid number required

A number that relates this response to a request.

type string required

The type of message sent.

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.

seqNum number required

The sequence number for this response per request.

action string

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

data array [ required

Array of Currency data.

Timestamp string required

Timestamp of message publication in ISO-8601 UTC format.

UpdateAction string required
Possible values: [Update, Remove]

"Update" or "Remove" where the latter indicates the Currency is no longer available.

CurrencyID string required

System ID for Currency - for information only.

Symbol string required

Symbol for currency.

MinIncrement string required

Minimum increment for Currency.

DefaultIncrement string required

Default increment used in all Market Data and Orders.

Description string required

Description of Currency.

]