admar
/
sinoptik
forked from paul/sinoptik
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix missing endpoint in example URLs; tweak text a bit

This commit is contained in:
Paul van Tilburg 2022-03-11 16:09:14 +01:00
parent 32964cea21
commit 80fd9525c4
Signed by untrusted user: paul
GPG Key ID: C6DE073EDA9EEC4D
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -41,11 +41,11 @@ address = "0.0.0.0"
port = 4321
```
## Forecast API
## Forecast API endpoint
The `/forecast` endpoint provides forecasts per requested metric a list of
forecast item which are each comprised of a value and its (UNIX) timestamp.
It does so for a requested location.
The `/forecast` API endpoint provides forecasts per requested metric a list of
forecast item which are each comprised of a value and its (UNIX) timestamp. It
does so for a requested location.
### Locations
@ -73,9 +73,9 @@ When querying, the metrics need to be selected. It can be one of: `AQI`, `NO2`,
Note that the parameter "array" as well as the repeated parameter notations are supported. For example:
```
GET /address=Stationsplein,Utrecht&metrics[]=AQI&metrics[]=pollen
GET /address=Stationsplein,Utrecht&metrics=AQI&metrics=pollen
GET /address=Stationsplein,Utrecht&metrics=all
GET /forecast?address=Stationsplein,Utrecht&metrics[]=AQI&metrics[]=pollen
GET /forecast?address=Stationsplein,Utrecht&metrics=AQI&metrics=pollen
GET /forecast?address=Stationsplein,Utrecht&metrics=all
```
### Response