{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Filings Scraper & API: Full-Text Search, Alerts", "description": "SEC EDGAR full-text search or latest filings by ticker/CIK: 8-K, 10-K, 10-Q, Form D and more. New-only monitoring, lastDays window and webhook alerts. If SEC throttles, the run says so instead of returning an empty result.", "version": "0.1", "x-build-id": "6yMJT4YBEZzhA9Fvs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stazis~sec-edgar-filings-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stazis-sec-edgar-filings-api", "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/stazis~sec-edgar-filings-api/runs": { "post": { "operationId": "runs-sync-stazis-sec-edgar-filings-api", "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/stazis~sec-edgar-filings-api/run-sync": { "post": { "operationId": "run-sync-stazis-sec-edgar-filings-api", "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": { "mode": { "title": "Mode", "enum": [ "search", "company" ], "type": "string", "description": "'search' = EDGAR full-text search across all filings (uses Query, Forms, dates, states). 'company' = latest filings of the tickers/CIKs below.", "default": "search" }, "query": { "title": "Search phrase", "type": "string", "description": "Full-text search phrase. Use double quotes for an exact phrase, e.g. \"going concern\" or \"material weakness\". Search mode only." }, "tickers": { "title": "Tickers or CIKs (company mode)", "type": "array", "description": "Company mode: tickers or CIK numbers, e.g. AAPL, MSFT, 320193.", "items": { "type": "string" } }, "forms": { "title": "Form types", "type": "array", "description": "Form types to include, e.g. 8-K, 10-K, 10-Q, S-1, D. Empty = all forms (insider forms 3/4/5/144 are always excluded).", "items": { "type": "string" } }, "dateFrom": { "title": "Filed from (YYYY-MM-DD)", "type": "string", "description": "Filed on or after this date (YYYY-MM-DD)." }, "dateTo": { "title": "Filed to (YYYY-MM-DD)", "type": "string", "description": "Filed on or before this date (YYYY-MM-DD)." }, "lastDays": { "title": "Last N days (optional)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only filings from the last N days (sets 'Filed from' automatically when it is empty). Handy with a daily schedule: lastDays 1 or 2." }, "states": { "title": "Business states (search mode)", "type": "array", "description": "Search mode: two-letter US state codes of the company's business address, e.g. CA, NY.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum filings returned. Full-text search returns at most 10,000 hits per query (SEC limit). Also caps the cost.", "default": 100 }, "onlyNew": { "title": "Only new since last run", "type": "boolean", "description": "Monitor mode: return only filings not returned by earlier runs. Use with a daily schedule for alerts.", "default": false }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Name of the key-value store that 'Only new' uses. Use a different name per saved search.", "default": "sec-edgar-state" }, "webhookUrl": { "title": "Webhook URL for alerts (optional)", "type": "string", "description": "When the run returns filings, POST one JSON message ({text, count, filings[]}) here, e.g. a Slack or Discord incoming webhook or a Zapier/Make hook. Combine with 'Only new' and a schedule for filing alerts." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }