Redra

Search 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.

{
  "type": "object",
  "properties": {
    "keywords": {
      "anyOf": [
        {
          "items": {
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "maxItems": 20,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Required logical-AND terms for specific companies, brands, products, employers, services, or incidents. Use separate queries for alternatives and settlement_type for taxonomy.",
      "title": "Keywords"
    },
    "state": {
      "anyOf": [
        {
          "maxLength": 2,
          "minLength": 2,
          "pattern": "^[A-Za-z]{2}$",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional two-letter US postal abbreviation, such as CA.",
      "title": "State"
    },
    "status": {
      "default": "open",
      "description": "Public lifecycle filter: open or upcoming. Defaults to open. Upcoming records are not yet claimable and must be presented as a separate watchlist.",
      "enum": [
        "open",
        "upcoming"
      ],
      "title": "Status",
      "type": "string"
    },
    "settlement_type": {
      "anyOf": [
        {
          "enum": [
            "class_action_settlement",
            "consumer_product_settlement",
            "data_breach_settlement",
            "financial_fee_settlement",
            "government_refund",
            "other_consumer_compensation",
            "privacy_settlement",
            "regulatory_compensation_program",
            "state_ag_refund"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Exact settlement taxonomy filter. Prefer this over keywords for type concepts such as data breaches, privacy, refunds, financial fees, or consumer products.",
      "title": "Settlement Type"
    },
    "proof_required": {
      "anyOf": [
        {
          "enum": [
            "yes",
            "no",
            "unknown"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Whether proof is required: yes, no, or unknown.",
      "title": "Proof Required"
    },
    "deadline_after": {
      "anyOf": [
        {
          "format": "date",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Include deadlines on or after this ISO 8601 date.",
      "title": "Deadline After"
    },
    "deadline_before": {
      "anyOf": [
        {
          "format": "date",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Include deadlines on or before this ISO 8601 date.",
      "title": "Deadline Before"
    },
    "limit": {
      "default": 20,
      "description": "Maximum records returned, from 1 to 50.",
      "maximum": 50,
      "minimum": 1,
      "title": "Limit",
      "type": "integer"
    }
  },
  "title": "search_settlementsArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "search_settlementsDictOutput"
}

Run up to 50 independent settlement searches and deduplicate records across queries. Results include matched_query_indices, and executed_query_count reports the number of searches performed. Use when several unrelated search angles should be evaluated together.

{
  "type": "object",
  "properties": {
    "queries": {
      "description": "Independent settlement searches. Each query retains logical-AND keyword semantics; unrelated alternatives belong in separate query objects.",
      "items": {
        "$ref": "#/$defs/SearchQuery"
      },
      "maxItems": 50,
      "minItems": 1,
      "title": "Queries",
      "type": "array"
    },
    "max_total_results": {
      "default": 50,
      "description": "Maximum unique settlement records returned across the whole batch after cross-query deduplication. This caps output, not the number of independent searches performed.",
      "maximum": 100,
      "minimum": 1,
      "title": "Max Total Results",
      "type": "integer"
    }
  },
  "required": [
    "queries"
  ],
  "$defs": {
    "SearchQuery": {
      "additionalProperties": false,
      "properties": {
        "keywords": {
          "description": "Terms combined with logical AND. Put unrelated companies, products, or alternatives in separate batch query objects.",
          "items": {
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "maxItems": 20,
          "title": "Keywords",
          "type": "array"
        },
        "state": {
          "anyOf": [
            {
              "maxLength": 2,
              "minLength": 2,
              "pattern": "^[A-Za-z]{2}$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Optional two-letter US postal abbreviation, such as CA.",
          "title": "State"
        },
        "status": {
          "default": "open",
          "description": "Public lifecycle filter: open or upcoming. Defaults to open. Upcoming records are not yet claimable and belong in a separate watchlist.",
          "enum": [
            "open",
            "upcoming"
          ],
          "title": "Status",
          "type": "string"
        },
        "settlement_type": {
          "anyOf": [
            {
              "enum": [
                "class_action_settlement",
                "consumer_product_settlement",
                "data_breach_settlement",
                "financial_fee_settlement",
                "government_refund",
                "other_consumer_compensation",
                "privacy_settlement",
                "regulatory_compensation_program",
                "state_ag_refund"
              ],
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Exact settlement taxonomy filter. Use this instead of keywords for type concepts such as privacy, data breaches, or financial fees.",
          "title": "Settlement Type"
        },
        "proof_required": {
          "anyOf": [
            {
              "enum": [
                "yes",
                "no",
                "unknown"
              ],
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Whether proof is required: yes, no, or unknown.",
          "title": "Proof Required"
        },
        "deadline_after": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Include deadlines on or after this ISO 8601 date.",
          "title": "Deadline After"
        },
        "deadline_before": {
          "anyOf": [
            {
              "format": "date",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Include deadlines on or before this ISO 8601 date.",
          "title": "Deadline Before"
        },
        "limit": {
          "default": 20,
          "description": "Maximum results for this independent query, from 1 to 50.",
          "maximum": 50,
          "minimum": 1,
          "title": "Limit",
          "type": "integer"
        }
      },
      "title": "SearchQuery",
      "type": "object"
    }
  },
  "title": "search_settlements_batchArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "search_settlements_batchDictOutput"
}

Return the complete stored record and official source links for one settlement ID produced by a search.

{
  "type": "object",
  "properties": {
    "settlement_id": {
      "description": "Exact settlement identifier returned by a search.",
      "maxLength": 200,
      "minLength": 1,
      "title": "Settlement Id",
      "type": "string"
    }
  },
  "required": [
    "settlement_id"
  ],
  "title": "get_settlementArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "get_settlementDictOutput"
}

Return complete stored records and official source links for up to 20 settlement IDs produced by search.

{
  "type": "object",
  "properties": {
    "settlement_ids": {
      "description": "Settlement identifiers returned by search to retrieve together.",
      "items": {
        "maxLength": 200,
        "minLength": 1,
        "type": "string"
      },
      "maxItems": 20,
      "minItems": 1,
      "title": "Settlement Ids",
      "type": "array"
    }
  },
  "required": [
    "settlement_ids"
  ],
  "title": "get_settlementsArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "get_settlementsDictOutput"
}

Return source, license, freshness, counts, and hosted aggregate metrics.

{
  "type": "object",
  "properties": {},
  "title": "get_dataset_infoArguments"
}

{
  "type": "object",
  "additionalProperties": true,
  "title": "get_dataset_infoDictOutput"
}