{ "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": "3UxDAQZE5E9ic0Lbm" }, "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": "US-listed stock tickers (case-insensitive). Each becomes one output row. Examples: 'AAPL', 'MSFT', 'BRK.B', 'GOOGL'. Resolved against SEC's official ticker→CIK mapping.", "items": { "type": "string" } }, "ciks": { "title": "CIK Numbers", "type": "array", "description": "Central Index Keys, with or without leading zeros. Examples: '320193', '0000320193', '1652044'. Use this when you already know the CIKs.", "items": { "type": "string" } }, "companyNames": { "title": "Company Names (fuzzy)", "type": "array", "description": "Free-text company names. The actor case-insensitively matches against SEC's official mapping titles ('apple' → 'Apple Inc.'). Use tickers / CIKs for exact lookups.", "items": { "type": "string" } }, "includeRecentFilings": { "title": "Include Recent Filings", "type": "boolean", "description": "Attach the company's recent SEC filings (form, filing date, accession number, direct document URL) under recentFilings.", "default": true }, "maxFilingsPerCompany": { "title": "Max Filings Per Company", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Cap on how many recent filings to keep per company. SEC's submissions endpoint already returns the most-recent 1,000; we trim to your cap.", "default": 50 }, "filingFormTypes": { "title": "Filing Form Types Filter", "type": "array", "description": "Filter the recent-filings list to these form types. Common values: 10-K (annual), 10-Q (quarterly), 8-K (current report), S-1 (IPO registration), DEF 14A (proxy), 4 (insider transaction). Leave empty to keep every form type.", "items": { "type": "string" } }, "includeFundamentals": { "title": "Include XBRL Fundamentals (slow)", "type": "boolean", "description": "Pull the latest reported value of Revenues, Net Income, Total Assets and Total Stockholders' Equity from SEC's XBRL companyfacts endpoint. Adds ~1 extra request per company.", "default": false }, "userAgentEmail": { "title": "Contact Email for User-Agent", "type": "string", "description": "SEC requires every API client to identify themselves with an email in the User-Agent header. Leave the default if you don't have a preference; the actor still works either way.", "default": "apify-edgar-scraper@example.com" }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many companies to process in parallel. SEC's rate limit is 10 req/s — keep this ≤8 to leave headroom.", "default": 5 }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Per-request delay inside a worker. 150 ms × 5 workers ≈ 6 req/s, well under SEC's 10 req/s cap.", "default": 150 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional — SEC EDGAR is open-access from any IP, no anti-bot, no Cloudflare, so proxy is OFF by default. Turn it on if your runs share an account with other heavy SEC consumers and you want IP rotation." } } }, "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 } } } } } } } } } }