Skip to main content

Order Updates

CHANNEL
wss://wss.prime.kraken.com/ws/v1
orderAuthentication Required

Request stream of Order updates. An Order update having a data field containing an array that has a similar structure to ExecutionReport.

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

name string required
Value: Order

Subscription name.

StartDate string

If provided, the subscription will return orders that were submitted after this time. An ISO-8601 UTC string of the form 2019-02-13T05:17:32.000000Z.

EndDate string

If provided, the subscription will return orders that were submitted before this time.

Symbol string

If provided, Symbol of the security to get the orders for.

Statuses array [

If provided, comma-separated Statuses of orders to include e.g. New,Filled.

]
OrderID string

If provided, filter by OrderID.

RFQID string

If provided, filter by RFQID.

]

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 Order data with a similar structure to ExecutionReport.

Timestamp string required

Timestamp of the message.

Symbol string required

Symbol of the order security.

OrderID string required

Server assigned Order ID, will be a UUID.

ClOrdID string required

Client assigned Order ID for the last request.

Side string required

"Buy" or "Sell".

ExecType string required

Describes the specific execution.

OrdStatus string required

Identifies current status of order.

OrderQty string required

Order quantity.

OrdType string required

Order type.

Currency string required

Currency of Quantity.

CustomerUser string

The customer user associated with this order.

]