Output Response - IP Enrichment API

Response Data Structure

Here is an example response from the IP Enrichment API:

{
    "status": 200,
    "data": {
        "ip": {
            "address": "72.212.42.169",
            "metadata": {
                "version": 4,
                "mobile": false,
                "hosting": false,
                "proxy": false,
                "tor": false,
                "vpn": false,
                "relay": false,
                "service": null,
              	"asn_domain": null
            },
            "location": {
                "name": "phoenix, arizona, united states",
                "locality": "phoenix",
                "region": "arizona",
                "metro": "phoenix, arizona",
                "country": "united states",
                "continent": "north america",
                "postal_code": "85001",
                "geo": "33.44838,-112.07404",
                "timezone": "america/phoenix"
            }
        },
        "company": {
            "confidence": "very high",
            "id": "tnHcNHbCv8MKeLh92946LAkX6PKg",
            "website": "peopledatalabs.com",
            "name": "people data labs",
            "display_name": "People Data Labs",
            "location": {
                "name": "san francisco, california, united states",
                "locality": "san francisco",
                "region": "california",
                "metro": "san francisco, california",
                "country": "united states",
                "continent": "north america",
                "street_address": "455 market street",
                "address_line_2": "suite 1670",
                "postal_code": "94105",
                "geo": "37.77,-122.41"
            },
            "size": "11-50",
            "industry": "computer software",
            "inferred_revenue": "$25m-$50m",
            "employee_count": 129,
            "tags": [
                "artificial intelligence",
                "data and analytics",
                "machine learning",
                "analytics",
                "database",
                "software",
                "developer apis",
                "data",
                "people data",
                "data science"
            ]
        },
        "person": {
            "confidence": "very high",
            "job_title_sub_role": "product",
            "job_title_role": "operations",
            "job_title_levels": [
                "cxo"
            ]
        },
      	"dataset_version": "1.1.0.2024w19"
    }
}

Response Fields

status

TypeDescription
IntegerThe API response code.

data

TypeDescription
ObjectThe information about the IP address from the ip input parameter.

The data object contains the entire record for the IP address that matches the Enrichment API request. Any fields within the data object that we do not have data for will have a null value.


data.ip

TypeDescription
ObjectInformation related to the IP address.

data.ip.address

TypeDescription
StringThe matched IP address.

The IP that matches the API input ip after it's passed through our validity checks.


data.ip.metadata

TypeDescription
ObjectPremium fields targeted towards identifying IPs as mobile or using hosting, proxy, Tor, VPN, relay or other services.

The metadata object is a premium add-on available for an additional price. It contains the following fields:

FieldTypeDescription
versionInteger (4 or 6)The type of IP Address (IPv4 or IPv6).
mobileBooleanIf the IP is a known mobile address.
hostingBooleanIf the IP is a known hosting address.
proxyBooleanIf the IP is a known proxy address.
torBooleanIf the IP is a known Tor address.
vpnBooleanIf the IP is a known VPN address.
relayBooleanIf the IP is a known relay address.
serviceStringIf known, the name of the service for the address.
asn_domainStringThe domain associated with the ASN block.

data.ip.location

TypeDescription
ObjectThe location associated with the IP address.

The location object will contain some of our common location fields as well as the location timezone:

FieldData TypeDescription
nameStringOur cleaned values for locations in the format locality, region, country.
localityString
regionString
metroEnum (String)US ONLY. These are generated based on the census-designated MSAs and maps. Will be one of our Canonical Metros.
countryEnum (String)Standardized format for country. Will be one of our Canonical Countries.
continentEnum (String)Standardized format for continent. Will be one of our Canonical Continents.
postal_codeString
geoStringCity-center geo code of a locality, in the format latitude, longitude.
timezoneEnum (String)The timezone the address is in. Will be lowercase and one of the Global Time Zone values found here.

data.company

TypeDescription
ObjectInformation related to the company associated with the IP address.

Many of the fields in the data.company object come directly from our Company Schema.


data.company.confidence

TypeDescription
Enum (String)How confident we are that the returned company is associated with requested IP.

Will be one of the following options: very high, high, moderate, low, very low.

Our company matches are created with observed data along with registered ASN blocks. For matches we make with observed data, the confidence value is our scoring for how much and how often we have seen a company associated with an IP address.


data.company.id

TypeDescription
StringThe PDL ID of the company associated with the IP address.

See company.id for more information about how we handle company IDs.


data.company.website

TypeDescription
StringThe primary website of the company associated with the IP address.

See company.website for more information about how we handle company websites.


data.company.name

TypeDescription
StringThe name of the company associated with the IP address.

See company.name for more information about how we handle company names.


data.company.display_name

TypeDescription
StringThe display_name of the company associated with the IP address.

See company.display_name for more information about how we handle company names.


data.company.location

TypeDescription
ObjectThe location of the company's primary HQ associated with the IP address.

The location object will contain our common location fields:

FieldData TypeDescription
nameStringOur cleaned values for locations in the format locality, region, country.
localityString
regionString
metroEnum (String)US ONLY. These are generated based on the census-designated MSAs and maps. Will be one of our Canonical Metros.
countryEnum (String)Standardized format for country. Will be one of our Canonical Countries.
continentEnum (String)Standardized format for continent. Will be one of our Canonical Continents.
street_addressString
address_line_2String
postal_codeString
geoStringCity-center geo code of a locality, in the format latitude, longitude.

data.company.size

TypeDescription
Enum (String)The self-reported size range of the company associated with the IP address.

See company.size for more information about how we handle company size ranges.


data.company.industry

TypeDescription
Enum (String)The self-reported industry of the company associated with the IP address.

See company.industry for more information about how we handle company industries.


data.company.inferred_revenue

TypeDescription
Enum (String)The estimated annual revenue (in USD) of the company associated with the IP address.

See company.inferred_revenue for more information about how we handle company revenues.


data.company.employee_count

TypeDescription
Integer (> 0)The current number of employees working at the company associated with the IP address.

See company.employee_count for more information about how we handle company employee counts.


data.company.tags

TypeDescription
Array [String]Tags associated with the company associated with the IP address.

See company.tags for more information about how we handle company tags.


data.person

TypeDescription
ObjectInformation related to the person associated with the IP address

data.person.confidence

TypeDescription
Enum (String)How confident we are that the returned person is associated with requested IP.

Will be one of the following options: very high, high, moderate, low, very low.


data.person.job_title_sub_role

TypeDescription
Enum (String)The derived subrole of the person's current job title.

The value will be one of our Canonical Job Sub Roles. Each subrole maps to a role. See https://docs.peopledatalabs.com/docs/title-subroles-to-roles for a complete mapping list.


data.person.job_title_role

TypeDescription
Enum (String)The derived role of the person's current job title.

The value will be one of our Canonical Job Roles.


data.person.job_title_levels

TypeDescription
Array [Enum (String)]The derived level(s) of the person's current job title

Each level in the list will be one of our Canonical Job Title Levels.

Note: The cxo level is a catch-all for "Chief __ Officer" roles, so a CEO, CIO, CTO, etc. will all have job_title_levels: ["cxo"].


data.dataset_version

TypeDescription
StringThe release number for the current build