Post Request Parameters

Parameter Description Usage
geometry Represents a Polygon geometry in GeoJSON or GML Format (based on request format). Polygon should contain atleast 3 points.

The type of geometry should be 'Polygon'. 'Multipolygon' Geometry is not accepted.

Only WGS84(epsg:4326) CRS value is supported.

 Required, either one of them.
geometryAsText Text which represents a polygon in WKT format along with CRS (optional). Polygon should contain atleast 3 points.

Only WGS84(epsg:4326) CRS value is supported.

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))

Default, and the only allowed value of SRID is 4326 i.e WGS84.
latitude Latitude of the location. Optional
longitude Longitude of the location. Optional
travelTime Travel Time based on travelMode within which Addresses are searched.

Maximum value is 10 minutes.

 Optional
travelTimeUnit Travel time unit such as minutes, hours, seconds or milliseconds.

Default value is Minutes.
travelDistance Travel Distance based on travelMode within which Addresses are searched.

Maximum value is 5 miles.
travelDistanceUnit Travel distance unit such as Feet, Kilometers, Miles or Meters.
travelMode Mode of commute. Required when travelDistance or travelTime is specified.

Accepted values are Walking or Driving.
maxCandidates Maximum number of addresses to be returned in response. Max. value is 100 for JSON, and 2000 for CSV.
page Specifies the page number of results. Allows API consumer to implement pagination in their application.

Page size is the value of maxCandidates in request. For example:

  • If page value is 1 and maxCandidates value is 20 then response will have matching results from rank 1 to 20.
  • If page value is 11 and maxCandidates value is 20 then response will have matching results from rank 201 to 220.
  • If page value is 19 and maxCandiates value 10 then response will have matching results from rank 181 to 190.