API Docs

APIs

Explore AEMOs API catalogue below.

Picture
B2BMessagingPull

Send and receive B2B messages between participants in a pull messaging pattern in the NEM.

Picture
B2MMessagingPull

Use the Push-Pull message pattern to undertake NEM Retail Business-to-Market communications with AEMO.

Picture
BlindUpdateTool

Submit and receive Blind Update Tool responses used to perform blind updates to CATS Standing Data fields without the generation of CATS Notifications in the NEM.

Picture
CDP Consent

CDP Clients Only - Creates a guest user session and returns a JWT token upon receiving a valid combination of a NMI, retailer and post code.

CDR Common
CDR Common

APIs to monitor the health status and scheduled outages for CDR in the NEM.

Picture
DER Registration for NSPs

APIs for NSPs to submit data to DERR database in the NEM.

Picture
HubMessageManagementv2

NEM Participants can use this API to receive B2B and B2M stop file and message acknowledgment payload validation failure alerts.

Meter Exemption
Meter Exemptions

Meter co-ordinators in the NEM to create and manage meter exemptions within MSATS to support clause 7.8.3(a) or 7.8.4 (a) of the NER.

Outage Management System

Manage outages in a constrained network environment in the WEM.

Picture
Prudentials

Allows Registered Participants to use Prudential APIs in the Energy Market Systems in the NEM.

Picture
Report

Retrieve data from the Gas Bulletin Board.

Picture
Settlement Direct

Allows Registered Participants to use the Publishing Direct APIs in the Energy Market Systems in the NEM.

TLS Certificate Management

Manage your AEMO-signed TLS certificates.

WEM Dispatch v1

View and download the full range of available data input to and output from the Wholesale Electricity Market Dispatch Engine (WEMDE).

Picture
B2BMessagingAsync

Send and receive B2B messages between participants in an asynchronous fashion in the NEM.

Picture
B2MMessagingAsync

Use the Push-Push message pattern to undertake NEM Retail Business-to-Market communications with AEMO.

Picture
Capacity

Submit and receive data relating to capacity trades and day ahead auction in the NEM.

Picture
CDP Consumption

CDP Clients Only - Returns electricity meter reading data for a given NMI.

Picture
Consumer Data Right (CDR)

APIs for retailers to retrieve AEMO held data on behalf of Accredited Data Recipients.

Picture
GeneratorRecall

Used by generators in the NEM to send information about recall times.

Picture
Identity Service v2

Change a password for a URM account in the NEM.

MT PASA
MT PASA Offers

Submit your MT PASA Offers in the NEM.

Picture
P2PMessagingSync

Exchange Peer-to-peer information via the e-Hub in the NEM.

Real-Time Market Submissions

New submission mechanism and validations for both Energy and ESS bids and offers in the WEM.

Reserve Capacity Mechanism

Ensures the SWIS has sufficient available capacity to meet the peak demand in the WEM.

STEM and Bilateral SOAP APIs

View reports and make submissions relating to the STEM and Bilateral components of the WEM. 

WEM DER Installation v2

Manage WEM DER Installation data.

Picture
B2BMessagingSync

Send and receive B2B messages between participants in a synchronous fashion in the NEM.

Picture
B2MMessagingSync

Use the Sync message pattern to undertake NEM Retail Business-to-Market communications with AEMO for a predefined set of B2M reporting and standing data queries.

Picture
CapacityAuction

Submit and receive data relating to capacity trades and day ahead auction in the NEM.

Picture
CDP Reference Data

CDP Clients Only - Retrieves a list of Energy Retailers in Australia.

Picture
DER Registration for Account Holders

APIs for Account Holders to submit data to DERR database in the NEM.

Picture
HubMessageManagement

Retrieve the current list of stop files for all participants or for a specific participant (using alerts) resource in the NEM.

Picture
Intermittent Generation Availability

Submit intermittent generation availability to AEMO for the NEM.

Picture
NEMDispatchBidding

Submit API Energy, FCAS, and MNSP Bids and Offers.

Prudential and Settlement Service

Prudential and Settlement functionality and services for the WEM.

Picture
Reallocations

Create, authorise or cancel reallocations in the NEM.

Picture
SelfForecast

Submit Solar or Wind Forecasts to AEMO for the NEM.

Submission

Submit data to the Gas Bulletin Board.


Picture
WEM DER NMI

