Query Parameters

Parameter Description Usage
areaName1 Specifies the largest geographical area, typically a state or province. Required, if areaName2, areaName3, or areaName4 is provided.
areaName2 Specifies the secondary geographic area, typically a county or district.

Click here to view full list of areaName2 for USA.

Note: The name should exactly match, as provided in the above downloaded document.
 Required, either one of these.
areaName3 Specifies a city or town name.

Click here to view full list of areaName3 for USA.

Click here to view full list of areaName3 for Canada.
Note: The name should exactly match, as provided in the above downloaded document.
areaName4 Specifies a city subdivision or locality/neighborhood.

Click here to view full list of areaName4 for USA.

Click here to view full list of areaName4 for Canada.
Note: The name should exactly match, as provided in the above downloaded document.
postCode Specifies the postcode (ZIP code) in the appropriate format for the country. Optional
country 3 letter ISO code of the country to be searched. Optional
maxCandidates Maximum number of addresses to be returned in response.

Default value is 20 for JSON and 2000 CSV.

Maximum value is 100 for JSON and 2000 for CSV.

 Optional
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.
 Optional