Skip to content

docs: add links to API key registration #122

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 1 commit into from
Jun 9, 2023
Merged

docs: add links to API key registration #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ and then from the environment variable `DELPHI_EPIDATA_KEY`.
We recommend storing your key in `.Renviron` file, which R will read by default.
You can do this with `usethis::edit_r_environ()` and there enter `DELPHI_EPIDATA_KEY=<your-key>`.
An alternative is [the dotenv package](https://github.com/gaborcsardi/dotenv/).
To generate your key, register for a pseudo-anonymous account
[here](https://api.delphi.cmu.edu/epidata/admin/registration_form), and see more discussion on
the [general API website](https://cmu-delphi.github.io/delphi-epidata/api/api_keys.html).

Note that for the time being, the private endpoints (i.e. those prefixed with `pvt`) will require
a separate key that needs to be passed as an argument.
Expand Down