FluView Clinical

This is the API documentation for accessing the FluView Clinical (fluview_clinical) endpoint of Delphi’s epidemiological data.

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

FluView Clinical Data

…

The API

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

See this documentation for details on specifying epiweeks, dates, and lists.

Parameters

Required

Parameter	Description	Type
`epiweeks`	epiweeks	`list` of epiweeks
`regions`	regions	`list` of region labels

Optional

Parameter	Description	Type
`issues`	issues	`list` of epiweeks
`lag`	# weeks between each epiweek and its issue	integer

Notes:

If both issues and lag are specified, only issues is used. If neither is specified, the current issues are used.

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`		string
`epidata[].region`		string
`epidata[].issue`		integer
`epidata[].epiweek`		integer
`epidata[].lag`		integer
`epidata[].total_specimens`		integer
`epidata[].total_a`		integer
`epidata[].total_b`		integer
`epidata[].percent_positive`		float
`epidata[].percent_a`		float
`epidata[].percent_b`		float
`message`	`success` or error message	string

Example URLs

FluView Clinical on 2020w01 (national)

https://delphi.cmu.edu/epidata/api.php?endpoint=fluview_clinical&regions=nat&epiweeks=202001

{
  "result": 1,
  "epidata": [
    {
      "release_date": "2020-04-10",
      "region": "nat",
      "issue": 202014,
      "epiweek": 202001,
      "lag": 13,
      "total_specimens": 64980,
      "total_a": 5651,
      "total_b": 9647,
      "percent_positive": 23.5426,
      "percent_a": 8.69652,
      "percent_b": 14.8461
    },
    ...
  ],
  "message": "success"
}

Code Samples

Libraries are available for CoffeeScript, JavaScript, Python, and R. The following samples show how to import the library and fetch national FluView Clinical data for epiweeks 201940 and 202001-202010 (11 weeks total).

CoffeeScript (in Node.js)

# Import
{Epidata} = require('./delphi_epidata')
# Fetch data
callback = (result, message, epidata) ->
  console.log(result, message, epidata?.length)
Epidata.fluview_clinical(callback, ['nat'], [201940, Epidata.range(202001, 202010)])

JavaScript (in a web browser)

<!-- Imports -->
<script src="jquery.js"></script>
<script src="delphi_epidata.js"></script>
<!-- Fetch data -->
<script>
  var callback = function(result, message, epidata) {
    console.log(result, message, epidata != null ? epidata.length : void 0);
  };
  Epidata.fluview_clinical(callback, ['nat'], [201940, Epidata.range(202001, 202010)]);
</script>

Python

Optionally install the package using pip(env):

pip install delphi-epidata

Otherwise, place delphi_epidata.py from this repo next to your python script.

# Import
from delphi_epidata import Epidata
# Fetch data
res = Epidata.fluview_clinical(['nat'], [201940, Epidata.range(202001, 202010)])
print(res['result'], res['message'], len(res['epidata']))

R

# Import
source('delphi_epidata.R')
# Fetch data
res <- Epidata$fluview_clinical(list('nat'), list(201940, Epidata$range(202001, 202010)))
cat(paste(res$result, res$message, length(res$epidata), "\n"))