Skip to main content
POST
geo.address.reverse-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
location
object
required

Coordinates to reverse geocode.

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}$
types
string[]

Required address types.

Maximum array length: 20
Required string length: 1 - 80
granularity
string[]

Required precision levels.

Maximum array length: 10
Required string length: 1 - 80
limit
integer
default:10

Maximum candidates.

Required range: 1 <= x <= 20

Response

The result

results
object[]
required

Address candidates.

Maximum array length: 20