{ "openapi": "3.0.1", "info": { "title": "Securities Class Action Filings Scraper", "description": "Scrape the Stanford Securities Class Action Clearinghouse: every federal securities class action filed since 1996 with its status, judge, filing date and case narrative, plus settlement amounts, class periods and counsel parsed from the narrative.", "version": "0.1", "x-build-id": "JwzZmrINg8cqj7AgW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~securities-class-action-filings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-securities-class-action-filings-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/parseforge~securities-class-action-filings-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-securities-class-action-filings-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/parseforge~securities-class-action-filings-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-securities-class-action-filings-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", "properties": { "caseIds": { "title": "Case ids", "type": "array", "description": "Clearinghouse case ids to fetch directly, for example 108640. The id is the number in the case page URL.", "items": { "type": "string" } }, "startUrls": { "title": "Case page URLs", "type": "array", "description": "Paste Clearinghouse case page URLs such as https://securities.stanford.edu/filings-case.html?id=108640.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: limited to 10 items (preview). Paid users: up to 1,000,000." }, "dateFrom": { "title": "Filed from", "type": "string", "description": "Earliest filing date to include, as YYYY-MM-DD. The database starts in 1996. Setting a date range switches the run from the latest-filings feed to a sweep of the case archive." }, "dateTo": { "title": "Filed to", "type": "string", "description": "Latest filing date to include, as YYYY-MM-DD. Leave empty for today." }, "caseStatuses": { "title": "Case status", "type": "array", "description": "Keep only cases in these states. The Clearinghouse publishes three: ONGOING, SETTLED and DISMISSED.", "items": { "type": "string", "enum": [ "ONGOING", "SETTLED", "DISMISSED" ], "enumTitles": [ "Ongoing", "Settled", "Dismissed" ] } }, "companyNameContains": { "title": "Company name contains", "type": "string", "description": "Keep only cases whose company name or case title contains this text, for example \"Tesla\" or \"Bancorp\"." }, "judgeNameContains": { "title": "Judge name contains", "type": "string", "description": "Keep only cases before a judge whose name contains this text, for example \"Rakoff\"." }, "summaryContains": { "title": "Case summary contains", "type": "string", "description": "Keep only cases whose narrative contains this text, for example \"restatement\", \"clinical trial\" or a law firm name." }, "sortBy": { "title": "Sort by", "enum": [ "newest", "oldest" ], "type": "string", "description": "Newest filings first, or oldest first. Cases are read in case id order, which follows the filing date.", "default": "newest" }, "includeCaseNarrative": { "title": "Full case narrative", "type": "boolean", "description": "Add the Clearinghouse's full case summary to the row: the allegations, the procedural history and, where it happened, the settlement.", "default": false }, "includeSettlementTerms": { "title": "Settlement terms", "type": "boolean", "description": "Parse the settlement: the largest amount named in a settlement sentence, every amount found, whether it was approved, the approval date and whether a D&O insurer funded it.", "default": false }, "includeClassPeriod": { "title": "Class period", "type": "boolean", "description": "Parse the class period start and end dates and its length in days.", "default": false }, "includeCounselAndPlaintiffs": { "title": "Lead plaintiffs and counsel", "type": "boolean", "description": "Parse the lead plaintiffs the court appointed, the lead counsel firms and every law firm named in the narrative.", "default": false }, "includeStatutesAndClaims": { "title": "Statutes and claims", "type": "boolean", "description": "Tag the statutes the complaint invokes: Exchange Act 10(b) and 20(a), Rule 10b-5, Securities Act 11, 12 and 15, state blue sky law and RICO.", "default": false }, "includeDocketReferences": { "title": "Docket and court references", "type": "boolean", "description": "Parse the docket numbers, the district courts and any MDL number named in the narrative.", "default": false }, "includeStockMoveMetrics": { "title": "Stock move metrics", "type": "boolean", "description": "Parse the share price move behind the case: the percentage drop, the price before and after, and the class period high.", "default": false }, "includeAllegationTags": { "title": "Allegation tags", "type": "boolean", "description": "Tag the case by allegation theme: accounting and restatement, misrepresentation, insider selling, FDA or clinical trial, merger, IPO, SPAC, crypto, artificial intelligence, cybersecurity, regulatory investigation, product safety, China-based issuer, bankruptcy and ESG.", "default": false } } }, "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 } } } } } } } } } }