parsimony-eia
U.S. Energy Information Administration (EIA) connector — fetches energy data (petroleum, electricity, natural gas, coal, renewables) from the EIA v2 Open Data API.
Part of the parsimony-connectors monorepo. Distributed standalone on PyPI as parsimony-eia.
Connectors
| Name | Kind | Description |
|---|---|---|
eia_search |
tool | Semantic-search the dataset catalog; returns a dataset route to pass to eia_fetch. |
eia_fetch |
fetch | Fetch a dataset by route (e.g. petroleum/pri/spt) with optional measure, facets, frequency, start, end. Paged in full. |
eia_fetch_series |
fetch | Fetch by a legacy APIv1 series id (e.g. PET.RWTC.D) via the /v2/seriesid/{id} path. |
eia_facets |
tool | List the valid {id, name} values of a dataset's facet dimension, to narrow a fetch to a series. |
enumerate_eia |
enumerator | Walk the v2 route tree to one row per leaf dataset (the catalog feed). |
Coverage
The catalog indexes all 232 leaf datasets across EIA's 14 top-level
categories (petroleum, natural gas, electricity, coal, nuclear, renewables/
densified-biomass, total energy, emissions, international, SEDS, STEO, AEO, IEO,
crude-oil imports), each carrying its measure and facet-dimension manifest. EIA's
full series universe (~2M series) is the facet cartesian product of those
datasets — too large to catalog individually, but every series is fetchable:
by route + facets filters, or by its legacy series id via eia_fetch_series.
So discovery is at the dataset tier and access is total.
EIA caps every data response at 5,000 rows; the fetch connectors page through to completeness automatically (a request matching more than 300,000 rows is refused with guidance to narrow it). Data is U.S. federal public domain — cite as "Source: U.S. Energy Information Administration".
Install
pip install parsimony-eia
Pulls in a compatible parsimony automatically. Verify discovery:
python -c "from parsimony import discover; print([p.name for p in discover.iter_providers()])"
Configuration
Set the following environment variable:
export EIA_API_KEY="<your-key>"
Get a free key at https://www.eia.gov/opendata/register.php.
Quick start
from parsimony_eia import CONNECTORS
result = CONNECTORS["eia_fetch"](route="petroleum/pri/spt", frequency="monthly")
print(result.raw.head())
For multi-plugin composition:
from parsimony import discover
connectors = discover.load_all()
Provider
- Homepage: https://www.eia.gov
- API docs: https://www.eia.gov/opendata/documentation.php
License
See LICENSE.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file parsimony_eia-0.0.2.tar.gz.
File metadata
- Download URL: parsimony_eia-0.0.2.tar.gz
- Upload date:
- Size: 18.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b1708e164e4676be19f726a6bee9fba64feff282de7b5b3e704198c74e5ff735
|
|
| MD5 |
df1072384f5371eb6a89f4e2d0e20c7e
|
|
| BLAKE2b-256 |
adc9d0ef3d9d3767e16401ee9cae3f1e750932b07150fc518292b93f5adc1e8b
|
Provenance
The following attestation bundles were made for parsimony_eia-0.0.2.tar.gz:
Publisher:
release.yml on ockham-sh/parsimony-connectors
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
parsimony_eia-0.0.2.tar.gz -
Subject digest:
b1708e164e4676be19f726a6bee9fba64feff282de7b5b3e704198c74e5ff735 - Sigstore transparency entry: 2408413107
- Sigstore integration time:
-
Permalink:
ockham-sh/parsimony-connectors@45adac08dad2b5faf031867e7e3ca1b87689f5b9 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/ockham-sh
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@45adac08dad2b5faf031867e7e3ca1b87689f5b9 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file parsimony_eia-0.0.2-py3-none-any.whl.
File metadata
- Download URL: parsimony_eia-0.0.2-py3-none-any.whl
- Upload date:
- Size: 21.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
642c3c6a77dde30765148e389f0ff136da013b6df244632ad3c477b25eed69a9
|
|
| MD5 |
275afc04f9d4975097d98883afe6bf10
|
|
| BLAKE2b-256 |
f2d8ed64579536a730a0ab45e3e43484ed562b80c053bbe385e9ce969e9838e2
|
Provenance
The following attestation bundles were made for parsimony_eia-0.0.2-py3-none-any.whl:
Publisher:
release.yml on ockham-sh/parsimony-connectors
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
parsimony_eia-0.0.2-py3-none-any.whl -
Subject digest:
642c3c6a77dde30765148e389f0ff136da013b6df244632ad3c477b25eed69a9 - Sigstore transparency entry: 2408413185
- Sigstore integration time:
-
Permalink:
ockham-sh/parsimony-connectors@45adac08dad2b5faf031867e7e3ca1b87689f5b9 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/ockham-sh
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@45adac08dad2b5faf031867e7e3ca1b87689f5b9 -
Trigger Event:
workflow_dispatch
-
Statement type:
