Overview

IP Enrichment API This page details the company-related fields that we provide through the IP Enrichment API.

Field AvailabilityPlease note: Not all fields are available in all bundles.

For more information about data formatting, see Data Types.
For a full example record, see Example IP Record.
For a simplified overview of our IP fields, check out the IP Data Overview.
For more details about our IP fields and fill rates check out our IP Stats pages.
If you’d like access to premium fields or have questions about which fields are included in your specific field bundle(s), please speak to one of our data consultants.

IP

`ip`


Data Type	`Object`
Description	Information related to the IP address.

Field Details

This the object containing all information related to a particular IP we’ve registered in our dataset. IP objects can include the following data:

Field	Type	Description
`ip.address`	`String`	The matched IP address.
`ip.metadata`	`Object`	Premium fields targeted towards identifying IPs as mobile or using hosting, proxy, Tor, VPN, relay or other services.
`ip.location`	`Object`	The location associated with the IP address.

Example

JSON

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

`ip.address`


Data Type	`String`
Description	The IP address .

Field Details

This is the specific IP address we have registered in our dataset

Example

JSON

"address": "72.212.42.169",

`ip.metadata`


Data Type	`Object`
Description	Premium fields targeted towards identifying IPs as mobile or using hosting, proxy, Tor, VPN, relay or other services.

Field Details

The metadata object is a set of premium fields targeted towards identifying IPs as mobile or using hosting, proxy, Tor, VPN, relay or other services.

Example

JSON

"metadata": {
    "version": 4,
    "mobile": false,
    "hosting": false,
    "proxy": false,
    "tor": false,
    "vpn": false,
    "relay": false,
    "service": null,
    "asn_domain": null
  }

`ip.metadata.version`


Data Type	`Integer (4 or 6)`
Description	The type of IP Address (IPv4 or IPv6).

Field Details

This field will only contain the integer values 4 or 6 corresponding to whether the ip.address field is a IPv4 or IPv6 address.

Example

JSON

"version": 4,

`ip.metadata.mobile`


Data Type	`Boolean`
Description	If the IP is a known mobile address.

Field Details

A boolean field indicating whether the IP is a known mobile address.

Example

JSON

"mobile": false,

`ip.metadata.hosting`


Data Type	`Boolean`
Description	If the IP is a known hosting address.

Field Details

A boolean field indicating whether the IP is a known hosting address.

Example

JSON

"hosting": false

`ip.metadata.proxy`


Data Type	`Boolean`
Description	If the IP is a known proxy address.

Field Details

A boolean field indicating whether the IP is a known proxy address.

Example

JSON

"proxy": false

`ip.metadata.tor`


Data Type	`Boolean`
Description	If the IP is a known Tor address.

Field Details

A boolean field indicating whether the IP is a known Tor address.

Example

JSON

"tor": false

`ip.metadata.vpn`


Data Type	`Boolean`
Description	If the IP is a known VPN address.

Field Details

A boolean field indicating whether the IP is a known VPN address.

Example

JSON

"vpn": false

`ip.metadata.relay`


Data Type	`Boolean`
Description	If the IP is a known relay address.

Field Details

A boolean field indicating whether the IP is a known relay address.

Example

JSON

"relay": false

`ip.metadata.service`


Data Type	`String`
Description	If known, the name of the service for the address.

Field Details

If known, this field will contain the name of the service for the address. If the service name is unknown, the field value returned will be null.

Example

JSON

"service": null

`ip.metadata.asn_domain`


Data Type	`String`
Description	The domain associated with the ASN block.

Field Details

If known, this field will contain the domain associated with the ASN block for this IP. If the ASN block is unknown, the field value returned will be null.

Example

JSON

"asn_domain": null

Location

`ip.location`


Data Type	`Object`
Description	The location associated with the IP address.

Field Details

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

Field	Data Type	Description
`name`	`String`	Our cleaned values for locations in the format `locality, region, country`.
`locality`	`String`
`region`	`String`
`metro`	`Enum (String)`	US ONLY. These are generated based on the census-designated MSAs and maps. Will be one of our Canonical Metros.
`country`	`Enum (String)`	Standardized format for country. Will be one of our Canonical Countries.
`continent`	`Enum (String)`	Standardized format for continent. Will be one of our Canonical Continents.
`postal_code`	`String`
`geo`	`String`	City-center geo code of a locality, in the format `latitude, longitude`.
`timezone`	`Enum (String)`	The timezone the address is in. Will be lowercase and formatted according to the IANA Time Zone Database.

See here for more information on our standard location fields.

Example

JSON

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

`ip.location.name`


Data Type	`String`
Description	Our cleaned values for locations in the format locality, region, country.

Example

JSON

"name": "phoenix, arizona, united states"

`ip.location.locality`


Data Type	`String`
Description	The locality of the ip address

Example

JSON

"locality": "phoenix"

`ip.location.region`


