GuidesAPI Reference
API Reference

Weather report

Retrieves weather reports, weather forecasts, severe weather alerts.

Query Params
products
array of objects
required

A parameter identifying the type of report to obtain. Comma separated values.

products*
string

Enter a free-text query. Examples: "125, Berliner, berlin", "Beacon, Boston"

string

ZIP code of the location. This parameter is supported only for locations in the United States of America. Latitude and longitude, name, or zipcode must be present.

string

Geographical location in WGS-84-compliant format. Specifying the area covered by the weather report. Format: {lat},{lng}

string
enum
Defaults to metric

Units of measurement used. The default is metric.

Allowed:
boolean
Defaults to false

Boolean, if set to true, the response only includes the closest location. Only available when the product parameter is set to observation. The default is false.

Date for which hourly forecasts are to be retrieved. The format is YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

string
Defaults to en-US

Defines the language used in the descriptions in the response. For example, the response for a query with lang=de-DE has descriptions in German. The default is en-US.

string

Specify the political view. Available territories are seen through the point of view of this country. If this parameter is not specified, the neutral international view is made available, where territories may have unresolved claims. This parameter accepts single ISO 3166-1 alpha-3 country code. The country codes are to be provided in all uppercase. Currently the only supported political view is CHN. Any political view that is unsupported falls back to the default view. For example, politicalView=USA or politicalView=FRA does not impact a response in any way.

Headers
string

User-provided token that can be used to trace a request or a group of requests sent to the service.

Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json