Skip to main content
POST
geo.postal-code.lookup

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

Postal/ZIP code to look up.

Required string length: 1 - 20000
countryCode
string

ISO 2-letter country code (default US).

Required string length: 1 - 20000

Response

The result

countryName
string
required

Country name.

valid
boolean

True when valid.

places
object[]

Places.

countryCode
string

Country code.

postalCode
string

Postal code.