Skip to main content
GET
Resolve a playbook's symbols and its input values for a date

Authorizations

x-api-key
string
header
required

Raw API key shown once when created in the Allocait app (Settings > API keys). Send it verbatim in this header; the server stores and compares only its SHA-256 hash. Allocait generates every key: alc_ followed by 64 lowercase hex characters. Keys issued before 2026-10-10 are 64 hex characters with no prefix and keep working. A key may carry an expiry (90 days or 1 year, or never). A malformed, unknown, revoked or expired key gets 401 with no further detail, and a malformed one is refused before any lookup. Keys cannot be created through this API.

Path Parameters

id
string<uuid>
required

Query Parameters

date
string<date>

The date to read the input values for. Defaults to the playbook's own default_date, or today in US Eastern when that is null. A carry_forward Input shows its latest value on or before this date; any other Input shows only a value recorded on it.

Response

Playbook data

A playbook's resolved symbol universe and the value each of its input columns shows for one date. An Input that keeps until changed (carry_forward) shows its latest value on or before the date, flagged carried when that value was recorded earlier. Any other Input shows only a value recorded on the date. A cell with no value to show is listed in needs_input, unless its Input is optional. Each value also carries history facts (ADR-196): the entry recorded just before it and the first date of the run of equal values that ends at it.

success
boolean
playbook
object
date
string<date>

The date the values are read for: the date query parameter, else the playbook's default_date, else today in US Eastern when that is null (ADR-189).

symbols
string[]
input_definitions
object[]

The playbook's input columns the caller owns, ordered by name.

input_entries
object[]

The value each cell shows, ordered by the column's position in the playbook's input_columns, then by symbol. A cell with no value is absent here and listed in needs_input.

needs_input
object[]

Every cell with no value to show for the date: a column that does not keep until changed with nothing recorded on the date, or a column that does with nothing recorded on or before it. A SYMBOL-scope column has one cell per symbol, a PORTFOLIO-scope column one cell with a null symbol. The blank cells of an optional Input are left out (ADR-189). Empty when every cell has a value.