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

Document API response; fix typo

This commit is contained in:
Paul van Tilburg 2022-02-25 15:43:15 +01:00
parent 512f170804
commit dc90f57422
1 changed files with 48 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -43,7 +43,7 @@ port = 4321
## Forecast API
The `/forcast` endpoint provides forecasts per requested metric a list of
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.
@ -78,6 +78,53 @@ GET /address=Stationsplein,Utrecht&metrics=AQI&metrics=pollen
GET /address=Stationsplein,Utrecht&metrics=all
```
### Response
The response of the API is a JSON object that contains three fixed fields:
* `lat`: the latitude of the geocoded position the forecast is for (number)
* `lon`: the longitude of the geocoded position the forecast is for (number)
* `time`: the (UNIX) timestamp of the forecast, basically "now" (number)
Then, it contains a field per requested metric with a list of forecast items
with two fixed fields as value:
* `time`: the (UNIX) timestamp for that forecasted value (number)
* `value`: the forecasted value for the metric (number)
An example when requesting just UVI (because it's short) for some random
position:
```json
{
"lat": 34.567890,
"lon": 1.234567,
"time": 1645800043,
"UVI": [
{
"time": 1645799526,
"value": 1
},
{
"time": 1645885926,
"value": 2
},
{
"time": 1645972326,
"value": 3
},
{
"time": 1646058726,
"value": 2
},
{
"time": 1646145126,
"value": 1
}
]
}
```
## License
Sinoptik is licensed under the MIT license (see the `LICENSE` file or