Quickstart - Company Enrichment API

A fast hands-on introduction to the Company Enrichment API

Getting Started

In order to use our Company Enrichment API, you must have an active API key. You can look up your API key by logging into our self-serve dashboard and going to the API Keys section.

👍

Need an API Key?

If you don't have an API key, you can easily create one by signing up for a self-serve account. For more information, check out our Self-Serve Quickstart Guide, which walks you through the sign-up process as well as shows you how to use the self-serve API dashboard.

Simple Example

As mentioned in the Overview, the Company Enrichment API is a means of performing a one-to-one match of a company with those included in our Company Dataset. In order to use the Company Enrichment API, you will need one of the input parameters of the API.

Here's a quick example that demonstrates retrieving a record with a website of google.com:

# See https://github.com/peopledatalabs/peopledatalabs-python
from peopledatalabs import PDLPY

# Create a client, specifying your API key
CLIENT = PDLPY(
    api_key="YOUR API KEY",
)

# Create a parameters JSON object
QUERY_STRING = {"website":"google.com"}

# Pass the parameters object to the Company Enrichment API
response = CLIENT.company.enrichment(**QUERY_STRING)

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

// Create a client, specifying your API key
const PDLJSClient = new PDLJS({ apiKey: "YOUR API KEY" });

// Create a parameters JSON object
const queryString = {"website":"google.com"}

// Pass the parameters object to the Company Enrichment API
PDLJSClient.company.enrichment(queryString).then((response) => {
    // Print the API response
    console.log(response);
}).catch((error) => {
    console.log(error);
});
# See https://github.com/peopledatalabs/peopledatalabs-ruby
require 'peopledatalabs'

# Set your API key
Peopledatalabs.api_key = 'YOUR API KEY'

# Create a parameters JSON object
QUERY_STRING = {"website":"google.com"}

# Pass the parameters object to the Company Enrichment API
response = Peopledatalabs::Enrichment.company(params: QUERY_STRING)

# Print the API response
puts response
package main

import (
    "fmt"
    "context"
)

// See https://github.com/peopledatalabs/peopledatalabs-go
import (
    pdl "github.com/peopledatalabs/peopledatalabs-go"
    pdlmodel "github.com/peopledatalabs/peopledatalabs-go/model"
)

func main() {
    // Set your API key
    apiKey := "YOUR API KEY"
    // Set API key as environmental variable
    // apiKey := os.Getenv("API_KEY")

    // Create a client, specifying your API key
    client := pdl.New(apiKey)
    
    // Create a parameters JSON object
    queryString := pdlmodel.CompanyParams{Website: "google.com"}
    
    params := pdlmodel.EnrichCompanyParams{
        CompanyParams: queryString,
    }
    
    // Pass the parameters object to the Company Enrichment API
    response, err := client.Company.Enrich(context.Background(), params)
    
    // Check for successful response
    if err == nil {
        // Print the API response
        fmt.Println(response)
    }  
}
import requests

# Set your API key
API_KEY = "YOUR API KEY"

# Set the Company Enrichment API URL
PDL_URL = "https://api.peopledatalabs.com/v5/company/enrich"

# Create a parameters JSON object
QUERY_STRING = {"website":"google.com"}

# Set headers
HEADERS = {
    'accept': "application/json",
    'content-type': "application/json",
    'x-api-key': API_KEY
    }

# Pass the parameters object to the Company Enrichment API
response = requests.request("GET", PDL_URL, headers=HEADERS, params=QUERY_STRING)

# Print the API response
print(response.text)

The response that the API returns is a company record if the website passed to it exists in our dataset:

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

If you don't get this response, check out our Errors page for more information.