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

Address or place name to geocode.

Required string length: 1 - 512

Response

The result

displayName
string
required

Display name.

boundingBoxEast
number

Bounding box east.

boundingBoxNorth
number

Bounding box north.

boundingBoxSouth
number

Bounding box south.

boundingBoxWest
number

Bounding box west.

importanceScore
number

Importance score.

latitude
number

Latitude.

longitude
number

Longitude.

inputAddress
string

Input address.

placeType
string

Place type.