{ "openapi": "3.0.1", "info": { "title": "SEC Filing Alerts - 8-K, Form 4, 13D & 10-K Monitor", "description": "Get alerted when your tickers file with the SEC: 8-K items, Form 4 insider trades, 13D/13G, 10-K, 10-Q, S-1. Runs on a schedule, sends to Slack or a webhook, $0.01 per new filing.", "version": "0.1", "x-build-id": "hRI50chcAaeTJW4Q0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/skillmerc~sec-filing-alerts/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-skillmerc-sec-filing-alerts", "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/skillmerc~sec-filing-alerts/runs": { "post": { "operationId": "runs-sync-skillmerc-sec-filing-alerts", "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/skillmerc~sec-filing-alerts/run-sync": { "post": { "operationId": "run-sync-skillmerc-sec-filing-alerts", "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": [ "companies" ], "properties": { "companies": { "title": "Tickers or CIKs", "type": "array", "description": "Ticker symbols (AAPL) or CIK numbers (320193). One company per line.", "items": { "type": "string" } }, "formTypes": { "title": "Form types", "type": "array", "description": "Only alert on these forms. Examples: 8-K, 10-K, 10-Q, 4, SC 13D, SC 13G, S-1, DEF 14A. You can write 13D/G as shorthand for both. Leave empty for every form type.", "default": [], "items": { "type": "string" } }, "includeAmendments": { "title": "Include amendments (/A)", "type": "boolean", "description": "Also alert on amended versions of the selected forms, e.g. 10-K/A when 10-K is selected.", "default": true }, "items8K": { "title": "8-K items (optional)", "type": "array", "description": "Only alert on 8-K filings that include at least one of these item numbers, e.g. 5.02 (officer or director changes), 1.01 (material agreement), 2.02 (results), 8.01 (other events). Other form types are not affected.", "items": { "type": "string" } }, "keywords": { "title": "Keywords (optional)", "type": "array", "description": "Case-insensitive words matched against the form type, 8-K items and the primary document description. A filing is reported if any keyword matches.", "items": { "type": "string" } }, "initialLookbackDays": { "title": "Initial lookback (days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "On the very first run for a watchlist, also report filings dated within this many days. 0 means the first run only saves a baseline and reports nothing. Use 30 to see recent filings immediately.", "default": 0 }, "watchlistName": { "title": "Watchlist name", "type": "string", "description": "Name for this watchlist. The actor keeps its last snapshot in a key-value store named sec-filing-alerts-. If left empty, the name is derived from the list of companies, so changing the list starts a fresh baseline." }, "webhookUrl": { "title": "Webhook URL (optional)", "pattern": "^https?://.+", "type": "string", "description": "HTTPS endpoint that receives one POST per run with the run summary and the list of alerts as JSON." }, "slackWebhookUrl": { "title": "Slack incoming webhook URL (optional)", "pattern": "^https://hooks\\.slack\\.com/.+", "type": "string", "description": "Slack incoming webhook. One message per run listing the new filings." }, "maxAlertsPerRun": { "title": "Max alerts per run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Cap on alert rows delivered (and charged) in one run. Extra filings are counted in the run summary but not delivered.", "default": 500 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }