Cities search by geoposition
Provide a latitude and longitude to retrieve detailed location information.
query Parameters
qA string that indicates the latitude and longitude position.
languageA string that indicates the language in which to return the response. More information can be found here.
detailsA boolean value that specifies whether or not to include extended information.
formatA string value that specifies what type of format to provide the response.
topLevelA boolean value indicating whether or not return only locations with the highest rank. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.)
Headers
AuthorizationThe Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.
Cities search by geoposition › Responses
OK
PrimaryPostalCodeOfficial postal code provided by our main location data provider for the requested location
IsAlias“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location
The object containing a list of administrative area details
DataSetsArray of location-specific products that are available for this location. Products include Alerts, PremiumAirQuality, AirQuality, MinuteCast, and ForecastConfidence. If no location-specific products are available, the array will be empty.
EnglishNameLocation name as displayed in English
VersionCurrent version of the API
KeyUnique ID to search a location
TypeLocation type such as City, PostalCode, POI or LatLong
RankNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNameDisplay name in local dialect set with language code in URL. Default is US English (us-en)
Location search by geoposition
Specify a geoposition point by latitude and longitude to return location data.
query Parameters
qA string that indicates the latitude and longitude position.
languageA string that indicates the language in which to return the response. More information can be found here.
detailsA boolean value that specifies whether or not to include extended information.
formatA string value that specifies what type of format to provide the response.
topLevelA boolean value indicating whether or not return only locations with the highest rank. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.)
Headers
AuthorizationThe Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.
Location search by geoposition › Responses
OK
PrimaryPostalCodeOfficial postal code provided by our main location data provider for the requested location
IsAlias“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location
The object containing a list of administrative area details
DataSetsArray of location-specific products that are available for this location. Products include Alerts, PremiumAirQuality, AirQuality, MinuteCast, and ForecastConfidence. If no location-specific products are available, the array will be empty.
EnglishNameLocation name as displayed in English
VersionCurrent version of the API
KeyUnique ID to search a location
TypeLocation type such as City, PostalCode, POI or LatLong
RankNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNameDisplay name in local dialect set with language code in URL. Default is US English (us-en)
Point of interest by latitude, longitude
Specify a latitude and longitude coordinate to return location data for a point of interest.
A point of interest (POI) typically refers to a business location, tourist attraction, or other well-known site. Common examples include:
- Airports
- Stadiums
- Parks
query Parameters
qA string that indicates the latitude and longitude position.
languageA string that indicates the language in which to return the response. More information can be found here.
detailsA boolean value that specifies whether or not to include extended information.
formatA string value that specifies what type of format to provide the response.
topLevelA boolean value indicating whether or not return only locations with the highest rank. Large cities have higher rank than the neighborhoods within them, so toplevel=true delivers a more generic location result. (Example: 40.73,-74.00 returns Greenwich Village, NY when toplevel=false. If toplevel=true, the same lat/lon pair will return New York, NY.)
Headers
AuthorizationThe Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.
Point of interest by latitude, longitude › Responses
OK
PrimaryPostalCodeOfficial postal code provided by our main location data provider for the requested location
IsAlias“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location
The object containing a list of administrative area details
DataSetsArray of location-specific products that are available for this location. Products include Alerts, PremiumAirQuality, AirQuality, MinuteCast, and ForecastConfidence. If no location-specific products are available, the array will be empty.
EnglishNameLocation name as displayed in English
VersionCurrent version of the API
KeyUnique ID to search a location
TypeLocation type such as City, PostalCode, POI or LatLong
RankNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNameDisplay name in local dialect set with language code in URL. Default is US English (us-en)