Reference

The following is reference documentation when using the Aeris API.

Endpoints

Endpoints refer to the types of data to request, such as a place, observation, forecast or advisory, and will be the basis for any request made to the weather API. The following endpoints are currently supported within Aeris.

Actions

The following are the supported actions with the AerisWeather API. Note that some actions are not supported for certain endpoints. Refer to each endpoint documentation for a list of supported actions for that endpoint.

Supported Places

When calling a weather API endpoint, normally a place/location is provided. The following are the supported place formats that can be passed, normally to the p parameter or used as the :id. All endpoints will allow the following formats, unless specified in the individual endpoint documentation.

Scripting Best Practices

Often times clients will need to gather weather data with automated scripting which typically comes with high volumes in a short time frame. The weather API is ready for your automated queries, but there are a few tips outlined below to help optimize your requests.

Coded Weather

The weather for each period is provided in a coded format to allow for more custom implementations where the provided weather phrasing and icons are not desired. The weatherCoded field provides the complete listing of weather codes broken up by time periods within its parent period, which gives the start times when a particular weather type is expected to begin. A single weather code is given for the entire period in the weatherCodedPrimary field, which is the weather type across all periods with the highest priority.

Icon List

Below is a list of icons that will correlate with the icon property within the Aeris Weather API. You will find our legacy icons in addition to our current icons. To download the list of icons, please visit our downloads page.

Custom Icon Mapping

Use cases where custom icon mapping is required can use the API's weatherCodedPrimary values seen in the Coded Weather docs. These values correlate with the [weather] code which can be either Cloud Codes or Weather Codes. Alternatively, you can use the icon value to map directly to custom icons. The full list of icons available in the API are listed on the Icon List page. There are 3 main ways to go about this listed below.

Last modified: November 12, 2018