Documentação

Buscar estados por código postal

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

HTTP GET

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

Retorna uma lista de todos os estados por código postal

Informação relevante

Tenha em conta que há muitos estados de diferentes países que têm códigos postais iguais

Dependendo dos campos solicitados, haverá 3 tipos de requisições:

  • BÁSICO: São retornados os campos id, state_name, lang Cada estado gastará 1 token

  • NORMAL: É retornado o campo state_cities [Todos os ids e nomes das cidades do estado] Cada cidade gastará 1 token

  • AVANÇADO: É retornado o campo state_zip_codes [Todos os códigos postais da cidade] Cada código postal 1 token

Parâmetros de Consulta


Parâmetro Tipo Descrição
apikey obrigatório, token Chave de autenticação da conta
zipcode obrigatório, string Código postal do estado que se deseja
limitToken opcional, number 1000 (padrão). Número máximo de tokens que você quer gastar nesta requisição
fields opcional, string id,lang,state_name (padrão). Campos esperados na resposta
lang opcional, lang en (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,
          ...
      ]
    }
  ]