Click the Try it out button in the upper-right corner.
Enter Query in the query field.
Enter Country in the Country field using the 3 digit ISO code.
(Optional) Enter Location using the geographic coordinates of the location where the user is searching for an address, in the format "{latitude},{longitude}" (USA ONLY).
(Optional) Under Take which is the maximum number of results to be returned. The default value is 7.
(Optional) Under Dataset which is the name of the dataset to be used for the country where the address is located.
Click the Execute button to send the request to the API.
View the response returned by the API under Responses. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out Response status codes to find out more about scenarios where the API returns errors.
Postman is a free, easy-to-use third-party application that you can use to send API calls.
Follow these instructions to send requests to the API via Postman:
Open the Postman app and click Import in the upper-left corner.
Import the file you've downloaded.
Go to the Collections tab on the left-hand side panel and click the API request you want to test.
Go to the Headers tab.
Replace the {{Auth-Token}} value with your token.
Go to the Body tab.
(Optional) Replace the address value with an address of your choice. Note that the address value must be enclosed in quotation marks, e.g. "125 summer St". Alternatively, you can skip this step and use the preset values.
Click Send to submit the API request.
View the response returned by the API. Note that your request was successful only if the API returned an HTTP status code of 200 - Success. Check out Response status codes codes to find out more about scenarios where the API returns errors.
