changedInput schema / properties / lineage_detail / description
Previous value: -"Per-period provenance envelope. 'compact' (default) returns source_filing + source_url + restated flag for one-click SEC verification. 'full' adds first_filed_at + accepted_at for Bloomberg-Option-C restatement reasoning. 'off' omits lineage entirely."New value: +"Per-period provenance envelope + per-metric availability/provenance sidecars. 'compact' (default) returns source_filing + source_url + restated flag, plus lean per-metric availability + fact_id + source_filing. 'full' adds first_filed_at + accepted_at + per-metric source_url + computed inputs[]. 'off' omits all provenance."
addedInput schema / properties / response_format
Added value: +{
+ "default": "flat",
+ "description": "Output shape. 'flat' (default) returns the legacy `metrics` object plus the additive `metrics_availability`/`metrics_provenance` sidecars. 'envelope' additionally attaches `metric_envelopes` — one canonical {metric,value,unit,scale,period,availability,provenance} object per metric.",
+ "enum": [
+ "flat",
+ "envelope"
+ ],
+ "type": "string"
+}
addedOutput schema / properties / data / items / properties / metric_envelopes
Added value: +{
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "availability": {
+ "$ref": "#/properties/data/items/properties/metrics_availability/additionalProperties"
+ },
+ "metric": {
+ "type": "string"
+ },
+ "period": {
+ "additionalProperties": false,
+ "properties": {
+ "fiscal_period": {
+ "type": "string"
+ },
+ "fiscal_year": {
+ "type": "integer"
+ },
+ "period_end": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "fiscal_year",
+ "fiscal_period",
+ "period_end"
+ ],
+ "type": "object"
+ },
+ "provenance": {
+ "$ref": "#/properties/data/items/properties/metrics_provenance/additionalProperties"
+ },
+ "scale": {
+ "enum": [
+ "absolute",
+ "thousands",
+ "millions",
+ "ratio",
+ "percent",
+ "shares"
+ ],
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ },
+ "value": {
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "metric",
+ "value",
+ "unit",
+ "scale",
+ "period",
+ "availability",
+ "provenance"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / data / items / properties / metrics / properties / shares_outstanding
Added value: +{
+ "description": "Common shares outstanding (CommonSharesOutstanding) — equity-value→per-share divisor.",
+ "type": [
+ "number",
+ "null"
+ ]
+}
addedOutput schema / properties / data / items / properties / metrics / properties / short_term_investments
Added value: +{
+ "description": "Short-term / marketable investments (ShortTermInvestments). Non-overlapping with `cash`; Wall-Street net_debt subtracts (cash + short_term_investments).",
+ "type": [
+ "number",
+ "null"
+ ]
+}
changedOutput schema / properties / data / items / properties / metrics / required
Previous value: -[
- "revenue",
- "gross_profit",
- "operating_income",
- "net_income",
- "eps_diluted",
- "total_assets",
- "total_liabilities",
- "stockholders_equity",
- "cash",
- "total_debt",
- "operating_cash_flow",
- "capex"
-]New value: +[
+ "revenue",
+ "gross_profit",
+ "operating_income",
+ "net_income",
+ "eps_diluted",
+ "total_assets",
+ "total_liabilities",
+ "stockholders_equity",
+ "cash",
+ "short_term_investments",
+ "total_debt",
+ "operating_cash_flow",
+ "capex",
+ "shares_outstanding"
+]
addedOutput schema / properties / data / items / properties / metrics_availability
Added value: +{
+ "additionalProperties": {
+ "description": "Explicit availability status. A real reported zero is 'available' with value 0 — never null. 'not_reported' = filing omitted it; 'not_mapped' = XBRL mapping uncertain; 'suppressed' = below confidence; 'error' = compute/retrieval failed.",
+ "enum": [
+ "available",
+ "not_reported",
+ "not_mapped",
+ "suppressed",
+ "error"
+ ],
+ "type": "string"
+ },
+ "type": "object"
+}
addedOutput schema / properties / data / items / properties / metrics_provenance
Added value: +{
+ "additionalProperties": {
+ "additionalProperties": false,
+ "description": "Provenance pointer: origin 'dataset' carries the SHA-256 fact_id + source filing; origin 'computed' carries the formula + the input fact_ids (verify with verify_fact_lineage).",
+ "properties": {
+ "accepted_at": {
+ "type": "string"
+ },
+ "fact_id": {
+ "type": "string"
+ },
+ "formula": {
+ "type": "string"
+ },
+ "inputs": {
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "fact_id": {
+ "type": "string"
+ },
+ "role": {
+ "type": "string"
+ },
+ "value": {
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "origin": {
+ "enum": [
+ "dataset",
+ "computed"
+ ],
+ "type": "string"
+ },
+ "source_filing": {
+ "type": "string"
+ },
+ "source_url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "origin"
+ ],
+ "type": "object"
+ },
+ "type": "object"
+}