Menu

Documentação

Buscar estados por código postal

A Country Data API fornece informações detalhadas sobre +200 países diferentes

HTTP GET

https://api.countrydataapi.com/v1/countries/zipCode

Retorna uma lista de todos os estados de acordo com seu código postal.

Informações relevantes

Tenha em mente que há muitos estados de diferentes países que possuem códigos postais iguais

Existem 3 tipos de operações:

  • BASIC: Os campos id, state_name, lang são retornados.

  • NORMAL: O campo state_cities é retornado [Todos os id e nome das cidades do estado]. Cada cidade gastará 1 token

  • ADVANCED: O campo state_zip_codes é retornado [Todos os códigos postais da cidade]. Cada código postal 1 token

Parâmetros da consulta

ParâmetroTipoDescrição
apikeyobrigatório, tokenChave de autenticação da conta
zipcodeobrigatório, stringCódigo postal do estado desejado
limitTokenopcional, número1000 (padrão). Número máximo de tokens que você deseja gastar nesta solicitação
typeopcional, stringbásico (padrão), normal, avançado
langopcional, idiomaen (padrão). Idioma esperado da resposta

Exemplo de resposta


    [
        {
          "id": "8dd25479-067a-43b0-ac4a-8e7faf2bcafb",
          "state_name":"Takhar",
          "lang":"en",
          "state_cities":[
              {
                id: "8dd25476-067a-43b0-ac4b-8e7faf2bcbfb",
                "city_name":"City",
                ...
              }
          ],
          "state_zip_codes": [
              00000,
              000001,
              ...
          ]
        }
      ]