Pular para o conteúdo

Ler o relevo de um município

GET
/v1/municipios/{codigo}/relevo
curl --request GET \
--url 'https://api.brasilsintetico.com/v1/municipios/example/relevo?quadro=urbano' \
--header 'Authorization: Bearer <token>'

O relevo do município como uma grade de alturas (Copernicus DEM GLO-30): caixa (o retângulo em graus), n (pontos por lado), passo_m, altitude_min e altitude_max, piso_zero, quadro e z, as alturas em metros como int16 little endian, de norte a sul, em base64. quadro=urbano (o padrão) é enquadrado pelos setores urbanos; quadro=municipio é uma grade mais grossa (160 pontos por lado) do município inteiro, com uma margem das terras vizinhas. fonte traz o crédito e o aviso que a licença pede para mostrar com o relevo. Com gzip. 404 relief_missing para um município que os dados não cobrem.

codigo
obrigatório

O código IBGE do município

string
/^\d{7}$/

O código IBGE do município

quadro

urbano: a grade fina enquadrada pelos setores urbanos (o padrão); municipio: uma grade mais grossa do município inteiro, com uma margem dos vizinhos

string
padrão: urbano
Valores aceitos: urbano municipio

urbano: a grade fina enquadrada pelos setores urbanos (o padrão); municipio: uma grade mais grossa do município inteiro, com uma margem dos vizinhos

Resposta bem-sucedida

Tipo de mídiaapplication/json

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