Phrases Summary

Phrases Summary

URL Path
https://api.aerisapi.com/phrases/summary/
Data Coverage
Global
Update Interval
Near Real Time
Time Range
N/A

The /phrases/summary provides weather summary phrasing based on the latest observations and the forecast over the next few hours for the requested location. The limit parameter can be utilized to control the number of hours the summary phrase covers. The default is 6 hours and the maximum is 12 hours.

Requests

Every request to the endpoint must include one of the supported actions in the url.

https://api.aerisapi.com/phrases/summary/{action}?client_id={client_id}&client_secret={client_secret}&{params}

Supported Actions

The following actions are supported with the /phrases/summary endpoint:

ActionDescription
:idType: stringTypically used for passing a geographical location name or identifier such as city name, lat/long, or even US and Canadian postal codes. Learn more.

Response

The following is an example of what each object in the response will consist of. Depending on your requested action, the response may contain multiple instances of this object within an array.

Properties

loc (object)

The location of the record.

loc.lat (number)

The latitude coordinate of the record.

loc.long (number)

The place or nearest place to the record.

place (object)

Object containing information about the place or nearest place to the record.

place.name (string)

The place or nearest place to the record.

place.state (string)

The state abbreviation in which the response is located. This may be null or an empty string depending on the country.

place.country (string)

The 2 letter ISO-3166 country abbreviation in which the response is located.

profile (object)

Object containing information about the location or event.

profile.tz (string)

Timezone name of the location, such as America/New_York.

phrases (object)

Object containing phrases describing the location or event.

phrases.short (string)

Short version of phrasing using imperial units

phrases.shortMET (string)

Short version of phrasing using metric units

phrases.long (string)

Long version of phrasing using imperial units

phrases.longMET (string)

Long version of phrasing using metric units

[
  {
    "loc": {
      "lat": 44.97997,
      "long": -93.26384
    },
    "place": {
      "name": "minneapolis",
      "state": "mn",
      "country": "us"
    },
    "profile": {
      "tz": "America/Chicago"
    },
    "phrases": {
      "short": "Expect mostly clear skies with temperatures falling to the upper 30s this evening.",
      "shortMET": "Expect mostly clear skies with temperatures falling to 3 degrees this evening.",
      "long": "Expect mostly clear skies with temperatures falling to the upper 30s this evening.",
      "longMET": "Expect mostly clear skies with temperatures falling to 3 degrees this evening."
    }
  }
]