{"info":{"_postman_id":"d640a6bf-ccfc-419e-9638-dd54f3295339","name":"WEMDE DispatchInstruction","description":"

Dispatch instructions are MW output instructions (or MW cap instructions) created by the market dispatch engine and available every five minutes for the primary dispatch interval for energy and essential services.

Dispatch instructions are created and made available every five minutes, expected within 30 seconds of the beginning of the current interval, referred to as the primary dispatch interval.

In addition to dispatch instructions, the WEMDE Dispatch API collection allows MPs direct access to the full range of inputs and dispatch outcomes for each market (Energy and Essential System Services (ESS)) for every market solution. The other Dispatch APIs are described in the described in the following reference documents:

Dispatch Case
Dispatch Summary
Dispatch Solutions.
Trading Day Report
DSP Dispatch Instruction
Not In Service Capacity
Reference Trading Price

For support, contact: AEMO Real Time Market Submissions Team

Email: wa.operations@aemo.com.au

API status

Ready. The design is ready for participants to use.

Assumed knowledge

API and JSON or YAML basics.

Prerequisites

Before you can use the Dispatch Instruction API you must:

Have a Participant ID and Facility Code. If your company is a Registered Participant, your ID is set up during the registration process.
Have a DigiCert TLS certificate.

For more information, see the Reformer page Accessing our test environments.

External documents

To be included in future releases.

Future publications

The following essential/mandatory endpoints will be added to the WEMDE UI swaggers in future releases and will also be documented in API references:

Demand side program data
Market schedule scenarios
Reference trading price

Request/response payload required limits

For all APIs, there is an enforced 10 MB max limit.

Certificate-based throttling

A single participant is restricted to accessing 50 calls every minute,
with a total of 200 calls in five minutes.

API details

Use the API Reference icon at the top of the portal page to see the
details of the paths, headers, request body and responses for each of the endpoints in the API.

Authentication methods

The Dispatch Instruction API uses the DigiCert TLS certificate as its authentication method:

Base URLs

The base URLs used for this API are as follows:

Market trial: https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchInstruction
Pre-prod: https://apis.preprod.aemo.com.au:9319/WEM/v1/dispatchInstruction
Production: https://apis.prod.aemo.com.au:9319/WEM/v1/dispatchInstruction

Sample data

Some sample data are available through the following link:
Release 1 sample data

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API status","slug":"api-status"},{"content":"API details","slug":"api-details"}],"owner":"26985380","collectionId":"d640a6bf-ccfc-419e-9638-dd54f3295339","publishedId":"2s93m61MYH","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-25T00:41:18.000Z"},"item":[{"name":"DispatchInstruction","item":[{"name":"Retrieves the recent dispatch instruction for each participant","id":"cafb7727-e489-4cb3-a066-1868cb0bf13d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-initiatingParticipantId","value":"","type":"text","description":"

(Required) The id of the Initiating Participant

\n"},{"key":"x-market","value":"WEM","type":"text","description":"

(Required) The id of the market

\n"}],"url":"https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchInstruction/dispatchInstruction","description":"

Retrieves the recent dispatch instruction for each participant

\n","urlObject":{"path":["dispatchInstruction"],"host":["https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchInstruction"],"query":[{"disabled":true,"key":"facilityCode","value":""},{"disabled":true,"key":"updatedRecordsOnly","value":"false"}],"variable":[]}},"response":[],"_postman_id":"cafb7727-e489-4cb3-a066-1868cb0bf13d"}],"id":"5f6548f0-2e3d-402b-b947-3df3aab3706c","_postman_id":"5f6548f0-2e3d-402b-b947-3df3aab3706c","description":""}],"event":[{"listen":"prerequest","script":{"id":"ee2d04ee-01c7-41f7-8956-fd47a47174e7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"68bd55da-0a5c-4e3a-acdc-0ae0a4ef97f6","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://apis.rfm.aemo.com.au:9319/WEM/v1/dispatchInstruction"},{"key":"x-initiatingParticipantId","value":""},{"key":"x-market","value":"WEM"}]}