Impacts
https://data.api.xweather.com/impacts/:activity/
The Impacts endpoint evaluates current and short-term meteorological conditions to forecast their influences on diverse activities. It systematically analyzes variables such as lightning incidence, extreme temperature fluctuations, air quality metrics, severe weather events, high wind speeds, and road weather conditions to assess associated risks for outdoor activities, freight transport, maritime shipping, and small craft operations, thereby providing real-time impact analyses.
This endpoint is currently in beta.
Activity | Description |
---|---|
general | A generalized category that would impact most outdoor activities. Risks associated with this activity will include lightning, wind, rain, snow, convection, and air quality. |
roadway_trucking | The roadway trucking activity will provide risks related to rollover, hydroplaning, visibility, EV range, convection, and snow. |
maritime_small_craft | The small craft activity focuses on wave height, swell height, wind, lightning, and convection. |
maritime_large_vessel | Utilized for marine logistics or cruise ships, the risk factors being considered here include: wave height, swell height, visibility, wind, and extreme temperature. |
Requests
Every request to the endpoint must include one of the supported actions in the url.
https://data.api.xweather.com/impacts/:activity/{action}?client_id={client_id}&client_secret={client_secret}&{params}
Supported Actions
The following actions are supported with the /impacts/:activity endpoint:
Action | Description |
---|---|
:id | Type: 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. |
route | Type: stringAllows you to pass several coordinates along a custom route to return data points at each location. 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.
periods.#.timestamp (number)
UNIX timestamp of the period.
periods.#.dateTimeISO (string)
ISO 8601 date of the period.
periods.#.impacts (array)
List of risk factors that will impact this location.
periods.#.impacts.#.id (string)
Id for the risk factor.
periods.#.impacts.#.name (string)
Full name of the risk factor.
periods.#.impacts.#.description (string)
Description of the risk.
periods.#.impacts.#.timeFrame (string)
Frame of time this risk is affecting the location.
periods.#.impacts.#.index (number)
Numerical value associated with the risk. Ratings are 0 - 5 with 5 being the greatest risk.
periods.#.impacts.#.category (string)
Categorical name associated with the index. Values include: none (0), minimal (1), low (2), moderate (3), high (4), major (5)
periods.#.impacts.#.weather (object)
The most prominent weather information that helped determined the impact.
periods.#.impacts.#.weather.source (string)
Weather attribute that determined the impact.
periods.#.impacts.#.weather.value (number)
Weather value that determined the impact.
periods.#.impacts.#.weather.unit (string)
Unit of the weather value that determined the impact.
periods.#.impacts.#.weather.timestamp (number)
Unix timestamp of the weather value that determined the impact, to the nearest second.
periods.#.impacts.#.weather.dateTimeISO (string)
ISO 8601 date and time of the weather value that determined the impact.
profile (object)
Object containing information about the location or event.
profile.tz (string)
Timezone name of the location, such as America/New_York
.
profile.tzname (string)
The timezone abbreviation for the location, such as EST
.
profile.tzoffset (number)
The timezone offset for the location in seconds.
profile.isDST (boolean)
True if the location is currently observing Daylight Savings Time (DST), otherwise false.
profile.elevM (number)
The elevation of the location in meters.
profile.elevFT (number)
The elevation of the location in feet.
[
{
"loc": {
"lat": 30.96574,
"long": -86.45967
},
"place": {
"name": "laurel hill",
"state": "fl",
"country": "us"
},
"periods": [
{
"timestamp": 1732042852,
"dateTimeISO": "2024-11-19T13:00:52-06:00",
"impacts": [
{
"id": "NextHourRainRisk",
"name": "Rain Risk",
"description": "Expect rainfall rates of 24.42 mm/h 30-40 minutes from now.",
"timeFrame": "1 hour",
"index": 5,
"category": "major",
"weather": {
"source": "Rainfall Rates",
"value": 24.42,
"unit": "mm/h",
"timestamp": 1732045200,
"dateTimeISO": "2024-11-19T13:40:00-06:00"
}
},
{
"id": "ConvectiveRisk",
"name": "Severe Storms",
"description": "NOAA has issued a marginal risk of severe thunderstorms in the area.",
"timeFrame": "now",
"index": 1,
"category": "minimal",
"weather": {
"source": "Convective Outlook",
"value": "marginal",
"unit": "category",
"timestamp": 1732033800,
"dateTimeISO": "2024-11-19T10:30:00-06:00"
}
}
]
}
],
"profile": {
"tz": "America/Chicago",
"tzname": "CST",
"tzoffset": -21600,
"isDST": false,
"elevM": 86,
"elevFT": 282
}
}
]