{ "openapi": "3.0.1", "info": { "title": "Sec Xbrl Company Screener Scraper", "description": "Screen SEC-registered public companies by financial metric — revenue, assets, R&D, net income, and more. Uses the free EDGAR XBRL API. Filter by value range, US state, and SIC code. Results include company name, CIK, ticker, exchange, SIC, phone, and EDGAR URL.", "version": "0.1", "x-build-id": "w1pdc1fHKSfUgqoik" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gocreative.ai~sec-xbrl-company-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gocreative.ai-sec-xbrl-company-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/gocreative.ai~sec-xbrl-company-screener/runs": { "post": { "operationId": "runs-sync-gocreative.ai-sec-xbrl-company-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/gocreative.ai~sec-xbrl-company-screener/run-sync": { "post": { "operationId": "run-sync-gocreative.ai-sec-xbrl-company-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", "properties": { "preset": { "title": "Financial Metric Preset", "enum": [ "revenues", "net_income", "assets", "research_development", "gross_profit", "operating_income" ], "type": "string", "description": "Choose the financial metric to screen by. Each preset maps to a specific XBRL concept and period.", "default": "revenues" }, "minValue": { "title": "Minimum Metric Value (USD)", "type": "integer", "description": "Only include companies with a metric value at or above this amount. Example: 10000000 for $10M minimum revenue." }, "maxValue": { "title": "Maximum Metric Value (USD)", "type": "integer", "description": "Only include companies with a metric value at or below this amount." }, "maxResults": { "title": "Max Results", "type": "integer", "description": "Maximum number of companies to return (up to 500).", "default": 100 }, "enrichWithDetails": { "title": "Enrich With Company Details", "type": "boolean", "description": "Fetch additional details per company (ticker, exchange, SIC code, phone, website) from EDGAR submissions API. Adds ~0.1s per result.", "default": true }, "stateCode": { "title": "Filter by US State (loc code)", "type": "string", "description": "Filter companies by US state location code from EDGAR. Examples: US-CA (California), US-TX (Texas), US-NY (New York)." }, "sicCode": { "title": "Filter by SIC Industry Code", "type": "string", "description": "Filter by 4-digit SIC code (requires Enrich With Details). Examples: 7372 (Prepackaged Software), 6022 (State Commercial Banks), 3674 (Semiconductors)." }, "period": { "title": "Override Period", "type": "string", "description": "Override the period for the selected preset. Duration examples: CY2022, CY2021. Instant (point-in-time) examples: CY2022Q4I, CY2023Q2I." } } }, "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 } } } } } } } } } }