AEMO

AEMO B2 M Messaging Pull API

Introduction

GitHub OpenAPI

Operations 4

GET /getMessages Get Messages #
GET /getQueueMetaData Get Queue MetaData #
POST /submitMessageAcknowledgements Submit Message Acknowledgements #
POST /submitMessages Submit Messages #

Documentation

📖
APIReference
https://dev.aemo.com.au/developer/apis/cdr?api-version=2022-04-01-preview
📖
Documentation
https://dev.aemo.com.au/api-docs
📖
Documentation
https://dev.aemo.com.au/CDR
📖
APIReference
https://dev.aemo.com.au/developer/apis/cdr-common?api-version=2022-04-01-preview
📖
Documentation
https://dev.aemo.com.au/CDR-Common

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aemo/refs/heads/main/openapi/aemo-b2mmessagingpull-api-openapi.yml

Other Resources

🔗
APIStandards
https://consumerdatastandardsaustralia.github.io/standards/#energy-secondary-dh-apis
🔗
APIStandards
https://consumerdatastandardsaustralia.github.io/standards/#discovery-apis

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aemo-b2mmessagingpull-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aemo-b2mmessagingpull-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: B2 M Messaging Pull API
  description: '## Introduction

    The B2MMessagingPull push-pull API supports inbound submitMessages, submitMessageAcknowledgements, getMessages, and getQueueMetaData endpoints and suits low volume exchange of messages.'
  version: '3.0'
  x-origin:
  - format: openapi
    source: AEMO API Management developer portal
    url: https://dev.aemo.com.au/developer/apis/b2mmessaging-pull-v1/operations?api-version=2022-04-01-preview
servers:
- url: https://api-prd.aemo.local/NEMRetail/B2MMessagingPull
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: B2MMessagingPull
  description: Introduction
