Skip to main content

Currency Conversion

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

Request for stream of currency conversion rates.

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 Conversion stream configuration.

name string required
Value: CurrencyConversion

Subscription name.

EquivalentCurrency string required

Quote currency to base the conversion rates on.

Currencies array [

List of currencies and securities to generate conversion rates for; defaults to all available currencies.

]
Throttle string

Optional throttle interval for conversion rate updates. Minimal/default value: 10s.

Tolerance string

Optional param to indicate what conversion rate percent change should trigger sending out an update. Minimal/default value: 0.0001 which means 1 bps.

]

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 CurrencyConversion data.

Timestamp string required

Timestamp of message publication.

EquivalentCurrency string required

Currency symbol for equivalent currency.

Currency string required

Currency symbol for base currency on conversion.

Rate string required

Currency conversion rate.

Status string required

Status of the conversion rate.

ConversionPath string required

Path used for the conversion.

]