Skip to content

docs: explain electricitymaps_api_token and query behaviour#1164

Open
hamza-mobeen wants to merge 2 commits intomlco2:masterfrom
hamza-mobeen:docs/co2-signal-token-403
Open

docs: explain electricitymaps_api_token and query behaviour#1164
hamza-mobeen wants to merge 2 commits intomlco2:masterfrom
hamza-mobeen:docs/co2-signal-token-403

Conversation

@hamza-mobeen
Copy link
Copy Markdown

Closes #403

The electricitymaps_api_token parameter was mentioned in config examples but never documented. This PR adds a dedicated section to configuration.md answering the questions raised in the issue:

  • What the token does: real-time carbon intensity vs static annual averages
  • How often the API is queried: at stop, and every ~2 minutes during long runs
  • Where to get a free token
  • Notes that co2_signal_api_token is the deprecated predecessor

@hamza-mobeen hamza-mobeen requested a review from a team as a code owner April 19, 2026 17:08
@hamza-mobeen hamza-mobeen force-pushed the docs/co2-signal-token-403 branch from f93f43e to 115e145 Compare April 19, 2026 17:11
Add a dedicated "Electricity Maps API Token" section to configuration.md
clarifying what the parameter does (real-time vs annual-average carbon
intensity), how often the API is queried, where to get a free token, and
that co2_signal_api_token is the deprecated predecessor.
@hamza-mobeen hamza-mobeen force-pushed the docs/co2-signal-token-403 branch from 115e145 to bd9682b Compare April 19, 2026 17:31
Copy link
Copy Markdown
Collaborator

@inimaz inimaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice @hamza-mobeen thanks for this addition!

@inimaz inimaz enabled auto-merge (squash) April 24, 2026 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation is unclear about co2_signal_api_token functionality

2 participants