Manage WEM DER NMI details.

Picture
B2BMessagingPull

Send and receive B2B messages between participants in a pull messaging pattern in the NEM.

Picture
B2MMessagingPull

Use the Push-Pull message pattern to undertake NEM Retail Business-to-Market communications with AEMO.

Picture
CDP Consent

CDP Clients Only - Creates a guest user session and returns a JWT token upon receiving a valid combination of a NMI, retailer and post code.

Picture
DER Registration for Account Holders

APIs for Account Holders to submit data to DERR database in the NEM.

Picture
HubMessageManagement

Retrieve the current list of stop files for all participants or for a specific participant (using alerts) resource in the NEM.

Meter Exemptions
Meter Exemptions

Meter co-ordinators in the NEM to create and manage meter exemptions within MSATS to support clause 7.8.3(a) or 7.8.4 (a) of the NER.

Prudential and Settlement Service

Prudential and Settlement functionality and services for the WEM.

Real-Time Market Submissions

New submission mechanism and validations for both Energy and ESS bids and offers in the WEM.

STEM and Bilateral SOAP APIs

View reports and make submissions relating to the STEM and Bilateral components of the WEM. 

WEM DER NMI

Manage WEM DER NMI details.

Picture
B2BMessagingAsync

Send and receive B2B messages between participants in an asynchronous fashion in the NEM.

Picture
B2MMessagingAsync

Use the Push-Push message pattern to undertake NEM Retail Business-to-Market communications with AEMO.

Picture
CDP Consumption

CDP Clients Only - Returns electricity meter reading data for a given NMI.

Picture
DER Registration for NSPs

APIs for NSPs to submit data to DERR database in the NEM.

Picture
Identity Service v2

Change a password for a URM account in the NEM.

Picture
NEMDispatchBidding

Submit API Energy, FCAS, and MNSP Bids and Offers.

Picture
P2PMessagingSync

Exchange Peer-to-peer information via the e-Hub in the NEM.

Reserve Capacity Mechanism

Ensures the SWIS has sufficient available capacity to meet the peak demand in the WEM.

TLS Certificate Management

Manage your AEMO-signed TLS certificates.

WEM Dispatch v1

View and download the full range of available data input to and output from the Wholesale Electricity Market Dispatch Engine (WEMDE).

Picture
B2BMessagingSync

Send and receive B2B messages between participants in a synchronous fashion in the NEM.

Picture
B2MMessagingSync

Use the Sync message pattern to undertake NEM Retail Business-to-Market communications with AEMO for a predefined set of B2M reporting and standing data queries.

Picture
CDP Reference Data

CDP Clients Only - Retrieves a list of Energy Retailers in Australia.

Picture
GeneratorRecall

Used by generators in the NEM to send information about recall times.

Picture
Intermittent Generation Availability

Submit intermittent generation availability to AEMO in the NEM.

Outage Management System

Manage outages in a constrained network environment in the WEM.

Picture
Reallocations

Create, authorise or cancel reallocations in the NEM.

Picture
SelfForecast

Submit Solar or Wind Forecasts to AEMO in the NEM.

Picture
WEM DER Installation v2

Manage WEM DER Installation data.

Picture
Capacity
Submit and receive data relating to capacity trades and day ahead auction in the NEM.
Picture
Report

Retrieve data from the Gas Bulletin Board.

Picture
CapacityAuction
Submit and receive data relating to capacity trades and day ahead auction in the NEM.
Picture
Submission
Submit data to the Gas Bulletin Board.
Picture
Identity Service v2

Change a password for a URM account in the NEM.

TLS Certificate Management
Manage your AEMO-signed TLS certificates.
Picture
B2BMessagingPull

Send and receive B2B messages between participants in a pull messaging pattern in the NEM.

Picture
B2MMessagingPull

Use the Push-Pull message pattern to undertake NEM Retail Business-to-Market communications with AEMO.

Picture
BlindUpdateTool

Submit and receive Blind Update Tool responses used to perform blind updates to CATS Standing Data fields without the generation of CATS Notifications in the NEM.

Picture
HubMessageManagement

Retrieve the current list of stop files for all participants or for a specific participant (using alerts) resource in the NEM.

Picture
P2PMessagingSync

Exchange Peer-to-peer information via the e-Hub in the NEM.

Picture
B2BMessagingAsync

