changedInput schema / properties / cursor / description
Previous value: -"Continue the original scope; other query fields may be omitted."New value: +"Continue the original scope; omit the other fields or repeat them unchanged, since a changed value (page_size included) fails cursor_invalid. Only max_pages may change per call."
addedInput schema / properties / include
Added value: +{
+ "description": "Lobbying-activity fields to return in selected_filings, raw_filings and activities: activity_descriptions (description) and activity_lobbyists (lobbyists). Fields left out are removed from delivered rows only; totals and SQL datasets are unaffected. Default []. Fixed for the scan: a continuation omits it or repeats it unchanged.",
+ "items": {
+ "enum": [
+ "activity_descriptions",
+ "activity_lobbyists"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+}
changedInput schema / properties / issue_code / description
Previous value: -"Required first-call code from uslobbying_list_reference topic issue_codes."New value: +"First-call code from uslobbying_list_reference topic issue_codes. Required unless registrant_id is given; omit it with registrant_id for ledgers across every issue."
changedInput schema / properties / max_pages / description
Previous value: -"Source pages per call; positive integers clamp to five, default one for discovery, five for analysis."New value: +"Most upstream pages fetched per call, at most 5; larger values clamp and are disclosed in delivery_limits. Discovery fetches only while fewer than page_size matches are pending. Default one for discovery, five for analysis."
changedInput schema / properties / page_size / description
Previous value: -"Upstream rows per page; positive integers clamp to 25, default 25."New value: +"Whole analytical rows delivered per call: default 25, at most 250; larger values clamp to it and are disclosed in delivery_limits. Not the upstream page size; a page is short only at the end of the result or while acquisition is still collecting."
removedInput schema / properties / record_handle
Removed value: -{
- "description": "Tenant/tool-bound deferred record handle.",
- "type": "string"
-}
removedInput schema / properties / record_limit
Removed value: -{
- "default": 25,
- "description": "Maximum object entries or array items, clamped to 25; text fragments use the response byte budget.",
- "minimum": 1,
- "multipleOf": 1,
- "type": "number"
-}
removedInput schema / properties / record_offset
Removed value: -{
- "default": 0,
- "description": "Key, item or Unicode-code-point offset.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
-}
removedInput schema / properties / record_path
Removed value: -{
- "default": "",
- "description": "JSON Pointer to a stored value; empty selects the root.",
- "type": "string"
-}
changedInput schema / properties / registrant_id / description
Previous value: -"Optional native registrant scope."New value: +"Optional native registrant scope; without issue_code, ledgers cover every issue."
changedInput schema / properties / row_sets / description
Previous value: -"Inline analytical sets; omit for all sets. Selection never limits acquisition, totals or SQL staging. Omitted sets remain available from a new call with another selection or staged tables. Continue with omitted or equivalent row_sets."New value: +"Inline analytical sets; omit for all sets. Selection never limits acquisition, totals or SQL staging. Omitted sets remain available from a new call with another selection or staged tables. On a continuation, omit row_sets or list the sets of the first call in any order; listing every set after a first call that omitted row_sets fails cursor_invalid."
changedInput schema / properties / row_sets / items / enum
Previous value: -[
- "annual_ledgers",
- "selections",
- "firms",
- "issue_codes",
- "targeted_entities",
- "selected_filings",
- "activities",
- "raw_filings"
-]New value: +[
+ "annual_ledgers",
+ "selections",
+ "firms",
+ "clients",
+ "issue_codes",
+ "targeted_entities",
+ "selected_filings",
+ "activities",
+ "raw_filings"
+]
changedOutput schema / $defs / LdaAnnualLedger / properties / ambiguous_group_count / description
Previous value: -"Equal-latest groups excluded from sums."New value: +"Equal-latest groups excluded from sums; counted on annual_ledgers, always 0 on firm, client and issue breakdown ledgers."
changedOutput schema / properties / activities / description
Previous value: -"Selected activities in this window; no money columns."New value: +"Selected activities in this window, with no money columns; description and lobbyists appear only when include names them."
addedOutput schema / properties / clients
Added value: +{
+ "description": "Client relationship breakdowns in this window.",
+ "items": {
+ "additionalProperties": false,
+ "description": "Client relationship breakdown; each selected filing belongs to exactly one.",
+ "properties": {
+ "annual_ledgers": {
+ "description": "Relationship year ledgers.",
+ "items": {
+ "$ref": "#/$defs/LdaAnnualLedger"
+ },
+ "type": "array"
+ },
+ "client_id": {
+ "description": "Client relationship record ID.",
+ "type": "string"
+ },
+ "filing_uuids": {
+ "description": "Selected report UUIDs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Client name.",
+ "type": "string"
+ },
+ "registrant_id": {
+ "description": "Firm ID of this relationship.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "client_id",
+ "name",
+ "registrant_id",
+ "filing_uuids",
+ "annual_ledgers"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `invalid_filter`: Invalid scope, identifier, reference code or mode combination. `cursor_invalid`: Unknown, expired, stale or mismatched continuation. `acquisition_storage_unavailable`: Storage cannot safely retain a checkpoint. `pagination_invalid`: Invalid or nonprogressing upstream pagination. `source_schema_changed`: Successful source response violates its verified schema. `canvas_unavailable`: Explicit staging without a configured canvas. `canvas_not_found`: Supplied canvas expired or unknown. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `invalid_filter`: Invalid scope, identifier, reference code or mode combination, or an over-cap page_size or max_pages while clamping is disabled. `cursor_invalid`: Unknown, expired, stale or mismatched continuation. `acquisition_storage_unavailable`: Storage cannot safely retain a checkpoint. `pagination_invalid`: Invalid or nonprogressing upstream pagination. `source_schema_changed`: Successful source response violates its verified schema. `canvas_unavailable`: Explicit staging without a configured canvas. `canvas_not_found`: Supplied canvas expired or unknown. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / issue_code / description
Previous value: -"Requested issue membership code."New value: +"Requested issue membership code; absent for registrant-wide ledgers."
changedOutput schema / properties / issue_codes / description
Previous value: -"Overlapping issue breakdowns in this window."New value: +"Overlapping issue breakdowns in this window; with issue_code set, every row covers only selected filings that also mention issue_code."
changedOutput schema / properties / methodology / properties / client_identity / const
Previous value: -"caller_selected_relationships"New value: +"relationship_records"
changedOutput schema / properties / methodology / properties / client_identity / description
Previous value: -"No corporate identity is inferred."New value: +"Each client is one relationship record; no corporate identity is inferred."
changedOutput schema / properties / methodology / properties / selection_method / description
Previous value: -"Latest posting within relationship and quarter."New value: +"Latest posting within relationship and reporting period, quarter or half-year."
changedOutput schema / properties / offset / description
Previous value: -"Final record delivery offset."New value: +"Records delivered before this window."
changedOutput schema / properties / raw_filings / description
Previous value: -"All acquired versions in this window, including selected versions."New value: +"All acquired versions in this window, including selected versions; activity description and lobbyists appear only when include names them."
removedOutput schema / properties / record_handles
Removed value: -{
- "description": "Deferred complete parents.",
- "items": {
- "additionalProperties": false,
- "description": "Deferred parent retrieval.",
- "properties": {
- "expires_at": {
- "description": "Retained parent expiry ISO timestamp.",
- "type": "string"
- },
- "record_bytes": {
- "description": "Serialized parent UTF-8 bytes.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "record_handle": {
- "description": "Opaque retained parent handle.",
- "type": "string"
- },
- "retrieval_tool": {
- "description": "Source tool for record windows.",
- "type": "string"
- },
- "source_id": {
- "description": "Original source identity.",
- "type": "string"
- }
- },
- "required": [
- "record_handle",
- "source_id",
- "record_bytes",
- "expires_at",
- "retrieval_tool"
- ],
- "type": "object"
- },
- "type": "array"
-}
removedOutput schema / properties / record_window
Removed value: -{
- "description": "Lossless stored parent window.",
- "oneOf": [
- {
- "additionalProperties": false,
- "description": "Complete or deferred object children.",
- "properties": {
- "complete": {
- "description": "This path and included children are fully delivered.",
- "type": "boolean"
- },
- "entries": {
- "description": "Key-ordered object window.",
- "items": {
- "additionalProperties": false,
- "description": "Key and pointer; value only when it fits.",
- "properties": {
- "key": {
- "description": "Original key.",
- "type": "string"
- },
- "path": {
- "description": "Child JSON Pointer.",
- "type": "string"
- },
- "value": {
- "$ref": "#/$defs/__schema0",
- "description": "Whole child value only when it fits."
- }
- },
- "required": [
- "key",
- "path"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "kind": {
- "const": "object",
- "description": "Object-entry window.",
- "type": "string"
- },
- "next_offset": {
- "description": "Next undelivered position.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "offset": {
- "description": "Start position.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "path": {
- "description": "Selected JSON Pointer.",
- "type": "string"
- },
- "record_handle": {
- "description": "Stored parent handle.",
- "type": "string"
- },
- "returned": {
- "description": "Delivered entries or code points.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "total": {
- "description": "Total keys, items or code points at this path.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- }
- },
- "required": [
- "record_handle",
- "path",
- "total",
- "offset",
- "returned",
- "complete",
- "kind",
- "entries"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Array items preserving original indexes.",
- "properties": {
- "complete": {
- "description": "This path and included children are fully delivered.",
- "type": "boolean"
- },
- "items": {
- "description": "Indexed array window.",
- "items": {
- "additionalProperties": false,
- "description": "Original index and child pointer.",
- "properties": {
- "index": {
- "description": "Original child index.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "path": {
- "description": "Child JSON Pointer.",
- "type": "string"
- },
- "value": {
- "$ref": "#/$defs/__schema0",
- "description": "Whole child value only when it fits."
- }
- },
- "required": [
- "index",
- "path"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "kind": {
- "const": "array",
- "description": "Array-item window.",
- "type": "string"
- },
- "next_offset": {
- "description": "Next undelivered position.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "offset": {
- "description": "Start position.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "path": {
- "description": "Selected JSON Pointer.",
- "type": "string"
- },
- "record_handle": {
- "description": "Stored parent handle.",
- "type": "string"
- },
- "returned": {
- "description": "Delivered entries or code points.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "total": {
- "description": "Total keys, items or code points at this path.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- }
- },
- "required": [
- "record_handle",
- "path",
- "total",
- "offset",
- "returned",
- "complete",
- "kind",
- "items"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Unicode-code-point text fragment.",
- "properties": {
- "complete": {
- "description": "This path and included children are fully delivered.",
- "type": "boolean"
- },
- "kind": {
- "const": "string",
- "description": "Unicode text window.",
- "type": "string"
- },
- "next_offset": {
- "description": "Next undelivered position.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "offset": {
- "description": "Start position.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "path": {
- "description": "Selected JSON Pointer.",
- "type": "string"
- },
- "record_handle": {
- "description": "Stored parent handle.",
- "type": "string"
- },
- "returned": {
- "description": "Delivered entries or code points.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "text": {
- "description": "Complete-code-point text fragment.",
- "type": "string"
- },
- "total": {
- "description": "Total keys, items or code points at this path.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- }
- },
- "required": [
- "record_handle",
- "path",
- "total",
- "offset",
- "returned",
- "complete",
- "kind",
- "text"
- ],
- "type": "object"
- },
- {
- "additionalProperties": false,
- "description": "Unfragmented non-text scalar.",
- "properties": {
- "complete": {
- "description": "This path and included children are fully delivered.",
- "type": "boolean"
- },
- "kind": {
- "const": "scalar",
- "description": "Complete scalar value.",
- "type": "string"
- },
- "next_offset": {
- "description": "Next undelivered position.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "offset": {
- "description": "Start position.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "path": {
- "description": "Selected JSON Pointer.",
- "type": "string"
- },
- "record_handle": {
- "description": "Stored parent handle.",
- "type": "string"
- },
- "returned": {
- "description": "Delivered entries or code points.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "total": {
- "description": "Total keys, items or code points at this path.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
- },
- "value": {
- "anyOf": [
- {
- "description": "Null value.",
- "type": "null"
- },
- {
- "description": "Boolean value.",
- "type": "boolean"
- },
- {
- "description": "Finite numeric value.",
- "type": "number"
- }
- ],
- "description": "Exact scalar value."
- }
- },
- "required": [
- "record_handle",
- "path",
- "total",
- "offset",
- "returned",
- "complete",
- "kind",
- "value"
- ],
- "type": "object"
- }
- ]
-}
removedOutput schema / properties / records_deferred
Removed value: -{
- "description": "Oversized parents available through handles.",
- "maximum": 9007199254740991,
- "minimum": 0,
- "type": "integer"
-}
changedOutput schema / properties / records_returned / description
Previous value: -"Complete records delivered in this window."New value: +"Whole records delivered in this window."
removedOutput schema / properties / retrieval_tool
Removed value: -{
- "description": "Tool that retrieves this parent.",
- "type": "string"
-}
changedOutput schema / properties / row_set_offsets / description
Previous value: -"Selected-set rows delivered or deferred before this window; others zero."New value: +"Selected-set rows delivered before this window; others zero."
addedOutput schema / properties / row_set_offsets / properties / clients
Added value: +{
+ "description": "Client relationship breakdown records.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+}
changedOutput schema / properties / row_set_offsets / required
Previous value: -[
- "annual_ledgers",
- "selections",
- "firms",
- "issue_codes",
- "targeted_entities",
- "selected_filings",
- "activities",
- "raw_filings"
-]New value: +[
+ "annual_ledgers",
+ "selections",
+ "firms",
+ "clients",
+ "issue_codes",
+ "targeted_entities",
+ "selected_filings",
+ "activities",
+ "raw_filings"
+]
addedOutput schema / properties / row_set_totals / properties / clients
Added value: +{
+ "description": "Client relationship breakdown records.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+}
changedOutput schema / properties / row_set_totals / required
Previous value: -[
- "annual_ledgers",
- "selections",
- "firms",
- "issue_codes",
- "targeted_entities",
- "selected_filings",
- "activities",
- "raw_filings"
-]New value: +[
+ "annual_ledgers",
+ "selections",
+ "firms",
+ "clients",
+ "issue_codes",
+ "targeted_entities",
+ "selected_filings",
+ "activities",
+ "raw_filings"
+]
changedOutput schema / properties / selected_filings / description
Previous value: -"Complete selected filings in this window."New value: +"Selected filings in this window; activity description and lobbyists appear only when include names them."
changedOutput schema / properties / selections / items / properties / exclusion_reason / description
Previous value: -"Why excluded."New value: +"Why excluded. non_quarterly: a period that is neither quarterly nor semiannual. off_cycle_period: a quarterly period through 2007 or semiannual period from 2008, in a registrant/client/year that also filed the statutory grain."
changedOutput schema / properties / selections / items / properties / exclusion_reason / enum
Previous value: -[
- "registration",
- "non_quarterly",
- "unknown_variant",
- "missing_relationship"
-]New value: +[
+ "registration",
+ "non_quarterly",
+ "off_cycle_period",
+ "unknown_variant",
+ "missing_relationship"
+]
changedOutput schema / properties / truncated / description
Previous value: -"More data is available through next_cursor or record_handles; no source data was discarded."New value: +"More data is available through next_cursor; no source data was discarded."