{ "openapi": "3.0.1", "info": { "title": "SEC Official Dataset Rows", "description": "Read bounded, typed rows from catalogued public SEC dataset tables while retaining original columns and source provenance.", "version": "0.1", "x-build-id": "kPu7npjIHqEP4l97q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bb-tradetec~sec-official-dataset-rows/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bb-tradetec-sec-official-dataset-rows", "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-rows/runs": { "post": { "operationId": "runs-sync-bb-tradetec-sec-official-dataset-rows", "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-rows/run-sync": { "post": { "operationId": "run-sync-bb-tradetec-sec-official-dataset-rows", "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": "Dataset table requests", "minItems": 1, "maxItems": 20, "type": "array", "description": "One to twenty bounded requests for exact C06-catalogued tables.", "items": { "type": "object", "additionalProperties": false, "required": [ "requestId", "datasetVersionId", "table" ], "properties": { "requestId": { "title": "Request ID", "description": "Caller correlation ID; never a secret.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "datasetVersionId": { "title": "Dataset version ID", "description": "Exact C06-catalogued dataset version identifier.", "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^[a-z0-9][a-z0-9._-]{0,127}:.+$" }, "table": { "title": "Table", "description": "Exact table name declared by the catalogue version.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z_][A-Za-z0-9_.-]*$" }, "columns": { "title": "Columns", "description": "Exact source columns to preserve; mutually exclusive with includeAllColumns.", "type": "array", "default": [], "maxItems": 200, "uniqueItems": true, "items": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z_][A-Za-z0-9_.-]*$" } }, "includeAllColumns": { "title": "Include all columns", "description": "Preserve every declared source column; mutually exclusive with columns.", "type": "boolean", "default": false }, "filters": { "title": "Typed filters", "description": "Bounded comparisons; source types are resolved from the C06 field definition.", "type": "array", "default": [], "maxItems": 50, "items": { "type": "object", "additionalProperties": false, "required": [ "field", "operator" ], "properties": { "field": { "title": "Field", "description": "Exact source field declared by the selected table.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z_][A-Za-z0-9_.-]*$" }, "operator": { "title": "Operator", "description": "Controlled typed comparison operator.", "type": "string", "enum": [ "eq", "in", "gte", "lte", "between", "isNull" ] }, "value": { "title": "Value", "description": "One canonical scalar string for eq, gte, lte, or isNull.", "type": "string", "minLength": 1, "maxLength": 4096 }, "values": { "title": "Values", "description": "Canonical scalar strings for in or between; never a comma-separated list.", "type": "array", "minItems": 1, "maxItems": 100, "uniqueItems": true, "items": { "type": "string", "minLength": 1, "maxLength": 4096 } } } } } } } }, "maxResults": { "title": "Maximum rows", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap on emitted rows.", "default": 1000 }, "maxSourceRequests": { "title": "Maximum SEC requests", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on SEC source requests.", "default": 100 }, "maxDownloadBytes": { "title": "Maximum compressed bytes", "minimum": 1, "maximum": 262144000, "type": "integer", "description": "Compatibility limit equal to maxCompressedBytes; both must be equal.", "default": 52428800 }, "maxCompressedBytes": { "title": "Maximum compressed bytes", "minimum": 1, "maximum": 262144000, "type": "integer", "description": "Hard cap on archive bytes before decompression.", "default": 52428800 }, "maxUncompressedBytes": { "title": "Maximum uncompressed bytes", "minimum": 1, "maximum": 1073741824, "type": "integer", "description": "Hard cap on streamed archive expansion.", "default": 262144000 }, "outputSchemaVersion": { "title": "Output schema version", "enum": [ "1.0" ], "type": "string", "description": "Only the stable 1.0 public schema is supported.", "default": "1.0" }, "outputMode": { "title": "Output mode", "enum": [ "full", "compact" ], "type": "string", "description": "Full or compact row output.", "default": "full" }, "cursor": { "title": "Continuation cursor", "minLength": 1, "maxLength": 32768, "type": "string", "description": "Opaque continuation token returned by a later implementation." } } }, "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 } } } } } } } } } }