How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The San Francisco Compute Company Orders API

Estimate an order before placing it: filled price, fee, and operational notices.

The San Francisco Compute Company Orders 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 Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 5 operations across 3 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

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

5 operations 3 paths 43 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 Orders 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 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 5

Estimate an order before placing it: filled price, fee, and operational notices.

POST
/preview/v2/order_preview
Estimate an order
get_order_preview body → 200401422500
POST
/preview/v2/orders
Create order
create_order 1 param body → 201401402403404422500503
GET
/preview/v2/orders
List orders
list_orders 12 params → 200401403422500
DELETE
/preview/v2/orders/{id}
Cancel order
cancel_order 1 param → 204401403404422500
GET
/preview/v2/orders/{id}
Get order
fetch_order 1 param → 200401403404500

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are v2.OrderResponse (18 properties), v2.CreateOrderRequest (7 properties), v2.BuyOrderPreviewRequest (5 properties), v2.SellOrderPreviewRequest (5 properties). Each schema is shown below with its type and property counts.

v2.BuyOrderPreviewRequest
object
5 properties 4 required
v2.OrderPreviewFee
object
Fee charged on fills for the targeted instance SKU. Total fee = flatdollarspernodehour × nodecount × durationhours + percentagebps / 10000 × executiontotaldoll…
2 properties 2 required
Name
string
ContractId
string
v2.ListOrdersResponse
object
4 properties 3 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
v2.OrderFill
object
A single fill event: one contract that was produced when the order matched.
4 properties 3 required
NotFoundError
object
1 property 1 required
Requirements
object
Key/value filters on instance SKU properties. Valid keys and values are published at GET /v2/instanceskupropertycatalog. Empty map = no constraints.
v2.OrderPrincipalKind
string
Whether an order's createdby principal is a human user or an API token.
v2.SellOrderPreviewRequest
object
5 properties 4 required
Side
string
v2.OrderPrincipal
object
The principal that placed an order. type distinguishes the two cases: a user carries email (when an email identity exists); a token carries name. The inapplica…
4 properties 2 required
UnprocessableEntityError
object
1 property 1 required
CapacitySummary
object
2 properties 2 required
ResourcePathOrId_WorkspaceId
string
A resource path like 'sfc:workspace:acme:my-workspace' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or m…
DollarsPerNodeHour
string
Price rate in dollars per node-hour.
v2.OrderPreviewNotice
PoolSummary
object
A pool referenced by id and name.
2 properties 2 required
ForbiddenError
object
1 property 1 required
OrdersCursor
string
OrderId
string
v2.MaintenanceNoticeType
string
v2.CreateOrderRequest
object
7 properties 5 required
InstanceSkuId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.
v2.OrderPreviewUnavailableReason
string
v2.OrderResponse
object
18 properties 12 required
v2.OrderPreviewRequest
InternalServerError
object
1 property 1 required
InstanceSkuSummary
object
A summary of an instance SKU - its id and human-recognizable alias - embedded on resources that reference a SKU.
3 properties 3 required
ServiceUnavailableError
object
1 property 1 required
ErrorDetail
object
3 properties 2 required
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…
UnauthorizedError
object
1 property 1 required
UnixEpoch
integer
Unix timestamp.
OrderStatus
string
The status of an order in the system. pending = not resolved/processed yet. filled = order executed. partiallyfilled = the order matched part of its requested…
v2.OrderSortBy
string
ResourcePathOrId_PoolId
string
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.…
PaymentRequiredError
object
1 property 1 required
ResourcePathOrId_ProcurementId
string
A resource path like 'sfc:procurement:acme:prod:my-procurement' or an ID. Resource paths are human-readable but not stable - they change when resources are ren…
v2.OrderPreviewResponse
PoolId
string
CapacityId
Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-san-francisco-compute-company-orders-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 Orderbook API
The San Francisco Compute Company Pools API
The San Francisco Compute Company Procurements API
The San Francisco Compute Company Users API
Where this information came from

This is an independent, third-party profile of The San Francisco Compute Company Orders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.