AVS Developer Docs

Appearance

Get Orders​

GET
/orders

Parameters​

Header Parameters

X-API-KEY*
Type
string
Required

Query Parameters

account_number*
Type
string
Required
security_type*

Must be CS (equities) or OPT (options)

Type
string
Required
status

can filter on a single status or multiple statuses using a comma-separated list without spaces in between each status -- e.g. new, dispatched, canceled, filled,partially_filled, new,dispatched, canceled,canceled_after_partial_fill,rejected, etc.

Type
string
symbol

e.g. AMD 251219P00140000

Type
string
order_ids

comma-separated list

Type
string
after

Timestamp filter. Accepts multiple formats including RFC3339 (e.g. 2024-07-12T00:00:00Z) and YYYY-MM-DD. Defaults to 48 hours ago if not provided. Max range between after and until is 31 days.

Type
string
until

Timestamp filter. Accepts multiple formats including RFC3339 (e.g. 2024-07-12T23:59:59Z) and YYYY-MM-DD. Defaults to current time if not provided. Max range between after and until is 31 days.

Type
string
page

first page is page 1

Type
integer
page_size

default is 500, max is 500

Type
string

Responses​

Ordered by time_placed descending

application/json
JSON
{
  
"orders": [
  
  
{
  
  
  
"av_order_id": "2eee349f-3db5-49bd-8a81-d3678667aeb2",
  
  
  
"average_price": "10",
  
  
  
"order_id": "clordid",
  
  
  
"order_type": "limit",
  
  
  
"limit_price": "10",
  
  
  
"quantity": "1",
  
  
  
"quantity_filled": "1",
  
  
  
"notional_filled": "10",
  
  
  
"side": "buy",
  
  
  
"status": "filled",
  
  
  
"symbol": "AMD",
  
  
  
"position_effect": "open",
  
  
  
"time_placed": "2022-12-12T07:13:12-05:00",
  
  
  
"order_completion_time": "2022-12-12T07:13:15-05:00",
  
  
  
"initiator": "MOCK_OMNI",
  
  
  
"time_in_force": "day"
  
  
}
  
],
  
"page": 1,
  
"page_size": 500
}

Playground​

Headers
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI