WEM Dispatch Instructions API

API Reference
Picture
Swagger File
Swagger file link
Back to WEM Dispatch APIs Overview

About the WEM Dispatch Instructions v1 API

A Dispatch Instruction is a direction issued by AEMO to a Market Participant in respect of a Registered Facility to operate the Central Dispatch Process, and is defined in the WEM Rules. This process is enabled through the Dispatch Market Schedule, whereby, Dispatch Instructions are sent to Facilities for the Primary Dispatch Interval. Facilities are instructed to Inject/Withdraw Energy to reach the required Dispatch Target or Dispatch Cap and vary the enablement quantity of Essential System Services when applicable. The information on this page pertains to Facilities that are not registered in the Demand Side Programme Facility Class.

Dispatch Instructions are issued by WEMDE and are available to Market Participants approximately 5 seconds after the start of the primary Dispatch Interval. SCADA controlled Facilities will receive Dispatch Instructions via SCADA based AGC while non-SCADA controlled Facilities can retrieve Dispatch Instructions via a dedicated GET API endpoint. In addition to the retrieval of the current Dispatch Instruction, Market Participants can acknowledge their Dispatch Instructions via a dedicated POST endpoint. The ability to extract historical Dispatch Instructions also exists. For more detailed information regarding the Dispatch Instruction APIs, please navigate to the following icons at the top of the page.

For support, contact WA RTMM team:

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. 

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:

  • 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.

Additional Information

Refer to WEM Dispatch APIs Overview for additional information on Prerequisites for API Access and API Details (Authentication Method and Base URLs).