{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Financials — Standardized US Company Periods", "description": "Standardized annual/quarterly financials for US public companies from SEC EDGAR's free XBRL APIs. One row per company-fiscal-period with revenue, net income, assets, liabilities, equity, cash, EPS, shares, margins, growth, filing URL and accession number. Restatements handled. No personal data.", "version": "0.1", "x-build-id": "jH3VSM8DbQXikdQyw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sweet-orb~sec-edgar-financials/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sweet-orb-sec-edgar-financials", "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/sweet-orb~sec-edgar-financials/runs": { "post": { "operationId": "runs-sync-sweet-orb-sec-edgar-financials", "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/sweet-orb~sec-edgar-financials/run-sync": { "post": { "operationId": "run-sync-sweet-orb-sec-edgar-financials", "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": { "companies": { "title": "CIKs or tickers", "type": "array", "description": "US public companies to fetch. Use 10-digit SEC CIKs (e.g. \"0000320193\") or tickers (e.g. \"AAPL\"). Leave empty for 10 large US companies.", "items": { "type": "string" }, "default": [] }, "formTypes": { "title": "Form types", "type": "array", "description": "SEC form types to include. 10-K/10-K/A are annual, 10-Q/10-Q/A are quarterly. Amendments are included by default so restatements are captured.", "items": { "type": "string" }, "default": [ "10-K", "10-Q", "10-K/A", "10-Q/A" ] }, "fiscalYearFrom": { "title": "First fiscal year", "minimum": 1900, "type": "integer", "description": "Earliest fiscal year to include (inclusive). Defaults to two years before the current year." }, "fiscalYearTo": { "title": "Last fiscal year", "minimum": 1900, "type": "integer", "description": "Latest fiscal year to include (inclusive). Defaults to the current year." }, "periodFrom": { "title": "Period end from", "type": "string", "description": "Earliest period end date (YYYY-MM-DD), inclusive. Optional; combines with the fiscal year range." }, "periodTo": { "title": "Period end to", "type": "string", "description": "Latest period end date (YYYY-MM-DD), inclusive. Optional; combines with the fiscal year range." }, "includeAnnual": { "title": "Include annual periods", "type": "boolean", "description": "Include fiscal-year periods from 10-K and 10-K/A filings.", "default": true }, "includeQuarterly": { "title": "Include quarterly periods", "type": "boolean", "description": "Include quarterly periods from 10-Q and 10-Q/A filings.", "default": true }, "minRevenue": { "title": "Minimum revenue (USD)", "type": "number", "description": "Only return periods whose revenue is at least this value. Null revenue is excluded when this filter is set." }, "maxRevenue": { "title": "Maximum revenue (USD)", "type": "number", "description": "Only return periods whose revenue is at most this value." }, "minNetIncome": { "title": "Minimum net income (USD)", "type": "number", "description": "Only return periods whose net income is at least this value." }, "maxNetIncome": { "title": "Maximum net income (USD)", "type": "number", "description": "Only return periods whose net income is at most this value." }, "minNetMargin": { "title": "Minimum net margin (ratio)", "type": "number", "description": "Only return periods whose net income / revenue is at least this ratio. 0.15 = 15%." }, "maxNetMargin": { "title": "Maximum net margin (ratio)", "type": "number", "description": "Only return periods whose net income / revenue is at most this ratio." }, "minGrossMargin": { "title": "Minimum gross margin (ratio)", "type": "number", "description": "Only return periods whose gross profit / revenue is at least this ratio." }, "maxGrossMargin": { "title": "Maximum gross margin (ratio)", "type": "number", "description": "Only return periods whose gross profit / revenue is at most this ratio." }, "minOperatingMargin": { "title": "Minimum operating margin (ratio)", "type": "number", "description": "Only return periods whose operating income / revenue is at least this ratio." }, "maxOperatingMargin": { "title": "Maximum operating margin (ratio)", "type": "number", "description": "Only return periods whose operating income / revenue is at most this ratio." }, "minRevenueGrowthYoY": { "title": "Minimum revenue growth YoY (ratio)", "type": "number", "description": "Only return periods whose revenue growth versus the same period one year earlier is at least this ratio. 0.1 = 10%." }, "maxRevenueGrowthYoY": { "title": "Maximum revenue growth YoY (ratio)", "type": "number", "description": "Only return periods whose revenue growth versus the same period one year earlier is at most this ratio." }, "minNetIncomeGrowthYoY": { "title": "Minimum net income growth YoY (ratio)", "type": "number", "description": "Only return periods whose net income growth versus the same period one year earlier is at least this ratio. Null when the prior value is missing or non-positive." }, "maxNetIncomeGrowthYoY": { "title": "Maximum net income growth YoY (ratio)", "type": "number", "description": "Only return periods whose net income growth versus the same period one year earlier is at most this ratio." }, "minAssets": { "title": "Minimum total assets (USD)", "type": "number", "description": "Only return periods whose total assets are at least this value." }, "maxAssets": { "title": "Maximum total assets (USD)", "type": "number", "description": "Only return periods whose total assets are at most this value." }, "minEquity": { "title": "Minimum stockholders' equity (USD)", "type": "number", "description": "Only return periods whose stockholders' equity is at least this value." }, "maxEquity": { "title": "Maximum stockholders' equity (USD)", "type": "number", "description": "Only return periods whose stockholders' equity is at most this value." }, "maxResults": { "title": "Maximum records", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of company-fiscal-period records to write. Defaults to 20.", "default": 20 }, "userAgent": { "title": "SEC User-Agent", "type": "string", "description": "Descriptive User-Agent with contact information, as required by SEC fair-access rules. Example: \"MyCompany/1.0 (data@mycompany.com)\". The default identifies the actor.", "default": "sec-edgar-financials-apify-actor/0.1 (+https://apify.com)" } } }, "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 } } } } } } } } } }