diff --git a/.bumpversion.cfg b/.bumpversion.cfg index d288160fd..c4d30e289 100644 --- 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 index 68aa62870..374009e0f 100644 --- 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 index 417d76219..d3030e575 100644 --- 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 index f2be98f34..dd8f98d5c 100644 --- 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 index 0c7056954..d53ad643e 100644 --- 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 new file mode 100644 index 000000000..37276f406 --- /dev/null +++ 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 index b71cab244..25295e512 100644 --- 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 index 0509cd283..d61c6eebf 100644 --- 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 index bad1e1690..fe24bb0e6 100644 --- 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 index 3a40dfd55..25e97c956 100644 --- 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 index ddfce9c06..245f6fe03 100644 --- 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 index e924f78fe..08c3990c8 100644 --- 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 index 8b12ba8d3..1cc645b0a 100644 --- 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 index 693356ddb..abaf15c08 100644 --- 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 index 15d60c1e3..470861bbf 100644 --- 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 index ac704a7fe..399f7f015 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -19,7 +19,7 @@ ECDC ILI data from ECDC website. ... # 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 index 32c097610..b33f5c22d 100644 --- 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 index 79ba9c276..be8d6e825 100644 --- 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 index 259a07c02..d5fd12db2 100644 --- 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 index 090865154..c3fbb25b4 100644 --- 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 { diff --git a/docs/api/gft.md b/docs/api/gft.md index c06574e70..72898cb9b 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -23,7 +23,7 @@ Estimate of influenza activity based on volume of certain search queries. Google # The API -The base URL is: https://delphi.cmu.edu/epidata/gft/ +The base URL is: https://api.delphi.cmu.edu/epidata/gft/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -50,7 +50,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### Google Flu Trends on 2015w01 (national) -https://delphi.cmu.edu/epidata/gft/?locations=nat&epiweeks=201501 +https://api.delphi.cmu.edu/epidata/gft/?locations=nat&epiweeks=201501 ```json { diff --git a/docs/api/ght.md b/docs/api/ght.md index ee5d2be4c..107d5b10e 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -19,7 +19,7 @@ Estimate of influenza activity based on volume of certain search queries. ... # The API -The base URL is: https://delphi.cmu.edu/epidata/kcdc_ili/ +The base URL is: https://api.delphi.cmu.edu/epidata/kcdc_ili/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. diff --git a/docs/api/meta.md b/docs/api/meta.md index 1f4822d17..bccd7c0fd 100644 --- a/docs/api/meta.md +++ b/docs/api/meta.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/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. @@ -38,7 +38,7 @@ None. # Example URLs -https://delphi.cmu.edu/epidata/meta/ +https://api.delphi.cmu.edu/epidata/meta/ ```json { diff --git a/docs/api/meta_afhsb.md b/docs/api/meta_afhsb.md index 10c7ac478..6ba294772 100644 --- a/docs/api/meta_afhsb.md +++ b/docs/api/meta_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/meta_afhsb/ +The base URL is: https://api.delphi.cmu.edu/epidata/meta_afhsb/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. diff --git a/docs/api/meta_norostat.md b/docs/api/meta_norostat.md index 57fc14ebe..217b20fbf 100644 --- a/docs/api/meta_norostat.md +++ b/docs/api/meta_norostat.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/meta_norostat/ +The base URL is: https://api.delphi.cmu.edu/epidata/meta_norostat/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index 40d087d6a..ab7349658 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -23,7 +23,7 @@ Counts of confirmed dengue cases from Taiwan's NIDSS. # The API -The base URL is: https://delphi.cmu.edu/epidata/nidss_dengue/ +The base URL is: https://api.delphi.cmu.edu/epidata/nidss_dengue/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -50,7 +50,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### NIDSS Dengue on 2015w01 (nationwide) -https://delphi.cmu.edu/epidata/nidss_dengue/?locations=nationwide&epiweeks=201501 +https://api.delphi.cmu.edu/epidata/nidss_dengue/?locations=nationwide&epiweeks=201501 ```json { diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md index 08699ea9a..4af0d61d6 100644 --- a/docs/api/nidss_flu.md +++ b/docs/api/nidss_flu.md @@ -25,7 +25,7 @@ Outpatient ILI from Taiwan's National Infectious Disease Statistics System (NIDS # The API -The base URL is: https://delphi.cmu.edu/epidata/nidss_flu/ +The base URL is: https://api.delphi.cmu.edu/epidata/nidss_flu/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -67,7 +67,7 @@ If neither is specified, the current issues are used. # Example URLs ### NIDSS Flu on 2015w01 (nationwide) -https://delphi.cmu.edu/epidata/nidss_flu/?regions=nationwide&epiweeks=201501 +https://api.delphi.cmu.edu/epidata/nidss_flu/?regions=nationwide&epiweeks=201501 ```json { diff --git a/docs/api/norostat.md b/docs/api/norostat.md index 4019020b7..6e801116c 100644 --- a/docs/api/norostat.md +++ b/docs/api/norostat.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/norostat/ +The base URL is: https://api.delphi.cmu.edu/epidata/norostat/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. diff --git a/docs/api/nowcast.md b/docs/api/nowcast.md index dfdecbc54..988c83810 100644 --- a/docs/api/nowcast.md +++ b/docs/api/nowcast.md @@ -25,7 +25,7 @@ A nowcast of U.S. national, regional, and state-level (weighted) %ILI, available # The API -The base URL is: https://delphi.cmu.edu/epidata/nowcast/ +The base URL is: https://api.delphi.cmu.edu/epidata/nowcast/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -53,7 +53,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### ILI Nearby on 2020w01 (national) -https://delphi.cmu.edu/epidata/nowcast/?locations=nat&epiweeks=202001 +https://api.delphi.cmu.edu/epidata/nowcast/?locations=nat&epiweeks=202001 ```json { diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index 3837cb43c..46e1706c2 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.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/paho_dengue/ +The base URL is: https://api.delphi.cmu.edu/epidata/paho_dengue/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. diff --git a/docs/api/privacy_statement.md b/docs/api/privacy_statement.md new file mode 100644 index 000000000..002367931 --- /dev/null +++ b/docs/api/privacy_statement.md @@ -0,0 +1,55 @@ +--- +title: Privacy Statement +parent: API Keys +--- + +# Delphi Privacy Statement + +Anyone may access the Epidata API anonymously without providing any personal +data. + +Some features of the API are only available by registering for an API key. 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. + +You may also choose to share personal information with us to participate in user +surveys. + +We log information about API traffic including the query parameters, API key, +and source IP address for each request. We retain these logs for a period of not +longer than five years. We use this information for the following +purposes: + +* to monitor the responsiveness of the API service +* to monitor the relative popularity of different data and features, alone and + in concert with user survey results +* to identify excessive or abnormal usage patterns which may harm our system + +The logs are only available to members of our operations team, and are expunged +at or before they reach five years in age. + +If you provide us with your email address, we will only use it to contact you in +the following scenarios: + +* you asked a question in a user survey and we have an answer for you +* we make improvements or other changes to the Epidata API service +* the API service experiences an outage +* your API key is about to expire +* your API usage becomes excessive or abnormal +* a voluntary survey of our users, but no more than once every 6 months + +We store the mapping from tokens to email addresses in a location separate from +server logs, using security measures consistent with our internal information +security practices to help us keep your information secure. We only retrieve +this mapping to resolve cases of excessive or abnormal usage. We automatically +disassociate an email address from its API key when the API key has not been +used for six months, or upon user request. You can request that your +email address be removed from our records by filling out a +[deletion request](https://forms.gle/GucFmZHTMgEFjH197). + +For more information, see +[Carnegie Mellon’s privacy notice](https://www.cmu.edu/legal/privacy-notice.html). +Further questions can be directed to delphi-support+privacy@andrew.cmu.edu. \ No newline at end of file diff --git a/docs/api/quidel.md b/docs/api/quidel.md index 9139ca59c..0abb412ca 100644 --- a/docs/api/quidel.md +++ b/docs/api/quidel.md @@ -21,7 +21,7 @@ Data provided by Quidel Corp., which contains flu lab test results. # The API -The base URL is: https://delphi.cmu.edu/epidata/quidel/ +The base URL is: https://api.delphi.cmu.edu/epidata/quidel/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. diff --git a/docs/api/sensors.md b/docs/api/sensors.md index 5175326e0..c4430e1f1 100644 --- a/docs/api/sensors.md +++ b/docs/api/sensors.md @@ -29,7 +29,7 @@ the COVID-19 pandemic. # The API -The base URL is: https://delphi.cmu.edu/epidata/sensors/ +The base URL is: https://api.delphi.cmu.edu/epidata/sensors/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -70,7 +70,7 @@ Notes: # Example URLs ### Delphi's Digital Surveillance SAR3 Sensor on 2020w01 (national) -https://delphi.cmu.edu/epidata/sensors/?names=sar3&locations=nat&epiweeks=202001 +https://api.delphi.cmu.edu/epidata/sensors/?names=sar3&locations=nat&epiweeks=202001 ```json { diff --git a/docs/api/twitter.md b/docs/api/twitter.md index 9c99b52f8..dc2196f47 100644 --- a/docs/api/twitter.md +++ b/docs/api/twitter.md @@ -23,7 +23,7 @@ Estimate of influenza activity based on analysis of language used in tweets. # The API -The base URL is: https://delphi.cmu.edu/epidata/twitter/ +The base URL is: https://api.delphi.cmu.edu/epidata/twitter/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -53,7 +53,7 @@ Note: # Example URLs ### Twitter on 2015w01 (national) -https://delphi.cmu.edu/epidata/twitter/?auth=...&locations=nat&epiweeks=201501 +https://api.delphi.cmu.edu/epidata/twitter/?auth=...&locations=nat&epiweeks=201501 ```json { diff --git a/docs/api/wiki.md b/docs/api/wiki.md index 5566db9d8..136711f46 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -24,7 +24,7 @@ Number of page visits for selected English, Influenza-related wikipedia articles # The API -The base URL is: https://delphi.cmu.edu/epidata/wiki/ +The base URL is: https://api.delphi.cmu.edu/epidata/wiki/ See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -66,7 +66,7 @@ Note: # Example URLs ### 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 { @@ -86,7 +86,7 @@ https://delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&epiweeks=202 ``` ### Wikipedia Access article "influenza" on date 2020-01-01 -https://delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&dates=20200101 +https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&dates=20200101 ```json { diff --git a/docs/epidata_development.md b/docs/epidata_development.md index a2f0b7e8e..29a0fdde7 100644 --- a/docs/epidata_development.md +++ b/docs/epidata_development.md @@ -1,6 +1,6 @@ --- title: Epidata API Development Guide -nav_order: 3 +nav_order: 4 --- # Epidata API Development Guide diff --git a/docs/index.md b/docs/index.md index c49e97467..1ddce45dc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,6 +14,26 @@ group](https://delphi.cmu.edu/). The Epidata API includes: quick access to COVID data are available. - [Data about other diseases](api/README.md), including influenza, dengue, and other diseases tracked by Delphi through various data streams. + +Anyone may access the Epidata API anonymously without providing any personal +data. Anonymous API access is currently rate-limited and restricted to public +datasets with a maximum of two of the requested parameters having multiple +selections (signals, dates, versions, regions, etc). + +To request access with no rate limit and unlimited multiple +selections, you can [request a registered API key](https://forms.gle/hkBr5SfQgxguAfEt7). +For policy and usage details, consult the [Epidata API keys documentation](api/api_keys.md). + +If you regularly or frequently use our system, please consider using an API key +even if your usage falls within the anonymous usage limits. API key usage helps +us understand who and how others are using our Delphi Epidata API, which may in +turn inform our future research, data partnerships, and funding. + +For more information about how we use the data you provide us through your +registration and API request activity, see our +[Privacy Statement](api/privacy_statement.md). At any time, you may submit a +[Deletion Request](https://forms.gle/GucFmZHTMgEFjH197) to have us deactivate your key and destroy all +information associating that key with your identity. The Delphi group is extremely grateful to Pedrito Maynard-Zhang for all his help with the Epidata API [documentation](api/README.md). diff --git a/docs/new_endpoint_tutorial.md b/docs/new_endpoint_tutorial.md index 436b89908..6e6094161 100644 --- a/docs/new_endpoint_tutorial.md +++ b/docs/new_endpoint_tutorial.md @@ -1,6 +1,6 @@ --- title: New Endpoint Tutorial -nav_order: 4 +nav_order: 5 --- # Tutorial: Adding a new API endpoint @@ -325,7 +325,7 @@ actual created in this tutorial. Once it's approved, merge the PR, and contact an admin to schedule a release. Once released, the API will begin serving your new endpoint. Go ahead and give it a -try: https://delphi.cmu.edu/epidata/fluview_meta/ +try: https://api.delphi.cmu.edu/epidata/fluview_meta/ ``` { diff --git a/docs/symptom-survey/index.md b/docs/symptom-survey/index.md index ac1ba9ac7..ec926dea3 100644 --- a/docs/symptom-survey/index.md +++ b/docs/symptom-survey/index.md @@ -1,7 +1,7 @@ --- title: COVID-19 Trends and Impact Survey has_children: true -nav_order: 5 +nav_order: 6 --- # COVID-19 Trends and Impact Survey diff --git a/scripts/report_missing_covidcast_meta.py b/scripts/report_missing_covidcast_meta.py index bd1779070..6346541b9 100644 --- a/scripts/report_missing_covidcast_meta.py +++ b/scripts/report_missing_covidcast_meta.py @@ -5,7 +5,7 @@ from pathlib import Path base_dir = Path(__file__).parent.parent -base_url = 'https://delphi.cmu.edu/epidata' +base_url = 'https://api.delphi.cmu.edu/epidata' def is_known_missing(source: str, signal: str) -> bool: if '7dav_cumulative' in signal: diff --git a/src/client/delphi_epidata.R b/src/client/delphi_epidata.R index 9566fda50..4f72b5f91 100644 --- a/src/client/delphi_epidata.R +++ b/src/client/delphi_epidata.R @@ -13,9 +13,9 @@ library(httr) Epidata <- (function() { # API base url - BASE_URL <- 'https://delphi.cmu.edu/epidata/api.php' + BASE_URL <- 'https://api.delphi.cmu.edu/epidata/api.php' - client_version <- '0.4.11' + client_version <- '0.4.12' # Helper function to cast values and/or ranges to strings .listitem <- function(value) { diff --git a/src/client/delphi_epidata.js b/src/client/delphi_epidata.js index 67240f754..0fb25d422 100644 --- a/src/client/delphi_epidata.js +++ b/src/client/delphi_epidata.js @@ -21,8 +21,8 @@ factory(root, root.fetch, root.jQuery || root.$); } })(this, function (exports, fetchImpl, jQuery) { - const BASE_URL = "https://delphi.cmu.edu/epidata/"; - const client_version = "0.4.11"; + const BASE_URL = "https://api.delphi.cmu.edu/epidata/"; + const client_version = "0.4.12"; // Helper function to cast values and/or ranges to strings function _listitem(value) { diff --git a/src/client/delphi_epidata.py b/src/client/delphi_epidata.py index 9b3deea94..61b5e41eb 100644 --- a/src/client/delphi_epidata.py +++ b/src/client/delphi_epidata.py @@ -33,7 +33,7 @@ class Epidata: """An interface to DELPHI's Epidata API.""" # API base url - BASE_URL = 'https://delphi.cmu.edu/epidata/api.php' + BASE_URL = 'https://api.delphi.cmu.edu/epidata/api.php' client_version = _version diff --git a/src/client/packaging/npm/package.json b/src/client/packaging/npm/package.json index 4daf24d72..fd109150d 100644 --- a/src/client/packaging/npm/package.json +++ b/src/client/packaging/npm/package.json @@ -2,7 +2,7 @@ "name": "delphi_epidata", "description": "Delphi Epidata API Client", "authors": "Delphi Group", - "version": "0.4.11", + "version": "0.4.12", "license": "MIT", "homepage": "https://github.com/cmu-delphi/delphi-epidata", "bugs": { diff --git a/src/client/packaging/npm/tests/__snapshots__/delphi_epidata.spec.js.snap b/src/client/packaging/npm/tests/__snapshots__/delphi_epidata.spec.js.snap index f0a2aa9f7..b38675130 100644 --- a/src/client/packaging/npm/tests/__snapshots__/delphi_epidata.spec.js.snap +++ b/src/client/packaging/npm/tests/__snapshots__/delphi_epidata.spec.js.snap @@ -36,7 +36,7 @@ exports[`fluview basic async 1`] = ` [MockFunction] { "calls": Array [ Array [ - "https://delphi.cmu.edu/epidata/fluview/?regions=a&epiweeks=4", + "https://api.delphi.cmu.edu/epidata/fluview/?regions=a&epiweeks=4", ], ], "results": Array [ @@ -52,7 +52,7 @@ exports[`fluview basic sync 1`] = ` [MockFunction] { "calls": Array [ Array [ - "https://delphi.cmu.edu/epidata/fluview/?regions=a&epiweeks=4", + "https://api.delphi.cmu.edu/epidata/fluview/?regions=a&epiweeks=4", ], ], "results": Array [ diff --git a/src/client/packaging/pypi/delphi_epidata/__init__.py b/src/client/packaging/pypi/delphi_epidata/__init__.py index da769f9d5..018c759ac 100644 --- a/src/client/packaging/pypi/delphi_epidata/__init__.py +++ b/src/client/packaging/pypi/delphi_epidata/__init__.py @@ -1,4 +1,4 @@ from .delphi_epidata import Epidata name = 'delphi_epidata' -__version__ = '0.4.11' +__version__ = '0.4.12' diff --git a/src/client/packaging/pypi/setup.py b/src/client/packaging/pypi/setup.py index 40e2a0b05..c53cf23dd 100644 --- a/src/client/packaging/pypi/setup.py +++ b/src/client/packaging/pypi/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name="delphi_epidata", - version="0.4.11", + version="0.4.12", author="David Farrow", author_email="dfarrow0@gmail.com", description="A programmatic interface to Delphi's Epidata API.", diff --git a/src/server/_config.py b/src/server/_config.py index 13e7e2b5e..073da564a 100644 --- a/src/server/_config.py +++ b/src/server/_config.py @@ -4,7 +4,7 @@ load_dotenv() -VERSION = "0.4.11" +VERSION = "0.4.12" MAX_RESULTS = int(10e6) MAX_COMPATIBILITY_RESULTS = int(3650)