{ "openapi": "3.0.1", "info": { "title": "SEC Company Financials from XBRL", "description": "Revenue, net income, assets and ten more lines straight from SEC XBRL filings. Companies file the same line under different tags, so each metric is tried against several and the row says which one answered. No key and no login.", "version": "0.1", "x-build-id": "p6taDjrKwqHU564me" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gubidonius~sec-financials/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gubidonius-sec-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/gubidonius~sec-financials/runs": { "post": { "operationId": "runs-sync-gubidonius-sec-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/gubidonius~sec-financials/run-sync": { "post": { "operationId": "run-sync-gubidonius-sec-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", "required": [ "companies" ], "properties": { "companies": { "title": "Companies", "type": "array", "description": "A ticker, a CIK number, or the exact registered name. AAPL, 320193 and Apple Inc. all reach the same company.", "items": { "type": "string" } }, "metrics": { "title": "Metrics", "type": "array", "description": "Each metric is tried against several XBRL concepts in turn, because companies file the same line under different tags. The row records which one answered.", "items": { "type": "string", "enum": [ "revenue", "netIncome", "grossProfit", "operatingIncome", "assets", "liabilities", "equity", "cash", "researchAndDevelopment", "operatingExpenses", "earningsPerShareBasic", "earningsPerShareDiluted", "sharesOutstanding" ] }, "default": [ "revenue", "netIncome" ] }, "annualOnly": { "title": "Annual figures only", "type": "boolean", "description": "Keeps only figures covering a full year. An annual report states quarters too, so this checks the period each figure covers and not just which form it came from.", "default": false }, "periodLengths": { "title": "Period lengths", "type": "array", "description": "Which spans to keep. A quarterly filing states the year to date beside the quarter, both under the same fiscal year and quarter label, so leaving this empty gives you both and charting them together doubles the year. Pick quarter for a quarterly series.", "items": { "type": "string", "enum": [ "quarter", "half-year", "nine-months", "annual", "instant", "other" ] }, "default": [] }, "since": { "title": "Periods ending on or after", "type": "string", "description": "A date such as 2020-01-01. Older periods are dropped." }, "maxPeriodsPerMetric": { "title": "Max periods per metric", "minimum": 1, "type": "integer", "description": "How many periods to return for each metric, newest first. Applied per metric, so asking for three metrics gives you up to this many of each rather than filling the whole budget with the first one.", "default": 40 } } }, "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 } } } } } } } } } }