Prospector Finder
curl --request GET \
--url https://api.waterfall.io/v1/prospector \
--header 'x-api-key: <api-key>'import requests
url = "https://api.waterfall.io/v1/prospector"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.waterfall.io/v1/prospector', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.waterfall.io/v1/prospector",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.waterfall.io/v1/prospector"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.waterfall.io/v1/prospector")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.waterfall.io/v1/prospector")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "SUCCEEDED",
"start_date": "2024-06-18T13:53:21.181000+00:00",
"stop_date": "2024-06-18T13:53:26.014000+00:00",
"input": {
"task": {
"domain": "acme.com",
"limit": 10,
"custom_fields": {},
"job_id": "413b35ce-572e-4d3a-bff6-e52d4542361d",
"context_id": "413b35ce-572e-4d3a-bff6-e52d4542361d"
}
},
"output": {
"company": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"domain": "acme.com",
"company_name": "Acme Corp",
"website": "https://www.acme.com/",
"linkedin_id": "acme-corp",
"linkedin_url": "https://www.linkedin.com/company/acme-corp/",
"linkedin_description": "Acme Corp builds enterprise software solutions for mid-market and large companies.",
"linkedin_logo_url": "https://media.licdn.com/dms/image/example/company-logo_200_200/logo.png",
"size": "501-1000",
"linkedin_size": "501-1000 employees",
"linkedin_industry": "Software Development",
"linkedin_type": "Privately Held",
"linkedin_followers": 12500,
"linkedin_founded": 2010,
"linkedin_employees_count": 823,
"linkedin_address": "San Francisco, California, United States",
"country": "United States",
"generic_emails": []
},
"persons": [
{
"id": "e70fc5a3-55d9-43e5-93ea-b9e8210435da",
"first_name": "Jane",
"last_name": "Doe",
"linkedin_id": "jane-doe-abc123",
"linkedin_url": "https://www.linkedin.com/in/jane-doe-abc123/",
"location": "San Francisco, California, United States",
"country": "United States",
"company_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"company_linkedin_id": "acme-corp",
"company_name": "Acme Corp",
"company_domain": "acme.com",
"professional_email": "jane.doe@acme.com",
"phone_numbers": [],
"title": "Head of Sales",
"seniority": "Director",
"department": "Sales",
"experiences": [
{
"title": "Head of Sales",
"company_name": "Acme Corp",
"company_linkedin_id": "acme-corp",
"company_linkedin_url": "https://www.linkedin.com/company/acme-corp/",
"company_domain": "acme.com",
"start_year": 2021,
"start_month": 3,
"is_current": true
}
],
"email_verified": true,
"email_confidence": "high",
"email_verified_status": "safe",
"smtp_provider": "Google",
"mx_record": "aspmx.l.google.com"
}
],
"usage": {
"total_usd": 0.1,
"balance_remaining_usd": 99.9,
"persons_count": 1,
"persons_usd": 0.1,
"phones_count": 0,
"phones_usd": 0,
"companies_count": 0,
"companies_usd": 0
}
}
}
Prospector
Prospector Finder
Retrieve Prospector job status, company data, and contacts by job_id.
GET
/
v1
/
prospector
Prospector Finder
curl --request GET \
--url https://api.waterfall.io/v1/prospector \
--header 'x-api-key: <api-key>'import requests
url = "https://api.waterfall.io/v1/prospector"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.waterfall.io/v1/prospector', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.waterfall.io/v1/prospector",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.waterfall.io/v1/prospector"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.waterfall.io/v1/prospector")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.waterfall.io/v1/prospector")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "SUCCEEDED",
"start_date": "2024-06-18T13:53:21.181000+00:00",
"stop_date": "2024-06-18T13:53:26.014000+00:00",
"input": {
"task": {
"domain": "acme.com",
"limit": 10,
"custom_fields": {},
"job_id": "413b35ce-572e-4d3a-bff6-e52d4542361d",
"context_id": "413b35ce-572e-4d3a-bff6-e52d4542361d"
}
},
"output": {
"company": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"domain": "acme.com",
"company_name": "Acme Corp",
"website": "https://www.acme.com/",
"linkedin_id": "acme-corp",
"linkedin_url": "https://www.linkedin.com/company/acme-corp/",
"linkedin_description": "Acme Corp builds enterprise software solutions for mid-market and large companies.",
"linkedin_logo_url": "https://media.licdn.com/dms/image/example/company-logo_200_200/logo.png",
"size": "501-1000",
"linkedin_size": "501-1000 employees",
"linkedin_industry": "Software Development",
"linkedin_type": "Privately Held",
"linkedin_followers": 12500,
"linkedin_founded": 2010,
"linkedin_employees_count": 823,
"linkedin_address": "San Francisco, California, United States",
"country": "United States",
"generic_emails": []
},
"persons": [
{
"id": "e70fc5a3-55d9-43e5-93ea-b9e8210435da",
"first_name": "Jane",
"last_name": "Doe",
"linkedin_id": "jane-doe-abc123",
"linkedin_url": "https://www.linkedin.com/in/jane-doe-abc123/",
"location": "San Francisco, California, United States",
"country": "United States",
"company_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"company_linkedin_id": "acme-corp",
"company_name": "Acme Corp",
"company_domain": "acme.com",
"professional_email": "jane.doe@acme.com",
"phone_numbers": [],
"title": "Head of Sales",
"seniority": "Director",
"department": "Sales",
"experiences": [
{
"title": "Head of Sales",
"company_name": "Acme Corp",
"company_linkedin_id": "acme-corp",
"company_linkedin_url": "https://www.linkedin.com/company/acme-corp/",
"company_domain": "acme.com",
"start_year": 2021,
"start_month": 3,
"is_current": true
}
],
"email_verified": true,
"email_confidence": "high",
"email_verified_status": "safe",
"smtp_provider": "Google",
"mx_record": "aspmx.l.google.com"
}
],
"usage": {
"total_usd": 0.1,
"balance_remaining_usd": 99.9,
"persons_count": 1,
"persons_usd": 0.1,
"phones_count": 0,
"phones_usd": 0,
"companies_count": 0,
"companies_usd": 0
}
}
}
Use the
job_id returned by Prospector Launcher to fetch state and results.Polling vs webhook
If you passedwebhook_url when launching the job, you don’t need to call this endpoint at all — Waterfall will automatically POST the result to your URL as soon as the job is ready.
If you didn’t use a webhook, poll this endpoint until status is SUCCEEDED:
GET /v1/prospector?job_id={job_id}
Use short exponential backoff — start with a 5s delay, then 10s, then 20s.
Job states
| Status | Meaning |
|---|---|
RUNNING | Job is still processing. Continue polling. |
SUCCEEDED | Job is complete. Results are in output. |
What you get
Theoutput object contains two keys:
| Field | Description |
|---|---|
output.company | Company profile for the target domain — name, LinkedIn, size, website |
output.persons | Array of contacts found. Each person uses the standard Person object with full fields: email, title, location, seniority, experiences, and more |
limit parameter set at launch (default 10, max 500).Authorizations
To access the API, provide your API key in x-api-key.
Query Parameters
The unique job_id you want to query. This value is returned by the corresponding launcher endpoint.
A UUID.
Example:
"7d44db58-5de3-4e92-a2fb-8325d12c2e8b"
Response
Prospector job state, input, and any available output data.
Finder response with prospector job status, input, and optional output.
The status of the job.
Available options:
RUNNING, SUCCEEDED, FAILED, TIMED_OUT, ABORTED Example:
"RUNNING"
A date time in ISO 8601 format.
Example:
"2025-02-05T15:46:35.771751+00:00"
Show child attributes
Show child attributes
A date time in ISO 8601 format.
Example:
"2025-02-05T15:46:35.771751+00:00"
Show child attributes
Show child attributes
⌘I