Query Parameters

Parameter Description Usage
latitude The latitude of the location. (WGS 84 datum or EPSG:4326 coordinate system) Optional
longitude The longitude of the location. (WGS 84 datum or EPSG:4326 coordinate system) Optional
searchText
This parameter accepts a free text, which can be a combination of Name or Address components, as shown below:
Table 1. Name and Address Components in Data
Name Components Address Components
Name Main Address Line
Brand Name Address Last Line
Trade Name AreaName1
AreaName2
AreaName3
AreaName4
STABB
Postcode
Formatted Address
Country
Both Name and Address components are optional and searchText can have either one or both components. It also accepts partial input.
 Optional
type Filters the points of interest (POIs) by place types. For example, bank, atm, hospital, school, park, police, zoo etc.

Click here to view a list of popular types.

Any possible place type could be mentioned in this parameter even if that type is not available in the above list. This service matches the input type against place descriptions and types, and return best matching relevant results.

 Optional
categoryCode Acts as a filter to narrow down and refine POI search results. The input value(s) are comma separated category codes. The category codes are unique 4, 6, or 11 digit numeric values.

Maximum of 10 category codes can be specified in a comma-separated format. Click here to view full list of category codes.

Optional
sicCode Acts as a filter to narrow down and refine POI search results. The input value(s) are comma separated SIC codes. The SIC codes are unique 4 or 8 digit SIC codes.

Maximum of 10 SIC codes can be specified in a comma-separated format. Click here to view full list of SIC codes.

maxCandidates Specifies the maximum number of POIs to be retrieved.

Default Value: 10

Maximum Value: 20

 Optional
searchRadius

Specifies the radius within which this method searches for results. If not provided, the default value mentioned below is applicable. The allowed minimum value is greater than 0 and maximum range in all allowed units is mentioned below:

In Miles: upto 100 Miles

In Feet: upto 528000 Feet

In Kilometers: upto 160.934 Kilometers

In Meters: upto 160934 Meters

Default value in allowed units is as mentioned below:

In miles: 2 Miles

In Feet: 10560 Feet

In Kilometers: 3.218688 Kilometers

In Meters: 3218.688 Meters

'searchRadius' 'travelTime' and 'travelDistance' parameters define the search boundary. If all are specified, then the search is performed in the order below:
  1. 'searchRadius'
  2. 'travelTime'
  3. 'travelDistance'

    If any parameter is not specified, the search is performed based on the next parameter in the order. For example: If 'searchRadius' is specified 'travelTime' and 'travelDistance' parameters are ignored. If 'searchRadius' is not specified, the search is performed based on 'travelTime'. If 'travelTime' is not specified, the search is performed based on 'travelDistance'.

Optional
searchRadiusUnit The acceptable unit values are: Feet, Kilometers, Miles and Meters.

The searchRadiusUnit is optional, if not provided, the unit ‘Meters’ is taken by default, otherwise the search is performed based upon the searchRadius calculated in the specified unit. The search results are returned accordingly in the specified unit. For example, 'Kilometers' searchRadiusUnit returns results in 'Kilometers'.

The input values can be case-insensitive.

Optional
travelTime Specifies the travel time within which method searches for results (POIs which can be reached within travel time)the search boundary in terms of time mentioned in 'travelTimeUnit'. The results are retrieved based on the travel time specified. This means search can be done in the mentioned time results be from the mentioned time.

Maximum Value: 2.5 hours.

 Optional
travelDistance Specifies the search boundary in terms of distance mentioned in 'travelDistanceUnit'. The results are retrieved from the polygon formed based on the travel distance specified.

Maximum Value: 100 miles.

 Optional
travelTimeUnit Specifies acceptable time units:
  • Minutes
  • Hours
  • Seconds
  • Milliseconds
 Optional
travelDistanceUnit Specifies acceptable time units:
  • Feet
  • Kilometers
  • Miles
  • Meters
 Optional
travelMode Specifies the available mode of commute. This is required when you are trying to do search by travel distance or travel time.
  • 'driving'
  • 'walking'

Default: 'driving'

 Optional
country 3 character ISO code or country name. Optional
areaName1 Specifies the largest geographical area, typically a state or province. This parameter is used along the country parameter. Optional
areaName3 Specifies the name of city or town. This parameter is used along the country parameter. Optional
postcode1 Post code in the appropriate format for the country. This parameter is used along the country parameter. Optional
postcode2 Post code extension in the appropriate format for the country. Optional
ipAddress

Specifies the ip address to be used to detect the location to perform the address search around that location. The parameter is used only when explicit location (latitute and longitude) is not provided in the request.

If the ip address is provided in query parameter, it will be used for detecting location. If ip address is not provided in query parameter, the ip address embedded in the request header will be considered for detecting location if autoDetectLocation parameter is stated to 'True'. If 'False' is set. the ip address is ignored.

 Optional
autoDetectLocation
Specifies whether to auto-detect location from IP address. If 'True' is set, the location is detected from the specified ip address. If 'False' is set. the search will happen according to country or location.

Possible Values: 'True' or 'False'.

Default: 'False'

The following scenarios apply in case of autoDetectLocation:
IP Address Not provided True False
IP Address parameter Yes Yes No
IP Address Header No Yes No
Optional
sortBy Whether to sort the results based on relevance (best match) or by nearest distance from input address. Possible values -
  • relevance (default)
  • distance
 Optional
searchOnNameOnly This parameter allows to do only a Name based POI search. Y indicator will allow the search on name component only. The default value is N Optional
matchMode Select a leniency to be used when making a match between your input name and the reference data. Allowed values are:
  • Specific: This is the default mode, and generally provides the best balance of accurate matches, few false matches, and high performance. It assumes that the user has entered the complete name with correct spelling.

    For example: If you enter "Pizza Hut", POIs with extra words other than "Pizza Hut" will not be returned.

    Fuzzy search is not supported for this match mode.

  • Exact: This will return POIs containing all terms/words provided in the name parameter.

    For example: If you enter "Pizza Hut", POIs with name "KFC Pizza Hut Corp" will also be returned.

  • Relaxed: This will return all close matches including partial matches. Fuzzy search is also supported with this match mode.

    For example: If you enter "Pizza Hut", "Pizzeria Hut" will also be returned. For multiple words, both words be used in the search.

 Optional
specificMatchOn This allows a specific match against Name, Brand Name, Trademark or Any other POI. Optional