Skip to content
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.

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

[Feature Contribution]: Add support for WattTime v3 - latest version of the API with new features and coverage #443

Open
2 of 4 tasks
danuw opened this issue Jan 7, 2024 · 2 comments
Assignees
Labels

Comments

@danuw
Copy link
Collaborator

danuw commented Jan 7, 2024

What happened?

WattTime just released a new version of their API.
https://watttime.org/data-science/release-notes/#:~:text=APIv3%20release

We’re excited to announce the release of our upgraded API (version 3). This new API brings many improvements including more intuitive and descriptive data delivery, error handling, and more. We are publishing data for 12 new countries which are only available in the new API. In addition to CO2, in the new API we also offer our Health Damage data signal which estimates the damage to human life and health caused by pollution from power plants. Our new coverage map shows the new countries we cover and where we offer each of our data signals.

This change needs to happen before June 2024 at which point the current version of the API will be out of service.

Transition Resources: We want this transition to be as easy as possible and worth the effort to upgrade. We’ve prepared a number of resources to guide you through the transition and help you get acquainted with the new API, new regions, and new signals.
Transition Guide for APIv2 -> APIv3
APIv3 documentation
Release notes related to the API, Data models, and Methodology
Data Signals Overview to explain each of the data types we offer
Methodology & Validation has been updated and expanded

Additional Support: WattTime will host a Q&A webinar about the new API and new features on Tuesday, January 23, 2024 at 11:30AM US-Pacific / 2:30PM US-Eastern. Webinar details and sign-up are here, and if you miss the webinar the recording will be accessible on-demand using the same page after the event concludes.

TODO:

  • Gap Analysis
  • Create migration backlog

Code of Conduct

  • I agree to follow this project's Code of Conduct

Feature Commitment

  • I commit to contributing this feature as a PR and working with the GSF to merge this feature into the Carbon Aware SDK.
@Sophietn
Copy link
Contributor

Sophietn commented Apr 23, 2024

Actions

  • Identify what APIs we currently call
  • Identify what's changed (response codes? schema changes? path changes? any regression? and future capabilities we may want to support?)
  • Document what we believe
  • Confirm with Watttime the work we've identified that needs to be done

NTT DATA don't feel like they have clear enough awareness to do this work.
@vaughanknight will speak to @danuw and @Willmish
if not, we could do a call out with gsf-all newsletter for other contributors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: In Progress
Development

No branches or pull requests

3 participants