{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Scraper | US Public Company Filings & Profiles", "description": "SEC EDGAR scraper & API: export US public-company filings, profiles and XBRL fundamentals (revenue, net income, assets, EPS) by ticker, CIK or name. Equity research, financial statement data and compliance — official data.sec.gov, fast, no login.", "version": "1.0", "x-build-id": "Tvu1Ew4taLoLY8zhK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~sec-edgar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-sec-edgar-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/haketa~sec-edgar-scraper/runs": { "post": { "operationId": "runs-sync-haketa-sec-edgar-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/haketa~sec-edgar-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-sec-edgar-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": { "tickers": { "title": "Stock tickers", "type": "array", "description": "The easiest way to look up companies — just type their stock tickers (case-insensitive). Each ticker becomes one row. Examples: AAPL, MSFT, BRK.B, GOOGL. Leave blank to get a diverse sample of popular US companies.", "items": { "type": "string" } }, "companyNames": { "title": "Company names", "type": "array", "description": "Prefer names over tickers? Type company names and the actor matches them to the right filer (e.g. 'apple' → Apple Inc.). For an exact match, stock tickers are more precise.", "items": { "type": "string" } }, "maxCompanies": { "title": "Max companies (0 = no limit)", "minimum": 0, "type": "integer", "description": "Cap the total number of companies returned. Useful to keep test runs fast and cheap. Set 0 for no limit.", "default": 0 }, "includeRecentFilings": { "title": "Include recent filings", "type": "boolean", "description": "Attach each company's recent SEC filings (form type, filing date, accession number and a direct document link) under recentFilings.", "default": true }, "filingFormTypes": { "title": "Keep only these filing types", "type": "array", "description": "Pick which filing types to keep. Leave empty to include every form type. Choose from the most common SEC forms below.", "items": { "type": "string", "enum": [ "10-K", "10-Q", "8-K", "S-1", "DEF 14A", "4", "3", "5", "13F-HR", "SC 13D", "SC 13G", "6-K", "20-F", "425", "424B4", "S-4" ], "enumTitles": [ "10-K — Annual report", "10-Q — Quarterly report", "8-K — Current report (material events)", "S-1 — IPO registration", "DEF 14A — Proxy statement", "Form 4 — Insider transaction", "Form 3 — Initial insider ownership", "Form 5 — Annual insider statement", "13F-HR — Institutional holdings", "SC 13D — Activist / >5% stake", "SC 13G — Passive >5% stake", "6-K — Foreign issuer report", "20-F — Foreign annual report", "425 — Merger communication", "424B4 — Prospectus", "S-4 — M&A registration" ] }, "default": [] }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 0, "maximum": 1000, "type": "integer", "description": "How many recent filings to keep for each company. Set 0 to keep all available (SEC returns up to the most recent 1,000).", "default": 50 }, "includeFundamentals": { "title": "Include financial fundamentals", "type": "boolean", "description": "Add each company's latest reported Revenue, Net Income, Total Assets and Total Stockholders' Equity from official XBRL financial data. Adds a little extra time per company.", "default": false }, "ciks": { "title": "CIK numbers (advanced)", "type": "array", "description": "Advanced: if you already know a company's SEC Central Index Key you can list it here, with or without leading zeros (e.g. 320193 or 0000320193). Most users should use tickers or company names instead.", "items": { "type": "string" } }, "userAgentEmail": { "title": "Contact email (advanced)", "type": "string", "description": "SEC asks every API client to identify itself with a contact email. The default works fine — only change it if you want your own address on record.", "default": "apify-edgar-scraper@example.com" }, "maxConcurrency": { "title": "Max concurrency (advanced)", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many companies to process in parallel. The default is tuned to stay comfortably within SEC's rate limits.", "default": 5 }, "requestDelay": { "title": "Request delay in ms (advanced)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "A small pause between requests to stay within SEC's rate limits. The default is well within the allowed range.", "default": 150 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "SEC EDGAR is open-access, so a proxy is not required and is off by default. Turn it on only if you want IP rotation for very large runs." } } }, "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 } } } } } } } } } }