Send and receive B2B messages between participants in an asynchronous fashion in the NEM.

Picture
B2MMessagingAsync

Use the Push-Push message pattern to undertake NEM Retail Business-to-Market communications with AEMO.

CDR Common
CDR Common

APIs to monitor the health status and scheduled outages for CDR in the NEM.

Picture
HubMessageManagementv2

NEM Participants can use this API to receive B2B and B2M stop file and message acknowledgment payload validation failure alerts.

Picture
Report

Retrieve data from the Gas Bulletin Board.

Meter Exemptions
Picture
B2BMessagingSync

Send and receive B2B messages between participants in a synchronous fashion in the NEM.

Picture
B2MMessagingSync

Use the Sync message pattern to undertake NEM Retail Business-to-Market communications with AEMO for a predefined set of B2M reporting and standing data queries.

Picture
Consumer Data Right (CDR)

APIs for retailers to retrieve AEMO held data on behalf of Accredited Data Recipients.

Meter Exemptions
Meter Exemptions

Meter co-ordinators in the NEM to create and manage meter exemptions within MSATS to support clause 7.8.3(a) or 7.8.4 (a) of the NER.

Picture
Submission

Submit data to the Gas Bulletin Board.

Picture
Capacity

Submit and receive data relating to capacity trades and day ahead auction in the NEM.

Picture
Intermittent Generation Availability

Submit intermittent generation availability to AEMO in the NEM.

Picture
Reallocations

Create, authorise or cancel reallocations in the NEM.

Picture
WEM DER Installation

Manage WEM DER Installation data.

Picture
CapacityAuction
Submit and receive data relating to capacity trades and day ahead auction in the NEM.
Picture
NEMDispatchBidding

Submit API Energy, FCAS, and MNSP Bids and Offers in the NEM.

Picture
SelfForecast

Submit Solar or Wind Forecasts to AEMO in the NEM.

Picture
WEM DER NMI

Manage WEM DER NMI details.

Picture
Settlement Direct

Allows Registered Participants to use the Publishing Direct APIs in the Energy Market Systems in the NEM.

Picture
GeneratorRecall

Used by generators in the NEM to send information about recall times.

Picture
Prudentials

Allows Registered Participants to use Prudential APIs in the Energy Market Systems in the NEM.

Picture
Identity Service v2

Change a password for a URM account in the NEM.

Picture
Report
Retrieve data from the Gas Bulletin Board.
Picture
Submission

Submit data to the Gas Bulletin Board.

Picture
Capacity
Submit and receive data relating to capacity trades and day ahead auction.
Picture
CapacityAuction
Submit and receive data relating to capacity trades and day ahead auction.
Picture
DER Registration for Account Holders

APIs for Account Holders to submit data to DERR database in the NEM.

Picture
WEM DER NMI

Manage WEM DER NMI details.

Picture
DER Registration for NSPs

APIs for NSPs to submit data to DERR database in the NEM.

WEM DER Installation v2

Manage WEM DER Installation data.

Picture
CDP Consent

CDP Clients Only - Creates a guest user session and returns a JWT token upon receiving a valid combination of a NMI, retailer and post code.

Picture
CDP Consumption

CDP Clients Only - Returns electricity meter reading data for a given NMI.

Picture
CDP Reference Data

CDP Clients Only - Retrieves a list of Energy Retailers in Australia.

CDR Common
CDR Common

APIs to monitor the health status and scheduled outages for CDR.

Picture
Consumer Data Right (CDR)

APIs for retailers to retrieve AEMO held data on behalf of Accredited Data Recipients.

Outage Management System

Manage outages in a constrained network environment in the WEM.

Reserve Capacity Mechanism

Ensures the SWIS has sufficient available capacity to meet the peak demand.

WEM DER NMI

Manage WEM DER NMI details.

Prudential and Settlement Service

Prudential and Settlement functionality and services for the WEM.

STEM and Bilateral SOAP APIs

View reports and make submissions relating to the STEM and Bilateral components of the WEM. 

WEM Dispatch v1

View and download the full range of available data input to and output from the Wholesale Electricity Market Dispatch Engine (WEMDE).

Real-time Market Submissions

Submission mechanism and validations for both Energy and ESS bids and offers in the WEM.

WEM DER Installation v2

Manage WEM DER Installation data.

General Documentation

Browse through a collection of general API documentation

Working with AEMO APIs