Skip to main content
GET
Preview a postal code

Authorizations

__Secure-better-auth.session_token
string
cookie
required

The session cookie set when you sign in to the web app.

Query Parameters

postalCode
string
required
Maximum string length: 20
Example:

"05432-010"

Response

What the postal code resolves to.

postalCode
string
required
city
string
required
state
string
required
timeZone
string
required
street
string | null
required

The street, such as Rua Inácio Pereira da Rocha. null for a CEP that covers a whole city. Not stored.

neighborhood
string | null
required

The neighborhood, such as Pinheiros. null for a CEP that covers a whole city. Not stored.