This repository has been archived by the owner on Apr 27, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
/
FORECAST-WEATHER-API-BLUEPRINT.apib
684 lines (623 loc) · 34.5 KB
/
FORECAST-WEATHER-API-BLUEPRINT.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
FORMAT: 1A
Weather API
=============================
# General information
This technical document was created for developers who are creating applications based on weather data provided by this API.
This document is using [API blueprint format](https://apiblueprint.org/documentation/).
### Authentication
To access active-warning-service the request has to be authorised with a valid
JWT OAuth 2.0 access token, obtained from the DTN Authorisation server
`https://auth.weather.mg/oauth/token` with according client credentials. The
required scope is `point-forecast`.
The documentation about how to authenticate against DTN Weather API with
OAuth 2.0 can be found here: [Weather API documentation](https://github.com/MeteoGroup/weather-api/blob/master/authorization/Authentication.md)
### Backward compatibility
Every endpoint may add one or more response parameters in the future.
Clients should ignore unknown parameters, to avoid technical issues.
# Group Forecast
## Retrieve weather forecast [/forecast/hourly?locatedAt={locatedAt}&meteoGroupStationIds={stationIds}&fields={fields}&validPeriod={validPeriod}&validFrom={validFrom}{&validUntil}]
#### Example
`https://point-forecast.weather.mg/forecast/hourly?locatedAt=48.2047,11.4513&validPeriod=PT0S,PT1H,PT3H,PT12H,PT24H&validFrom=2016-11-24T11:00:00Z&validUntil=2016-11-29T11:00:00Z&fields=dewPointTemperatureInCelsius,maxAirTemperatureInFahrenheit,relativeGlobalRadiationInPercent,evaporationMakkinkInMillimeter,visibilityProbabilityLessThan200MeterInPercent`
### Search for forecast data from weather stations for multiple given locations [GET]
You can request forecast for locations or for concrete meteostations IDs. There are two request parameters: 'locatedAt' and 'meteoGroupStationIds'. One of these parameters must be included in the request. You can't use both of them in one request.
For any requested location a relevant station is searched.
The searching algorithm stops at a maximum distance of 100km (between requested location and station).
By default, the latest known weather forecast data from a relevant station is returned.
If validFrom and validUntil are missing then application sets validFrom as current time and validUntil as current time plus 1 day.
if validFrom is not missing and validUntil is missing then application sets validUntil as current time plus 1 day.
It's possible to search forecast data either by geographical locations (long,lat) using 'locatedAt' request parameter or by DTN station IDs using 'meteoGroupStationIds' parameter.
*Meteorological hints*
The forecasted parameters always have a time period associated, which is typically one hour and one moment.
Each weather parameter refers implicitly to one or another time period within a forecast.
For example air temperature is forecasted for one moment in time.
Whereas max air temperature is typically forecasted for a period of one hour.
There are other forecast periods possible, where parameters than are aggregated among e.g. 12 hours.
In the response JSON document the weather parameters will be associated with their according period.
All aggregated weather parameters (e.g. `maxAirTemperatureInCelsius`) are calculated at fixed hours as follows:
PT1H - every hour
PT3H - at 00:00, 03:00, 06:00, 09:00, 12:00, 15:00, 18:00 and 21:00
PT6H - at 00:00, 06:00, 12:00 and 18:00
PT12H - at 06:00 and 18:00
PT24H - at 00:00
By default they are calculated either in a time zone of a requested location or in a time zone of a meteo station
when requesting forecast by `locatedAt` or `meteoGroupStationIds` correspondingly. `validFrom` and `validUntil`
will also be presented in a time zone of location or station.
If a user specifies the 'timeZone' parameter, all aggregated weather parameters will be calculated at fixed hours
of this time zone and `validFrom` and `validUntil` will be presented in it.
*Technical hints*
All timestamps and time periods/durations follow ISO8601 standard notation.
For example 'PT1H' refers to one hour and 'PT0S' refers to one moment.
For convenience reasons, a single location can be requested, but the response always returns a collection.
For multiple locations, its recommended to just use the point compression.
The forecasts in the response collection are "flat" to allow easy streaming and filtering on client side.
The forecasts in the response are ordered ascending by field 'validFrom'.
*Fields mapping*
Common names of filed which can be included in all periods: locatedAt,meteoGroupStationId,meteoGroupStationName,stationLocation,stationTimeZoneName,validFrom,validUntil,validPeriod,issuedAt
Here are relationship between observation periods and fields appropriately:
- **PT0S** - airTemperatureInCelsius,airTemperatureInFahrenheit,airTemperatureInKelvin,dewPointTemperatureInCelsius,dewPointTemperatureInFahrenheit,
dewPointTemperatureInKelvin,feelsLikeTemperatureInCelsius,feelsLikeTemperatureInFahrenheit,feelsLikeTemperatureInKelvin,airPressureAtSeaLevelInHectoPascal,
windSpeedInMeterPerSecond,windSpeedInKnots,windSpeedInMilesPerHour,windSpeedInBeaufort,windSpeedInKilometerPerHour,windDirectionInDegree,
effectiveCloudCoverInOkta,effectiveCloudCoverInPercent,totalCloudCoverInOkta,cloudCoverLowerThan2000MeterInOkta,cloudCoverLowerThan5000MeterInOkta,cloudBaseHeightInMeter,relativeHumidityInPercent,
visibilityInMeter,weatherCode,weatherCodeTraditional,clearSkyUVIndex,uvIndexWithClouds,airTemperatureErrorInKelvin,windSpeedErrorInKnots,freezingLevelHeightInMeter,
freezingRainProbabilityInPercent,noSnowPossibleBelowHeightInMeter,snowCertainAboveHeightInMeter,saturationDeficitInHectoPascal,
airTemperatureNearGroundInCelsius,visibilityProbabilityLessThan200MeterInPercent,visibilityProbabilityLessThan1000MeterInPercent,
convectivePrecipitationProbabilityInPercent,precipitationProbabilityInPercent,precipitationType,hailProbabilityInPercent,
snowfallProbabilityInPercent,thunderstormProbabilityInPercent,condensationIndicator
- **PT1H** - maxWindGustInMeterPerSecond,maxWindGustInKnots,maxWindGustInMilesPerHour,maxWindGustInKilometerPerHour,
sunshineDurationInMinutes,precipitationAmountInMillimeter,precipitationAmountInInch,
maxPrecipitationAmountInMillimeter,directRadiationInJoulePerSquareCentimeter,globalRadiationInJoulePerSquareCentimeter,averageGlobalRadiationInWattPerSquareMeter,relativeGlobalRadiationInPercent,
freshSnowfallInCentimeter,maxFreshSnowfallInCentimeter,relativeSunshineDurationInPercent,windGustProbabilityGreaterThan40KnotsInPercent,netRadiationInJoulePerCentimeterSquare
- **PT3H** - maxWindSpeedInMeterPerSecond,maxWindSpeedInKnots,maxWindSpeedInMilesPerHour,maxWindSpeedInKilometerPerHour,
maxWindGustInMeterPerSecond,maxWindGustInKnots,maxWindGustInMilesPerHour,maxWindGustInKilometerPerHour,dominantWindDirectionInDegree,
minAirTemperatureInCelsius,minAirTemperatureInFahrenheit,minAirTemperatureInKelvin,maxAirTemperatureInCelsius,maxAirTemperatureInFahrenheit,
maxAirTemperatureInKelvin,mostLikelyLowAirTemperatureInCelsius,mostLikelyLowAirTemperatureInFahrenheit,mostLikelyLowAirTemperatureInKelvin,
minFeelsLikeTemperatureInCelsius,minFeelsLikeTemperatureInFahrenheit,minFeelsLikeTemperatureInKelvin,
maxFeelsLikeTemperatureInCelsius,maxFeelsLikeTemperatureInFahrenheit,maxFeelsLikeTemperatureInKelvin,
mostLikelyHighAirTemperatureInCelsius,mostLikelyHighAirTemperatureInFahrenheit,mostLikelyHighAirTemperatureInKelvin,weatherCode,weatherCodeTraditional,
averageRelativeHumidityInPercent,averageWindSpeedInMeterPerSecond,averageWindSpeedInKnots,averageWindSpeedInMilesPerHour,averageWindSpeedInBeaufort,
averageWindSpeedInKilometerPerHour,averageAirPressureAtSeaLevelInHectoPascal,precipitationProbabilityInPercent,maxUVIndexWithClouds,minVisibilityInMeter
- **PT6H** - maxWindSpeedInMeterPerSecond,maxWindSpeedInKnots,maxWindSpeedInMilesPerHour,maxWindSpeedInKilometerPerHour,
maxWindGustInMeterPerSecond,maxWindGustInKnots,maxWindGustInMilesPerHour,maxWindGustInKilometerPerHour,dominantWindDirectionInDegree,
minAirTemperatureInCelsius,minAirTemperatureInFahrenheit,minAirTemperatureInKelvin,maxAirTemperatureInCelsius,maxAirTemperatureInFahrenheit,
maxAirTemperatureInKelvin,mostLikelyLowAirTemperatureInCelsius,mostLikelyLowAirTemperatureInFahrenheit,mostLikelyLowAirTemperatureInKelvin,
mostLikelyHighAirTemperatureInCelsius,mostLikelyHighAirTemperatureInFahrenheit,mostLikelyHighAirTemperatureInKelvin,weatherCode,weatherCodeTraditional,
minFeelsLikeTemperatureInCelsius,minFeelsLikeTemperatureInFahrenheit,minFeelsLikeTemperatureInKelvin,
maxFeelsLikeTemperatureInCelsius,maxFeelsLikeTemperatureInFahrenheit,maxFeelsLikeTemperatureInKelvin,
precipitationAmountInMillimeter,precipitationAmountInInch,maxPrecipitationAmountInMillimeter,minPrecipitationAmountInMillimeter,
precipitationProbabilityMoreOrEqualThan0_1MillimeterInPercent,precipitationProbabilityMoreThan0_2MillimeterInPercent,
precipitationProbabilityMoreThan4_4MillimeterInPercent,precipitationProbabilityInPercent,
precipitationDurationInMinutes,freshSnowfallInCentimeter,maxFreshSnowfallInCentimeter,effectiveCloudCoverInOkta,effectiveCloudCoverInPercent,averageRelativeHumidityInPercent,
averageWindSpeedInMeterPerSecond,averageWindSpeedInKnots,averageWindSpeedInMilesPerHour,averageWindSpeedInBeaufort,averageWindSpeedInKilometerPerHour,
averageAirPressureAtSeaLevelInHectoPascal,maxUVIndexWithClouds,minVisibilityInMeter
- **PT12H** - maxWindSpeedInMeterPerSecond,maxWindSpeedInKnots,maxWindSpeedInMilesPerHour,maxWindSpeedInKilometerPerHour,
maxWindGustInMeterPerSecond,maxWindGustInKnots,maxWindGustInMilesPerHour,maxWindGustInKilometerPerHour,dominantWindDirectionInDegree,
minAirTemperatureInCelsius,minAirTemperatureInFahrenheit,minAirTemperatureInKelvin,maxAirTemperatureInCelsius,maxAirTemperatureInFahrenheit,
maxAirTemperatureInKelvin,mostLikelyLowAirTemperatureInCelsius,mostLikelyLowAirTemperatureInFahrenheit,mostLikelyLowAirTemperatureInKelvin,
mostLikelyHighAirTemperatureInCelsius,mostLikelyHighAirTemperatureInFahrenheit,mostLikelyHighAirTemperatureInKelvin,weatherCode,weatherCodeTraditional,
minFeelsLikeTemperatureInCelsius,minFeelsLikeTemperatureInFahrenheit,minFeelsLikeTemperatureInKelvin,
maxFeelsLikeTemperatureInCelsius,maxFeelsLikeTemperatureInFahrenheit,maxFeelsLikeTemperatureInKelvin,
convectivePrecipitationProbabilityInPercent,precipitationAmountInMillimeter,precipitationAmountInInch,
maxPrecipitationAmountInMillimeter,minPrecipitationAmountInMillimeter,precipitationProbabilityMoreOrEqualThan0_1MillimeterInPercent,
precipitationProbabilityMoreThan0_2MillimeterInPercent,precipitationProbabilityMoreThan1_4MillimeterInPercent,precipitationProbabilityMoreThan4_4MillimeterInPercent,
precipitationProbabilityMoreThan20MillimeterInPercent,precipitationProbabilityInPercent,thunderstormProbabilityInPercent,mostSignificantWeatherCode,
mostSignificantWeatherCodeTraditional,effectiveCloudCoverInOkta,effectiveCloudCoverInPercent,freezingRainProbabilityInPercent,groundFrostProbabilityInPercent,hailProbabilityInPercent,
snowfallProbabilityInPercent,minAirTemperatureNearGroundInCelsius,averageRelativeHumidityInPercent,averageWindSpeedInMeterPerSecond,averageWindSpeedInKnots,
averageWindSpeedInMilesPerHour,averageWindSpeedInBeaufort,averageWindSpeedInKilometerPerHour,averageAirPressureAtSeaLevelInHectoPascal,
maxUVIndexWithClouds,minVisibilityInMeter
- **PT24H** - maxWindSpeedInMeterPerSecond,maxWindSpeedInKnots,maxWindSpeedInMilesPerHour,maxWindSpeedInKilometerPerHour,
maxWindGustInMeterPerSecond,maxWindGustInKnots,maxWindGustInMilesPerHour,maxWindGustInKilometerPerHour,dominantWindDirectionInDegree,
minAirTemperatureInCelsius,minAirTemperatureInFahrenheit,minAirTemperatureInKelvin,maxAirTemperatureInCelsius,maxAirTemperatureInFahrenheit,
maxAirTemperatureInKelvin,mostLikelyLowAirTemperatureInCelsius,mostLikelyLowAirTemperatureInFahrenheit,mostLikelyLowAirTemperatureInKelvin,
mostLikelyHighAirTemperatureInCelsius,mostLikelyHighAirTemperatureInFahrenheit,mostLikelyHighAirTemperatureInKelvin,
minFeelsLikeTemperatureInCelsius,minFeelsLikeTemperatureInFahrenheit,minFeelsLikeTemperatureInKelvin,
maxFeelsLikeTemperatureInCelsius,maxFeelsLikeTemperatureInFahrenheit,maxFeelsLikeTemperatureInKelvin,
precipitationAmountInMillimeter,precipitationAmountInInch,maxPrecipitationAmountInMillimeter,minPrecipitationAmountInMillimeter,
precipitationProbabilityMoreOrEqualThan0_1MillimeterInPercent,precipitationProbabilityMoreThan0_2MillimeterInPercent,
precipitationProbabilityMoreThan4_4MillimeterInPercent,precipitationProbabilityInPercent,mostSignificantWeatherCode,mostSignificantWeatherCodeTraditional,
evaporationMakkinkInMillimeter,evaporationPenmanInMillimeter,mostSignificantPrecipitationType,saturationDeficitInHectoPascal,sunshineDurationInMinutes,
relativeSunshineDurationInPercent,globalRadiationInJoulePerSquareCentimeter,averageGlobalRadiationInWattPerSquareMeter,averageRelativeHumidityInPercent,averageWindSpeedInMeterPerSecond,
averageWindSpeedInKnots,averageWindSpeedInMilesPerHour,averageWindSpeedInBeaufort,averageWindSpeedInKilometerPerHour,averageAirPressureAtSeaLevelInHectoPascal,
maxUVIndexWithClouds,minVisibilityInMeter
+ The "weatherCode" parameter refers to: [this code table](FORECAST-WEATHER-API-WeatherCode.md).
+ The "weatherCodeTraditional" parameter refers to the WMO code table "4677".
+ The mostLikelyHighAirTemperature equals maxAirTemperature plus airTemperatureError.
+ The mostLikelyLowAirTemperature equals minAirTemperature minus airTemperatureError.
+ The maxUVIndexWithClouds parameter is calculated based on clearSkyUVIndex and effectiveCloudCoverInOkta values
+ The minVisibilityInMeter parameters for PT3H, PT6H, PT12H and PT24H are calculated as a min value of the visibilityInMeter parameter from PT0S for the last 3, 6, 12 and 24 hours respectively,
including marginal values. E.g for PT3H period 4 PT0S values are used to cover the full three hours (validUntil-3h,validUntil-2h,validUntil-1h and validUntil).
+ The min/max FeelsLikeTemperatureIn Celsius/Fahrenheit/Kelvin parameters for PT3H, PT6H, PT12H and PT24H are calculated as a min/max value of the feelsLikeTemperatureIn Celsius/Fahrenheit/Kelvin parameter from PT0S for the last 3, 6, 12 and 24 hours respectively, including marginal values. E.g for PT3H period 4 PT0S values are used to cover the full three hours (validUntil-3h,validUntil-2h,validUntil-1h and validUntil).
### Forecasted weather for a given *latitude* and *longitude* [GET]
#### Example
'https://point-forecast.weather.mg/forecast/hourly?locatedAt=-16.78,32.69&validPeriod=PT0S,PT1H,PT3H,PT6H,PT12H,PT24H&validFrom=2016-12-13T05:00:00Z&validUntil=2016-12-13T06:00:00Z&fields=dewPointTemperatureInCelsius,feelsLikeTemperatureInCelsius,maxAirTemperatureInFahrenheit,relativeGlobalRadiationInPercent,evaporationMakkinkInMillimeter,visibilityProbabilityLessThan200MeterInPercent,weatherCode,locatedAt,saturationDeficitInHectoPascal,precipitationProbabilityMoreThan4_4MillimeterInPercent'
+ Parameters
+ locatedAt: `-16.78,32.69` (string, required) - longitude, latitude; can occur multiple times for multiple locations
+ fields: `dewPointTemperatureInCelsius,feelsLikeTemperatureInCelsius,maxAirTemperatureInFahrenheit,relativeGlobalRadiationInPercent,evaporationMakkinkInMillimeter,visibilityProbabilityLessThan200MeterInPercent,weatherCode,locatedAt,saturationDeficitInHectoPascal,precipitationProbabilityMoreThan4_4MillimeterInPercent,precipitationProbabilityInPercent` (string, required) - comma separated list of parameters to be contained inside response
+ validFrom: `2016-12-13T05:00:00Z` (string, optional) - ISO8601 timestamp notation, means incl. this timestamp; always provide a time offset, e.g. 'Z' for UTC; optional: a request may provide correct offset (so that server can convert to UTC).
+ validUntil: `2016-12-13T06:00:00Z` (string, optional) - ISO8601 timestamp notation, means incl. this timestamp; always provide a time offset, e.g. 'Z' for UTC; optional: a request may provide correct offset (so that server can convert to UTC).
+ validPeriod: `PT0S,PT1H,PT3H,PT6H,PT12H,PT24H` (string, required) - comma separated list of periods to be retrieved. PT1H refers to one hour forecast periods.
+ Response 200 (application/json)
+ Headers
Content-Type:application/json
Last-Modified:Tue, 03 Jan 2017 09:29:41 GMT
Cache-Control: max-age=90
+ Body
{
"forecasts":[
{
"dewPointTemperatureInCelsius":11.9,
"feelsLikeTemperatureInCelsius":16.8,
"visibilityProbabilityLessThan200MeterInPercent":1,
"weatherCode":1,
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T05:00:00Z",
"saturationDeficitInHectoPascal":3.9,
"validFrom":"2016-12-13T05:00:00Z",
"validPeriod":"PT0S",
"precipitationProbabilityInPercent":1
},
{
"relativeGlobalRadiationInPercent":95,
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T05:00:00Z",
"validFrom":"2016-12-13T04:00:00Z",
"validPeriod":"PT1H",
"precipitationProbabilityInPercent":1
},
{
"dewPointTemperatureInCelsius":12,
"feelsLikeTemperatureInCelsius":17.1,
"visibilityProbabilityLessThan200MeterInPercent":1,
"weatherCode":1,
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T06:00:00Z",
"saturationDeficitInHectoPascal":4.1,
"validFrom":"2016-12-13T06:00:00Z",
"validPeriod":"PT0S",
"precipitationProbabilityInPercent":1
},
{
"relativeGlobalRadiationInPercent":94,
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T06:00:00Z",
"validFrom":"2016-12-13T05:00:00Z",
"validPeriod":"PT1H",
"precipitationProbabilityInPercent":1
},
{
"maxAirTemperatureInFahrenheit":60.6,
"weatherCode":1,
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T06:00:00Z",
"validFrom":"2016-12-13T03:00:00Z",
"validPeriod":"PT3H",
"precipitationProbabilityInPercent":2
},
{
"maxAirTemperatureInFahrenheit":62.2,
"weatherCode":1,
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T06:00:00Z",
"precipitationProbabilityMoreThan4_4MillimeterInPercent":0,
"validFrom":"2016-12-13T00:00:00Z",
"validPeriod":"PT6H",
"precipitationProbabilityInPercent":2
},
{
"maxAirTemperatureInFahrenheit":65.7,
"weatherCode":1,
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T06:00:00Z",
"precipitationProbabilityMoreThan4_4MillimeterInPercent":0,
"validFrom":"2016-12-12T18:00:00Z",
"validPeriod":"PT12H",
"precipitationProbabilityInPercent":4
},
{
"maxAirTemperatureInFahrenheit":68.2,
"evaporationMakkinkInMillimeter":2,
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T06:00:00Z",
"precipitationProbabilityMoreThan4_4MillimeterInPercent":0,
"saturationDeficitInHectoPascal":5.6,
"validFrom":"2016-12-12T06:00:00Z",
"validPeriod":"PT24H",
"precipitationProbabilityInPercent":8
}
]
}
# Example 2:
### Forecasted weather for a given collection of *latitude* and *longitude* pairs, compressed by Point Compression Algorithm [GET]
+ Parameters
+ locatedAt: `463pklwwsB4-4jtN81qz8hR` (string, optional) - compressed list of station locations, using Microsoft Point Compression Algorithm, is efficient for up to 400 locations
+ fields: `precipitationProbabilityInPercent,maxWindSpeedInKnots,stationTimeZoneName` (string, required) - comma separated list of parameters to be contained inside response
+ validFrom: `2016-12-13T00:00:00Z` (string, optional) - ISO8601 timestamp notation, means incl. this timestamp; always provide a time offset, e.g. 'Z' for UTC; optional: a request may provide correct offset (so that server can convert to UTC).
+ validUntil: `2016-12-13T06:00:00Z` (string, optional) - ISO8601 timestamp notation, means incl. this timestamp; always provide a time offset, e.g. 'Z' for UTC; optional: a request may provide correct offset (so that server can convert to UTC).
+ validPeriod: `PT6H,PT24H` (string, required) - comma separated list of periods to be retrieved. use iso8601 time duration notation. PT1H refers one hour forecast periods.
+ timeZone: `+02:00` (string, optional) - a time-zone ID or offset, such as `Europe/Paris`, `-01:00` etc.
+ Response 200 (application/json)
+ Headers
Content-Type:application/json
Last-Modified:Mon, 26 Dec 2016 14:28:05 GMT
Cache-Control: max-age=90
+ Body
{
"forecasts":[
{
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T02:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-12T20:00:00+02:00",
"validPeriod":"PT6H",
"precipitationProbabilityInPercent":4,
"maxWindSpeedInKnots":4.7
},
{
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T02:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-12T02:00:00+02:00",
"validPeriod":"PT24H",
"precipitationProbabilityInPercent":8,
"maxWindSpeedInKnots":8.8
},
{
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T08:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-13T02:00:00+02:00",
"validPeriod":"PT6H",
"precipitationProbabilityInPercent":2,
"maxWindSpeedInKnots":3.9
},
{
"locatedAt":[
-16.78,
32.69
],
"validUntil":"2016-12-13T08:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-12T08:00:00+02:00",
"validPeriod":"PT24H",
"precipitationProbabilityInPercent":8,
"maxWindSpeedInKnots":7.2
},
{
"locatedAt":[
-16.89,
32.65
],
"validUntil":"2016-12-13T02:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-12T20:00:00+02:00",
"validPeriod":"PT6H",
"precipitationProbabilityInPercent":1,
"maxWindSpeedInKnots":4.3
},
{
"locatedAt":[
-16.89,
32.65
],
"validUntil":"2016-12-13T02:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-12T02:00:00+02:00",
"validPeriod":"PT24H",
"precipitationProbabilityInPercent":5,
"maxWindSpeedInKnots":5.1
},
{
"locatedAt":[
-16.89,
32.65
],
"validUntil":"2016-12-13T08:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-13T02:00:00+02:00",
"validPeriod":"PT6H",
"precipitationProbabilityInPercent":1,
"maxWindSpeedInKnots":3.7
},
{
"locatedAt":[
-16.89,
32.65
],
"validUntil":"2016-12-13T08:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-12T08:00:00+02:00",
"validPeriod":"PT24H",
"precipitationProbabilityInPercent":2,
"maxWindSpeedInKnots":5.1
},
{
"locatedAt":[
-16.35,
33.067
],
"validUntil":"2016-12-13T02:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-12T20:00:00+02:00",
"validPeriod":"PT6H",
"precipitationProbabilityInPercent":2,
"maxWindSpeedInKnots":4.7
},
{
"locatedAt":[
-16.35,
33.067
],
"validUntil":"2016-12-13T02:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-12T02:00:00+02:00",
"validPeriod":"PT24H",
"precipitationProbabilityInPercent":3,
"maxWindSpeedInKnots":8.8
},
{
"locatedAt":[
-16.35,
33.067
],
"validUntil":"2016-12-13T08:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-13T02:00:00+02:00",
"validPeriod":"PT6H",
"precipitationProbabilityInPercent":1,
"maxWindSpeedInKnots":4.3
},
{
"locatedAt":[
-16.35,
33.067
],
"validUntil":"2016-12-13T08:00:00+02:00",
"stationTimeZoneName":"Atlantic/Madeira",
"validFrom":"2016-12-12T08:00:00+02:00",
"validPeriod":"PT24H",
"precipitationProbabilityInPercent":3,
"maxWindSpeedInKnots":6.8
}
]
}
# Example 3:
### Forecasted weather for multiple stations [GET]
+ Parameters
+ meteoGroupStationIds: `8521,8522` (string, optional) - comma separated list of required meteostaions IDs.
+ fields: `maxWindGustInMeterPerSecond,sunshineDurationInMinutes,precipitationAmountInMillimeter` (string, required) - comma separated list of parameters to be contained inside the response
+ validFrom: `2016-12-13T11:00:00Z` (string, optional) - ISO8601 timestamp notation, means incl. this timestamp; always provide a time offset, e.g. 'Z' for UTC; optional: a request may provide correct offset (so that server can convert to UTC).
+ validUntil: `2016-12-13T12:00:00Z` (string, optional) - ISO8601 timestamp notation, means incl. this timestamp; always provide a time offset, e.g. 'Z' for UTC; optional: a request may provide correct offset (so that server can convert to UTC).
+ validPeriod: `PT1H` (string, required) - comma separated list of periods to be retrieved. use iso8601 time duration notation. PT1H refers one hour forecast periods.
+ Response 200 (application/json)
+ Headers
Content-Type:application/json
Last-Modified:Mon, 26 Dec 2016 14:28:05 GMT
Cache-Control: max-age=90
+ Body
{
"forecasts":[
{
"sunshineDurationInMinutes":37,
"maxWindGustInMeterPerSecond":4.2,
"meteoGroupStationId":"8521",
"precipitationAmountInMillimeter":0,
"validUntil":"2016-12-13T11:00:00Z",
"validFrom":"2016-12-13T10:00:00Z",
"validPeriod":"PT1H"
},
{
"sunshineDurationInMinutes":33,
"maxWindGustInMeterPerSecond":5.5,
"meteoGroupStationId":"8521",
"precipitationAmountInMillimeter":0,
"validUntil":"2016-12-13T12:00:00Z",
"validFrom":"2016-12-13T11:00:00Z",
"validPeriod":"PT1H"
},
{
"sunshineDurationInMinutes":31,
"maxWindGustInMeterPerSecond":4.3,
"meteoGroupStationId":"8522",
"precipitationAmountInMillimeter":0,
"validUntil":"2016-12-13T11:00:00Z",
"validFrom":"2016-12-13T10:00:00Z",
"validPeriod":"PT1H"
},
{
"sunshineDurationInMinutes":28,
"maxWindGustInMeterPerSecond":4.4,
"meteoGroupStationId":"8522",
"precipitationAmountInMillimeter":0,
"validUntil":"2016-12-13T12:00:00Z",
"validFrom":"2016-12-13T11:00:00Z",
"validPeriod":"PT1H"
}
]
}
# Group Aggregations by polygon
For type "Polygon", the "coordinates" member must be an array of LinearRing coordinate arrays.
For Polygons with multiple rings, the first must be the exterior ring and any others must be interior rings or holes.
A LinearRing is closed LineString with 4 or more positions. The first and last positions are equivalent (they represent equivalent points).
Though a LinearRing is not explicitly represented as a GeoJSON geometry type, it is referred to in the Polygon geometry type definition.
More information is here: https://geojson.org/geojson-spec.html#polygon
#### Example - Get maxThunderstormProbabilityInPercent for PT0S period
'https://point-forecast.weather.mg/aggregate?locatedWithin={%22type%22:%22Polygon%22,%22coordinates%22:[[[12,5],[14,531],[13,52.9],[12,5]]]}&validPeriod=PT0S&fields=maxThunderstormProbabilityInPercent&validFrom=2017-08-05T00:00:00Z&validUntil=2017-08-05T03:00:00Z'
+ Parameters
+ locatedWithin: `{"type":"Polygon","coordinates":[[[12,5],[14,531],[13,52.9],[12,5]]]}` (string, required) - JSON polygon geometry object, as defined in GeoJSON
+ validFrom: `2017-08-05T00:00:00Z` (string, required) - ISO8601 timestamp notation, means incl. this timestamp; always provide a time offset, e.g. 'Z' for UTC; optional: a request may provide correct offset (so that server can convert to UTC).
+ validUntil: `2017-08-05T03:00:00Z` (string, required) - ISO8601 timestamp notation, means incl. this timestamp; always provide a time offset, e.g. 'Z' for UTC; optional: a request may provide correct offset (so that server can convert to UTC).
+ validPeriod: `PT0S` (string, required) - comma separated list of periods to be retrieved.
+ fields: `maxThunderstormProbabilityInPercent` (string, required) - comma separated list of parameters to be contained inside response.
+ Response 200 (application/json)
+ Headers
Content-Type:application/json
Cache-Control: max-age=90
+ Body
{
"forecasts": [
{
"locatedWithin": {
"coordinates": [
[
[
12,
5
],
[
14,
531
],
[
13,
52.9
],
[
12,
5
]
]
],
"type": "Polygon"
},
"validUntil": "2017-08-05T00:00:00Z",
"maxThunderstormProbabilityInPercent": 19,
"validFrom": "2017-08-05T00:00:00Z",
"validPeriod": "PT0S"
},
{
"locatedWithin": {
"coordinates": [
[
[
12,
5
],
[
14,
531
],
[
13,
52.9
],
[
12,
5
]
]
],
"type": "Polygon"
},
"validUntil": "2017-08-05T01:00:00Z",
"maxThunderstormProbabilityInPercent": 16,
"validFrom": "2017-08-05T01:00:00Z",
"validPeriod": "PT0S"
},
{
"locatedWithin": {
"coordinates": [
[
[
12,
5
],
[
14,
531
],
[
13,
52.9
],
[
12,
5
]
]
],
"type": "Polygon"
},
"validUntil": "2017-08-05T02:00:00Z",
"maxThunderstormProbabilityInPercent": 12,
"validFrom": "2017-08-05T02:00:00Z",
"validPeriod": "PT0S"
},
{
"locatedWithin": {
"coordinates": [
[
[
12,
5
],
[
14,
531
],
[
13,
52.9
],
[
12,
5
]
]
],
"type": "Polygon"
},
"validUntil": "2017-08-05T03:00:00Z",
"maxThunderstormProbabilityInPercent": 10,
"validFrom": "2017-08-05T03:00:00Z",
"validPeriod": "PT0S"
}
]
}
# Data Structures
## Total Cloud Cover (number)
This symbolic digit shall embrace the total fraction of the celestial dome covered by clouds irrespective of their genus.
(WMO akronym 'N')
Value | Meaning
------|---------
0 | 0 (Sky completely clear)
1 | 1 okta or less, but not zero
2 | 2 oktas
3 | 3 oktas
4 | 4 oktas (Sky half cloudy)
5 | 5 oktas
6 | 6 oktas
7 | 7 oktas
8 | 8 oktas (Sky completely cloudy)
9 | Sky obscured from view (usually due to dense fog or heavy snow)