WEM Dispatch Solution v2 API

The solution file contains the market outcomes for a given case file. For every successful Market Schedule produced there will be a reconcilable relationship between the solution file and case file. The solution file contains the full set of data produced by WEMDE. Information regarding Scenarios and Market Schedules can be found under section 2 - Data availability on the WEM Dispatch APIs Overview page.

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:

• Email: wa.rtm@aemo.com.au

API status

Available in pre-production and production.

Audience

The primary audience is registered participants.

The secondary audience is AEMO's internal team.

Related resources

For additional information, see:

• e-Hub

• Industry Terminology

• OpenAPI Specification v3.0.1

OpenAPI specification

You can download the OpenAPI Specification for the following environments:

• Pre-production: OpenAPI specification

• Production: OpenAPI specification

Prerequisites

Before using the WEM DSP Dispatch Solution v2 API, see API Requirements in Markets Portal Help. You also need:

• An enabled participant user account associated with a Registered Market Participant. Your Market Participant Administrator creates and manages user accounts. See the WEMS MPI User Management User Guide.

• A DigiCert certificate created and installed for the participant user account.

Payload format

This API supports a JSON format payload.

API gateway

Participants can connect to the AEMO API Gateway through the internet. See URL format in the API Reference.

All communications between AEMO’s API gateway and participants’ gateways use HTTPS. AEMO APIs do not support HTTP.

Authentication methods

The WEM Dispatch APIs use the DigiCert TLS certificate authentication method. 

Authorization

Authorization is based on the participant user account and the permissions configured in the WEMS MPI User Management portal. The participant certificate authenticates the participant with AEMO's Identity Service and obtains a JSON Web Token (JWT). The participant must include the JWT when interacting with the APIs.

Throttling

To control traffic, participants can make up to 50 API calls per minute, with a maximum of 250 calls over any 5-minute period.

Response codes

See Response codes in the API Reference.

Submission rules

The submission rules for the WEM DSP Dispatch Instructions v2 API are:

• Payload format - JSON

• HTTP Methods - GET

• Authentication Mechanisms - as per AEMO standard

• Request parameters - specific to each API

Submission size

A submission request or response has a payload limit of 10 MB (compressed or uncompressed).

Submission processing

n/a

Submission response

Follows standard response codes and throws exception on validation fails.

URLs

The base URLs in the API Reference represent the APIM direct host. They are not applicable for participants. Participants should instead use the base URLs below:

Pre-production base URL: https://wem-apis.wgw.aemo.com.au/WEM/v2/

Production base URL: https://wem-apis.preprod.wgw.aemo.com.au/WEM/v2/

Validation

Validation is implemented for each endpoint. If validation fails, the endpoint returns a 422 response containing the validation error message.