No Data

Every response object will contain every field listed in the Schema page that the customer has paid for.

If we do not have data for a field, its value will be null unless the field is an Array type, in which case its value will be an empty list [].

Phone Numbers

All phone numbers will be in in E164 format with a leading + and country code. For example, "+15558675309".

Currencies

Unless otherwise stated in the Schema page for a field, all currency values are in USD.

Locations

Localities

A locality is the city, town, village, neighborhood, or other local place-name component of an address. It is the part of a location most users think of as "city-level" and usually appears before region and country in a cleaned location name. Examples: san francisco, london, berkeley, north york, marseille.

We match locations using a strict/fuzzy logic. Our goal is match as many locations as possible to our Location Data entity, linking them based on location.name. To tap into our location matching logic, use our Location Cleaner API or retrieve possible location values using our Autocomplete API.

Addresses

We standardize addresses in the US and Canada using an internal address parser. We do not conform to any standards such as CASS, although we try to imitate them as much as possible.

Common Location Fields

We break location data into the following fields. These names are used throughout our data to refer to location information.

Field	Data Type	Description
`name`	`String`	Our cleaned values for locations in the format `locality, region, country`.
`locality`	`String`	The locality of the address, typically a city, town, neighborhood, or other local place name. Examples: `san francisco`, `london`, `berkeley`, `north york`.
`region`	`String`	The administrative region of the address, such as a U.S. state, Canadian province, or other sub-country division. Examples: `california`, `ontario`, `bavaria`, `queensland`.
`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`	The street address
`address_line_2`	`String`	The street address line 2
`postal_code`	`String`	The postal code of the address
`geo`	`String`	City-center geo code of a locality, in the format `latitude, longitude`