About this endpoint
What it does
Searches for addresses using a text query and returns a JSON object response. The request accepts query parameters for the search text, an optional result limit, and an optional country code.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| limit | Integer | No | Maximum number of results to return. Default: 20. Minimum: 1. Maximum: 200. |
| query | String | Yes | Search text. Minimum length: 2. |
| country_code | String | No | Optional 2-character country code. |
Response
Returns a JSON object containing the search query, number of matches, matching addresses, and attribution information.