Skip to main content
GET
/
v2
/
orders
List orders
curl --request GET \
  --url https://api.sfcompute.com/v2/orders \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "object": "order",
      "id": "<string>",
      "capacity": "<string>",
      "side": "sell",
      "allow_standing": true,
      "zones": [
        "richmond"
      ],
      "delta": {
        "node_count": 2,
        "start_at": 1738972800,
        "end_at": 1738972800,
        "type": "rectangle"
      },
      "limit_price_dollars_per_node_hour": "<string>",
      "status": "pending",
      "created_at": 1738972800,
      "filled_at": 1738972800,
      "filled_price_dollars_per_node_hour": "2.500000",
      "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. An ID or name identifying this resource.

Pattern: (cap_[0-9a-zA-Z_-]{1,21}) | ([a-zA-Z0-9][a-zA-Z0-9._-]{0,254})
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. 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,
rejected,
cancelled,
standing
​
created_after
integer<int64>

Unix timestamp.

Example:

1738972800

​
created_before
integer<int64>

Unix timestamp.

Example:

1738972800

​
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
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"