Skip to main content
GET
Suggest addresses

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Query Parameters

q
string
required

Partial address typed by the user

searchSessionId
string
required

Client-generated id grouping one search (maps to the provider billing session)

language
string

UI language (ISO 639-1); clamped to the provider set

country
string

Restrict results to this country (ISO 3166-1 alpha-2). Empty = worldwide

part
enum<string>

Address part this field represents; scopes suggestions to the matching feature types

Available options:
address,
postalCode,
city,
country

Response

200 - application/json
data
object[]
required

Address suggestions