Reference - Company Enrichment API

Reference information for the Company Enrichment API

PDL's company enrichment API is designed to provide a one to one company match. The company data provided by this endpoint includes all the fields in our Company Schema.

Endpoint

The endpoint for the Company Enrichment API is https://api.peopledatalabs.com/v5/company/enrich.

Company Enrichment API Access and Billing

When a matching company is returned, the HTTP response code will be 200, and when no matching company is found or returned, the HTTP response code will be a 404. We charge per match.

Requests

See Authentication and Requests to learn 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/min for testing purposes and 1000/min for paying customers.

Input Parameters

Data points on the queried company are added as key/value pairs to the query string of a request.

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 like website, ticker or profile are more likely to yield a match than a name.

📘

For more details, see Input Parameters - Company Enrichment API

You can also click on the individual parameter names in the table below to view more information as well.

Parameter NameDescriptionExample
nameThe company's name.Google, Inc.
profileThe company's social profile.linkedin.com/company/google
tickerThe company's stock ticker, if publicly traded.GOOGL
websiteThe company's website.google.com
locationThe complete or partial company location. You can input multiple location values.1600 Amphitheatre Pkwy, Mountain View, CA 94043
localityThe company's locality. You can only input one locality.mountainview
regionThe company's region. You can only input one region.california
countryThe company's country. You can only input one country.united states
street_addressThe company's address. You can only input one street address.1600 Amphitheatre Pkwy
postal_codeThe company's postal code. You can only input one postal code.94043
data_includeA comma-separated string of fields that you want the response to include. For example, "full_name,emails.address". Begin the string with a - if you want to exclude the specified fields. If you want to exclude all data from being returned, use data_include="".
prettyWhether the output should have human-readable indentation.false
api_keyYour API key. Note: You can also provide this in the request header instead, as shown on the Authentication page.

For our Company Enrichment API, we require a non-ambiguous match. This means that you must input a name OR ticker OR website OR profile.

Additional Input Parameters

These input parameters are not required but generally transform or control various aspects of the enrichment process (returning matches or formatting results):

Parameter NameDescriptionExample
titlecaseAll text in API responses returns as lowercase by default. Setting titlecase to true will titlecase the person data in 200 responses.false
include_if_matchedIf true, the response includes the top-level field matched (along with data, status and so forth), which includes a value for each queried field parameter that was matched during our internal query.false
min_likelihoodThe minimum likelihood score a response must have to return a 200.2
requiredSpecifies the fields and data points a response must have to return a 200.

Response

When an API request is executed, the queried data points are preprocessed and built into a query, which is then executed against our company dataset. Most profiles and websites map to a unique company. Company names are fuzzy matched 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 a 200 HTTP response code. If we do not find a match, we will return a 404 HTTP response code. If we cannot resolve to a unique company based on a name, we will also return a 404 response.

Response Fields

📘

For more details see Output Response - Company Enrichment API

You can also click the field names in the table below to view more information as well.

FieldDescriptionType
dataThe matched profile record containing fields from our Company Schema. Any fields in the profile record that do not contain any data will have a null value.Object
statusThe response code. See a description of our Error Codes.Integer
likelihood The degree of confidence is represented by the likelihood field in the API response. The likelihood field is an integer between 1 and 10 that represents how confident we are that the company returned is the same as the company requested. The minimum likelihood score a response must have in order to return a 200 can be controlled in the API request by using the min_likelihood parameter.Integer

Abridged Response Data Structure

Here is an example response from the Company Enrichment API:

{
    "status": 200,
    "id": "google",
    "name": "google",
     "founded": "1998",
     ...
}

Full Example Response

Full Output Response (click to expand)
{
  "status": 200,
  "name": "google",
  "size": "10001+",
  "employee_count": 260979,
  "id": "google",
  "founded": 1998,
  "industry": "internet",
  "location": {
    "name": "mountain view, california, united states",
    "locality": "mountain view",
    "region": "california",
    "metro": "san francisco, california",
    "country": "united states",
    "continent": "north america",
    "street_address": "1600 amphitheatre parkway",
    "address_line_2": null,
    "postal_code": "94043",
    "geo": null
  },
  "linkedin_id": "1441",
  "linkedin_url": "linkedin.com/company/google",
  "facebook_url": "facebook.com/google",
  "twitter_url": "twitter.com/google",
  "profiles": [
    "linkedin.com/company/google",
    "linkedin.com/company/1441",
    "facebook.com/google",
    "twitter.com/google",
    "crunchbase.com/organization/google"
  ],
  "website": "google.com",
  "ticker": "GOOGL",
  "type": "public",
  "summary": "google\u2019s mission is to organize the world\u2018s information and make it universally accessible and useful. since our founding in 1998, google has grown by leaps and bounds. from offering search in a single language we now offer dozens of products and services\u2014including various forms of advertising and web applications for all kinds of tasks\u2014in scores of languages. and starting from two computer science students in a university dorm room, we now have thousands of employees and offices around the world. a lot has changed since the first google search engine appeared. but some things haven\u2019t changed: our dedication to our users and our belief in the possibilities of the internet itself.",
  "tags": [
    "online video",
    "artificial intelligence",
    "mobile",
    "android",
    "cloud",
    "machine learning",
    "virtual reality",
    "apps",
    "software",
    "ads"
  ],
  "headline": null,
  "alternative_names": [
    "google inc.",
    "google, social marketing tools",
    "google, inc.",
    "google inc",
    "google, inc",
    "google summer of code",
    "google maps",
    "google ireland",
    "wildfire, a division of google",
    "wildfire interactive, inc."
  ],
  "alternative_domains": [
    "googlevideo.com",
    "google.nl",
    "google.pt",
    "gkecnapps.cn",
    "youtube.com",
    "youtu.be",
    "youtubeeducation.com",
    "gstatic.cn",
    "youtubekids.com",
    "googleadapis.com"
  ],
  "affiliated_profiles": [
    "youtube",
    "google-cloud",
    "think-with-google",
    "google-ads-",
    "googleworkspace",
    "google-analytics",
    "googlemarketingplatform",
    "google-ad-manager",
    "grow-with-google",
    "google-cloud-partners",
    "google-for-startups",
    "google-small-business",
    "x",
    "google-partners",
    "rework-with-google",
    "googleplaydev",
    "googleadmob",
    "google-user-research.",
    "google-news-initiative",
    "adometry"
  ],
  "likelihood": 4
}

Did this page help you?