Skip to content

Last-minute docs changes #1166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 17, 2023
Merged

Last-minute docs changes #1166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
743cc76
Specify anonymous limits subject to change
krivard May 17, 2023
555950b
Drop mention of restricted datasets and add link to policy and usage
krivard May 17, 2023
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
6 changes: 3 additions & 3 deletions docs/api/api_keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ 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:
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 100 requests per hour
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
Expand All @@ -22,7 +23,6 @@ Epidata API. You can request an API key by
[registering with us](https://forms.gle/hkBr5SfQgxguAfEt7).
Privileges of registration may include:

1. restricted-access datasets
1. no rate limit
1. no limit on multiple selections

Expand Down
3 changes: 2 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ 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 to restricted datasets, no rate limit, and unlimited multiple
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
Expand Down