dateTime: ⓘ

The datetime that the trip should depart (or arrive, for requests where arriveBy is on). An ISO 8601 string (YYYY-MM-DDTHH:MM:SSZ, YYYY-MM-DDTHH:MM:SS.mmmZ) or a timestamp in milliseconds (ms since epoch, `1767225600000` = `2026-01-01T00:00:00.000Z`).
Use either datetime or the combination of date & time.
If datetime is present it will take precedence over date+time. Optional. If not provided the journey is assume to depart "now".
Example: 2025-12-31T23:59:59.999Z.

alightSlack: ⓘ

String representing a positive integer. alightSlack, the time it takes to alight from a transit vehicle, in seconds.

bannedRoutes: ⓘ

List of banned routes.

bannedStops: ⓘ

List of banned stops. A stop is banned by ignoring its pre-board and pre-alight edges. This means the stop will be reachable via the street network. Also, it is still possible to travel through the stop. Just boarding and alighting is prohibited. The format is agencyId_stopId, so: TriMet_2107

bannedStopsHard: ⓘ

List of banned stops. A stop is banned by ignoring its pre-board and pre-alight edges. This means the stop will be reachable via the street network. It is not possible to travel through the stop. For example, this parameter can be used when a train station is destroyed, such that no trains can drive through the station anymore. The format is agencyId_stopId, so: TriMet_2107

bannedTrips: ⓘ

List of banned trips. The format is agency_trip[:stop*], so: TriMet_24601 or TriMet_24601:0:1:2:17:18:19

batch: ⓘ

If true, goal direction is turned off and a full path tree is built (specify only once).

bikeBoardCost: ⓘ

Integer. Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that is used when boarding while cycling. This is usually higher that walkBoardCost.

bikeSpeed: ⓘ

Float. The user's biking speed in meters/second. Defaults to approximately 11 MPH, or 9.5 for bikeshare.

bikeSwitchCost: ⓘ

Integer. The cost of the user fetching their bike and parking it again. Defaults to 0.

boardSlack: ⓘ

String representing a positive integer. boardSlack, the time it takes to board a transit vehicle, in seconds.

disableAlertFiltering: ⓘ

TODO : add description

disableRemainingWeightHeuristic: ⓘ

If true, the remaining weight heuristic is disabled. Currently only implemented for the long distance path service.

geoidElevation: ⓘ

If true, the Graph's ellipsoidToGeoidDifference is applied to all elevations returned by this query.

ignoreRealtimeUpdates: ⓘ

If true, realtime updates are ignored during this search.

intermediatePlaces: ⓘ

An ordered list of intermediate locations to be visited (see the fromPlace for format). Parameter can be specified multiple times.

locale: ⓘ

The locale to use for the response data translations. Defaults to `en`.

maxHours: ⓘ

Float. TODO add description

maxPreTransitTime: ⓘ

Integer. Seconds. The maximum time (in seconds) of pre-transit travel when using drive-to-transit (park and ride or kiss and ride). Defaults to unlimited.

maxTransfers: ⓘ

integer. The maximum number of transfers (that is, one plus the maximum number of boardings) that a trip will be allowed. Larger values will slow performance, but could give better routes. This is limited on the server side by the MAX_TRANSFERS value in org.opentripplanner.api.ws.Planner.

otherThanPreferredRoutesPenalty: ⓘ

Integer. Seconds. Penalty added for using every route that is not preferred if user set any route as preferred, i.e. number of seconds that we are willing to wait for preferred route.

preferredAgencies: ⓘ

List of preferred agencies.

preferredRoutes: ⓘ

List of preferred routes.

reverseOptimizeOnTheFly: ⓘ

If true, this trip will be reverse-optimized on the fly. Otherwise, reverse-optimization will occur once a trip has been chosen (in Analyst, it will not be done at all).

startTransitStopId: ⓘ

A transit stop required to be the first stop in the search (AgencyId_TripId i.e. "tec" + "_" + "gs:tec:12345": "tec_gs:tec:12345")

startTransitTripId: ⓘ

A transit trip acting as a starting "state" for depart-onboard routing (AgencyId_TripId i.e. "tec" + "_" + "gt:tec:12345": "tec_gt:tec:12345")

transferPenalty: ⓘ

Integer. An additional penalty added to boardings after the first. The value is in OTP's internal weight units, which are roughly equivalent to seconds. Set this to a high value to discourage transfers. Of course, transfers that save significant time or walking will still be taken.

triangleSafetyFactor: ⓘ

Float. For bike triangle routing, how much safety matters (range 0-1).

triangleSlopeFactor: ⓘ

Float. For bike triangle routing, how much slope matters (range 0-1).

triangleTimeFactor: ⓘ

Float. For bike triangle routing, how much time matters (range 0-1).

unpreferredAgencies: ⓘ

List of unpreferred agencies.

unpreferredRoutes: ⓘ

List of unpreferred routes.

useRequestedDateTimeInMaxHours: ⓘ

TODO : add description

waitAtBeginningFactor: ⓘ

Float. How much less bad is waiting at the beginning of the trip (replaces waitReluctance)

waitReluctance: ⓘ

Float. How much worse is waiting for a transit vehicle than being on a transit vehicle, as a multiplier. The default value treats wait and on-vehicle time as the same. It may be tempting to set this higher than walkReluctance (as studies often find this kind of preferences among riders) but the planner will take this literally and walk down a transit line to avoid waiting at a stop. This used to be set less than 1 (0.95) which would make waiting offboard preferable to waiting onboard in an interlined trip. That is also undesirable. If we only tried the shortest possible transfer at each stop to neighboring stop patterns, this problem could disappear.

walkBoardCost: ⓘ

Prevents unnecessary transfers by adding a cost for boarding a vehicle. This is the cost that is used when boarding while walking.

walkReluctance: ⓘ

Float. Defaults to 2. Walk cost is multiplied by this value. This is the main parameter to use for limiting walking. walkReluctance is a multiplier for how bad walking is compared to being in transit. Higher values discourage walking. Empirically, values between 10 and 20 seem to correspond well to the concept of not wanting to walk too much without asking for totally ridiculous itineraries, but this observation should in no way be taken as scientific or definitive. Your mileage may vary.

wheelchair: ⓘ

Whether the trip must be wheelchair accessible.