Skip to content

Request fields

Use these fields inside the payload of a JSON planTrip request, or in a binary PlanRequest message.

FieldWhat to sendExample
fromPlaceStart as latitude,longitude52.0894,5.1102
toPlaceDestination as latitude,longitude52.0925,5.1813
timestampTravel time in ISO 8601, including timezoneA departure or arrival time with an offset or Z
arriveByUse the time as arrival rather than departuretrue
timeSlackMinutes around the requested time; default 50 for the specified time
transferSlackExtra transfer time in seconds120 for two minutes
FieldPurposeExample
excludeModesExclude transit modes["RAIL"]
excludedFirstMileModesExclude alternatives before transit["CAR"]
excludedLastMileModesExclude alternatives after transit["RENTED_SCOOTER"]
excludedUnimodalModesExclude direct alternatives["CAR"]
lessWalkingPrefer journeys with less walkingtrue
allowWorseOptionsInclude lower-graded optionstrue
useFlexibleRoutingSearch flexible-service optionstrue
userPreferencesWalking/cycling speed and e-bike choiceSee speeds
FieldPurposeExample
includePricingInclude available farestrue
pricingOptions.travelClassTrain fare class; default SECOND_CLASS"FIRST_CLASS"
pricingOptions.ageSelect the 65+ tariff for flex services with senior pricing70
includeTownInStopNameInclude town in compatible stop names; default truefalse for separate town/name
itineraryHashLook up a returned itineraryCopy the hash from the result
flexOptions.bookingTimeTime at which a flex booking is consideredISO 8601 timestamp

Use includePricing: true for standard fares. Add travelClass for first-class train pricing or age for a supported flex senior tariff. General child and senior discounts on regular public transport are not currently applied. See fare examples.

The complete schema contains all wire fields and their support notes.