Reference - Cleaner APIs
Reference information for the Cleaner APIs
We designed the Cleaner APIs to clean your company, school and location data so that you can better query our person data. We use these same cleaners for standardizing our data as part of our Data Build Process.
Endpoints
The endpoints for the Cleaner APIs are:
Company: https://api.peopledatalabs.com/v5/company/clean
Location: https://api.peopledatalabs.com/v5/location/clean
School: https://api.peopledatalabs.com/v5/school/clean
Billing and Access
The Cleaner APIs are public and we make them available by default to all customers.
Rate Limiting
The standard rate limit is 10 per minute, and we have a standard total limit of 10,000 per month that we provide free of charge. To increase your monthly limit above 10,000, reach out to your Data Consultant or Customer Success Manager.
Input Parameters
Each of the three Cleaner API endpoints supports a different set of input parameters, which we've described in the tables below:
For More Details, See Input Parameters - Cleaner APIs
You can also click on the individual parameter names in the table below to view more information on them.
Company Cleaner API (/company/clean)
/company/clean)| Parameter Name | Required | Description | Default | Example |
|---|---|---|---|---|
name | No (but see note below) | The name of the company that you want to identify. We accept unformatted strings with arbitrary capitalizations, leading and trailing whitespaces and so forth. | None | “People data LABS” |
website | No (but see note below) | The website of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth. | None | www.peopledatalabs.com |
profile | No (but see note below) | The social profile URL of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth. | None | ”https://linkedin.com/company/peopledatalabs” |
pretty | No | Whether the output should have human-readable indentation. | False | True |
api_key | No* | Your secret API key. While we do not require this as part of the request parameters, if you don't provide it here, then you must provide it in an alternative way, such as by using the x-api-key field in the headers. For more information, see the Authentication page. | None |
Note: Although the Company Cleaner API doesn't require any specific input fields, it requires at least one of the following identifying fields: name, website or profile.
Location Cleaner API (/location/clean)
/location/clean)| Parameter Name | Required | Description | Default | Example |
|---|---|---|---|---|
location | Yes | The name of the location that you want to identify. We accept unformatted locations with arbitrary capitalizations, leading and trailing whitespaces and so forth. | None | "san francisco" |
pretty | No | Whether the output should have human-readable indentation. | False | True |
api_key | No* | Your secret API key. While we do not require this as part of the request parameters, if you don't provide it here, then you must provide it in an alternative way, such as by using the x-api-key field in the headers. For more information, see the Authentication page. | None |
School Cleaner API (/school/clean)
/school/clean)| Parameter Name | Required | Description | Default | Example |
|---|---|---|---|---|
name | No (but see note below) | The name of the company that you want to identify. We accept unformatted strings with arbitrary capitalizations, leading and trailing whitespaces and so forth. | None | “People data LABS” |
website | No (but see note below) | The website of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth. | None | www.peopledatalabs.com |
profile | No (but see note below) | The social profile URL of the company that you want to identify. We accept unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces and so forth. | None | ”https://linkedin.com/company/peopledatalabs” |
pretty | No | Whether the output should have human-readable indentation. | False | True |
api_key | No* | Your secret API key. While we do not require this as part of the request parameters, if you don't provide it here, then you must provide it in an alternative way, such as by using the x-api-key field in the headers. For more information, see the Authentication page. | None |
Note: Although the School Cleaner API doesn't require any specific input fields, it requires at least one of the following identifying fields: name, website or profile.
Output Responses
Each of the three Cleaner API endpoints returns a different response, as shown below:
For More Details, see Output Response - Cleaner APIs
Company Cleaner API (/company/clean)
/company/clean)Here is an example response from the Company Cleaner API:
{
"name": "people data labs",
"size": "11-50",
"id": "peopledatalabs",
"founded": 2015,
"industry": "computer software",
"location": {
"name": "san francisco, california, united states",
"locality": "san francisco",
"region": "california",
"metro": "san francisco, california",
"country": "united states",
"continent": "north america",
"street_address": "455 market street",
"address_line_2": "suite 1670",
"postal_code": "94105",
"geo": "37.77,-122.41"
},
"linkedin_url": "linkedin.com/company/peopledatalabs",
"linkedin_id": "18170482",
"facebook_url": "facebook.com/peopledatalabs",
"twitter_url": "twitter.com/peopledatalabs",
"website": "peopledatalabs.com",
"ticker": null,
"type": "private",
"raw": [],
"score": 3.0,
"fuzzy_match": false
}
Location Cleaner API (/location/clean)
/location/clean)Here is an example response from the Location Cleaner API:
{
"name": "portland, oregon, united states",
"locality": "portland",
"region": "oregon",
"subregion": "multnomah county",
"country": "united states",
"continent": "north america",
"type": "locality",
"geo": "45.52,-122.67",
}
School Cleaner API (/school/clean)
/school/clean)Here is an example response from the School Cleaner API:
{
"name": "university of california, los angeles",
"type": "post-secondary institution",
"id": "72978d72-275a-49c8-b9b9-f227ccfb1361",
"location": {
"name": "los angeles, california, united states",
"locality": "los angeles",
"region": "california",
"country": "united states",
"continent": "north america"
},
"linkedin_url": "linkedin.com/school/ucla",
"facebook_url": null,
"twitter_url": null,
"linkedin_id": "17950",
"website": "ucla.edu",
"domain": "ucla.edu"
}
Updated 4 months ago