Skip to main content
POST
geo.address.parse

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
address
string
required

Free-text address to parse.

Required string length: 1 - 512

Response

The result

streetName
string
required

Street name.

city
string

City.

confidence
string

Confidence.

country
string

Country.

countryCode
string

Country code.

formatted
string

Formatted.

postalCode
string

Postal code.

stateProvince
string

State province.

street
string

Street.

streetNumber
string

Street number.