Ir para o conteúdo

Climate Weekly

Série temporal climática semanal

Este endpoint é uma agregação do endpoint Climate por Epiweek (Semana Epidemiológica).

Tabela de Parâmetros

Entrada

Nome do Parâmetro Obrigatório Tipo Descrição
*page sim int Página a ser exibida
*per_page sim int Quantos itens serão exibidos por página (até 300)
start sim int (AAAASE) Semana epidemiológica inicial
end sim int (AAAASE) Semana epidemiológica final
geocode não* int Código de município do IBGE
uf não* str (UF) Abreviação de duas letras do estado brasileiro. Ex: SP
macro_health_code não* int Geocódigo de 5 dígitos da região Macro de Saúde brasileira.

Saída (items)

Nome do Parâmetro Tipo Descrição
epiweek int (AAAASE) Semana Epidemiológica
geocodigo int Código de município do IBGE
temp_min_avg float (°C) Temperatura mínima diária média
temp_med_avg float (°C) Temperatura mediana diária média
temp_max_avg float (°C) Temperatura máxima diária média
temp_amplit_avg float (°C) Temperatura média diária de amplitude
precip_tot_sum float (mm) Soma da precipitação diária total
umid_min float (%) Umidade relativa diária mínima média
umid_med float (%) Umidade relativa diária mediana média
umid_max float (%) Umidade relativa diária máxima média

Detalhes

Um dos seguintes parâmetros é obrigatório: geocode, uf ou macro_health_code. page consiste no total de itens retornados pela requisição dividido por per_page. A informação de pagination é retornada junto com a requisição. Ex.:

'pagination': {
    'items': 10,                      # Quantidade de Itens sendo exibidos 
    'total_items': 10,          # Quantidade total de Itens retornados na requisição
    'page': 1,                         # *parâmetro da requisição
    'total_pages': 1,            # Quantidade total de páginas retornadas na requisição
    'per_page': 100             # *parâmetro da requisição
},

Exemplos de uso

import mosqlient

mosqlient.get_climate_weekly(
    api_key = api_key,
    start = "202201",
    end = "202301",
    # uf = "RJ",
    geocode = 3304557,
)
library(httr)
library(jsonlite)

climate_weekly_api <- "https://api.mosqlimate.org/api/datastore/climate/weekly/"

params <- list(
  page = 1,
  per_page = 300,
  start = YYYYWW,
  end = YYYYWW,
  geocode = MUNICIPALITY_GEOCODE,
  uf = UF,
  macro_health_code = MACROHEALTH_CODE
)

headers <- add_headers(
  `X-UID-Key` = API_KEY
)

resp <- GET(climate_weekly_api, query = params, headers)
items <- fromJSON(content(resp, "text", encoding = "UTF-8"))
curl -X 'GET' \
  'https://api.mosqlimate.org/api/datastore/climate/weekly/?start=YYYYWW&end=YYYYWW&page=1&per_page=300' \
  -H 'accept: application/json' \
  -H 'X-UID-Key: See X-UID-Key documentation'

# Or you can add a geocode and other filters
curl -X 'GET' \
  'https://api.mosqlimate.org/api/datastore/climate/weekly/?start=YYYYWW&end=YYYYWW&geocode=MUNICIPALITY_GEOCODE&uf=UF&macro_health_code=MACROHEALTH_CODE&page=1&per_page=300' \
  -H 'accept: application/json' \
  -H 'X-UID-Key: See X-UID-Key documentation'

*A paginação da resposta contém informações sobre a quantidade de itens retornados pela chamada da API. Essas informações podem ser usadas para navegar entre os dados consultados alterando o parâmetro page na URL. Ver detalhes