Menu
API (v2)
Services
- Destinations
- Locations
- Routes
- Service Advisories
- Statuses
- Stop Features
- Stop Schedules
- Stops
- Streets
- System Messages
- Trip Planner
- Variants
Other versions
Trip Planner API
Uses the Navigo engine to plan trips from an origin to a destination. Origins and destinations are encoded strings representing a location or point.
- Format for locations: (addresses|intersections|monuments|stops)/{key}
Location keys are found from the Locations service. - Format for points: utm/{x},{y} or geo/{lat},{lon}
Valid URL Parameters
origin | The trip origin. See above for allowed formats. |
---|---|
destination | The trip destination. See above for allowed formats. |
date | The date of the trip in YYYY-mm-dd format. Defaults to today. |
time | The time of the trip in HH:MM or HH:MM:SS format. Defaults to now. |
mode |
|
walk-speed | Walking speed in km/h. Can be a float. |
max-walk-time | The maximum number of minutes to spend walking. |
min-transfer-wait | The minimum number of minutes to spend waiting for a transfer. |
max-transfer-wait | The maximum number of minutes to spend waiting for a transfer. |
max-transfers | The maximum number of transfers. |
usage |
The style of names to return.
|
---|
Examples
Login to see sample results.
Identity
- trip-planner/home
Filter
- trip-planner?origin=addresses/136590&destination=intersections/123172:378@954
- trip-planner?origin=addresses/136589&destination=monuments/3911&date=2025-07-02&time=17:00&mode=arrive-before
- trip-planner?origin=utm/633861,5525798&destination=addresses/26045&walk-speed=5.3
- trip-planner
- trip-planner?origin=locations/124&destination=addresses:321
Wildcard
- trip-planner:
- trip-planner:home
Explore the API
Login to explore the Trip Planner API.
Noteworthy Results
plan | Each trip plan is a different option that can be used to get from the origin to the destination. |
---|---|
segments | A plan has one or more segments. Each segment represents a part of the trip (eg. walk, ride, transfer, ride, walk). |
segment/@type | The type of segment (ie. walk, ride, or transfer) |
segment/route | A ride segment contains route information. See the Route service for more information. |
segment/variant | A ride segment contains variant information. See the Variants service for more information. |
segment/from|segment/to | Walk and transfer segments contain information about the start point and end point of the segment. |
from/origin|to/destination | A walk segment that starts at the origin of the trip, or ends at the destination. Contains locations (see the Locations service for more information), or geographical points. |
(from|to)/stop | A walk or transfer segment begins or ends at a stop. Only includes basic stop information. The xlink:href attribute points to the service that can be called for more information. |
(plan|segment)/times | Contains start and end times of the plan or segment. Includes the total duration in minutes. Riding, walking, and waiting totals are included where appropriate. |
segment/bus | Information about the bus servicing a ride segment. Usually present in plans for today but absent for past and future dates. |
segment/bus/key | A unique identifier for the bus servicing this segment. |
segment/bus/bike-rack | Boolean field describing whether the bus has a bike rack. |