{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Financial Data & Company Screener (XBRL)", "description": "Screen every US public company by any financial metric, or pull one company's history. Official SEC XBRL data, every figure linked to its filing.", "version": "0.0", "x-build-id": "G8J5yQ3Z15cDXGpiL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/groundtruth~sec-edgar-financial-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-groundtruth-sec-edgar-financial-data", "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/groundtruth~sec-edgar-financial-data/runs": { "post": { "operationId": "runs-sync-groundtruth-sec-edgar-financial-data", "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/groundtruth~sec-edgar-financial-data/run-sync": { "post": { "operationId": "run-sync-groundtruth-sec-edgar-financial-data", "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": [ "screen", "company" ], "type": "string", "description": "'screen' compares one metric across every US public company for a period. 'company' returns one company's history of that metric.", "default": "screen" }, "metric": { "title": "Financial metric", "type": "string", "description": "revenue, net_income, assets, liabilities, equity, cash, operating_income, gross_profit, eps_basic, eps_diluted, operating_cash_flow, capex, long_term_debt, inventory, goodwill, rd_expense, shares_outstanding, and more. A raw XBRL tag such as 'Revenues' also works.", "default": "revenue" }, "company": { "title": "Company (ticker or CIK)", "type": "string", "description": "Required in 'company' mode. A ticker like AAPL, or a CIK number." }, "period": { "title": "Period", "type": "string", "description": "Used in 'screen' mode. Calendar year like CY2024, or a quarter like CY2024Q1. Balance-sheet metrics are adjusted automatically.", "default": "CY2024" }, "period_type": { "title": "Period type", "enum": [ "any", "quarterly", "half_year", "nine_month", "annual", "instant" ], "type": "string", "description": "Filters by reporting period length. A 10-Q reports both the quarter AND the year-to-date figure, so without this you can accidentally compare a 3-month number to a 9-month one.", "default": "any" }, "min_value": { "title": "Minimum value", "type": "integer", "description": "Only companies at or above this figure. Negative values are legal (losses)." }, "max_value": { "title": "Maximum value", "type": "integer", "description": "Only companies at or below this figure." }, "order": { "title": "Order", "enum": [ "desc", "asc" ], "type": "string", "description": "Sort direction. 'Largest first' ranks companies by value descending; in company mode it orders by most recent period first.", "default": "desc" }, "limit": { "title": "Number of records", "minimum": 1, "maximum": 200, "type": "integer", "description": "1 to 200.", "default": 50 } } }, "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 } } } } } } } } } }