Skip to main content

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>_.

Release files for nemapi 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nemapi 1.0.6
File Size Uploaded
nemapi-1.0.6.tar.gz 3.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nemapi 1.0.6
File Interpreter ABI Platform
nemapi-1.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 8.9 kB

Release files / nemapi-1.0.6.tar.gz

Download URL nemapi-1.0.6.tar.gz
Size 3.8 kB
Tags Source
SHA-256 checksum
How to use checksums
b01ed0f4e1541695c17203a510a3375fcbdc202ae099a68a961fbdd35f33e22b
BLAKE2b-256 checksum
How to use checksums
d401ab59a7949e381102a34a51695fe85792c74b79f2cedfceb80e7f2cf22d3d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.5.0.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

Release files / nemapi-1.0.6-py3-none-any.whl

Download URL nemapi-1.0.6-py3-none-any.whl
Size 5.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4586eae0eb022a0368c59fc08ffb8b51ed83905093db3ddf13564d7b9572c071
BLAKE2b-256 checksum
How to use checksums
6f3ba5d1956dbad988f0eacae6e2093898b4a0168be9cc36a68f3faf1a287a9c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.5.0.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

Release history Release notifications | RSS feed

This release

1.0.6 This release

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page