Skip to main content
POST
geo.place.geocode

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

The ref returned by a place-returning call.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
language
string

Language tag, such as en or en-US.

Required string length: 1 - 35
Pattern: ^[a-zA-Z]{2,8}(?:-[a-zA-Z0-9]{1,8})*$
region
string

Two-letter region code.

Required string length: 1 - 2
Pattern: ^[A-Za-z]{2}$

Response

The result

formattedAddress
string
required

Formatted postal address, possibly personal data.

Required string length: 1 - 2048
location
object
required

Address coordinates.

components
object[]

Typed address components.

Maximum array length: 40
granularity
string

Precision of the address match.

Required string length: 1 - 80
types
string[]

Address categories.

Maximum array length: 20
Required string length: 1 - 80
viewport
object

Suggested viewing bounds.

plusCode
string

Geographic location code.

Required string length: 1 - 128