category

Return a bounded summary of approved Signals and coverage state across the covered pre-workout set for a date window.

Return a bounded summary of approved Signals and coverage state across the covered pre-workout set for a date window.

When to use. Use for 'what changed in the category recently'. Pass from and to dates; the window is capped and the page size is capped.

What it cannot provide. It is not an export. It returns approved Signals inside one bounded window, never the product table and never the underlying Record.

Requires the category: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/category/snapshot

Request

  • Base URL: https://formulasignal.com
  • URL: https://formulasignal.com/api/v1/category/snapshot
  • Auth: HTTP bearer

Query parameters

fromstring date
tostring date
limitinteger
cursorstring

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
status'supported' | 'partial' | 'stale' | 'under_review' | 'ambiguous' | 'unsupported' | 'refused' 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.