---
title: "Retrieves a list of addresses"
method: GET
path: "/v2/address/typeahead"
tags: ["Address"]
---

# Retrieves a list of addresses

`GET /v2/address/typeahead`

## Request

- Base URL: `https://api.alianza.com`
- URL: `https://api.alianza.com/v2/address/typeahead`
- Auth: API key in header `X-AUTH-TOKEN`
- TypeScript: <https://skmtc.dev/alianza/apis/alianza-public-api/docs/v2/address/typeahead/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of strings containing addresses. Use to build features like autocomplete search. As an address is typed in a list of potential addresses will be returned. A partial address can be used, for example, for zipcode 13905, just inputting the number 135 will bring back several addresses in the zipcode that begin with 135. If 135 F is input several addresses are brought back, including Front St.

## Query parameters

- `address` string, required
- `country` 'USA' | 'CAN' | 'UNK', required
- `postalCode` string

## Response `200`

Successful operation

- string[]

## Other responses

- `400`: Invalid request parameters
- `401`: Unauthorized
- `404`: Zipcodes not found

---

[API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/7223246c352c?raw)