{ "openapi": "3.0.1", "info": { "title": "SEC XBRL Fact API", "description": "Normalize official SEC Company Facts into stable records with exact concepts, periods, units, filing references, and provenance.", "version": "0.1", "x-build-id": "bIGRKcfPHNQtj0csg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bb-tradetec~sec-xbrl-fact-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bb-tradetec-sec-xbrl-fact-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/bb-tradetec~sec-xbrl-fact-api/runs": { "post": { "operationId": "runs-sync-bb-tradetec-sec-xbrl-fact-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/bb-tradetec~sec-xbrl-fact-api/run-sync": { "post": { "operationId": "run-sync-bb-tradetec-sec-xbrl-fact-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", "required": [ "queries" ], "properties": { "queries": { "title": "XBRL queries", "minItems": 1, "maxItems": 20, "type": "array", "description": "One to twenty exact official SEC XBRL query strategies.", "items": { "type": "object", "additionalProperties": false, "required": [ "requestId", "queryType" ], "properties": { "requestId": { "title": "Request ID", "description": "Stable caller correlation ID; never put a secret here.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "queryType": { "title": "Query type", "description": "Choose the official SEC XBRL query strategy.", "type": "string", "enum": [ "companyFacts", "companyConcept", "frame", "filing" ] }, "cik": { "title": "SEC CIK", "description": "Issuer CIK for companyFacts or companyConcept.", "type": "string", "pattern": "^\\d{1,10}$" }, "accession": { "title": "Exact accession", "description": "Exact filing accession for filing mode.", "type": "string", "pattern": "^\\d{10}-\\d{2}-\\d{6}$" }, "filerCik": { "title": "Confirmed filing CIK", "description": "Required for filing mode; never inferred from accession digits.", "type": "string", "pattern": "^\\d{1,10}$" }, "taxonomy": { "title": "XBRL taxonomy", "description": "Exact taxonomy prefix.", "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z][A-Za-z0-9._-]*$" }, "concept": { "title": "XBRL concept", "description": "Exact XBRL tag without a free URL fragment.", "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z_][A-Za-z0-9._-]*$" }, "unit": { "title": "XBRL unit", "description": "Exact SEC unit for frame mode.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z][A-Za-z0-9._/-]*$" }, "frame": { "title": "SEC frame", "description": "Exact SEC frame name for frame mode.", "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z0-9._-]+$" }, "taxonomies": { "title": "Taxonomy filter", "description": "Optional exact taxonomy allowlist.", "type": "array", "default": [], "maxItems": 20, "uniqueItems": true, "items": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z][A-Za-z0-9._-]*$" } }, "concepts": { "title": "Concept filter", "description": "Optional exact concept allowlist.", "type": "array", "default": [], "maxItems": 100, "uniqueItems": true, "items": { "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[A-Za-z_][A-Za-z0-9._-]*$" } }, "units": { "title": "Unit filter", "description": "Optional exact unit allowlist.", "type": "array", "default": [], "maxItems": 20, "uniqueItems": true, "items": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z][A-Za-z0-9._/-]*$" } }, "periodFrom": { "title": "Period from", "description": "Inclusive lower period date.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "editor": "datepicker" }, "periodTo": { "title": "Period to", "description": "Inclusive upper period date.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "editor": "datepicker" }, "forms": { "title": "Exact SEC forms", "description": "Optional exact form allowlist.", "type": "array", "default": [], "maxItems": 50, "uniqueItems": true, "items": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": "^[A-Za-z0-9][A-Za-z0-9 ./-]*$" } }, "includeDimensions": { "title": "Include dimensions", "description": "Return complete dimensional contexts when available.", "type": "boolean", "default": true }, "includeFootnotes": { "title": "Include footnotes", "description": "Return bounded source footnote references when available.", "type": "boolean", "default": false }, "latestOnly": { "title": "Latest fact only", "description": "Keep only the latest fact in each full context.", "type": "boolean", "default": false }, "maxFacts": { "title": "Maximum facts for this query", "description": "Hard per-query fact ceiling.", "type": "integer", "minimum": 1, "maximum": 50000, "default": 1000 } } } }, "maxResults": { "title": "Maximum fact records", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard run-wide fact ceiling.", "default": 1000 }, "maxSourceRequests": { "title": "Maximum SEC source requests", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard run-wide SEC request ceiling.", "default": 100 }, "maxDownloadBytes": { "title": "Maximum downloaded bytes", "minimum": 1, "maximum": 262144000, "type": "integer", "description": "Hard run-wide download byte ceiling.", "default": 26214400 }, "outputSchemaVersion": { "title": "Output schema version", "enum": [ "1.0" ], "type": "string", "description": "Only stable schema 1.0 is supported.", "default": "1.0" }, "outputMode": { "title": "Output mode", "enum": [ "full", "compact" ], "type": "string", "description": "Full or compact fact representation.", "default": "full" }, "cursor": { "title": "Continuation cursor", "minLength": 1, "maxLength": 32768, "type": "string", "description": "Opaque cursor reserved for a later service package." } } }, "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 } } } } } } } } } }