{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Financial Statements: XBRL Company Fundamentals", "description": "Company fundamentals from SEC EDGAR XBRL: revenue, net income, EPS, assets, liabilities, equity, cash flow and capex per 10-K or 10-Q period, by ticker or CIK. One clean row per company-period, latest restated values, only-new mode. $2 per 1,000 company-periods.", "version": "0.1", "x-build-id": "VUyczCQfa6thmYzgb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/opendata-feeds~sec-edgar-fundamentals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-opendata-feeds-sec-edgar-fundamentals", "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/opendata-feeds~sec-edgar-fundamentals/runs": { "post": { "operationId": "runs-sync-opendata-feeds-sec-edgar-fundamentals", "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/opendata-feeds~sec-edgar-fundamentals/run-sync": { "post": { "operationId": "run-sync-opendata-feeds-sec-edgar-fundamentals", "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 (tickers or CIKs)", "type": "array", "description": "Stock tickers (AAPL, BRK-B) or SEC CIK numbers (320193, 0000320193 or CIK0000320193). Tickers are resolved with the SEC's company_tickers.json.", "items": { "type": "string" } }, "periodType": { "title": "Periods", "enum": [ "annual", "quarterly", "both" ], "type": "string", "description": "Annual periods come from 10-K filings, quarterly periods (Q1 to Q3) from 10-Q filings.", "default": "annual" }, "fromYear": { "title": "From fiscal year", "minimum": 0, "type": "integer", "description": "Keep periods whose fiscal year is this year or later. 0 keeps all years (XBRL data starts around 2009).", "default": 2020 }, "metrics": { "title": "Metrics", "type": "array", "description": "Which normalized metrics to include. Empty means all of them.", "items": { "type": "string", "enum": [ "revenue", "netIncome", "operatingIncome", "assets", "liabilities", "stockholdersEquity", "cashAndEquivalents", "epsBasic", "epsDiluted", "sharesOutstanding", "weightedAverageDilutedShares", "operatingCashFlow", "capitalExpenditure" ], "enumTitles": [ "Revenue", "Net income", "Operating income", "Total assets", "Total liabilities", "Stockholders' equity", "Cash and cash equivalents", "EPS (basic)", "EPS (diluted)", "Shares outstanding", "Weighted average diluted shares", "Operating cash flow", "Capital expenditure" ] }, "default": [] }, "onlyNew": { "title": "Only periods not delivered before", "type": "boolean", "description": "For scheduled runs: remember the company-periods already delivered (by filing and period end) and return, and charge for, only new ones. An amended filing counts as new.", "default": false }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Name for the only-new memory, so different schedules keep separate lists.", "default": "default" }, "maxItems": { "title": "Max company-periods per run", "minimum": 0, "type": "integer", "description": "0 means no limit. Newest periods of each company come first. Use the run's maximum-cost setting to cap spend overall.", "default": 0 }, "userAgent": { "title": "Your SEC User-Agent (optional)", "type": "string", "description": "The SEC asks automated clients to identify themselves, as \"Company Name contact@example.com\". Leave empty to use the Actor's own declared User-Agent." } } }, "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 } } } } } } } } } }