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) QA 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

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-0.0.8.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

california_midasapi-0.0.8-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: california_midasapi-0.0.8.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for california_midasapi-0.0.8.tar.gz
Algorithm Hash digest
SHA256 4a58b6f8cd24d6ad0ef520efd190c297097c356ac74f887a19f3d749f2488972
MD5 dfd63ced9fa0dd6b5856ede931dab13c
BLAKE2b-256 1eace05e9bed33ecb256c56155d07f72caeddddb4a33a24457f6834ccae4b88c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for california_midasapi-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7d564932203ea1b14cd852f4aed8498a949a9897ae78260e1a85af4b823ea6f8
MD5 b129bab22c3f49351e33e96a1b10473b
BLAKE2b-256 cef37d4eb3bc1b88c0547a8897a948fecfb3776ee21bd765b850014ed20f68a9

See more details on using hashes here.

Supported by

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