Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The San Francisco Compute Company Orderbook API

Read-only orderbook visibility: bid/ask spread, depth, open and filled orders, and historical fills, keyed on hardware requirements + delivery window.

The San Francisco Compute Company Orderbook API is one of 14 APIs that The San Francisco Compute Company publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orderbook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.sfcompute.com.

4 operations 4 paths 20 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.sfcompute.com/preview/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

The San Francisco Compute Company Orderbook API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer_auth). By default, every request must be authenticated.

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

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Orderbook 4

Read-only orderbook visibility: bid/ask spread, depth, open and filled orders, and historical fills, keyed on hardware requirements + delivery window.

GET
/preview/v2/orderbook/depth
Get market depth
get_orderbook_depth 4 params → 200401422500
GET
/preview/v2/orderbook/fills
List market fills
list_orderbook_fills 6 params → 200401422500
GET
/preview/v2/orderbook/quote
Get market quote
get_orderbook_quote 3 params → 200401422500
GET
/preview/v2/orderbook/windows
List market windows
list_orderbook_windows 5 params → 200401422500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are OrderbookWindow (8 properties), ListOrderbookFillsResponse (8 properties), ListOrderbookWindowsResponse (7 properties), OrderbookQuoteResponse (6 properties). Each schema is shown below with its type and property counts.

OrderbookFillsCursor
string
InstanceSkuId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
InternalServerError
object
1 property 1 required
OrderbookWindowsCursor
string
Schedule
array
Node count over time, as a list of [startat, endat) time ranges. Example: 5 nodes from t=0 to t=3600 is [{"startat": 0, "endat": 3600, "nodecount": 5}]. starta…
UnprocessableEntityError
object
1 property 1 required
ErrorDetail
object
3 properties 2 required
OrderbookFill
object
A single trade: instance SKU, execution rate, delivered nodes over time, and the time it was recorded.
4 properties 4 required
OrderbookQuoteResponse
object
Top-of-book snapshot: the highest resting buy (bestbid) and lowest resting sell (bestask) for the requested window. Either side may be absent if no orders are…
6 properties 4 required
OrderbookWindow
object
Summary row: one instance SKU and delivery window with at least one resting order matching the requested filter.
8 properties 6 required
ScheduleEntry
object
A [startat, endat) time range with a fixed nodecount. endat is null only on the final entry, marking an unbounded tail.
3 properties 2 required
PriceLevel
object
One price level in the order book — orders sharing the same instance SKU and per-node-hour rate are summed into a single entry.
3 properties 3 required
Requirements
object
Key/value filters on instance SKU properties. Valid keys and values are published at GET /v2/instanceskupropertycatalog. Empty map = no constraints.
ListOrderbookFillsResponse
object
Paginated list of historical fills, newest first.
8 properties 7 required
UnauthorizedError
object
1 property 1 required
OrderbookDepthResponse
object
Depth of book for one delivery window. Bids descending (highest first), asks ascending (lowest first). Either array may be empty when no orders rest on that si…
6 properties 6 required
ListOrderbookWindowsResponse
object
Paginated list of active SKU windows, sorted by (startat, endat, instancesku) ascending.
7 properties 6 required
Name
string
DollarsPerNodeHour
string
Price rate in dollars per node-hour.
UnixEpoch
integer
Unix timestamp.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-san-francisco-compute-company-orderbook-api-openapi.yml Raw ↑

Other APIs The San Francisco Compute Company publishes across the network.

The San Francisco Compute Company Account API
The San Francisco Compute Company Deployments API
The San Francisco Compute Company Feature Flags API
The San Francisco Compute Company Images API
The San Francisco Compute Company Instance SKU Catalog API
The San Francisco Compute Company Instance SKUs API
The San Francisco Compute Company Instance Templates API
The San Francisco Compute Company Instances API
The San Francisco Compute Company Orders API
The San Francisco Compute Company Pools API
The San Francisco Compute Company Procurements API
The San Francisco Compute Company Users API