Search

Fuzzy search across settlements, municipalities, and codes

Useful for autocomplete in frontend UIs. Not cached in CDN (Cache-Control: no-store); rate-limited per IP at the edge.

get/api/v1/{country}/search

Request

  • Base URL: https://postali.app
  • URL: https://postali.app/api/v1/{country}/search
  • Auth: none required

Path parameters

country'mx' | 'co' | 'es' required
Example:mx

ISO 3166-1 alpha-2 country code in lowercase. The path /api/v1/cp/... (without country) defaults to mx for backwards compatibility.

Query parameters

qstring required
Example:roma

Search terms (max 100 characters).

limitinteger

Maximum number of results.

Response

Search results.

querystring required

Changes

No recorded changes to this operation across all 1 revision of this API.