Data Formatting

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

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.

FieldData TypeDescription
nameStringOur cleaned values for locations in the format locality, region, country.
localityStringThe locality of the address
regionStringThe region of the address
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_addressStringThe street address
address_line_2StringThe street address line 2
postal_codeStringThe postal code of the address
geoStringCity-center geo code of a locality, in the format latitude, longitude