Cities search by geoposition
Provide a latitude and longitude to retrieve detailed location information.
query Parameters
qstring · requiredA string that indicates the latitude and longitude position.
Example: 40.779,-73.969languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usdetailsbooleanA boolean value that specifies whether or not to include extended information.
Default: falseformatstringA string value that specifies what type of format to provide the response.
Default: jsontopLevelbooleanA 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.)
Default: false
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
PrimaryPostalCodestring · minLength: 1 · requiredOfficial postal code provided by our main location data provider for the requested location
RegionrequiredThe object containing the region details
TimeZonerequiredThe object containing the timezone details
GeoPositionrequiredThe object containing the geoposition details
IsAliasboolean · required“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location
SupplementalAdminAreasobject[] · requiredThe object containing a list of administrative area details
DataSetsstring[] · requiredArray 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.
EnglishNamestring · minLength: 1 · requiredLocation name as displayed in English
Versioninteger · int32 · requiredCurrent version of the API
Keystring · minLength: 1 · requiredUnique ID to search a location
Typestring · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rankinteger · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNamestring · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
CountryrequiredTHe object containing the country details
AdministrativeArearequiredThe object containing the amdministrative area details
ParentCity| nullThe object containing the parentcity details. This object will be displayed only if the location is part of a larger metropolitan area or parent city.
Details| nullAccuWeather related details about the specific location
Location search by geoposition
Specify a geoposition point by latitude and longitude to return location data.
query Parameters
qstring · requiredA string that indicates the latitude and longitude position.
Example: 40.779,-73.969languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usdetailsbooleanA boolean value that specifies whether or not to include extended information.
Default: falseformatstringA string value that specifies what type of format to provide the response.
Default: jsontopLevelbooleanA 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.)
Default: false
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
PrimaryPostalCodestring · minLength: 1 · requiredOfficial postal code provided by our main location data provider for the requested location
RegionrequiredThe object containing the region details
TimeZonerequiredThe object containing the timezone details
GeoPositionrequiredThe object containing the geoposition details
IsAliasboolean · required“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location
SupplementalAdminAreasobject[] · requiredThe object containing a list of administrative area details
DataSetsstring[] · requiredArray 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.
EnglishNamestring · minLength: 1 · requiredLocation name as displayed in English
Versioninteger · int32 · requiredCurrent version of the API
Keystring · minLength: 1 · requiredUnique ID to search a location
Typestring · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rankinteger · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNamestring · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
CountryrequiredTHe object containing the country details
AdministrativeArearequiredThe object containing the amdministrative area details
ParentCity| nullThe object containing the parentcity details. This object will be displayed only if the location is part of a larger metropolitan area or parent city.
Details| nullAccuWeather related details about the specific location
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
qstring · requiredA string that indicates the latitude and longitude position.
Example: 40.779,-73.969languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usdetailsbooleanA boolean value that specifies whether or not to include extended information.
Default: falseformatstringA string value that specifies what type of format to provide the response.
Default: jsontopLevelbooleanA 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.)
Default: false
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
PrimaryPostalCodestring · minLength: 1 · requiredOfficial postal code provided by our main location data provider for the requested location
RegionrequiredThe object containing the region details
TimeZonerequiredThe object containing the timezone details
GeoPositionrequiredThe object containing the geoposition details
IsAliasboolean · required“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location
SupplementalAdminAreasobject[] · requiredThe object containing a list of administrative area details
DataSetsstring[] · requiredArray 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.
EnglishNamestring · minLength: 1 · requiredLocation name as displayed in English
Versioninteger · int32 · requiredCurrent version of the API
Keystring · minLength: 1 · requiredUnique ID to search a location
Typestring · minLength: 1 · requiredLocation type such as City, PostalCode, POI or LatLong
Rankinteger · int32 · requiredNumber applied to locations set by factors such as population, political importance, and geographic size
LocalizedNamestring · minLength: 1 · requiredDisplay name in local dialect set with language code in URL. Default is US English (us-en)
CountryrequiredTHe object containing the country details
AdministrativeArearequiredThe object containing the amdministrative area details
ParentCity| nullThe object containing the parentcity details. This object will be displayed only if the location is part of a larger metropolitan area or parent city.
Details| nullAccuWeather related details about the specific location