routing

Street routing from one to many places or many to one. The order in the response array corresponds to the order of coordinates of the \`many\` parameter in the request body.

Changed on
post/api/v1/one-to-many

Request

  • Base URL
    https://api.transitous.org
  • URL
    https://api.transitous.org/api/v1/one-to-many
  • Auth
    none declared

Request body

onestring required

geo location as latitude;longitude

manystring[] required

geo locations as latitude;longitude,latitude;longitude,...

The number of accepted locations is limited by server config variable onetomany_max_many.

mode'WALK' | 'BIKE' | 'RENTAL' | 'CAR' | 'HGV' | 'CAR_PARKING' | 'CAR_DROPOFF' | 'ODM' | 'RIDE_SHARING' | 'FLEX' | 'DEBUG_BUS_ROUTE' | 'DEBUG_RAILWAY_ROUTE' | 'DEBUG_FERRY_ROUTE' | 'TRANSIT' | 'TRAM' | 'SUBWAY' | 'FERRY' | 'AIRPLANE' | 'BUS' | 'COACH' | 'RAIL' | 'HIGHSPEED_RAIL' | 'LONG_DISTANCE' | 'NIGHT_RAIL' | 'REGIONAL_FAST_RAIL' | 'REGIONAL_RAIL' | 'SUBURBAN' | 'FUNICULAR' | 'AERIAL_LIFT' | 'OTHER' | 'AREAL_LIFT' | 'METRO' | 'CABLE_CAR' required

Street modes

  • WALK
  • BIKE
  • RENTAL Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
  • CAR
  • HGV Heavy goods vehicles (only supported for direct connections)
  • CAR_PARKING Experimental. Expect unannounced breaking changes (without version bumps) for all parameters and returned structs.
  • CAR_DROPOFF Experimental. Expect unannounced breaking changes (without version bumps) for all perameters and returned structs.
  • ODM on-demand taxis from the Prima+ÖV Project
  • RIDE_SHARING ride sharing from the Prima+ÖV Project
  • FLEX flexible transports

Transit modes

  • TRANSIT: translates to TRAM,FERRY,AIRPLANE,BUS,COACH,RAIL,ODM,RIDE_SHARING,FUNICULAR,AERIAL_LIFT,OTHER
  • TRAM: trams
  • SUBWAY: subway trains (Paris Metro, London Underground, but also NYC Subway, Hamburger Hochbahn, and other non-underground services)
  • FERRY: ferries
  • AIRPLANE: airline flights
  • BUS: short distance buses (does not include COACH)
  • COACH: long distance buses (does not include BUS)
  • RAIL: translates to HIGHSPEED_RAIL,LONG_DISTANCE,NIGHT_RAIL,REGIONAL_RAIL,SUBURBAN,SUBWAY
  • HIGHSPEED_RAIL: long distance high speed trains (e.g. TGV)
  • LONG_DISTANCE: long distance inter city trains
  • NIGHT_RAIL: long distance night trains
  • REGIONAL_FAST_RAIL: deprecated, REGIONAL_RAIL will be used
  • REGIONAL_RAIL: regional train
  • SUBURBAN: suburban trains (e.g. S-Bahn, RER, Elizabeth Line, ...)
  • ODM: demand responsive transport
  • RIDE_SHARING: ride sharing
  • FUNICULAR: Funicular. Any rail system designed for steep inclines.
  • AERIAL_LIFT: Aerial lift, suspended cable car (e.g., gondola lift, aerial tramway). Cable transport where cabins, cars, gondolas or open chairs are suspended by means of one or more cables.
  • AREAL_LIFT: deprecated
  • METRO: deprecated
  • CABLE_CAR: deprecated
maxnumber required

maximum travel time in seconds. Is limited by server config variable street_routing_max_direct_seconds.

maxMatchingDistancenumber required

maximum matching distance in meters to match geo coordinates to the street network

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

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.
arriveByboolean required

true = many to one false = one to many

withDistanceboolean

If true, the response includes the distance in meters for each path. This requires path reconstruction and may be slower than duration-only queries.

Response

A list of durations. If no path was found, the object is empty.

durationnumber

duration in seconds if a path was found, otherwise missing

distancenumber

distance in meters if a path was found and distance computation was requested, otherwise missing

Changes

  • dbfe4b7f2babRevision changes
    • info

      added the new HGV enum value to the request property

  • 55cf0dab5be0Revision changes
    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property default value false was added