Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
00de931
docs: Complete the "Other endpoints" documentation
JavierMtzRdz Jan 4, 2026
ad5292d
more detail on CDC source
nmdefries Jan 8, 2026
93dd680
wording
nmdefries Jan 9, 2026
33789cd
Merge branch 'dev' into imp-doc-oth-endpoints
JavierMtzRdz Jan 15, 2026
c699a67
docs: Update internal documentation links to use the .md extension an…
JavierMtzRdz Jan 15, 2026
38d56be
docs: update CDC API documentation with specific page titles for `num…
JavierMtzRdz Jan 16, 2026
8d8aefe
docs: enhance API endpoint overviews and descriptions for clarity
JavierMtzRdz Jan 16, 2026
0997a46
docs: refining KCDC ILI details
JavierMtzRdz Jan 17, 2026
cf6bab7
docs: update API documentation by removing "inactive" prefixes
JavierMtzRdz Jan 17, 2026
9dabecb
docs: clarify API access restrictions across multiple endpoints
JavierMtzRdz Jan 17, 2026
a6fb0b8
docs: Twitter API documentation with a new methodology section and cl…
JavierMtzRdz Jan 17, 2026
06af592
docs: update wiki response table and ght note on access restrictions
JavierMtzRdz Jan 17, 2026
9fce4bd
docs: refine API endpoint descriptions dor delphi baseline, dengue …
JavierMtzRdz Jan 19, 2026
034ec1e
docs: Update the overview and list of available sources for Digital S…
JavierMtzRdz Jan 19, 2026
5e262f1
docs: further revision of CDC and other endpoints. It adds a signal d…
JavierMtzRdz Jan 19, 2026
54bb854
docs: Rearrange the order of sections in delphi.md
JavierMtzRdz Jan 19, 2026
2dc8150
docs: include estimation section in dengue_nowcast
JavierMtzRdz Jan 19, 2026
325668a
docs: include Available Signals in Dengue Digital Surveillance Sensors
JavierMtzRdz Jan 19, 2026
3e76b11
docs: add references to Dengue Nowcast
JavierMtzRdz Jan 19, 2026
db2875a
docs: better structure in cdc.md
JavierMtzRdz Jan 19, 2026
2d4da22
docs: add estimation section to ecdc_ili
JavierMtzRdz Jan 19, 2026
6e14018
docs: update example output on flusurv
JavierMtzRdz Jan 20, 2026
08df8b6
docs: add estimation section to fluview_clinical and source code for …
JavierMtzRdz Jan 20, 2026
145d175
docs: add small estimation to ght for other endpoints
JavierMtzRdz Jan 20, 2026
9d6fb39
docs: add estimation, lag and limitation sections to ILI Nearby Nowcast
JavierMtzRdz Jan 20, 2026
d91dde6
docs: add estimation section to KCDC page
JavierMtzRdz Jan 20, 2026
dfcb459
docs: add estimation section to nidss_* pages
JavierMtzRdz Jan 20, 2026
541a1da
docs: add an estimation section to the norostat page
JavierMtzRdz Jan 20, 2026
57be6b1
docs: add an estimation setion to PAHO Dengue
JavierMtzRdz Jan 20, 2026
0407341
docs: adds an estimation section to quidel, twitter and wiki pages
JavierMtzRdz Jan 20, 2026
d904e34
docs: adjust level sections for consistency across other endpoints
JavierMtzRdz Jan 20, 2026
448cd17
docs: add formula to quidel data under other endpoints.
JavierMtzRdz Jan 20, 2026
54dc22b
docs: update licence for quidel, norostat and cdc and wording
JavierMtzRdz Jan 20, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 108 additions & 9 deletions docs/api/01meta.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
parent: Inactive Sources (Other)
grand_parent: Data Sources and Signals
title: <i>inactive</i> Epidata Metadata
parent: Data Sources and Signals
grand_parent: Other Endpoints (COVID-19 and Other Diseases)
nav_order: 2
permalink: api/meta.html
---

Expand All @@ -18,13 +17,13 @@ General topics not specific to any particular endpoint are discussed in the

## API Metadata

... <!-- TODO -->
Overview of the current state of the database, including the latest update times and data volume for specific endpoints.

# The API

The base URL is: https://api.delphi.cmu.edu/epidata/meta/
The base URL is: <https://api.delphi.cmu.edu/epidata/meta/>

See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
See [this documentation](date_formats.html) for details on specifying epiweeks, dates, and lists.

## Parameters

Expand All @@ -36,12 +35,15 @@ None.
|-----------|-----------------------------------------------------------------|------------------|
| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer |
| `epidata` | list of results | array of objects |
| ... | ... | ... | <!-- TODO -->
| `epidata[].fluview` | Metadata for [FluView](fluview.md) | array of objects |
| `epidata[].twitter` | Metadata for [Twitter](twitter.md) | array of objects |
| `epidata[].wiki` | Metadata for [Wikipedia](wiki.md) | array of objects |
| `epidata[].delphi` | Metadata for [Delphi Forecasts](delphi.md) | array of objects |
| `message` | `success` or error message | string |

# Example URLs

https://api.delphi.cmu.edu/epidata/meta/
<https://api.delphi.cmu.edu/epidata/meta/>

```json
{
Expand Down Expand Up @@ -108,4 +110,101 @@ https://api.delphi.cmu.edu/epidata/meta/

# Code Samples

<!-- TODO: fix -->
Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/).
The following samples show how to import the library and fetch API metadata.

