Search settlements
search_settlementsSearch one settlement angle using logical AND keywords and structured status, type, state, proof, and deadline filters. Status defaults to open. Results include source metadata and quality flags.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum records returned, from 1 to 50. | |
| state | No | Optional two-letter US postal abbreviation, such as CA. | |
| status | No | Public lifecycle filter: open or upcoming. Defaults to open. Upcoming records are not yet claimable and must be presented as a separate watchlist. | open |
| keywords | No | Required logical-AND terms for specific companies, brands, products, employers, services, or incidents. Use separate queries for alternatives and settlement_type for taxonomy. | |
| deadline_after | No | Include deadlines on or after this ISO 8601 date. | |
| proof_required | No | Whether proof is required: yes, no, or unknown. | |
| deadline_before | No | Include deadlines on or before this ISO 8601 date. | |
| settlement_type | No | Exact settlement taxonomy filter. Prefer this over keywords for type concepts such as data breaches, privacy, refunds, financial fees, or consumer products. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||