# SEC Filings Scraper — EDGAR & XBRL Data (`blackfalcondata/sec-filings-scraper`) Actor Scrape SEC filings straight from official sec.gov sources — 10-K, 10-Q, 8-K, Form 4 and more, by ticker or full-text search. Structured JSON with company name and filing date, XBRL financials, plus new-filing monitoring and direct document links. - **URL**: https://apify.com/blackfalcondata/sec-filings-scraper.md - **Developed by:** [Black Falcon Data](https://apify.com/blackfalcondata) (community) - **Categories:** Developer tools, Business, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 recent filing results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ### What does SEC Filings Scraper do? SEC Filings Scraper pulls SEC filings from the U.S. Securities and Exchange Commission's official public records on [sec.gov](https://sec.gov) (the EDGAR system). Look up a specific company's filing history by ticker or CIK, or run a full-text search across every filing since 2001 by keyword. Each result is a structured filing record with metadata (form type, filing and report dates, accession number, company name and CIK) plus direct links to the filing index and primary document — covering forms like 10-K, 10-Q, 8-K and Form 4. Optionally enrich `byCompany` runs with structured XBRL financial facts. ### How to use this actor - 👉 **Register for a free Apify account** — no credit card required. - 🎉 Just click **[Sign up free on Apify →](https://console.apify.com/sign-up?fpr=1h3gvi&fp_sid=ctarich)** and complete a quick signup. - 💰 A free Apify account includes $5 in monthly credits — enough to test this actor. - ⏳ Scrape during the free trial, with no commitment or upfront payment required. ### Key features - **♻️ Incremental mode** — recurring runs emit and charge only for filings not seen in prior runs of the same task. The first run builds a baseline; later runs return only the newly published filings. SEC filings are immutable once accepted, so there is no update or expiry lifecycle to track — incremental mode is ideal for scheduled monitoring of brand-new filings (e.g. a daily 8-K or Form 4 watch). Baselines are tracked per query configuration within the task. - **🔀 Two ways to find filings** — pull a specific company's filing history by ticker or CIK (`mode: byCompany`), or search the full text of every filing since 2001 by keyword (`mode: fullText`). Same structured filing records either way — pick the discovery path that fits your pipeline. - **📤 Export anywhere** — Download the dataset as JSON, CSV, or Excel from the Apify Console, or stream live via the Apify API and integrations (Make, Zapier, Google Sheets, n8n, …). - **🔔 Notifications** — Telegram, Slack, Discord, WhatsApp Cloud API, and generic webhook out of the box. Pair with incremental for daily new-listing alerts without pipeline glue. - **🔌 MCP connectors** — export your results into Notion via Apify's MCP connectors — a clean run-summary page, no glue code. Opt-in via the App connector field; deterministic field-mapping, no AI. Built on Apify's connector framework, so more destinations open up as their catalog grows. ### What data can you extract from sec.gov? Each filing record includes core metadata (`accessionNumber`, `cik`, `ticker`, `companyName`, `form`, `filingDate`, `reportDate`, `acceptanceDateTime`, and more), direct document links (`documentUrl`, `indexUrl`, `primaryDocument`), and classification fields (`sic`, `sicDescription`, `exchange`, `isXBRL`). All fields are always present — unavailable data points are returned as `null`, never omitted. Enable `includeFinancials` on `byCompany` runs to also output structured XBRL financial facts as separate records. ### Input The main inputs are a search keyword. Additional filters and options are available in the input schema. Key parameters: - **`mode`** — byCompany = pull a company's filings by ticker/CIK. fullText = search all filings by keyword. (default: `"byCompany"`) - **`tickers`** — Company tickers (byCompany mode), e.g. AAPL, MSFT. - **`ciks`** — SEC Central Index Keys (byCompany mode). Alternative to tickers. - **`query`** — Keyword/phrase to search across filing text (fullText mode). - **`formTypes`** — Filter to specific SEC forms, e.g. 10-K, 10-Q, 8-K, 4. Empty = all. - **`dateFrom`** — Filings on/after YYYY-MM-DD. - **`dateTo`** — Filings on/before YYYY-MM-DD. - **`issuerNameContains`** — Case-insensitive substring on company name. - **`exchange`** — Filter by listing exchange. (default: `"All"`) - **`incremental`** — Only return filings not seen in previous runs of this actor task. Useful for scheduled monitoring. (default: `false`) - **`includeFinancials`** — Also output structured financial facts (byCompany mode). (default: `false`) - **`financialConcepts`** — Limit financials to specific XBRL concepts, e.g. Revenues. Empty = all. - ...and 14 more parameters ### Input examples **Company filings by ticker** — Pull a company's recent filings, filtered to specific form types. → One filing record per matching filing, with metadata and direct document links. ```json { "mode": "byCompany", "tickers": [ "AAPL" ], "formTypes": [ "10-K", "10-Q", "8-K" ], "limit": 50 } ```` **Full-text search across all filings** — Search the full text of every filing since 2001 by keyword. → Filing records mentioning the search phrase, newest first. ```json { "mode": "fullText", "query": "going concern", "formTypes": [ "10-K" ], "limit": 100 } ``` **Company filings with XBRL financials** — Add structured XBRL financial facts alongside the filing metadata (byCompany mode). → Filing records plus separate financial-fact records for the requested concepts. ```json { "mode": "byCompany", "tickers": [ "MSFT" ], "includeFinancials": true, "financialConcepts": [ "Revenues" ], "limit": 25 } ``` **Monitor new filings (incremental)** — Schedule this run to receive only filings published since the previous run of the same task. → First run returns the current filings and builds a baseline; later runs return only newly published filings. ```json { "mode": "byCompany", "tickers": [ "AAPL", "MSFT" ], "formTypes": [ "8-K", "4" ], "incremental": true, "limit": 200 } ``` ### Output Each run produces a dataset of structured filing records. Results can be downloaded as JSON, CSV, or Excel from the Dataset tab in Apify Console. ### Example filing record ```json { "accessionNumber": "0001213900-26-068022", "cik": "0001424657", "ticker": "CUEN", "companyName": "Cuentas Inc.", "form": "8-K", "filingDate": "2026-06-12", "reportDate": null, "acceptanceDateTime": null, "items": null, "primaryDocument": "", "documentUrl": "https://www.sec.gov/Archives/edgar/data/1424657/000121390026068022/", "indexUrl": "https://www.sec.gov/Archives/edgar/data/1424657/000121390026068022/0001213900-26-068022-index.htm", "sizeBytes": null, "isXBRL": false, "exchange": "UNKNOWN", "sic": null, "sicDescription": null, "resolutionStrategy": "efts_display", "year": 2026, "recordType": "filing" } ``` ### Incremental mode When `incremental` is enabled, a run returns **only filings not seen in prior runs of the same task** — the newly published filings since you last polled. - The first run builds a baseline of the filings it sees; later runs emit only filings new to that baseline. - SEC filings are immutable once accepted by EDGAR, so there is no update, re-appear, or expiry lifecycle — a filing is either already seen (skipped) or new (emitted). - This makes incremental mode ideal for scheduled monitoring of brand-new filings (for example, a daily 8-K or Form 4 watch on a list of companies). - Baselines are namespaced per query configuration, so different ticker lists or search terms in the same task are tracked independently. ### How to scrape sec.gov 1. Go to [SEC Filings Scraper](https://apify.com/blackfalcondata/sec-filings-scraper?fpr=1h3gvi) in Apify Console. 2. Enter a search keyword. 3. Set `maxResults` to control how many results you need. 4. Click **Start** and wait for the run to finish. 5. Export the dataset as JSON, CSV, or Excel. ### Use cases - Extract filing data from sec.gov for market research and competitive analysis. - Monitor new and changed listings on scheduled runs without processing the full dataset every time. - Export clean, structured data to dashboards, spreadsheets, or data warehouses. ### How much does it cost to scrape sec.gov? SEC Filings Scraper uses [pay-per-event](https://docs.apify.com/platform/actors/paid-actors/pay-per-event) pricing. You pay a small fee when the run starts and then for each result that is actually produced. - **Run start:** $0 per run - **Per filing (primary event):** $0.002 You are billed only for the events your run actually triggers. Prices below are the Free plan tier. | Event | Price (Free tier) | Charged when | |---|---|---| | Actor Start | $0 (one-time) | Charged when the Actor starts running. Number of events charged depends on Actor memory (one event per GB, minimum one event). | | Recent filing result (primary) | $0.002 | Charged per filing dated within the last 12 months. | | Historical filing result | $0.0005 | Charged per filing older than 12 months. | | Financials result (per company) | $0.01 | Charged once per company for which XBRL financial facts are returned (includeFinancials). Billed per company, not per fact. | Example costs (primary event only — other events above add cost when they fire): - 10 results: **$0.02** - 25 results: **$0.05** - 100 results: **$0.2** - 200 results: **$0.4** - 500 results: **$1** #### Example: recurring monitoring savings These examples compare full re-scrapes with incremental runs at different churn rates. Churn is the share of listings that are new or whose tracked content changed since the previous run. Actual churn depends on your query breadth, source activity, and polling frequency — the scenarios below are examples, not predictions. Example setup: 250 results per run, daily polling (30 runs/month). Event-pricing examples scale linearly with result count. Numbers below are for the primary **Recent filing result** event. Other events (**Historical filing result**, **Financials result (per company)**) are billed separately when they fire. | Churn rate | Full re-scrape run cost | Incremental run cost | Savings vs full re-scrape | Monthly cost after baseline | |---|---:|---:|---:|---:| | 5% — stable niche query | $0.50 | $0.03 | $0.47 (95%) | $0.75 | | 15% — moderate broad query | $0.50 | $0.07 | $0.42 (85%) | $2.25 | | 30% — high-volume aggregator | $0.50 | $0.15 | $0.35 (70%) | $4.50 | Full re-scrape monthly cost at daily polling: $15.00. First month with incremental costs $1.23 / $2.67 / $4.85 for the 5% / 15% / 30% scenarios because the first run builds baseline state at full cost before incremental savings apply. Platform usage (compute and proxies) is billed separately by Apify based on actual consumption. Incremental runs consume less on result processing, though fixed per-run overhead stays the same. ### FAQ #### How many results can I get from sec.gov? The number of results depends on the search query and available listings on sec.gov. Use the `maxResults` parameter to control how many results are returned per run. #### Does SEC Filings Scraper support recurring monitoring? Yes. Enable incremental mode to only receive new or changed listings on subsequent runs. This is ideal for scheduled monitoring where you want to track changes over time without re-processing the full dataset. #### Can I integrate SEC Filings Scraper with other apps? Yes. SEC Filings Scraper works with Apify's [integrations](https://apify.com/integrations?fpr=1h3gvi) to connect with tools like Zapier, Make, Google Sheets, Slack, and more. You can also use webhooks to trigger actions when a run completes. #### Can I use SEC Filings Scraper with the Apify API? Yes. You can start runs, manage inputs, and retrieve results programmatically through the [Apify API](https://docs.apify.com/api/v2). Client libraries are available for JavaScript, Python, and other languages. #### Can I use SEC Filings Scraper through an MCP Server? Yes. Apify provides an [MCP Server](https://apify.com/apify/actors-mcp-server?fpr=1h3gvi) that lets AI assistants and agents call this actor directly. Use compact mode and `descriptionMaxLength` to keep payloads manageable for LLM context windows. #### Is it legal to scrape sec.gov? This actor extracts publicly available data from sec.gov. Web scraping of public information is generally considered legal, but you should always review the target site's terms of service and ensure your use case complies with applicable laws and regulations, including GDPR where relevant. #### Your feedback If you have questions, need a feature, or found a bug, please [open an issue](https://apify.com/blackfalcondata/sec-filings-scraper/issues?fpr=1h3gvi) on the actor's page in Apify Console. Your feedback helps us improve. ### You might also like - [Delisted Stocks List — NYSE & NASDAQ Delistings (SEC EDGAR)](https://apify.com/blackfalcondata/delisted-stocks-list?fpr=1h3gvi) — 36,000+ delisted stocks from NYSE, NASDAQ & OTC since 2002, with filing dates, exchange, and direct SEC EDGAR filing links. ### Getting started with Apify New to Apify? [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=1h3gvi\&fp_sid=ctarich) — no credit card required. 1. Sign up — $5 platform credit included 2. Open this actor and configure your input 3. Click **Start** — export results as JSON, CSV, or Excel Need more later? [See Apify pricing](https://apify.com/pricing?fpr=1h3gvi). ### Disclaimer This actor is an independent tool and is not affiliated with, endorsed by, or sponsored by the U.S. Securities and Exchange Commission (SEC). Data is sourced from the SEC's public EDGAR system. Filings may contain personal information that is already part of the public record; you are responsible for your downstream use of this data and for complying with any applicable laws (e.g. GDPR, FCRA). # Actor input Schema ## `mode` (type: `string`): byCompany = pull a company's filings by ticker/CIK. fullText = search all filings by keyword. ## `tickers` (type: `array`): Company tickers (byCompany mode), e.g. AAPL, MSFT. ## `ciks` (type: `array`): SEC Central Index Keys (byCompany mode). Alternative to tickers. ## `query` (type: `string`): Keyword/phrase to search across filing text (fullText mode). ## `formTypes` (type: `array`): Filter to specific SEC forms, e.g. 10-K, 10-Q, 8-K, 4. Empty = all. ## `dateFrom` (type: `string`): Filings on/after YYYY-MM-DD. ## `dateTo` (type: `string`): Filings on/before YYYY-MM-DD. ## `issuerNameContains` (type: `string`): Case-insensitive substring on company name. ## `exchange` (type: `string`): Filter by listing exchange. ## `incremental` (type: `boolean`): Only return filings not seen in previous runs of this actor task. Useful for scheduled monitoring. ## `includeFinancials` (type: `boolean`): Also output structured financial facts (byCompany mode). ## `financialConcepts` (type: `array`): Limit financials to specific XBRL concepts, e.g. Revenues. Empty = all. ## `limit` (type: `integer`): Max records to return. ## `telegramToken` (type: `string`): Telegram bot token from @BotFather. Required for Telegram notifications. ## `telegramChatId` (type: `string`): Telegram chat or channel ID where alerts are sent (e.g. "-100123456789" for a private group, or "@yourchannel"). ## `discordWebhookUrl` (type: `string`): Discord incoming webhook URL. Get one from Server Settings → Integrations → Webhooks. ## `slackWebhookUrl` (type: `string`): Slack incoming webhook URL. Create at api.slack.com/messaging/webhooks. ## `whatsappPhoneNumberId` (type: `string`): WhatsApp Business phone number ID from Meta Business Manager (NOT the phone number itself — the numeric ID shown next to your business number). Free service-conversation messages within 24 hours of last user-initiated contact. ## `whatsappAccessToken` (type: `string`): Meta Cloud API access token with `whatsapp_business_messaging` scope. Get a permanent token from a system user in Meta Business Manager. ## `whatsappTo` (type: `string`): Recipient phone in E.164 format (e.g. +14155552671). Recipient must have messaged your business number within the last 24 hours — outside that window, free-form text is rejected by Meta. ## `webhookUrl` (type: `string`): Generic webhook URL that receives a JSON POST with the full filing payload + run metadata. Universal escape hatch for n8n / Make / Zapier / your own backend. ## `webhookHeaders` (type: `object`): Optional headers (e.g. {"Authorization": "Bearer xyz"}) sent with the webhook POST. ## `notificationLimit` (type: `integer`): Maximum number of filings included in each notification message (1–20). Excess filings are still in the dataset; notifications get a summary line. ## `notifyOnlyChanges` (type: `boolean`): When Incremental Mode is on, only send notifications for newly published filings. Has no effect outside incremental mode. ## `appConnector` (type: `string`): Optional. Pick a connected app under Settings → API & Integrations to receive your filing results. Notion is supported today (a run-summary page); other MCP connectors are best-effort as Apify expands its catalog. ## `mcpIssueTeam` (type: `string`): Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one. ## Actor input object example ```json { "mode": "byCompany", "tickers": [ "AAPL" ], "exchange": "All", "incremental": false, "includeFinancials": false, "limit": 100, "notificationLimit": 5, "notifyOnlyChanges": false } ``` # Actor output Schema ## `results` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "tickers": [ "AAPL" ], "includeFinancials": false, "limit": 100 }; // Run the Actor and wait for it to finish const run = await client.actor("blackfalcondata/sec-filings-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "tickers": ["AAPL"], "includeFinancials": False, "limit": 100, } # Run the Actor and wait for it to finish run = client.actor("blackfalcondata/sec-filings-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "tickers": [ "AAPL" ], "includeFinancials": false, "limit": 100 }' | apify call blackfalcondata/sec-filings-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=blackfalcondata/sec-filings-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "SEC Filings Scraper — EDGAR & XBRL Data", "description": "Scrape SEC filings straight from official sec.gov sources — 10-K, 10-Q, 8-K, Form 4 and more, by ticker or full-text search. Structured JSON with company name and filing date, XBRL financials, plus new-filing monitoring and direct document links.", "version": "0.1", "x-build-id": "TxczwLQLNQSuLPORd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~sec-filings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-sec-filings-scraper", "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/blackfalcondata~sec-filings-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-sec-filings-scraper", "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/blackfalcondata~sec-filings-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-sec-filings-scraper", "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": "⚙️ Mode", "enum": [ "byCompany", "fullText" ], "type": "string", "description": "byCompany = pull a company's filings by ticker/CIK. fullText = search all filings by keyword.", "default": "byCompany" }, "tickers": { "title": "Tickers", "type": "array", "description": "Company tickers (byCompany mode), e.g. AAPL, MSFT.", "items": { "type": "string" } }, "ciks": { "title": "CIKs", "type": "array", "description": "SEC Central Index Keys (byCompany mode). Alternative to tickers.", "items": { "type": "string" } }, "query": { "title": "🔍 Full-text query", "type": "string", "description": "Keyword/phrase to search across filing text (fullText mode)." }, "formTypes": { "title": "Form types", "type": "array", "description": "Filter to specific SEC forms, e.g. 10-K, 10-Q, 8-K, 4. Empty = all.", "items": { "type": "string" } }, "dateFrom": { "title": "Date from", "type": "string", "description": "Filings on/after YYYY-MM-DD." }, "dateTo": { "title": "Date to", "type": "string", "description": "Filings on/before YYYY-MM-DD." }, "issuerNameContains": { "title": "Issuer name contains", "type": "string", "description": "Case-insensitive substring on company name." }, "exchange": { "title": "Exchange", "enum": [ "All", "NYSE", "NASDAQ", "NYSE_AMER", "NYSE_ARCA", "CBOE", "UNKNOWN" ], "type": "string", "description": "Filter by listing exchange.", "default": "All" }, "incremental": { "title": "♻️ Incremental (new filings only)", "type": "boolean", "description": "Only return filings not seen in previous runs of this actor task. Useful for scheduled monitoring.", "default": false }, "includeFinancials": { "title": "Include XBRL financials", "type": "boolean", "description": "Also output structured financial facts (byCompany mode).", "default": false }, "financialConcepts": { "title": "Financial concepts", "type": "array", "description": "Limit financials to specific XBRL concepts, e.g. Revenues. Empty = all.", "items": { "type": "string" } }, "limit": { "title": "Limit", "minimum": 1, "type": "integer", "description": "Max records to return.", "default": 1000 }, "telegramToken": { "title": "🤖 Telegram Bot Token", "type": "string", "description": "Telegram bot token from @BotFather. Required for Telegram notifications." }, "telegramChatId": { "title": "💬 Telegram Chat ID", "type": "string", "description": "Telegram chat or channel ID where alerts are sent (e.g. \"-100123456789\" for a private group, or \"@yourchannel\")." }, "discordWebhookUrl": { "title": "🎮 Discord Webhook URL", "type": "string", "description": "Discord incoming webhook URL. Get one from Server Settings → Integrations → Webhooks." }, "slackWebhookUrl": { "title": "💼 Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL. Create at api.slack.com/messaging/webhooks." }, "whatsappPhoneNumberId": { "title": "📱 WhatsApp Phone Number ID", "type": "string", "description": "WhatsApp Business phone number ID from Meta Business Manager (NOT the phone number itself — the numeric ID shown next to your business number). Free service-conversation messages within 24 hours of last user-initiated contact." }, "whatsappAccessToken": { "title": "🔐 WhatsApp Access Token", "type": "string", "description": "Meta Cloud API access token with `whatsapp_business_messaging` scope. Get a permanent token from a system user in Meta Business Manager." }, "whatsappTo": { "title": "📨 WhatsApp Recipient", "type": "string", "description": "Recipient phone in E.164 format (e.g. +14155552671). Recipient must have messaged your business number within the last 24 hours — outside that window, free-form text is rejected by Meta." }, "webhookUrl": { "title": "🪝 Generic Webhook URL", "type": "string", "description": "Generic webhook URL that receives a JSON POST with the full filing payload + run metadata. Universal escape hatch for n8n / Make / Zapier / your own backend." }, "webhookHeaders": { "title": "🔑 Webhook Headers", "type": "object", "description": "Optional headers (e.g. {\"Authorization\": \"Bearer xyz\"}) sent with the webhook POST." }, "notificationLimit": { "title": "📊 Max Filings Per Notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of filings included in each notification message (1–20). Excess filings are still in the dataset; notifications get a summary line.", "default": 5 }, "notifyOnlyChanges": { "title": "🔄 Notify Only New Filings", "type": "boolean", "description": "When Incremental Mode is on, only send notifications for newly published filings. Has no effect outside incremental mode.", "default": false }, "appConnector": { "title": "Send results to Notion (or another connected app)", "type": "string", "description": "Optional. Pick a connected app under Settings → API & Integrations to receive your filing results. Notion is supported today (a run-summary page); other MCP connectors are best-effort as Apify expands its catalog." }, "mcpIssueTeam": { "title": "Issue tracker team", "type": "string", "description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one." } } }, "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 } } } } } } } } } } ```