Climate Weekly

Climate Weekly time series

This endpoint is an aggregation of the Climate endpoint by Epiweek.

Parameters Table

Input

Parameter name	Required	Type	Description
*page	yes	int	Page to be displayed
*per_page	yes	int	How many items will be displayed per page (up to 300)
start	yes	int (YYYYWW)	Start epiweek
end	yes	int (YYYYWW)	End epiweek
geocode	no*	int	IBGE's municipality code
uf	no*	str (UF)	Two letters brazilian's state abbreviation. E.g: SP
macro_health_code	no*	int	5 digit brazilian's MacroHealth region geocode.

Output (items)

Parameter name	Type	Description
epiweek	int (YYYYWW)	Epidemiological Week
geocodigo	int	IBGE's municipality code
temp_min_avg	float (°C)	Average minimum daily temperature
temp_med_avg	float (°C)	Average median daily temperature
temp_max_avg	float (°C)	Average maximum daily temperature
temp_amplit_avg	float (°C)	Average daily amplitude temperature
precip_tot_sum	float (mm)	Sum of total daily precipitation
umid_min	float (%)	Average minimum daily relative humidity
umid_med	float (%)	Average median daily relative humidity
umid_max	float (%)	Average maximum daily relative humidity

Details

One of the parameters is required: geocode, uf or macro_health_code page consists in the total amount of Items returned by the request divided by per_page. The pagination information is returned alongside with the returned request. E.g.:

'pagination': {
    'items': 10,                      # Amout of Items being displayed 
    'total_items': 10,          # Total amount of Items returned in the request
    'page': 1,                         # *request parameter
    'total_pages': 1,            # Total amount of pages returned in the request
    'per_page': 100             # *request parameter
},

Note: for fetching a big amount of pages, please consider using Async code

Usage examples

PythonRcurl

import requests

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

params = {
    "page": 1,
    "per_page": 300,
    "start": YYYYWW,
    "end": YYYYWW,
    "geocode": MUNICIPALITY_GEOCODE,
    "uf": UF,
    "macro_health_code": MACROHEALTH_CODE
}

resp = requests.get(climate_weekly_api, params=params)
items = resp.json() # JSON data in dict format

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
)

resp <- GET(climate_weekly_api, query = params)
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'

# 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'

*The response's pagination contain information about the amount of items returned by the API call. These information can be used to navigate between the queried data by changing the page parameter on the URL. See details