{ "openapi": "3.0.1", "info": { "title": "SEC XBRL Screener - Company Financials Data", "description": "Screen US public companies on SEC XBRL financial data: pick metrics and a period, get one row per company with a column for each, such as revenue, net income, assets, cash and R&D, joined across thousands of SEC EDGAR filers. Sort like a stock screener. No API key.", "version": "0.1", "x-build-id": "fTViuGOZd08OATQ7W" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataio~sec-edgar-xbrl-financial-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataio-sec-edgar-xbrl-financial-screener", "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/dataio~sec-edgar-xbrl-financial-screener/runs": { "post": { "operationId": "runs-sync-dataio-sec-edgar-xbrl-financial-screener", "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/dataio~sec-edgar-xbrl-financial-screener/run-sync": { "post": { "operationId": "run-sync-dataio-sec-edgar-xbrl-financial-screener", "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": [ "metrics", "year", "quarter" ], "properties": { "metrics": { "title": "Metrics", "type": "array", "description": "One column per metric, joined across every company that reported it. Pick two or three to start: each one is a separate call to the SEC, so ten metrics take ten times as long. Balance-sheet items are marked — they are measured at a date rather than over a period, and this Actor handles that difference for you.", "items": { "type": "string", "enum": [ "revenue", "revenue-strict", "revenue-from-contracts", "gross-profit", "operating-income", "net-income", "rd-expense", "sga-expense", "interest-expense", "eps-diluted", "eps-basic", "operating-cash-flow", "capex", "assets", "liabilities", "equity", "cash", "long-term-debt", "inventory", "goodwill", "shares-outstanding" ], "enumTitles": [ "Revenue (any reported basis)", "Revenue (us-gaap:Revenues only)", "Revenue from contracts (ASC 606)", "Gross profit", "Operating income", "Net income", "R&D expense", "SG&A expense", "Interest expense", "EPS, diluted", "EPS, basic", "Operating cash flow", "Capital expenditure", "Total assets (balance sheet)", "Total liabilities (balance sheet)", "Stockholders' equity (balance sheet)", "Cash and equivalents (balance sheet)", "Long-term debt (balance sheet)", "Inventory (balance sheet)", "Goodwill (balance sheet)", "Shares outstanding (balance sheet)" ] }, "default": [ "revenue", "net-income", "assets" ] }, "year": { "title": "Year", "minimum": 2009, "maximum": 2030, "type": "integer", "description": "Calendar year. XBRL filings start around 2009, and the most recent quarters fill in over several months as companies file.", "default": 2025 }, "quarter": { "title": "Period", "enum": [ "Q1", "Q2", "Q3", "Q4", "FY" ], "type": "string", "description": "A calendar quarter, or the full year. Quarterly coverage is broader than annual, because most filers report quarterly.", "default": "Q1" }, "onlyComplete": { "title": "Only companies reporting every metric", "type": "boolean", "description": "Off by default, because it can cut the result sharply: a company that did not tag one concept disappears entirely. Turn it on when you need a rectangular table for analysis.", "default": false }, "maxItems": { "title": "Maximum companies", "minimum": 1, "maximum": 50000, "type": "integer", "description": "One row per company, sorted by the sort metric.", "default": 2000 }, "sortBy": { "title": "Sort by", "enum": [ "revenue", "revenue-strict", "revenue-from-contracts", "gross-profit", "operating-income", "net-income", "rd-expense", "sga-expense", "interest-expense", "eps-diluted", "eps-basic", "operating-cash-flow", "capex", "assets", "liabilities", "equity", "cash", "long-term-debt", "inventory", "goodwill", "shares-outstanding" ], "type": "string", "description": "Must be one of the metrics you selected. Defaults to the first one. Sorted high to low; companies missing the value sort last." }, "minValue": { "title": "Minimum value on the sort metric", "type": "integer", "description": "For example 1000000000 to keep only companies above one billion on that metric. In the metric's own unit — dollars, shares, or dollars per share." } } }, "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 } } } } } } } } } }