ledger

Return one Category Ledger edition: the executive summary, confirmed changes released in the period, category benchmarks with their cohorts, serving economics, the product comparison, and the limitations.

When to use. Use when an agent needs the month's category intelligence with every denominator attached, or needs to cite a figure a customer is reading on the web edition.

What it cannot provide. It never returns an unreviewed candidate, a Signal the publication gate refuses, a preserved-source path, or a hash of any stored source. The edition_hash it does return is a hash of the published document itself, so a machine citation and the page a person was sent can be checked against each other.

Requires the ledger:read scope. Each distinct signal named in a successful answer spends one unit of the key's daily signal budget. Asking twice about the same one costs once.

get/api/v1/ledger/{edition_id}

Request

Base URL: https://formulasignal.com
URL: https://formulasignal.com/api/v1/ledger/{edition_id}
Auth: HTTP bearer

Path parameters

edition_idstring required

The edition id.

Headers

X-FormulaSignal-Origin'api' | 'mcp'

Optional attribution: mcp when the call comes from the FormulaSignal MCP server, api otherwise. Self-reported and recorded on the usage row so a customer can see which surface their traffic came from. Nothing reads it to decide what a caller may do, so a wrong value costs only the accuracy of that customer's own reporting.

Response

A FormulaSignal answer. status says what kind of answer it is, and every value except supported is still a real answer about the Record rather than a fact about the product.

request_idstring required

capabilitystring required

What kind of answer this is. Every value except supported is still a real answer about the Record rather than a fact about the product.

summarystring required

One sentence saying what kind of answer this is.

signalsobject[]

comparisonobject

coverageobject

ledgerobject

watchobject

next_cursorstring nullable

limitationsstring[] required

Always present, including when empty. Read it.

record_versionstring required

The Record data-state id. Two answers sharing it came from one committed state.

record_as_ofstring date required

record_timestampstring date-time required

The newest dated observation the Record holds. Deliberately not "now".

methodology_versionstring required

disclaimerstring required

Example response

{
  "methodology_version": "record-v1",
  "disclaimer": "FormulaSignal provides evidence-backed supplement information and does not provide individualized medical advice."
}

Changes

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