AccuWeather · Schema

AutocompleteLocation

A location that can be used to plot on a map.

WeatherForecastsMeteorologyLocation ServicesAir QualityStorms

Properties

Name	Type	Description
locationType	string	Type of location, eg. address or postalcode
city	string	City name of the location, usually used for display purposes when sourcing weather data.
adminCode	string	The admin code for the location.
countryCode	string	County code for the location.
postalCode	string	Postal Code of the location, usually used for display purposes when sourcing weather data.
position	array	City name of the location, usually used for display purposes when sourcing weather data.
name	string	Editable name of the location to display to the user.
longName	string	Longer name of the location to display to the user, typically the full address.
locationSettingsInfo	object	Detailed keys for the location from AccuWeather to aid in weather data retrieval.
source	string	The parent provider of the location.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/accuweather/refs/heads/main/json-schema/accuweather-autocomplete-location-schema.json",
  "title": "AutocompleteLocation",
  "description": "A location that can be used to plot on a map.",
  "type": "object",
  "properties": {
    "locationType": {
      "type": "string",
      "description": "Type of location, eg. address or postalcode",
      "nullable": true,
      "example": "address"
    },
    "city": {
      "type": "string",
      "description": "City name of the location, usually used for display purposes when sourcing weather data.",
      "nullable": true,
      "example": "London"
    },
    "adminCode": {
      "type": "string",
      "description": "The admin code for the location.",
      "nullable": true,
      "example": "PA"
    },
    "countryCode": {
      "type": "string",
      "description": "County code for the location.",
      "nullable": true,
      "example": "US"
    },
    "postalCode": {
      "type": "string",
      "description": "Postal Code of the location, usually used for display purposes when sourcing weather data.",
      "nullable": true
    },
    "position": {
      "type": "array",
      "items": {
        "type": "number",
        "format": "double"
      },
      "description": "City name of the location, usually used for display purposes when sourcing weather data.",
      "nullable": true,
      "example": [
        51.50032,
        -0.145433
      ]
    },
    "name": {
      "type": "string",
      "description": "Editable name of the location to display to the user.",
      "nullable": true,
      "example": "Buckingham Palace"
    },
    "longName": {
      "type": "string",
      "description": "Longer name of the location to display to the user, typically the full address.",
      "nullable": true,
      "example": "Buckingham Palace, Westminster, London, Greater London GBR"
    },
    "locationSettingsInfo": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique Id created for favorite and recent locations",
          "nullable": true,
          "example": "50603e3f-5433-4d14-9b5f-01c8cf619d9b"
        },
        "locationKey": {
          "type": "string",
          "description": "AccuWeather Surefind location key for this location.",
          "nullable": true,
          "example": "328328"
        },
        "name": {
          "type": "string",
          "description": "Simple name for a location, such as the name of a city",
          "nullable": true,
          "example": "State Collage"
        },
        "longName": {
          "type": "string",
          "description": "Full name for a location, such as the name of an Admin or address",
          "nullable": true,
          "example": "385 Science Park Rd, State College, PA"
        },
        "displayName": {
          "type": "string",
          "description": "Name used to display to the user as the placeholder\r\nThis differece from the LongName since will be sometimes display location name from\r\nthe AW API (Non-english/direct location key serach)",
          "nullable": true,
          "example": "385 Science Park Rd, State College, PA or Eureka, CA USA"
        },
        "stationCode": {
          "type": "string",
          "description": "AccuWeather station code for this location.",
          "nullable": true,
          "example": "EGRB"
        },
        "supportedDataSets": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "AccuWeather list of supported data sets for this location.",
          "nullable": true,
          "example": [
            "AirQualityCurrentConditions",
            "AirQualityForecasts",
            "Alerts",
            "DailyAirQualityForecast",
            "DailyPollenForecast",
            "ForecastConfidence",
            "FutureRadar",
            "MinuteCast",
            "ProximityNotification-Lightning",
            "Radar"
          ]
        },
        "supportsMinuteCast": {
          "type": "boolean",
          "description": "True if a location supports MinuteCast data.",
          "nullable": true,
          "readOnly": true,
          "example": true
        },
        "latitude": {
          "type": "number",
          "description": "Latitude for a location",
          "format": "double",
          "nullable": true
        },
        "longitude": {
          "type": "number",
          "description": "Longitude for a location",
          "format": "double",
          "nullable": true
        },
        "supportsEventConfidence": {
          "type": "boolean",
          "description": "True if a location supports probabilities on weather events.",
          "nullable": true,
          "readOnly": true,
          "example": true
        }
      },
      "additionalProperties": false,
      "description": "Detailed keys for the location from AccuWeather to aid in weather data retrieval."
    },
    "source": {
      "enum": [
        "AccuWeather",
        "Radar",
        "Unknown"
      ],
      "type": "string",
      "description": "The parent provider of the location."
    }
  },
  "additionalProperties": false
}