Skip to main content

Security

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

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

Kraken maintains a security master which contains up-to-date information about the securities supported over API that are available to trade.

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

name string required
Value: Security

Subscription name.

Symbols array [

Optional list of 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 Security data.

Timestamp string required

Timestamp of message publication in ISO-8601 UTC format.

UpdateAction string required

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

SecurityID string required

System ID for Security - for information only.

Symbol string required

Symbol for security.

MinPriceIncrement string required

Minimum Price Increment for Security.

MinSizeIncrement string required

Minimum Size Increment for Security. This increment is used to validate orders and RFQS expressed in base currency of the security.

MinAmtIncrement string

Minimum Amount Increment for Security. This increment is used to validate orders and RFQS expressed in quote currency of the security.

MinimumSize string required

Minimum Size for an Order on this Security.

MaximumSize string

Maximum Size for an Order on this Security.

QuoteCurrency string required

Currency in which the Security is quoted.

BaseCurrency string required

Base currency for the Security.

EndTime string

Date this security was Disabled.

DefaultPriceIncrement string required

Default price increment used in all Market Data and Orders.

DefaultSizeIncrement string required

Default size increment used in all Market Data and Orders.

PriceDisplaySpec string required

String specification describing the price display.

SizeDisplaySpec string required

String specification describing the size display.

NormalSize string

Normal size of Security.

ProductType string

Product type of Security.

PositionCurrency string required

Currency in which any position on this Security is tracked.

SettlementCurrency string

Currency in which any settlement on this Security is negotiated.

NotionalMultiplier string

Notional Multiplier of Security.

Expiration string

Expiration of Security.

SizeBuckets array [ required

Default array of Size Buckets for Market Data Snapshot Streams.

]
DisplaySymbol string required

Display symbol for Security.

Description string required

Description of Security.

Rank number

Security rank.

]