{ "openapi": "3.0.1", "info": { "title": "SEC Official Dataset Catalog", "description": "Discover official SEC datasets, versions, files, and available field definitions with explicit schema gaps and no archive download.", "version": "0.1", "x-build-id": "jDHcs5RxrwLDfJUON" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bb-tradetec~sec-official-dataset-catalog/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bb-tradetec-sec-official-dataset-catalog", "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-official-dataset-catalog/runs": { "post": { "operationId": "runs-sync-bb-tradetec-sec-official-dataset-catalog", "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-official-dataset-catalog/run-sync": { "post": { "operationId": "run-sync-bb-tradetec-sec-official-dataset-catalog", "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": { "queries": { "title": "Catalog requests", "minItems": 1, "maxItems": 100, "type": "array", "description": "One to one hundred caller correlation IDs for the same bounded catalog filter.", "items": { "type": "object", "additionalProperties": false, "required": [ "requestId" ], "properties": { "requestId": { "title": "Request ID", "description": "Stable caller correlation ID; never put a secret here.", "editor": "textfield", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" } } }, "default": [ { "requestId": "catalog" } ] }, "datasetIds": { "title": "Dataset IDs", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Optional exact local dataset inventory IDs.", "items": { "type": "string", "pattern": "^[a-z0-9][a-z0-9._-]{0,127}$" }, "default": [] }, "categories": { "title": "Dataset categories", "maxItems": 10, "uniqueItems": true, "type": "array", "description": "Optional controlled category filter; runtime accepts only the documented controlled values.", "items": { "type": "string", "pattern": "^(filings|financials|funds|ownership|offerings|registries|marketStructure|enforcement|operations|other)$" }, "default": [] }, "publishedFrom": { "title": "Published from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive official publication-date lower bound." }, "publishedTo": { "title": "Published to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive official publication-date upper bound." }, "includeHistoricalVersions": { "title": "Include historical versions", "type": "boolean", "description": "Include catalogued earlier dataset versions.", "default": true }, "includeFieldDefinitions": { "title": "Include field definitions", "type": "boolean", "description": "Include available table field definitions.", "default": true }, "discoverNewSources": { "title": "Discover new sources", "type": "boolean", "description": "Only compares official catalog pages against source-inventory.json; it never enables a blind crawl.", "default": false }, "maxResults": { "title": "Maximum dataset versions", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on emitted dataset versions.", "default": 100 }, "maxSourceRequests": { "title": "Maximum source requests", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard cap on official catalog requests.", "default": 100 }, "maxDownloadBytes": { "title": "Maximum download bytes", "minimum": 1, "maximum": 52428800, "type": "integer", "description": "Hard cap on catalog, dictionary, and schema downloads.", "default": 26214400 }, "outputSchemaVersion": { "title": "Output schema version", "enum": [ "1.0" ], "type": "string", "description": "Supported public schema version.", "default": "1.0" }, "outputMode": { "title": "Output mode", "enum": [ "full", "compact" ], "type": "string", "description": "Full or compact catalog metadata.", "default": "full" }, "cursor": { "title": "Continuation cursor", "minLength": 1, "maxLength": 32768, "type": "string", "description": "Opaque prior continuation cursor." } } }, "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 } } } } } } } } } }