order_book

How the book was taken, booked quantity and value by the week it was booked in

How a season's book was taken over time: one point per week carrying the book as it stood at the end of that week, with booked quantity, booked value and line count.

season_code is required; commitment_id, trading_partner_id (one account's book) and as_of narrow as elsewhere, and grain takes week. Weekly only: a daily curve on a book taken in showroom appointments is noise around the appointments rather than a signal about the season.

It answers whether a season is ahead of or behind the pace the last one was taken at, which a single total cannot. Use get_order_book_accounts when the question is which accounts are behind rather than whether the book as a whole is.

Sold with Essentials+: without Tightly Connect the answer is 403 plan_excludes.

Scope: order_book:read.

get/api/v1/order-book/curve

Request

  • Base URL: https://api.app.tightly.io
  • URL: https://api.app.tightly.io/api/v1/order-book/curve
  • Auth: HTTP bearer

Query parameters

season_codestring required
Example:SS27

The season being read, e.g. SS27.

commitment_idstring

Narrow the book to one Commitment's scope.

as_ofstring date-time

Reconstruct the book as it stood at this instant (ISO-8601). Default is now.

trading_partner_idstring

Narrow the curve to one account's book, how that account's season was taken week by week. The answer's scope.trading_partner_id says it back. A key bound to one account may read its own account's curve and no other's; unnamed, the curve is the whole book and a bound key is refused it.

grain'week'

The bucket the curve is cut into. week is the only grain served.

Headers

Tightly-Versionstring
Example:2026-11

The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.

Response

One point per week, each with the book as it stood at the end of that week, as_of, booked_qty, booked_value_usd and lines.

messageobject

severity, service and desc.

Changes

No recorded changes to this operation across all 1 revision of this API.