v44

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

Orders

List orders

⚠️ This endpoint is in public preview.

List all orders.

get/preview/v2/orders

Query parameters

idSfcApiOrderId[]

Filter by order ID (repeatable).

[
  "ordr_k3R-nX9vLm7Qp2Yw5Jd8F"
]

capacitystring

A resource path like 'sfc:capacity:acme:prod:my-capacity' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Example:cap_k3R-nX9vLm7Qp2Yw5Jd8F

Filter by capacity.

side'sell' | 'buy'

statusSfcApiOrderStatus[]

Filter by status (repeatable).

created_afterinteger

Unix timestamp.

Example:1738972800

created_beforeinteger

Unix timestamp.

Example:1738972800

procurementstring

A resource path like 'sfc:procurement:acme:prod:my-procurement' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Example:proc_k3R-nX9vLm7Qp2Yw5Jd8F

Filter to one procurement's orders (ID or resource path). Without it, the list omits procurement orders.

sort_by'created_at' | '-created_at' | 'start_at' | '-start_at'

Prefix with - for descending.

limitinteger

starting_afterstring

Example:ordrc_gqXR7s0Kj5mHvE2wNpLc4Q

Set to the response's cursor to fetch the next page.

ending_beforestring

Example:ordrc_gqXR7s0Kj5mHvE2wNpLc4Q

Set to the response's cursor to fetch the previous page.

Response

Paginated list of orders.

object'list' required

cursorstring

has_moreboolean required

Example response

{
  "object": "list",
  "cursor": "ordrc_gqXR7s0Kj5mHvE2wNpLc4Q",
  "data": [
    {
      "object": "order",
      "id": "ordr_k3R-nX9vLm7Qp2Yw5Jd8F",
      "capacity": {
        "id": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "instance_sku": {
        "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "allocation_schedule_delta": [
        {
          "start_at": 1738972800,
          "end_at": 1738972800
        }
      ],
      "limit_price_dollars_per_node_hour": "2.500000",
      "created_at": 1738972800,
      "filled_at": 1738972800,
      "filled_average_price_dollars_per_node_hour": "2.500000",
      "fills": [
        {
          "contract": "cont_k3R-nX9vLm7Qp2Yw5Jd8F",
          "filled_at": 1738972800,
          "allocation_schedule_delta": [
            {
              "start_at": 1738972800,
              "end_at": 1738972800
            }
          ],
          "price_dollars_per_node_hour": "2.500000"
        }
      ],
      "cancelled_at": 1738972800
    }
  ]
}