Query Parameters

Parameter Name Description Usage
address Free-form address text. Required
country A three character long code that represents the country for the corresponding address.

For example : USA

It is recommended to enter the country in the request.

There is no default value for the parameter and no value is passed in the request while making the API call.

Optional
distance Specifies the distance between the input address and the outer boundary of the region.

In case, the boundary is a circle then this distance is the radius and the input address is the center.

Note: This parameter can have only positive values.
Required
distanceUnit Specifies the unit in which the distance is measured. Acceptable values:
  • Feet
  • Metres
  • Kilometers
  • Miles
Default: Feet
Optional
resolution Specifies the resolution of the boundary. Curves generated for the boundary are approximated by line segments and measured in segments per circle.

Higher resolution results in smoother curves for the boundary but also increases the cost.

Number specified for resolution needs to be greater than 0 and in multiple of 4. If not, it is rounded off to nearest multiple of 4.

Optional
responseSrs The spatial reference system in which the response is expressed.

Default value is: epsg:4236

Optional