Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 2.2 KB

USAGE_GUIDE.md

File metadata and controls

45 lines (28 loc) · 2.2 KB

Open Bus Stride API Usage Guide

This is a detailed guide to using the Stride API.

The Stride API uses standard REST and returns JSON objects, if you are familiar with such concepts feel free to skip this guide and head on to the API to start using it at https://open-bus-stride-api.hasadna.org.il/docs

First step is to find an API method you want to call. Head over to the API docs using your web browser at https://open-bus-stride-api.hasadna.org.il/docs

Some general details and useful links are displayed at the top, followed by a list of all the methods:

image

Click on an API method you want to use, for this example we will use the first one - /route_timetable/list. This will show all the parameters for this method:

image

The API docs also allow to call functions directly from the web browser, click on the "Try it out" button.

Fill-in some of the fields, the fields have descriptions and you can also refer to the Data Model and the ETL Processes documentation for details regarding the meaning of the fields.

Once you filled-in the required fields, click on the "Execute" button.

It will now show the request url:

image

How to use this depends on your programming language, but in general, you will want to get just the domain and path part without the query string, for example:

https://open-bus-stride-api.hasadna.org.il/route_timetable/list

The query string and response parsing should be handled by your programming language HTTP library, for example, in Python using the Requests library it will look like this:

data = requests.get("https://open-bus-stride-api.hasadna.org.il/route_timetable/list", params={"get_count": "false", "line_refs": "5473232"}).json()

The data variable will now contain the result of this API method.