Skip to main content
GET
Internal Proxy - List available cities

Query Parameters

country
string
default:br

ISO alpha-2 (lowercase). Default br.

Pattern: ^[a-z]{2}$
state
string

Filters by state/subdivision when the catalog provides state. For Brazil, use values such as sp, rj, mg.

Pattern: ^[a-z0-9-]{1,16}$

Partial filter by name/slug (accent- and case-insensitive).

Response

List of available cities

country
string
Example:

"br"

state
string

Returned only when the state query was provided.

Example:

"sp"

cities
object[]