Skip to main content
GET
/
preview
/
v2
/
orderbook
/
windows
List market windows
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/orderbook/windows \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "requirements": {},
  "range_start_at": 1738972800,
  "range_end_at": 1738972800,
  "has_more": true,
  "data": [
    {
      "start_at": 1738972800,
      "end_at": 1738972800,
      "duration_hours": 168,
      "total_bid_order_count": 3,
      "total_ask_order_count": 5,
      "total_bid_node_count": 12,
      "total_ask_node_count": 18,
      "best_bid": {
        "dollars_per_node_hour": "<string>",
        "node_count": 4
      },
      "best_ask": {
        "dollars_per_node_hour": "<string>",
        "node_count": 4
      }
    }
  ],
  "cursor": "mwin_gqXR7s0Kj5mHvE2wNpLc4Q"
}

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

range_start_at
integer<int64>
required

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

Example:

1738972800

range_end_at
integer<int64>
required

End of the delivery-window range to browse. Unix epoch seconds, minute-aligned, must be > range_start_at. Unix timestamp.

Example:

1738972800

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: ^mwin_[A-Za-z0-9_-]+$
Example:

"mwin_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

Active windows in the range.

Paginated list of active windows, sorted by (start_at, end_at) ascending.

object
string
default:list
required
read-only
Allowed value: "list"
requirements
object
required
range_start_at
integer<int64>
required

Unix timestamp.

Example:

1738972800

range_end_at
integer<int64>
required

Unix timestamp.

Example:

1738972800

has_more
boolean
required
data
object[]
required
cursor
null | string
Pattern: ^mwin_[A-Za-z0-9_-]+$
Example:

"mwin_gqXR7s0Kj5mHvE2wNpLc4Q"