Sign in

v44

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-20129390589.6 KB
Orders

List Orders

List active and historical orders

get/v0/orders

Query parameters

side'buy' | 'sell'

Filter by order side (buy or sell)

instance_typestring
Example:h100i

Filter by instance type

min_priceinteger

Minimum price in cents

max_priceinteger

Maximum price in cents

min_start_datestring date-time

An ISO 8601 datetime string

Example:2025-07-11T20:41:37.423Z

Minimum start date

max_start_datestring date-time

An ISO 8601 datetime string

Example:2025-07-11T20:41:37.423Z

Maximum start date

min_durationinteger

Unix timestamp.

Example:1738972800

Minimum duration in seconds

max_durationinteger

Unix timestamp.

Example:1738972800

Maximum duration in seconds

min_quantityinteger

Minimum quantity

max_quantityinteger

Maximum quantity

contract_idstring
Example:cont_k3R-nX9vLm7Qp2Yw5Jd8F

Filter by contract ID

only_openboolean

Show only open orders

exclude_filledboolean

Exclude filled orders

only_filledboolean

Show only filled orders

min_filled_atstring date-time

An ISO 8601 datetime string

Example:2025-07-11T20:41:37.423Z

Minimum filled at date

max_filled_atstring date-time

An ISO 8601 datetime string

Example:2025-07-11T20:41:37.423Z

Maximum filled at date

min_fill_priceinteger

Minimum fill price in cents

max_fill_priceinteger

Maximum fill price in cents

exclude_cancelledboolean

Exclude cancelled orders

only_cancelledboolean

Show only cancelled orders

min_cancelled_atstring date-time

An ISO 8601 datetime string

Example:2025-07-11T20:41:37.423Z

Minimum cancelled at date

max_cancelled_atstring date-time

An ISO 8601 datetime string

Example:2025-07-11T20:41:37.423Z

Maximum cancelled at date

min_placed_atstring date-time

An ISO 8601 datetime string

Example:2025-07-11T20:41:37.423Z

Minimum placed at date

max_placed_atstring date-time

An ISO 8601 datetime string

Example:2025-07-11T20:41:37.423Z

Maximum placed at date

limitinteger

Maximum number of results to return (default: 100, max: 100)

offsetinteger

Number of results to skip

sort_by'created_at' | 'start_time'

Sort field for listing orders

Example:created_at

Sort field

sort_direction'ASC' | 'DESC'

Sort direction for listing orders

Example:ASC

Sort direction

{"stackTrail":"paths:/v0/orders:get:parameters:28:schema","oasType":"schema","type":"unknown"}

Response

List of orders

object'list' required
has_moreboolean required

Example response

{
  "object": "list",
  "data": [
    {
      "object": "order",
      "id": "ordr_k3R-nX9vLm7Qp2Yw5Jd8F",
      "instance_type": "h100i",
      "quantity": 4,
      "start_at": "2025-07-11T20:41:37.423Z",
      "end_at": "2025-07-11T20:41:37.423Z",
      "price": 2850000,
      "executed_at": "2025-07-11T20:41:37.423Z",
      "cancelled_at": "2025-07-11T20:41:37.423Z",
      "colocate_with": [
        "cont_k3R-nX9vLm7Qp2Yw5Jd8F"
      ],
      "created_at": "2025-07-11T20:41:37.423Z",
      "cluster": "richmond",
      "duration": 1738972800
    }
  ]
}