WSSws-auth.kraken.com/v2executions
The executions channel streams order status and execution events for this account.
It corresponds to a combination of the following Websockets v1 channels: openOrders and ownTrades.
This channel contains account specific data, an authentication token is required in the request.
Subscribe
- Request
- Response
string
required
Value:
subscribeobject
required
Hide properties
Hide properties
string
required
Value:
executionsboolean
One of:
Default:
true, falseDefault:
falseIf true, the last 50 order fills will be included in snapshot.boolean
One of:
Default:
true, falseDefault:
trueIf true, open orders will be included in snapshot.boolean
One of:
Default:
true, falseDefault:
trueIf true, all possible status transitions will be sent. Otherwise, only open / close transitions will be streamed: new, filled, canceled, expired.boolean
One of:
Default:
Condition: Effective for viewing xStocks onlyIf
true, falseDefault:
trueCondition: Effective for viewing xStocks onlyIf
true, display in terms of underlying equity, otherwise display in terms of SPV tokens.boolean
One of:
Default:
true, falseDefault:
falseIf true, the rate-limit counter is included in the stream.string
One of:
Condition: Available on master accounts onlyIf
allCondition: Available on master accounts onlyIf
all, events for master and subaccounts are streamed, otherwise only master account events are published. No snapshot is provided.boolean
deprecated
One of:
Deprecated: Use ‘snap_trades’ fieldIf
true, falseDeprecated: Use ‘snap_trades’ fieldIf
true, snapshot provides only trade events. Otherwise, open orders and trades will be included in snapshot.boolean
deprecated
One of:
Deprecated: Use ‘snap_orders’ or ‘snap_trades’ fieldRequest a snapshot after subscribing.
true, falseDeprecated: Use ‘snap_orders’ or ‘snap_trades’ fieldRequest a snapshot after subscribing.
string
required
Authentication token. See authentication guide for details.
integer
Optional client originated request identifier sent as acknowledgment in the response.
string
required
Value:
subscribeobject
Hide properties
Hide properties
string
required
Value:
executionsboolean
One of:
true, falseIndicates if a snapshot of orders is requested.boolean
One of:
true, falseIndicates if a snapshot of trades is requested.integer
Specifies the max rate counter value for the user transaction rate. It is based on user tier.
boolean
deprecated
Deprecated: Use ‘snap_trades’ and ‘snap_orders’Indicates if a snapshot is requested.
string[]
An advisory message, highlighting deprecated fields or upcoming changes to the channel.
boolean
Indicates if the request was successfully processed by the engine. One of:
true, falsestring
Error message. Condition: if
success is false.string
The timestamp when the subscription was received on the wire, just prior to parsing data. Format: RFC3339. Example:
2022-12-25T09:30:59.123456Zstring
The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data. Format: RFC3339. Example:
2022-12-25T09:30:59.123456Zinteger
Optional client originated request identifier sent as acknowledgment in the response.
Snapshot / Update
The snapshot and update stream share the same data schema, the fields included in the message is dependant on theexec_type.
By default, the snapshot response contains all open orders and latest 50 trades.
The snapshot message content can be adjusted with the subscription parameters.
string
Value:
executionsstring
One of:
snapshot, updateobject[]
A list of execution reports: order status and fills.
Hide properties
Hide properties
boolean
One of:
true, falseIndicates if the order has been amended, the modification history can be extracted from the REST OrderAmends endpoint. This field is present in the snapshot and the amended, restated event types.float
Order’s average fill price.
float
Order volume expressed in quote currency (if specified on the original order).
string
Optional client identifier associated with the order.
object
The contingent object describes the template for generating the secondary close orders when the primary order fills.
Hide properties
Hide properties
string
One of:
limit, stop-loss, stop-loss-limit, take-profit, take-profit-limit, trailing-stop, trailing-stop-limitDescribes the order type of the secondary orders which will be created on each fill.float
Condition: Only on triggered secondary order typesDescribes the trigger price amount on the secondary orders. This field is used in combination with the
contingent.trigger_price_type field to determine the effective trigger price.string
One of:
Condition: Only on triggered secondary order typesDescribes trigger price units on the secondary orders.
static, pct, quoteCondition: Only on triggered secondary order typesDescribes trigger price units on the secondary orders.
static: a static market price for the asset, i.e. 30000 for BTC/USD.pct: a percentage offset from the reference price, i.e. -10% from index price.quote: a notional offset from the reference price in the quote currency, i.e, 150 BTC/USD from last price.
float
Condition: Only on secondary order types that support limit priceDescribes limit price amount on the secondary orders. This field is used in combination with the
contingent.limit_price_type field to determine the effective limit price.string
One of:
Condition: Only on secondary order types that support limit priceDescribes limit price units on the secondary orders.
static, pct, quoteCondition: Only on secondary order types that support limit priceDescribes limit price units on the secondary orders.
static: a static market price for the asset, i.e. 30000 for BTC/USD.pct: a percentage offset from the reference price, i.e. -10% from index price.quote: a notional offset from the reference price in the quote currency, i.e, 150 BTC/USD from last price.
float
Condition: trade events onlyValue of an individual execution.
float
The order cumulative value executed.
float
The order cumulative executed quantity.
float
Display quantity for iceberg order types.
float
Condition: Iceberg OrderIndicates next display_qty in Iceberg order.
string
Format: RFC3339
Example:
Example:
2022-12-25T09:30:59.123456ZScheduled start time of the order.string
Condition: trade events onlyExecution identifier.
string
One of:
pending_new, new, trade, filled, iceberg_refill, canceled, expired, amended, restated, statusDescribes the type of order event and determines the set of fields in the message.pending_new: Order request has been received and validated but the order is not live yet.new: Order has been created and is live in the engine.trade: The order has received a fill.filled: The order has been fully filled.canceled: The order has been cancelled.iceberg_refill: Indicates an Iceberg order refill.expired: The order has expired.amended: There is a user initiated amend on the order, i.e. limit price change.restated: There is a engine initiated amend on the order for maintenance of position or book, seereasonfield, i.e. reduce non-tradable liquidity.status: The order has a status update, i.e. trigger price has been updated.
string
Format: RFC3339
Example:
Example:
2022-12-25T09:30:59.123456ZScheduled expiration time of the order.string
Format: UUIDAn optional, external partner order identifier shown on order events.
string
Format: UUIDAn optional, external partner execution identifier shown on trade events.
object[]
string
The preferred currency for paying fees.
fcib: prefer fee in base currency.fciq: prefer fee in quote currency.
float
The total fee paid in USD.
float
Limit price for order types that support limit price restriction.
boolean
Indicates if the order has been liquidated by the engine.
string
One of:
m, tThe liquidity indicator: t taker, m maker.float
Condition: trade events onlyThe average price in this trade event.
float
Condition: trade events onlyThe quantity filled in this trade event.
boolean
Indicates if the order can be funded on margin.
boolean
Indicates if an execution is on margin, i.e. if the trade increased or reduced size of margin borrowing. On trade events only.
boolean
Indicates if the order has market price protection.
string
Referral order transaction id that created this order.
string
Unique order identifier generated by Kraken.
float
The client order quantity.
string
One of:
limit, market, iceberg, stop-loss, stop-loss-limit, take-profit, take-profit-limit, trailing-stop, trailing-stop-limit, settle-positionThe execution model of the order.string
Describes current state of the order.
pending_new: Order has been received but not yet created by the engine.new: Order is live but has no fills.partially_filled: Order is live and some fills.filled: The order has been fully filled.canceled: The order has been cancelled.expired: The order has expired.
integer
Optional numeric, client identifier associated with one or more orders.
boolean
One of:
true, falseIndicates a post only order.string
One of:
opened, closing, closedIndicates status of the position on a margin order.integer
Condition: Published when request parameters have ‘ratecounter=true’The value of the user’s trading rate-limit counter at the time of the event, as evaluated by the trading engine.
string
The reason associated with an event, if applicable.
boolean
One of:
true, falseIndicates a reduce only order.string
For institutional accounts, identifies underlying sub-account/trader for Self Trade Prevention (STP).
string
One of:
buy, sellSide of the order.string
Example:
"BTC/USD"The symbol of the currency pair.string
One of:
GTC, GTD, IOC, FOKTime-in-force specifies how long an order remains in effect before being expired.GTC: Good Till CanceledGTD: Good Till DateIOC: Immediate Or CancelFOK: Fill Or Kill
string
Format: RFC3339
Example:
Example:
2022-12-25T09:30:59.123456ZTime of the event.integer
The trade identifier.
object
Describes the parameters and status of the price trigger for triggered order types.
Hide properties
Hide properties
string
One of:
index, lastThe reference price tracked for triggering orders.float
Specifies the amount for the trigger price - it supports both static market prices and relative prices. This field is used in combination with the
price_type field below to determine the effective trigger price.string
One of:
static, pct, quoteThe units for the trigger price.static: a static market price for the asset, i.e. 30000 for BTC/USD.pct: a percentage offset from the reference price, i.e. -10% from index price.quote: a notional offset from the reference price in the quote currency, i.e, 150 BTC/USD from last price.
float
The current value of the effective trigger price, this is useful if the trigger was entered using a relative price or the trigger price changes over time.
float
The peak / trough price on
trailing-stop and trailing-stop-limit orders.float
On trigger activation, the value of the reference last price that triggered the order.
string
One of:
triggered, untriggeredThe status is set to triggered when the trigger conditions are met and the order becomes active.string
Format: RFC3339
Example:
Example:
2022-12-25T09:30:59.123456ZOn trigger activation, the timestamp of the trigger event.string
Example:
Condition: Published when request parameters have ‘users=all’The Kraken generated identifier for a user / sub-account.
AA96N74GCGEFN8KICondition: Published when request parameters have ‘users=all’The Kraken generated identifier for a user / sub-account.
string
deprecated
Deprecated: Use ‘reason’ fieldCancellation reason.
float
deprecated
Deprecated: Use ‘triggers’ objectThe stop price for triggered order types.
string
deprecated
One of:
Deprecated: Use ‘triggers’ objectReference price for triggered order types.
index, lastDeprecated: Use ‘triggers’ objectReference price for triggered order types.
float
deprecated
Deprecated: Use ‘triggers’ objectPrice which triggered the order.
integer
The subscription message sequence number.
Unsubscribe
- Request
- Response
string
required
Value:
unsubscribeobject
required
Hide properties
Hide properties
string
required
Value:
executionsstring
required
Authentication token. See authentication guide for details.
integer
Optional client originated request identifier sent as acknowledgment in the response.
string
required
Value:
unsubscribeboolean
Indicates if the request was successfully processed by the engine. One of:
true, falsestring
Error message. Condition: if
success is false.string
The timestamp when the subscription was received on the wire, just prior to parsing data. Format: RFC3339. Example:
2022-12-25T09:30:59.123456Zstring
The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data. Format: RFC3339. Example:
2022-12-25T09:30:59.123456Zinteger
Optional client originated request identifier sent as acknowledgment in the response.