PAHO Dengue

Attribute Details
Source Name paho_dengue
Data Source Pan American Health Organization (PAHO) Dengue surveillance
Geographic Levels Countries and territories in the Americas (see Geographic Codes)
Note: Data availability varies by country.
Temporal Granularity Weekly (Epiweek)
Reporting Cadence Inactive - No longer updated since 2020w31
Temporal Scope Start 2014w01
License This was scraped from a publicly-accessible website, but no explicit license terms were found.

Overview

This data source provides weekly dengue case counts for countries and territories in the Americas, as reported by the Pan American Health Organization (PAHO).

General topics not specific to any particular endpoint are discussed in the API overview. Such topics include: contributing, citing, and data licensing.

Table of contents

  1. The API
    1. Parameters
      1. Required
    2. Response
  2. Example URLs
    1. PAHO Dengue on 2015w01 (Canada)
  3. Code Samples
    1. Legacy Clients

The API

The base URL is: https://api.delphi.cmu.edu/epidata/paho_dengue/

Parameters

Required

Parameter Description Type
epiweeks epiweeks (see Date Formats) list of epiweeks
regions regions list of region labels (see Geographic Codes)

Response

Field Description Type
result result code: 1 = success, 2 = too many results, -2 = no results integer
epidata list of results array of objects
epidata[].release_date date when data was released date (YYYY-MM-DD)
epidata[].region region label (ISO 3166-1 alpha-2 code) string
epidata[].serotype dengue serotype information string
epidata[].issue epiweek when data was issued integer
epidata[].epiweek epiweek for the data point integer
epidata[].lag number of weeks between epiweek and issue integer
epidata[].total_pop total population (in thousands) integer
epidata[].num_dengue total number of dengue cases integer
epidata[].num_severe number of severe dengue cases integer
epidata[].num_deaths number of dengue-related deaths integer
epidata[].incidence_rate incidence rate per 100,000 population float
message success or error message string

Example URLs

PAHO Dengue on 2015w01 (Canada)

https://api.delphi.cmu.edu/epidata/paho_dengue/?regions=ca&epiweeks=201501

{
  "result": 1,
  "epidata": [
    {
      "release_date": "2020-08-07",
      "region": "CA",
      "serotype": "  ",
      "issue": 202032,
      "epiweek": 201501,
      "lag": 291,
      "total_pop": 0,
      "num_dengue": 0,
      "num_severe": 0,
      "num_deaths": 0,
      "incidence_rate": 0.0
    }
  ],
  "message": "success"
}

Code Samples

Libraries are available for R and Python. The following samples show how to import the library and fetch PAHO Dengue data for Canada for epiweek 201501.

Install the package using pip:

pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"
# Import
from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange
# Fetch data
epidata = EpiDataContext()
res = epidata.pub_paho_dengue(regions=['ca'], epiweeks=[201501])
print(res)
library(epidatr)
# Fetch data
res <- pub_paho_dengue(regions = 'ca', epiweeks = 201501)
print(res)

Legacy Clients

We recommend using the modern client libraries mentioned above. Legacy clients are also available for Python, R, and JavaScript.

Place delphi_epidata.py from this repo next to your python script.

# Import
from delphi_epidata import Epidata
# Fetch data
res = Epidata.paho_dengue(['ca'], [201501])
print(res['result'], res['message'], len(res['epidata']))

Place delphi_epidata.R from this repo next to your R script.

source("delphi_epidata.R")
# Fetch data
res <- Epidata$paho_dengue(regions = list("ca"), epiweeks = list(201501))
print(res$message)
print(length(res$epidata))
<!-- Imports -->
<script src="delphi_epidata.js"></script>
<!-- Fetch data -->
<script>
  EpidataAsync.paho_dengue('ca', [201501]).then((res) => {
    console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
  });
</script>