# B2B Waterfall Enrichment (`josrade/b2b-waterfall-enrichment`) Actor

Multi-provider waterfall enrichment for company / email / domain. Tries providers in cheapest-first order, returns first match with attribution and a hard budget cap.

- **URL**: https://apify.com/josrade/b2b-waterfall-enrichment.md
- **Developed by:** [jts](https://apify.com/josrade) (community)
- **Categories:** Developer tools, Business
- **Stats:** 0 total users, 0 monthly users, 0.0% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.01 / 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

<!-- Generated by npm run sync:marketplace. Do not edit manually. -->

### What this Actor does

Multi-provider waterfall enrichment for company / email / domain. Tries providers in cheapest-first order, returns first match with attribution and a hard budget cap.

### Input example

```json
{
  "lookups": [
    {
      "email": "founder@linear.app"
    }
  ],
  "providers": [
    "internal",
    "hunter",
    "clearbit",
    "peopledatalabs",
    "apollo"
  ],
  "maxBudgetUsd": 1
}
````

### Input fields

Provide one or more lookups (email / domain / companyName), the provider order, a budget cap, and per-provider API tokens.

- `lookups` (array, user input): Array of lookup records. Each item is { email?, domain?, companyName? }. At least one field per item is required.
- `providers` (array, user input): Provider order. Cheapest-first is recommended (internal -> hunter -> clearbit -> peopledatalabs -> apollo).
- `maxBudgetUsd` (number, user input): Hard cap; the cascade stops before any attempt that would exceed this.
- `apiTokens` (object, user input): Bring-your-own tokens. Providers without a token are skipped with status skipped\_no\_token.

### Output dataset

Each successful upstream response is written to the default dataset.

- `input`: Original input value submitted to the upstream API.
- `result`: Full upstream API response.

### Developer notes

Set `B2B_WATERFALL_ENRICHMENT_API_KEY` as an Apify secret environment variable. The Actor forwards it as `X-API-Key` to the upstream API.
Use `apiBaseUrl` only for local or staging QA. Production runs default to the deployed API base URL from service.json.
For advanced testing, a `requests` array can call explicit API paths; normal users should use the service-specific fields above.

### Run locally

```bash
apify run
```

### Deploy

```bash
apify push
```

# Actor input Schema

## `lookups` (type: `array`):

Array of lookup records. Each item is { email?, domain?, companyName? }. At least one field per item is required.

## `providers` (type: `array`):

Provider order. Cheapest-first is recommended (internal -> hunter -> clearbit -> peopledatalabs -> apollo).

## `maxBudgetUsd` (type: `number`):

Hard cap; the cascade stops before any attempt that would exceed this.

## `apiTokens` (type: `object`):

Bring-your-own tokens. Providers without a token are skipped with status skipped\_no\_token.

## Actor input object example

```json
{
  "lookups": [
    {
      "email": "founder@linear.app"
    }
  ],
  "providers": [
    "internal",
    "hunter",
    "clearbit",
    "peopledatalabs",
    "apollo"
  ],
  "maxBudgetUsd": 1
}
```

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "lookups": [
        {
            "email": "founder@linear.app"
        }
    ],
    "providers": [
        "internal",
        "hunter",
        "clearbit",
        "peopledatalabs",
        "apollo"
    ],
    "maxBudgetUsd": 1
};

// Run the Actor and wait for it to finish
const run = await client.actor("josrade/b2b-waterfall-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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "lookups": [{ "email": "founder@linear.app" }],
    "providers": [
        "internal",
        "hunter",
        "clearbit",
        "peopledatalabs",
        "apollo",
    ],
    "maxBudgetUsd": 1,
}

# Run the Actor and wait for it to finish
run = client.actor("josrade/b2b-waterfall-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 '{
  "lookups": [
    {
      "email": "founder@linear.app"
    }
  ],
  "providers": [
    "internal",
    "hunter",
    "clearbit",
    "peopledatalabs",
    "apollo"
  ],
  "maxBudgetUsd": 1
}' |
apify call josrade/b2b-waterfall-enrichment --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=josrade/b2b-waterfall-enrichment",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "B2B Waterfall Enrichment",
        "description": "Multi-provider waterfall enrichment for company / email / domain. Tries providers in cheapest-first order, returns first match with attribution and a hard budget cap.",
        "version": "0.1",
        "x-build-id": "bMU5DWwvKdMK9sTUg"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/josrade~b2b-waterfall-enrichment/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-josrade-b2b-waterfall-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/josrade~b2b-waterfall-enrichment/runs": {
            "post": {
                "operationId": "runs-sync-josrade-b2b-waterfall-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/josrade~b2b-waterfall-enrichment/run-sync": {
            "post": {
                "operationId": "run-sync-josrade-b2b-waterfall-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",
                "required": [
                    "lookups",
                    "providers",
                    "maxBudgetUsd",
                    "apiTokens"
                ],
                "properties": {
                    "lookups": {
                        "title": "Lookups",
                        "minItems": 1,
                        "maxItems": 200,
                        "type": "array",
                        "description": "Array of lookup records. Each item is { email?, domain?, companyName? }. At least one field per item is required.",
                        "items": {
                            "type": "object"
                        }
                    },
                    "providers": {
                        "title": "Providers (in order)",
                        "type": "array",
                        "description": "Provider order. Cheapest-first is recommended (internal -> hunter -> clearbit -> peopledatalabs -> apollo).",
                        "items": {
                            "type": "string"
                        },
                        "default": [
                            "internal",
                            "hunter",
                            "clearbit",
                            "peopledatalabs",
                            "apollo"
                        ]
                    },
                    "maxBudgetUsd": {
                        "title": "Max budget per lookup (USD)",
                        "minimum": 0,
                        "type": "number",
                        "description": "Hard cap; the cascade stops before any attempt that would exceed this.",
                        "default": 1
                    },
                    "apiTokens": {
                        "title": "Provider API tokens",
                        "type": "object",
                        "description": "Bring-your-own tokens. Providers without a token are skipped with status skipped_no_token."
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```