routing

Door-to-door journey planning (the core).

get/v1/plan

Request

  • Base URL: https://pt-api.internal.example
  • URL: https://pt-api.internal.example/v1/plan
  • Auth: none declared

Query parameters

fromstring required

lat,lon or stop:<opaque-id>

tostring required

lat,lon or stop:<opaque-id>

timestring

RFC 3339 with offset; default now

arrive_byboolean
resultsinteger
max_transfersinteger
modesstring

Comma-separated list of TRANSIT modes to INCLUDE. walk is always implied (access/egress). Absent => ALL transit modes (default, no filter). Vocabulary: bus, rail, tram, metro, trolleybus, ferry, funicular, aerial_lift, coach, air (plus walk, and legacy transit = all). Unknown tokens -> 400. Example: modes=rail,ferry.

cursorstring
langstring
snap_radius_minteger

Explicit opt-in override for the legacy coordinate snap circle. By default there is NO radius: a coordinate endpoint is resolved to the single nearest served station (fast) instead of scanning every stop in a circle. Only set this if you specifically want multi-stop circle snapping.

Response

Journey planning result (possibly empty).

diagnosticsstring nullable

Set (non-null) only when itineraries is empty — a clear human reason, never a silent empty.

attributions_urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.