Skip to main content
GET
/
preview
/
v2
/
orders
List orders
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/orders \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "object": "order",
      "id": "<string>",
      "capacity": {
        "id": "<string>",
        "name": "<string>"
      },
      "allow_standing": true,
      "allocation_schedule_delta": [
        {
          "start_at": 1738972800,
          "node_count": 123,
          "end_at": 1738972800
        }
      ],
      "limit_price_dollars_per_node_hour": "<string>",
      "created_at": 1738972800,
      "instance_sku": {
        "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "<string>"
      },
      "filled_at": 1738972800,
      "filled_quantity": 123,
      "filled_average_price_dollars_per_node_hour": "2.500000",
      "fills": [
        {
          "filled_at": 1738972800,
          "allocation_schedule_delta": [
            {
              "start_at": 1738972800,
              "node_count": 123,
              "end_at": 1738972800
            }
          ],
          "price_dollars_per_node_hour": "<string>",
          "contract": "cont_k3R-nX9vLm7Qp2Yw5Jd8F"
        }
      ],
      "cancelled_at": 1738972800
    }
  ],
  "cursor": "ordrc_gqXR7s0Kj5mHvE2wNpLc4Q"
}

Authorizations

​
Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Query Parameters

​
id
string[]

Filter by order ID (repeatable).

Pattern: ordr_[0-9a-zA-Z_-]{1,21}
​
capacity
string

Filter by capacity. 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.

Pattern: (cap_[0-9a-zA-Z_-]{1,21})|(sfc:capacity:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"cap_k3R-nX9vLm7Qp2Yw5Jd8F"

​
side
enum<string>
Available options:
sell,
buy
​
status
enum<string>[]

Filter by status (repeatable).

The status of an order in the system.

pending = not resolved/processed yet.

filled = order executed.

partially_filled = the order matched part of its requested capacity and remains active for the remainder.

standing = the order is waiting for a match.

cancelled = the order was cancelled either automatically (not a standing order and didn't immediately fill, or current time past end_at) or by explicit cancellation.

rejected = validation/system error occurred.

Available options:
pending,
filled,
partially_filled,
rejected,
cancelled,
standing
​
created_after
integer<int64>

Unix timestamp.

Example:

1738972800

​
created_before
integer<int64>

Unix timestamp.

Example:

1738972800

​
procurement
string

Filter to one procurement's orders (ID or resource path). Without it, the list omits procurement orders. 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.

Pattern: (proc_[0-9a-zA-Z_-]{1,21})|(sfc:procurement:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"proc_k3R-nX9vLm7Qp2Yw5Jd8F"

​
sort_by
enum<string>
default:-created_at

Prefix with - for descending.

Available options:
created_at,
-created_at,
start_at,
-start_at
​
limit
integer<u-int32>
default:50
Required range: 1 <= x <= 200
​
starting_after
string

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

Pattern: ^ordrc_[A-Za-z0-9_-]+$
Example:

"ordrc_gqXR7s0Kj5mHvE2wNpLc4Q"

​
ending_before
string

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

Pattern: ^ordrc_[A-Za-z0-9_-]+$
Example:

"ordrc_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

Paginated list of orders.

​
object
string
default:list
required
read-only
Allowed value: "list"
​
has_more
boolean
required
​
data
object[]
required
​
cursor
null | string

Pass as starting_after or ending_before to paginate.

Pattern: ^ordrc_[A-Za-z0-9_-]+$
Example:

"ordrc_gqXR7s0Kj5mHvE2wNpLc4Q"