MapmyIndia Route / Driving Directions API for World - beta

Easy To Integrate Maps & Location APIs & SDKs For Web & Mobile Applications

Disclaimer

The document contains sensitive information on parameters and responses that can be accessed only by MapmyIndia. Redistribution without permissions is prohibited. It is mandatory to take permissions from the author before sharing with any personnel outside MapmyIndia. This API is not valid for regions falling in bounding rectangle covering India & Sri Lanka, Nepal, Bangladesh & Bhutan.

Document Version History

API Version History

Introduction

Route and Navigation

Routing and displaying driving directions on map, including instructions for navigation, distance to destination, traffic etc. are few of the most important parts of developing a map based application. This REST API calculates driving routes between specified locations including via points based on route calculation type(optimal or shortest).

Security Type

• License key based authentication
• IP/domain based whitelisting

Input Method

GET

Contructing the request URL

Example URL:

https://apisuat.mappls.com/advancedmaps/v1/123/route_adv/driving/15.969083,45.810206;17.013984,43.301062?

where:

• "route_adv" is the chosen resource.
• profile is "driving"
• "15.969083,45.810206" is the start position.
• "17.013984,43.301062" is the end position of the route. Note: The position input is in decimal degree notation of longitude,latitude.

Request Parameters

Mandatory Parameters

1. lic_key: Allocated REST API license key. (part of URL). For this POC purpose, please use "123" as the API key.
2. coordinates: Coordinate is pair of comma separated longitude & latitude value. First coordinate will be consider as start point (mandatory); a last coordinate will be considered as end point (mandatory) and those in between are via points (optional). Example: {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] (part of URL).

Optional Parameters

1. geometries(string): This parameter used to change the route geometry format/density (influences overview and per step). Default value is
   • polyline with 5 digit precision;
   • polyline6 for 6 digit precision;
   • geojson for geometries as geojson.
2. steps(boolean): Return route steps for each route leg. Possible values are true/false. By default it will be used as false. <Recommended=false; unless otherwise recommended by MapmyIndia>
3. exclude(string): Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by .
4. bearings(integer): Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (shall be part of premium offering)
5. alternatives Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.
6. radiuses Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (shall be part of premium offering).
7. overview(string): Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values could be simplified (default), full, false. (shall be part of premium offering)

Response Parameters

1. code: if request is successful, response is ‘ok’. Else, see the service dependent and general status codes. In case of error, “NoRoute” code is supported (in addition to the general ones) which means “no route found”.
2. routes: An array of route objects, each having potentially multiple via points.
   • geometry: returns the whole geometry of the route as per given parameter ‘geometries’ default is encoded ‘polyline’ with 5 digit accuracy for positional coordinates.
   • legs: The legs between the given waypoints, representing an array of routes between two waypoints.
     • steps: Return route steps for each route leg depending upon steps parameter.
       • intersections: A list of Intersection objects¹ that are passed along the segment, the very first belonging to the StepManeuver².
         • classes: Categorised types of road segments e.g. Motorway
         • locations: longitude, latitude pair describing the location of the turn.
         • bearings: A list of bearing values (e.g. [0,90,180,270]) thxat are available at the intersection. The bearings describe all available roads at the intersection.
         • entry: A list of entry flags, corresponding in a 1:1 relationship to the bearings. A value of true indicates that the respective road could be entered on a valid route. false indicates that the turn onto the respective road would violate a restriction.
         • in: index into bearings/entry array. Used to calculate the bearing just before the turn. Namely, the clockwise angle from true north to the direction of travel immediately before the maneuver/passing the intersection. Bearings are given relative to the intersection. To get the bearing in the direction of driving, the bearing has to be rotated by a value of 180. The value is not supplied for depart maneuvers.
         • out: index into the bearings/entry array. Used to extract the bearing just after the turn. Namely, The clockwise angle from true north to the direction of travel immediately after the maneuver/passing the intersection. The value is not supplied for arrive maneuvers.
         • lanes: Array of Lane objects that denote the available turn lanes at the intersection. If no lane information is available for an intersection, the lanes property will not be present.
           • valid: verifying lane info.
           • indications: Indicating a sign of directions like Straight, Slight Left, Right, etc. To see the complete list of indications, please see article in wiki.
       • driving_side: “Left” (default) for India, Sri Lanka, Nepal, Bangladesh & Bhutan.
       • mode: signifies the mode of transportation; driving as default.
       • maneuver: A StepManeuver object representing a maneuver
         • location: A [longitude, latitude] pair describing the location of the turn.
         • bearing_before: The clockwise angle from true north to the direction of travel immediately before the maneuver.
         • bearing_after: The clockwise angle from true north to the direction of travel immediately after the maneuver.
         • modifier: An optional string indicating the direction change of the maneuver. To see the complete list of modifiers, please see article in wiki.
         • type: A string indicating the type of maneuver. New identifiers might be introduced without API change. Types unknown to the client should be handled like the ‘turn’ type, the existence of correct modifier values is guaranteed. To see the complete list of types, please see article in wiki.
       • distance: The distance of travel to the subsequent step, in float meters
       • duration: The estimated travel time, in float number of seconds
       • geometry: The un-simplified geometry of the route segment, depends on the given geometries parameter.
       • weight: Parameter for internal use only.
       • name: The name of the way along which travel proceeds.
       • ref: Highway numbers for the way, if available.
   • distance: The distance travelled by the route, in float; unit is meter.
   • duration: The estimated travel time, in float; unit is second.
   • weight_name: Parameter for internal purpose only.
   • weight: Parameter for internal use only.
