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 details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

Details for the file nemapi-1.0.6.tar.gz.

File metadata

  • Download URL: nemapi-1.0.6.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for nemapi-1.0.6.tar.gz
Algorithm Hash digest
SHA256 b01ed0f4e1541695c17203a510a3375fcbdc202ae099a68a961fbdd35f33e22b
MD5 e6c48a63afa2aa89980b07f38982fecc
BLAKE2b-256 d401ab59a7949e381102a34a51695fe85792c74b79f2cedfceb80e7f2cf22d3d

See more details on using hashes here.

File details

Details for the file nemapi-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: nemapi-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for nemapi-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4586eae0eb022a0368c59fc08ffb8b51ed83905093db3ddf13564d7b9572c071
MD5 81c3fe79e309806e7304d0bd0f68a7e3
BLAKE2b-256 6f3ba5d1956dbad988f0eacae6e2093898b4a0168be9cc36a68f3faf1a287a9c

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