Real-Time Market Submissions
API Reference
Swagger File
Getting started
About the Real-Time Market Submissions API
The Real-Time Market Submissions (RTMS) API provides a submission and validation mechanism for both Energy and ESS bids and offers, including Regulation Raise/Lower, Contingency Raise/Lower, and Rate of Change of Frequency (RoCoF) Control Service.
The submission information provided by Market Participants is fed into the Dispatch Engine to determine the lowest-overall-cost dispatch to the market.
The RTMS API allows Market Participants to submit and query their historic submission data for RTM and DSP submissions for all Market Services.
The API Reference automatically takes the APIM endpoint not the F5 endpoint which is accessible for Market Participants.
For support contact AEMO RTMS Team:
Email: wa.rtm@aemo.com.au
Navigating this reference
This page provides an overview of the API as well as information on how to use it.
The icons at the top of the page link to the following, more detailed information sources:
The API Reference describes the paths, headers, request body and responses for each of the endpoints in the API.
The Swagger File links to the latest version of the swagger file for the API.
Prerequisites for API access
Before using this API, you need the following:
An enabled user account (created by your Market Participant Administrator) attached to a Registered Market Participant (see WEMS MPI User Management User Guide).
A DigiCert Certificate created and installed for the user account.
For more information, see The Reformer: Accessing our test environments.
External documents
The following documents provide more detail on this API:
Non-functional requirements
The following provisional non-functional requirements (NFR) are relevant to this API. These may be revised in subsequent versions following consultation with Market Participants.
Request/response payload required limits:
For all APIs, there is an enforced 10 MB max limit.
Rate Limits (Throttling) applied per user:
An individual user is restricted to accessing 50 calls to this API every minute, with a total of 250 calls in five minutes.
API details
Authentication method
This API uses the DigiCert TLS certificate authentication method.
Base URLs
The base URLs used for this API are included below:
