Skip to main content

A Python client for the EIA v2 natural gas API with structured access to production, storage, flows, prices, and gas-fired electricity generation.

Project description

eia-ng

A Python client for the EIA v2 natural gas API with structured access to production, storage, consumption, imports, exports, prices, and natural-gas-fired electricity generation.

EIA API Documentation

This library is built on top of the official U.S. Energy Information Administration (EIA) Open Data API.

For detailed information about datasets, endpoints, parameters, and data definitions, refer to the official EIA API documentation:

https://www.eia.gov/opendata/documentation.php

Installation

pip install eia-ng-client

3. API key setup

You need a free EIA API key.

  1. Register at: https://www.eia.gov/opendata/register.php
  2. Set the key as an environment variable:
export EIA_API_KEY="your_api_key_here"

4. Quick start

from eia_ng import EIAClient

client = EIAClient()

# U.S. natural gas production (monthly)
production = client.natural_gas.production(start="2020-01")
print(production[:3])

# Lower 48 natural gas storage (weekly)
weekly_storage = client.natural_gas.weekly_working_storage(start="2022-01-01")
print(weekly_storage[:3])

# Henry Hub spot prices (daily)
prices = client.natural_gas.spot_prices(start="2023-01-01")
print(prices[:3])

5. Natural gas API overview

Natural Gas Data

The natural_gas source provides access to:

  • Production (U.S. total and by state)
  • Consumption (U.S. total and by state)
  • Weekly working gas storage (by region)
  • Underground storage all operators (by geography and metric)
  • Imports (pipeline, LNG, compressed)
  • Exports (pipeline, LNG, truck, compressed)
  • Spot prices (Henry Hub)
  • Futures prices (front-month and deferred contracts)

Production by State

# Texas natural gas production
tx_prod = client.natural_gas.production(
    start="2020-01",
    state="tx",
)

Weekly working storage by region

# Lower 48 weekly working gas storage
weekly_storage = client.natural_gas.weekly_working_storage(
    start="2022-01-01",
    region="lower48",
)

Underground storage all operators

# Texas monthly working gas in underground storage
texas_working_gas = client.natural_gas.underground_storage_all_operators(
    start="2020-01",
    geography="tx",
    metric_type="working_gas",
    frequency="monthly",
)

# U.S. working gas percent change from year ago
us_yoy_pct = client.natural_gas.underground_storage_all_operators(
    start="2020-01",
    geography="us_total",
    metric_type="working_gas_yoy_pct_change",
    frequency="monthly",
)

# Thin wrapper example
base_gas = client.natural_gas.underground_storage_base_gas(
    start="2020-01",
    geography="pa",
)

Underground storage by type

# U.S. monthly working gas by storage type dataset
storage_type_working_gas = client.natural_gas.underground_storage_type(
    start="2020-01",
    storage_type="working_gas",
    frequency="monthly",
)

# U.S. annual salt cavern withdrawals
salt_withdrawals = client.natural_gas.underground_storage_type(
    start="2015",
    storage_type="salt_withdrawals",
    frequency="annual",
)

Imports / exports

# Pipeline imports from Canada
imports = client.natural_gas.imports(
    start="2021-01",
    country="canada_pipeline",
)

# Pipeline exports to Mexico
exports = client.natural_gas.exports(
    start="2021-01",
    country="mexico_pipeline",
)

Futures prices

# Front-month natural gas futures
futures = client.natural_gas.futures_prices(
    start="2023-01-01",
    contract=1,
)

Exploration & Reserves (Annual)

The exploration_and_reserves method provides access to EIA Exploration & Reserves (Form-23) data. This data is annual only and represents reserve stocks or expected future production, not current output.

Supported categories:

  • Proved associated natural gas reserves (wet)
  • Proved nonassociated natural gas reserves (wet)
  • Proved natural gas plant liquids (NGL) reserves
  • Expected future production of dry natural gas

Proved associated natural gas reserves

# U.S. total proved associated natural gas reserves (annual)
reserves_us = client.natural_gas.exploration_and_reserves(
    start="2010",
    resource_category="proved_associated_gas",
)
print(reserves_us[:3])

# Texas proved associated natural gas reserves
reserves_tx = client.natural_gas.exploration_and_reserves(
    start="2010",
    state="tx",
    resource_category="proved_associated_gas",
)
print(reserves_tx[:3])

# Pennsylvania proved nonassociated gas reserves
pa_nonassoc = client.natural_gas.exploration_and_reserves(
    start="2010",
    state="pa",
    resource_category="proved_nonassociated_gas",
)


# U.S. proved NGL reserves
ngl_reserves = client.natural_gas.exploration_and_reserves(
    start="2010",
    resource_category="proved_ngl",
)

# Expected future production of dry natural gas (U.S.)
efp = client.natural_gas.exploration_and_reserves(
    start="2010",
    resource_category="expected_future_gas_production",
)

7. Electricity generation (Natural Gas)

# U.S. electricity generation from natural gas
gen_us = client.electricity.generation_natural_gas(
    start="2020-01",
)

# Utah electricity generation from natural gas
gen_ut = client.electricity.generation_natural_gas(
    start="2020-01",
    state="UT",
)

Returned Data Format

All methods return a list of dictionaries corresponding to rows returned by the EIA API.

You can easily convert the results to pandas using this approach.

import pandas as pd
df = pd.DataFrame(production)

🧪 Testing

This project uses pytest for unit and integration tests and runs inside the Poetry virtual environment.

Run the full test suite with:

poetry run pytest -q

License

MIT

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

eia_ng_client-0.1.60.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

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

eia_ng_client-0.1.60-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file eia_ng_client-0.1.60.tar.gz.

File metadata

  • Download URL: eia_ng_client-0.1.60.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.9.12 Darwin/25.2.0

File hashes

Hashes for eia_ng_client-0.1.60.tar.gz
Algorithm Hash digest
SHA256 b285ea77143943b1e3cb06a49db7a24b271fdda559e390aeafbb6212c5a377b6
MD5 86e4151ae57e9ebaf86184e612ebef35
BLAKE2b-256 4c5ad5587cc7a12afbe9eb6df880038a8cbed73013960fda89674eca16a65bc0

See more details on using hashes here.

File details

Details for the file eia_ng_client-0.1.60-py3-none-any.whl.

File metadata

  • Download URL: eia_ng_client-0.1.60-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.9.12 Darwin/25.2.0

File hashes

Hashes for eia_ng_client-0.1.60-py3-none-any.whl
Algorithm Hash digest
SHA256 608ec190d1b65886db7fb3a9355d7408cc489b72a38cf5e603d4c4279f3f5842
MD5 cdd27a81053144cdcf839adfde7b8738
BLAKE2b-256 7aaae861f56e7178eccae7736d2b9ecdbf6d2ab954c1c84ef6eb190728c0e061

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