{ "openapi": "3.0.1", "info": { "title": "SEC 8-K Event Normalizer, Facts & Evidence API", "description": "Convert official SEC EDGAR 8-K filings into evidence-backed item events, deterministic facts and subtypes. Query by ticker, CIK, company or accession; optionally follow exhibits and use stateless incremental cursors.", "version": "0.2", "x-build-id": "XoZDvhjajFDpdpvyF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bb-tradetec~sec-8k-event-normalizer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bb-tradetec-sec-8k-event-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-8k-event-normalizer/runs": { "post": { "operationId": "runs-sync-bb-tradetec-sec-8k-event-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-8k-event-normalizer/run-sync": { "post": { "operationId": "run-sync-bb-tradetec-sec-8k-event-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": "Company or filing queries", "minItems": 1, "maxItems": 20, "type": "array", "description": "Unique requestId values are returned in requestIds. ticker and companyName use the SEC ticker catalog; cik may omit leading zeros. accessionNumber requires the issuer cik because an accession prefix can identify a filing agent instead of the issuer. Do not place secrets in requestId.", "items": { "type": "object", "additionalProperties": false, "required": [ "requestId", "identifierType", "identifier" ], "properties": { "requestId": { "title": "Request ID", "description": "Caller-defined stable correlation ID returned in every matching event.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "identifierType": { "title": "Identifier type", "description": "ticker and companyName resolve through the SEC catalog; cik is direct; accessionNumber requires the separate issuer cik field.", "type": "string", "enum": [ "ticker", "cik", "companyName", "accessionNumber" ] }, "identifier": { "title": "Identifier", "description": "Ticker, CIK, exact SEC company name, or exact accession number such as 0001140361-26-015711.", "type": "string", "minLength": 1, "maxLength": 200 }, "cik": { "title": "Issuer CIK for accession lookup", "description": "Required only when identifierType is accessionNumber.", "type": "string", "pattern": "^\\d{1,10}$" } } }, "default": [ { "requestId": "apple-recent-8k", "identifierType": "ticker", "identifier": "AAPL" } ] }, "filedFrom": { "title": "Filed from", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive YYYY-MM-DD filing-date lower bound." }, "filedTo": { "title": "Filed to", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Inclusive YYYY-MM-DD filing-date upper bound; must not precede filedFrom." }, "itemCodes": { "title": "SEC item-code filter", "maxItems": 31, "uniqueItems": true, "type": "array", "description": "Exact Form 8-K item codes. Empty means all officially reported or unambiguously detected item headings.", "items": { "type": "string", "pattern": "^[1-9]\\.[0-9]{1,2}$" }, "default": [] }, "includeAmendments": { "title": "Include Form 8-K/A", "type": "boolean", "description": "Include amendments in addition to Form 8-K.", "default": true }, "maxFilingsPerCompany": { "title": "Maximum filings per company", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard bound on matching filings fetched per company.", "default": 25 }, "maxEvents": { "title": "Maximum unique events", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard global dataset and result-charge bound after eventId deduplication.", "default": 50 }, "evidenceMaxChars": { "title": "Evidence characters per event", "minimum": 500, "maximum": 5000, "type": "integer", "description": "Maximum primary or exhibit excerpt length. Original length and truncation remain explicit.", "default": 2000 }, "outputSchemaVersion": { "title": "Output schema version", "enum": [ "1.0", "1.1" ], "type": "string", "description": "1.0 preserves the original event contract. 1.1 adds eventSubtypes, facts, relatedExhibits, compact mode, and cursors.", "default": "1.0" }, "outputMode": { "title": "Output mode", "enum": [ "full", "compact" ], "type": "string", "description": "full includes bounded evidence excerpts. compact omits long primary and exhibit excerpts but keeps provenance and short fact/subtype match evidence; compact requires schema 1.1.", "default": "full" }, "extractSubtypes": { "title": "Extract deterministic event subtypes", "type": "boolean", "description": "Precision-first rule matches for Items 1.05, 2.01, 3.01, 4.01, 4.02, and 5.02. Never guesses a semantic subtype for Item 8.01. Requires schema 1.1.", "default": false }, "extractFacts": { "title": "Extract structured facts", "type": "boolean", "description": "Evidence-bound dates, money, percentages, share counts, and supported officer/director actions. No LLM. Requires schema 1.1.", "default": false }, "includeExhibits": { "title": "Fetch explicitly referenced exhibits", "type": "boolean", "description": "Opt-in. Fetch only allowed SEC exhibit types explicitly referenced by the matching item section, under document and byte caps. Requires schema 1.1 and may add SEC requests.", "default": false }, "exhibitTypes": { "title": "Allowed exhibit types", "minItems": 1, "maxItems": 6, "uniqueItems": true, "type": "array", "description": "Exact SEC exhibit-type allowlist used only with includeExhibits.", "items": { "type": "string", "pattern": "^EX-[0-9A-Z]+(?:\\.[0-9A-Z]+)?$" }, "default": [ "EX-99.1" ] }, "maxExhibitsPerFiling": { "title": "Maximum exhibits per filing", "minimum": 1, "maximum": 5, "type": "integer", "description": "Hard limit on distinct exhibit documents selected across all item events in one filing.", "default": 2 }, "maxTotalExhibits": { "title": "Maximum exhibits per run", "minimum": 1, "maximum": 20, "type": "integer", "description": "Hard limit on distinct exhibit documents selected across the complete Actor run.", "default": 10 }, "maxExhibitBytes": { "title": "Maximum bytes per exhibit", "minimum": 100000, "maximum": 2000000, "type": "integer", "description": "Streaming download limit per exhibit; the runtime also enforces a 5 MB total exhibit budget.", "default": 1000000 }, "incremental": { "title": "Stateless incremental mode", "type": "object", "description": "Client-carried opaque cursor mode for repeated polling. First run: omit cursor. Next run: pass SUMMARY.nextCursor unchanged. Cannot be combined with accessionNumber queries. Requires schema 1.1.", "properties": { "cursor": { "title": "Previous cursor", "description": "Opaque nextCursor returned in the prior SUMMARY. Omit on the first incremental run and never edit the value.", "type": "string", "maxLength": 32768, "pattern": "^sec8kcur1_[A-Za-z0-9_-]+$" }, "overlapHours": { "title": "Overlap hours", "description": "Recheck this many hours before the saved position; stable event IDs suppress duplicates.", "type": "integer", "editor": "number", "minimum": 0, "maximum": 168 } }, "additionalProperties": false } } }, "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 } } } } } } } } } }