Skip to main content
GET
/
preview
/
v2
/
orderbook
/
depth
Get market depth
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/orderbook/depth \
  --header 'Authorization: Bearer <token>'
{
  "requirements": {},
  "start_at": 1738972800,
  "end_at": 1738972800,
  "requested_at": 1738972800,
  "bids": [
    {
      "dollars_per_node_hour": "<string>",
      "node_count": 4
    }
  ],
  "asks": [
    {
      "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

depth
integer<u-int32>
default:20

Maximum levels returned per side. Clamped to [1, 100]. Default 20.

Required range: 1 <= x <= 100

Response

Market depth.

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 side.

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

bids
object[]
required

Bids sorted descending by rate (best bid first).

asks
object[]
required

Asks sorted ascending by rate (best ask first).