GuidesAPI Reference
API Reference

Weather report

Retrieves weather reports, weather forecasts, severe weather alerts.

Query Params
product
array of objects
required

A parameter identifying the type of report to obtain.

product*
string

Client application Id (for authentication)).

string

Client application Code (for authentication)).

string

Name of a city. If there is more than one match for the name, then the most populous location is in the response. Country, state and street name can be added to this parameter. Latitude and longitude, name or zipcode must be present.

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.

double

Geographical coordinates in WGS-84-compliant format, specifying the area covered by the weather report. Latitude and longitude, name or zipcode must be present.

double

Geographical coordinates in WGS-84-compliant format, specifying the area covered by the weather report. Latitude and longitude, name or zipcode must be present.

boolean
Defaults to true

Boolean, defines whether metric or imperial units are used in the response. If set to false, the response contains imperial units (feet, inch, Fahrenheit, miles). The default is true.

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-time

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 language=de has descriptions in German. The default is en-US. List of supported languages:

LanguageCode
afrikaansaf-ZA
albaniansq
amharicam-ET
arabicar
armenianhy
assameseas-IN
azerbaijaniaz-AZ
basqueeu
belarusianbe
bengali-bdbn-BD
bengalibn
bosnianbs-BA
bulgarianbg-BG
catalanca
chinese_prczh-CN
chinese_hkzh-HK
chinese_twzh-TW
croatianhr-HR
czechcs-CZ
danishda-DK
dutchnl-NL
englishen
english_usen-US
estonianet-EE
finnishfi-FI
french_cafr-CA
frenchfr
galiciangl
georgianka-GE
germande
greekel-GR
gujaratigu-IN
hausaha
hebrewhe-IL
hindihi-IN
hungarianhu-HU
icelandicis-IS
igboig-NG
indonesianid-ID
italianit
japaneseja-JP
kannadakn-IN
kashmiriks-IN
kazakhkk-KZ
khmerkm-KH
kirghizky-KG
koreanko-KR
laolo-LA
latvianlv-LV
lingalaln
lithuanianlt-LT
macedonianmk-MK
malagasymg-MG
malayms-MY
malayalamml-IN
marathimr-IN
mongolianmn-MN
norwegianno-NO
oriyaor-IN
persian-affa-AF
farsifa
polishpl-PL
portuguese_brpt-BR
portuguesept-PT
punjabipa
pushtops
romanianro-RO
russianru-RU
serbiansr-YU
sesothost
sinhalasi-LK
slovaksk-SK
slovenesl-SI
spanishes-ES
spanish_ames-US
swahilisw
swedishsv
tagalogtl-PH
tamilta
telugu"te-IN "
thaith-TH
tajiktg-TJ
turkishtr-TR
turkmentk
turkmen_latintk
ukrainianuk-UA
urduur
uzbekuz-UZ
vietnamesevi-VN
xhosaxh
yorubayo
zuluzu
string

Specify the political view. Available territories will be 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.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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