Skip to main content
GET
Get an account's order event timeline

Authorizations

X-API-Key
string
header
required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Path Parameters

accountId
string
required

The account whose order events to retrieve

Query Parameters

from
string

Only events at or after this time (ISO 8601)

to
string

Only events at or before this time (ISO 8601)

eventType
string

Comma-separated event types to include. One or more of: planned, submit_requested, validated, accepted, replace_requested, cancel_requested, fill_partial, fill_final, cancelled, rejected, expired, bracket_auto_resized. Default: all

Pattern: ^(planned|submit_requested|validated|accepted|replace_requested|cancel_requested|fill_partial|fill_final|cancelled|rejected|expired|bracket_auto_resized)(,(planned|submit_requested|validated|accepted|replace_requested|cancel_requested|fill_partial|fill_final|cancelled|rejected|expired|bracket_auto_resized))*$
orderId
string

Only events of this order (the orderId from this endpoint or id / orderId from the orders endpoint)

includeReverted
boolean
default:false

Include events voided by a Time Machine revert (they carry revertedAt)

cursor
string

Pass pagination.nextCursor from the previous response to get the next (older) page

limit
integer
default:100
Required range: 1 <= x <= 500

Response

Success - Returns the account's order events, newest first

success
boolean
Example:

true

data
object