Ler os nomes dos setores de um município

GET

/v1/municipios/{codigo}/setores/nomes

curl --request GET \
  --url https://api.brasilsintetico.com/v1/municipios/example/setores/nomes \
  --header 'Authorization: Bearer <token>'

Os setores censitários do município pelo nome. Para cada setor: nome, o rótulo pelo qual o console o lê, um por setor da cidade: o bairro que o município informou ao IBGE; senão o aglomerado rural ou o núcleo urbano da malha do IBGE; senão o lugar do OpenStreetMap dentro do setor, ou o limite de nível 10 do OpenStreetMap que o contém; senão “perto de” o lugar mais próximo da cidade a até 1 km do centro do setor; senão o distrito do IBGE; e por fim os últimos dígitos do código. lugar é só o nome desse lugar; origem diz de onde o nome vem (ibge_bairro, ibge_aglomerado, ibge_nucleo, osm_dentro, osm_limite, osm_perto ou ibge_distrito), com o credito; distancia_m é a distância para osm_perto, em metros. bairro (null onde o município não informou), distrito e subdistrito são os do IBGE (malha de setores de 2022). fontes lista o crédito de cada fonte: um nome do OpenStreetMap aparece com “© colaboradores do OpenStreetMap” (ODbL). Dados públicos: não é preciso abrir a cidade.

Autorizações

• projectKey

Parâmetros

Parâmetros de caminho

codigo

obrigatório

O código IBGE do município

string

/^\d{7}$/

O código IBGE do município

Respostas

200

Resposta bem-sucedida

Tipo de mídiaapplication/json

object

key

propriedades adicionais

any

Exemplo ^gerado

{}

422

Erro de validação

Tipo de mídiaapplication/json

object

detail

Array<object>

object

loc

obrigatório

Local

Array

msg

obrigatório

Mensagem

string

type

obrigatório

Tipo do erro

string

input

ctx

Contexto

object

Exemplo ^gerado

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}