Parameters
Parameter: | Required: | Type: | Description: | Default: | Examples: |
q | Required | String | Address (full address free text or separated according to administrative levels | q=10 6th ave, manhattan, ny, 10004 q=broadway, manhattan, ny q=main, new york, ny q=chicago, il q=ny, 10003 q=;state|cl;city|denver;street|mall |
|
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 |
resultslimit | Optional | Integer | maximum number of returned results in response | 5 | resultslimit=5 |
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 |
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 |
poicategories | Optional | String | POI category IDs to consider for the geo-coder response. Can be no category, a list of categories, or all POI categories ('*'). | no POIs. | poicategories=* poicategories=12,34,52 |
minGrade | Optional | Double | Threshold grade (0-1) for relevance of results which will be returned by the service. | 0.8 | minGrade=0.6 |
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 |
rc | Optional | String | Reference coordinates and zoom level for the search: long, lat, zoom-Level | rc=3-,12.13476,14.12441 |