<div class="code-tabs">
<div class="tab-header">
<button class="active" data-tab="python">Python</button>
<button data-tab="r">R</button>

</div>

<div class="tab-content active" data-tab="python" markdown="1">

Install the package using pip:
```bash
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"
```

```python
# Import
from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange
# Fetch data
epidata = EpiDataContext()
res = epidata.pub_meta()
print(res)
```
</div>

<div class="tab-content" data-tab="r" markdown="1">

```R
library(epidatr)
# Fetch data
res <- pub_meta()
print(res)
```
</div>

</div>

### Legacy Clients

We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).

<div class="code-tabs">
<div class="tab-header">
<button class="active" data-tab="python">Python</button>
<button data-tab="r">R</button>
<button data-tab="js">JavaScript</button>
</div>

<div class="tab-content active" data-tab="python" markdown="1">

Optionally install the package using pip(env):
```bash
pip install delphi-epidata
```

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

```python
# Import
from delphi_epidata import Epidata
# Fetch data
res = Epidata.meta()
print(res['result'], res['message'], len(res['epidata']))
```
</div>

<div class="tab-content" data-tab="r" markdown="1">

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

```R
source("delphi_epidata.R")
# Fetch data
res <- Epidata$meta()
print(res$message)
print(length(res$epidata))
```
</div>

<div class="tab-content" data-tab="js" markdown="1">



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

</div>
45 changes: 19 additions & 26 deletions docs/api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ like to cite it, we would gratefully recommend the following copy:
> Roni Rosenfeld
> (2015).
> _Delphi Epidata API_.
> https://github.com/cmu-delphi/delphi-epidata
> <https://github.com/cmu-delphi/delphi-epidata>

## Data Licensing

