Getting started

About the Settlement Service API

The Settlement Service API has not been integrated into the APIM at this time. This has implications for the certificate type and other requirements/behaviours that are explained below.

The Settlement Service API has been designed to allow the retrieval of Settlement Statement information for a Market Participant, including: 

• High-level summary for a settlement period. 

• Low-level details for a Trading Day. 

• Low level details of an estimation Settlement Statement for the Trading Day. 

• A settlement invoice as a PDF for a settlement. 

• A settlement invoice for a settlement. 

• The settlement timeline. 

For support, contact AEMO WA Prudentials and Settlements:

• Email: wa.settlements@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 Local Certificate created and installed for the user account.

For more information see The Reformer: Accessing our test environments. 

External documents

• None.

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:

• As the Settlement Service API has not been integrated into the APIM at this time, the API does not impose a payload required limit..

Rate Limits (Throttling) applied per user:

• As the Settlement Service API has not been integrated into the APIM at this time, no rate limits currently apply. We ask that users apply reasonable caution in managing their call volumes.

API details

Authentication method

This API uses a Local Certificate authentication method.

Base URLs

Note: the Prudential Service API has not been integrated into APIM at this time

The base URLs used for this API are included below: