orders channel sends the orders of the account behind your API key: a snapshot right after login, then the whole order every time it changes.
Snapshot
Right afterlogin_ok, you receive:
orders holds every working order, plus every order that changed in the last 24 hours. Each order has the shape of GET /v1/orders/{id}.
Changes
Every change to an order sends the whole order again:id, keep the order with the highest version, and ignore one with a lower or equal version: the same version can arrive twice.
Resume
eventId exists for resuming. Keep the highest eventId you received, the snapshot’s included. When you reconnect, log in with it:
- Inside the window. At most 1 000 changes were missed and the oldest is less than 10 minutes old: the orders that changed are sent as
ordermessages, then the live changes follow. No snapshot is sent. - Outside the window. You receive
{ "type": "snapshot_required", "reason": "resume_window_exceeded", "channels": ["orders"] }, then a new snapshot. Replace what you held with it.
sinceEventId always starts with a snapshot.
Without the channel
A login that nameschannels without orders receives none of this. A login without channels covers every channel, orders included.