Get Order By ID

v1.orders.get_order_by_id(, ) -> OrderGetOrderByIDResponse

GET/v1/accounts/{account_id}/orders/{order_id}

Get Order By ID

ParametersExpand Collapse

account_id: int

order_id: str

ReturnsExpand Collapse

class OrderGetOrderByIDResponse: …

data: Order

A trading order with its current state and execution details.

This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.

id: str

Engine-assigned unique identifier for this order (UUID).

account_id: int

Account placing the order

formatint64

client_order_id: str

Client-provided identifier echoed back (FIX tag 11).

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time

filled_quantity: str

Cumulative filled quantity

instrument_id: str

OEMS instrument UUID for the traded instrument.

formatuuid

instrument_type: SecurityType

Type of security

One of the following:

"COMMON_STOCK"

"PREFERRED_STOCK"

"OPTION"

"CASH"

"OTHER"

leaves_quantity: str

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:

"MARKET"

"LIMIT"

"STOP"

"STOP_LIMIT"

"TRAILING_STOP"

"TRAILING_STOP_LIMIT"

"OTHER"

quantity: str

Total order quantity

side: Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:

"BUY"

"SELL"

"SELL_SHORT"

"OTHER"

status: OrderStatus

Current status of the order

One of the following:

"PENDING_NEW"

"NEW"

"PARTIALLY_FILLED"

"FILLED"

"CANCELED"

"REJECTED"

"EXPIRED"

"PENDING_CANCEL"

"PENDING_REPLACE"

"REPLACED"

"DONE_FOR_DAY"

"STOPPED"

"SUSPENDED"

"CALCULATED"

"OTHER"

symbol: str

Trading symbol

time_in_force: TimeInForce

Time in force instruction

One of the following:

"DAY"

"GOOD_TILL_CANCEL"

"IMMEDIATE_OR_CANCEL"

"FILL_OR_KILL"

"GOOD_TILL_DATE"

"AT_THE_OPENING"

"AT_THE_CLOSE"

"GOOD_TILL_CROSSING"

"GOOD_THROUGH_CROSSING"

"AT_CROSSING"

"OTHER"

updated_at: datetime

Timestamp of the most recent update (UTC)

formatdate-time

venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time

extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed)

limit_price: Optional[str]

Limit price (for LIMIT and STOP_LIMIT orders)

queue_state: Optional[QueueState]

Parent order queue state, present when the order is awaiting release or released.

One of the following:

"AWAITING_RELEASE"

"RELEASED"

releases_at: Optional[datetime]

Scheduled release time for orders awaiting release.

formatdate-time

stop_price: Optional[str]

Stop price (for STOP and STOP_LIMIT orders)

trailing_limit_px: Optional[str]

Current trailing limit price computed by the trailing strategy

trailing_offset: Optional[str]

Trailing offset amount for trailing orders

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type for trailing orders

One of the following:

"PRICE"

"BPS"

trailing_stop_px: Optional[str]

Current trailing stop price computed by the trailing strategy

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders

formatdate-time

underlying_instrument_id: Optional[str]

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid

Get Order By ID

from clear_street import ClearStreet

client = ClearStreet(
    api_key="My API Key",
)
response = client.v1.orders.get_order_by_id(
    order_id="order_id",
    account_id=0,
)
print(response)

{
  "data": {
    "account_id": 19816,
    "average_fill_price": "149.95",
    "created_at": "2025-10-31T13:30:00.000000000Z",
    "filled_quantity": "50",
    "id": "my-ref-id-20251001-001",
    "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
    "instrument_type": "COMMON_STOCK",
    "leaves_quantity": "50",
    "limit_price": "150.00",
    "order_type": "LIMIT",
    "quantity": "100",
    "side": "BUY",
    "status": "PARTIALLY_FILLED",
    "stop_price": null,
    "symbol": "AAPL",
    "time_in_force": "DAY",
    "updated_at": "2025-10-31T13:35:10.000000000Z"
  },
  "error": null,
  "metadata": {
    "request_id": "0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

{
  "error": {
    "code": 404,
    "message": "Order 97dfdcfe503f425c8367ca10928e2499 not found for account 100001"
  },
  "metadata": {
    "request_id": "efbd46f4-4bfc-455b-bae0-ee13f84360ba"
  }
}

Returns Examples

{
  "data": {
    "account_id": 19816,
    "average_fill_price": "149.95",
    "created_at": "2025-10-31T13:30:00.000000000Z",
    "filled_quantity": "50",
    "id": "my-ref-id-20251001-001",
    "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
    "instrument_type": "COMMON_STOCK",
    "leaves_quantity": "50",
    "limit_price": "150.00",
    "order_type": "LIMIT",
    "quantity": "100",
    "side": "BUY",
    "status": "PARTIALLY_FILLED",
    "stop_price": null,
    "symbol": "AAPL",
    "time_in_force": "DAY",
    "updated_at": "2025-10-31T13:35:10.000000000Z"
  },
  "error": null,
  "metadata": {
    "request_id": "0c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

{
  "error": {
    "code": 404,
    "message": "Order 97dfdcfe503f425c8367ca10928e2499 not found for account 100001"
  },
  "metadata": {
    "request_id": "efbd46f4-4bfc-455b-bae0-ee13f84360ba"
  }
}