paths:
  /getMessages:
    get:
      operationId: getMessages
      summary: Get Messages
      tags:
      - B2MMessagingPull
      description: Retrieve messages queued in the Participant Hub Queue
      parameters:
      - name: messageContextID
        in: query
        required: true
        schema:
          type: string
        description: message Context ID
      - name: transactionGroup
        in: query
        required: false
        schema:
          type: string
        description: Transaction Group
      - name: X-initiatingParticipantID
        in: header
        required: true
        schema:
          type: string
        description: The ID of the Initiating Participant
      - name: X-market
        in: header
        required: true
        schema:
          type: string
        description: The ID of the Market
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: basic auth
      responses:
        '200':
          description: Success response with aseXml response payload
          content:
            application/xml:
              example: <_x0032_00APIResponseResponse-xml></_x0032_00APIResponseResponse-xml>
        '400':
          description: This response is provided when Mandatory HTTP header {missing Header Name} is missing. No response paylaod.
        '401':
          description: This response is provided when Authorisation is missing from the header OR user/password is incorrect OR user account is locked out. No response paylaod.
        '404':
          description: This response is provided when the requested resource for the endpoint URI is not found. No response paylaod.
        '405':
          description: This response is provided when the requested method/verb on a resource is invalid. No response paylaod.
        '429':
          description: This response is provided when number of inbound requests exceeded the throttling limits. No response paylaod.
        '500':
          description: This response is provided when any unforeseen error is encountered,such as; Certificate/key do not match or incorrect or downstream service is not available.
  /getQueueMetaData:
    get:
      operationId: getQueueMetaData
      summary: Get Queue MetaData
      tags:
      - B2MMessagingPull
      description: Retrieve details of messages queued in the Participant Hub Queue
      parameters:
      - name: transactionGroup
        in: query
        required: false
        schema:
          type: string
        description: Transaction Group
      - name: X-initiatingParticipantID
        in: header
        required: true
        schema:
          type: string
        description: The ID of the Initiating Participant
      - name: X-market
        in: header
        required: true
        schema:
          type: string
        description: The ID of the Market
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success response with aseXml response payload
          content:
            application/xml:
              example: <_x0032_00APIResponseResponse-xml></_x0032_00APIResponseResponse-xml>
        '400':
          description: This response is provided when Mandatory HTTP header {missing Header Name} is missing. No response paylaod.
        '401':
          description: This response is provided when Authorisation is missing from the header OR user/password is incorrect OR user account is locked out. No response paylaod.
        '404':
          description: This response is provided when the requested resource for the endpoint URI is not found. No response paylaod.
        '405':
          description: This response is provided when the requested method/verb on a resource is invalid. No response paylaod.
        '429':
          description: This response is provided when number of inbound requests exceeded the throttling limits. No response paylaod.
        '500':
          description: This response is provided when any unforeseen error is encountered,such as; Certificate/key do not match or incorrect or downstream service is not available.
  /submitMessageAcknowledgements:
    post:
      operationId: submitMessageAcknowledgements
      summary: Submit Message Acknowledgements
      tags:
      - B2MMessagingPull
      description: Submit messages acknowledgements to AEMO’s market systems
      parameters:
      - name: messageContextID
        in: header
        required: true
        schema:
          type: string
        description: Format - [TransactionGroup 0-9_a-z]{1,4} +[Priority h|m|l] + "_"+[FromParticipantID]{1,10} + "_" + [0-9_a-z]{1,18}.
      - name: X-initiatingParticipantID
        in: header
        required: true
        schema:
          type: string
        description: The ID of the Initiating Participant
      - name: X-market
        in: header
        required: false
        schema:
          type: string
        description: The ID of the Market
      - name: Accept
        in: header
        required: true
        schema:
          type: string
        description: Requird response format
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Basic Auth
      requestBody:
        content:
          application/xml:
            example: <SubmitMessageAcknowledgementsPostRequest-5></SubmitMessageAcknowledgementsPostRequest-5>
        description: Payload
      responses:
        '200':
          description: Success response with aseXml response payload
          content:
            application/xml:
              example: <_x0032_00APIResponseResponse-xml></_x0032_00APIResponseResponse-xml>
        '400':
          description: This response is provided when Mandatory HTTP header {missing Header Name} is missing. No response paylaod.
        '401':
          description: This response is provided when Authorisation is missing from the header OR user/password is incorrect OR user account is locked out. No response paylaod.
        '404':
          description: This response is provided when the requested resource for the endpoint URI is not found. No response paylaod.
        '405':
          description: This response is provided when the requested method/verb on a resource is invalid. No response paylaod.
        '429':
          description: This response is provided when number of inbound requests exceeded the throttling limits. No response paylaod.
        '500':
          description: This response is provided when any unforeseen error is encountered,such as; Certificate/key do not match or incorrect or downstream service is not available.
  /submitMessages:
    post:
      operationId: submitMessages
      summary: Submit Messages
      tags:
      - B2MMessagingPull
      description: Submit messages and transaction acknowledgements to AEMO’s market systems
      parameters:
      - name: messageContextID
        in: header
        required: true
        schema:
          type: string
        description: Format - [TransactionGroup 0-9_a-z]{1,4} +[Priority h|m|l] + "_"+[FromParticipantID]{1,10} + "_" + [0-9_a-z]{1,18}.
      - name: X-initiatingParticipantID
        in: header
        required: true
        schema:
          type: string
        description: The ID of the Initiating Participant
      - name: X-market
        in: header
        required: true
        schema:
          type: string
        description: The ID of the Market
      - name: Accept
        in: header
        required: true
        schema:
          type: string
        description: Requird response format
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Basic Auth
      requestBody:
        content:
          application/xml:
            example: <SubmitMessagesPostRequest></SubmitMessagesPostRequest>
        description: Payload
      responses:
        '200':
          description: Success response with aseXml response payload
          content:
            application/xml:
              example: <_x0032_00APIResponseResponse-xml></_x0032_00APIResponseResponse-xml>
        '400':
          description: This response is provided when Mandatory HTTP header {missing Header Name} is missing. No response paylaod.
        '401':
          description: This response is provided when Authorisation is missing from the header OR user/password is incorrect OR user account is locked out. No response paylaod.
        '404':
          description: This response is provided when the requested resource for the endpoint URI is not found. No response paylaod.
        '405':
          description: This response is provided when the requested method/verb on a resource is invalid. No response paylaod.
        '429':
          description: This response is provided when number of inbound requests exceeded the throttling limits. No response paylaod.
        '500':
          description: This response is provided when any unforeseen error is encountered,such as; Certificate/key do not match or incorrect or downstream service is not available.
components:
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query