Skip to content

Update README.md with instructions on getting provider credentials #11

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
MeadBarrel merged 2 commits into from
Dec 1, 2025
Merged

Update README.md with instructions on getting provider credentials #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
408f552
Update README.md
MeadBarrel Oct 29, 2025
af3a0b6
Add some newlines in README.md for readability
MeadBarrel Oct 29, 2025
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
17 changes: 14 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,20 @@ The project provides a CLI tool that retrieves electric and gas utility tariff d
## Requirements
- Python 3.11+
- Credentials for the providers you intend to call:
- `ARCADIA_APP_ID` and `ARCADIA_APP_KEY`
- `OPENEI_API_KEY`
- `RATEACUITY_USERNAME` and `RATEACUITY_PASSWORD`

- **Genability / Arcadia Data Platform**: `ARCADIA_APP_ID`, `ARCADIA_APP_KEY`

[Create an account](https://dash.genability.com/signup), navigate to [Applications dashboard](https://dash.genability.com/org/applications), create an application, then copy the Application ID and Key.

- **OpenEI**: `OPENEI_API_KEY`

Request a key at the [OpenEI API signup](https://openei.org/services/api/signup/). The key arrives by email.

- **RateAcuity Web Portal**: `RATEACUITY_USERNAME`, `RATEACUITY_PASSWORD`

There is no self-serve signup. [Contact RateAcuity](https://rateacuity.com/contact-us/) to request Web Portal access. No API key is required for `tariff_fetch`.


- Google Chrome or Chromium installed locally (for RateAcuity)

## Configuration
Expand Down