7 Power Quality Data API

This API Application Programming Interface; a set of clearly defined methods of communication between various software components. provides an interface for submitting and retrieving structured basic power quality data within the NEM.

7.1 Authentication

OAuth tokens. Details TBC To be confirmed.

7.2 API gateway

Participants can connect Energy Rules Terms to the AEMO API Gateway The gateway on AEMO’s side providing participant communication options, accessible over the internet or MarketNet. It uses resources and methods to push messages to Participants’ API Gateways . through MarketNet AEMO's private VPN for Registered Participants. A network of more than 300 registered participants in the National Electricity Market, including market generators, transmission network service providers, distribution network service providers, and market customers..

All communications between AEMO Australian Energy Market Operator’s API gateway and participants’ gateways use HTTPS Hypertext Transfer Protocol Secure, adds the security capabilities of SSL to standard HTTP communications.. AEMO APIs do not support HTTP.

7.3 Compression

For details, see the IDX Technical Delivery Specification The B2B Procedures: Technical Delivery Specification. Defines the technical requirements for communicating B2B messages between participants using the MSATS B2B Handler or contingency systems..

7.4 Submission size

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

7.5 Throttling

The following throttling limits are applied by AEMO per Participant ID Registered participant identifier; A company can have more than one Participant ID. each day:

• High (file size 1 Mb) 180,000 messages.

• Medium (file size 5 Mb) 35,000 messages.

• Low (file size 10 Mb) 18,000 messages.

Participant systems must manage throttling limits. AEMO can also reject multiple API requests for the same participantId at the same time.

7.6 Validation

TBC

7.7 Submission processing

TBC

7.8 Base urls

Environment	Base URLs
MarketNet pre-production	TBC
MarketNet production	https://nem-apis-wgw.aemo.com.au

7.9 Endpoints

Endpoint	Method	Description	Success response
/pqd/v1/bpqd	POST	Submit BPQD. Payload contains data at the 5-minute trading resolution. For payload details, see PQD payload format and structure	200 (accepted)
/pqd/v1//bpqd	GET	A list of metadata for BPQD messages in the queue	200 (OK)
/pqd/v1//bpqd/{messageContextId}	GET	Retrieve a BPQD payload	200 (OK)
/pqd/v1//bpqd/{messageContextId}	DELETE	Delete a BPQD payload	200 (deleted)

7.10 PQD payload format

The PQD payload format is JSON JavaScript Object Notification. For schema details, see PQD schema.

A BPQD payload contains data at the 5-minute trading resolution.

7.11 Payload limit

The payload limit is 10 MB uncompressed.

7.12 HTTP response codes

The table below lists HTTP response codes when submitting PQD.

Scenario	Status code	Message
Success	201 Created	Success
Message Context ID Validation Failure	400 Bad Request	The message context ID in the header does not match the values in the payload. Please ensure both values are aligned and retry the request.
Schema Version Validation Error	400 Bad Request	The provided schema version is not a supported schema version for that business function.
Receiving Participant ID is invalid	400 Bad Request	The Receiving Participant ID does not exist or is not registered.
Schema payload validation errors	422 Unprocessable Entity	The payload is not in a valid schema format for the business function.
AEMO backend error	500 Internal Server Error	An unexpected error occurred while processing your request. Please try again later.
Message queue outbound error	503 Service Unavailable	The receiving participant’s server cannot handle the request due to flow control restrictions or scheduled maintenance.