Sign in

v44

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

Create order

⚠️ This endpoint is in public preview.

Place a buy or sell order. Orders fill completely or not at all. All nodes fill on a single instance SKU matching the order's requirements. Order filling is asynchronous; poll GET /v2/orders/{id} to check status.

post/preview/v2/orders

Headers

Idempotency-Keystring nullable

Unique key to ensure idempotent order creation. If provided, duplicate requests with the same key will not place a new order and return the original order.

Request body

capacitystring required

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.

side'sell' | 'buy' required
allow_standingboolean

If true, the order rests on the order book until it fills, is cancelled, or its end time passes. If false, the order is cancelled immediately if it does not fill.

instance_skustring required
limit_price_dollars_per_node_hourstring required

Price rate in dollars per node-hour.

Example request

{
  "capacity": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
  "instance_sku": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
  "allocation_schedule_delta": [
    {
      "start_at": 1738972800,
      "end_at": 1738972800
    }
  ],
  "limit_price_dollars_per_node_hour": "2.500000"
}

Response

Order created.

object'order' required
idstring required
side'sell' | 'buy' required
allow_standingboolean 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.

limit_price_dollars_per_node_hourstring required

Price rate in dollars per node-hour.

status'pending' | 'filled' | 'rejected' | 'cancelled' | 'standing' required

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.

created_atinteger required

Unix timestamp.

filled_atinteger

Unix timestamp.

filled_quantityinteger nullable

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

filled_average_price_dollars_per_node_hourstring

Price rate in dollars per node-hour.

cancelled_atinteger

Unix timestamp.

Example response

{
  "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
}