WEM Dispatch Summary API

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

About the WEM Dispatch Summary v1 API

The Dispatch Summary API returns a subset of data from the solution file. The purpose of this API is to produce a smaller payload with a refined set of data that is more commonly sought after by Market Participants. Data is also restricted to the specified Registered Facilities for a given Market Participant.

This data set includes:

  • Dispatch Summary Data

  • Market Schedules

  • Facility Schedule Details

  • Trapezium Adjustments

  • Prices

The data contained within solution files is made publicly available in accordance with the confidentiality status set in Section 10.2: Information Confidentiality Status of the WEM Rules.

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