NoroSTAT Metadata

Attribute	Details
Source Name	meta_norostat
Data Source	CDC NoroSTAT
Reporting Cadence	Inactive - Delphi stopped stopped acquiring data from this data source in November 2020.

This is the documentation of the API for accessing the NoroSTAT Metadata (meta_norostat) endpoint of the 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.

Table of contents

1. The API
   1. Parameters
      1. Required
   2. Response
2. Example URLs
   1. NoroSTAT Metadata
3. Code Samples
   1. Legacy Clients

The API

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

Parameters

Required

Parameter	Description	Type
auth	password	string

Response

Field	Description	Type
result	result code: 1 = success, 2 = too many results, -2 = no results	integer
epidata	metadata object containing locations and releases	object
epidata.locations	list of location sets available over time	array of objects
epidata.locations[].location	comma-separated list of state names available in this release	string
epidata.releases	list of data release dates	array of objects
epidata.releases[].release_date	date when data was released (YYYY-MM-DD)	string
message	success or error message	string

Example URLs

NoroSTAT Metadata

https://api.delphi.cmu.edu/epidata/meta_norostat/?auth=...

{
  "result": 1,
  "epidata": {
    "locations": [
      {
        "location": "Massachusetts, Michigan, Minnesota, Nebraska, New Mexico, Ohio, Oregon, South Carolina, Tennessee, Virginia, Wisconsin, and Wyoming"
      },
      {
        "location": "Massachusetts, Michigan, Minnesota, New Mexico, Ohio, Oregon, South Carolina, Tennessee, Virginia, Wisconsin, and Wyoming"
      },
      {
        "location": "Massachusetts, Michigan, Minnesota, Ohio, Oregon, South Carolina, Tennessee, Virginia, and Wisconsin"
      },
      {
        "location": "Michigan, Minnesota, Ohio, Oregon, South Carolina, Tennessee, and Wisconsin"
      },
      {
        "location": "Minnesota, Ohio, Oregon, Tennessee, and Wisconsin"
      }
    ],
    "releases": [
      {"release_date": "2014-10-21"},
      {"release_date": "2015-03-30"},
      ...]
  },
  "message": "success"
}

Code Samples

Libraries are available for R and Python. The following samples show how to import the library and fetch NoroSTAT Metadata.

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_meta_norostat(auth='auth_token')
print(res)

library(epidatr)
# Fetch data
res <- pvt_meta_norostat(auth = 'auth_token')
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.meta_norostat('auth_token')
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$meta_norostat(auth = "auth_token")
print(res$message)
print(length(res$epidata))

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