Query Parameters

Note: To perform search, it is mandatory to specify either latitude/longitude, country or ipAddress input parameter.
Parameter Description Usage
transactionId For calling List endpoint a mandatory transactionId is required. To know how to generate a transactionId, see Transaction ID and Its Generation. Required
longitude The longitude of the location. (WGS 84 datum/EPSG:4326 coordinate system) Optional
latitude The latitude of the location. (WGS 84 datum/EPSG:4326 coordinate system) Optional
searchText The input to be searched. Required
maxCandidates Specifies the maximum number of addresses that this service retrieves.

The maxCandidates parameter is optional, if not provided, maximum 10 results are retrieved by default. Maximum of upto 20 results can be retrieved.

Optional
searchRadius Specifies the radius within which this service 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: 160.934 Kilometers

In Meters: 160934 Meters

Default value in allowed units is as mentioned below:

In miles: 10 Miles

In Feet: 52800 Feet

In Kilometers: 16.09344 Kilometers

In Meters: 16093.4 Meters

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

The searchRadiusUnit is optional, if not provided, the unit ‘Feet’ 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 are case-insensitive.

Optional
country

Accepts ISO code of supported countries. If the search is performed based on 'country' input only, the service searches for results in the entire country. For Example, provide AUS as input to perform search within Australia. In case the search is performed based on 'country', 'latitude/longitude' and 'searchRadius', the search coverage varies as per the following use cases:

Table 1.
latitude/longitude/ IP Address country searchRadius Search Coverage
Yes No No Search is performed within the default radius of 10 miles.
Yes No Yes Search is performed within the mentioned radius.
Yes Yes No Search begins from the mentioned location coordinates and spreads out throughout the entire country. Here, the default search radius of 10 miles is applicable.
Yes Yes Yes Search begins from the mentioned location coordinates and searches within the specified radius around the specified location coordinates in the mentioned country.
No Yes No Search is performed on the entire country to fetch results.
No Yes Yes Search is performed on the entire country to fetch results. Here, the default radius of 10 miles and maximum radius of 100 miles is not applicable even if provided.

The input values are case-insensitive.

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 the city or town. This parameter is used along the country parameter. Optional
postCode Postal code in the appropriate format for the country. This parameter is used along the country parameter. Optional
matchOnAddressNumber

Specifies whether an address number match is required. By default, an address number match is not required.

Valid values: 'True' or 'False'.

Default: 'False'.

The input value is case insensitive.

 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 (latitude 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'

 Optional
returnAdminAreasOnly Specifies whether to return admin areas only with given search text. When this parameter is set to true, it will match text on postcode, county, city, state, province fields of address and return admin areas.

Possible Values: 'Y' or 'N'.

Default: 'N'

Note: This will be given preference if both returnAdminAreasOnly and searchOnAddressNumber are set to Y.
 Optional
searchOnAddressNumber Specifies if Address Number matching the input number are returned or not. Currently when you input just a number in the MainAddressLine, responses with street names that match the input number are returned. For example:

An input of 350 could return the following response:

  • 225 S 350 E, # 350E, PIMA, AZ 85543
  • 1244 W 350 N, PIMA, AZ 85543
  • 112 E 350 N, BLACKFOOT, ID 83221

Once you set searchOnAddressNumber=Y, the same input would return these response:

  • 350 EDNA RD, HOOVER, AL 35244
  • 350 OAK LEAF CIR, HOOVER, AL 35244
  • 350 SUMMIT PL, BIRMINGHAM, AL 35243

Possible Values: 'Y' or 'N'.

Default: 'N'

 Optional
includeRangesDetails Specifies whether to return ranges and units information in the response. When this parameter is set to true, it will return place name and unit details in response.

Possible Values: 'Y' or 'N'.

Default: 'Y'

 Optional
searchOnUnitInfo

Specifies whether to enable search for matching on Apartment/House number of the address. When this parameter is set to ‘Y’, it will search in unit information of the address.

Possible Values: 'Y' or 'N'.

Countries supported for this feature: GBR, CAN, AUS, USA, NLD, BEL

Default: ‘N’ for USA, NLD, BEL
‘Y’ for GBR, CAN, AUS
Optional
searchOnPOBox

Specifies whether to enable search for matching on PO Box. When this parameter is set to ‘Y’, it enables PO Box search, it will include PO Box in its search.

Possible Values: 'Y' or 'N'.

Default: 'N'

 Optional