Quidel

Attribute Details
Source Name quidel
Data Source QuidelOrtho Corp. influenza testing data
Geographic Levels HHS regions (see Geographic Codes)
Temporal Granularity Weekly (Epiweek)
Reporting Cadence Inactive - No longer updated since 2020w15
Temporal Scope Start 2015w35

Overview

This data source provides influenza testing data from Quidel Corporation, covering HHS health regions in the United States.

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
  2. Parameters
    1. Required
  3. Response
  4. Example URLs
    1. Quidel on 2015w35-2020w01 (HHS Region 1)
  5. Code Samples
    1. Legacy Clients

The API

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

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

Parameters

Required

Parameter Description Type
auth password string
epiweeks epiweeks (see Date Formats) list of epiweeks
locations locations list of hhs<#> 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[].location HHS region label string
epidata[].epiweek epiweek for the data point integer
epidata[].value percentage of positive influenza tests float
message success or error message string

Example URLs

Quidel on 2015w35-2020w01 (HHS Region 1)

https://api.delphi.cmu.edu/epidata/quidel/?auth=...&locations=hhs1&epiweeks=201535-202001

{
  "result": 1,
  "epidata": [
    {
      "location": "hhs1",
      "epiweek": 201535,
      "value": 2.0
    },
    {
      "location": "hhs1",
      "epiweek": 201536,
      "value": 6.16667
    },
    ...
  ],
  "message": "success"
}

Code Samples

Libraries are available for R and Python. The following samples show how to import the library and fetch Quidel data for HHS Region 1 for epiweeks 201535-202001.

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.pvt_quidel(auth='auth_token', locations=['hhs1'], epiweeks=EpiRange(201535, 202001))
print(res)

library(epidatr)
# Fetch data
res <- pvt_quidel(auth = 'auth_token', locations = 'hhs1', epiweeks = epirange(201535, 202001))
print(res)

Legacy Clients

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

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.quidel('auth_token', ['hhs1'], Epidata.range(201535, 202001))
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$quidel(auth = "auth_token", locations = list("hhs1"), epiweeks = Epidata$range(201535, 202001))
print(res$message)
print(length(res$epidata))

<!-- Imports -->
<script src="delphi_epidata.js"></script>
<!-- Fetch data -->
<script>
  EpidataAsync.quidel('auth_token', ['hhs1'], Epidata.range(201535, 202001)).then((res) => {
    console.log(res.result, res.message, res.epidata != null ? res.epidata.length : 0);
  });
</script>