The Location Service APIs provide the ability to lookup a location name or geocode (latitude and longitude) to retrieve a set of locations matching the request.
The Location Point API provides detailed location data for a specific point on the globe, searchable by: Geocode (Latitude and Longitude), Postal Key (postal code:country code composite), IATA Code, ICAO Code, Place ID (encrypted location identifier), Canonical City ID (city level feature identifier), and Location ID (legacy location identifier).
The Location Point API is most commonly used for GPS-based location searches where a pair of coordinates or known location codes are queried to identify location features and related metadata.
For details on appropriate header values as well as caching and expiration definitions, see the Weather Company Data API Common Usage Guide.
Returns information for a search via a latitude,longitude pair like "33.43,-84.22".
Required: geocode, language, format, apiKey
Optional: locationType
v3-location-pointhttps://api.weather.com/v3/location/point?geocode=33.74,-84.39&language=en-US&format=json&apiKey=yourApiKey
Returns information for a search via a Postal Key like "30339:US". A Postal Key is <Postal Code>:<Country Code>.
Required: postalKey, language, format, apiKey
Optional: locationType
v3-location-pointhttps://api.weather.com/v3/location/point?postalKey=30339:US&language=en-US&format=json&apiKey=yourApiKey
Returns information for a search via an IATA code like "ATL".
Required: iataCode, language, format, apiKey
v3-location-pointhttps://api.weather.com/v3/location/point?iataCode=ATL&language=en-US&format=json&apiKey=yourApiKey
Returns information for a search via an ICAO code like "KATL".
Required: icaoCode, language, format, apiKey
v3-location-pointhttps://api.weather.com/v3/location/point?icaoCode=KATL&language=en-US&format=json&apiKey=yourApiKey
Returns information for a search via a Place ID.
Required: placeid, language, format, apiKey
v3-location-pointhttps://api.weather.com/v3/location/point?placeid=ee0214ae7fb1d265f3e4d2509e77557119b2cac9d0ac1013b593c74a1567f2b7&language=en-US&format=json&apiKey=yourApiKey
Returns information for a search via a Canonical City ID.
Required: canonicalCityId, language, format, apiKey
v3-location-pointhttps://api.weather.com/v3/location/point?canonicalCityId=3e933388e3fb38c28c2d0806165bf7e3185d84bbb370417734798573ee243240&language=en-US&format=json&apiKey=yourApiKey
Returns information for a search via a Location ID like "USWY0183:1:US". This method is no longer actively supported.
Required: locid, language, format, apiKey
v3-location-pointhttps://api.weather.com/v3/location/point?locid=USWY0183:1:US&language=en-US&format=json&apiKey=yourApiKey
| Parameter | Description | Type | Range | Sample |
|---|---|---|---|---|
locationType |
Specify the type(s) of location to return in the request. Determines response granularity. Multiple location types may be requested as comma separated values. Limiting the types requested is recommended for best results. | city, locality, neighborhood, state, address, pws, country, postal, locale, locid | city,locality,neighborhood |
| Type | Description |
|---|---|
country |
Features that have been given a designated country code under ISO 3166-1. |
state |
Top-level sub-national administrative features. "region" is a comparable type. |
district |
Features smaller than states/regions but larger than cities. |
city |
Features generally recognized as cities, villages, municipalities, etc. Typically locations used in postal addressing. Most commonly used for end-user location presentation. |
locality |
Official sub-city features used in postal addressing or commonly known to local residents. |
neighborhood |
Colloquial sub-city features which often lack official administrative status and lack agreed-upon boundaries. |
locale |
A sub-grouping combining district, city, locality, postal, and neighborhood features. Made obsolete by the ability to request multiple location types. |
postal |
Postal codes used in country-specific national addressing systems. |
address |
Individual residential or business addresses. |
airport |
Valid, active airports. Curated internally by The Weather Company. |
pws |
Valid, active Personal Weather Stations. Curated internally by The Weather Company. |
Field names are sorted alphabetically for presentation. This does not represent the sort order of the API response.
| Field | Description | Type | Range | Sample | Nulls |
|---|---|---|---|---|---|
address |
Locale level location detail. | string | Atlanta, Georgia, United States | Y | |
adminDistrict |
The internationalized state, region, district or province identifier (level 1 administrative division). | string | Any valid state, region, district, or province name. | Georgia | Y |
adminDistrictCode |
The identifier code for state or geopolitical area (level 1 administrative division). | string | US states only. | GA | Y |
airportName |
The airport name associated to the (ICAO / IATA) airport code. Only returned when the iataCode or icaoCode query parameter is used. | string | Any valid airport name. | Hartsfield-Jackson Intl | Y |
canonicalCityId |
A city-level place identifier that encompasses lower level place types. Should be used for SEO purposes only. | string | Any valid canonicalCityId | b9561b6ddb213b878ba672863570cf55d936ecb80cacd7fe8c45fe9379288343 | Y |
city |
Full name of location city. | string | Any valid city name. | Atlanta | Y |
country |
Full name of location country. | string | Any valid country name. | United States | Y |
countryCode |
ISO country code. | string | Any valid ISO country code. | US | Y |
countyId |
Governmental assigned county identifier. Internal use only. | string | Any valid County ID | FLC117 | Y |
disputedArea |
Point falls in an area with political sensitivity. | boolean | true, false | false | N |
disputedCountries |
List of countries claiming territory in the provided disputedArea. | [string] | Any valid country name. | ["United States","Canada"] | Y |
disputedCountryCodes |
List of ISO country codes representing the disputedCountries. | [string] | Any valid ISO country code. | ["US", "CA"] | Y |
disputedCustomers |
Customer identifier for custom logic pertaining to areas with political sensitivity. | [array] | Any valid internal code. | [["ABC"],[]] | Y |
disputedShowCountry |
Customer designation for display of country names. | [boolean] | true, false | true | N |
displayContext |
The recommended location context to include with the displayName. | [string] | Any free form string. | GA, United States | Y |
displayName |
The common display name for a location. | string | Any valid location display name. | Atlanta | N |
dmaCd |
DMA Code. Internal use only. A Designated Market Area is a group of counties covered by a specific group of television stations. | string | Any valid DMA Code | 534 | Y |
dstEnd |
The date time when the location ends daylight savings time observation. | ISO | Any valid ISO date time. | 2017-11-05T01:00:00-0500 | Y |
dstStart |
The date time when the location starts daylight savings time observation. | ISO | Any valid ISO date time. | 2017-03-12T03:00:00-0400 | Y |
featureId |
Identifier used for TWC use cases. | string | Unique identifier | place.268863724 | |
iataCode |
IATA airport code of the requested location. Only returned when the iataCode query parameter is used. | string | Any valid IATA code. | ATL | Y |
ianaTimeZone |
The standard IANA Time Zone for the location requested. | string | Any valid IANA time zone or UTC offset. | America/New_York | Y |
icaoCode |
ICAO airport code of the requested location. Only returned when the icaoCode query parameter is used. | string | Any valid ICAO code. | KATL | Y |
latitude |
Center latitude coordinate of the requested location. | decimal | Any valid latitude value. | 33.63 | N |
locId |
Legacy TWC location identifier for compatibility with legacy queries. | string | Any valid locId | USWY0183:1:US | Y |
locationCategory |
A sub-type of the "type" field describing a more specific grouping. Returns non-null only when type="poi". | string | Any valid locationCategory | national park | Y |
longitude |
Center longitude coordinate of the requested location. | decimal | Any valid longitude value. | -84.42 | N |
neighborhood |
The recognized neighborhood name of the requested location. | string | Any valid neighborhood name. | Eagan Park | Y |
placeId |
A unique place identifier. A request using a placeid query parameter is expected to return the same placeid. | string | Unique Place Identifier | 25d07eca1bcda02800c1a9e699d7eb1c8132cad9bc2d6efa8a2531f0ee4a81cd | N |
pollenId |
The pollen station identifier. Only valid in the United States. | string | Any valid pollenId | ATL | Y |
postalCode |
The postal code of the requested location. | string | Any valid postal code. | 30337 | Y |
postalKey |
Composite location identifier key of <Postal Code>:<Country Code>. | string | Any valid postal key value. | 30337:US | Y |
pwsId |
Personal Weather Station identifier. | string | Any valid pwsId | KTXSANMA13 | Y |
regionalSatellite |
A TWC-defined area identifying a satellite region on the globe. | string | Any valid regional satellite value. | se | Y |
tideId |
The tide station identifier. Only available for locations near coastlines. | string | Any valid tideId | 8729511 | Y |
type |
Geospatial definition for the location record. | string | Any valid type | city, address, poi, neighborhood, state | N |
zoneId |
Government assigned location identifier. | string | Any valid zoneId | GAZ033 | Y |
locale |
Object for additional city & sub-city locale information. | object | |||
locale.locale1 |
Broadest sub-city locale information (district). | string | Any valid city or sub-city locale | Lake County | Y |
locale.locale2 |
One level more granular than locale1 (city). | string | Any valid city or sub-city locale | Astor | Y |
locale.locale3 |
One level more granular than locale2 (locality). | string | Any valid city or sub-city locale | Manhatten | Y |
locale.locale4 |
Smallest area locale (neighborhood). | string | Any valid city or sub-city locale | Y |
{
"location": {
"latitude": 29.162,
"longitude": -81.525,
"city": "Astor",
"locale": {
"locale1": "Lake County",
"locale2": "Astor",
"locale3": "Manhatten",
"locale4": null
},
"neighborhood": null,
"adminDistrict": "Florida",
"adminDistrictCode": "FL",
"postalCode": "32102",
"postalKey": "32102:US",
"country": "United States",
"countryCode": "US",
"ianaTimeZone": "America/New_York",
"displayName": "Manhatten",
"displayContext": "Astor, United States",
"dstEnd": "2023-11-05T01:00:00-0500",
"dstStart": "2024-03-10T03:00:00-0400",
"dmaCd": "534",
"placeId": "4911fe91dedcc116bd7ebc5258a098b6bc68bca2b81c326ca329d7965af519bf",
"disputedArea": false,
"disputedCountries": null,
"disputedCountryCodes": null,
"disputedCustomers": null,
"disputedShowCountry": [false],
"canonicalCityId": "d76c26f1eef1099f8fa128c897644e4a158172913748c815d44f660548883aa5",
"countyId": "FLC069",
"locId": "USFL0018:1:US",
"locationCategory": null,
"pollenId": null,
"pwsId": "KFLASTOR16",
"regionalSatellite": "se",
"tideId": "8720832",
"type": "postal",
"zoneId": "FLZ044"
}
}