v44

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-20129390589.6 KB
Orderbook

List market windows

List every delivery window with resting orders matching the requirements, within the given time range. Each row is a summary; use /quote or /depth for detail on a specific window.

get/preview/v2/orderbook/windows

Query parameters

requirementsstring

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

range_start_atinteger required

Unix timestamp.

Example:1738972800

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

range_end_atinteger required

Unix timestamp.

Example:1738972800

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

limitinteger

Maximum results to return. Clamped to [1, 200]. Default 50.

starting_afterstring
Example:mwin_gqXR7s0Kj5mHvE2wNpLc4Q

Set to the response's cursor to fetch the next page.

Response

Active windows in the range.

object'list' required
requirementsSfcApiInstanceTypeRequirements required
range_start_atinteger required

Unix timestamp.

range_end_atinteger required

Unix timestamp.

cursorstring
has_moreboolean required

Example response

{
  "object": "list",
  "range_start_at": 1738972800,
  "range_end_at": 1738972800,
  "cursor": "mwin_gqXR7s0Kj5mHvE2wNpLc4Q",
  "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": "2.500000",
        "node_count": 4
      },
      "best_ask": {
        "dollars_per_node_hour": "2.500000",
        "node_count": 4
      }
    }
  ]
}