Skip to main content
GET
Get order health signals

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

account_id
string<uuid>

Trading account ID. Omitted, the window covers every account in the organization

environment
enum<string>
required

Required. Which environment the read covers. Resolved to the organization's accounts in that environment, including disabled and deleted ones, since the ledger stores no environment of its own. Rejected with 400 when it disagrees with the account named alongside it.

Available options:
paper,
live
days
integer<int64>
required

Trailing day count for the amendment distribution. Clamped to 1..=90, then to the window the caller's plan grants

symbol
string

Filter by symbol. Symbols are normalized to uppercase; a blank value is treated as no filter

stuck_minutes
integer<int64>

How long an order must have rested to count as stuck. Defaults to 15, clamped to 1..=1440

Response

Health signals retrieved

Order-level health signals that describe a window rather than a series.

amendments
object[]
required

The amendment distribution over the requested window, ascending, with every bucket present up to and including the cap.

An amendment is any command issued against an order after the one that placed it, which includes the cancel that ends it, so an order replaced once and then cancelled reports two. The distribution is read for its shape near zero rather than as a count of replaces alone.

stuck_count
integer<int64>
required

How many were found, which can exceed stuck_orders.len(). The list is capped so one wedged account cannot return an unbounded response.

Required range: x >= 0
stuck_minutes
integer<int64>
required

The threshold the list was built with, echoed back so a caller does not have to remember what it asked for to label the result.

stuck_orders
object[]
required

Orders still open past the staleness threshold, oldest first.