> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kraken.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Open Orders
> Subscribe to real-time open order updates for the authenticated user
WSS
ws-auth.kraken.com
openOrders
The `openOrders` channel streams the open orders belonging to the authenticated user. The initial snapshot provides a list of all open orders, followed by real-time updates. For status change updates, such as `closed`, the fields `orderid` and `status` will be present in the payload.
## Subscribe
Value: `subscribe`
Value: `openOrders`
Session token from the GetWebSocketsToken REST endpoint.
One of: `false`, `true`
Default: `false`
Includes rate-limit counter in updates.
One of: `true`, `false`
Default: `true`
Condition: Effective for viewing xstocks only
If `true`, display in terms of underlying equity, otherwise display in terms of SPV tokens.
Optional client originated request identifier sent as acknowledgment in the response.
The subscription status is returned via the [subscriptionStatus](/exchange/api-reference/spot-websocket-v1/subscriptionstatus) message.
## Snapshot / Update
The snapshot and update responses share the same schema. The payload is a JSON array containing the order data, the channel name, and feed detail.
A list of order objects. Each object is keyed by the Kraken order identifier.
The key for each order is the Kraken order identifier.
Referral order transaction id that created this order.
An optional, numeric identifier associated with one or more orders.
An optional, alphanumeric client identifier associated with this order.
Format: UUID
An optional, external partner order identifier.
Status of order.
Unix timestamp of when order was placed.
Unix timestamp of order start time (if set).
Condition: Iceberg orders only
The reload quantity for iceberg order types.
Condition: Iceberg orders only
The visible quantity remaining in the book.
Unix timestamp of order end time (if set).
Parameters for the conditional close order (if attached).
Conditional close order type.
Primary price of the conditional close order.
Secondary price of the conditional close order.
Comma delimited list of order flags for the conditional close order. `fcib` = prefer fee in base currency, `fciq` = prefer fee in quote currency, `nompp` = no market price protection, `post` = post only order (available when ordertype = limit).
Order description info.
Asset pair.
Optional - position ID (if applicable).
Side of order (buy/sell).
Order type.
The limit price or trigger price depending on the order type:
* **limit** price for `limit` orders.
* **trigger** price for all triggered orders.
The **limit** price for `stop-loss-limit`, `take-profit-limit` and `trailing-stop-limit` orders.
Amount of margin leverage.
Indicates if the order is funded on margin.
Text summary of order.
Text summary of conditional order (if conditional close attached).
Unix timestamp of last change (for updates).
Volume of order (base currency unless viqc set in oflags).
Total volume executed so far (base currency unless viqc set in oflags).
Total cost (quote currency unless viqc set in oflags).
Total fee (quote currency).
Average price (cumulative; quote currency unless viqc set in oflags).
Stop price (for trailing stops).
Triggered limit price (after limit based order types are triggered).
A comma delimited list of miscellaneous info:
* `stopped`: triggered by stop price
* `touched`: triggered by touch price
* `liquidation`: liquidation event
* `partial`: partial fill
A comma delimited list of order flags:
* `viqc`: volume in quote currency
* `fcib`: prefer fee in base currency
* `fciq`: prefer fee in quote currency
* `nompp`: no market price protection
* `post`: post only order
For institutional accounts, identifies underlying sub-account/trader for Self Trade Prevention (STP).
One of: `GTC`, `GTD`, `IOC`, `FOK`
Default: `GTC`
Time-in-force specifies how long an order remains in effect before expiry.
* `GTC`: Good Till Canceled - until user has cancelled.
* `GTD`: Good Till Date - until `expiretm` parameter.
* `IOC`: Immediate Or Cancel - immediately cancels back any quantity that cannot be filled on arrival.
* `FOK`: Fill Or Kill - immediately fills the full order quantity or cancels it entirely.
Cancel reason, present for all cancellation updates (status="canceled") and for some close updates (status="closed").
Amendment reason, present for all amend events.
One of: `true`, `false`
Indicates if the order has been amended, the modification history can be extracted from the REST `OrderAmends` endpoint.
Rate-limit counter, present if requested in subscription request. See Trading Rate Limits.
Value: `openOrders`
Sequence number for this subscription.
```json Subscribe theme={null}
{
"event": "subscribe",
"subscription": {
"name": "openOrders",
"ratecounter": "true",
"token": "WW91ciBhdXRoZW50aWNhdGlvbiB0b2tlbiBnb2VzIGhlcmUu"
}
}
```
```json Snapshot / Update theme={null}
[
[
{
"OGTT3Y-C6I3P-XRI6HX": {
"avg_price": "34.50000",
"cost": "0.00000",
"descr": {
"close": "",
"leverage": "0:1",
"order": "sell 10.00345345 XBT/EUR @ limit 34.50000 with 0:1 leverage",
"ordertype": "limit",
"pair": "XBT/EUR",
"price": "34.50000",
"price2": "0.00000",
"type": "sell"
},
"expiretm": "0.000000",
"fee": "0.00000",
"limitprice": "34.50000",
"misc": "",
"oflags": "fcib",
"opentm": "0.000000",
"refid": "OKIVMP-5GVZN-Z2D2UA",
"starttm": "0.000000",
"status": "open",
"stopprice": "0.000000",
"userref": 0,
"vol": "10.00345345",
"vol_exec": "0.00000000"
}
}
],
"openOrders",
{
"sequence": 234
}
]
```
```json Status Update theme={null}
[
[
{
"OGTT3Y-C6I3P-XRI6HX": {
"status": "closed"
}
}
],
"openOrders",
{
"sequence": 59342
}
]
```