Skip to main content
GET
/
preview
/
v2
/
orders
/
{id}
Get order
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/orders/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Order ID

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

"ordr_k3R-nX9vLm7Qp2Yw5Jd8F"

Response

Order details.

​
object
string
default:order
required
read-only
Allowed value: "order"
​
id
string
required
Pattern: ordr_[0-9a-zA-Z_-]{1,21}
Example:

"ordr_k3R-nX9vLm7Qp2Yw5Jd8F"

​
capacity
object
required

Target capacity that receives or loses compute if this order fills (depending on order type).

​
side
enum<string>
required
Available options:
sell,
buy
​
allow_standing
boolean
required

If true, the order stays in the order book until either fills, is explicitly cancelled, or the order end time is reached resulting in automatic cancellation. If false, the order is cancelled immediately if it doesn't fill.

​
allocation_schedule_delta
object[]
required

Change in capacity if the order fills. Must be a single time range with both start_at and end_at.

​
limit_price_dollars_per_node_hour
string
required

Price rate in dollars per node-hour.

Pattern: ^\d+\.\d+$
Example:

"2.500000"

​
status
enum<string>
required

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_at
integer<int64>
required

Unix timestamp.

Example:

1738972800

​
instance_sku
object

Instance SKU this order is pinned to. None for legacy orders that pre-date the move to instance-sku-pinned matching, or for orders stored without an instance_sku requirement. Carries the SKU's human-readable name when one is registered.

​
filled_at
null | integer<int64>

Unix timestamp.

Example:

1738972800

​
filled_quantity
integer<int32> | null

Node count that filled. Equals the order's quantity for complete fills.

​
filled_average_price_dollars_per_node_hour
null | string

Weighted-average execution price across all fills.

Pattern: ^\d+\.\d+$
Example:

"2.500000"

​
fills
object[]

Each contract produced by this order. Empty for unfilled orders.

​
cancelled_at
null | integer<int64>

Unix timestamp.

Example:

1738972800