Parameters
| Parameter: | Required: | Type: | Description: | Default: | Examples: |
| q0 | Required (if c0 is not provided). | String | Full address free text of the origin (e.g. q=24 ben gurion st. tel aviv) or - Address separated according to administrative levels (e.g. q0=;state|cl;city|denver;street|mall) | q0=chicago, il q0=;state|cl;city|denver;street|mall |
|
| q1..q(n-1), qn | Required (if c1 is not provided). | String | Full address free text of the origin (e.g. q=24 ben gurion st. tel aviv) or - Address separated according to administrative levels (e.g. q1=;state|cl;city|denver;street|mall) | q1=chicago, il q1=;state|cl;city|denver;street|mall |
|
| c0 | Required (if q0 is not provided). | String | coordinate of the origin | c0=-73.971787,40.7972 | |
| c1..c(n-1), cn | coordinate of the destination / milestones | c1=-73.971787,40.7972 | |||
| countrycode | Optional - Simple geocoder Required - Composed geo-coder | String | Country code of the map currently viewed by the client. The country code is according to ISO-ALPHA-3 code: http://unstats.un.org/unsd/methods/m49/m49alpha.htm | countrycode=usa | |
| key | Required | String | your API Key | key=YOUR_API_KEY | |
| lang | Optional | String | Language of the client according to ISO-639-3 code. http://www.w3.org/WAI/ER/IG/ert/iso639.htm | according to country code | lang=eng |
| lookup | Optional | Boolean | Tells the service to consider external data with repositioning of addresses. This is a tool for fixing misplacement of addresses in the data of the map data provider. | false | lookup=true |
| minGrade | Optional | Double | Threshold grade (0-1) for relevance of results which will be returned by the service. | 0.8 | minGrade=0.6 |
| minNotExactGrade | Optional | Double | minimum threshold grade (0-1) for found address for not giving a not-exact result. | 0.5 | minNotExactGrade=0.9 |
| projection | Optional | String | Map projection type | projection=webmercator | |
| output | Optional | String | output format of the response. Valid values: [ json | jsonp | kml ] | kml | output=json |
| ie | Optional | String | input encoding of request | utf-8 | ie= windows-1255 |
| iconformat | Optional | String | Format of icon which will represent the result on the map display | png | iconformat=jpg |
| sensor | Optional | Boolean | whether the API is called from a device with a positioning sensor (GPS) | false | sensor=true |
| routeType | Optional | String | type or route to be calculated | fastest | routeType=Shortest |
| vehicle | Optional | String | type or route to be calculated: car or pedestrian | car | vehicle=pedestrian |
| tollway | Optional | Boolean | allow or prohibit driving through tollways | false | tollway=true |
| heading | Optional | Double | Angle of route starting point. The service will consider the heading value when choosing the route direction. | false | heading=120 |
| showDiscripton | Optional | Boolean | If not True, the output will be JSON, and the result will include only the route duration, without driving directions or any other details. | true | showDiscription=false - don’t show route description showDiscription=true - show route maneuvers showDiscription=time - show only time showDiscription=length - show only length showDiscription=time;length - show only time & length |
| traffic | Optional | Boolean | If true, the route will consider real-time traffic information for calculating driving time, and decide upon the fastest route. | false | traffic=true |
| slim | Optional | Boolean | if True, removes less commonly used tags from the response | false | slim=true |
Routing approximation parameters
For optimization purposes, it is possible to setup the request in a way that saves time, while making the algorithm stricter or using approximations:
| Parameter: | Required: | Type: | Description: | Default: | Examples: |
| approximationDistance | Optional | Integer (meters) | Distance to destination that can be used as a result. If a route to the destination itself was not found, but a route with this distance was found, the found route will be returned | q0=chicago, il q0=;state|cl;city|denver;street|mall |