Sign in
timetable

Reconstruct an itinerary from an itinerary ID.

Experimental (API might change without prior notice and without API version bump). Only supports walking at start/end or station-to-station itineraries.

All parameters mirror those of the plan endpoint - see the plan endpoint for their descriptions.

get/api/v6/refresh-itinerary

Query parameters

itineraryIdstring required
requireDisplayNameMatchboolean
joinInterlinedLegsboolean
detailedTransfersboolean
detailedLegsboolean
withFaresboolean
withScheduledSkippedStopsboolean
numLegAlternativesinteger
transitModesMode[]
preTransitModesMode[]

Optional. Default is WALK. Modes allowed for the first (access) mile when reconstructing leg alternatives. Should match the preTransitModes of the original plan request.

postTransitModesMode[]

Optional. Default is WALK. Modes allowed for the last (egress) mile when reconstructing leg alternatives. Should match the postTransitModes of the original plan request.

pedestrianProfile'FOOT' | 'WHEELCHAIR'

Different accessibility profiles for pedestrians.

useRoutedTransfersboolean
requireBikeTransportboolean
requireCarTransportboolean
noCompulsoryReservationboolean
languagestring[]
pedestrianSpeednumber

Average speed for pedestrian routing in meters per second

Average speed for pedestrian routing on the first/last mile.

cyclingSpeednumber

Average speed for bike routing in meters per second

Average speed for bike routing on the first/last mile.

elevationCosts'NONE' | 'LOW' | 'HIGH'

Different elevation cost profiles for street routing. Using a elevation cost profile will prefer routes with a smaller incline and smaller difference in elevation, even if the routed way is longer.

  • NONE: Ignore elevation data for routing. This is the default behavior
  • LOW: Add a low penalty for inclines. This will favor longer paths, if the elevation increase and incline are smaller.
  • HIGH: Add a high penalty for inclines. This will favor even longer paths, if the elevation increase and incline are smaller.

Elevation cost profile for first/last-mile street routing.

maxMatchingDistancenumber

Maximum matching distance in meters to the street network.

Is limited by server config variable max_max_matching_distance, larger values are capped to this limit.

maxPreTransitTimeinteger

Maximum time in seconds for the first (access) street leg.

maxPostTransitTimeinteger

Maximum time in seconds for the last (egress) street leg.

preTransitRentalFormFactorsRentalFormFactor[]

Allowed rental form factors for the first (access) leg.

postTransitRentalFormFactorsRentalFormFactor[]

Allowed rental form factors for the last (egress) leg.

preTransitRentalPropulsionTypesRentalPropulsionType[]

Allowed rental propulsion types for the first (access) leg.

postTransitRentalPropulsionTypesRentalPropulsionType[]

Allowed rental propulsion types for the last (egress) leg.

preTransitRentalProvidersstring[]

Allowed rental providers for the first (access) leg.

postTransitRentalProvidersstring[]

Allowed rental providers for the last (egress) leg.

preTransitRentalProviderGroupsstring[]

Allowed rental provider groups for the first (access) leg.

postTransitRentalProviderGroupsstring[]

Allowed rental provider groups for the last (egress) leg.

ignorePreTransitRentalReturnConstraintsboolean

Ignore rental return constraints on the first (access) leg.

ignorePostTransitRentalReturnConstraintsboolean

Ignore rental return constraints on the last (egress) leg.

Response

reconstructed itinerary

durationinteger required

journey duration in seconds

startTimestring date-time required

journey departure time

endTimestring date-time required

journey arrival time

transfersinteger required

The number of transfers this trip has.

idstring required

Experimental (format might change). Opaque itinerary identifier. Pass it as itineraryId to refresh-itinerary endpoint for reconstruction using the new schedule/realtime data.

Changes

