Ler os setores censitários de um município

GET

/v1/municipios/{codigo}/setores

curl --request GET \
  --url 'https://api.brasilsintetico.com/v1/municipios/example/setores?limite=500&offset=0' \
  --header 'Authorization: Bearer <token>'

O município por setor censitário: cobertura do solo (MapBiomas), edificações (Google Open Buildings; retidas onde moram de 1 a 4 domicílios) e declividade (Copernicus DEM), com um resumo dos setores. Contexto, nunca entrada de uma simulação; fontes e aviso são o que as licenças pedem para mostrar junto com os números.

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

Parâmetros de consulta

limite

Setores na página; 0 para só o resumo

integer

padrão: 500 <= 5000

Setores na página; 0 para só o resumo

offset

integer

0

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": {}
    }
  ]
}