{ "openapi": "3.0.1", "info": { "title": "Company Financials API: SEC EDGAR XBRL Fundamentals", "description": "Financials of US listed companies and foreign issuers from the official SEC EDGAR XBRL API: revenue, net income, EPS, cash flow, balance sheet and margins. One row per fiscal year or quarter, Q4 computed. Also lists 10-K, 10-Q and 8-K filings. No API key.", "version": "0.1", "x-build-id": "cHEa6sOIVQi3HqmiS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/boubap~sec-edgar-financials/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-boubap-sec-edgar-financials", "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/boubap~sec-edgar-financials/runs": { "post": { "operationId": "runs-sync-boubap-sec-edgar-financials", "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/boubap~sec-edgar-financials/run-sync": { "post": { "operationId": "run-sync-boubap-sec-edgar-financials", "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. US listed companies and foreign issuers that file with the SEC. At most 500 per run.", "items": { "type": "string" } }, "mode": { "title": "What to return", "enum": [ "financials", "filings" ], "type": "string", "description": "Financials gives normalized income statement, balance sheet and cash flow figures per fiscal year or quarter. Filings lists the company's SEC filings with links to the documents.", "default": "financials" }, "period": { "title": "Periods (financials)", "enum": [ "annual", "quarterly", "both" ], "type": "string", "description": "Fiscal years, fiscal quarters, or both. Quarterly cash flows and fourth quarters are computed from year-to-date and annual figures, and listed in derivedMetrics.", "default": "annual" }, "fiscalYearFrom": { "title": "From fiscal year (financials)", "minimum": 2009, "type": "integer", "description": "Oldest fiscal year to return. Default: 5 years ago. XBRL data starts in 2009 for large companies and in 2011 for the others." }, "formTypes": { "title": "Form types (filings)", "type": "array", "description": "Forms to return, one per line, for example 10-K, 10-Q, 8-K, 20-F, DEF 14A, S-1. Leave empty for all company forms. Forms 3, 4, 5, 144, Schedules 13D and 13G and proxy material from dissident shareholders (DFAN14A, PREN14A, DEFN14A) are never returned: they are filed by or about individuals.", "default": [ "10-K", "10-Q", "8-K" ], "items": { "type": "string" } }, "includeAmendments": { "title": "Include amendments (filings)", "type": "boolean", "description": "Also return amended versions of the requested forms, such as 10-K/A for 10-K.", "default": true }, "filedFrom": { "title": "Filed from (filings)", "type": "string", "description": "Oldest filing date (YYYY-MM-DD). Default: one year ago. EDGAR goes back to 1994. On a schedule, set it to the date of the previous run: each run bills every filing it returns." }, "filedTo": { "title": "Filed to (filings)", "type": "string", "description": "Latest filing date (YYYY-MM-DD). Leave empty for today." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of rows for the whole run, across all companies. Each row is billed once.", "default": 1000 }, "userAgentContact": { "title": "Your contact for the SEC (optional)", "type": "string", "description": "The SEC asks automated tools to say who is calling. By default the Actor declares itself with its Apify page. Set your organization and a contact address here, for example Acme Corp data@acme.com, if you prefer to be identified directly." } } }, "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 } } } } } } } } } }