{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Company Filings & XBRL Facts", "description": "Official SEC filing metadata and selected US-GAAP fact observations for a CIK or ticker. No API key or browser required.", "version": "0.1", "x-build-id": "VUvHbdPYyC2Z2JwNZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/atesen-software~sec-edgar-company-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-atesen-software-sec-edgar-company-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/atesen-software~sec-edgar-company-data/runs": { "post": { "operationId": "runs-sync-atesen-software-sec-edgar-company-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/atesen-software~sec-edgar-company-data/run-sync": { "post": { "operationId": "run-sync-atesen-software-sec-edgar-company-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": { "cik": { "title": "Company CIK", "type": "string", "description": "1–10 digits, optional CIK prefix. Clear this field when supplying ticker. When both identifiers are omitted, Apple Inc. is used as the public example." }, "ticker": { "title": "Ticker", "type": "string", "description": "Resolved using SEC company_tickers.json. Omit when supplying cik." }, "userAgent": { "title": "Declared SEC User-Agent", "minLength": 8, "maxLength": 256, "type": "string", "description": "Organization name and actual contact email. Defaults to this Actor publisher's public support contact. You may supply your own organization and real contact. Sent to SEC only, never included in result rows.", "default": "Atesen Software support@atesensoftware.com" }, "forms": { "title": "Forms", "type": "array", "description": "Exact SEC form names, such as 10-K, 10-Q, 8-K. Empty means all. Applies to filings and facts.", "items": { "type": "string" }, "default": [] }, "startDate": { "title": "Filed on or after", "type": "string", "description": "Inclusive YYYY-MM-DD filing date, for filings and facts." }, "endDate": { "title": "Filed on or before", "type": "string", "description": "Inclusive YYYY-MM-DD filing date, for filings and facts." }, "includeFilings": { "title": "Include filings", "type": "boolean", "description": "Return one metadata row per accession number.", "default": true }, "maxFilings": { "title": "Maximum filing rows", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Per-run filing row cap.", "default": 100 }, "includeOlderFilings": { "title": "Read older submission archives", "type": "boolean", "description": "Read SEC historical pages only when recent filings do not fill the limit.", "default": false }, "maxOlderPages": { "title": "Maximum older pages", "minimum": 0, "maximum": 10, "type": "integer", "description": "Bound archive downloads, in addition to the recent submissions request.", "default": 3 }, "includeFacts": { "title": "Include US-GAAP facts", "type": "boolean", "description": "Read selected companyfacts observations. One row per concept/unit/period/accession/value.", "default": false }, "concepts": { "title": "US-GAAP concepts", "type": "array", "description": "Case-sensitive concept names without namespace, maximum 20.", "items": { "type": "string" }, "default": [ "Assets", "NetIncomeLoss", "Revenues" ] }, "yearlyOnly": { "title": "Annual observations only", "type": "boolean", "description": "FY observations in annual forms; duration facts must cover at least 300 days. Instant facts retained.", "default": false }, "maxFacts": { "title": "Maximum fact rows", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Newest filed observations across selected concepts; maximum 1000.", "default": 100 } } }, "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 } } } } } } } } } }