Geoposition

Cities search by geoposition

GET

https://dataservice.accuweather.com

/locations/v1/cities/geoposition/search

Provide a latitude and longitude to retrieve detailed location information.

Cities search by geoposition › query Parameters

q

string · required

A string that identifies the central location from which to search. Provide the coordinates as latitude,longitude in decimal format.

Example: 40.779,-73.969

language

string

A string that indicates the language in which to return the response. More information can be found here.

Default: en-us

details

boolean

A boolean value that specifies whether or not to include extended information.

Default: false

format

string

A string value that specifies what type of format to provide the response.

Default: json

topLevel

boolean

A 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

Cities search by geoposition › Headers

Authorization

string · required

The Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.

Cities search by geoposition › Responses

API.Locations.Entities.OpenAPI.Location

PrimaryPostalCode

string · minLength: 1 · required

Official postal code provided by our main location data provider for the requested location

required

The object containing the region details

required

The object containing the timezone details

required

The object containing the geoposition details

IsAlias

boolean · required

“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location

API.Locations.Entities.OpenAPI.SupplementalAdminArea[] · required

The object containing a list of administrative area details

DataSets

string[] · required

Array 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.

EnglishName

string · minLength: 1 · required

Location name as displayed in English

Version

integer · int32 · required

Current version of the API

Key

string · minLength: 1 · required

Unique ID to search a location

Type

string · minLength: 1 · required

Location type such as City, PostalCode, POI or LatLong

Rank

integer · int32 · required

Number applied to locations set by factors such as population, political importance, and geographic size

LocalizedName

string · minLength: 1 · required

Display name in local dialect set with language code in URL. Default is US English (us-en)

required

THe object containing the country details

required

The object containing the amdministrative area details

The object containing the parentcity details. This object will be displayed only if the location is part of a larger metropolitan area or parent city.

AccuWeather related details about the specific location

Location search by geoposition

GET

https://dataservice.accuweather.com

/locations/v1/geoposition/search

Specify a geoposition point by latitude and longitude to return location data.

Location search by geoposition › query Parameters

q

string · required

A string that identifies the central location from which to search. Provide the coordinates as latitude,longitude in decimal format.

Example: 40.779,-73.969

language

string

A string that indicates the language in which to return the response. More information can be found here.

Default: en-us

details

boolean

A boolean value that specifies whether or not to include extended information.

Default: false

format

string

A string value that specifies what type of format to provide the response.

Default: json

topLevel

boolean

Default: false

Location search by geoposition › Headers

Authorization

string · required

The Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.

Location search by geoposition › Responses

API.Locations.Entities.OpenAPI.Location[]

API.Locations.Entities.OpenAPI.Location

PrimaryPostalCode

string · minLength: 1 · required

Official postal code provided by our main location data provider for the requested location

required

The object containing the region details

required

The object containing the timezone details

required

The object containing the geoposition details

IsAlias

boolean · required

“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location

API.Locations.Entities.OpenAPI.SupplementalAdminArea[] · required

The object containing a list of administrative area details

DataSets

string[] · required

EnglishName

string · minLength: 1 · required

Location name as displayed in English

Version

integer · int32 · required

Current version of the API

Key

string · minLength: 1 · required

Unique ID to search a location

Type

string · minLength: 1 · required

Location type such as City, PostalCode, POI or LatLong

Rank

integer · int32 · required

Number applied to locations set by factors such as population, political importance, and geographic size

LocalizedName

string · minLength: 1 · required

Display name in local dialect set with language code in URL. Default is US English (us-en)

required

THe object containing the country details

required

The object containing the amdministrative area details

The object containing the parentcity details. This object will be displayed only if the location is part of a larger metropolitan area or parent city.

AccuWeather related details about the specific location

GET/locations/v1/geoposition/search

curl 'https://dataservice.accuweather.com/locations/v1/geoposition/search?q=<string>' \
  --header 'Authorization: <api-key>'

Example Responses

[
  {
    "PrimaryPostalCode": "PrimaryPostalCode",
    "Region": {},
    "TimeZone": {},
    "GeoPosition": {},
    "IsAlias": true,
    "ParentCity": {},
    "SupplementalAdminAreas": [
      {
        "Level": 0,
        "LocalizedName": "LocalizedName",
        "EnglishName": "EnglishName"
      }
    ],
    "DataSets": [
      "string"
    ],
    "Details": {},
    "EnglishName": "EnglishName",
    "Version": 0,
    "Key": "Key",
    "Type": "Type",
    "Rank": 0,
    "LocalizedName": "LocalizedName",
    "Country": {},
    "AdministrativeArea": {}
  }
]

json

application/json

Point of interest by latitude, longitude

GET

https://dataservice.accuweather.com

/locations/v1/poi/geoposition/search

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

Point of interest by latitude, longitude › query Parameters

q

string · required

A string that identifies the central location from which to search. Provide the coordinates as latitude,longitude in decimal format.

Example: 40.779,-73.969

language

string

A string that indicates the language in which to return the response. More information can be found here.

Default: en-us

details

boolean

A boolean value that specifies whether or not to include extended information.

Default: false

format

string

A string value that specifies what type of format to provide the response.

Default: json

topLevel

boolean

Default: false

Point of interest by latitude, longitude › Headers

Authorization

string · required

The Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.

Point of interest by latitude, longitude › Responses

API.Locations.Entities.OpenAPI.Location

PrimaryPostalCode

string · minLength: 1 · required

Official postal code provided by our main location data provider for the requested location

required

The object containing the region details

required

The object containing the timezone details

required

The object containing the geoposition details

IsAlias

boolean · required

“True” or “false” verification of whether a location is an “alias” or an alternative name or spelling for a requested location

API.Locations.Entities.OpenAPI.SupplementalAdminArea[] · required

The object containing a list of administrative area details

DataSets

string[] · required

EnglishName

string · minLength: 1 · required

Location name as displayed in English

Version

integer · int32 · required

Current version of the API

Key

string · minLength: 1 · required

Unique ID to search a location

Type

string · minLength: 1 · required

Location type such as City, PostalCode, POI or LatLong

Rank

integer · int32 · required

Number applied to locations set by factors such as population, political importance, and geographic size

LocalizedName

string · minLength: 1 · required

Display name in local dialect set with language code in URL. Default is US English (us-en)

required

THe object containing the country details

required

The object containing the amdministrative area details

The object containing the parentcity details. This object will be displayed only if the location is part of a larger metropolitan area or parent city.

AccuWeather related details about the specific location

Text Search IP Address