Skip to content

Response & schema reference

Download all four files for your client.

FileContents
PlanRequest.protoRequest, user speeds, flex and pricing options
PlanResult.protoResults, trips, legs, places, alerts, booking and fares
Modes.protoTransit and non-transit enums
DirectionType.protoJourney direction enum
FieldMeaning
trips[]Travel options in this result frame
timestampResult timestamp
errors[]Routing errors (code, message)
modifiers[]Request modifications used for this group
gradeGroup-level relative grade
containsOnDemand, containsWithSurchargeOptional, source-dependent flags
FieldsMeaning
aimedStartTime, aimedEndTimeScheduled/planned times
expectedStartTime, expectedEndTimeExpected times when mapped
duration, transfersMinutes and transfer count
waitingTime, walkTimeOptional minutes
distance, streetDistanceOptional metres
legs[], systemNotices[]Timeline and general notices
idTrip identity in returned results
itineraryHashOpaque replay identifier for transit/flex itineraries; empty for purely non-transit trips
gradeIndividual trip grade
pricingInfoOptional total, leg fares, discounts and transfer instructions

Keep these files together and update them as a set. Use enum names in your display code and preserve optional values when decoding.