# Dataset Delta โ€” Added, Removed & Changed Records (`orangepinlabs/dataset-delta`) Actor Compare two Apify datasets or track one dataset between runs. Emit only added, removed, and changed records with exact changed fields. - **URL**: https://apify.com/orangepinlabs/dataset-delta.md - **Developed by:** [Orange Pin Labs](https://apify.com/orangepinlabs) (community) - **Categories:** Developer tools - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 dataset changes 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/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.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/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 ## Dataset Delta Turn full scraper outputs into a small, actionable change feed. Dataset Delta compares any two Apify datasetsโ€”or tracks one dataset between scheduled runsโ€”and returns only records that were added, removed, or changed. It is designed for price monitoring, job alerts, inventory tracking, lead-list updates, regulatory feeds, and any recurring Actor workflow where users care about **what changed**, not another complete export. ### What it produces Each output row contains: - `changeType`: `added`, `removed`, `changed`, or optionally `unchanged` - `key`: the unique field or composite key used to match the record - `changedFields`: exact dot paths that changed - `before`: the old record - `after`: the new record The run's `OUTPUT` record contains totals and source metadata. ### Modes #### Compare two datasets Provide an older `baselineDatasetId` and a newer `currentDatasetId`. This mode is stateless and supports up to 50,000 records per dataset. #### Track one dataset Provide the current dataset and a stable `stateKey`. Dataset Delta saves a private snapshot in a named key-value store. By default, the first run only initializes the snapshot and emits no changes; enable `emitInitialSnapshot` if every existing record should be emitted as added. Later runs report the delta. Use a different `stateKey` for each scheduled source. If a user's maximum charge is reached before every change is emitted, the snapshot is deliberately not advanced. The next run can therefore recover the unprocessed changes. Tracking snapshots are capped at 8 MB. Use Compare mode for larger datasets. ### Example input ```json { "mode": "compare", "baselineDatasetId": "OLDER_DATASET_ID", "currentDatasetId": "NEWER_DATASET_ID", "keyFields": ["url"], "ignoreFields": ["scrapedAt", "metadata.requestId"], "maxItems": 10000 } ```` For records that are only unique in combination, use a composite key: ```json { "keyFields": ["company.id", "locationId"] } ``` Duplicate or missing keys fail clearly instead of silently producing incorrect changes. ### Pricing Dataset Delta uses pay-per-event pricing: - Actor start: Apify's standard low-cost start event - `delta-record`: **$0.002 per emitted change** Unchanged records do not create result charges unless you explicitly enable `includeUnchanged`. ### Requirements and limits - Both datasets must be accessible to the account running Dataset Delta. - Every record must contain the configured unique key fields. - Duplicate keys fail the run instead of producing an ambiguous comparison. - Compare mode supports at most 50,000 records per dataset. - Tracking snapshots are limited to 8 MB; use Compare mode for larger datasets. - No external API key, proxy, browser, LLM, or third-party service is required. ### Local development Requires Node.js 20 or newer. ```bash npm install npm test npm start ``` The checked-in local storage fixture compares two tiny datasets and ignores `scrapedAt`. # Actor input Schema ## `mode` (type: `string`): Compare two datasets now, or compare a dataset with this Actor's saved snapshot. ## `currentDatasetId` (type: `string`): The newer/current dataset ID or name. ## `baselineDatasetId` (type: `string`): Required in Compare mode. The older dataset ID or name. ## `keyFields` (type: `array`): One or more fields that uniquely identify a record, such as url, id, or company.id. ## `ignoreFields` (type: `array`): Fields that should not trigger a change, such as scrapedAt or metadata.requestId. Dot paths are supported. ## `stateKey` (type: `string`): Track mode only. Use a different value for each scheduled source. ## `emitInitialSnapshot` (type: `boolean`): Off by default so initializing a tracker does not create a large, chargeable change feed. ## `maxItems` (type: `integer`): Safety limit applied separately to the current and baseline datasets. ## `includeUnchanged` (type: `boolean`): Normally off. Enable for debugging or complete audit exports. ## Actor input object example ```json { "mode": "compare", "keyFields": [ "url" ], "ignoreFields": [], "stateKey": "default", "emitInitialSnapshot": false, "maxItems": 10000, "includeUnchanged": false } ``` # Actor output Schema ## `changes` (type: `string`): Added, removed, changed, and optionally unchanged records. Each item includes the matching key, changed field paths, and before/after values. ## `summary` (type: `string`): Run totals, source dataset IDs, matching key fields, ignored fields, tracking state, and charge-limit status. # 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 = {}; // Run the Actor and wait for it to finish const run = await client.actor("orangepinlabs/dataset-delta").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 = {} # Run the Actor and wait for it to finish run = client.actor("orangepinlabs/dataset-delta").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 '{}' | apify call orangepinlabs/dataset-delta --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=orangepinlabs/dataset-delta", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Dataset Delta โ€” Added, Removed & Changed Records", "description": "Compare two Apify datasets or track one dataset between runs. Emit only added, removed, and changed records with exact changed fields.", "version": "0.1", "x-build-id": "vpGuLTEzd0XtMOLcx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/orangepinlabs~dataset-delta/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-orangepinlabs-dataset-delta", "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/orangepinlabs~dataset-delta/runs": { "post": { "operationId": "runs-sync-orangepinlabs-dataset-delta", "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/orangepinlabs~dataset-delta/run-sync": { "post": { "operationId": "run-sync-orangepinlabs-dataset-delta", "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": [ "mode", "currentDatasetId", "keyFields" ], "properties": { "mode": { "title": "Mode", "enum": [ "compare", "track" ], "type": "string", "description": "Compare two datasets now, or compare a dataset with this Actor's saved snapshot.", "default": "compare" }, "currentDatasetId": { "title": "Current dataset", "type": "string", "description": "The newer/current dataset ID or name." }, "baselineDatasetId": { "title": "Baseline dataset", "type": "string", "description": "Required in Compare mode. The older dataset ID or name." }, "keyFields": { "title": "Unique key fields", "type": "array", "description": "One or more fields that uniquely identify a record, such as url, id, or company.id.", "items": { "type": "string" }, "default": [ "url" ] }, "ignoreFields": { "title": "Fields to ignore", "type": "array", "description": "Fields that should not trigger a change, such as scrapedAt or metadata.requestId. Dot paths are supported.", "items": { "type": "string" }, "default": [] }, "stateKey": { "title": "Tracking state name", "pattern": "^[A-Za-z0-9._-]{1,80}$", "type": "string", "description": "Track mode only. Use a different value for each scheduled source.", "default": "default" }, "emitInitialSnapshot": { "title": "Emit every record on the first tracking run", "type": "boolean", "description": "Off by default so initializing a tracker does not create a large, chargeable change feed.", "default": false }, "maxItems": { "title": "Maximum records per dataset", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Safety limit applied separately to the current and baseline datasets.", "default": 10000 }, "includeUnchanged": { "title": "Include unchanged records", "type": "boolean", "description": "Normally off. Enable for debugging or complete audit exports.", "default": false } } }, "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 } } } } } } } } } } ```