Public Transit API Developer's Guide

Introduction

This document introduces the Public Transit API and:

  • explains key concepts
  • provides examples
  • documents resources and query parameters
  • documents response structures and data types

For the terms and conditions covering this documentation, see the HERE Documentation License.

What Is the Public Transit API?

The Public Transit API is a REST API that allows you to use agency data, external services and data collected by HERE to discover public transit options, request public transit routes and transit related information.

The Public Transit API has a number of endpoints that center around two major features:

  • Discovery - shows stations and departure of transit services around a given location, transit stations that could be reached within a certain time frame from a given location and shows transit line(s) details at any given station
  • Routing - provides the most efficient and relavant transit routes between a given pair of locations.

Why Use the Public Transit API?

The Public Transit API provides resources to address the following high-level use cases:

Table 1. Main features of the HERE Public Transit API
Feature Description
Discover public transit options in a geolocation. Based on a WGS-84 compliant latitude and longitude, search for nearby stations, determine what public transit information is available in the area (e.g. transit lines and departure times), and discover how far a person can travel by public transit within a certain time frame.
Request public transit routes. Based on WGS-84 compliant start and end points, request public transit routes making use of all avalable transit types in a given city or metropolitan area.

You can tailor transit route calculation for different use cases by:

  • defining routes based on arrival time vs departure time
  • filtering specific forms of transit, such as rail and metro only
  • planning routes hours or days in advance
  • setting a maximum distance for the walk to the nearest transit stop/station or the speed of the walk
  • defining how many changes or transfers the journey may include
  • requesting turn-by-turn maneuvers for walk navigation at the beginning and end of the journey
  • requesting route graph of the journeys in order to view the route over a map.