Expand Down Expand Up @@ -71,23 +71,16 @@ Please note that our `endpoint` parameters were previously referenced as `source

# The API

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

## Specifying Epiweeks, Dates, and Lists

Epiweeks use the U.S. definition. That is, the first epiweek each year is the
week, starting on a Sunday, containing January 4. See
[this page](https://www.cmmcp.org/mosquito-surveillance-data/pages/epi-week-calendars-2008-2020)
for more information.

Formatting for epiweeks is YYYYWW and for dates is YYYYMMDD.

`list` parameters consist of a comma-separated list of individual values or, for numeric parameters, a hyphenated range of values. Examples include:
- `param=201530` *(A single epiweek)*
- `param=201401,201501,201601` *(Several epiweeks)*
- `param=200501-200552` *(A range of epiweeks)*
- `param=201440,201501-201510` *(Several epiweeks, including a range)*
- `param=20070101-20071231` *(A range of dates)*
See [Date Formats](date_formats.html) for full details on specifying epiweeks, dates, lists, and ranges.

`list` parameters consist of a comma-separated list of individual values or, for numeric parameters, a hyphenated range of values.


## Universal Parameters

Expand All @@ -111,39 +104,39 @@ The parameters available for each source are documented in each linked source-sp

| Endpoint | Name | Description | Restricted? |
| --- | --- | --- | --- |
| [`cdc`](cdc.md) | CDC Page Hits | ... <!-- TODO --> | yes |
| [`delphi`](delphi.md) | Delphi's Forecast | ... <!-- TODO --> | no |
| [`cdc`](cdc.md) | CDC Page Hits | CDC total and by topic webpage visits. | yes |
| [`delphi`](delphi.md) | Delphi's Forecast | Delphi's ILINet outpatient doctor visits forecasts. | no |
| [`ecdc_ili`](ecdc_ili.md) | ECDC ILI | ECDC ILI data from the ECDC website. | no |
| [`flusurv`](flusurv.md) | FluSurv | FluSurv-NET data (flu hospitaliation rates) from CDC. | no |
| [`fluview`](fluview.md) | FluView | Influenza-like illness (ILI) from U.S. Outpatient Influenza-like Illness Surveillance Network (ILINet). | no |
| [`fluview_meta`](fluview_meta.md) | FluView Metadata | Summary data about [`fluview`](fluview.md). | no |
| [`fluview_clinical`](fluview_clinical.md) | FluView Clinical | ... <!-- TODO --> | no |
| [`fluview_clinical`](fluview_clinical.md) | FluView Clinical | Clinical flu data. | no |
| [`gft`](gft.md) | Google Flu Trends | Estimate of influenza activity based on volume of certain search queries. Google has discontinued Flu Trends, and this is now a static endpoint. | no |
| [`ght`](ght.md) | Google Health Trends | Estimate of influenza activity based on volume of certain search queries. | yes |
| [`kcdc_ili`](kcdc_ili.md) | KCDC ILI | KCDC ILI data from KCDC website. | no |
| [`meta`](meta.md) | API Metadata | Metadata for `fluview`, `twitter`, `wiki`, and `delphi`. | no |
| [`nidss_flu`](nidss_flu.md) | NIDSS Flu | Outpatient ILI from Taiwan's National Infectious Disease Statistics System (NIDSS). | no |
| [`nowcast`](nowcast.md) | ILI Nearby | A nowcast of U.S. national, regional, and state-level (weighted) percent ILI, available seven days (regionally) or five days (state-level) before the first ILINet report for the corresponding week. | no |
| [`quidel`](quidel.md) | Quidel | Data provided by Quidel Corp., which contains flu lab test results. | yes |
| [`sensors`](sensors.md) | Delphi's Digital Surveillance Sensors | ... <!-- TODO --> | no |
| [`sensors`](sensors.html) | Delphi's Digital Surveillance Sensors | Influenza and dengue digital surveillance sensors. | partially |
| [`twitter`](twitter.md) | Twitter Stream | Estimate of influenza activity based on analysis of language used in tweets from [HealthTweets](http://HealthTweets.org/). | yes |
| [`wiki`](wiki.md) | Wikipedia Access Logs | Number of page visits for selected English, Influenza-related wikipedia articles. | no |

### Dengue Data

| Endpoint | Name | Description | Restricted? |
| --- | --- | --- | --- |
| [`dengue_nowcast`](dengue_nowcast.md) | Delphi's Dengue Nowcast | ... <!-- TODO --> | ... <!-- TODO --> |
| [`dengue_sensors`](dengue_sensors.md) | Delphi's Dengue Digital Surveillance Sensors | ... <!-- TODO --> | ... <!-- TODO --> |
| [`nidss_dengue`](nidss_dengue.md) | NIDSS Dengue | Counts of confirmed dengue cases from Taiwan's NIDSS. | no |
| [`paho_dengue`](paho_dengue.md) | PAHO Dengue | ... <!-- TODO --> | ... <!-- TODO --> |
| [`dengue_nowcast`](dengue_nowcast.md) | Delphi's Dengue Nowcast | Delphi's PAHO dengue nowcasts (North and South America). | no |
| [`dengue_sensors`](dengue_sensors.md) | Delphi's Dengue Digital Surveillance Sensors | PAHO dengue digital surveillance sensors (North and South America). | yes |
| [`nidss_dengue`](nidss_dengue.md) | NIDSS Dengue | NIDSS dengue cases (Taiwan). | no |
| [`paho_dengue`](paho_dengue.md) | PAHO Dengue | PAHO dengue data (North and South America). | no |

### Norovirus Data

| Endpoint | Name | Description | Restricted? |
| --- | --- | --- | --- |
| [`meta_norostat`](meta_norostat.md) | NoroSTAT Metadata | ... <!-- TODO --> | ... <!-- TODO --> |
| [`norostat`](norostat.md) | NoroSTAT | Suspected and confirmed norovirus outbreaks reported by state health departments to the CDC. | ... <!-- TODO --> |
| [`meta_norostat`](meta_norostat.md) | NoroSTAT Metadata | Metadata for the NoroSTAT endpoint. | yes |
| [`norostat`](norostat.md) | NoroSTAT | CDC NoroSTAT norovirus outbreaks. | yes |

### Deprecated
* `ilinet` - replaced by [`fluview`](fluview.md)
Expand All @@ -153,7 +146,7 @@ The parameters available for each source are documented in each linked source-sp
# Example URLs

### FluView on 2015w01 (national)
https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501
<https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501>

```json
{
Expand Down Expand Up @@ -183,7 +176,7 @@ https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501
```

### Wikipedia Access article "influenza" on 2020w01
https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&epiweeks=202001
<https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&epiweeks=202001>

```json
{
Expand All @@ -204,7 +197,7 @@ https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&epiweeks

# Code Samples

To access our Epidata API, visit our [Epidata API Client Libraries)](client_libraries.md). For anyone looking for COVIDCast data in particular, please visit our purpose-built [COVIDCast Libraries](covidcast_clients.md) instead.
To access our Epidata API, visit our [Epidata API Client Libraries](client_libraries.md). For anyone looking for COVIDCast data in particular, please visit our purpose-built [COVIDCast Libraries](covidcast_clients.md) instead.

# Related Work

Expand Down
Loading