Search service addresses
Paginated endpoint — This API returns paginated results. Use the pageNumber and pageSize query parameters to control which page of results is returned. The response includes pagination metadata in the response headers. See the Pagination guide for details.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Query Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| address | The address fragment to search for | string | Optional |
| pageSize | The number of elements to return in a page | integer (int32) | Optional |
| pageNumber | The current page number | integer (int32) | Optional |
Response Headers
This endpoint returns pagination metadata in the response headers.
| Header | Type | Description |
|---|---|---|
| PageNumber | integer | The current page number (1-based). |
| PageSize | integer | The maximum number of items per page. |
| TotalNumberOfRecords | integer | The total number of records matching the query across all pages. |
| TotalPages | integer | The total number of pages. Increment pageNumber until it equals this value to retrieve all results. |
See the Pagination guide for iteration examples and best practices.
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
Array of:
AddressLookup
| Property | Description | Type |
|---|---|---|
| addressTypeId | integer (int32) | |
| city | string | |
| country | string | |
| latitude | number (double) | |
| line1 | string | |
| line2 | string | |
| line3 | string | |
| locationProperties | object | |
| longitude | number (double) | |
| postalCode | string | |
| state | string | |
| uniqueLocationIdentifier | string |
Example Response
[
{ "addressTypeId": 1, "city": "string", "country": "string", "latitude": 1.0, "line1": "string", "line2": "string", "line3": "string", "locationProperties": {}, "longitude": 1.0, "postalCode": "string", "state": "string", "uniqueLocationIdentifier": "string"
}
]