You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs: reframe intro away from COVID-centric language
* docs: de-emphasize COVID in other-endpoints framing
* docs: reframe COVIDcast guide beyond the pandemic
* docs: fix nav parent refs after Other Endpoints rename
* docs: reframe main endpoint intro beyond the pandemic
* docs: include Jules' feedback on pandemic framing
Copy file name to clipboardExpand all lines: docs/api/covidcast.md
+14-15Lines changed: 14 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,19 +6,18 @@ nav_order: 3
6
6
7
7
# Main Epidata API
8
8
9
-
This endpoint was previously known as COVIDcast.
9
+
This legacy Epidata API endpoint was formerly called COVIDcast.
10
10
11
-
This is the documentation for accessing Delphi's COVID-19 indicators via the `covidcast` endpoint of [Delphi](https://delphi.cmu.edu/)'s
12
-
epidemiological data API. This API provides data on the spread and impact of the COVID-19 pandemic across the United States, most of which is available at the
11
+
This is the documentation for accessing all Delphi's indicators via the `covidcast` endpoint of [Delphi](https://delphi.cmu.edu/)'s
12
+
epidemiological data API. This API provides data on the spread and impact of infectious diseases, including COVID-19, across the United States, most of which is available at the
13
13
county level and updated daily. This data powers our public [COVIDcast
14
14
map](https://delphi.cmu.edu/covidcast/) which includes testing, cases, and death data,
15
15
as well as unique healthcare and survey data Delphi acquires through its
16
-
partners. The API allows users to select specific signals and download data for
partners. Many additional data sources and pathogen indicator types are available. The API allows users to select specific signals and download data for
17
+
selected geographical areas. For a comprehensive look at the sources, signals, and geographic regions available through the API, please visit [EpiPortal](https://delphi.cmu.edu/epiportal/?hosted_by_delphi=on).
19
18
20
19
21
-
> **Get updates:** Delphi operates a [mailing list](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api) for users of the COVIDcast API. We will use the list to announce API changes, corrections to data, and new features; API users may also use the mailing list to ask general questions about its use. If you use the API, we strongly encourage you to [subscribe](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api).
20
+
> **Get updates:** Delphi operates a [mailing list](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api) for users of the main Epidata API. We will use the list to announce API changes, corrections to data, and new features; API users may also use the mailing list to ask general questions about its use. If you use the API, we strongly encourage you to [subscribe](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api).
22
21
{: .important }
23
22
24
23
## Table of contents
@@ -28,7 +27,7 @@ and other divisions.
28
27
{:toc}
29
28
30
29
## Licensing
31
-
Like all other Delphi Epidata datasets, our COVIDcast data is freely available to the public. However, our COVID-19 indicators include data from many different sources, with data licensing handled separately for each source. For a summary of the licenses used and a list of the indicators each license applies to, we suggest users visit our [COVIDcast licensing](covidcast_licensing.md) page. Licensing information is also summarized on each indicator's details page.
30
+
Like all other Delphi Epidata datasets, our data is freely available to the public. However, our indicators include data from many different sources, with data licensing handled separately for each source. For a summary of the licenses used and a list of the indicators each license applies to, we suggest users visit our [licensing](covidcast_licensing.md) page. Licensing information is also summarized on each indicator's details page.
32
31
We encourage academic users to [cite](README.md#citing) the data if they
33
32
use it in any publications. Our [data ingestion
34
33
code](https://github.com/cmu-delphi/covidcast-indicators) and [API server
@@ -39,9 +38,9 @@ in the [API overview](README.md).
39
38
## Accessing the Data
40
39
41
40
Our [COVIDcast site](https://delphi.cmu.edu/covidcast/) provides an interactive
42
-
visualization of a select set of the data signals available in the COVIDcast
43
-
API, and provides a data export feature to download any data range as a
44
-
CSV file.
41
+
visualization of a select set of the data signals available and relevant
42
+
during the COVID-19 pandemic, and provides a data export feature to download
43
+
any data range as a CSV file.
45
44
46
45
Several [API clients are available](covidcast_clients.md) for common programming
47
46
languages, so you do not need to construct API calls yourself to obtain
@@ -93,13 +92,13 @@ Alternatively, users can [manually construct URLs and parse responses to access
93
92
The API provides multiple data sources, each with several signals. Each source
94
93
represents one provider of data, such as a medical testing provider or a symptom
95
94
survey, and each signal represents one quantity computed from data provided by
96
-
that source. Our sources provide detailed data about COVID-related topics,
95
+
that source. Our sources provide detailed data about infectious disease related topics,
97
96
including confirmed cases, symptom-related search queries, hospitalizations,
98
97
outpatient doctor's visits, and other sources. Many of these are publicly
99
-
available *only* through the COVIDcast API.
98
+
available *only* through the main Epidata API.
100
99
101
-
Delphi's COVID-19 indicators data includes the following data sources.
102
-
Data from most of these sources is typically updated daily. You can use the
100
+
Update cadence varies by source, reflecting what is most relevant for each
101
+
pathogen and context. You can use the
103
102
[`covidcast_meta`](covidcast_meta.md) endpoint to get summary information
104
103
about the ranges of the different attributes for the different data sources.
0 commit comments