WEM Dispatch Instructions v2

API Reference

The DSP Dispatch Instruction API v2 provides external market participants with secure access to DSP dispatch instruction data. This version enhances the existing DSP Dispatch Instruction API with an updated interface and data model, while supporting ongoing integration and operational requirements.

The API enables participants to retrieve dispatch instruction information for market participation and downstream processing.

API status

Available in preproduction.

Audience

The primary audience is registered participants.

The secondary audience is AEMO's internal support team and Energy Policy WA (EPWA).

For additional information, see:

OpenAPI specification

You can download the OpenAPI Specification for the following environments:

  • Pre-production: OpenAPI specification (TBC)

  • Production: OpenAPI specification (TBC)

Prerequisites

Before using the WEM Dispatch Instructions 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

No request payload. Input data is provided through path parameters, query parameters, and request headers.

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 Dispatch Instructions v2 API are:

  • Payload format - n/a

  • HTTP Methods - GET and POST

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

AKAMAI Pre-production base URL: https://wem-apis.preprod.wgw.aemo.com.au

AKAMAI Production base URL: https://wem-apis.wgw.aemo.com.au

Pre-production base URL (old on-premise server): https://apis.preprod.aemo.com.au:9319

Production base URL (old on-premise server): https://apis.prod.aemo.com.au:9319

Validation

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