Data Type	`String`
Description	The region of the ip address

Example

JSON

"region": "arizona"

`ip.location.metro`


Data Type	`Enum (String)`
Description	US ONLY. These are generated based on the census-designated MSAs and maps. Will be one of our Canonical Metros.

Example

JSON

"metro": "phoenix, arizona"

`ip.location.country`


Data Type	`Enum (String)`
Description	Standardized format for country. Will be one of our Canonical Countries.

Example

JSON

"country": "united states"

`ip.location.continent`


Data Type	`Enum (String)`
Description	Standardized format for continent. Will be one of our Canonical Continents.

Example

JSON

"continent": "north america"

`ip.location.postal_code`


Data Type	`String`
Description	The postal code of the ip address

Example

JSON

"postal_code": "85001"

`ip.location.geo`


Data Type	`String`
Description	City-center geo code of a locality, in the format latitude, longitude.

Example

JSON

"geo": "33.44838,-112.07404"

`ip.location.timezone`


Data Type	`Enum (String)`
Description	The timezone the address is in. Will be lowercase and formatted according to the IANA Time Zone Database.

Example

JSON

"timezone": "america/phoenix"

Company

`company`


Data Type	`Object`
Description	Information related to the company associated with the IP address

Field Details

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

Example

JSON

"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": "51-200",
  "industry": "computer software",
  "inferred_revenue": "$10M-$25M",
  "employee_count": 116,
  "tags": [
    "b2b data",
    "people data",
    "data science",
    "data",
    "daas",
    "artificial intelligence",
    "data and analytics",
    "machine learning",
    "analytics",
    "database"
  ]
}

`company.confidence`


Data Type	`Enum (String)`
Description	How confident we are that the returned company is associated with requested IP.

Field Details

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.

Example

JSON

"confidence": "very high"

`company.id`


Data Type	`String`
Description	The PDL ID of the company associated with the IP address

Field Details

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

Example

JSON

"id": "tnHcNHbCv8MKeLh92946LAkX6PKg"

`company.website`


Data Type	`String`
Description	The primary website of the company associated with the IP address.

Field Details

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

Example

JSON

"website": "peopledatalabs.com"

`company.name`


Data Type	`String`
Description	The name of the company associated with the IP address.

Field Details

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

Example

JSON

"name": "people data labs"

`company.display_name`


Data Type	`String`
Description	The display_name of the company associated with the IP address.

Field Details

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

Example

JSON

"display_name": "People Data Labs"

`company.location`


Data Type	`Object`
Description	The location of the company’s primary HQ associated with the IP address

Field Details

The location object will contain our common location fields:

Field	Data Type	Description
`name`	`String`	Our cleaned values for locations in the format `locality, region, country`.
`locality`	`String`
`region`	`String`
`metro`	`Enum (String)`	US ONLY. These are generated based on the census-designated MSAs and maps. Will be one of our Canonical Metros.
`country`	`Enum (String)`	Standardized format for country. Will be one of our Canonical Countries.
`continent`	`Enum (String)`	Standardized format for continent. Will be one of our Canonical Continents.
`street_address`	`String`
`address_line_2`	`String`
`postal_code`	`String`
`geo`	`String`	City-center geo code of a locality, in the format `latitude, longitude`.

Example

JSON

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

`company.location.name`


Data Type	`String`
Description	Our cleaned values for locations in the format locality, region, country.

Example

JSON

"name": "san francisco, california, united states"

`company.location.locality`


Data Type	`String`
Description	The locality of the company HQ

Example

JSON

"locality": "san francisco"

`company.location.region`


Data Type	`String`
Description	The region of the company HQ

Example

JSON

"region": "california"

`company.location.metro`


Data Type	`Enum (String)`
Description	US ONLY. These are generated based on the census-designated MSAs and maps. Will be one of our Canonical Metros.

Example

JSON

"metro": "san francisco, california"

`company.location.country`


Data Type	`Enum (String)`
Description	Standardized format for country. Will be one of our Canonical Countries.

Example

JSON

"country": "united states"

`company.location.continent`


Data Type	`Enum (String)`
Description	Standardized format for continent. Will be one of our Canonical Continents.

Example

JSON

"continent": "north america"

`company.location.street_address`


Data Type	`String`
Description	The street address of the company HQ

Example

JSON

"street_address": "455 market street"

`company.location.address_line_2`


Data Type	`String`
Description	The company HQ’s street address line 2

Example

JSON

"address_line_2": "suite 1670"

`company.location.postal_code`


Data Type	`String`
Description	The postal code of the company HQ

Example

JSON

"postal_code": "94105"

`company.location.geo`


Data Type	`String`
Description	City-center geo code of a locality, in the format latitude, longitude.

Example

JSON

"geo": "37.77,-122.41"

`company.size`


Data Type	`Enum (String)`
Description	The self-reported size range of the company associated with the IP address.

Field Details

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

Example

