AEMO Capacity
AEMO Capacity from AEMO — 13 path(s) described in OpenAPI.
OpenAPI Specification
openapi: 3.0.1
info:
title: Capacity
description: '
## Introduction
The Capacity API is used by facility operators and trading participants to submit and receive data
relating to capacity trades and day ahead auction for AEMO’s Capacity Transfer Platform (CTP) and
Day-Ahead Auction (DAA) market systems.
For details on how to get access and business rules for this API:
<a href="/api-docs"><img src="./files/ViewAPIDocsButton.png" alt="View API Docs" /></a>'
version: '3.0'
x-origin:
- format: openapi
source: AEMO API Management developer portal
url: https://dev.aemo.com.au/developer/apis/capacity-v1/operations?api-version=2022-04-01-preview
servers:
- url: https://api-prd.aemo.local/ws/gsh/capacity
paths:
/reportTransportationServicePointRegister:
get:
operationId: getAListOfAllTheServicePointsZonesAndPipelineSegments
summary: Get a list of all the service points, zones and pipeline segments
tags:
- Capacity
description: The report contains list of all the service points (receipt and delivery points), zones
and pipeline segments currently registered under Part 24 of the Rules, for the capacity transfer
and day ahead auction.
parameters:
- name: ComponentType
in: query
required: false
schema:
type: string
enum:
- ZONE
- SEGMENT
- SERVICE_POINT
- NOTIONAL_POINT
- PARK_SERVICE
description: Type of component
- name: X-initiatingParticipantID
in: header
required: true
schema:
type: string
description: The ID of the Initiating Participant
- name: X-market
in: header
required: false
schema:
type: string
description: The market type that the request applies.
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: Successful reponse with the Transportation facilities report
content:
application/json:
example:
transactionId: 27d225a6-6c9a-4081-81dc-eb643fdd2a6e
data:
Zones:
- ZoneId: 20001
ZoneName: Zone 1
ZoneType: Pipeline Receipt
ZoneDescription: Some sort of description
ForAuctionPublication: 'Yes'
EffectiveDate: '2018-02-28T02:00:00Z'
VersionDatetime: '2018-02-01T02:23:45Z'
LastChanged: '2018-05-01T02:23:45Z'
- ZoneId: 20002
ZoneName: Zone 2
ZoneType: Pipeline Delivery
ZoneDescription: Some sort of description
ForAuctionPublication: 'Yes'
EffectiveDate: '2018-02-28T02:00:00Z'
VersionDatetime: '2018-02-01T02:23:45Z'
LastChanged: '2018-05-01T02:23:45Z'
Segments:
- FacilityId: 100001
FacilityName: Moomba to Adelaide Pipeline System
SegmentId: 30001
SegmentName: Segment 1
SegmentType: Forward Haul
FromId: 20001
FromName: Zone 1
ToId: 30001
ToName: Zone 2
ForAuctionPublication: 'Yes'
EffectiveDate: '2018-02-28T02:00:00Z'
VersionDatetime: '2018-02-01T02:23:45Z'
LastChanged: '2018-05-01T02:23:45Z'
- FacilityId: 100001
FacilityName: Moomba to Adelaide Pipeline System
SegmentId: 30001
SegmentName: Segment 1
SegmentType: Forward Haul
FromId: 20002
FromName: Zone 22
ToId: 30002
ToName: Zone 33
ForAuctionPublication: 'Yes'
EffectiveDate: '2018-02-28T02:00:00Z'
VersionDatetime: '2018-02-01T02:23:45Z'
LastChanged: '2018-05-01T02:23:45Z'
ServicePoints:
- FacilityId: 100001
FacilityName: Moomba to Adelaide Pipeline System
ServicePointId: 50001
ServicePointName: SP 1
ServicePointType: Forward Haul Receipt Point
ServicePointDescription: Some description
NotionalPoint: 'Yes'
ZoneId: 20002
ZoneName: Zone 2
GBBConnectionPointId: 150001
GBBConnectionPointName: Moomba Gas Plant
ForAuctionPublication: 'Yes'
EffectiveDate: '2018-02-28T02:00:00Z'
VersionDatetime: '2018-02-01T02:23:45Z'
LastChanged: '2018-05-01T02:23:45Z'
- FacilityId: 100001
FacilityName: Moomba to Adelaide Pipeline System
ServicePointId: 50001
ServicePointName: SP 1
ServicePointType: Forward Haul Receipt Point
ServicePointDescription: Some description
NotionalPoint: 'Yes'
ZoneId: 20002
ZoneName: Zone 2
GBBConnectionPointId: 150001
GBBConnectionPointName: Moomba Gas Plant
ForAuctionPublication: 'Yes'
EffectiveDate: '2018-02-28T02:00:00Z'
VersionDatetime: '2018-02-01T02:23:45Z'
LastChanged: '2018-05-01T02:23:45Z'
NotionalPoints:
- ServicePointId: 500001
ServicePointName: SP 1
PhysicalPointName: SP 2
GBBConnectionPointId: '150001'
EffectiveDate: '2018-02-28T02:00:00Z'
VersionDatetime: '2018-02-01T02:23:45Z'
LastChanged: '2018-05-01T02:23:45Z'
- ServicePointId: 500001
ServicePointName: SP 1
PhysicalPointName: SP 3
GBBConnectionPointId: '150002'
EffectiveDate: '2018-02-28T02:00:00Z'
VersionDatetime: '2018-02-01T02:23:45Z'
LastChanged: '2018-05-01T02:23:45Z'
ParkServices:
- ParkProductName: Park Service 1
ParkServicePointId: 500001
ParkServicePointName: SP 1
EffectiveDate: '2018-02-28T02:00:00Z'
VersionDatetime: '2018-02-01T02:23:45Z'
LastChanged: '2018-05-01T02:23:45Z'
- ParkProductName: Park Service 23
ParkServicePointId: 500022
ParkServicePointName: SP 22
EffectiveDate: '2018-02-28T02:00:00Z'
VersionDatetime: '2018-02-01T02:23:45Z'
LastChanged: '2018-05-01T02:23:45Z'
errors: []
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password
is incorrect/not provided OR user account is locked out.
content:
application/json:
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have
permission to submit this request.
'404':
description: This response is provided when the resource is missing from the URL or the URL
is incorrect.
content:
application/json:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource
Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: This response is provided when any there are any Business validation failures,
then entire submission is rejected.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
example:
Exception: Application Unavailable
'503':
description: Exceeds throttling limits OR SSL Certificate authentication validation failed
content:
application/json:
example:
Exception: 'Service invocation for API was rejected based on policy violation OR Error
message: javax.net.ssl.SSLHandshakeException: Received fatal alert: bad_certificate'
/reportRegisteredParticipants:
get:
operationId: getAllParticipantsCurrentlyRegisteredInTheGSHCTPAndDAAMarkets
summary: Get all participants currently registered in the GSH, CTP and DAA markets.
tags:
- Capacity
description: The report contains the registration details of all participants currently registered
in the GSH, CTP and DAA markets.
parameters:
- name: Markets
in: query
required: true
schema:
type: string
- name: X-initiatingParticipantID
in: header
required: true
schema:
type: string
description: The ID of the Initiating Participant
- name: X-market
in: header
required: false
schema:
type: string
description: The market type that the request applies.
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: Successful reponse with registered participants report
content:
application/json:
example:
transactionId: 27d225a6-6c9a-4081-81dc-eb643fdd2a3d
data:
Participants:
- Market: Gas Supply Hub
ParticipantId: '74'
ParticipantCode: ES584
OrganisationName: AGL
OrganisationCode: AG256
TradingName: AGL Hydro Partnership
HeadOfficeAddressLine1: 50 Collins St
HeadOfficeAddressLine2: Melbourne
HeadOfficeAddressLine3: VIC
HeadOfficeAddressLine4: '3001'
PhoneNumber: 03 9658 7000
FaxNumber: 03 9658 7589
ABN: '456874258'
ARBN: '125874569'
ACN: '569845214'
Classifications: Facility Operator
AgentId: 123
AgentName: Star Energy Pty Ltd
LastChanged: '2018-05-01T02:23:45Z'
- Market: Gas Supply Hub
ParticipantId: '56'
ParticipantCode: ORRE
OrganisationName: Origin Energy Retail Ltd
OrganisationCode: ORIGINRETAIL
TradingName: Origin Energy Retail Ltd
HeadOfficeAddressLine1: Level 45
HeadOfficeAddressLine2: 264-278 George Street
HeadOfficeAddressLine3: Sydney
HeadOfficeAddressLine4: NSW 2000
PhoneNumber: 0295035209
FaxNumber: 0292524066
ABN: '22078868425'
ARBN: ''
ACN: '78868425'
Classifications: Trader
AgentId: 123
AgentName: Star Energy Pty Ltd
LastChanged: '2018-05-01T02:23:45Z'
errors: []
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password
is incorrect/not provided OR user account is locked out.
content:
application/json:
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have
permission to submit this request.
'404':
description: This response is provided when the resource is missing from the URL or the URL
is incorrect.
content:
application/json:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource
Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: This response is provided when any there are any Business validation failures,
then entire submission is rejected.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
example:
Exception: Application Unavailable
'503':
description: Exceeds throttling limits OR SSL Certificate authentication validation failed
content:
application/json:
example:
Exception: 'Service invocation for API was rejected based on policy violation OR Error
message: javax.net.ssl.SSLHandshakeException: Received fatal alert: bad_certificate'
/contractDetails:
post:
operationId: provideAListOfValidShipperContractsForAFacility
summary: Provide a list of valid shipper contracts for a facility.
tags:
- Capacity
description: 'Each submission must contain the full set of shipper contracts that are valid beyond
the submission date in accordance with the Procedures.
On submission of this data, the system replaces all contract details previously submitted by the
facility operator with the contents of the new submission.
This information is used by shippers to select an appropriate contract for a capacity product
prior to trading.
STTM contract references must be firm i.e. must be a Priority 1 registered facility service.'
parameters:
- name: X-initiatingParticipantID
in: header
required: true
schema:
type: string
description: The ID of the Initiating Participant
- name: X-market
in: header
required: false
schema:
type: string
description: The market type that the request applies.
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
ItemList:
FacilityId: 530001
ParticipantId: '13'
ServiceReference: SR00000001
ServiceReferenceDescription: ID for service in easterly direction
STTMContractReference: RS0000011
ContractType: TRADE
StartDate: '2018-05-01T12:00:00Z'
EndDate: '2018-05-01T12:00:00Z'
responses:
'200':
description: Successful
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password
is incorrect/not provided OR user account is locked out.
content:
application/json:
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have
permission to submit this request.
'404':
description: This response is provided when the resource is missing from the URL or the URL
is incorrect.
content:
application/json:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource
Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: This response is provided when any there are any Business validation failures,
then entire submission is rejected.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
example:
Exception: Application Unavailable
'503':
description: Exceeds throttling limits OR SSL Certificate authentication validation failed
content:
application/json:
example:
Exception: 'Service invocation for API was rejected based on policy violation OR Error
message: javax.net.ssl.SSLHandshakeException: Received fatal alert: bad_certificate'
/capacityTransferStatus:
post:
operationId: provideAStatusOfCapacityTransferForEachCapacityTransferNotice
summary: Provide a status of capacity transfer for each capacity transfer notice.
tags:
- Capacity
description: 'Provide a status of capacity transfer for each capacity transfer notice.
Partial submissions are accepted. This allows facility operators to submit interim PENDING statuses
for transfers that have failed.
Facility operators are responsible for pro-rating capacity quantities where applicable i.e. if
there is a shipper capacity shortfall.
Facility operators may continue to submit this transaction beyond the cut-off time for the purposes
of updating the invalid quantity and reason.
Changes to day ahead capacity transfer transaction status and confirmed capacity quantity will
be ignored after the day ahead transfer cut-off time.
Changes to D-2 and ‘bundled products’ forward traded capacity transfer transaction status and
confirmed capacity quantity will be ignored after the forward traded capacity transfer cut-off
time.
Changes to D-3 (and beyond) forward traded capacity transaction status and confirmed capacity
quantity will be accepted for up to 24 hours after the forward traded capacity transfer cut-off
time.'
parameters:
- name: X-initiatingParticipantID
in: header
required: true
schema:
type: string
description: The ID of the Initiating Participant
- name: X-market
in: header
required: false
schema:
type: string
description: The market type that the request applies.
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
ItemList:
CapacityTransferId: 10001
TransactionStatus: TRANSFERRED
ConfirmedCapacityQuantity: 96
Reason: PIPELINE_CONSTRAINED
InvalidQuantity: 30
responses:
'200':
description: Successful
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password
is incorrect/not provided OR user account is locked out.
content:
application/json:
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have
permission to submit this request.
'404':
description: This response is provided when the resource is missing from the URL or the URL
is incorrect.
content:
application/json:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource
Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: This response is provided when any there are any Business validation failures,
then entire submission is rejected.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
example:
Exception: Application Unavailable
'503':
description: Exceeds throttling limits OR SSL Certificate authentication validation failed
content:
application/json:
example:
Exception: 'Service invocation for API was rejected based on policy violation OR Error
message: javax.net.ssl.SSLHandshakeException: Received fatal alert: bad_certificate'
/auctionServiceCurtailmentNotice:
post:
operationId: provideAEMOWithNoticeOfAnAuctionServiceCurtailmentOnAnAuctionFacilityDuringAGasDay
summary: Provide AEMO with notice of an auction service curtailment on an auction facility during
a gas day.
tags:
- Capacity
description: Provide AEMO with notice of an auction service curtailment on an auction facility during
a gas day.
parameters:
- name: X-initiatingParticipantID
in: header
required: true
schema:
type: string
description: The ID of the Initiating Participant
- name: X-market
in: header
required: false
schema:
type: string
description: The market type that the request applies.
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
ItemList:
FacilityId: 530001
AuctionService: FORWARD_HAUL
Curtailed: 'true'
Material: 'true'
Description: Why the curtailment has occurred
EffectiveDateTime: '2018-05-01T12:00:00Z'
GasDate: '2018-05-01T12:00:00Z'
responses:
'200':
description: Successful
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password
is incorrect/not provided OR user account is locked out.
content:
application/json:
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have
permission to submit this request.
'404':
description: This response is provided when the resource is missing from the URL or the URL
is incorrect.
content:
application/json:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource
Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: This response is provided when any there are any Business validation failures,
then entire submission is rejected.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
example:
Exception: Application Unavailable
'503':
description: Exceeds throttling limits OR SSL Certificate authentication validation failed
content:
application/json:
example:
Exception: 'Service invocation for API was rejected based on policy violation OR Error
message: javax.net.ssl.SSLHandshakeException: Received fatal alert: bad_certificate'
/zoneCurtailmentInformation:
post:
operationId: provideAEMOWithNoticeOfCurtailedShipperNominationsAgainstSecondaryFirmRights
summary: Provide AEMO with notice of curtailed shipper nominations against secondary firm rights.
tags:
- Capacity
description: Provide AEMO with notice of curtailed shipper nominations against secondary firm rights.
parameters:
- name: X-initiatingParticipantID
in: header
required: true
schema:
type: string
description: The ID of the Initiating Participant
- name: X-market
in: header
required: false
schema:
type: string
description: The market type that the request applies.
- name: Authorization
in: header
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
ItemList:
FacilityId: 530001
ServicePointId: 3001
GasDate: '2018-05-01T12:00:00Z'
CurtailedQuantity: 455
responses:
'200':
description: Successful
'400':
description: The service cannot be found for the endpoint reference (EPR) <URI>
content:
application/json:
example:
Fault: <SystemMessageExceptionDump>
'401':
description: This response is provided when "Authorisation" is missing from the header OR user/password
is incorrect/not provided OR user account is locked out.
content:
application/json:
example:
Exception: Unauthorized:Invalid UserName or Password
'403':
description: This response is provided when there is an invalid Role i.e. user does not have
permission to submit this request.
'404':
description: This response is provided when the resource is missing from the URL or the URL
is incorrect.
content:
application/json:
example:
Exception: 'Resources for the endpoint URI not found. Endpoint URI: <Resource>'
'405':
description: Invalid Method used (e.g. GET used instead of POST)
content:
application/json:
example:
Exception: 'Input request HTTP method is <Invalid Method passed> but operation <Resource
Name> accepts only: [<Valid Method>]'
'411':
description: This response is provided when "Content-Length" is missing from the Header
'422':
description: This response is provided when any there are any Business validation failures,
then entire submission is rejected.
'500':
description: e-Hub is operational but downstream systems are not available.
content:
application/json:
example:
Exception: Application Unavailable
'503':
description: Exceeds throttling limits OR SSL Certificate authentication validation failed
content:
application/json:
example:
Exception: 'Service invocation for API was rejected based on policy violation OR Error
message: javax.net.ssl.SSLHandshakeException: Received fatal alert: bad_certificate'
/reportShipperCapacityTransferNotification:
get:
operationId: provideConfirmationToFacilityOperatorThatShipperIsNotifiedOfACapacityTransferOutcome
summary: Provide confirmation to facility operator that shipper is notified of a capacity transfer
outcome.
tags:
- Capacity
description: 'Provide confirmation to facility operator that shipper is notified of a capacity transfer
outcome.
Failed capacity transfer can be due to-
- Facility operator system failure preventing the capacity transfer in their system.
- Facility operator system rejects the capacity transfer due to an issue with the contract specified.
- AEMO system failure preventing the capacity transfer in the STTM or DWGM system.
- AEMO STTM or DWGM system rejects the capacity transfer due to an issue with the STTM registered
facility service (CRN) or DWGM accreditation reference specified.
Park product transfers are identified by empty zone details and identical receipt and delivery
points.'
parameters:
- name: FromGasDate
in: query
required: false
schema:
type: string
description: One calendar month from request date
- name: ToGasDate
in: query
required: false
schema:
type: string
description: Request date
- name: ChangedAfter
in: query
required: false
schema:
type: string
description: Changed After Date
- name: X-initiatingParticipantID
in: header
required: true
schema:
type: string
description: The ID of the Initiating Participant
- name: X-market
in: header
required: false
schema:
type: string
description: The market type that the request applies.
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: Successful reponse Shipper Capacity Transfer report
content:
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aemo/refs/heads/main/openapi/aemo-capacity-v1-openapi.yml