City Translation

City translation by country code, admin code, and name search

GET

https://dataservice.accuweather.com

/locations/v1/cities/{countryCode}/{adminCode}/translate

Specify a country code, admin code, and city name to return translated location information.

City translation by country code, admin code, and name search › path Parameters

countryCode

string

A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.

Example: US

adminCode

string

A unique ID that designates a specific administrative area. More information can be found here.

Example: NY

City translation by country code, admin code, and name search › query Parameters

q

string · required

A string that indicates a city name to search by.

Example: New York

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

offset

integer · int32

A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.

Default: -1

alias

A numerical value indicating the mode of alias searching (0=Always, 1=Never, 2=No Official Match). No official match indicates an alias could be returned if no official location could be found.

Default: 2

City translation by country code, admin code, and name search › Headers

Authorization

string · required

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

City translation by country code, admin code, and name search › 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

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

GET/locations/v1/cities/{countryCode}/{adminCode}/translate

curl 'https://dataservice.accuweather.com/locations/v1/cities/:countryCode/:adminCode/translate?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

City translation by country code and city name

GET

https://dataservice.accuweather.com

/locations/v1/cities/{countryCode}/translate

Specify a country code and city name to return translated location information.

City translation by country code and city name › path Parameters

countryCode

string

A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.

Example: US

City translation by country code and city name › query Parameters

q

string · required

A string that indicates a city name to search by.

Example: New York

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

offset

integer · int32

A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.

Default: -1

adminCode

string

A unique ID that designates a specific administrative area. More information can be found here.

Example: NY

alias

A numerical value indicating the mode of alias searching (0=Always, 1=Never, 2=No Official Match). No official match indicates an alias could be returned if no official location could be found.

Default: 2

City translation by country code and city name › Headers

Authorization

string · required

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

City translation by country code and city name › 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/cities/{countryCode}/translate

curl 'https://dataservice.accuweather.com/locations/v1/cities/:countryCode/translate?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

City translation by city name

GET

https://dataservice.accuweather.com

/locations/v1/cities/translate

Specify a city name to return translated location information.

City translation by city name › query Parameters

q

string · required

A string that indicates a city name to search by.

Example: New York

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

offset

integer · int32

A numerical value representing the first result to return. Results will be returned in sets of 25. Offset=0 will return the first 25 results, Offset=1 will return the second 25 results, etc.

Default: -1

countryCode

string

A unique ISO or Microsoft Localization Code for a specific country. More information can be found here.

Example: US

adminCode

string

A unique ID that designates a specific administrative area. More information can be found here.

Example: NY

alias

A numerical value indicating the mode of alias searching (0=Always, 1=Never, 2=No Official Match). No official match indicates an alias could be returned if no official location could be found.

Default: 2

City translation by city name › Headers

Authorization

string · required

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

City translation by city name › 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/cities/translate

curl 'https://dataservice.accuweather.com/locations/v1/cities/translate?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

Text Search Geoposition