{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Company Fundamentals Scraper", "description": "Scrape SEC EDGAR filings and XBRL financial fundamentals for any US public company. Returns filings, financial statements, and key metrics by ticker or CIK. No API key. Pay per record; empty or failed runs cost nothing.", "version": "0.1", "x-build-id": "BrU7DW7YpytRUNNGP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chrisp1211~sec-edgar-scraper-max/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chrisp1211-sec-edgar-scraper-max", "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/chrisp1211~sec-edgar-scraper-max/runs": { "post": { "operationId": "runs-sync-chrisp1211-sec-edgar-scraper-max", "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/chrisp1211~sec-edgar-scraper-max/run-sync": { "post": { "operationId": "run-sync-chrisp1211-sec-edgar-scraper-max", "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": "Tickers", "type": "array", "description": "Stock ticker symbols to look up, e.g. AAPL, MSFT, NVDA. Resolved to a CIK via SEC's official ticker map.", "items": { "type": "string" } }, "ciks": { "title": "CIKs (optional)", "type": "array", "description": "SEC Central Index Keys, with or without zero-padding, e.g. 320193 or CIK0000320193. Use instead of / alongside tickers.", "items": { "type": "string" } }, "includeFilings": { "title": "Include filings", "type": "boolean", "description": "Emit one record per recent filing (form, date, accession, primary document URL).", "default": true }, "includeFundamentals": { "title": "Include fundamentals", "type": "boolean", "description": "Emit clean XBRL fundamental data points (deduped across restatements) for the selected tags.", "default": true }, "fundamentalTags": { "title": "Fundamental tags", "type": "array", "description": "us-gaap / dei XBRL concept tags to extract, e.g. Revenues, NetIncomeLoss, Assets, StockholdersEquity. Defaults to a core set when left empty.", "items": { "type": "string" } }, "filingForms": { "title": "Filing form filter (optional)", "type": "array", "description": "Only keep filings whose form matches one of these, e.g. 10-K, 10-Q, 8-K. Empty = all forms.", "items": { "type": "string" } }, "maxFilings": { "title": "Max filings per company", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Cap on recent filing records per company (default 50, max 1000). Set 0 to skip filings entirely.", "default": 50 }, "fromYear": { "title": "From year (optional)", "type": "integer", "description": "Only keep filings and fundamentals from this calendar/fiscal year or later, e.g. 2020." }, "userAgent": { "title": "User-Agent (recommended)", "type": "string", "description": "Descriptive User-Agent SEC requires for automated access, e.g. \"my-company-research you@example.com\". A default is used if left blank." }, "maxCostUsd": { "title": "Max cost per run (USD)", "minimum": 1, "type": "integer", "description": "HARD budget cap. The run stops cleanly before exceeding this." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "SEC EDGAR is an open, automation-permitted API; no proxy needed. Default is fine.", "default": { "useApifyProxy": 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 } } } } } } } } } }