JSON

"size": "51-200"

`company.industry`


Data Type	`Enum (String)`
Description	The self-reported industry of the company associated with the IP address.

Field Details

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

Example

JSON

"industry": "computer software"

`company.inferred_revenue`


Data Type	`Enum (String)`
Description	The estimated annual revenue (in USD) of the company associated with the IP address.

Field Details

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

Example

JSON

"inferred_revenue": "$10M-$25M"

`company.employee_count`


Data Type	`Integer (> 0)`
Description	The current number of employees working at the company associated with the IP address.

Field Details

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

Example

JSON

"employee_count": 116

`company.tags`


Data Type	`Array [String]`
Description	Tags associated with the company associated with the IP address.

Field Details

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

Example

JSON

"tags": [
  "b2b data",
  "people data",
  "data science",
  "data",
  "daas",
  "artificial intelligence",
  "data and analytics",
  "machine learning",
  "analytics",
  "database"
]

Person

`person`


Data Type	`Object`
Description	Information related to the person associated with the IP address

Field Details

We offer several person-related fields within our IP records to understand the associated persona behind the IP. These fields are largely limited to job title information.

Example

JSON

"person": {
  "confidence": "very high",
  "job_title_sub_role": "product",
  "job_title_role": "operations",
  "job_title_levels": [
    "cxo"
  ],
  "job_title_class": "research_and_development"
}

`person.confidence`


Data Type	`Enum (String)`
Description	How confident we are that the returned person is associated with requested IP.

Field Details

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

Example

JSON

"confidence": "very high"

`person.job_title_sub_role`


Data Type	`Enum (String)`
Description	The derived subrole of the person’s current job title.

Field Details

The value will be one of our Canonical Job Sub Roles. Each subrole maps to a role. See Mapping Job Title Class to Roles to Subroles for the complete list.

Example

JSON

"job_title_sub_role": "product management"

`person.job_title_role`


Data Type	`Enum (String)`
Description	The derived role of the person’s current job title.

Field Details

The value will be one of our Canonical Job Roles.

Example

JSON

"job_title_role": "product"

`person.levels`


Data Type	`Array [Enum (String)]`
Description	The derived level(s) of the person’s current job title

Field Details

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”].

Example

JSON

"job_title_levels": [
  "cxo"
]

`person.job_title_class`


Data Type	`Enum (String)`
Description	The line item category this employee would fall into.

Field Details

The value will be one of our Canonical Job Roles.

Example

JSON

"job_title_class": "research_and_development"

​Overview

​IP

​ip

​Field Details

​Example

​ip.address

​Field Details

​Example

​ip.metadata

​Field Details

​Example

​ip.metadata.version

​Field Details

​Example

​ip.metadata.mobile

​Field Details

​Example

​ip.metadata.hosting

​Field Details

​Example

​ip.metadata.proxy

​Field Details

​Example

​ip.metadata.tor

​Field Details

​Example

​ip.metadata.vpn

​Field Details

​Example

​ip.metadata.relay

​Field Details

​Example

​ip.metadata.service

​Field Details

​Example

​ip.metadata.asn_domain

​Field Details

​Example

​Location

​ip.location

​Field Details

​Example

​ip.location.name

​Example

​ip.location.locality

​Example

​ip.location.region

​Example

​ip.location.metro

​Example

​ip.location.country

​Example

​ip.location.continent

​Example

​ip.location.postal_code

​Example

​ip.location.geo

​Example

​ip.location.timezone

​Example

​Company

​company

​Field Details

​Example

​company.confidence

​Field Details

​Example

​company.id

​Field Details

​Example

​company.website

​Field Details

​Example

​company.name

​Field Details

​Example

​company.display_name

​Field Details

​Example

​company.location

Overview

IP

`ip`

Field Details

Example

`ip.address`

Field Details

Example

`ip.metadata`

Field Details

Example

`ip.metadata.version`

Field Details

Example

`ip.metadata.mobile`

Field Details

Example

`ip.metadata.hosting`

Field Details

Example

`ip.metadata.proxy`

Field Details

Example

`ip.metadata.tor`

Field Details

Example

`ip.metadata.vpn`

Field Details

Example

`ip.metadata.relay`

Field Details

Example

`ip.metadata.service`

Field Details

Example

`ip.metadata.asn_domain`

Field Details

Example

Location

`ip.location`

Field Details

Example

`ip.location.name`

Example

`ip.location.locality`

Example

`ip.location.region`

Example

`ip.location.metro`

Example

`ip.location.country`

Example

`ip.location.continent`

Example

`ip.location.postal_code`

Example

`ip.location.geo`

Example

`ip.location.timezone`

Example

Company

`company`

Field Details

Example

`company.confidence`

Field Details

Example

`company.id`

Field Details

Example

`company.website`

Field Details

Example

`company.name`

Field Details

Example

`company.display_name`

Field Details

Example

`company.location`