TripGo API

The TripGo API allows you to plan door-to-door trips using a large variety of public and private transport. It integrates real-time information and, for selected providers, allows users to book and pay for transport.


Getting started

1. Getting an API key

Get an API key. You can try it out for free for as long as you like, as you stay below a threshold of API calls - no credit card required. For limits on the free tier and pricing, see the SkedGo website.

Once you have an API key, send it along with every request as the X-TripGo-Key header.

2. Getting the base URL

Unfortunately we don't yet have a unified URL for all areas, as failover is expected to be done client-side. You can get a list of regions and URLs with something like:

curl 'https://tripgo.skedgo.com/satapp/regions.json' -H 'Accept: application/json' --compressed -H "X-TripGo-Key: $tripgoKey" -d '{"v":2}'

Keep in mind that this API is powered by multiple servers, not all of which cover every region. You have to use the correct host names for the region that you query. You get those host names by first querying regions.json and looking up the urls for that region. You should only cache this information short term as those URLs can change without notice.

3. Make a request

Our API can do a lot more than just directions, but if that is what you are interested in, then try something like:

curl 'https://granduni-au-nsw-sydney-tripgo.skedgo.com/satapp/routing.json?from=(-33.859,151.207)&to=(-33.863,151.208)&departAfter=1532799914&modes[]=wa_wal&v=11&locale=en' -H 'Accept: application/json' --compressed -H "X-TripGo-Key: $tripgoKey" -g

or

curl 'https://granduni-au-nsw-sydney-tripgo.skedgo.com/satapp/routing.json?from=(-33.859,151.207)&to=(-33.891,151.209)&modes[]=pt_pub&v=11&locale=en' -H 'Accept: application/json' --compressed -H "X-TripGo-Key: $tripgoKey" -g

Keep in mind that this API is optimised to return a large number of trip results while maintaining small response sizes. This has a number of complications. Notably, to get a trip's segments you need to combine the segment references with the segment templates. This is explained further in the F.A.Q..

4. Where to go from here?

  1. If you're an app developer, take a look at our open source TripKit SDKs for iOS, macOS and Android.

  2. If you're a web developer, take a look at our sample app "FastGo" and its accompanying blog post series.

  3. If you're a backend developer, dive into the API specs, which are available in OpenAPI (formerly Swagger) format.

  4. Continue reading with our in-depth guides.

  5. If you know how to debug a web app, look at the network activity for our web app to get an idea of which API calls to use when. (Filter for "satapp".)

  6. To talk to us and other developers using our API, join our Slack team.