Endpoint
The endpoint for the Company Enrichment API ishttps://api.peopledatalabs.com/v5/company/enrich.
Company Enrichment API Access and Billing
When the API finds a matching company, it returns this company along with an HTTP response code of200. When it doesn’t find a matching company, it returns an HTTP response code of 404. We charge per match.
Requests
See Authentication and Requests for how to input requests. We recommend using a JSON object to capture request parameters and will do so in the examples.Rate Limiting
The standard rate limit is 10 per minute for free customers and 1,000 per minute for paying customers.Input Parameters
When querying the API in URL, you can add data points to a queried company as key/value pairs at the end of av5 request string.
You can use the following parameters to specify information about the requested company. Adding more data points to a request increases the probability of a 200 response and increases the likelihood score. Adding unique parameters such as website, ticker or profile are more likely to yield a match than a name.
| Parameter Name | Description | Example |
|---|---|---|
The PDL ID for a record in our Company Dataset. Note: If you enrich on ID and anything else, only ID is used and the other inputs for matching are ignored. |
| |
The company’s name. |
| |
The company’s social profile. |
| |
The company’s stock ticker, if publicly traded. |
| |
The company’s website. |
| |
The complete or partial company location. You can input multiple location values. |
| |
The company’s locality. You can only input one locality. |
| |
The company’s region. You can only input one region. |
| |
The company’s country. You can only input one country. |
| |
The company’s street address. You can only input one street address. |
| |
The company’s postal code. You can only input one postal code. |
| |
Your secret API key. Note: You can also provide this in the request header instead, as shown on the Authentication page. |
name OR ticker OR website OR profile.
Additional Input Parameters
You are not required to use the following additional input parameters. They generally transform or control various aspects of the enrichment process (returning matches or formatting results.)| Parameter Name | Description | Default | Example |
|---|---|---|---|
All text in API responses returns as lowercase by default. Setting titlecase to |
|
| |
Whether the output should have human-readable indentation. |
|
| |
If |
|
| |
The minimum |
|
| |
The fields a response must have to return a |
| ||
A comma-separated string of fields that you want the response to include. Begin the string with a |
|
Output Response
When you execute an API request, we preprocess the queried data points and build them into a query, which we then execute against our Company Dataset. Most profiles and websites map to a unique company. We fuzzy-match company names based on name appearance relative to different unique company profiles. The company name that appears most frequently in our data is the one that is most likely to be the company returned in a200 HTTP response code. If we do not find a match or cannot resolve the query to a unique company based on a name, we will return a 404 HTTP response code.
