Add radar to Readme

This commit is contained in:
Klaus-Uwe Mitterer 2017-10-02 21:16:55 +02:00
parent cec2eca235
commit 656e4b9b49

View file

@ -1,11 +1,12 @@
# Python3 ÖBB API
This project aims to provide a functional API for the Austrian Federal Railways
(Österreichische Bundesbahnen, ÖBB). It has three core features/request types:
(Österreichische Bundesbahnen, ÖBB). It has four core features/request types:
* Search for Public Transportation stops by name ("val")
* Search for Public Transportation stops by coordinates ("nearby")
* Search for Public Transportation connections between two stops ("conn")
* Search for the current location of a train ("radar")
## Request
@ -122,6 +123,23 @@ appearance in the request.
(https://bahnapi.xyz/?type=conn&from=Bruck an der Mur&to=Salzburg&via=Leoben
&via=Selzthal&via=Linz)
### Search for current location of trains ("radar")
The following parameter is required for this type of request:
* "type": "radar"
The following optional parameter is accepted:
* "train": Train number (including prefix)
If "train" is not set, this will return the location and destination of all
trains currently running. If "train" is set, only trains matching the passed
train numbers are returned. Multiple "train" parameters may be passed in a
single request.
* [Example "radar" request](https://bahnapi.xyz/?type=radar&train=s9)
### Short requests
For "val" and "conn" requests, it is possible to use shorter requests by passing