Merge pull request #1167 from cmu-delphi/release/delphi-epidata-0.4.12

Release Delphi Epidata 0.4.12
cmu-delphi · May 18, 2023 · c2f933e · c2f933e
2 parents 7c666fe + cab9043
commit c2f933e
Show file tree

Hide file tree

Showing 49 changed files with 217 additions and 78 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.4.11
+current_version = 0.4.12
 commit = False
 tag = False
 

diff --git a/dev/local/setup.cfg b/dev/local/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = Delphi Development
-version = 0.4.11
+version = 0.4.12
 
 [options]
 packages =

diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -205,14 +205,14 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
-    mini_portile2 (2.8.0)
+    mini_portile2 (2.8.1)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
     minitest (5.17.0)
     multipart-post (2.1.1)
-    nokogiri (1.13.10)
+    nokogiri (1.14.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     octokit (4.20.0)
@@ -221,7 +221,7 @@ GEM
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (4.0.6)
-    racc (1.6.1)
+    racc (1.6.2)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)

diff --git a/docs/api/README.md b/docs/api/README.md
@@ -1,6 +1,6 @@
 ---
 title: Other Endpoints (COVID-19 and Other Diseases)
-nav_order: 2
+nav_order: 3
 has_children: true
 ---
 
@@ -70,7 +70,7 @@ Please note that our `endpoint` parameters were previously referenced as `source
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/
+The base URL is: https://api.delphi.cmu.edu/epidata/
 
 ## Specifying Epiweeks, Dates, and Lists
 
@@ -154,7 +154,7 @@ The parameters available for each source are documented in each linked source-sp
 # Example URLs
 
 ### FluView on 2015w01 (national)
-https://delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501
+https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501
 
 ```json
 {
@@ -184,7 +184,7 @@ https://delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501
 ```
 
 ### Wikipedia Access article "influenza" on 2020w01
-https://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
 {

diff --git a/docs/api/afhsb.md b/docs/api/afhsb.md
@@ -19,7 +19,7 @@ General topics not specific to any particular endpoint are discussed in the
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/afhsb/
+The base URL is: https://api.delphi.cmu.edu/epidata/afhsb/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 

diff --git a/docs/api/api_keys.md b/docs/api/api_keys.md
@@ -0,0 +1,64 @@
+---
+title: API Keys
+nav_order: 1
+has_children: true
+---
+
+# Epidata API Keys
+
+Anyone may access the Epidata API anonymously without providing any personal
+data. Anonymous API access is subject to the following restrictions; they may
+change as we learn more about their impact:
+
+1. public datasets only
+1. rate-limited to 60 requests per hour
+1. only two parameters may have multiple selections
+
+For example, a query for three signals on one date across all counties can be
+submitted anonymously, but a query for three signals on a period of four weeks
+across all counties requires an API key. 
+
+An API key is a pseudonymous access token that grants privileged access to the
+Epidata API. You can request an API key by 
+[registering with us](https://forms.gle/hkBr5SfQgxguAfEt7).
+Privileges of registration may include:
+
+1. no rate limit
+1. no limit on multiple selections
+
+We require an email address for all registrations so that we can contact you to
+resolve problems with excessive or abnormal usage patterns. Any additional
+personal information you provide to us at registration will be much appreciated,
+because it will help us understand what our data is used for and inform our
+plans and priorities, but is voluntary. For more information on how we use and
+store the information you provide us at registration time, see our
+[privacy statement](api/privacy_statement.md).
+
+## Usage
+
+If you choose to [register for an API key](https://forms.gle/hkBr5SfQgxguAfEt7), 
+there are several ways to use your key to authenticate your requests:
+
+### Via request parameter
+
+The request parameter “api_key” can be used to pass the API key to the server.
+Example:
+
+    https://api.delphi.cmu.edu/epidata/covidcast/meta?api_key=your_api_key_here
+
+### Via Basic Authentication
+
+Another method is using the HTTP basic authorization header with the username
+"epidata" and the API key as the password. Example:
+
+```
+curl -u 'epidata:your_api_key_here' https://api.delphi.cmu.edu/epidata/covidcast/meta
+```
+
+### Via Bearer Token
+
+Another method is providing the key in a bearer token header. Example:
+
+```
+curl -H 'Authorization: Bearer your_api_key_here' https://api.delphi.cmu.edu/epidata/covidcast/meta
+```
diff --git a/docs/api/cdc.md b/docs/api/cdc.md
@@ -19,7 +19,7 @@ General topics not specific to any particular endpoint are discussed in the
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/cdc/
+The base URL is: https://api.delphi.cmu.edu/epidata/cdc/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 

diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md
@@ -46,7 +46,7 @@ dataset was published by HHS.
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/covid_hosp_state_timeseries/
+The base URL is: https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/
 
 See [this documentation](README.md) for details on specifying locations and dates.
 
@@ -82,7 +82,7 @@ If `issues` is not specified, then the most recent issue is used by default.
 # Example URLs
 
 ### MA on 2020-05-10 (per most recent issue)
-https://delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates=20200510
+https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates=20200510
 
 ```json
 {

diff --git a/docs/api/covid_hosp_facility.md b/docs/api/covid_hosp_facility.md
@@ -37,7 +37,7 @@ HHS. New versions are expected to be published roughly weekly.
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/covid_hosp_facility/
+The base URL is: https://api.delphi.cmu.edu/epidata/covid_hosp_facility/
 
 See [this documentation](README.md) for details on specifying locations and dates.
 
@@ -87,7 +87,7 @@ has been renamed here for clarity.
 # Example URLs
 
 ### Moses Taylor Hospital (Scranton, PA) on the first collection week of December 2020 (per most recent issue)
-https://delphi.cmu.edu/epidata/covid_hosp_facility/?hospital_pks=390119&collection_weeks=20201201-20201207
+https://api.delphi.cmu.edu/epidata/covid_hosp_facility/?hospital_pks=390119&collection_weeks=20201201-20201207
 
 ```json
 {

diff --git a/docs/api/covid_hosp_facility_lookup.md b/docs/api/covid_hosp_facility_lookup.md
@@ -30,7 +30,7 @@ This data source provides metadata about healthcare facilities in the US.
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/covid_hosp_facility_lookup/
+The base URL is: https://api.delphi.cmu.edu/epidata/covid_hosp_facility_lookup/
 
 See [this documentation](README.md) for details on specifying locations and dates.
 
@@ -72,7 +72,7 @@ Use the `hospital_pk` value when querying
 # Example URLs
 
 ### Lookup facilities in the city of Southlake (TX)
-https://delphi.cmu.edu/epidata/covid_hosp_facility_lookup/?city=southlake
+https://api.delphi.cmu.edu/epidata/covid_hosp_facility_lookup/?city=southlake
 
 ```json
 {

diff --git a/docs/api/covidcast.md b/docs/api/covidcast.md
@@ -1,7 +1,7 @@
 ---
 title: COVIDcast Main Endpoint
 has_children: true
-nav_order: 1
+nav_order: 2
 ---
 
 # COVIDcast Epidata API
@@ -92,7 +92,7 @@ sources and signals.
 ## Constructing API Queries
 
 The COVIDcast API is based on HTTP GET queries and returns data in JSON form.
-The base URL is `https://api.covidcast.cmu.edu/epidata/covidcast/`.
+The base URL is `https://api.delphi.cmu.edu/epidata/covidcast/`.
 
 See [this documentation](README.md) for details on specifying epiweeks, dates,
 and lists.
@@ -207,7 +207,7 @@ The `fields` parameter can be used to limit which fields are included in each re
 
 ### Facebook Survey CLI on 2020-04-06 to 2010-04-10 (county 06001)
 
-https://api.covidcast.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406-20200410&geo_value=06001
+https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406-20200410&geo_value=06001
 
 ```json
 {
@@ -229,7 +229,7 @@ https://api.covidcast.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=sm
 
 ### Facebook Survey CLI on 2020-04-06 (all counties)
 
-https://api.covidcast.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406&geo_value=*
+https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406&geo_value=*
 
 ```json
 {

diff --git a/docs/api/covidcast_meta.md b/docs/api/covidcast_meta.md
@@ -13,7 +13,7 @@ geographic levels at which they are reported.
 
 ## The API
 
-The base URL is: https://api.covidcast.cmu.edu/epidata/covidcast_meta/
+The base URL is: https://api.delphi.cmu.edu/epidata/covidcast_meta/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 
@@ -45,7 +45,7 @@ None required.
 
 ## Example URLs
 
-https://api.covidcast.cmu.edu/epidata/covidcast_meta/
+https://api.delphi.cmu.edu/epidata/covidcast_meta/
 
 ```json
 {

diff --git a/docs/api/delphi.md b/docs/api/delphi.md
@@ -19,7 +19,7 @@ General topics not specific to any particular endpoint are discussed in the
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/delphi/
+The base URL is: https://api.delphi.cmu.edu/epidata/delphi/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 
@@ -58,7 +58,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
 # Example URLs
 
 ### Delphi on 2020w01 (EC)
-https://delphi.cmu.edu/epidata/delphi/?system=ec&epiweek=202001
+https://api.delphi.cmu.edu/epidata/delphi/?system=ec&epiweek=202001
 
 ```json
 {

diff --git a/docs/api/dengue_nowcast.md b/docs/api/dengue_nowcast.md
@@ -20,7 +20,7 @@ General topics not specific to any particular endpoint are discussed in the
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/dengue_nowcast/
+The base URL is: https://api.delphi.cmu.edu/epidata/dengue_nowcast/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 

diff --git a/docs/api/dengue_sensors.md b/docs/api/dengue_sensors.md
@@ -20,7 +20,7 @@ General topics not specific to any particular endpoint are discussed in the
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/dengue_sensors/
+The base URL is: https://api.delphi.cmu.edu/epidata/dengue_sensors/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 

diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md
@@ -19,7 +19,7 @@ ECDC ILI data from ECDC website. ... <!-- TODO -->
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/ecdc_ili/
+The base URL is: https://api.delphi.cmu.edu/epidata/ecdc_ili/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 

diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md
@@ -26,7 +26,7 @@ See also:
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/flusurv/
+The base URL is: https://api.delphi.cmu.edu/epidata/flusurv/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 
@@ -79,7 +79,7 @@ Notes:
 # Example URLs
 
 ### FluSurv on 2020w01 (CA)
-https://delphi.cmu.edu/epidata/flusurv/?locations=ca&epiweeks=202001
+https://api.delphi.cmu.edu/epidata/flusurv/?locations=ca&epiweeks=202001
 
 ```json
 {

diff --git a/docs/api/fluview.md b/docs/api/fluview.md
@@ -25,7 +25,7 @@ Influenza-like illness (ILI) from U.S. Outpatient Influenza-like Illness Surveil
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/fluview/
+The base URL is: https://api.delphi.cmu.edu/epidata/fluview/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 
@@ -80,7 +80,7 @@ Notes:
 # Example URLs
 
 ### FluView on 2015w01 (national)
-https://delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501
+https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501
 
 ```json
 {
@@ -111,11 +111,11 @@ https://delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501
 
 ### FluView in HHS Regions 4 and 6 for the 2014/2015 flu season
 
-https://delphi.cmu.edu/epidata/fluview/?regions=hhs4,hhs6&epiweeks=201440-201520
+https://api.delphi.cmu.edu/epidata/fluview/?regions=hhs4,hhs6&epiweeks=201440-201520
 
 ### Updates to FluView on 2014w53, reported from 2015w01 through 2015w10 (national)
 
-https://delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201453&issues=201501-201510
+https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201453&issues=201501-201510
 
 
 # Code Samples

diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md
@@ -20,7 +20,7 @@ General topics not specific to any particular endpoint are discussed in the
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/fluview_clinical/
+The base URL is: https://api.delphi.cmu.edu/epidata/fluview_clinical/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 
@@ -66,7 +66,7 @@ If neither is specified, the current issues are used.
 # Example URLs
 
 ### FluView Clinical on 2020w01 (national)
-https://delphi.cmu.edu/epidata/fluview_clinical/?regions=nat&epiweeks=202001
+https://api.delphi.cmu.edu/epidata/fluview_clinical/?regions=nat&epiweeks=202001
 
 ```json
 {

diff --git a/docs/api/fluview_meta.md b/docs/api/fluview_meta.md
@@ -20,7 +20,7 @@ Returns information about the [`fluview` endpoint](fluview.md).
 
 # The API
 
-The base URL is: https://delphi.cmu.edu/epidata/fluview_meta/
+The base URL is: https://api.delphi.cmu.edu/epidata/fluview_meta/
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 
@@ -42,7 +42,7 @@ There are no parameters for this endpoint.
 # Example URLs
 
 ### FluView Metadata
-https://delphi.cmu.edu/epidata/fluview_meta/
+https://api.delphi.cmu.edu/epidata/fluview_meta/
 
 ```json
 {