Skip to main content
POST
geo.address.suggest

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
countryCode
string
required

ISO two- or three-letter country code.

Required string length: 1 - 3
Pattern: ^[A-Z]{2,3}$
text
string
required

Address beginning, up to 32 characters.

Required string length: 1 - 32
limit
integer
default:10

Suggestions, 1 to 10.

Required range: 1 <= x <= 10
source
enum<string>
default:postal

Postal addresses only, or include alternate addresses.

Available options:
postal,
all
includeStates
string[]

US states to include.

Required array length: 1 - 60 elements
Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
excludeStates
string[]

US states to exclude.

Required array length: 1 - 60 elements
Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
includeCities
object[]

US cities and states to include.

Required array length: 1 - 20 elements
preferCities
object[]

US cities and states to prefer.

Required array length: 1 - 20 elements
includePostalCodes
string[]

Postal codes to include.

Required array length: 1 - 20 elements
Required string length: 1 - 16
includeLocalities
string[]

International localities to include.

Required array length: 1 - 20 elements
Required string length: 1 - 64
preferStates
string[]

US states to prefer.

Required array length: 1 - 60 elements
Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
preferPostalCodes
string[]

US postal codes to prefer.

Required array length: 1 - 20 elements
Required string length: 1 - 16
preferencePercent
integer
default:100

Percentage of suggestions to prefer.

Required range: 0 <= x <= 100
excludeTypes
enum<string>[]

US address types to exclude.

Required array length: 1 - 6 elements
Available options:
base-address,
undeliverable-base-address,
commercial,
residential,
po-box,
military
language
enum<string>

International address alphabet.

Available options:
native,
latin
preferLocation
boolean
default:false

Prefer the explicitly supplied IPv4 location.

ipv4
string<ipv4>

User IPv4, required when location preference is enabled.

Pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$

Response

The result

results
object[]
required

Address suggestions; groups can be expanded.

Maximum array length: 10