Skip to main content
POST
geo.postal-codes.search

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

ISO two- or three-letter country code.

Required string length: 1 - 3
Pattern: ^[A-Z]{2,3}$
locality
string

City.

Required string length: 1 - 64
region
string

State or province.

Required string length: 1 - 32
postalCode
string

Exact postal code.

Required string length: 1 - 16
prefix
string

Postal code prefix; supported internationally.

Required string length: 1 - 16
language
enum<string>

Alphabet; native only where supported.

Available options:
native,
latin
limit
integer
default:100

At most 1000 records, without pagination.

Required range: 1 <= x <= 1000

Response

The result

results
object[]
required

Postal records.

Maximum array length: 1000
aliases
object[]
required

City aliases; they are not paired with unrelated postal records.

Maximum array length: 1000
truncated
boolean
required

Refine the search if the result cap was reached.