Skip to main content

Open Orders

CHANNEL
wss://futures.kraken.com/ws/v1
open_orders

This subscription feed publishes information about user open orders.

Request​

MESSAGE BODY

event string required
subscribe or unsubscribe
feed string required
The requested subscription feed open_orders
api_key string required
The user api key
original_challenge string required
The message that is received from a challenge request
signed_challenge string required
The signed challenge message with user api secret

Response Success​

MESSAGE BODY

event string
The result, subscribed or subscribed_failed or unsubscribed or unsubscribed_failed
feed string
The requested subscription feed open_orders
api_key string
The user api key
original_challenge string
The message that is received from a challenge request
signed_challenge string
The signed challenge message with user api secret

Response Snapshot​

MESSAGE BODY

feed string
The subscribed feed
account string
The user account
orders list of structures
The user new order
instrument string
The instrument (referred also as symbol or product_id) of the order
time positive integer
The UTC time in milliseconds.
last_update_time positive integer
The UTC time in milliseconds that the order was last updated
qty positive float
The quantity or the order.
filled positive float
The total amount of the order that is filled.
limit_price positive float
The limit price of the order.
stop_price positive float
The stop price of the order.
type string
The order type, limit, take_profit, or stop
order_id UUID
The order id.
cli_ord_id UUID
The unique client order identifier. This field is returned only if the order has a client order id.
direction integer
The direction of the order, either 0 for a buy order or 1 for a sell order.
reduce_only boolean
If true, the order can only reduce open positions, it cannot increase or open new positions.
triggerSignal string
Trigger signal selected for take profit or stop loss order. Options are last, mark, or spot. Returned only for take profit or stop loss orders.
trailing_stop_options list of structures
If this order is a trailing stop, this contains its parameters
max_deviation double
The maximum distance the trigger price may be away from the trigger signal.
unit string
The unit of the deviation, one of:
percent
quote_currency

Response Delta​

MESSAGE BODY

feed string
The subscribed feed
order structure
The user new order
instrument string
The instrument (referred also as symbol or product_id) of the order
time positive integer
The UTC time in milliseconds.
last_update_time positive integer
The UTC time in milliseconds that the order was last updated
qty positive float
The quantity or the order.
filled positive float
The total amount of the order that is filled.
limit_price positive float
The limit price of the order.
stop_price positive float
The stop price of the order.
type string
The order type, limit, take_profit, or stop
order_id UUID
The order id.
cli_ord_id UUID
The unique client order identifier. This field is returned only if the order has a client order id.
direction integer
The direction of the order, either 0 for a buy order or 1 for a sell order.
reduce_only boolean
If true, the order can only reduce open positions, it cannot increase or open new positions.
triggerSignal string
Trigger signal selected for take profit or stop loss order. Options are last, mark, or spot. Returned only for take profit or stop loss orders.
trailing_stop_options list of structures
If this order is a trailing stop, this contains its parameters
max_deviation double
The maximum distance the trigger price may be away from the trigger signal.
unit string
The unit of the deviation, one of:
percent
quote_currency
is_cancel boolean
If false the open order has been either placed or partially filled and needs to be updated. If true the open order was either fully filled, cancelled or rejected (for post-only). If it was filled or cancelled it must be removed from open orders snapshot.
reason string
Reason behind the received delta.
new_placed_order_by_user: User placed a new order
liquidation: User position liquidated. The order cancelled
stop_order_triggered: A stop order triggered. The system removed the stop order
limit_order_from_stop: The system created a limit order because an existing stop order triggered
partial_fill: The order filled partially
full_fill: The order filled fully and removed
cancelled_by_user: The order cancelled by the user and removed
contract_expired: The order contract expired. All open orders of that contract removed
not_enough_margin: The order removed due to insufficient margin
market_inactive: The order removed because market became inactive
cancelled_by_admin: The order removed by administrator's action
dead_man_switch: The order removed because dead man's switch was triggered
ioc_order_failed_because_it_would_not_be_executed: The immediate or cancel order was rejected due to insufficient liquidity
post_order_failed_because_it_would_filled: The post only order was rejected as it crosses the spread and would be immediately filled
would_execute_self: The order was rejected as it would execute against another order from the same account
would_not_reduce_position: The order was rejected as it the reduce-only option was selected and it would not reduce the position
order_for_edit_not_found: The order edit was rejected as the order to be edited could not be found

Response Error​

MESSAGE BODY

event string
Always error
message string
An error message out of:
Invalid feed
Json Error