simono41/db-rest
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs for /radar 📝

Browse source
This commit is contained in:
Jannis R 2018-02-26 00:38:35 +01:00
parent 698b625040
commit de5f4ca7f8
No known key found for this signature in database
GPG key ID: 0FE83946296A88A5
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/index.md
View file

@ -163,3 +163,22 @@ Output from [`require('db-hafas').locations(…)`](https://github.com/derhuerst/
curl 'https://1.db.transport.rest/locations?query=Alexanderplatz' curl 'https://1.db.transport.rest/locations?query=Alexanderplatz'
curl 'https://1.db.transport.rest/locations?query=Pestalozzistra%C3%9Fe%2082%2C%20Berlin&poi=false&stations=false' curl 'https://1.db.transport.rest/locations?query=Pestalozzistra%C3%9Fe%2082%2C%20Berlin&poi=false&stations=false'
``` ```
## `GET /radar`
- `north`: **Required.** Northern latitude.
- `west`: **Required.** Western longtidue.
- `south`: **Required.** Southern latitude.
- `east`: **Required.** Eastern longtidue.
- `results`: How many vehicles shall be shown? Default: `256`.
- `duration`: Compute frames for how many seconds? Default: `30`.
- `frames`: Number of frames to compute. Default: `3`.
`Content-Type`: `application/json`
### examples
```shell
curl 'https://1.db.transport.rest/radar?north=52.52411&west=13.41002&south=52.51942&east=13.41709'
```