Reference - Cleaner APIs

Reference information for the Cleaner APIs

PDL's cleaner APIs are designed to clean your company/school/location data so you can better query our person data. We use these cleaners for standardizing our data as part of our Data Build Process.

Endpoints

The endpoints for the 3 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 freely available by default to all customers.

Rate Limiting

The standard rate limit is 10/min, and we have a standard total limit of 10,000/month—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 are 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 as well.

Company Cleaner API (/company/clean)

Parameter Name

Required

Description

Default

Example

name

No (but see note below)

The name of the company that you want to identify. Unformatted strings with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

None

“People data LABS”

website

No (but see note below)

The website of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

None

www.peopledatalabs.com

profile

No (but see note below)

The social profile URL of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

None

”https://linkedin.com/company/peopledatalabs”

pretty

No

Whether the output should have human-readable indentation.

False

True

api_key

No

Not required as part of the request parameters, but if it is not provided here, then it must be provided in the headers using the x-api-key field. For more information, see the Authentication page.

None

Note: Although no input fields are strictly required, the Company Cleaner API requires at least one of the identifying fields: name, website or profile.

Location Cleaner API (/location/clean)

Parameter Name

Required

Description

Default

Example

location

Yes

The name of the location that you want to identify. Unformatted locations with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

None

"san francisco"

pretty

No

Whether the output should have human-readable indentation.

False

True

api_key

No

Not required as part of the request parameters, but if it is not provided here, then it must be provided in the headers using the x-api-key field. For more information, see the Authentication page.

None

School Cleaner API (/school/clean)

Parameter Name

Required

Description

Default

Example

name

No (but see note below)

The name of the company that you want to identify. Unformatted strings with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

None

“People data LABS”

website

No (but see note below)

The website of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

None

www.peopledatalabs.com

profile

No (but see note below)

The social profile URL of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

None

”https://linkedin.com/company/peopledatalabs”

pretty

No

Whether the output should have human-readable indentation.

False

True

api_key

No

Not required as part of the request parameters, but if it is not provided here, then it must be provided in the headers using the x-api-key field. For more information, see the Authentication page.

None

Note: Although no input fields are strictly required, the School Cleaner API requires at least one of the identifying fields: name, website or profile.

Responses

Each of the three Cleaner API endpoints returns a different response, which are described below:

📘

For more details see Output Response - Cleaner APIs

Company Cleaner API (/company/clean)

Here is an example response from the Company 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"
}

Location Cleaner API (/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)

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"
}

Did this page help you?