Right after signing up, the API will serve results for regions and transport providers that publish their data as Open Data and which have already been connected to our system.
The TripGo API can be extended in the following ways:
- Unlock transport modes, regions and real-time data from services that require you to first accept their terms or acquire API credentials.
- Add new transport modes through our TSP Connectors.
- Add new regions through our Region Connectors (coming soon).
Regions
Unlocking regions
To get results for regions with providers that aren't using Open Data please get in touch with our team by mail or on Slack (by self-invite).
Rio de Janeiro (Brazil) 🌎
- Go to Fetransport Site and make sure you agree with the data terms. Contact us if you need help for this.
- Forward your confirmation mail to [email protected]
- We will then unlock the region for your API key.
Adding new regions
To get results for regions that are not yet covered by the TripGo API, you as an API client can help us with the integration process to add a region of interest as follows:
- Collect all "Minimum required data" detailed below.
- Send the URLs where we could donwload the data from the sources to [email protected]. For the cases where the data is not in a public accessible repository, please also pass on necessary contact information or access details.
- Wait until SkedGo processes all the information and updates the backend with the new region.
This last process involves: - Configuring the region with the required data - Allocating cloud resources, including redunancy - Testing and verification of data quality and routing results - Once all tests pass, our data team will promote the new regions to our production servers
For expected timing and pricing, please refer to our published price list.
Minimum required data
- Name of the country and city or area which is going to be added.
- Coverage: The region's coverage area where the service is going to be provided, as a polygon or bounding rectangle.
- The most important city or cities from that area.
- URL(s) to the public transport timetables for that area in a standard data format that can be be consumed by our platform. A very important rule to follow, is to include data for every major public transport operator in the coverage area. Supported data formats are: - General Transit Feed Specification (GTFS) - NeTEx - TransXChange
- Country/region properties that configure our routing and API responses, including: - Currency - Timezone - Default language - Preferred distance unit (metric/imperial) - Drive on left / right - Taxi cost for that area (see TSP connectors below) - Average fuel cost
- Road and footpath information is being consumed from OpenStreetMap, so there is no need to provide that.
Optional data
- More cities to be displayed on the map: Each of them should have a default position.
- Public holidays information: Country default ones could be loaded from global repositories but regional or local ones could be added.
- Public transport real-time data, using one of the following standards: - GTFS-Realtime - Siri
- Car park information
- Transport service providers (see TSP connectors below)
- Traffic alerts (see "info" connectors below)
Customisations
- Rules for when bicycles are allowed on public transport and on which types of public transport. This is useful when this data is not provided as part of the public transport sources.
- Icon customisation for specific transports or services.
- Icon customisation for specific public transport nodes.
- Public transport fare calculations, see our published price list.
Transport providers
Unlocking transport modes
To get results for providers who aren't using Open Data, follow the instructions for the provider below. If you want to use a provider that hasn't yet been connected to our system, please get in touch with our team by mail or on Slack (by self-invite).
BlaBlaCar 🌍
Integrations: Routing, Real-time
- Read the terms of use of BlaBlaCar's API and make sure you comply with them in your app.
- Sign up to BlaBlaCar's API.
- Enter your
BlaBlaCar auth key
in your application credentials. - BlaBlaCar results will start coming through the TripGo API for your API key (after at most 5 minutes).
GoGet 🇦🇺
Integrations: Locations, Routing, Real-time
- Get in touch with GoGet's sales team and get access to their API.
- Enter your
GoGet ConsumerKey
andGoGet ConsumerSecret
in your application credentials. - GoGet results will start coming through the TripGo API for your API key (after at most 5 minutes).
Lyft 🇺🇸
Integrations: Routing, Real-time, Bookings
- Read the terms of use of Lyft's API and make sure you comply with them in your app.
- Sign up to Lyft's API.
- Enter your
Lyft Client ID
andLyft Client Secret
in your application credentials. - Lyft results will start coming through the TripGo API for your API key (after at most 5 minutes).
Ola 🇮🇳 🇦🇺 🇳🇿 🇬🇧
Integrations: Routing, Real-time
- Get in touch with Ola's sales team and get access to their API.
- Enter your
OLA ApiKey
in your application credentials. - Ola results will start coming through the TripGo API for your API key (after at most 5 minutes).
Unlocking public transport real-time data
To get real-time data for providers who aren't using Open Data, follow the instructions for the provider below. If you want to use a provider that hasn't yet been connected to our system, please get in touch with our team by mail or on Slack (by self-invite).
Chicago's CTA 🇺🇸
- Read the terms of use of CTA's API and make sure you comply with them in your app
- Sign up to CTA's API
- Enter your
CTA key for Chicago
in your application credentials. - Real-time data for CTA for your TripGo API key will be enabled (after at most 5 minutes).
STIB-MIVB in Brussels 🌎
- Read the terms of use of STIB-MIVB's open data platform and make sure you comply with them in your app
- Sign up to STIB-MIVB's API
- Enter your
STIB-MIVB realtime api key
in your application credentials. - Real-time data for STIB-MIVB for your TripGo API key will be enabled (after at most 5 minutes).
To get real-time data for providers who aren't using Open Data, follow the instructions for the provider below. If you want to use a provider that hasn't yet been connected to our system, please get in touch with our team by mail or on Slack (by self-invite).
Adding new providers: TSP connectors
For TSPs that are not yet integrated into our platform, you can add them by:
- Implementing the corresponding API according to our API specs, and then
- Sending the URL of where you have deployed your implementation to [email protected].
The process then involves a manual step (which we plan to automate) to add that to our list of TSP connectors and enable it. It will usually take 1 day after it is added to our list for results will then include the new TSP, with some exceptions like pod based share vehicles, which will take between 3 and 7 days.
How does this work
All TSP connector APIs share in common three endpoints:
- config: the list of endpoints that are implemented, similar to gbfs.json
- provider: the information about the provider, which may include links to mobile apps and deep links (with a pattern); and also the list of modes for the TSP
- coverage: a list of coverage areas of the provider, and for each area, it is possible to define available products and pricing rules
Config endpoint allows our platform to understand what are the capabilities of the TSP integration of each connector. Provider information is what our platform will use to attribute results. This will be passed on with any API responses that include results from your TSP connector. Coverage will allow our platform to know in which areas (i.e., regions) the TSP will be enabled.
Taxi and TNC
For taxi and TNC providers we defined a Taxi API which allows you to:
- Add static pricing (in
coverage
endpoint), which will be shown as an estimate cost and used by our routing engine when creating trip alternatives. - Provide real-time ETAs, which might differ by "product".
- Provide real-time costs estimations based on specific trip details.
- Enable in-app booking capabilities, so users can directly initiate the booking process through our platform.
Shared bikes, scooters and cars
For shared vehicles, such as bikes, scooters or cars, we support the GBFS standard with the addition of the shared endpoints mentioned above (except for config
which is replaced by the standard gbfs.json
). This includes support for car-sharing, but be aware that this part of the standard is not finalised yet (as of February 2021).
We also support GBFS sources with only one endpoint, for example just the free_bike_status.json endpoint.
Additional data sources
Unlocking real-time traffic
To get real-time traffic information, you need to unlock one of the providers below. If you want to use a provider that hasn't yet been connected to our system, please get in touch with our team by mail or on Slack (by self-invite).
Live-Traffic from Google 🌎
- Read the terms of use of Google Maps and make sure you comply with them in your app - in particular, that you are using a Google Map.
- Sign up to the Google Maps Directions API
- Enter your
Google Maps Directions API key
in your application credentials. - Car results leaving now will then come augmented with Google's drive time predictions through the TripGo API for your API key (after at most 5 minutes).
Live-Traffic from TomTom 🌎
- Sign up to the TomTom Maps API, making sure you read the terms and comply with them - in particular, that you're not affiliated with a prohibited party and that you're using a TomTom or TomTom licenses map UI (e.g., Apple Maps).
- Enter your
TomTom consumer API key
andTomTom consumer secret
in your application credentials. - Car results leaving now will then come augmented with TomTom's drive time predictions through the TripGo API for your API key (after at most 5 minutes).
Unlocking geocoding providers
To get results from geocoding data for providers who aren't using Open Data when using geocoding.json
endpoint, follow the instructions for the provider below. These providers will only apply for non auto-completion requests, except for What3Words ones, which can be used for both type of geocoding requests. If you want to use a provider that hasn't yet been connected to our system, please get in touch with our team by mail or on Slack (by self-invite).
Foursquare 🌎
- Read the Foursquare Terms of Use and make sure you comply with them in your app.
- Sign up to the Foursquare Developers Site
- Enter your
Foursquare API key
in your application credentials. - Add
allowFoursquare=true
to your geocoding requests, and then geocoding results will then come augmented with Foursquare's API through the TripGo API for your API key (after at most 5 minutes).
Google Places 🌎
- Read the Places API Policies and make sure you comply with them in your app - in particular, that you are using a Google Map.
- Sign up to the Google Places API
- Enter your
Google Places API key
in your application credentials. - Add
allowGoogle=true
to your geocoding requests, and then geocoding results will then come augmented with Google Places's API through the TripGo API for your API key (after at most 5 minutes).
What3Words 🌎
- Read the API Licence Agreement and make sure you comply with them in your app.
- Sign up to the What3Words API
- Enter your
What 3 Words key
in your application credentials. - Add
allowW3W=true
to your geocoding requests, and then geocoding results will then come augmented with What3Words's API through the TripGo API for your API key (after at most 5 minutes).
Yelp 🌎
- Read the Yelp Terms of Use and make sure you comply with them in your app.
- Sign up to the Yelp Developers Site
- Enter your
Yelp API key
in your application credentials. - Add
allowYelp=true
to your geocoding requests, and then geocoding results will then come augmented with Yelp's API through the TripGo API for your API key (after at most 5 minutes).
Adding "info" data sources
Similar to TSP connectors above, you can create a "info" connector to enhance our platform with more information, as defined in the Info API, which allows:
- Reporting real-time events on a given location or area. The model follows GTFS-R standard and will be added to our platform responses accordingly.
- Integrating bike lanes, which will be used by our cycling results to prioritise those paths.