Skip to main content

A simple wrapper for the EIA API.

Project description


PyPI PyPI - License PyPI - Python Version

Python 3 wrapper for the U.S. Energy Information Administration API.

Quick start

pip install eiapy

Get the last 5 measurements of the electricity flow between California and Mexico.

>>> from eiapy import Series
>>> cal_to_mex = Series('EBA.CISO-CFE.ID.H')
>>> cal_to_mex.last(5)
{'request': {'command': 'series', 'series_id': 'EBA.CISO-CFE.ID.H'},
 'series': [{'data': [['20180401T07Z', -11],
                      ['20180401T06Z', -16],
                      ['20180401T05Z', -11],
                      ['20180401T04Z', -7],
                      ['20180401T03Z', -5]],
             'description': 'Timestamps follow the ISO8601 standard '
                            '( Hourly '
                            'representations are provided in Universal Time.',
             'end': '20180401T07Z',
             'f': 'H',
             'name': 'Actual Net Interchange for California Independent System '
                     'Operator (CISO) to Comision Federal de Electricidad '
                     '(CFE), Hourly',
             'series_id': 'EBA.CISO-CFE.ID.H',
             'start': '20150701T00Z',
             'units': 'megawatthours',
             'updated': '2018-04-02T08:43:16-0400'}]}

Further examples can be found in this gist.

For more details about the API go to the EIA's Open Data page. To find interesting data (and identifiers) browse the data sets.

Go here to see the API terms of service and here for an explanation of copyright and reuse of their data.

Setting up your API key

An API key is needed to access the EIA's data, you can get one here. eiapy needs this key to be manually set in the operating system environmental variables.

Mac & Linux
Open a terminal and enter the following;

export EIA_KEY=type_your_api_key_here

To set it permanently follow the instructions on this stackexchange question.

Open a Command Prompt and enter the following;

setx EIA_KEY "type_your_api_key_within_the_quotes"

Notes on API behaviour

  • When providing invalid time limits for a series data request an empty data list is returned.
  • For data requests num & start cannot be used together but num & end can.
  • When an invalid series id is passed this is the response.
{'request': {'series_id': '', 'command': 'series', 'num': '5'},
 'data': {'error': 'invalid series_id. For key registration, documentation, and
 examples see'}}



  • Simplify construction and use of the Search class.
  • Explain how to set up the API key.
  • Added gist of examples to readme.


  • Rename several methods for extra clarity.
  • data -> get_data
  • get -> get_updates


  • Started using requests session functionality to improve performance.
  • Fixed a mistake in the MultiSeries class that stopped it working entirely.
  • Added a version attribute to the package.
  • Overhaul of readme.

Project details

Download files

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

Files for eiapy, version 0.1.3
Filename, size & hash File type Python version Upload date
eiapy-0.1.3-py2.py3-none-any.whl (6.2 kB) View hashes Wheel py2.py3
eiapy-0.1.3.tar.gz (6.2 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page