{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Filings & XBRL Financials API", "description": "Official SEC EDGAR data as clean JSON for analysts and AI agents: every filing (10-K, 10-Q, 8-K, Form 4, S-1...) with document links, and XBRL financials (revenue, net income, EPS, assets...) as one value per period. By ticker or CIK, no API key.", "version": "1.0", "x-build-id": "VaePcEwyXPvArM8EC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sam_i_am_not~sec-edgar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sam_i_am_not-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/sam_i_am_not~sec-edgar-scraper/runs": { "post": { "operationId": "runs-sync-sam_i_am_not-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/sam_i_am_not~sec-edgar-scraper/run-sync": { "post": { "operationId": "run-sync-sam_i_am_not-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", "required": [ "companies" ], "properties": { "companies": { "title": "Companies", "type": "array", "description": "Stock tickers (\"AAPL\", \"BRK.B\") or SEC CIK numbers (\"320193\"), one per line. CIKs also work for companies without a ticker, such as private issuers, funds and insiders.", "items": { "type": "string" } }, "dataTypes": { "title": "Data to fetch", "type": "array", "description": "Filings: the company's EDGAR filings with links to the documents, billed per filing. Financials: XBRL numbers from 10-K/10-Q reports, billed per fact.", "items": { "type": "string", "enum": [ "filings", "financials" ], "enumTitles": [ "Filings", "Financials (XBRL facts)" ] }, "default": [ "filings" ] }, "formTypes": { "title": "Form types", "type": "array", "description": "Only return filings of these forms, e.g. 10-K, 10-Q, 8-K, 4, S-1, DEF 14A, 13F-HR. Amendments are separate forms (\"10-K/A\"). Leave empty for every form.", "items": { "type": "string" } }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 0, "type": "integer", "description": "Newest first. 0 = no limit (large companies have several thousand filings, most of them Form 4 insider trades).", "default": 100 }, "concepts": { "title": "Financial concepts", "type": "array", "description": "XBRL concept names, e.g. \"NetIncomeLoss\" or \"us-gaap:Revenues\". Leave empty for the headline set: revenue, operating and net income, EPS, assets, liabilities, equity, cash, operating cash flow and shares outstanding. Use \"*\" for every concept the company reports (often 10,000+ facts per company).", "items": { "type": "string" } }, "factPeriods": { "title": "Periods", "type": "array", "description": "Which kinds of period to return. Annual and quarterly are flows (revenue, income); point in time is balance-sheet values (assets, cash, shares). Leave empty for all.", "items": { "type": "string", "enum": [ "annual", "quarterly", "instant", "other" ], "enumTitles": [ "Annual (about 12 months)", "Quarterly (about 3 months)", "Point in time (balance sheet)", "Other (e.g. 6- or 9-month year to date)" ] } }, "allFactValues": { "title": "Every reported value", "type": "boolean", "description": "Off: one value per period, the latest one SEC assigns to the calendar period (a clean time series). On: every value as reported in every filing, including prior-year comparatives and restatements (3-4x more rows).", "default": false }, "dateFrom": { "title": "From date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "YYYY-MM-DD. Filings filed on or after this date; facts whose period ends on or after it." }, "dateTo": { "title": "To date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "YYYY-MM-DD. Filings filed on or before this date; facts whose period ends on or before it." }, "contactEmail": { "title": "Contact email (optional)", "type": "string", "description": "SEC asks API clients to identify themselves. If you set an email, it's sent to sec.gov in the User-Agent header instead of this Actor's name. It isn't stored or sent anywhere else." } } }, "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 } } } } } } } } } }