Skip to main content

Python wrapper for California's energy price API MIDAS.

Project description

california-midasapi

A Python wrapper for the California Energy Comission (CEC)'s Market Informed Demand Automation Server (MIDAS) energy price API.
This API lets you get info about energy prices in California from utilities regulated by the CEC, which is all the big ones (PG&E, SCE, SDG&E, SMUD, etc.) and some smaller municipal utilities. If you have a Rate Identification Number (RIN) QR Code on your electric bill you can use this API to get your electricity price in real time.

Usage

  1. Start by registering an account with MIDAS. There is no webpage for this so I have provided a helper. You only have to register an account once.
from california_midasapi import Midas
response = Midas.register("username", "password", "email@email.email", "Full Name")
print(response)

You should see User account for username was successfully created. A verification email has been sent to email@email.email. Please click the link in the email in order to start using the API..
Click the link in the email, then you can use the rest of the API as described below.

  1. Create a Midas object:
from california_midasapi import Midas
midas = Midas("username", "password")
  1. Access the API methods using this object:
# Get basic info about all rates
from california_midasapi.ratelist import RINFilter
rates = midas.GetAvailableRates(RINFilter.TARIFF)
print(rates) # ~40k+ items at writing

# Get specific info about one rate
ratedata = midas.GetRateInfo('USCA-SMSM-AD00-0000')
print(ratedata)
# Get the currently applicable value from a rate (local filtering)
print(ratedata.GetCurrentTariffs())

Contributing

Contributions are welcome, please submit a PR!

More Information & Thanks

More info about MIDAS can be found at https://midasapi.energy.ca.gov/
Thank you to the CEC for providing example code at https://github.com/morganmshep/MIDAS-Python-Repository

Projects using this library

ha-midas: A Home Assistant integration to expose MIDAS rate data to your smart home

If you have a project using this library, we'd love to hear about it! Let us know and we'll add it to this list.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

california_midasapi-1.1.1.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

california_midasapi-1.1.1-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file california_midasapi-1.1.1.tar.gz.

File metadata

  • Download URL: california_midasapi-1.1.1.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for california_midasapi-1.1.1.tar.gz
Algorithm Hash digest
SHA256 60a318d5c0611cdc58130964aed54e2556e61b724b435fa71c16e2207a784a65
MD5 d84eb6328617948e84e4e03f1e2c5a14
BLAKE2b-256 66d4b6269f843060b3bd8d42f7b6d78d0088552a869ea82775b5e125b837f0e7

See more details on using hashes here.

Provenance

The following attestation bundles were made for california_midasapi-1.1.1.tar.gz:

Publisher: python-publish.yml on MattDahEpic/california-midasapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file california_midasapi-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for california_midasapi-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8da17f3fabcef0b14c40f769a4c7d4af89dbeea0594727739ea13730a38a099f
MD5 97de4fc0e7910c5e58019c3c8e97d51f
BLAKE2b-256 40548df52e364d682ba3727e1199de7eb74c77616357b722b2f3ed1db507c499

See more details on using hashes here.

Provenance

The following attestation bundles were made for california_midasapi-1.1.1-py3-none-any.whl:

Publisher: python-publish.yml on MattDahEpic/california-midasapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page