Suggest addresses for what has been typed of an address line in a country

GET /addresses/suggest

Suggest addresses for what has been typed of an address line (q, at least three characters) in a country (country, ISO 3166-1 alpha-2, AU when absent): canonical forms — or, outside Australia, the provider's lines — with where each is when known, best first (limit: default 5, at most 10).

A suggestion is not yet a platform address — verify the one picked with POST /addresses/verify. 422 CountryNotSupported for a country no provider covers here; 503 AddressProviderUnavailable when the provider does not answer. The answer is the address alone — the same whether or not anyone verified it before — and nothing about who else uses it. Appends nothing: a read.

Access

Requires orders:read or customers:read or companies:read or locations:read or purchasing:read.

Any one of these scopes is enough.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

AI agent tool

No agent tool. Suggestions for an address line as a person types it, a keystroke at a time; an agent sends the whole address to addresses_verify_address, which answers the nearest known addresses when it cannot verify one.

Connecting an agent: AI agents.

Example

curl

curl -X GET 'https://addresses.getmanifold.io/addresses/suggest?q=200+Collins&country=AU' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://addresses.getmanifold.io/addresses/suggest?q=200+Collins&country=AU", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Response · 200 · application/json

{
  "items": [
    {
      "countryCode": "AU",
      "streetNumber": "200",
      "streetName": "COLLINS",
      "streetType": "ST",
      "locality": "MELBOURNE",
      "region": "VIC",
      "postcode": "3000",
      "street": "200 Collins Street",
      "lines": [
        "200 Collins Street",
        "Melbourne VIC 3000"
      ],
      "geocode": {
        "latitude": -37.8152,
        "longitude": 144.9671,
        "precision": "rooftop"
      }
    }
  ]
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: address-manager.openapi.json. Base URL https://addresses.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`409`

Refusal	What it means	What to do
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`422`

Refusal	What it means	What to do
`CountryNotSupported` countryCode	The request was refused, and nothing changed.	Fix the request. Sending it again unchanged gets the same answer.

`503`

Refusal	What it means	What to do
`AddressProviderUnavailable` reason	The provider does not answer.	Try again shortly.
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Try again shortly.

How refusals work everywhere: Errors.