Menu

Documentação

Todos os dados de um estado

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

HTTP GET

https://api.countrydataapi.com/v1/state/all

Retorna uma lista de todos os estados

Existem 3 tipos de operações:

  • BÁSICO: Retorna os campos id, state_name, lang Cada estado gastará 1 token

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

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

Parâmetros de Consulta

ParâmetroTipoDescrição
apikeyobrigatório, tokenChave de autenticação da conta
langopcional, langen (padrão). Idioma esperado da resposta
limitTokenopcional, número1000 (padrão). Número máximo de tokens que deseja gastar nesta solicitação
limitStatesopcional, número10 (padrão). Número máximo de estados que deseja retornar
typeopcional, stringbasic (padrão), normal, advanced

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,
              ...
          ]
        }
      ]