Location
Explore what information is available for locations.
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.
Some countries use regions instead of states for administrative divisions, so we included both to let you choose the best option for your scenario.
Properties
These are the available properties:
- continent(optional)map<string>
- continentName(optional)
An alias for the continent.name property.
- continentCode(optional)
An alias for the continent.code property.
- country(optional)map<string>
The country where the location is situated.
- namestring
The name of the country in English.
For example, "United States" or "Brazil".
- code(optional)
The country code following the ISO 3166-1 alpha-2 standard, in upper case.
For example, "US" for United States.
- name
- countryName(optional)
An alias for the country.name property.
- countryCode(optional)
An alias for the country.code property.
- region(optional)map<string>
The primary administrative division within the country, such as a state or province.
- namestring
The name of the region in English.
For example, "California" or "Rio de Janeiro".
- code(optional)
The code is based on the ISO 3166-2 standard or official codes whenever available, in upper case.
For example, "CA" for California.
- name
- regionName(optional)
An alias for the region.name property.
- regionCode(optional)
An alias for the region.code property.
- state(optional)map<string>
An alias for the region property.
- namestring
An alias for the region.name property.
- code(optional)
An alias for the region.code property.
- name
- stateName(optional)
An alias for the region.name property.
- stateCode(optional)
An alias for the region.code property.
- city(optional)map<string>
The incorporated city or town political entity.
- namestring
The name of the city in English.
For example, "New York", "Mexico City" or "São Paulo".
- name
- cityName(optional)
An alias for the city.name property.
- coordinates(optional)map<number>
- latitude(optional)
An alias for the coordinates.latitude property.
- longitude(optional)
An alias for the coordinates.longitude property.
- currency(optional)map<string>
- currencyCode(optional)
An alias for the currency.code property.
- currencyName(optional)
An alias for the currency.name property.
- timeZone(optional)
The time zone name as specified in the IANA Time Zone Database.
For example, "America/New_York" or "America/Sao_Paulo".
- languages(optional)
A list of locale codes of the languages spoken in the location as specified in the ISO 639-1 and ISO 3166-1.
For example, ["en", "en-CA", "fr-CA"] indicates that English and French are spoken in Canada, with English being more prevalent.
- phoneCode(optional)
The international dialing code for this location.
For example, "+1" for the United States or Canada, or "+55" for Brazil.
- postalCode(optional)
The postal or ZIP code associated with the location.
The value follows a valid format (e.g., "90210", "SW1A 1AA", or "28430-000"), but may represent an approximate or example code for the region rather than an exact or specific address.
In some areas, it may reflect the beginning of a postal range.
- population(optional)
The approximate population within the boundaries of the returned location.
If the location refers to a city, this value reflects the city's population. If it refers to a broader area, such as a region, it reflects the population of that region.
One or more tags describing the location, such as natural features or climate.
For example, a lake in a warm, touristic area might include tags like "warm", "lake" and "tourism".
Continent
These are the possible values and what they represent:
| Code | Continent |
|---|---|
| AF | Africa |
| AN | Antarctica |
| AS | Asia |
| EU | Europe |
| NA | North America |
| OC | Oceania |
| SA | South America |
Tags
These are the possible tags grouped by category.
Place
Tags related to the type of place or area:
| Tag | Description |
|---|---|
| urban | Related to cities or densely populated areas |
| residential | Areas where housing and living spaces are concentrated |
| rural | Countryside or sparsely populated regions outside urban centers |
| remote | Locations distant from major settlements or infrastructure |
| park | Public or protected areas with greenery or open space |
| island | Land surrounded by water on all sides |
Society
Tags denoting social roles, institutions, and public services:
| Tag | Description |
|---|---|
| government | Locations related to public services, institutions, or administration |
| politics | Places associated with political activity or governance |
| military | Locations used for defense, training, or armed service operations |
| religion | Sites with religious or spiritual significance |
| education | Places where people study and learn |
Economy
Tags related to economic activity:
| Tag | Description |
|---|---|
| business | Areas with commercial presence or economic activity |
| industry | Zones involving manufacturing, logistics, or production |
| agriculture | Areas with fields, pastures, or crops |
Infrastructure
Tags related to transportation, utilities, and built environments:
| Tag | Description |
|---|---|
| transport | Locations supporting transit or logistics |
| facility | Places built for specific purposes, often supporting operations or services |
| waterway | Navigable or managed water routes such as rivers or canals |
| airport | Locations related to aircraft takeoff and landing |
| road | Infrastructure for vehicular travel |
| railway | Locations involving rail transport infrastructure |
| seaport | Ports where ships may dock, load, or unload goods or passengers |
Sport
Tags for areas commonly used for sports and outdoor activities:
| Tag | Description |
|---|---|
| fishing | Areas where fishing or related activity may take place |
| surfing | Coastal areas with waves that may support surfing |
| swimming | Areas where people may swim or engage with water safely |
| hiking | Outdoor spaces where hiking might occur |
| skiing | Areas where snow allows skiing or similar activities |
Attraction
Tags highlighting cultural, recreational, or scenic appeal:
| Tag | Description |
|---|---|
| entertainment | Places that can offer cultural or recreational activities |
| scenery | Locations appreciated for their natural beauty or view |
| landmark | Notable spots or features that help identify a place |
| recreation | Areas intended for outdoor activities, sports, or leisure |
| tourism | Places people visit for culture, nature, or history |
Nature
Tags describing natural features and landscapes:
| Tag | Description |
|---|---|
| mountain | Elevated terrain rising above surroundings |
| lake | Bodies of still water surrounded by land |
| river | Naturally flowing body of water that may lead to lakes or oceans |
| canyon | Natural formations shaped by erosion |
| desert | Dry regions with little rainfall or vegetation |
| ocean | Coastal or open-sea areas facing large saltwater bodies |
| coast | Edges of land meeting a sea or ocean |
| beach | Shoreline with sand or pebbles, often near water bodies |
| forest | Areas with dense tree cover |
Weather
Tags related to climate and weather conditions:
| Tag | Description |
|---|---|
| warm | Regions with generally tropical or temperate climates |
| cold | Regions characterized by low temperatures |
| snowy | Areas with frequent snow or icy conditions |