# 📄 SEC & ESG Report Scraper (`taroyamada/esg-disclosure-tracker`) Actor Extract climate disclosures and sustainability reports directly from SEC EDGAR filings and corporate investor relations web pages. - **URL**: https://apify.com/taroyamada/esg-disclosure-tracker.md - **Developed by:** [åĪŠéƒŽ åąąį”°](https://apify.com/taroyamada) (community) - **Categories:** Business, News - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $10.00 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. 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 ## ESG Disclosure Tracker API Monitor official ESG, sustainability, climate, investor relations, and SEC / EDGAR disclosure surfaces with one summary-first company digest per monitored target. ### Store Quickstart 1. Start with `input.local.json` for a fixture-safe baseline / changed proof. 2. Move to `store-input.example.json` for a single-company official-source starter. 3. Keep the same `snapshotKey` on reruns so the actor can tell you which monitored disclosure surfaces changed. ### Key Features - ðŸ’đ **Real-time market signals** — Pulls current prices/rates from authoritative public APIs - 📊 **Historical-ready output** — Timestamp every row for downstream time-series analysis - 🌍 **Multi-asset support** — Handles dozens of symbols/pairs per run - ðŸ“Ą **Webhook alerts on threshold** — Push to Slack when prices cross user-defined bands - 🔄 **Cron-friendly** — Idempotent runs with persistent state for scheduled monitoring ### Use Cases | Who | Why | |-----|-----| | Developers | Automate recurring data fetches without building custom scrapers | | Data teams | Pipe structured output into analytics warehouses | | Ops teams | Monitor changes via webhook alerts | | Product managers | Track competitor/market signals without engineering time | ### Input | Field | Type | Default | Description | |-------|------|---------|-------------| | companies | array | prefilled | One monitored company per output row. Use official disclosure pages and SEC / EDGAR company submissions where possible. | | requestTimeoutSeconds | integer | `30` | Timeout for each disclosure page or SEC / EDGAR request. | | maxChars | integer | `30000` | Upper bound for extracted page text per monitored disclosure surface. | | delivery | string | `"dataset"` | dataset writes results to the Apify dataset. webhook posts the digest JSON. email is a placeholder for later delivery ex | | datasetMode | string | `"changes_only"` | changes_only emits only changed companies. all emits every company row. action_needed limits results to higher-severity | | webhookUrl | string | — | POST target for webhook delivery. Leave empty for dataset runs. | | notifyOnNoChange | boolean | `false` | When false, webhook delivery is skipped if no company changed. | | snapshotKey | string | `"esg-disclosure-tracker-snapshots"` | Stable key used to persist disclosure snapshots between recurring runs. | #### Input Example ```json { "companies": [ { "id": "microsoft", "name": "Microsoft", "criticality": "high", "owner": "ESG Program Office", "peerGroup": "mega-cap-software", "tags": [ "software", "scope-3", "climate" ], "disclosurePacks": { "sustainability": [ { "id": "msft-sustainability-report", "name": "Microsoft Sustainability Report", "url": "https://www.microsoft.com/en-us/corporate-responsibility/sustainability/report", "includePatterns": [ "sustainability report", "annual report", "scope 1", "scope 2", "scope 3", "net zero" ], "staleAfterDays": 430 } ], "sec_filings": [ { "id": "msft-sec-10k", "name": "Microsoft SEC climate watch", "sourceType": "sec_edgar", "cik": "789019", "formTypes": [ "10-K", "10-Q", "8-K" ], "staleAfterDays": 430 } ] } } ], "requestTimeoutSeconds": 30, "maxChars": 30000, "delivery": "dataset", "datasetMode": "changes_only", "notifyOnNoChange": false, "snapshotKey": "esg-disclosure-tracker-snapshots", "diffMode": "line_summary", "summaryMaxLines": 12, "concurrency": 2, "batchDelayMs": 500, "dryRun": false } ```` ### Output | Field | Type | Description | |-------|------|-------------| | `meta` | object | | | `recurringDigest` | object | | | `actionNeeded` | array | | | `results` | array | | | `actionNeeded[].companyId` | string | | | `actionNeeded[].companyName` | string | | | `actionNeeded[].owner` | string | | | `actionNeeded[].severity` | string | | | `actionNeeded[].status` | string | | | `actionNeeded[].reason` | string | | | `actionNeeded[].peerComparison` | object | | | `actionNeeded[].recommendedActions` | array | | | `actionNeeded[].executiveSummary` | string | | #### Output Example ```json { "meta": { "generatedAt": "2026-04-05T13:28:06.026Z", "now": "2026-03-25T12:00:00.000Z", "input": { "companyCount": 2, "surfaceCount": 5, "delivery": "dataset", "datasetMode": "all", "diffMode": "line_summary", "summaryMaxLines": 12, "concurrency": 2, "batchDelayMs": 0, "dryRun": false }, "snapshot": { "key": "local-esg-disclosure-proof", "loadedFrom": "local", "savedTo": "local" }, "warnings": [], "totals": { "companies": 2, "monitoredSurfaces": 5, "changedCompanies": 1, "initialCompanies": 1, "unchangedCompanies": 0, "partialCompanies": 0, "errorCompanies": 0, "actionNeededCompanies": 1, "changedSurfaces": 0, "initialSurfaces": 5, "unchangedSurfaces": 0, "errorSurfaces": 0, "staleSurfaces": 2, "missingSurfaces": 0, "newDisclosureSurfaces": 0 }, "severityCounts": { "critical": 0, ``` ### API Usage Run this actor programmatically using the Apify API. Replace `YOUR_API_TOKEN` with your token from [Apify Console → Settings → Integrations](https://console.apify.com/account/integrations). #### cURL ```bash curl -X POST "https://api.apify.com/v2/acts/taroyamada~esg-disclosure-tracker/run-sync-get-dataset-items?token=YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "companies": [ { "id": "microsoft", "name": "Microsoft", "criticality": "high", "owner": "ESG Program Office", "peerGroup": "mega-cap-software", "tags": [ "software", "scope-3", "climate" ], "disclosurePacks": { "sustainability": [ { "id": "msft-sustainability-report", "name": "Microsoft Sustainability Report", "url": "https://www.microsoft.com/en-us/corporate-responsibility/sustainability/report", "includePatterns": [ "sustainability report", "annual report", "scope 1", "scope 2", "scope 3", "net zero" ], "staleAfterDays": 430 } ], "sec_filings": [ { "id": "msft-sec-10k", "name": "Microsoft SEC climate watch", "sourceType": "sec_edgar", "cik": "789019", "formTypes": [ "10-K", "10-Q", "8-K" ], "staleAfterDays": 430 } ] } } ], "requestTimeoutSeconds": 30, "maxChars": 30000, "delivery": "dataset", "datasetMode": "changes_only", "notifyOnNoChange": false, "snapshotKey": "esg-disclosure-tracker-snapshots", "diffMode": "line_summary", "summaryMaxLines": 12, "concurrency": 2, "batchDelayMs": 500, "dryRun": false }' ``` #### Python ```python from apify_client import ApifyClient client = ApifyClient("YOUR_API_TOKEN") run = client.actor("taroyamada/esg-disclosure-tracker").call(run_input={ "companies": [ { "id": "microsoft", "name": "Microsoft", "criticality": "high", "owner": "ESG Program Office", "peerGroup": "mega-cap-software", "tags": [ "software", "scope-3", "climate" ], "disclosurePacks": { "sustainability": [ { "id": "msft-sustainability-report", "name": "Microsoft Sustainability Report", "url": "https://www.microsoft.com/en-us/corporate-responsibility/sustainability/report", "includePatterns": [ "sustainability report", "annual report", "scope 1", "scope 2", "scope 3", "net zero" ], "staleAfterDays": 430 } ], "sec_filings": [ { "id": "msft-sec-10k", "name": "Microsoft SEC climate watch", "sourceType": "sec_edgar", "cik": "789019", "formTypes": [ "10-K", "10-Q", "8-K" ], "staleAfterDays": 430 } ] } } ], "requestTimeoutSeconds": 30, "maxChars": 30000, "delivery": "dataset", "datasetMode": "changes_only", "notifyOnNoChange": false, "snapshotKey": "esg-disclosure-tracker-snapshots", "diffMode": "line_summary", "summaryMaxLines": 12, "concurrency": 2, "batchDelayMs": 500, "dryRun": false }) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) ``` #### JavaScript / Node.js ```javascript import { ApifyClient } from 'apify-client'; const client = new ApifyClient({ token: 'YOUR_API_TOKEN' }); const run = await client.actor('taroyamada/esg-disclosure-tracker').call({ "companies": [ { "id": "microsoft", "name": "Microsoft", "criticality": "high", "owner": "ESG Program Office", "peerGroup": "mega-cap-software", "tags": [ "software", "scope-3", "climate" ], "disclosurePacks": { "sustainability": [ { "id": "msft-sustainability-report", "name": "Microsoft Sustainability Report", "url": "https://www.microsoft.com/en-us/corporate-responsibility/sustainability/report", "includePatterns": [ "sustainability report", "annual report", "scope 1", "scope 2", "scope 3", "net zero" ], "staleAfterDays": 430 } ], "sec_filings": [ { "id": "msft-sec-10k", "name": "Microsoft SEC climate watch", "sourceType": "sec_edgar", "cik": "789019", "formTypes": [ "10-K", "10-Q", "8-K" ], "staleAfterDays": 430 } ] } } ], "requestTimeoutSeconds": 30, "maxChars": 30000, "delivery": "dataset", "datasetMode": "changes_only", "notifyOnNoChange": false, "snapshotKey": "esg-disclosure-tracker-snapshots", "diffMode": "line_summary", "summaryMaxLines": 12, "concurrency": 2, "batchDelayMs": 500, "dryRun": false }); const { items } = await client.dataset(run.defaultDatasetId).listItems(); console.log(items); ``` ### Tips & Limitations - Use Apify Schedules to run this every N minutes and build your own historical dataset. - Threshold alerts work best with webhook delivery — pipe into PagerDuty/Slack for ops visibility. - For trading applications, note that public APIs have 5–15 minute lag. Don't use for HFT. - Combine with `weather-forecast-fetcher` or `sec-edgar-filings-monitor` for cross-signal strategies. - Source APIs are free — this actor has no subscription cost beyond Apify compute. ### FAQ **What's the data source?** Authoritative public APIs (e.g., ECB, Federal Reserve, SEC EDGAR, exchange official APIs). See actor-specific docs for the full list. **How do I backtest historical data?** Schedule this actor daily and accumulate Apify Dataset rows — you build your own history over time. **Are there rate limits?** Source APIs rate-limit at their level. This actor respects those with built-in backoff. **How fresh is the data?** Typically 1–15 minutes behind real-time, depending on the source API. Check each actor's `meta.dataAge` field. **Can I use this for trading automation?** For backtesting/research yes. For live trading, use a paid real-time feed — this actor prioritizes reliability over sub-second latency. ### Related Actors Market Data & Financial APIs cluster — explore related Apify tools: - [ðŸ’ą Exchange Rate Monitor](https://apify.com/taroyamada/exchange-rate-monitor) — Monitor 160+ foreign exchange rates with automatic change detection. - [💰 Crypto Price Tracker](https://apify.com/taroyamada/cryptocurrency-price-tracker) — Track cryptocurrency prices, market caps, 24h volumes, and price changes for 10,000+ coins via CoinGecko API. - [ðŸŒĪïļ Weather Forecast API](https://apify.com/taroyamada/weather-forecast-fetcher) — Fetch weather forecasts for any location worldwide via free Open-Meteo API. - [📊 SEC EDGAR Monitor](https://apify.com/taroyamada/sec-edgar-filings-monitor) — Monitor SEC EDGAR filings for US public companies by ticker or CIK. - [Competitive Pricing Monitor - SaaS & Ecommerce Plan Tracker](https://apify.com/taroyamada/competitive-pricing-monitor) — Monitor competitor SaaS and ecommerce pricing pages for plan changes, price increases/decreases, new/removed tiers, and packaging shifts. ### Cost **Pay Per Event**: - `actor-start`: $0.01 (flat fee per run) - `dataset-item`: $0.003 per output item **Example**: 1,000 items = $0.01 + (1,000 × $0.003) = **$3.01** No subscription required — you only pay for what you use. # Actor input Schema ## `companies` (type: `array`): One monitored company per output row. Use official disclosure pages and SEC / EDGAR company submissions where possible. ## `requestTimeoutSeconds` (type: `integer`): Timeout for each disclosure page or SEC / EDGAR request. ## `maxChars` (type: `integer`): Upper bound for extracted page text per monitored disclosure surface. ## `delivery` (type: `string`): dataset writes results to the Apify dataset. webhook posts the digest JSON. email is a placeholder for later delivery expansion. ## `datasetMode` (type: `string`): changes\_only emits only changed companies. all emits every company row. action\_needed limits results to higher-severity disclosure changes. ## `webhookUrl` (type: `string`): POST target for webhook delivery. Leave empty for dataset runs. ## `notifyOnNoChange` (type: `boolean`): When false, webhook delivery is skipped if no company changed. ## `snapshotKey` (type: `string`): Stable key used to persist disclosure snapshots between recurring runs. ## `diffMode` (type: `string`): line\_summary includes compact added/removed disclosure text snippets. hash\_only only compares snapshot hashes. ## `summaryMaxLines` (type: `integer`): Maximum added and removed lines included in disclosure change summaries. ## `concurrency` (type: `integer`): Concurrent disclosure fetches. Keep low for polite recurring monitoring. ## `batchDelayMs` (type: `integer`): Delay between concurrency batches to reduce rate-limit pressure on disclosure surfaces. ## `dryRun` (type: `boolean`): Preview fetch and diff behavior without persisting snapshots or posting webhooks. ## `nowIso` (type: `string`): Optional ISO timestamp override for deterministic fixture or replay tests. ## Actor input object example ```json { "companies": [ { "id": "microsoft", "name": "Microsoft", "criticality": "high", "owner": "ESG Program Office", "peerGroup": "mega-cap-software", "tags": [ "software", "scope-3", "climate" ], "disclosurePacks": { "sustainability": [ { "id": "msft-sustainability-report", "name": "Microsoft Sustainability Report", "url": "https://www.microsoft.com/en-us/corporate-responsibility/sustainability/report", "includePatterns": [ "sustainability report", "annual report", "scope 1", "scope 2", "scope 3", "net zero" ], "staleAfterDays": 430 } ], "sec_filings": [ { "id": "msft-sec-10k", "name": "Microsoft SEC climate watch", "sourceType": "sec_edgar", "cik": "789019", "formTypes": [ "10-K", "10-Q", "8-K" ], "staleAfterDays": 430 } ] } } ], "requestTimeoutSeconds": 30, "maxChars": 30000, "delivery": "dataset", "datasetMode": "changes_only", "notifyOnNoChange": false, "snapshotKey": "esg-disclosure-tracker-snapshots", "diffMode": "line_summary", "summaryMaxLines": 12, "concurrency": 2, "batchDelayMs": 500, "dryRun": false } ``` # 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 = { "companies": [ { "id": "microsoft", "name": "Microsoft", "criticality": "high", "owner": "ESG Program Office", "peerGroup": "mega-cap-software", "tags": [ "software", "scope-3", "climate" ], "disclosurePacks": { "sustainability": [ { "id": "msft-sustainability-report", "name": "Microsoft Sustainability Report", "url": "https://www.microsoft.com/en-us/corporate-responsibility/sustainability/report", "includePatterns": [ "sustainability report", "annual report", "scope 1", "scope 2", "scope 3", "net zero" ], "staleAfterDays": 430 } ], "sec_filings": [ { "id": "msft-sec-10k", "name": "Microsoft SEC climate watch", "sourceType": "sec_edgar", "cik": "789019", "formTypes": [ "10-K", "10-Q", "8-K" ], "staleAfterDays": 430 } ] } } ] }; // Run the Actor and wait for it to finish const run = await client.actor("taroyamada/esg-disclosure-tracker").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 = { "companies": [{ "id": "microsoft", "name": "Microsoft", "criticality": "high", "owner": "ESG Program Office", "peerGroup": "mega-cap-software", "tags": [ "software", "scope-3", "climate", ], "disclosurePacks": { "sustainability": [{ "id": "msft-sustainability-report", "name": "Microsoft Sustainability Report", "url": "https://www.microsoft.com/en-us/corporate-responsibility/sustainability/report", "includePatterns": [ "sustainability report", "annual report", "scope 1", "scope 2", "scope 3", "net zero", ], "staleAfterDays": 430, }], "sec_filings": [{ "id": "msft-sec-10k", "name": "Microsoft SEC climate watch", "sourceType": "sec_edgar", "cik": "789019", "formTypes": [ "10-K", "10-Q", "8-K", ], "staleAfterDays": 430, }], }, }] } # Run the Actor and wait for it to finish run = client.actor("taroyamada/esg-disclosure-tracker").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 '{ "companies": [ { "id": "microsoft", "name": "Microsoft", "criticality": "high", "owner": "ESG Program Office", "peerGroup": "mega-cap-software", "tags": [ "software", "scope-3", "climate" ], "disclosurePacks": { "sustainability": [ { "id": "msft-sustainability-report", "name": "Microsoft Sustainability Report", "url": "https://www.microsoft.com/en-us/corporate-responsibility/sustainability/report", "includePatterns": [ "sustainability report", "annual report", "scope 1", "scope 2", "scope 3", "net zero" ], "staleAfterDays": 430 } ], "sec_filings": [ { "id": "msft-sec-10k", "name": "Microsoft SEC climate watch", "sourceType": "sec_edgar", "cik": "789019", "formTypes": [ "10-K", "10-Q", "8-K" ], "staleAfterDays": 430 } ] } } ] }' | apify call taroyamada/esg-disclosure-tracker --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=taroyamada/esg-disclosure-tracker", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "📄 SEC & ESG Report Scraper", "description": "Extract climate disclosures and sustainability reports directly from SEC EDGAR filings and corporate investor relations web pages.", "version": "0.1", "x-build-id": "uPaRTtNXxgobKslgH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~esg-disclosure-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-esg-disclosure-tracker", "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/taroyamada~esg-disclosure-tracker/runs": { "post": { "operationId": "runs-sync-taroyamada-esg-disclosure-tracker", "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/taroyamada~esg-disclosure-tracker/run-sync": { "post": { "operationId": "run-sync-taroyamada-esg-disclosure-tracker", "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", "type": "array", "description": "One monitored company per output row. Use official disclosure pages and SEC / EDGAR company submissions where possible." }, "requestTimeoutSeconds": { "title": "Request Timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for each disclosure page or SEC / EDGAR request.", "default": 30 }, "maxChars": { "title": "Max Extracted Characters per Surface", "minimum": 1000, "maximum": 200000, "type": "integer", "description": "Upper bound for extracted page text per monitored disclosure surface.", "default": 30000 }, "delivery": { "title": "Delivery", "enum": [ "dataset", "webhook", "email" ], "type": "string", "description": "dataset writes results to the Apify dataset. webhook posts the digest JSON. email is a placeholder for later delivery expansion.", "default": "dataset" }, "datasetMode": { "title": "Dataset Mode", "enum": [ "action_needed", "changes_only", "all" ], "type": "string", "description": "changes_only emits only changed companies. all emits every company row. action_needed limits results to higher-severity disclosure changes.", "default": "changes_only" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "POST target for webhook delivery. Leave empty for dataset runs." }, "notifyOnNoChange": { "title": "Notify On No Change", "type": "boolean", "description": "When false, webhook delivery is skipped if no company changed.", "default": false }, "snapshotKey": { "title": "Snapshot Key", "type": "string", "description": "Stable key used to persist disclosure snapshots between recurring runs.", "default": "esg-disclosure-tracker-snapshots" }, "diffMode": { "title": "Diff Mode", "enum": [ "line_summary", "hash_only" ], "type": "string", "description": "line_summary includes compact added/removed disclosure text snippets. hash_only only compares snapshot hashes.", "default": "line_summary" }, "summaryMaxLines": { "title": "Max Diff Summary Lines", "minimum": 5, "maximum": 50, "type": "integer", "description": "Maximum added and removed lines included in disclosure change summaries.", "default": 12 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Concurrent disclosure fetches. Keep low for polite recurring monitoring.", "default": 2 }, "batchDelayMs": { "title": "Inter-batch Delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay between concurrency batches to reduce rate-limit pressure on disclosure surfaces.", "default": 500 }, "dryRun": { "title": "Dry Run", "type": "boolean", "description": "Preview fetch and diff behavior without persisting snapshots or posting webhooks.", "default": false }, "nowIso": { "title": "Override Current Time", "type": "string", "description": "Optional ISO timestamp override for deterministic fixture or replay tests." } } }, "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 } } } } } } } } } } ```