Menu

Documentação

Buscar Códigos Postais por Região

CountryDataAPI fornece informações detalhadas sobre +200 países diferentes

HTTP GET

https://api.countrydataapi.com/v1/zipcodes/region

Retorna uma lista de todos os códigos postais de uma região.

Cada código postal retornado gastará 1 token.

Query Params

ParâmetroTipoDescrição
apikeyobrigatório, tokenChave de autenticação da conta
regionobrigatório, stringNome da região que está sendo buscada. Ex: “África”
langopcional, langen (padrão). Idioma esperado da resposta
limitTokenopcional, número1000 (padrão). Número máximo de tokens que você deseja gastar nesta solicitação

Exemplo de resposta


    [
        {
          "id":"8dd25479-067a-43b0-ac4a-8e7faf2bcaf",
          "country_name":"Argelia",
          "state_names": [
            {
              id: "8dd25479-067a-43b0-ac4a-8e7faf2bcad",
              name: "Orán",
              postal_code: [
                "31004",
                "31016",
                "31019",
                "31020",
                ...
              ]
            }
          ]
        }
    ]