Request Parameters

Parameter Description Usage
geometry The polygon geometry either in GeoJSON or GML format. Required (Either this or geometryAsText)
geometryAsText Text representing a polygon in WKT format along with an optional CRS (Coordinate Reference System) WGS84 (epsg:4326) value.
For example,
SRID=4326;POLYGON((75.15 29.53 1,77 29 1,77.6 29.5 1,75.15 29.53 1))
polygon((75.15 29.53 1,77 29 1,77.6 29.5 1,75.15 29.53 1));SRID=4326
POLYGON((75.15 29.53 1,77 29 1,77.6 29.5 1,75.15 29.53 1))
 Required (Either this or geometry)
countSummaryBy This returns the POI count based on categoryCode, sicCode, categoryCode4, categoryCode6, and sicCode4. Multiple comma-spearated values are also accepted.
name

Specifies the name of the place (POI) to be searched. Also performs search on partially specified names. It requires minimum 3 characters to search.

The input values can be case-insensitive.

For Example, "KFC", "Citi Bank", "Toyota", "Nike" etc.

 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 per page.

Default Value: 20 for JSON response format and 2000 for CSV.

Maximum Value: 100 for JSON response format and 2000 for CSV format.

Maximum of 20,000 POIs can be returned overall for a given search criteria. We recommend you to use filters (such as categoryCode, sicCode and searchRadius) to narrow down your search and get the relevant results.

 Optional
fuzzyOnName

Y for fuzzy search

N for non fuzzy search

 Optional
page This parameter is used for pagination. The default value is 1. 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