{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR XBRL Frames — Cross-Company Financial Facts Lookup", "description": "Query standardized XBRL frames (Revenues, Assets, NetIncomeLoss, StockholdersEquity) for ~6000 US public companies. Period presets, derived fields, post-filters. Public domain.", "version": "0.1", "x-build-id": "gNJHoXUf1RGcaJphB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devone-studio~sec-edgar-xbrl-frames-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devone-studio-sec-edgar-xbrl-frames-api", "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/devone-studio~sec-edgar-xbrl-frames-api/runs": { "post": { "operationId": "runs-sync-devone-studio-sec-edgar-xbrl-frames-api", "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/devone-studio~sec-edgar-xbrl-frames-api/run-sync": { "post": { "operationId": "run-sync-devone-studio-sec-edgar-xbrl-frames-api", "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": { "tag": { "title": "XBRL tag", "type": "string", "description": "Canonical us-gaap concept. Presets: Revenues, NetIncomeLoss, OperatingIncomeLoss, GrossProfit, Assets, Liabilities, StockholdersEquity, LongTermDebt, CommonStockSharesOutstanding. Custom us-gaap tags accepted (balance type auto-detected from period suffix).", "default": "Revenues" }, "taxonomy": { "title": "Taxonomy", "type": "string", "description": "XBRL taxonomy namespace. Default us-gaap.", "default": "us-gaap" }, "unit": { "title": "Unit of measure", "type": "string", "description": "Unit of measure filter. Default USD.", "default": "USD" }, "period": { "title": "Period", "type": "string", "description": "Period preset or explicit segment. Presets: last_year (annual duration), last_quarter (3M duration), last_fy_q4 (instant balance sheet at year-end), this_year, this_quarter. Explicit: 'CY2024' (annual), 'CY2024Q1' (3M duration), 'CY2024Q2I' (instant at Q2-end), '2024', '2024Q1', '2024Q4I'.", "default": "last_year" }, "min_value_usd": { "title": "Minimum value (USD)", "type": "string", "description": "Post-filter: keep only rows where value ≥ this number (USD). Leave empty for no minimum.", "default": "" }, "max_value_usd": { "title": "Maximum value (USD)", "type": "string", "description": "Post-filter: keep only rows where value ≤ this number (USD). Leave empty for no maximum.", "default": "" }, "entity_state": { "title": "Entity state (2-letter)", "type": "string", "description": "Post-filter: keep only entities located in this US state (e.g. CA, NY, TX). Leave empty for all states.", "default": "" }, "entity_name_contains": { "title": "Entity name contains", "type": "string", "description": "Substring filter on entity name (case-insensitive).", "default": "" }, "domestic_only": { "title": "US-only entities", "type": "boolean", "description": "If true, drop non-US entities (loc does not start with 'US-').", "default": false }, "sort_by": { "title": "Sort by", "type": "string", "description": "Sort key: value_desc (default), value_asc, entity_name, cik.", "default": "value_desc" }, "max_results": { "title": "Max results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of records returned (1-500).", "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 }, "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 } } } } } } } } } }