Sign in

v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB
Orders

Create order

⚠️ This endpoint is in public preview.

Place a buy or sell order. Orders fill on a single instance SKU matching the order's requirements. By default orders fill completely or not at all; set allow_partial to permit a partial fill. 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

poolstring required

A resource path like 'sfc:pool:acme:prod:my-pool' 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.

allow_partialboolean

If true, the order may fill partially — fewer nodes and/or a subset of the requested time window. The filled time may be disjoint.

limit_price_dollars_per_node_hourstring required

Price in dollars per node-hour, encoded as a decimal string. Prices are rounded to the nearest $0.000060/node-hour market tick. This is one microdollar per node-minute. Responses contain the rounded value with six decimal places. Inputs must contain a decimal point, be non-negative, and not exceed $500/node-hour.

Example request

{
  "pool": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
  "instance_sku": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
  "allocation_schedule_delta": [
    {
      "start_at": 1738972800,
      "end_at": 1738972800
    }
  ],
  "limit_price_dollars_per_node_hour": "1.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.

allow_partialboolean

If true, the order may fill partially — fewer nodes and/or a subset of the requested time window.

limit_price_dollars_per_node_hourstring required

Price in dollars per node-hour, encoded as a decimal string. Prices are rounded to the nearest $0.000060/node-hour market tick. This is one microdollar per node-minute. Responses contain the rounded value with six decimal places. Inputs must contain a decimal point, be non-negative, and not exceed $500/node-hour.

status'pending' | 'filled' | 'partially_filled' | 'rejected' | 'cancelled' | 'standing' 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.

created_atinteger required

Unix timestamp.

filled_atinteger

Unix timestamp.

filled_average_price_dollars_per_node_hourstring

Price in dollars per node-hour, encoded as a decimal string. Prices are rounded to the nearest $0.000060/node-hour market tick. This is one microdollar per node-minute. Responses contain the rounded value with six decimal places. Inputs must contain a decimal point, be non-negative, and not exceed $500/node-hour.

cancelled_atinteger

Unix timestamp.

Example response

{
  "id": "ordr_k3R-nX9vLm7Qp2Yw5Jd8F",
  "capacity": {
    "id": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
    "name": "my-resource-name"
  },
  "pool": {
    "id": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
    "name": "my-resource-name"
  },
  "instance_sku": {
    "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
    "alias": "my-resource-name"
  },
  "allocation_schedule_delta": [
    {
      "start_at": 1738972800,
      "end_at": 1738972800
    }
  ],
  "filled_allocation_schedule_delta": [
    {
      "start_at": 1738972800,
      "end_at": 1738972800
    }
  ],
  "limit_price_dollars_per_node_hour": "1.500000",
  "created_at": 1738972800,
  "filled_at": 1738972800,
  "filled_average_price_dollars_per_node_hour": "1.500000",
  "fills": [
    {
      "contract": "cont_k3R-nX9vLm7Qp2Yw5Jd8F",
      "filled_at": 1738972800,
      "allocation_schedule_delta": [
        {
          "start_at": 1738972800,
          "end_at": 1738972800
        }
      ],
      "price_dollars_per_node_hour": "1.500000"
    }
  ],
  "cancelled_at": 1738972800
}