{ "openapi": "3.0.1", "info": { "title": "SEC XBRL Financial Data — Company Facts & Frame Data", "description": "Download XBRL financial data from the SEC EDGAR API. Fetch any accounting concept (Assets, Revenue, NetIncomeLoss, EPS) for companies by ticker or CIK, or pull cross-company frame snapshots for a period. Covers US-GAAP and IFRS filers. No API key required.", "version": "1.0", "x-build-id": "od9A2Rl3LvSaGuU30" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/commonelements~sec-xbrl-financials/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-commonelements-sec-xbrl-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/commonelements~sec-xbrl-financials/runs": { "post": { "operationId": "runs-sync-commonelements-sec-xbrl-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/commonelements~sec-xbrl-financials/run-sync": { "post": { "operationId": "run-sync-commonelements-sec-xbrl-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", "properties": { "mode": { "title": "Mode", "enum": [ "company-facts", "frame-data" ], "type": "string", "description": "company-facts: fetch all XBRL facts for one or more companies by ticker/CIK. frame-data: fetch all companies' value for a single concept at a specific period.", "default": "company-facts" }, "tickers": { "title": "Tickers", "type": "array", "description": "Stock tickers to look up (company-facts mode). E.g. AAPL, MSFT, JPM.", "items": { "type": "string" } }, "ciks": { "title": "CIKs", "type": "array", "description": "SEC CIK numbers to look up directly (company-facts mode). Will be zero-padded to 10 digits.", "items": { "type": "string" } }, "concepts": { "title": "Concepts (fact filter)", "type": "array", "description": "Only return these XBRL concept names. Leave empty for all. E.g. Assets, Revenues, NetIncomeLoss, EarningsPerShareBasic.", "items": { "type": "string" } }, "taxonomies": { "title": "Taxonomies", "type": "array", "description": "Which XBRL taxonomies to include. us-gaap = standard US financials. dei = document/entity info. invest = investment company facts.", "default": [ "us-gaap" ], "items": { "type": "string" } }, "unitsFilter": { "title": "Units filter", "type": "array", "description": "Only return facts in these units. E.g. USD to skip per-share and pure-ratio facts.", "items": { "type": "string" } }, "maxRecordsPerCompany": { "title": "Max records per company", "minimum": 0, "type": "integer", "description": "Maximum XBRL fact records per company. 0 = unlimited.", "default": 0 }, "taxonomy": { "title": "Taxonomy (frame-data mode)", "type": "string", "description": "XBRL taxonomy for frame-data mode.", "default": "us-gaap" }, "concept": { "title": "Concept (frame-data mode)", "type": "string", "description": "XBRL concept name for frame-data mode. E.g. Assets, PremiumsEarnedNet." }, "unit": { "title": "Unit (frame-data mode)", "type": "string", "description": "Unit for frame-data mode. E.g. USD, shares, pure." }, "period": { "title": "Period (frame-data mode)", "type": "string", "description": "Period for frame-data mode. Instant: CY2024Q1I. Duration: CY2024Q1, CY2024." } } }, "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 } } } } } } } } } }