Query Parameters

Parameter Description Usage
address Free-form text. Required
maxCandidates Specifies the maximum number of water bodies that this service retrieves. The default value is 1. The retrieved water bodies are distance ordered from the specified location. Maximum of 3 water bodies can be retrieved. Optional
waterBodyType Specifies the type of water bodies to be returned. The type of water bodies include:
  • oceanandsea
  • lake
  • others
  • unknown
  • intermittent
  • all

Default: 'all'

The input values can be case-insensitive. 		Optional
searchDistance Specifies the distance within which this method searches for water bodies. If not provided, the nearest water body is searched. The allowed minimum value is greater than or equal to 0 and maximum range in all allowed units is mentioned below:

Default: 20 Miles

In Miles: upto 100 Miles

In Feet: upto 528,000 Feet

In Kilometers: upto 160.934 Kilometers

In Meters: upto 160934 Meters

In case no value is provided, the default searchDistance of 20 miles is applicable.

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

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

The input values can be case-insensitive.

Optional