Location

This type represents specific geographic positions or areas, such as a point on a map or a region, typically indicating temporary locations like where a user is accessing a website from.

All properties in this type are optional and represent different levels of accuracy, which may vary depending on the source of information — such as GPS or IP — and the user's privacy settings.

Generally, if more specific properties are available, less specific properties are likely to be available as well. For example, the city is usually unavailable when the state is unknown.

Properties

These are the available properties:

continent(optional)

string

The name of the continent in English. For example, "North America" or "South America".

continentCode(optional)

Continent

The continent as a two-letter code. For example, "na" for North America.

country(optional)

string

Name of the country in English. For example, "United States" or "Brazil".

countryCode(optional)

string

The country code following the ISO 3166-1 alpha-2 standard, always in lower case. For example, "us" for United States.

region(optional)

string

The name of the region in its native language. For example, "California" or "Rio de Janeiro".

regionCode(optional)

string

The code is based on the ISO 3166-2 standard or official codes whenever available, always in lowercase. For example, "ca" for California.

state(optional)

string

An alias for the region property.

stateCode(optional)

string

An alias for the regionCode property.

city(optional)

string

The name of the city in its native language. For example, "New York" or "São Paulo".

district(optional)

string

The name of the district in its native language. For example, "Manhattan" for New York City or "Zona Sul" for São Paulo City.

timeZone(optional)

string

The time zone name as specified in the IANA Time Zone Database. For example, "America/New_York" or "America/Sao_Paulo".

Continent

These are the possible values and what they represent: