Skip to main content

API Wrappers for the Energy Markets

Project description

Energy Trading API Wrappers

This package aims to build Pandas-based API wrappers for Energy Markets Data coming from publicly available sources. The results are returned in the Pandas dataFrame format unless specified otherwise.

disclaimer While readily useable, this API library is under constant in development. The reliability of the data from the API list depends on the sources. Enjoy!

Supported APIs:

Australia

Singapore

Japan

Global

Installation

  • Python 3.6 or 3.7

To install, use pip :

$ pip install energy-trading-api

Requirements

  • Python 3.7

Usage

AUSTRALIA

Western Australian Wholesale Electricity Market (WEM)
from energy_trading_api import australiaWEM 
df = australiaWEM.loadForecast()
df1 = australiaWEM.demandSideProgrammePrices(year="2019")

WEM Data API Documentation

ACCC LNG Netback Price Series
from energy_trading_api import australiaLNG
netback,netforward,merged = australiaLNG.acccNetbackPrice()
print(netback.head())

ACCC LNG Netback Price Series Documentation

Australian REC Register
from energy_trading_api import australiaREC 
df = australiaREC.recDay("2019-01-01")

REC Registry API Documentation

AEMC Gas Scheme Register
from energy_trading_api import australiaNG 
df = australiaNG.pipelineRegister()
df1 = australiaNG.pipelineRegisterSearch(state="NSW",operator="APA Group")

AEMC Gas Scheme Register Website

Western Australia Gas Bulletin Board
from energy_trading_api import wagbb 
wagbb.capacityOutlook()

WAGBB API Documentation

Australian Bureau of Meteorology

Retrieves BOM records into a pandas dataframe, given Product and location.

For instance, Bankstown time series data has a product code of IDN60901.94765.

To return Air Temp, Apparent Temp Rel Humidity, Cloud data in a pandas df, simply do:

from energy_trading_api import australiaBOM 
df1 = australiaBOM.airTemp('IDN60901.94765')
df2 = australiaBOM.apparentTemp('IDN60901.94765')
df2 = australiaBOM.relativeHumidity('IDN60901.94765')
df3 = australiaBOM.cloud('IDN60901.94765')

You can also access the entire dataset by doing:

from energy_trading_api import australiaBOM 
df, df_header = australiaBOM.__call_api_BOM('IDN60901.94765')
# e.g. dew point:
print(df['dewpt'].to_string())

Bankstown BOM Data Example

SINGAPORE

Singapore National Electricity Market (NEMS)
from energy_trading_api import singaporeNEMS 
df = singaporeNEMS.singaporeUSEP(date="2019-01-01")

JAPAN

Japan Electric Power Exchange
from energy_trading_api import jepx 
df = jepx.spotLatest()
df = jepx.spotLatest("20190101")
Kyushu Electric Power Company (Kyuden)
from energy_trading_api import japanElectricity as je 
df = je.kyushuElectricdemandJapanese()
df1 = je.kyushuElectricdemandJapanese(day="20190101")
Chubu Electric Power Company (Chuden)
from energy_trading_api import japanElectricity as je 
df = je.chubuElectricdemandJapanese()
df1 = je.chubuElectricDemandJapaneseRange(begtime="20190101",endtime="20190101")
Tokyo Electric Power Company (TEPCO)
from energy_trading_api import japanElectricity as je 
df = je.tepcoElectricDemandHistoricalJapanese("2018")
df1 = je.tepcoElectricDemandCurrentJapanese()
CHUGOKU Electric Power Company (Chugoku Denki)
from energy_trading_api import japanElectricity as je 
df = je.chugokuElectricDemandJapanese("2018")
FEPC - JAPAN Federation of Electric Power Company
from energy_trading_api import japanFEPC as je 
df = je.demandByIndustry()

GLOBAL

U.S. Energy Information Administration
from energy_trading_api import eia_api 
df = eia_api.ngAustraliaProduction("<YOUR-API-KEY-HERE>")

EIA-Python Documentation EIA API Documentation

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

energy_trading_api-0.0.34.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

energy_trading_api-0.0.34-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file energy_trading_api-0.0.34.tar.gz.

File metadata

  • Download URL: energy_trading_api-0.0.34.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.26.0 setuptools/57.4.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.7.2

File hashes

Hashes for energy_trading_api-0.0.34.tar.gz
Algorithm Hash digest
SHA256 f5fe692a3921d56def587d636048a6eeb65c2e3782a8eed70415fedaa5170cd9
MD5 f5f527afaaa920caa96fb859c4b9dc26
BLAKE2b-256 5c1620f9350ebd04ae9c7c5a94ecc60f9342e573a97361609273927d7bfc46fc

See more details on using hashes here.

File details

Details for the file energy_trading_api-0.0.34-py3-none-any.whl.

File metadata

  • Download URL: energy_trading_api-0.0.34-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.26.0 setuptools/57.4.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.7.2

File hashes

Hashes for energy_trading_api-0.0.34-py3-none-any.whl
Algorithm Hash digest
SHA256 b78baca37c6d739718743e754f65b52c4e876ddc95cf23e6e4b2c8b0c7fa72da
MD5 38c9eb44b94324f587926b26426c5b29
BLAKE2b-256 4e55079c2045d21c526be0ebd544087e6b8b2ed1b7732769c20a52628f2467f7

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