Skip to main content

Access to public National Electricity Market data through nemmarket API.

Project description

nemapi

Access to public National Electricity Market data through nemAPI.

Description & Usage

Currently users can access the following tables within the AEMO MMS Data Model provided at nemweb.

NEM Dispatch Interval Data:

  • dispatch_price
  • dispatch_regionsum
  • dispatch_interconnectorres

NEM Trading Interval Data:

  • trading_price
  • trading_regionsum
  • trading_interconnectorres

There are two main methods for returning data. Firstly a get_['table'] method which will return the most current data back a trailing number of dispatch/trading intervals the user defines. The second is a get_['table']_historical where the user can define a start_date and end_date in addition to selecting over either regionid (price and regionsum tables) or connectorid (interconnectorres tables).

  • Note: Each data request is limited to 10,000 rows.

Examples

from nemapi import *

nemapi = nemapi()
df = nemapi.get_dispatch_price(intervals=1)
print('dispatch prices: \n', df)

df1 = nemapi.get_dispatch_regionsum_historical(start_date='2021-01-01 00:30:00', end_date='2021-01-01 12:00:00', regionid='ALL')
print('dispatch prices: \n', df1)

df2 = nemapi.get_trading_interconnectorres_historical(start_date='2021-01-01 00:00:00', end_date='2021-01-02 00:00:00', connectorid='NSW1-QLD1')
print('trading NSW1-QLD1 interconnector historical : \n', df2)

Installation

Use the package manager pip to install nemapi.

pip install nemapi
pip install nemapi --upgrade

Requirements

Python modules required:

  • datetime
  • requests
  • pandas

Compatibility

Python3

Licence

The MIT License (MIT)

Authors

nemmarketapi was written by Jonathon Emerick <jonathon.emerick@uq.net.au>_.

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

nemapi-1.0.6.tar.gz (3.8 kB view hashes)

Uploaded Source

Built Distribution

nemapi-1.0.6-py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 3

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