B2MMessagingPull

API Reference
Picture
Postman Collection
NavigationArrow
View API Docs

Getting Started

About the API

The NEM Retail B2M APIs allow Registered Market Participants to undertake Retail Business-to-Market communications to submit, acknowledge and manage B2M message exchange with AEMO.

Participants use this API to exchange B2M messages with AEMO using the Push-Pull message pattern for the following transaction groups:

  1. CATS: Consumer Administration and Transfer Solution (CATS) to create, withdraw, edit, object to change requests and request CATS reports as per the CATS and WIGS Procedures and to request CATS reports.

  2. NMID: NMI Standing Data Management (NMID) to Discover the End User’s NMI and NMI Checksum or sufficient standing data about the NMI.

  3. MDMT: Meter Data Management Transaction Group (MDMT) to submit meter data notifications to support B2M Market Settlements and to request RM reports as per the Meteorology Procedures.

The Push-Pull pattern requires API implementation only at the e-Hub where B2M messages queued within AEMO’s systems until the Participants requests delivery via a GET resource.

To assist with the management of NEM B2M Retail APIs, AEMO recommends Participants utilise the HubMessageManagementv2 API to retrieve the current list of stop files or invalid message acknowledgments (badack) using the alerts resource.

Getting Access

To use NEM B2M Retail APIs Participants must:

  1. Be a Registered Participant with a Participant ID.

  2. Have an MSATS user ID with the required Participant User Rights Management (URM) entities granted to it by a participant administrator.

  3. Register with AEMO to use APIs.

During formal onboarding, you will first be given access to Pre-Production and must complete your development/testing there prior to getting access to Production.

External Docs

Below are a list of external links for additional context to the API or Program:

API Details

Authentication Methods

This API is using the following Security Policies:

Note: The TLS certificates used to access Pre-Production are different from those used to access Production.

Endpoints

Below are the base URLs used for this API:

Environment

Base URL

Data Type

Pre-Production Internet Entry

https://apis.preprod.aemo.com.au:9319/NEMRetail/B2MMessagingPull/v1

Test Data

Pre-Production MarketNet Entry

https://apis.preprod.marketnet.net.au:9319/NEMRetail/B2MMessagingPull/v1

Test Data

Production Internet Entry

https://apis.prod.aemo.com.au:9319/NEMRetail/B2MMessagingPull/v1

Live Data

Production MarketNet Entry

https://apis.prod.marketnet.net.au:9319/NEMRetail/B2MMessagingPull/v1

Live Data

Parameters

Paths, Headers, Request Body and Responses can be found in the API Reference (OpenAPI Spec).