Dengue Digital Surveillance Sensors

Attribute	Details
Source Name	`dengue_sensors`
Data Source	Various digital data streams
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 2020w32
Temporal Scope Start	2014w04
License	CC BY

Overview

This endpoint provides digital surveillance sensor estimates for dengue activity, derived from various data streams.

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

Available Signals

The following signals are available:

Name	Description
`gft`	Google Flu Trends
`ght`	Google Health Trends
`twtr`	HealthTweets
`wiki`	Wikipedia access
`cdc`	CDC Page Hits
`epic`	Epicast 1-week-ahead point prediction
`quid`	Flu lab test data
`sar3`	Seasonal Autoregression (order 3)
`arch`	Best-fit Archetype at 1-week-ahead

Available Signals
The API
1. Parameters
  1. Required
2. Response
Example URLs
1. Dengue Sensors on 2015w01 (Puerto Rico)
Code Samples
1. Legacy Clients

The API

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

Parameters

Required

Parameter	Description	Type
`auth`	password	string
`epiweeks`	epiweeks (see Date Formats)	`list` of epiweeks
`name`	name	`list` of names (see Available Signals)
`locations`	locations	`list` of location 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[].location`	location label	string
`epidata[].epiweek`	epiweek	integer
`epidata[].name`	name	string
`epidata[].value`	value	float
`message`	`success` or error message	string

Example URLs

Dengue Sensors on 2015w01 (Puerto Rico)

https://api.delphi.cmu.edu/epidata/dengue_sensors/?auth=...&locations=pr&epiweeks=201501&names=ght

{
  "result": 1,
  "epidata": [
    {
      "location": "pr",
      "epiweek": 201501,
      "name": "ght",
      "value": 103.676
    }
  ],
  "message": "success"
}

Code Samples

Libraries are available for R and Python. The following samples show how to import the library and fetch Dengue Sensors data for Puerto Rico 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.dengue_sensors('auth_token', ['ght'], ['pr'], [201501])
print(res['result'], res['message'], len(res['epidata']))

library(epidatr)
# Fetch data
res <- pvt_dengue_sensors(auth = 'auth_token', names = 'ght', locations = 'pr', epiweeks = 201501)
print(res)

Legacy Clients

We recommend using our client libraries: epidatr for R and epidatpy for Python. Legacy clients are also available for Python, R, and JavaScript.

Optionally install the package using pip(env):

pip install delphi-epidata

# Import
from delphi_epidata import Epidata
# Fetch data
res = Epidata.dengue_sensors('auth_token', ['gft'], ['pr'], [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$dengue_sensors(auth = "auth_token", sensors = list("gft"), locations = list("pr"), epiweeks = list(201501))
print(res$message)
print(length(res$epidata))

<!-- Imports -->
<script src="delphi_epidata.js"></script>
<!-- Fetch data -->
<script>
  EpidataAsync.dengue_sensors('auth_token', ['ght'], 'pr', [201501]).then((res) => {
    console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
  });
</script>