changedOutput schema / properties / results / items / anyOf
Previous value: -[
- {
- "additionalProperties": false,
- "properties": {
- "derived": {
- "additionalProperties": false,
- "description": "Present on a re-derived (`drv1:`) item: the formula and the input facts the engine re-read. `lineage.display` is the engine's recomputed figure.",
- "properties": {
- "formula_id": {
- "description": "The registered formula that was re-run, e.g. margin.gross@1.",
- "type": "string"
- },
- "inputs": {
- "description": "The facts the figure was recomputed from; empty for a pipeline-computed ratio.",
- "items": {
- "additionalProperties": false,
- "properties": {
- "concept": {
- "description": "That input's standard concept.",
- "type": [
- "string",
- "null"
- ]
- },
- "display": {
- "description": "That input fact, rendered.",
- "type": [
- "string",
- "null"
- ]
- },
- "fact_id": {
- "description": "The source fact that filled the role.",
- "type": "string"
- },
- "period_end": {
- "description": "That input's period end (YYYY-MM-DD).",
- "type": [
- "string",
- "null"
- ]
- },
- "role": {
- "description": "The role this input plays in the formula.",
- "type": "string"
- }
- },
- "required": [
- "role",
- "fact_id",
- "display",
- "period_end",
- "concept"
- ],
- "type": "object"
- },
- "type": "array"
- }
- },
- "required": [
- "formula_id",
- "inputs"
- ],
- "type": "object"
- },
- "derived_id": {
- "description": "Set when this item was a `drv1:` derived id (echoed).",
- "type": "string"
- },
- "fact_id": {
- "description": "The fact_id this item asked about — echoed so a caller can key results without relying on order.",
- "type": "string"
- },
- "found": {
- "const": true,
- "description": "The fact resolved; `lineage` carries its full provenance chain.",
- "type": "boolean"
- },
- "lineage": {
- "additionalProperties": false,
- "description": "Full provenance for one fact. Identity: fact_id, entity_id, ticker, company_name, concept, standard_concept, accession_id. Value: numeric_value (raw), `display` (the SAME number already rendered — \"$391.04B\" — QUOTE THIS rather than re-rounding numeric_value yourself), unit, plus derived_quarterly_value/derived_quarterly_display (a Q2/Q3 10-Q states year-to-date, so the quarter and the filing are different numbers). Filing: source_url, inline_viewer_url, document_url, filing_date, form_type, accepted_at. Duration: period_start, period_end, period_span_days, and period_type (instant | quarterly | half_year | nine_month | annual | duration) so a 3-month stub is never mistaken for the 12-month figure — a 10-K tags BOTH at the same period_end. ⚠️ There is no `value` key and no `cik` key; the fields are named exactly as emitted.",
- "properties": {
- "accepted_at": {
- "description": "SEC acceptance timestamp (ISO 8601) — the moment this number became public. The PIT cut is taken on this.",
- "type": [
- "string",
- "null"
- ]
- },
- "accession_id": {
- "description": "SEC accession number of the filing that reported this value, e.g. 0000320193-24-000123.",
- "type": "string"
- },
- "company_name": {
- "description": "Registrant name as filed.",
- "type": "string"
- },
- "concept": {
- "description": "Raw XBRL tag as the filer used it, e.g. us-gaap:Revenues.",
- "type": "string"
- },
- "derived_quarterly_display": {
- "description": "`derived_quarterly_value` rendered the same way. Null when that value is null.",
- "type": [
- "string",
- "null"
- ]
- },
- "derived_quarterly_value": {
- "description": "The three-month figure derived from a year-to-date filing. A Q2/Q3 10-Q states YTD, so THIS and `numeric_value` are different numbers for the same fact — a verifier comparing against whichever one it happened to read passes wrong numbers half the time. Null when no derivation applies.",
- "type": [
- "number",
- "null"
- ]
- },
- "display": {
- "description": "`numeric_value` ALREADY RENDERED — \"$391.04B\", \"$6.11\". QUOTE THIS character-for-character rather than re-rounding `numeric_value` yourself: the rendering also needs a scale, and `unit` alone cannot tell a fraction (0.5965 → \"59.65%\") from a percent (0.5965 → \"0.60%\"). Null when `numeric_value` is null.",
- "type": [
- "string",
- "null"
- ]
- },
- "document_url": {
- "description": "Direct link to the rendered primary document (not the index page). Null when the primary document is unknown.",
- "type": [
- "string",
- "null"
- ]
- },
- "entity_id": {
- "description": "Zero-padded 10-digit SEC CIK of the filer. (The key is named entity_id — there is no `cik` field.)",
- "type": "string"
- },
- "fact_id": {
- "description": "Deterministic fact identity: SHA-256(entity_id|accession_id|concept|period_end|unit), 64-char lowercase hex.",
- "type": "string"
- },
- "filing_date": {
- "description": "Filing date (YYYY-MM-DD). Null when the filing join found nothing.",
- "type": [
- "string",
- "null"
- ]
- },
- "form_type": {
- "description": "Filing form type — 10-K, 10-Q, 8-K, 20-F. Null when the filing join found nothing.",
- "type": [
- "string",
- "null"
- ]
- },
- "inline_viewer_url": {
- "description": "SEC Inline-XBRL viewer opened on the rendered primary document — the strongest one-click verification link. Null when the filing is not Inline-XBRL or the primary document is unknown.",
- "type": [
- "string",
- "null"
- ]
- },
- "numeric_value": {
- "description": "The raw reported value. Null when the fact carries no numeric value.",
- "type": [
- "number",
- "null"
- ]
- },
- "period_end": {
- "description": "End of the reporting window (YYYY-MM-DD), or the instant date for balance-sheet facts.",
- "type": [
- "string",
- "null"
- ]
- },
- "period_span_days": {
- "description": "Length of the reporting window in days. Null when not derivable.",
- "type": [
- "number",
- "null"
- ]
- },
- "period_start": {
- "description": "Start of the reporting window (YYYY-MM-DD). Null for instant (balance-sheet) facts.",
- "type": [
- "string",
- "null"
- ]
- },
- "period_type": {
- "description": "Coarse duration class: instant | quarterly | half_year | nine_month | annual | duration. A single 10-K tags BOTH a 12-month figure and a 3-month Q4 stub at the same period_end, so this is what stops a stub being quoted as the annual number.",
- "type": "string"
- },
- "source_url": {
- "description": "SEC filing-index URL. Null when the filing join found nothing.",
- "type": [
- "string",
- "null"
- ]
- },
- "standard_concept": {
- "description": "Valuein's standardized concept name (TotalRevenue, NetIncome, …); null when the raw tag is unmapped.",
- "type": [
- "string",
- "null"
- ]
- },
- "ticker": {
- "description": "Uppercase ticker the lookup resolved through.",
- "type": "string"
- },
- "unit": {
- "description": "Unit of the value, e.g. USD, USD/share, shares.",
- "type": "string"
- }
- },
- "required": [
- "fact_id",
- "entity_id",
- "ticker",
- "company_name",
- "accession_id",
- "concept",
- "standard_concept",
- "unit",
- "numeric_value",
- "derived_quarterly_value",
- "display",
- "derived_quarterly_display",
- "accepted_at",
- "source_url",
- "inline_viewer_url",
- "document_url",
- "filing_date",
- "form_type",
- "period_start",
- "period_end",
- "period_span_days",
- "period_type"
- ],
- "type": "object"
- },
- "ticker": {
- "description": "The uppercased ticker (or CIK) this item asked about.",
- "type": "string"
- }
- },
- "required": [
- "ticker",
- "fact_id",
- "found",
- "lineage"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "properties": {
- "derived_id": {
- "$ref": "#/properties/results/items/anyOf/0/properties/derived_id"
- },
- "error": {
- "additionalProperties": false,
- "description": "Why this item could not be resolved. Never fabricate a lineage for an item that carries this.",
- "properties": {
- "code": {
- "description": "Machine-readable reason: TICKER_NOT_FOUND (the company is outside the bucket your plan reads), DATA_NOT_AVAILABLE_FOR_PERIOD (the period is outside your history window), DATA_NOT_FOUND / FACT_NOT_FOUND (no fact carries that fact_id for that company), or any other code the lookup raised — the original code is preserved, never flattened. Derived items add INVALID_ARGUMENT, UNKNOWN_FORMULA, INPUT_NOT_FOUND, INPUT_UNAVAILABLE, UNDEFINED_RESULT and ENTITLEMENT_DENIED (permanent: a human must act) and pass the data layer's transient codes through unchanged (UPSTREAM_UNAVAILABLE, STALE_SNAPSHOT, RATE_LIMITED, R2_CONCURRENCY, INTERNAL_ERROR: retry).",
- "type": "string"
- },
- "message": {
- "description": "Human-readable detail for this item.",
- "type": "string"
- }
- },
- "required": [
- "code",
- "message"
- ],
- "type": "object"
- },
- "fact_id": {
- "description": "The fact_id this item asked about.",
- "type": "string"
- },
- "found": {
- "const": false,
- "description": "This one fact could not be resolved. The other items in the call are unaffected — read them.",
- "type": "boolean"
- },
- "ticker": {
- "description": "The uppercased ticker (or CIK) this item asked about.",
- "type": "string"
- }
- },
- "required": [
- "ticker",
- "fact_id",
- "found",
- "error"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "additionalProperties": false,
+ "properties": {
+ "derived": {
+ "additionalProperties": false,
+ "description": "Present on a re-derived (`drv1:`) item: the formula and the input facts the engine re-read. `lineage.display` is the engine's recomputed figure.",
+ "properties": {
+ "formula_id": {
+ "description": "The registered formula that was re-run, e.g. margin.gross@1.",
+ "type": "string"
+ },
+ "inputs": {
+ "description": "The facts the figure was recomputed from; empty for a pipeline-computed ratio.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "concept": {
+ "description": "That input's standard concept.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "display": {
+ "description": "That input fact, rendered.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "fact_id": {
+ "description": "The source fact that filled the role.",
+ "type": "string"
+ },
+ "period_end": {
+ "description": "That input's period end (YYYY-MM-DD).",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "role": {
+ "description": "The role this input plays in the formula.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "role",
+ "fact_id",
+ "display",
+ "period_end",
+ "concept"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "formula_id",
+ "inputs"
+ ],
+ "type": "object"
+ },
+ "derived_id": {
+ "description": "Set when this item was a `drv1:` derived id (echoed).",
+ "type": "string"
+ },
+ "fact_id": {
+ "description": "The fact_id this item asked about — echoed so a caller can key results without relying on order.",
+ "type": "string"
+ },
+ "found": {
+ "const": true,
+ "description": "The fact resolved; `lineage` carries its full provenance chain.",
+ "type": "boolean"
+ },
+ "lineage": {
+ "additionalProperties": false,
+ "description": "Full provenance for one fact. Identity: fact_id, entity_id, ticker, company_name, concept, standard_concept, accession_id. Value: numeric_value (raw), `display` (the SAME number already rendered — \"$391.04B\" — QUOTE THIS rather than re-rounding numeric_value yourself), unit, plus derived_quarterly_value/derived_quarterly_display (a Q2/Q3 10-Q states year-to-date, so the quarter and the filing are different numbers). Filing: source_url, inline_viewer_url, document_url, filing_date, form_type, accepted_at. Duration: period_start, period_end, period_span_days, and period_type (instant | quarterly | half_year | nine_month | annual | duration) so a 3-month stub is never mistaken for the 12-month figure — a 10-K tags BOTH at the same period_end. ⚠️ There is no `value` key and no `cik` key; the fields are named exactly as emitted.",
+ "properties": {
+ "accepted_at": {
+ "description": "SEC acceptance timestamp (ISO 8601) — the moment this number became public. The PIT cut is taken on this.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "accession_id": {
+ "description": "SEC accession number of the filing that reported this value, e.g. 0000320193-24-000123.",
+ "type": "string"
+ },
+ "company_name": {
+ "description": "Registrant name as filed.",
+ "type": "string"
+ },
+ "concept": {
+ "description": "Raw XBRL tag as the filer used it, e.g. us-gaap:Revenues.",
+ "type": "string"
+ },
+ "derived_quarterly_display": {
+ "description": "`derived_quarterly_value` rendered the same way. Null when that value is null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "derived_quarterly_value": {
+ "description": "The three-month figure derived from a year-to-date filing. A Q2/Q3 10-Q states YTD, so THIS and `numeric_value` are different numbers for the same fact — a verifier comparing against whichever one it happened to read passes wrong numbers half the time. Null when no derivation applies.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "display": {
+ "description": "`numeric_value` ALREADY RENDERED — \"$391.04B\", \"$6.11\". QUOTE THIS character-for-character rather than re-rounding `numeric_value` yourself: the rendering also needs a scale, and `unit` alone cannot tell a fraction (0.5965 → \"59.65%\") from a percent (0.5965 → \"0.60%\"). Null when `numeric_value` is null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "document_url": {
+ "description": "Direct link to the rendered primary document (not the index page). Null when the primary document is unknown.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "entity_id": {
+ "description": "Zero-padded 10-digit SEC CIK of the filer. (The key is named entity_id — there is no `cik` field.)",
+ "type": "string"
+ },
+ "fact_id": {
+ "description": "Deterministic fact identity: SHA-256(entity_id|accession_id|concept|period_end|unit), 64-char lowercase hex.",
+ "type": "string"
+ },
+ "filing_date": {
+ "description": "Filing date (YYYY-MM-DD). Null when the filing join found nothing.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "form_type": {
+ "description": "Filing form type — 10-K, 10-Q, 8-K, 20-F. Null when the filing join found nothing.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "inline_viewer_url": {
+ "description": "SEC Inline-XBRL viewer opened on the rendered primary document — the strongest one-click verification link. Null when the filing is not Inline-XBRL or the primary document is unknown.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "numeric_value": {
+ "description": "The raw reported value. Null when the fact carries no numeric value.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "period_end": {
+ "description": "End of the reporting window (YYYY-MM-DD), or the instant date for balance-sheet facts.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "period_span_days": {
+ "description": "Length of the reporting window in days. Null when not derivable.",
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "period_start": {
+ "description": "Start of the reporting window (YYYY-MM-DD). Null for instant (balance-sheet) facts.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "period_type": {
+ "description": "Coarse duration class: instant | quarterly | half_year | nine_month | annual | duration. A single 10-K tags BOTH a 12-month figure and a 3-month Q4 stub at the same period_end, so this is what stops a stub being quoted as the annual number.",
+ "type": "string"
+ },
+ "source_url": {
+ "description": "SEC filing-index URL. Null when the filing join found nothing.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "standard_concept": {
+ "description": "Valuein's standardized concept name (TotalRevenue, NetIncome, …); null when the raw tag is unmapped.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "ticker": {
+ "description": "Uppercase ticker the lookup resolved through.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "Unit of the value, e.g. USD, USD/share, shares.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "fact_id",
+ "entity_id",
+ "ticker",
+ "company_name",
+ "accession_id",
+ "concept",
+ "standard_concept",
+ "unit",
+ "numeric_value",
+ "derived_quarterly_value",
+ "display",
+ "derived_quarterly_display",
+ "accepted_at",
+ "source_url",
+ "inline_viewer_url",
+ "document_url",
+ "filing_date",
+ "form_type",
+ "period_start",
+ "period_end",
+ "period_span_days",
+ "period_type"
+ ],
+ "type": "object"
+ },
+ "ticker": {
+ "description": "The uppercased ticker (or CIK) this item asked about.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "ticker",
+ "fact_id",
+ "found",
+ "lineage"
+ ],
+ "type": "object"
+ },
+ {
+ "additionalProperties": false,
+ "properties": {
+ "derived_id": {
+ "$ref": "#/properties/results/items/anyOf/0/properties/derived_id"
+ },
+ "error": {
+ "additionalProperties": false,
+ "description": "Why this item could not be resolved. Never fabricate a lineage for an item that carries this.",
+ "properties": {
+ "code": {
+ "description": "Machine-readable reason: TICKER_NOT_FOUND (the company is outside the bucket your plan reads), DATA_NOT_AVAILABLE_FOR_PERIOD (the period is outside your history window, or no fact carries that fact_id for that company), or any other code the lookup raised — the original code is preserved, never flattened. Derived items add INVALID_ARGUMENT, UNKNOWN_FORMULA, INPUT_NOT_FOUND, INPUT_UNAVAILABLE, UNDEFINED_RESULT and ENTITLEMENT_DENIED (permanent: a human must act) and pass the data layer's transient codes through unchanged (UPSTREAM_UNAVAILABLE, STALE_SNAPSHOT, RATE_LIMITED, INTERNAL_ERROR: retry).",
+ "type": "string"
+ },
+ "message": {
+ "description": "Human-readable detail for this item.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ],
+ "type": "object"
+ },
+ "fact_id": {
+ "description": "The fact_id this item asked about.",
+ "type": "string"
+ },
+ "found": {
+ "const": false,
+ "description": "This one fact could not be resolved. The other items in the call are unaffected — read them.",
+ "type": "boolean"
+ },
+ "ticker": {
+ "description": "The uppercased ticker (or CIK) this item asked about.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "ticker",
+ "fact_id",
+ "found",
+ "error"
+ ],
+ "type": "object"
+ }
+]