{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Filing Delta Monitor", "description": "Monitor official SEC EDGAR filings for a ticker watchlist and return only new or changed filings in normalized JSON.", "version": "0.1", "x-build-id": "9nC2XjpHeJL6zau0U" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tom_the_builder~sec-edgar-filing-delta-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tom_the_builder-sec-edgar-filing-delta-monitor", "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/tom_the_builder~sec-edgar-filing-delta-monitor/runs": { "post": { "operationId": "runs-sync-tom_the_builder-sec-edgar-filing-delta-monitor", "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/tom_the_builder~sec-edgar-filing-delta-monitor/run-sync": { "post": { "operationId": "run-sync-tom_the_builder-sec-edgar-filing-delta-monitor", "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": { "mode": { "title": "Run mode", "enum": [ "delta", "snapshot" ], "type": "string", "description": "Use delta for monitor-style runs or snapshot to return the current filtered set.", "default": "delta" }, "changeMode": { "title": "Delta selection", "enum": [ "new_and_changed", "new_only" ], "type": "string", "description": "When mode is delta, choose whether to return new filings only or both new and changed filings.", "default": "new_and_changed" }, "stateKey": { "title": "State key", "type": "string", "description": "Logical state bucket. Use a different value for each distinct watchlist.", "default": "default" }, "tickers": { "title": "Ticker watchlist", "type": "array", "description": "Public company tickers to monitor, resolved through the official SEC company tickers index.", "items": { "type": "string" }, "default": [ "AAPL", "MSFT" ] }, "ciks": { "title": "CIK watchlist", "type": "array", "description": "Optional CIKs to monitor directly. Values are normalized to 10-digit SEC CIKs.", "items": { "type": "string" }, "default": [] }, "filingTypes": { "title": "Filing types", "type": "array", "description": "SEC form types to return, for example 8-K, 10-Q, 10-K, or 4.", "items": { "type": "string" }, "default": [ "8-K", "10-Q", "10-K", "4" ] }, "maxItems": { "title": "Max output items", "minimum": 1, "type": "integer", "description": "Limit the number of items returned in the output. State is still computed from the full filtered set.", "default": 100 }, "dateFrom": { "title": "Filing date from", "type": "string", "description": "Optional lower bound for filing date in YYYY-MM-DD format.", "default": "" }, "dateTo": { "title": "Filing date to", "type": "string", "description": "Optional upper bound for filing date in YYYY-MM-DD format.", "default": "" }, "relativeDateFromDays": { "title": "Relative lookback window (days)", "minimum": 0, "type": "integer", "description": "If Filing date from is empty, derive it automatically as today minus this many days.", "default": 30 }, "query": { "title": "Free text query", "type": "string", "description": "Free text query for company, ticker, filing type, and primary document description.", "default": "" }, "companyNameContains": { "title": "Company name contains", "type": "string", "description": "Case-insensitive substring filter for company names.", "default": "" }, "accessionNumber": { "title": "Accession number", "type": "string", "description": "Fetch a specific accession number when known.", "default": "" }, "keywordList": { "title": "Keyword list", "type": "array", "description": "Optional keyword list matched against company, ticker, form, accession, document description, and item fields.", "items": { "type": "string" }, "default": [] }, "requireKeywordMatch": { "title": "Require keyword match", "type": "boolean", "description": "If enabled, filings are returned only when at least one keyword matches.", "default": false }, "includeAmendments": { "title": "Include amended filings", "type": "boolean", "description": "If disabled, amended forms ending in /A are excluded.", "default": false }, "includeRaw": { "title": "Include raw source payload", "type": "boolean", "description": "Attach the raw SEC filing object to each item. Useful for debugging but increases output size.", "default": false }, "includeUnchanged": { "title": "Include unchanged items", "type": "boolean", "description": "When mode is delta, include unchanged items in the selected set.", "default": false }, "webhookMode": { "title": "Webhook payload mode", "enum": [ "off", "summary", "full" ], "type": "string", "description": "Choose whether to disable webhook payloads, send only a summary, or include all selected items.", "default": "summary" }, "userAgentEmail": { "title": "SEC User-Agent email", "type": "string", "description": "Contact email included in SEC request User-Agent headers for fair-access compliance.", "default": "danilyarmolchik@gmail.com" }, "requestDelayMs": { "title": "Request delay (ms)", "minimum": 0, "type": "integer", "description": "Delay between company submissions requests. Keep this polite for SEC fair access.", "default": 150 } } }, "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 } } } } } } } } } }