ClassAction APIclassaction.org ↗
Access class action settlements, lawsuit investigations, data breaches, and news articles from ClassAction.org via 7 structured endpoints.
What is the ClassAction API?
The ClassAction.org API exposes 7 endpoints covering open settlements, lawsuit investigations, data breaches, and news articles drawn from ClassAction.org. The get_settlement_card_details endpoint returns granular fields including payout_amount, claim_deadline, proof_required, administrator contact details, and final_approval_hearing_date. Settlements and lawsuits can be browsed with pagination or narrowed by keyword using search_settlements and search_site.
curl -X GET 'https://api.parse.bot/scraper/665da9a3-255e-4141-ba4f-480ff48290b5/list_settlements?page=0&limit=5&proof_required=Yes' \ -H 'X-API-Key: $PARSE_API_KEY'
Retrieve open class action settlements with pagination. Each settlement includes payout amounts, claim deadlines, proof requirements, and whether it is featured or new. Results are ordered by recency within the search index. Paging is controlled by page (zero-based, default 0) and limit (results per page, default 100); total and nb_pages always describe the full unfiltered settlement stream. The optional proof_required and min_payout filters are applied within the requested page: settlements that do not match are dropped from that page, matched_count reports how many remain, and a page can legitimately be empty while later pages still contain matches. payout_max is the largest dollar figure parsed from the site's payout text (e.g. '$50 - $5,000' gives 5000) and is null when the text carries no figure ('Varies', 'N/A'); min_payout keeps only settlements whose payout_max is at or above the given value, so settlements with a null payout_max are always dropped by that filter. Unknown proof_required values and non-numeric min_payout values are rejected with a stale_input error.
| Param | Type | Description |
|---|---|---|
| page | integer | Zero-based page number for pagination. |
| limit | integer | Max results per page. |
| min_payout | number | Minimum payout in US dollars. Keep only settlements whose payout_max (largest dollar figure in the payout text) is at or above this value; settlements with no parseable dollar figure are dropped. Omit to skip payout filtering. |
| proof_required | string | Keep only settlements whose proof requirement equals this value (matched case-insensitively). Omit to return every settlement on the page. |
{
"type": "object",
"fields": {
"page": "integer current page number",
"total": "integer total number of settlements in the unfiltered stream",
"nb_pages": "integer total number of pages in the unfiltered stream",
"settlements": "array of settlement summary objects (name, description, payout_amount, payout_max, claim_deadline, proof_required, official_website, is_featured, is_new, is_active, path, object_id)",
"matched_count": "integer number of settlements returned on this page after applying proof_required and min_payout (equals the page size when no filter is given)",
"settlements[].payout_max": "number or null: largest dollar figure parsed from payout_amount; null when the text has no figure (e.g. 'Varies')"
},
"sample": {
"data": {
"page": 0,
"total": 3170,
"nb_pages": 50,
"settlements": [
{
"name": "Laboratory Services Cooperative - Data Breach",
"path": "",
"is_new": true,
"is_active": true,
"object_id": "18530755001",
"payout_max": 6000,
"description": "You may be included in this settlement if your personal information was exposed in the Laboratory Services Cooperative data breach discovered in October 2024.",
"is_featured": false,
"payout_amount": "Up to $6,000",
"claim_deadline": "11/24/2026",
"proof_required": "No",
"official_website": "https://www.lscdatasettlement.com/"
},
{
"name": "Drug and Alcohol Treatment Services - Data Breach",
"path": "",
"is_new": false,
"is_active": false,
"object_id": "114721000",
"payout_max": 5000,
"description": "You may be included in this settlement if your personal information was impacted by the October 2024 Drug and Alcohol Treatment Services data breach.",
"is_featured": false,
"payout_amount": "Up to $5,000",
"claim_deadline": "09/24/2026",
"proof_required": "No",
"official_website": "https://www.datsdatabreachsettlement.com/"
}
],
"matched_count": 2
},
"status": "success"
}
}About the ClassAction API
Settlements
list_settlements returns paginated settlement summaries with fields for payout_amount, claim_deadline, proof_required, and official_website. Pages are zero-indexed; pass page and limit to walk through the full dataset. search_settlements accepts a query string — such as a company name or topic like "Data Breach" — and filters results to the Settlements content type. For richer detail on any individual item, pass its object_id to get_settlement_card_details, which adds a full description, a structured administrator object with optional name, phone, and email, and a final_approval_hearing_date extracted from related filings where available.
Lawsuits and Data Breaches
list_lawsuits pages through active lawsuit investigations, returning each record's name, description, summary, is_featured flag, path, and object_id. list_data_breaches covers reported breaches with company, impacted_data, report_date, and a path you can use for further lookup. Both endpoints support page and limit parameters. Neither endpoint currently exposes a keyword filter of its own, but search_site spans all content types — settlements, lawsuits, news, and data breaches — and returns raw hit objects with name, path, description, pageTypeTitle, and Algolia highlight metadata in a single response.
News and Articles
get_news_article retrieves full article text by path (e.g. '/news/michael-kors-settlement'), returning title, content, description, published_at, and modified_at. Paths for articles are obtainable from search_site results. This makes it practical to programmatically fetch the editorial content attached to a specific settlement or investigation rather than just the structured card data.
The ClassAction API is a managed, monitored endpoint for classaction.org — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when classaction.org changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official classaction.org API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Build a settlement eligibility checker that surfaces
claim_deadlineandproof_requiredfor a user's product purchases - Track newly listed data breaches using
list_data_breachesto alert users when their company or sector appears - Aggregate administrator contact details from
get_settlement_card_detailsfor legal research or claims filing workflows - Monitor
final_approval_hearing_datefields to schedule automated reminders before a settlement closes - Combine
search_siteacross content types to build a cross-referenced legal news feed covering lawsuits, breaches, and settlements - Index lawsuit investigation summaries from
list_lawsuitsto power a consumer-facing notification service by industry or defendant name - Extract full article text via
get_news_articleto feed a legal news digest or case-update email system
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 200 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
| Team | $300/mo | 20,000 | 300 req/min |
| Company | $1,000/mo | 100,000 | 500 req/min |
Each endpoint has a fixed posted price per successful call — most fall between 1 and 10 credits — shown on this API's page before you run it. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does ClassAction.org have an official developer API?+
What does `get_settlement_card_details` return beyond what `list_settlements` provides?+
list_settlements returns summary-level fields: name, description, payout_amount, claim_deadline, proof_required, and official_website. get_settlement_card_details adds a full summary, a structured administrator object (with name, phone, and email where available), and a final_approval_hearing_date sourced from related newswire filings. Pass the object_id from a listing result to retrieve these details.Can I search lawsuits or data breaches by keyword directly?+
list_lawsuits and list_data_breaches support pagination but not keyword filtering on their own. search_settlements filters by keyword scoped to settlements only. For cross-type keyword search covering lawsuits, breaches, and news simultaneously, use search_site with a query string — it returns hits tagged with pageTypeTitle so you can filter by content type in your application.Does the API expose case filing documents, court dockets, or attorney contact information?+
How current is the settlement and breach data?+
published_at date, and news articles expose both published_at and modified_at fields so you can detect updates. There is no webhook or delta endpoint — to detect new entries you need to compare paginated results across successive calls.