Skip to main content
GET
List market orders

Authorizations

Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/dashboard/tokens.

Query Parameters

requirements
string

URL-safe field[:op]:value triples joined by ;.

range_start_at
integer<int64>
required

Start of the delivery range to search. Unix epoch seconds, minute-aligned. Unix timestamp.

Example:

1738972800

range_end_at
integer<int64>
required

End of the delivery range to search. Unix epoch seconds, minute-aligned, and no more than 30 days after range_start_at. Unix timestamp.

Example:

1738972800

window_relation
enum<string>
default:overlaps

How each order's delivery window must relate to the requested range. How an order's delivery window must relate to the requested range. Delivery windows are half-open: [start_at, end_at). overlaps returns intersecting windows, contained_within returns windows fully inside the range, and exact returns windows equal to the range.

Available options:
overlaps,
contained_within,
exact
status
enum<string>[]

Filter by lifecycle status. Repeat to include both. Omit to return open and filled orders.

Lifecycle state for an orderbook order. open includes standing and partially filled orders; filled includes completely filled orders.

Available options:
open,
filled
side
enum<string>

Filter by order side.

Available options:
sell,
buy
limit
integer<u-int32>
default:50

Maximum results to return. Clamped to [1, 200]. Default 50.

Required range: 1 <= x <= 200
starting_after
string

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

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

"mordc_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

Paginated list of orderbook orders.

Paginated orderbook orders created within the last 30 days, newest first.

object
string
default:list
required
read-only
Allowed value: "list"
requirements
object
required

Key/value filters on instance SKU properties.

Keys are the property names instance SKUs carry on GET /v2/instance_skus (e.g. accelerator); values match each property's value spelling. The reserved instance_sku key pins to a single SKU by id.

Empty map = no constraints.

Example:
range_start_at
integer<int64>
required

Unix timestamp.

Example:

1738972800

range_end_at
integer<int64>
required

Unix timestamp.

Example:

1738972800

window_relation
enum<string>
required

How an order's delivery window must relate to the requested range. Delivery windows are half-open: [start_at, end_at). overlaps returns intersecting windows, contained_within returns windows fully inside the range, and exact returns windows equal to the range.

Available options:
overlaps,
contained_within,
exact
requested_at
integer<int64>
required

Server time used to determine the 30-day history boundary.

Example:

1738972800

has_more
boolean
required
data
object[]
required
cursor
null | string

Pass as starting_after to fetch the next page.

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

"mordc_gqXR7s0Kj5mHvE2wNpLc4Q"