Skip to main content

Fast, unofficial Python client for the EIA Open Data API v2 (Polars-native, cached)

Project description

eiax

Unofficial Python client for the EIA Open Data API v2. polars-native, auto-paginating, and parquet cached.

Installation

pip install eiax # install eiax[fastjson] to use orjson for faster loads

eiax requires Python 3.12+.

API key

Get a key at eia.gov/opendata/register.php. Browsing the offline catalog (search, help_route, facet_values) does not need a key.

Provide the key any of these ways (highest precedence first):

import eiax

# 1. Explicit argument
client = eiax.EIAClient(api_key="your_key")
# 2. Environment variable (best for pipelines / CI)
#   export EIA_API_KEY=your_key
# 3. A local .env file (best for development)
#   EIA_API_KEY=your_key

License & attribution

eiax is released under the MIT License. It is not affiliated with the U.S. EIA.

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

eiax-0.1.0.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

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

eiax-0.1.0-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

Details for the file eiax-0.1.0.tar.gz.

File metadata

  • Download URL: eiax-0.1.0.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for eiax-0.1.0.tar.gz
Algorithm Hash digest
SHA256 606d6736d00e7c2358269b470aa1219b882d605477e88a7ac2dd65d15564e05e
MD5 91f270a2a0382c805f5b949bb014c5ba
BLAKE2b-256 ac044862aa43682e583ff62cd30962b791ddb34ddf8896c3396011b8c87fc393

See more details on using hashes here.

File details

Details for the file eiax-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: eiax-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for eiax-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d1347d5712cc1b73a9b4696aa9d21861a63eb7da4e914e45d9f61c7d4d431afb
MD5 78cc6cdc5d8f83b347e7d7d99b7baba2
BLAKE2b-256 5ca0b647fcf476fe04fd4f3817ed2498dfc9ebfddaadf7b975b31f35d65a11ea

See more details on using hashes here.

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