{ "openapi": "3.0.1", "info": { "title": "SEC Public Offering Events", "description": "Normalize SEC registrations, prospectuses, pricing, withdrawals, and communications into evidence-bound offering events.", "version": "0.1", "x-build-id": "71KyvO6aoAiWr6LhV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bb-tradetec~sec-public-offering-normalizer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bb-tradetec-sec-public-offering-normalizer", "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-public-offering-normalizer/runs": { "post": { "operationId": "runs-sync-bb-tradetec-sec-public-offering-normalizer", "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-public-offering-normalizer/run-sync": { "post": { "operationId": "run-sync-bb-tradetec-sec-public-offering-normalizer", "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": "Offering queries", "minItems": 1, "maxItems": 20, "type": "array", "description": "One to twenty exact issuer CIK or accession queries. Do not place secrets in request IDs.", "items": { "type": "object", "additionalProperties": false, "required": [ "requestId", "identifierType", "identifier" ], "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._:-]+$" }, "identifierType": { "title": "Identifier type", "description": "Use an issuer CIK or a complete SEC accession number.", "type": "string", "enum": [ "cik", "accession" ] }, "identifier": { "title": "CIK or exact accession", "description": "One to ten CIK digits or an accession in ##########-##-###### form.", "type": "string", "minLength": 1, "maxLength": 32 }, "filerCik": { "title": "Verified filer CIK", "description": "Required with an accession query. Supply the SEC filer CIK separately; an accession prefix identifies a submitter and is not used as a filer identity.", "type": "string", "pattern": "^\\d{1,10}$", "minLength": 1, "maxLength": 10 }, "forms": { "title": "Exact SEC forms", "description": "A strict form allowlist. Defaults to S-1, S-3, F-1, and F-3.", "type": "array", "minItems": 1, "maxItems": 30, "uniqueItems": true, "default": [ "S-1", "S-3", "F-1", "F-3" ], "items": { "type": "string", "pattern": "^(S-(1|3|4|6|8|11)(/A)?|F-(1|3|4|6|10)(/A)?|POS AM|424A|424B[1-9][A-Z]?|425|FWP|RW|AW)$" } }, "detailKinds": { "title": "Offering detail kinds", "description": "Restrict output to one or more supported public-offering event kinds.", "type": "array", "editor": "select", "maxItems": 6, "uniqueItems": true, "default": [], "items": { "type": "string", "enum": [ "registration", "amendment", "prospectus", "pricing", "withdrawal", "communication" ] } } } } }, "filedFrom": { "title": "Filed from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive SEC filing-date lower bound." }, "filedTo": { "title": "Filed to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive SEC filing-date upper bound." }, "includeAmendments": { "title": "Include amendments", "type": "boolean", "description": "Include SEC forms ending in /A and POS AM.", "default": true }, "maxFilings": { "title": "Maximum offering filings", "minimum": 1, "maximum": 50, "type": "integer", "description": "Hard ceiling before document parsing.", "default": 50 }, "maxResults": { "title": "Maximum event records", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard ceiling after event normalization.", "default": 1000 }, "maxSourceRequests": { "title": "Maximum SEC requests", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard run-wide public SEC request ceiling.", "default": 200 }, "maxDownloadBytes": { "title": "Maximum downloaded bytes", "minimum": 1, "maximum": 52428800, "type": "integer", "description": "Hard run-wide public SEC byte ceiling.", "default": 52428800 }, "outputSchemaVersion": { "title": "Output schema version", "enum": [ "1.0" ], "type": "string", "description": "The supported public record contract version.", "default": "1.0" }, "outputMode": { "title": "Output mode", "enum": [ "full", "compact" ], "type": "string", "description": "Full or compact event representation.", "default": "full" }, "cursor": { "title": "Continuation cursor", "minLength": 1, "maxLength": 32768, "type": "string", "description": "Opaque cursor returned by a prior SUMMARY; do not edit it." } } }, "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 } } } } } } } } } }