Changed in 11 of the 52 revisions of this API.21238

  • f4c11a2b04312See the full diff
    • ○

      added the new optional query request parameter noCompulsoryReservation

      new-optional-request-parameter

    • ○

      added the optional property legs/items/reservation to the response with the 200 status

      response-optional-property-added

  • dbfe4b7f2bab63See the full diff
    • ●

      added the new HGV enum value to the legs/items/from/modes/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new HGV enum value to the legs/items/intermediateStops/items/modes/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new HGV enum value to the legs/items/mode response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new HGV enum value to the legs/items/to/modes/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new HGV enum value to the legs/items/tripFrom/modes/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new HGV enum value to the legs/items/tripTo/modes/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value HGV to the property items/ of the query request parameter postTransitModes

      request-parameter-property-enum-value-added

    • ○

      added the enum value HGV to the property items/ of the query request parameter preTransitModes

      request-parameter-property-enum-value-added

    • ○

      added the enum value HGV to the property items/ of the query request parameter transitModes

      request-parameter-property-enum-value-added

  • 03f152d705b92See the full diff
    • ○

      added the optional property legs/items/agencyFareUrl to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property legs/items/ticketUrls to the response with the 200 status

      response-optional-property-added

  • ddd353807e6a2See the full diff
    • ○

      added the optional property legs/items/steps/items/fromOsmNode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property legs/items/steps/items/toOsmNode to the response with the 200 status

      response-optional-property-added

  • 360889ae286f1See the full diff
    • ▲

      for the query request parameter maxMatchingDistance, default value was changed from 25 to 250

      request-parameter-default-value-changed

  • 457c392131be18See the full diff
    • ○

      added the new optional query request parameter cyclingSpeed

      new-optional-request-parameter

    • ○

      added the new optional query request parameter elevationCosts

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ignorePostTransitRentalReturnConstraints

      new-optional-request-parameter

    • ○

      added the new optional query request parameter ignorePreTransitRentalReturnConstraints

      new-optional-request-parameter

    • ○

      added the new optional query request parameter maxMatchingDistance

      new-optional-request-parameter

    • ○

      added the new optional query request parameter maxPostTransitTime

      new-optional-request-parameter

    • ○

      added the new optional query request parameter maxPreTransitTime

      new-optional-request-parameter

    • ○

      added the new optional query request parameter pedestrianSpeed

      new-optional-request-parameter

    • ○

      added the new optional query request parameter postTransitModes

      new-optional-request-parameter

    • ○

      added the new optional query request parameter postTransitRentalFormFactors

      new-optional-request-parameter

    • ○

      added the new optional query request parameter postTransitRentalPropulsionTypes

      new-optional-request-parameter

    • ○

      added the new optional query request parameter postTransitRentalProviderGroups

      new-optional-request-parameter

    • ○

      added the new optional query request parameter postTransitRentalProviders

      new-optional-request-parameter

    • ○

      added the new optional query request parameter preTransitModes

      new-optional-request-parameter

    • ○

      added the new optional query request parameter preTransitRentalFormFactors

      new-optional-request-parameter

    • ○

      added the new optional query request parameter preTransitRentalPropulsionTypes

      new-optional-request-parameter

    • ○

      added the new optional query request parameter preTransitRentalProviderGroups

      new-optional-request-parameter

    • ○

      added the new optional query request parameter preTransitRentalProviders

      new-optional-request-parameter

  • a2ab90068a355See the full diff
    • ○

      added the optional property legs/items/from/stopCode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property legs/items/intermediateStops/items/stopCode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property legs/items/to/stopCode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property legs/items/tripFrom/stopCode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property legs/items/tripTo/stopCode to the response with the 200 status

      response-optional-property-added

  • 1844a7e745fe5See the full diff
    • ○

      added the new optional query request parameter pedestrianProfile

      new-optional-request-parameter

    • ○

      added the new optional query request parameter requireBikeTransport

      new-optional-request-parameter

    • ○

      added the new optional query request parameter requireCarTransport

      new-optional-request-parameter

    • ○

      added the new optional query request parameter transitModes

      new-optional-request-parameter

    • ○

      added the new optional query request parameter useRoutedTransfers

      new-optional-request-parameter

  • f808465a02ed6See the full diff
    • ●

      added the new SPECIAL_EVENT enum value to the legs/items/alerts/items/cause response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SPECIAL_EVENT enum value to the legs/items/from/alerts/items/cause response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SPECIAL_EVENT enum value to the legs/items/intermediateStops/items/alerts/items/cause response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SPECIAL_EVENT enum value to the legs/items/to/alerts/items/cause response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SPECIAL_EVENT enum value to the legs/items/tripFrom/alerts/items/cause response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SPECIAL_EVENT enum value to the legs/items/tripTo/alerts/items/cause response property for the response status 200

      response-property-enum-value-added

  • 4f82b7d9f9561See the full diff
    • ○

      endpoint added

      endpoint-added