Skip to content

get_orders_blotter

GET
/admin/orders
curl --request GET \
--url http://localhost:3001/admin/orders \
--header 'Authorization: Bearer <token>'
status
string
nullable
portfolio_id
string format: uuid
nullable
instrument_id
string
nullable
principal_id
string format: uuid
nullable
broker_connection_code
string
nullable
side
string
nullable
since
string format: date-time
nullable
until
string format: date-time
nullable
limit
integer format: int64
nullable
offset
integer format: int64
nullable
client_order_id
string
nullable

Free-text reference set at submit time — not unique, so this can match several rows sharing one strategy’s generated tag.

OK

Media typeapplication/json
Array<object>
object
account_id
required
string format: uuid
avg_px
number format: double
nullable
broker_connection_code
required
string
client_order_id
required
string
created_at
required
string format: date-time
cum_qty
required
number format: double
instrument_id
required
string
instrument_name
string
nullable
instrument_symbol
string
nullable
leaves_qty
required
number format: double
order_id
required
string format: uuid
order_type
required
string
original_qty
required
number format: double
portfolio_code
required
string
portfolio_id
required
string format: uuid
principal_code
required
string
principal_id
required
string format: uuid
side
required
string
status
required
string
updated_at
required
string format: date-time

Example generated

[
{
"account_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"avg_px": 1,
"broker_connection_code": "example",
"client_order_id": "example",
"created_at": "2026-04-15T12:00:00Z",
"cum_qty": 1,
"instrument_id": "example",
"instrument_name": "example",
"instrument_symbol": "example",
"leaves_qty": 1,
"order_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"order_type": "example",
"original_qty": 1,
"portfolio_code": "example",
"portfolio_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"principal_code": "example",
"principal_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"side": "example",
"status": "example",
"updated_at": "2026-04-15T12:00:00Z"
}
]