Turn local businesses into leads
curl --request POST \
--url https://api.instantly.ai/api/v2/local-business-search/convert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"query": "<string>",
"categories": [
"dentist"
],
"location": {
"label": "Austin, TX",
"country": "US",
"state": "TX",
"city": "Austin",
"lat": 30.2672,
"long": -97.7431,
"radius_km": 10
},
"keywords": [
"<string>"
],
"name": "<string>",
"min_rating": 123,
"max_rating": 123,
"min_reviews": 123,
"max_reviews": 123,
"min_locations": 123,
"max_locations": 123,
"exclude_keywords": [
"<string>"
],
"opened_within_months": 123,
"updated_within_months": 123
},
"count": 500000,
"idempotency_key": "<string>"
}
'import requests
url = "https://api.instantly.ai/api/v2/local-business-search/convert"
payload = {
"filters": {
"query": "<string>",
"categories": ["dentist"],
"location": {
"label": "Austin, TX",
"country": "US",
"state": "TX",
"city": "Austin",
"lat": 30.2672,
"long": -97.7431,
"radius_km": 10
},
"keywords": ["<string>"],
"name": "<string>",
"min_rating": 123,
"max_rating": 123,
"min_reviews": 123,
"max_reviews": 123,
"min_locations": 123,
"max_locations": 123,
"exclude_keywords": ["<string>"],
"opened_within_months": 123,
"updated_within_months": 123
},
"count": 500000,
"idempotency_key": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
query: '<string>',
categories: ['dentist'],
location: {
label: 'Austin, TX',
country: 'US',
state: 'TX',
city: 'Austin',
lat: 30.2672,
long: -97.7431,
radius_km: 10
},
keywords: ['<string>'],
name: '<string>',
min_rating: 123,
max_rating: 123,
min_reviews: 123,
max_reviews: 123,
min_locations: 123,
max_locations: 123,
exclude_keywords: ['<string>'],
opened_within_months: 123,
updated_within_months: 123
},
count: 500000,
idempotency_key: '<string>'
})
};
fetch('https://api.instantly.ai/api/v2/local-business-search/convert', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.instantly.ai/api/v2/local-business-search/convert")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"query\": \"<string>\",\n \"categories\": [\n \"dentist\"\n ],\n \"location\": {\n \"label\": \"Austin, TX\",\n \"country\": \"US\",\n \"state\": \"TX\",\n \"city\": \"Austin\",\n \"lat\": 30.2672,\n \"long\": -97.7431,\n \"radius_km\": 10\n },\n \"keywords\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"min_rating\": 123,\n \"max_rating\": 123,\n \"min_reviews\": 123,\n \"max_reviews\": 123,\n \"min_locations\": 123,\n \"max_locations\": 123,\n \"exclude_keywords\": [\n \"<string>\"\n ],\n \"opened_within_months\": 123,\n \"updated_within_months\": 123\n },\n \"count\": 500000,\n \"idempotency_key\": \"<string>\"\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.instantly.ai/api/v2/local-business-search/convert",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'query' => '<string>',
'categories' => [
'dentist'
],
'location' => [
'label' => 'Austin, TX',
'country' => 'US',
'state' => 'TX',
'city' => 'Austin',
'lat' => 30.2672,
'long' => -97.7431,
'radius_km' => 10
],
'keywords' => [
'<string>'
],
'name' => '<string>',
'min_rating' => 123,
'max_rating' => 123,
'min_reviews' => 123,
'max_reviews' => 123,
'min_locations' => 123,
'max_locations' => 123,
'exclude_keywords' => [
'<string>'
],
'opened_within_months' => 123,
'updated_within_months' => 123
],
'count' => 500000,
'idempotency_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.instantly.ai/api/v2/local-business-search/convert"
payload := strings.NewReader("{\n \"filters\": {\n \"query\": \"<string>\",\n \"categories\": [\n \"dentist\"\n ],\n \"location\": {\n \"label\": \"Austin, TX\",\n \"country\": \"US\",\n \"state\": \"TX\",\n \"city\": \"Austin\",\n \"lat\": 30.2672,\n \"long\": -97.7431,\n \"radius_km\": 10\n },\n \"keywords\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"min_rating\": 123,\n \"max_rating\": 123,\n \"min_reviews\": 123,\n \"max_reviews\": 123,\n \"min_locations\": 123,\n \"max_locations\": 123,\n \"exclude_keywords\": [\n \"<string>\"\n ],\n \"opened_within_months\": 123,\n \"updated_within_months\": 123\n },\n \"count\": 500000,\n \"idempotency_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"job": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"requested": 123,
"scanned": 123,
"created": 123,
"lookup_pending": 123,
"verify_pending": 123,
"verifying_count": 123,
"credits_spent": 123,
"list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": 123,
"error_code": "<string>",
"pool_exhausted": true
}
}{
"job": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"requested": 123,
"scanned": 123,
"created": 123,
"lookup_pending": 123,
"verify_pending": 123,
"verifying_count": 123,
"credits_spent": 123,
"list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": 123,
"error_code": "<string>",
"pool_exhausted": true
}
}{
"statusCode": 400,
"error": "Bad Request",
"message": "body must have required property 'name'",
"code": "FST_ERR_VALIDATION"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Missing Authorization header"
}{
"statusCode": 402,
"error": "Insufficient credits",
"message": "Insufficient credits",
"creditsRequired": 2,
"creditsAvailable": 0
}{}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found"
}{
"statusCode": 429,
"error": "local_business_search_daily_limit",
"message": "local_business_search_daily_limit",
"code": "local_business_search_daily_limit"
}Local Business
Turn local businesses into leads
Starts converting the businesses matching filters into up to count leads, each with a verified email, in one lead list or one campaign. Runs in the background: read its progress with GET /local-business-search/convert/{id}. Costs 2 credits per lead created; businesses without an email cost nothing, and a workspace may scan up to 20000 of them a day (429 local_business_convert_daily_limit). Answers 402 when the balance cannot pay for one lead. A request repeated with the same idempotency_key returns the same conversion. campaign_name also needs the campaigns:create scope.
Requires one of the following scopes: supersearch_enrichments:create, supersearch_enrichments:all, all:create, all:all
POST
/
api
/
v2
/
local-business-search
/
convert
Turn local businesses into leads
curl --request POST \
--url https://api.instantly.ai/api/v2/local-business-search/convert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"query": "<string>",
"categories": [
"dentist"
],
"location": {
"label": "Austin, TX",
"country": "US",
"state": "TX",
"city": "Austin",
"lat": 30.2672,
"long": -97.7431,
"radius_km": 10
},
"keywords": [
"<string>"
],
"name": "<string>",
"min_rating": 123,
"max_rating": 123,
"min_reviews": 123,
"max_reviews": 123,
"min_locations": 123,
"max_locations": 123,
"exclude_keywords": [
"<string>"
],
"opened_within_months": 123,
"updated_within_months": 123
},
"count": 500000,
"idempotency_key": "<string>"
}
'import requests
url = "https://api.instantly.ai/api/v2/local-business-search/convert"
payload = {
"filters": {
"query": "<string>",
"categories": ["dentist"],
"location": {
"label": "Austin, TX",
"country": "US",
"state": "TX",
"city": "Austin",
"lat": 30.2672,
"long": -97.7431,
"radius_km": 10
},
"keywords": ["<string>"],
"name": "<string>",
"min_rating": 123,
"max_rating": 123,
"min_reviews": 123,
"max_reviews": 123,
"min_locations": 123,
"max_locations": 123,
"exclude_keywords": ["<string>"],
"opened_within_months": 123,
"updated_within_months": 123
},
"count": 500000,
"idempotency_key": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
query: '<string>',
categories: ['dentist'],
location: {
label: 'Austin, TX',
country: 'US',
state: 'TX',
city: 'Austin',
lat: 30.2672,
long: -97.7431,
radius_km: 10
},
keywords: ['<string>'],
name: '<string>',
min_rating: 123,
max_rating: 123,
min_reviews: 123,
max_reviews: 123,
min_locations: 123,
max_locations: 123,
exclude_keywords: ['<string>'],
opened_within_months: 123,
updated_within_months: 123
},
count: 500000,
idempotency_key: '<string>'
})
};
fetch('https://api.instantly.ai/api/v2/local-business-search/convert', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.instantly.ai/api/v2/local-business-search/convert")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"query\": \"<string>\",\n \"categories\": [\n \"dentist\"\n ],\n \"location\": {\n \"label\": \"Austin, TX\",\n \"country\": \"US\",\n \"state\": \"TX\",\n \"city\": \"Austin\",\n \"lat\": 30.2672,\n \"long\": -97.7431,\n \"radius_km\": 10\n },\n \"keywords\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"min_rating\": 123,\n \"max_rating\": 123,\n \"min_reviews\": 123,\n \"max_reviews\": 123,\n \"min_locations\": 123,\n \"max_locations\": 123,\n \"exclude_keywords\": [\n \"<string>\"\n ],\n \"opened_within_months\": 123,\n \"updated_within_months\": 123\n },\n \"count\": 500000,\n \"idempotency_key\": \"<string>\"\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.instantly.ai/api/v2/local-business-search/convert",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'query' => '<string>',
'categories' => [
'dentist'
],
'location' => [
'label' => 'Austin, TX',
'country' => 'US',
'state' => 'TX',
'city' => 'Austin',
'lat' => 30.2672,
'long' => -97.7431,
'radius_km' => 10
],
'keywords' => [
'<string>'
],
'name' => '<string>',
'min_rating' => 123,
'max_rating' => 123,
'min_reviews' => 123,
'max_reviews' => 123,
'min_locations' => 123,
'max_locations' => 123,
'exclude_keywords' => [
'<string>'
],
'opened_within_months' => 123,
'updated_within_months' => 123
],
'count' => 500000,
'idempotency_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.instantly.ai/api/v2/local-business-search/convert"
payload := strings.NewReader("{\n \"filters\": {\n \"query\": \"<string>\",\n \"categories\": [\n \"dentist\"\n ],\n \"location\": {\n \"label\": \"Austin, TX\",\n \"country\": \"US\",\n \"state\": \"TX\",\n \"city\": \"Austin\",\n \"lat\": 30.2672,\n \"long\": -97.7431,\n \"radius_km\": 10\n },\n \"keywords\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"min_rating\": 123,\n \"max_rating\": 123,\n \"min_reviews\": 123,\n \"max_reviews\": 123,\n \"min_locations\": 123,\n \"max_locations\": 123,\n \"exclude_keywords\": [\n \"<string>\"\n ],\n \"opened_within_months\": 123,\n \"updated_within_months\": 123\n },\n \"count\": 500000,\n \"idempotency_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"job": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"requested": 123,
"scanned": 123,
"created": 123,
"lookup_pending": 123,
"verify_pending": 123,
"verifying_count": 123,
"credits_spent": 123,
"list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": 123,
"error_code": "<string>",
"pool_exhausted": true
}
}{
"job": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"requested": 123,
"scanned": 123,
"created": 123,
"lookup_pending": 123,
"verify_pending": 123,
"verifying_count": 123,
"credits_spent": 123,
"list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": 123,
"error_code": "<string>",
"pool_exhausted": true
}
}{
"statusCode": 400,
"error": "Bad Request",
"message": "body must have required property 'name'",
"code": "FST_ERR_VALIDATION"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "Missing Authorization header"
}{
"statusCode": 402,
"error": "Insufficient credits",
"message": "Insufficient credits",
"creditsRequired": 2,
"creditsAvailable": 0
}{}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found"
}{
"statusCode": 429,
"error": "local_business_search_daily_limit",
"message": "local_business_search_daily_limit",
"code": "local_business_search_daily_limit"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
A search needs a category, a query or a name, and a location (a city, a state, or lat/long).
Show child attributes
Show child attributes
Required range:
1 <= x <= 1000000Required string length:
8 - 80Creates a draft campaign with this name and the default schedule, and adds the leads to it.
Required string length:
1 - 255Required string length:
1 - 255Response
Default Response
Show child attributes
Show child attributes