Input Parameters - Company Enrichment API

Detailed information on the input parameters used for the Company Enrichment API

Optional Parameters

While all parameters are optional, we require a non-ambiguous match. This means that you must input a name OR ticker OR website OR profile.

name

Parameter Name

Required

Description

Example

name

No

The company's name.

Google, Inc.

profile

Parameter Name

Required

Description

Example

profile

No

The company's social profile.

linkedin.com/company/google

ticker

Parameter Name

Required

Description

Example

ticker

No

The company's stock ticker, if publicly traded.

GOOGL

website

Parameter Name

Required

Description

Example

website

No

The company's website.

google.com

location

Parameter Name

Required

Description

Example

location

No

The complete or partial company location. You can input multiple location values.

1600 Amphitheatre Pkwy, Mountain View, CA 94043

street_address

Parameter Name

Required

Description

Example

street_address

No

The company's address. You can only input one street address.

1600 Amphitheatre Pkwy

locality

Parameter Name

Required

Description

Example

locality

No

The company's locality. You can only input one locality.

Mountain View

region

Parameter Name

Required

Description

Example

region

No

The company's region. You can only input one region.

California

country

Parameter Name

Required

Description

Example

country

No

The company's country. You can only input one country.

United States

postal_code

Parameter Name

Required

Description

Example

postal_code

No

The company's postal code. You can only input one postal code.

83701

data_include

Parameter Name

Required

Description

Example

data_include

No

A 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="".

pretty

Parameter Name

Required

Description

Example

pretty

No

Whether the output should have human-readable indentation.

false

api_key

Parameter Name

Required

Description

Example

api_key

No

Your API key.

Note: You can also provide this in the request header instead, as shown on the Authentication page.

Additional Parameters

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

titlecase

Parameter Name

Required

Description

Example

titlecase

No

All text in API responses returns as lowercase by default. Setting titlecase to true will titlecase the company data in 200 responses.

false

include_if_matched

Parameter Name

Required

Description

Example

include_if_matched

No

If 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_likelihood

Parameter Name

Required

Description

Example

min_likelihood

No

The minimum likelihood score a response must have to return a 200.

2

This parameter allows you to balance precision and recall. In other words, using a high min_likelihood value will only return very strong matches but at the risk of not returning any match at all if none can be found above the min_likelihood threshold. Alternatively, using a low min_likelihood value is more likely to give you a match but at the cost of returning a potentially weaker match.

Some general rules of thumb for setting this parameter are as follows:

  • For use cases which rely on a high degree of data accuracy, use a value of ≥ 6.
  • Requests made with only a few less-specific data points, such as a name alone, will return lower scores.
  • Requests made with just a name return a score between 2 and 5, based on the quality of the match.

Example

import requests

url = "https://api.peopledatalabs.com/v5/company/enrich"

querystring = {
                "website":"google.com",
                "min_likelihood": 5
              }

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'x-api-key': "YOUR_API_KEY"
    }

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
curl -X GET -G \
  'https://api.peopledatalabs.com/v5/company/enrich'\
  -H 'X-Api-Key: xxxx'\
  --data-urlencode 'website=google.com'
  --data-urlencode 'min_likelihood=5'
// See https://github.com/peopledatalabs/peopledatalabs-js
import PDLJS from 'peopledatalabs';

const PDLJSClient = new PDLJS({ apiKey: "YOUR API KEY" });

const queryString = {
                        "website":"google.com",
                        "min_likelihood": 5
                    }

PDLJSClient.company.enrichment(queryString).then((data) => {
    console.log(data);
}).catch((error) => {
    console.log(error);
});

required

Parameter Name

Required

Description

Example

required

No

Specifies the fields and data points a response must have to return a 200.

This parameter ensures that you only get charged for responses that include the data fields that you're interested in. You can use any top-level company fields except those that you use as search parameters and input fields. If you include a field in both the request and the required parameter, the required parameter will not work. The value is formatted as a boolean statements.

Example

import requests

url = "https://api.peopledatalabs.com/v5/company/enrich"

querystring = {
                "website":"google.com",
                "required": "size"
              }

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'x-api-key': "YOUR_API_KEY"
    }

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
curl -X GET -G \
  'https://api.peopledatalabs.com/v5/company/enrich'\
  -H 'X-Api-Key: xxxx'\
  --data-urlencode 'website=google.com'
  --data-urlencode 'required=size'
// See https://github.com/peopledatalabs/peopledatalabs-js
import PDLJS from 'peopledatalabs';

const PDLJSClient = new PDLJS({ apiKey: "YOUR API KEY" });

const queryString = {
                        "website":"google.com",
                        "required": "size"
                    }

PDLJSClient.company.enrichment(queryString).then((data) => {
    console.log(data);
}).catch((error) => {
    console.log(error);
});

Did this page help you?