Account Information

Get account order detail

Changed on

Returns the detail of a single order, identified by the brokerage order ID in the path, in the same kind-discriminated format as /accounts/{accountId}/orders/all.

The order carries a legs list with at least one leg; switch on legs[].instrument.kind and order_type.kind to know which fields are present. Multi-leg orders are a single order with multiple legs.

This endpoint is always realtime and does not rely on cached data, except that an order in a terminal state (executed, canceled, rejected, failed, expired, replaced) may be served from a short-lived cache since it can no longer change.

This endpoint only returns orders placed through SnapTrade. In other words, orders placed outside of the SnapTrade network are not returned by this endpoint.

Beta: this endpoint and its response schema may change.

get/accounts/{accountId}/orders/{brokerageOrderId}

Request

  • Base URL
    https://api.snaptrade.com
  • Auth
    API key in header Signature and API key in query parameter clientId and API key in query parameter timestamp

Path parameters

accountIdstring uuid required

Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.

Example:917c8734-8470-4a3e-a18f-57c3f2ee6631
brokerageOrderIdstring required

Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.

Example:66a033fa-da74-4fcf-b527-feefdec9257e

Query parameters

userIdstring required

SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.

Example:snaptrade-user-123
userSecretstring required

SnapTrade User Secret. This is a randomly generated string and should be stored securely. If compromised, please rotate it via the rotate user secret endpoint.

Example:adf2aa34-8219-40f7-a6b3-60156985cc61

Response

OK

brokerage_order_idstring required

Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.

status'PENDING' | 'REJECTED' | 'CANCELED' | 'CANCEL_PENDING' | 'PARTIAL_CANCELED' | 'EXECUTED' | 'PARTIALLY_EXECUTED' | 'REPLACED' | 'REPLACE_PENDING' | 'EXPIRED' required

Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.

time_in_force'DAY' | 'GTC' | 'FOK' | 'IOC' | 'GTD' | 'MOO' | 'EHP' | 'EHA' | 'OTHER' required

How long the order remains active. Brokerage values that cannot be mapped to this list are returned as OTHER.

  • DAY - valid only for the trading day on which it is placed.
  • GTC - Good Til Canceled.
  • FOK - Fill Or Kill.
  • IOC - Immediate Or Cancel.
  • GTD - Good Til Date; see expiry_date.
  • MOO - Market On Open.
  • EHP - Extended Hours P.M.
  • EHA - Extended Hours A.M.
  • OTHER - the brokerage reported a value outside this list.
expiry_datestring date-time nullable

When the order expires, for orders with a time_in_force of GTD.

price_effect'CREDIT' | 'DEBIT' | 'EVEN' | 'UNKNOWN' required

Direction of the net order price when applicable.

total_quantitystring decimal nullable

Total quantity requested. For multi-leg orders this is the number of spreads, not the sum of leg quantities.

filled_quantitystring decimal nullable

Quantity filled so far.

canceled_quantitystring decimal nullable

Quantity canceled.

open_quantitystring decimal nullable

Quantity still open (not yet filled or canceled).

execution_pricestring decimal nullable

Average execution price. Per unit for single-leg orders; net price per spread for multi-leg orders.

time_placedstring date-time nullable

The time the order was submitted to the brokerage, when the brokerage reports it.

time_updatedstring date-time nullable

The time the order was last updated at the brokerage, when available.

time_executedstring date-time nullable

The time the order was executed, when available.

Example response

{
  "brokerage_order_id": "66a033fa-da74-4fcf-b527-feefdec9257e",
  "order_type": {
    "kind": "market"
  },
  "time_in_force": "DAY",
  "expiry_date": "2026-07-30T22:51:49Z",
  "priced_in": {
    "kind": "cash",
    "code": "EUR"
  },
  "total_quantity": "10",
  "filled_quantity": "9",
  "canceled_quantity": "1",
  "open_quantity": "0",
  "execution_price": "12.34",
  "time_placed": "2026-07-30T22:51:49Z",
  "time_updated": "2026-07-30T22:52:10Z",
  "time_executed": "2026-08-05T00:05:57Z",
  "group": {
    "id": "1234567890",
    "role": "TRIGGER"
  },
  "legs": [
    {
      "instrument": {
        "kind": "stock",
        "id": "1ef3a5d3-4a9b-40b2-b8d1-cc35f74d6324",
        "symbol": "AAPL",
        "raw_symbol": "AAPL",
        "description": "Apple Inc.",
        "currency": "USD",
        "exchange": "XNAS",
        "figi_instrument": {
          "figi_code": "BBG000B9Y5X2",
          "figi_share_class": "BBG001S5N8V8"
        }
      },
      "total_quantity": "10",
      "filled_quantity": "9",
      "canceled_quantity": "1",
      "execution_price": "12.34"
    }
  ]
}

Changes