# Dataset Join and Enrichment (`eager_vitamin/apify-dataset-join-enrichment`) Actor Join and enrich two Apify datasets by URL, ID, or another stable key with bounded, collision-safe output. - **URL**: https://apify.com/eager\_vitamin/apify-dataset-join-enrichment.md - **Developed by:** [Lau Kuan Ee](https://apify.com/eager_vitamin) (community) - **Categories:** Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows. 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 Join and Enrichment Join two Apify datasets by URL, ID, or another stable field without exporting them to a spreadsheet or database. The Actor uses one bounded right-side index and never performs a many-to-many expansion. ### Why this Actor - Accepts dataset IDs, inline records, or one of each. - Supports nested keys such as `company.domain`. - Provides inner, left, and full joins. - Preserves left fields and prefixes colliding right-side fields. - Rejects many-to-many joins before writing output. - Reads private datasets with the run's `APIFY_TOKEN`, which is never logged or stored. ### Input example ```json { "leftDatasetId": "LEFT_DATASET_ID", "rightDatasetId": "RIGHT_DATASET_ID", "leftKey": "url", "rightKey": "canonicalUrl", "joinType": "left", "rightPrefix": "source_", "duplicateKeyPolicy": "error", "maxLeftItems": 10000, "maxRightItems": 10000 } ```` `duplicateKeyPolicy` can stop on duplicate right keys or deterministically keep the first or last record. If the same key is duplicated on both sides, the run stops even under a selection policy because the requested relationship is many-to-many. ### Output The default dataset contains joined JSON rows. Existing left-side values are preserved; right-side collisions use `rightPrefix`. `OUTPUT.json` reports loaded, matched, left-only, right-only, missing-key, duplicate-key, and emitted counts. Each side is capped at 100,000 records. Version 1 is an in-memory bounded join, not a streaming or distributed ETL system. ### Pricing proposal `$0.75` per 1,000 emitted rows plus Apify's required minimum Actor-start event. Final pricing is staged separately in the Apify Console. # Actor input Schema ## `leftDatasetId` (type: `string`): Leave empty when using Left inline records. ## `leftItems` (type: `array`): Optional left-side JSON records for a quick trial. ## `rightDatasetId` (type: `string`): Leave empty when using Right inline records. ## `rightItems` (type: `array`): Optional right-side JSON records for a quick trial. ## `leftKey` (type: `string`): Stable field used to match left records. ## `rightKey` (type: `string`): Stable field used to match right records. ## `joinType` (type: `string`): Choose matched-only, all left, or all records from both sides. ## `rightPrefix` (type: `string`): Prefix applied when a right-side field already exists on the left row. ## `duplicateKeyPolicy` (type: `string`): Stop on duplicate right keys or select the first or last record deterministically. ## `maxLeftItems` (type: `integer`): Hard limit for records loaded from the left side. ## `maxRightItems` (type: `integer`): Hard limit for records loaded from the right side. ## Actor input object example ```json { "leftItems": [ { "id": "job-1", "title": "Data Engineer" }, { "id": "job-2", "title": "Product Analyst" } ], "rightItems": [ { "id": "job-1", "company": "Acme", "status": "open" }, { "id": "job-3", "company": "Beta", "status": "open" } ], "leftKey": "id", "rightKey": "id", "joinType": "left", "rightPrefix": "right_", "duplicateKeyPolicy": "error", "maxLeftItems": 10000, "maxRightItems": 10000 } ``` # Actor output Schema ## `results` (type: `string`): No description ## `summary` (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 = { "leftItems": [ { "id": "job-1", "title": "Data Engineer" }, { "id": "job-2", "title": "Product Analyst" } ], "rightItems": [ { "id": "job-1", "company": "Acme", "status": "open" }, { "id": "job-3", "company": "Beta", "status": "open" } ] }; // Run the Actor and wait for it to finish const run = await client.actor("eager_vitamin/apify-dataset-join-enrichment").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 = { "leftItems": [ { "id": "job-1", "title": "Data Engineer", }, { "id": "job-2", "title": "Product Analyst", }, ], "rightItems": [ { "id": "job-1", "company": "Acme", "status": "open", }, { "id": "job-3", "company": "Beta", "status": "open", }, ], } # Run the Actor and wait for it to finish run = client.actor("eager_vitamin/apify-dataset-join-enrichment").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 '{ "leftItems": [ { "id": "job-1", "title": "Data Engineer" }, { "id": "job-2", "title": "Product Analyst" } ], "rightItems": [ { "id": "job-1", "company": "Acme", "status": "open" }, { "id": "job-3", "company": "Beta", "status": "open" } ] }' | apify call eager_vitamin/apify-dataset-join-enrichment --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=eager_vitamin/apify-dataset-join-enrichment", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Dataset Join and Enrichment", "description": "Join and enrich two Apify datasets by URL, ID, or another stable key with bounded, collision-safe output.", "version": "0.1", "x-build-id": "4RQBq5LSKyZe2XzT9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/eager_vitamin~apify-dataset-join-enrichment/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-eager_vitamin-apify-dataset-join-enrichment", "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/eager_vitamin~apify-dataset-join-enrichment/runs": { "post": { "operationId": "runs-sync-eager_vitamin-apify-dataset-join-enrichment", "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/eager_vitamin~apify-dataset-join-enrichment/run-sync": { "post": { "operationId": "run-sync-eager_vitamin-apify-dataset-join-enrichment", "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": { "leftDatasetId": { "title": "Left dataset ID or name", "type": "string", "description": "Leave empty when using Left inline records." }, "leftItems": { "title": "Left inline records", "type": "array", "description": "Optional left-side JSON records for a quick trial.", "items": { "type": "object" } }, "rightDatasetId": { "title": "Right dataset ID or name", "type": "string", "description": "Leave empty when using Right inline records." }, "rightItems": { "title": "Right inline records", "type": "array", "description": "Optional right-side JSON records for a quick trial.", "items": { "type": "object" } }, "leftKey": { "title": "Left key dot path", "type": "string", "description": "Stable field used to match left records.", "default": "id" }, "rightKey": { "title": "Right key dot path", "type": "string", "description": "Stable field used to match right records.", "default": "id" }, "joinType": { "title": "Join type", "enum": [ "inner", "left", "full" ], "type": "string", "description": "Choose matched-only, all left, or all records from both sides.", "default": "left" }, "rightPrefix": { "title": "Right-side collision prefix", "type": "string", "description": "Prefix applied when a right-side field already exists on the left row.", "default": "right_" }, "duplicateKeyPolicy": { "title": "Duplicate right-key policy", "enum": [ "error", "first", "last" ], "type": "string", "description": "Stop on duplicate right keys or select the first or last record deterministically.", "default": "error" }, "maxLeftItems": { "title": "Maximum left records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard limit for records loaded from the left side.", "default": 10000 }, "maxRightItems": { "title": "Maximum right records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard limit for records loaded from the right side.", "default": 10000 } } }, "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 } } } } } } } } } } ```