{ "openapi": "3.0.1", "info": { "title": "Top Class Actions Scraper", "description": "Scrape TopClassActions.com - open, pending and closed class-action lawsuit settlements, legal news, and case-tracker entries. Get settlement eligibility, potential award, proof-of-purchase requirements, claim deadlines, and case details.", "version": "1.0", "x-build-id": "DeZdTUdHEl80zOZgC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~top-class-actions-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-top-class-actions-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/crawlerbros~top-class-actions-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-top-class-actions-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/crawlerbros~top-class-actions-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-top-class-actions-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "latest", "search", "byCategory", "openSettlements", "closedSettlements", "caseTracker", "glossary", "byUrls" ], "type": "string", "description": "What to fetch from TopClassActions.com.", "default": "openSettlements" }, "postUrls": { "title": "Article/settlement URLs (mode=byUrls)", "type": "array", "description": "Exact topclassactions.com article or settlement page URLs to fetch directly.", "default": [], "items": { "type": "string" } }, "searchQuery": { "title": "Search query (mode=search; also narrows mode=caseTracker/glossary)", "type": "string", "description": "Free-text search across article titles and content, e.g. `data breach settlement`. Required for mode=search; optional narrowing filter (matches case name/company) when mode=caseTracker; optional narrowing filter (matches term/definition) when mode=glossary.", "default": "" }, "glossaryLetter": { "title": "Glossary letter (mode=glossary)", "enum": [ "", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z" ], "type": "string", "description": "Optional narrowing filter for mode=glossary: only return glossary terms starting with this letter. Leave blank to browse/search the full glossary.", "default": "" }, "categorySlug": { "title": "Category / company slug (mode=byCategory, optional narrower filter for other modes)", "type": "string", "description": "TopClassActions category slug. Examples: `amazon-class-action-lawsuit-and-settlement-news` (company news), `data-breach` (topic), `apple-open-settlements` (per-company open settlements), `auto-news`, `banking-news`, `beauty-products`. Find slugs by browsing the site's category URLs (the last path segment). Leave empty to not filter by category.", "default": "" }, "tagSlug": { "title": "Topic tag slug (optional narrower filter)", "type": "string", "description": "Optional TopClassActions topic-tag slug to narrow results further, e.g. `abortion`, `data-breach`, `data-privacy`. This is a separate taxonomy from `categorySlug`. Find slugs by browsing the site's `/tag//` URLs. Leave empty to not filter by tag. Not applicable to mode=byUrls or mode=caseTracker.", "default": "" }, "dateFrom": { "title": "Published after (YYYY-MM-DD)", "type": "string", "description": "Only include articles published on/after this date (UTC)." }, "dateTo": { "title": "Published before (YYYY-MM-DD)", "type": "string", "description": "Only include articles published on/before this date (UTC)." }, "sortOrder": { "title": "Sort order", "enum": [ "newest", "oldest", "relevance" ], "type": "string", "description": "Order results are fetched in. `relevance` only affects mode=search.", "default": "newest" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 30 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }