Skip to main content
GET
/
preview
/
v2
/
orderbook
/
quote
Get market quote
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/orderbook/quote \
  --header 'Authorization: Bearer <token>'
{
  "requirements": {},
  "start_at": 1738972800,
  "end_at": 1738972800,
  "requested_at": 1738972800,
  "best_bid": {
    "dollars_per_node_hour": "<string>",
    "node_count": 4
  },
  "best_ask": {
    "dollars_per_node_hour": "<string>",
    "node_count": 4
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sfcompute.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Query Parameters

requirements
string

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

start_at
integer<int64>
required

Start of the delivery window. Unix timestamp.

Example:

1738972800

end_at
integer<int64>
required

End of the delivery window. Unix timestamp.

Example:

1738972800

Response

Market quote.

Top-of-book snapshot: the highest resting buy (best_bid) and lowest resting sell (best_ask) for the requested window. Either side may be absent if no orders are resting on it.

requirements
object
required

The hardware requirements the book was filtered by.

start_at
integer<int64>
required

Start of the delivery window the book covers.

Example:

1738972800

end_at
integer<int64>
required

End of the delivery window the book covers.

Example:

1738972800

requested_at
integer<int64>
required

Server time when the book was sampled.

Example:

1738972800

best_bid
object

Highest resting buy. Omitted if no bids are resting.

best_ask
object

Lowest resting sell. Omitted if no asks are resting.