{ "openapi": "3.0.1", "info": { "title": "SEC Filing Alerts: EDGAR Monitor by Ticker or CIK", "description": "SEC filing alerts for a watchlist of tickers or CIKs: new 8-K, 10-K, 10-Q, Form D or any other EDGAR form, one clean row per filing with 8-K item codes explained. On a schedule, each run returns only filings it has not delivered before.", "version": "0.1", "x-build-id": "k9o8wCPo3mrUeM60I" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lone_rachis~sec-edgar-filing-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lone_rachis-sec-edgar-filing-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/lone_rachis~sec-edgar-filing-monitor/runs": { "post": { "operationId": "runs-sync-lone_rachis-sec-edgar-filing-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/lone_rachis~sec-edgar-filing-monitor/run-sync": { "post": { "operationId": "run-sync-lone_rachis-sec-edgar-filing-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", "required": [ "companies" ], "properties": { "companies": { "title": "Companies", "maxItems": 1000, "type": "array", "description": "Companies to watch, one per line: a ticker such as AAPL or BRK.B, or a CIK (the SEC's company number) such as 320193 or CIK0000320193. Give the CIK for funds and private companies, which have no ticker. One run takes at most 1,000 companies. A ticker SEC does not list, or a CIK it has no filings for, gets one not-found row and costs nothing. The same company given twice is checked once.", "items": { "type": "string" } }, "formTypes": { "title": "Form types", "type": "array", "description": "EDGAR form types to return, written as EDGAR writes them: 8-K (current reports), 10-K and 10-Q (annual and quarterly reports), D (private offerings), S-1, 6-K, 20-F, DEF 14A and so on. 8-K rows carry their item codes with titles; Form D rows carry the offering amounts and industry. Forms 3, 4, 5 and 144 are refused, because they report one person's own trades and the Actor collects nothing about individuals. Changing this list starts a new memory unless you set a memory name below.", "default": [ "8-K", "10-K", "10-Q", "D" ], "items": { "type": "string" } }, "includeAmendments": { "title": "Include amendments", "type": "boolean", "description": "Also return amended versions of the chosen forms, such as 8-K/A for 8-K and D/A for D. An amendment is its own filing with its own accession number, so it is delivered and charged once like any other filing.", "default": true }, "lookbackDays": { "title": "Lookback for the first run", "minimum": 1, "maximum": 365, "type": "integer", "description": "How many days back the first run reads, counted from today in UTC: 30 means filings dated on or after the day 30 days ago. Later runs read the same window and skip what they already delivered, so a schedule more frequent than this window never misses a filing. Raising it on a later run delivers the older filings it now reaches.", "default": 30 }, "stateStoreName": { "title": "Memory name", "pattern": "^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "type": "string", "description": "Optional. Name of the key-value store that remembers which filings were delivered. Leave it empty and the Actor makes a name from the companies and form types, so the same list always uses the same memory and a changed list starts fresh. Set a name to keep one memory while you add or remove companies. Lower-case letters, digits and hyphens, at most 63 characters. Delete the store in Storage to start again from the lookback." }, "contactEmail": { "title": "Contact email for SEC", "type": "string", "description": "Optional. SEC asks every automated tool to name a contact in the User-Agent header of its requests. Leave it empty to use the Actor developer's address. Give your own if you want SEC to reach you about your runs. It is sent to SEC only, in that header, and is not stored in the output." } } }, "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 } } } } } } } } } }