---
title: "Search for a list of addresses"
method: GET
path: "/addresses"
tags: ["address"]
---

# Search for a list of addresses

`GET /addresses`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/addresses`
- Auth: none declared
- TypeScript: <https://skmtc.dev/mountain-pass/apis/addressr-by-mountain-pass/docs/addresses/get.ts> (a function with typed inputs; its response is checked against the schema)

returns a list of addresses matching the search string

## Query parameters

- `q` string, required

## Response `200`

successful query

- object[]: The list of addresses matching the search string. The list may be paginated. A the `Link` header with a `rel` of `next` will be provided if there are additional results.
  - `sla` string, required: The full address flattened to a single line. The primary use is for search results and for autocomplete.
  - `ssla` string: The full address flattened to a single line. The primary use is for search results and for autocomplete.
  - `highlight` object
    - `sla` string, required: The full address flattened to a single line with matching search tokens highlighted
    - `ssla` string: The full address flattened to a single line with matching search tokens highlighted
  - `score` number, required: strength of the match relative to the other matches
  - `pid` string, required: The Persistent Identifier is unique to the real world feature this record represents.

## Other responses

- `400`: invalid query
- `500`: unexpected error
- `503`: service unavailable

## Changes

- **2026-08-09** `4a4c43b9b253`: 1 warning, 1 info
  - deleted the `query` request parameter `p`
  - api operation id `getAddresses` removed and replaced with ``
- **2026-07-17** `6217bf13b26e`: 2 info
  - api operation id `getAddresses` was added
  - added the new optional `query` request parameter `p`
- **2026-04-01** `08b94015aaa5`: 1 warning, 1 info
  - deleted the `query` request parameter `p`
  - api operation id `getAddresses` removed and replaced with ``
- **2021-04-26** `d76dcbb665be`: 2 info
  - added the non-success response with the status `500`
  - added the non-success response with the status `503`
- **2019-08-06** `a041b366636e`: 1 breaking, 1 info
  - the `query` request parameter `q` became required
  - added the non-success response with the status `400`

[Operation history](https://skmtc.dev/mountain-pass/apis/addressr-by-mountain-pass/changes/addresses/get.md)

---

[API](https://skmtc.dev/mountain-pass/apis/addressr-by-mountain-pass.md) - [All operations](https://skmtc.dev/mountain-pass/apis/addressr-by-mountain-pass/llms.txt) - [OpenAPI document](https://skmtc.dev/mountain-pass/apis/addressr-by-mountain-pass/revisions/4a4c43b9b253?raw)