VVSPY Requests

Departures

vvspy.get_departures(station_id: Union[str, int], check_time: datetime.datetime = None, limit: int = 100, debug: bool = False, request_params: dict = None, return_resp: bool = False, session: requests.sessions.Session = None, **kwargs) → Union[List[vvspy.obj.departure.Departure], requests.models.Response, None]

Returns: List[vvspy.obj.Departure] Returns none on webrequest errors.

Basic usage:

results = vvspy.get_departures("5006115", limit=3)  # Stuttgart main station

Set proxy for request:

proxies = {}  # see https://stackoverflow.com/a/8287752/9850709
results = vvspy.get_departures("5006115", request_params={"proxies": proxies})

station_id Union[int, str]

Station you want to get departures from. See csv on root of repository to get your id.

check_time Optional[datetime.datetime]

Time you want to check. default datetime.now()

limit Optional[int]

Limit request/result on this integer. default 100

debug Optional[bool]

Get advanced debug prints on failed web requests default False

request_params Optional[dict]

params parsed to the api request (e.g. proxies) default {}

return_resp Optional[bool]

if set, the function returns the response object of the API request.

session Optional[requests.Session]

if set, uses a given requests.session object for requests

kwargs Optional[dict]

Check departures.py to see all available kwargs.

vvspy.get_departure(station_id: Union[str, int], check_time: datetime.datetime = None, debug: bool = False, request_params: dict = None, return_resp: bool = False, session: requests.sessions.Session = None, **kwargs) → Union[vvspy.obj.departure.Departure, requests.models.Response, None]

Same as get_departures But limited to one obj as result.

Returns: vvspy.obj.Departure Returns none on webrequest errors or no results found.

vvspy.departures_now(station_id: Union[str, int], limit: int = 100, return_resp: bool = False, session: requests.sessions.Session = None, **kwargs) → Union[List[vvspy.obj.departure.Departure], requests.models.Response, None]

Same as get_departures But datetime.datetime.now() is already used as parameter.

Returns: List[vvspy.obj.Departure] Returns none on webrequest errors or no results found.

Arrivals

vvspy.get_arrivals(station_id: Union[str, int], check_time: datetime.datetime = None, limit: int = 100, debug: bool = False, request_params: dict = None, return_resp: bool = False, session: requests.sessions.Session = None, **kwargs) → Union[List[vvspy.obj.arrival.Arrival], requests.models.Response, None]

Returns: List[vvspy.obj.Arrival] Returns none on webrequest errors.

Basic usage:

results = vvspy.get_arrivals("5006115", limit=3)  # Stuttgart main station

Set proxy for request:

proxies = {}  # see https://stackoverflow.com/a/8287752/9850709
results = vvspy.get_arrivals("5006115", request_params={"proxies": proxies})

station_id Union[int, str]

Station you want to get arrivals from. See csv on root of repository to get your id.

check_time Optional[datetime.datetime]

Time you want to check. default datetime.now()

limit Optional[int]

Limit request/result on this integer. default 100

debug Optional[bool]

Get advanced debug prints on failed web requests default False

request_params Optional[dict]

params parsed to the api request (e.g. proxies) default {}

return_resp Optional[bool]

if set, the function returns the response object of the API request.

session Optional[requests.Session]

if set, uses a given requests.session object for requests

kwargs Optional[dict]

Check arrivals.py to see all available kwargs.

vvspy.get_arrival(station_id: Union[str, int], check_time: datetime.datetime = None, debug: bool = False, request_params: dict = None, return_resp: bool = False, session: requests.sessions.Session = None, **kwargs) → Union[vvspy.obj.arrival.Arrival, requests.models.Response, None]

Same as get_arrivals But limited to one obj as result.

Returns: vvspy.obj.Arrival Returns none on webrequest errors or no results found.

Trips

vvspy.get_trips(origin_station_id: Union[str, int], destination_station_id: Union[str, int], check_time: datetime.datetime = None, limit: int = 100, debug: bool = False, request_params: dict = None, return_resp: bool = False, session: requests.sessions.Session = None, **kwargs) → Union[List[vvspy.obj.trip.Trip], requests.models.Response, None]

Returns: List[vvspy.obj.Trip] Returns none on webrequest errors.

Basic usage:

results = vvspy.get_trips("5006115", "5006465", limit=3)  # Stuttgart main station to Zuffenhausen

Set proxy for request:

proxies = {}  # see https://stackoverflow.com/a/8287752/9850709
results = vvspy.get_arrivals("5006115", "5006465", request_params={"proxies": proxies})

station_id Union[int, str]

Station you want to get trips from. See csv on root of repository to get your id.

check_time Optional[datetime.datetime]

Time you want to check. default datetime.now()

limit Optional[int]

Limit request/result on this integer. default 100

debug Optional[bool]

Get advanced debug prints on failed web requests default False

request_params Optional[dict]

params parsed to the api request (e.g. proxies) default {}

return_resp Optional[bool]

if set, the function returns the response object of the API request.

session Optional[requests.Session]

if set, uses a given requests.session object for requests

kwargs Optional[dict]

Check trips.py to see all available kwargs.

vvspy.get_trip(origin_station_id: Union[str, int], destination_station_id: Union[str, int], check_time: datetime.datetime = None, debug: bool = False, request_params: dict = None, return_resp: bool = False, session: requests.sessions.Session = None, **kwargs) → Union[vvspy.obj.trip.Trip, requests.models.Response, None]

Same as get_trips But limited to one obj as result.

Returns: vvspy.obj.Trip Returns none on webrequest errors or no results found.