Quick Start

In order to use our Person Search API, you must have an active API key. You can look up your API key by logging into our Rapid API hub and subscribing to the personsearch API.

Need an API Key?

If you don't have an API key, you can easily create one by signing up. For more information, check out our Quickstart Guide, which walks you through the sign-up process as well as shows you how to use the self-serve API dashboard.

Get API Key

Simple Example

As mentioned in the Overview, the Person Search API is a means of filtering and segmenting individual profiles included in our Person Dataset. In order to use the Person Search API, you will need to use either an get query.

Here's a quick example to search for profiles whose location_country is liverpool (united kingdom), whose positions are either, director or chief exec and whose records must include work (public) email addresses:

Heads Up! Credit Usage

Person Search API calls cost the number of total search results returned.

If you are making a search that could have a large number of results, make sure to use the size parameter to set the maximum number of results and cap your credit usage.

/personsearch?emailTypeId=1&positionList=director|chief exec&locationList=Liverpool:United Kingdom

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Get,
	RequestUri = new Uri("https://leadhootz2.p.rapidapi.com/api/personsearch?locationList=%5BLiverpool%3AUnited%20Kingdom%5D&amp;take=2"),
	Headers =
	{
		{ "X-RapidAPI-Key", "YOUR API KEY HERE" },
		{ "X-RapidAPI-Host", "leadhootz2.p.rapidapi.com" },
	},
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('GET', 'https://leadhootz2.p.rapidapi.com/api/personsearch?locationList=%5BLiverpool%3AUnited%20Kingdom%5D&take=2');
xhr.setRequestHeader('X-RapidAPI-Key', 'YOUR API KEY HERE');
xhr.setRequestHeader('X-RapidAPI-Host', 'leadhootz2.p.rapidapi.com');

xhr.send(data);

GET /api/personsearch?locationList=%5BLiverpool%3AUnited%20Kingdom%5D&take=2 HTTP/1.1
X-Rapidapi-Key: YOUR API KEY HERE
X-Rapidapi-Host: leadhootz2.p.rapidapi.com
Host: leadhootz2.p.rapidapi.com

AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "https://leadhootz2.p.rapidapi.com/api/personsearch?locationList=%5BLiverpool%3AUnited%20Kingdom%5D&take=2")
	.setHeader("X-RapidAPI-Key", "YOUR API KEY HERE")
	.setHeader("X-RapidAPI-Host", "leadhootz2.p.rapidapi.com")
	.execute()
	.toCompletableFuture()
	.thenAccept(System.out::println)
	.join();

client.close();

<?php

$curl = curl_init();

curl_setopt_array($curl, [
	CURLOPT_URL => "https://leadhootz2.p.rapidapi.com/api/personsearch?locationList=%5BLiverpool%3AUnited%20Kingdom%5D&take=2",
	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-RapidAPI-Host: leadhootz2.p.rapidapi.com",
		"X-RapidAPI-Key: YOUR API KEY"
	],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

import requests

url = "https://leadhootz2.p.rapidapi.com/api/personsearch"

querystring = {"locationList":"[Liverpool:United Kingdom]","take":"2"}

headers = {
	"X-RapidAPI-Key": "YOUR API KEY HERE",
	"X-RapidAPI-Host": "leadhootz2.p.rapidapi.com"
}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())

The returned API response is a list of the records in our dataset that match the request query in the format:

[
    {
        "title": "Mr",
        "name": "John",
        "surname": "Covert",
        "domain": null,
        "email": "[email protected]",
        "linkedIn": "johncovert",
        "twitter": null,
        "industryId": 73,
        "industries": null,
        "pastCompany": "Sterne, Kessler, Goldstein & Fox",
        "school": null,
        "profileLanguage": null,
        "serviceCategories": null,
        "locality": "Washington, District Of Columbia, United States",
        "cityId": 82449,
        "cities": {
            "name": "Washington",
            "countryId": 239,
            "countries": null,
            "regionId": 314,
            "regions": null,
            "id": 82449,
            "createdAt": "2022-11-12T02:21:01.3609847"
        },
        "street": "1100 new york avenue northwest",
        "countryId": 239,
        "position": "Director",
        "gender": "male",
        "birthDate": null,
        "experience": "Patent Examiner, Director, Biotech And Chemical Practice Group Leader, Director",
        "workEmail": "[email protected]",
        "facebookId": "1549484302",
        "facebookUsername": "john.covert.33",
        "inferredSalary": "150,000-250,000",
        "inferredYearsExperience": 32,
        "locationGeo": "38.89,-77.03",
        "language": "[]",
        "phone": "+17037952546",
        "mobile": null,
        "summary": "I am a director and co-chair of Sterne Kessler’s Biotechnology & Chemical Practice Group.",
        "skills": "Patents, Patent Prosecution, Intellectual Property, Due Diligence.
        "linkedInConnections": 915,
        "dataSourceType": 4,
        "whenUpdated": "2023-03-02T22:13:23.8033333",
        "companyId": 792519,
        "positionId": 10576,
        "id": 23768484,
        "createdAt": "2021-08-15T08:35:46.349448"
    }
]

The objects in the data array will follow the Person Schema. For a full example, see the Example Person Record.

Troubleshooting

If you don't get this response, check out our Errors page for more information.

Quick Start

Simple Example

Troubleshooting

Download Template

Generate your order