Actions

Actions

The following are the supported actions with the Xweather 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.

/:id
Typically used for passing a geographical location name or identifier such as city name, lat/long, or even US and Canadian postal codes.
/closest
Based on a location search, the results will be returned in order from closest to farthest.
/search
A generalized action that is determined with the endpoints query parameters.
/within
Uses a circle or polygon, define an area to search for results.
/route
Allows you to pass several coordinates along a custom route to return data points at each location.
/affects
Returns a list of locations that are currently affected by a weather event. Criteria for the location(s) can be determined in your query parameters.
/contains
Used with polygon based products (convective outlook, drought monitor, etc.) to determine if the queried location is inside of an impacted area.
/:all
Designates no action is required and can be omitted from the endpoint request.
EndpointsGetting Started
support

Need help? Contact support (opens in a new tab).

c-question

Have questions? Contact sales (opens in a new tab).

© 2024 Xweather (opens in a new tab)Terms of Service (opens in a new tab)Privacy Policy (opens in a new tab)