Skip to main content
GET
/
api
/
v1
/
orders
List orders
curl --request GET \
  --url https://staging.zerolatencylabs.com/api/v1/orders \
  --header 'X-API-KEY: <api-key>'
[
  {
    "account_id": 1024,
    "expires_at": null,
    "id": "018f9a3c-7b2e-7c1a-9f3d-2a4b6c8d0e1f",
    "initial_size": "0.5",
    "market": "BTC-PERP",
    "order_status": "OPEN",
    "order_type": "LIMIT",
    "portfolio_index": 0,
    "post_only": false,
    "price": "65000.0",
    "reduce_only": false,
    "remaining_size": "0.5",
    "side": "LONG",
    "subaccount_index": 0,
    "time_in_force": "GTC"
  }
]

Authorizations

​
X-API-KEY
string
header
required

Base64-encoded API key issued by POST /api/v1/api-keys.

Query Parameters

​
portfolio_index
integer<int32>
Required range: x >= 0
​
limit
integer<int64>
default:100

Maximum number of orders to return. Must be between 1 and 1000; defaults to 100.

Required range: 1 <= x <= 1000
​
offset
integer<int64>
default:0

Number of orders to skip from the start of the result set. Must be >= 0; defaults to 0.

Required range: x >= 0

Response

Matching orders

​
account_id
integer<int64>
required

A system-generated unique identifier for an account.

Required range: x >= 0
​
portfolio_index
integer<int32>
required

A unique identifier for a portfolio within a subaccount.

Required range: x >= 0
​
subaccount_index
integer<int32>
required

A unique identifier for a subaccount within an account.

Required range: x >= 0
​
id
string<uuid>
required

The unique identifier of the order

Example:

"0190b6c2-7e4a-7c3b-9f21-2b6a1c4e5d8f"

​
initial_size
string
required

The initial size of the order in base asset units

Example:

"0.50"

​
market
string
required

The symbol of the market (e.g. BTC-PERP)

Example:

"BTC-PERP"

​
order_status
enum<string>
required

The current status of the order (Open, Filled, Canceled, etc.)

Available options:
OPEN,
FILLED,
CANCELED,
REJECTED,
UNTRIGGERED,
PARTIALLY_FILLED,
EXPIRED
​
order_type
enum<string>
required

The type of the order (Market, Limit, etc.)

Available options:
MARKET,
LIMIT,
STOP_LIMIT,
STOP_MARKET,
TAKE_PROFIT,
TAKE_PROFIT_MARKET,
LIQUIDATE,
AUTO_DELEVERAGE
​
post_only
boolean
required

Whether the order is post-only

Example:

false

​
reduce_only
boolean
required

Whether the order is reduce-only

Example:

false

​
remaining_size
string
required

The remaining size of the order in base asset units

Example:

"0.50"

​
side
enum<string>
required

The side of the order (Long or Short)

Available options:
LONG,
SHORT
​
time_in_force
enum<string>
required

The time-in-force policy (IOC, FOK, GTC, or GTT).

Available options:
IOC,
FOK,
GTC,
GTT
​
expires_at
null | integer<int64>

The instant the order expires. Present only for GTT orders; null for IOC, FOK, and GTC.

This is kept separate from time_in_force because JavaScript clients parse 64-bit integers as floats, which cannot represent the GTC sentinel.

Required range: x >= 0
​
price
string | null

The limit price of the order in quote asset units (e.g. USDC)

Example:

"65000.00"