B2MMessagingSync

API Reference
Picture
Postman Collection
NavigationArrow
View API Docs

Getting Started

About the API

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.

Participants use this API to undertake a predefined set of B2M reporting and standing data queries with AEMO using the Synchronous pattern for the following transaction:

  1. C4 - Single NMI Master Report: Provides the full standing data for a single NMI which is currently available in a C4 – NMI Master Report.

  2. MSATS Limits: Provides details of a Participants MSATS Limits status.

  3. NMI Discovery: Provides a list of NMIs matching the search criteria to authorized Participants.

    • NMI Discovery Type 1: NMI Search by Delivery point identifier (DPID)

    • NMI Discovery Type 1: NMI Search by Meter Serial ID

    • NMI Discovery Type 1: NMI Search by Address (without DPID)

    • NMI Discovery Type 3: Identifying the current or most recent previous retailer for an NMI.

  4. NMI Detail: Provides role details of a specified NMI to authorised users. It is the same criteria as NMI Discovery type 2.

  5. Participant System Status: Provides feedback to Participants about the status of their processing by MSATS systems.

  6. C1 - Provides all the codes and rules for a particular table; you must submit a report with the [Start Date] and [End Date]. To get all records where full replication is allowed, use an old Start Date (e.g. 01-Jan-1970) and today as the End Date.

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

  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/B2MMessagingSync/v1

Test Data

Pre-Production MarketNet Entry

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

Test Data

Production Internet Entry

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

Live Data

Production MarketNet Entry

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

Live Data

Parameters

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