Project OSRM

Open Source Routing Machine

Location of the server.

Example: 10.15.162.7:5000

Service	Description
nearest	returns the nearest street segment for a given coordinate
route	shortest path between given coordinates
table	computes duration tables for given coordinates
match	matches given coordinates to the road network
trip	compute the shortest round trip between given coordinates

1.  General options can be used with all services.
2. Refer to Additional options of each service for more options.

Option	Values	Description
bearings	{bearing};{bearing}[;{bearing} ...]	Limits the search to segments with given bearing in degrees towards true north in clockwise direction.
radiuses	{radius};{radius}[;{radius} ...]	Limits the search to given radius in meters.
hints	{hint};{hint}[;{hint} ...]	Hint to derive position in street network.

Code	Description
Ok	Request could be processed as expected.
InvalidUrl	URL string is invalid.
InvalidService	Service name is invalid.
InvalidVersion	Version is not found.
InvalidOptions	Options are invalid.
NoSegment	One of the supplied input coordinates could not snap to street.
TooBig	The request size violates one of the service specific request size restrictions.

*optional human-readable error message. (code Ok usually don’t come with any message)

single {longitude},{latitude}

number

code -  if the request was successful: Ok ,otherwise see the service dependent and general status codes above.

waypoints - array of Waypoint objects sorted by distance to the input coordinate. Each object has at least the following additional properties:

• distance - Distance in meters to the supplied input coordinate.

Response:

http://10.15.162.7:5000/nearest/v1/driving/101.69300,3.13739?number=3&radiuses=50

Eg.

alternatives

steps

annotations

geometries

overview

continue_straight

code - if the request was successful: Ok ,otherwise see the service dependent and general status codes.

waypoints - Array of Waypoint objects representing all waypoints in order

routes - An array of Route objects, ordered by descending recommendation rank.

Response:

http://10.15.162.7:5000/route/v1/driving/101.69300,3.13739;101.66567,3.11573?steps=true&overview=false&alternatives=true

Eg.

code - if the request was successful: Ok ,otherwise see the service dependent and general status codes.

durations - array of arrays that stores the matrix in row-major order. Values are given in seconds.

sources - array of Waypoint objects describing all sources in order

destinations - array of Waypoint objects describing all destinations in order

Response:

http://10.15.162.7:5000/table/v1/driving/101.69300,3.13739;101.68756,3.13291;101.66567,3.11573

Eg.

sources

destinations

code - if the request was successful Ok otherwise see the service dependent and general status codes.

tracepoints - Array of Ẁaypoint objects representing all points of the trace in order. If the trace point was ommited by map matching because it is an outlier, the entry will be null. Each Waypoint object has the following additional properties:

• matchings_index - Index to the Route object in matchings the sub-trace was matched to.
• waypoint_index - Index of the waypoint inside the matched route.

matchings - An array of Route objects that assemble the trace. Each Route object has the following additional properties:

• confidence - Confidence of the matching. float value between 0 and 1. 1 is very confident that the matching is correct.

Response:

http://10.15.162.7:5000/match/v1/driving/101.69300,3.13739;101.69040,3.13603?steps=true&overview=false

Eg.

steps

geometries

annotations

overview

timestamps

radiuses

code - if the request was successful Ok otherwise see the service dependent and general status codes.

waypoints - Array of Waypoint objects representing all waypoints in input order. Each Waypoint object has the following additional properties:

• trips_index - Index to trips of the sub-trip the point was matched to.
• waypoint_index - Index of the point in the trip.

trips - An array of Route objects that assemble the trace.

Response:

http://10.15.162.7:5000/trip/v1/driving/101.69300,3.13739;101.66567,3.11573?overview=false

Eg.

steps

annotations

geometries

overview

RouteStep

Consists of a maneuver such as a turn or merge, followed by a distance of travel along a single way to the subsequent step.

{"intersections":
[{"out":0,"in":2,"entry":[true,true,false,false],"bearings":[0,90,180,270],"location":[101.662552,3.115442]},
{"out":0,"in":1,"entry":[true,false,false],"bearings":[0,180,210],"location":[101.662549,3.116177]},
{"out":0,"in":2,"entry":[true,false,false],"bearings":[30,120,210],"location":[101.662865,3.1173]},
{"out":1,"in":2,"entry":[true,true,false],"bearings":[15,45,225],"location":[101.663481,3.118112]},
{"out":0,"in":1,"entry":[true,false,false],"bearings":[90,270,330],"location":[101.664188,3.118541]},
{"out":1,"in":2,"entry":[true,true,false],"bearings":[75,120,285],"location":[101.665164,3.11837]}],

"geometry":"on_R}}nkRsC?w@?iAQ}Am@oCkBQMw@u@O]K[A]B{@\\eCBI",

"maneuver":
{"bearing_after":360,"bearing_before":357,
"location":[101.662552,3.115442],
"modifier":"straight","type":"turn"},
"mode":"driving",
"duration":37.6,
"name":"Jalan Pantai Baru",
"distance":537.6},

http://10.15.162.7:5000/route/v1/driving/101.69300,3.13739;101.66567,3.11573?steps=true&overview=false

turn: a basic turn into direction of the modifier

new name: no turn is taken/possible, but the road name changes. The road can take a turn itself, following modifier.

depart: indicates the departure of the leg

arrive: indicates the destination of the leg

merge: merge onto a street

on ramp: take a ramp to enter a highway (direction given my modifier)

off ramp: take a ramp to exit a highway (direction given my modifier)

fork: take the left/right side at a fork depending on modifier

end of road: road ends in a T intersection turn in direction of modifier

continue: Turn in direction of modifier to stay on the same road

roundabout: traverse roundabout, has additional field exit with NR if the roundabout is left

rotary: a larger version of a roundabout, can offer rotary_name in addition to the exit parameter.

roundabout turn: Describes a turn at a small roundabout that should be treated as normal turn. The modifier indicates the turn direciton. Example instruction: At the roundabout turn left.

notification: not an actual turn but a change in the driving conditions. For example the travel mode. If the road takes a turn itself, the modifier describes the direction

uturn: indicates reversal of direction

sharp right: a sharp right turn

right: a normal turn to the right

slight right: a slight turn to the right

straight: no relevant change in direction

slight left: a slight turn to the left

left: a normal turn to the left

sharp left: a sharp turn to the left

{"intersections": [{"out":0,"in":2,"entry":[true,true,false,false],"bearings":[0,90,180,270],"location":[101.662552,3.115442]},

Data Format

only supports plaintext ASCII grid sources (.asc)

Profiles

Data must be tagged along with profiles (.lua)