3. waypoints: Array of Waypoint objects representing all waypoints in order
   • hint: Unique internal identifier of the segment (ephemeral, not constant over data updates) This can be used on subsequent request to significantly speed up the query and to connect multiple services. E.g. you can use the hint value obtained by the nearest query as hint values for route inputs.
   • name: Name of the street the coordinate snapped to.
   • location: longitude, latitude pair describing the snapped location of the waypoint.
   • distance: distance of coordinate from the street the coordinate snapped to.

Notes

1. An intersection gives a full representation of any cross-way the path passes bay. For every step, the very first intersection (intersections[0]) corresponds to the location of the StepManeuver. Further intersections are listed for every cross-way until the next turn instruction.
2. An object type representing maneuver.

Response Type

JSON: response will served as JSON

Response Codes {as HTTP response code}

• 200: To denote a successful API call.
• 204: DB Connection error.
• 400: Bad Request, User made an error while creating a valid request.
• 401: Unauthorized, Developer’s key is not allowed to send a request.
• 403: Forbidden, Developer’s key has hit its daily/hourly limit or IP or domain not white-listed.
• 404: HTTP not found
• 412: Precondition Failed, i.e. Mandatory parameter is missing
• 500: Internal Server Error, the request caused an error in our systems.
• 503: Service Unavailable, during our maintenance break or server down-times.

Sample Input

https://apisuat.mappls.com/advancedmaps/v1/123/route_adv/driving/15.969083,45.810206;17.013984,43.301062?steps=false

Sample Response

{
    "code": "Ok",
    "waypoints": [
        {
            "hint": "faRClPSkQpQGAAAAAwAAAAAAAAAkAAAAylTsQPmcOkAAAAAAfrEgQgYAAAADAAAAAAAAACQAAADeEAEATqvzABwCuwI7q_MAHgK7AgAArwvk1bwe",
            "distance": 1.49312,
            "location": [
                15.969102,
                45.810204
            ],
            "name": "Savska cesta"
        },
        {
            "hint": "0XJNgWBPPIwcAAAAiQAAADcAAAAAAAAAdZj7QXh6F0MMXXNCAAAAABwAAACJAAAANwAAAAAAAADeEAEAvZwDAa-4lALgnAMBxriUAgEArwjk1bwe",
            "distance": 3.81953,
            "location": [
                17.013949,
                43.301039
            ],
            "name": "Ulica Ante Starčevića"
        }
    ],
    "routes": [
        {
            "legs": [
                {
                    "steps": [],
                    "weight": 17906.7,
                    "distance": 453823.2,
                    "summary": "",
                    "duration": 17906.7
                }
            ],
            "weight_name": "routability",
            "geometry": "whrvG{}m`BhjTbaX`pJdp_@rnWfwVzLviNp`Tdsj@n`r@_mC~s]xva@~dm@uju@zpUewKzuQzAjsN}k_@vkZi}Lj}KtzDg`AvtIj{CuyA|sClf]`xNfyDpvx@ojyAtoXesT|~TuddAoi@c`t@fvV}gc@~fOotm@foHfuNvjHcsH",
            "weight": 17906.7,
            "distance": 453823.2,
            "duration": 17906.7
        }
    ]
}

Live Demo

Under Construction

For more details, please visit our full documentation.

For any queries and support, please contact:

Email us at apisupport@mapmyindia.com

Stack Overflow Ask a question under the mapmyindia-api

Support Need support? contact us!

Blog Read about the latest updates & customer stories

© Copyright 2019. CE Info Systems Pvt. Ltd. All Rights Reserved. | Terms & Conditions Contains portions from OSMF licensed under Open Database License (ODbL) v1.0 Written with StackEdit by MapmyIndia.