AEMO Report API

openapi: 3.2.0
info:
  title: Report API
  description: "\n## Introduction\nThe report API allows participants to retrieve data from the Gas Bulletin Board (BB). \n\n\nFor details on how to get access and business rules for this API:\n\n<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/report-v1/operations?api-version=2022-04-01-preview
servers:
- url: https://api-prd.aemo.local/ws/gbb/report
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: Report
  description: Report
paths:
  /linepackCapacityAdequacy:
    get:
      operationId: adhocReportForLinepackCapacityAdequacy
      summary: Adhoc report for Linepack Capacity Adequacy
      tags:
      - Report
      description: Provides a report for the Linepack Capacity Adequacy for each Pipeline for the current and next 2 gas days (D to D+2). The report can be filtered to reduce data output.
      parameters:
      - name: FacilityIds
        in: query
        required: false
        schema:
          type: integer
        description: A unique AEMO defined Facility identifier
      - name: GasDate
        in: query
        required: false
        schema:
          type: string
        description: Date of gas day. Timestamps are ignored. The gas day as defined in the pipeline contract or market rules.
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful reponse with Linepack Capacity Adequacy report
          content:
            application/json:
              example:
                transactionId: d715de25-813f-4fb8-9b4a-944f41c05ba5
                data:
                  LinepackCapacityAdequacyList:
                  - GasDate: '2018-11-30T14:00:00Z'
                    FacilityId: 530038
                    FacilityName: APLNG Pipeline
                    Flag: GREEN
                    Description: All OK
                    LastUpdated: '2018-11-30T23:50:45Z'
                  - GasDate: '2018-12-01T14:00:00Z'
                    FacilityId: 530038
                    FacilityName: APLNG Pipeline
                    Flag: GREEN
                    Description: All OK
                    LastUpdated: '2018-11-30T23:50:45Z'
                  - GasDate: '2018-11-30T14:00:00Z'
                    FacilityId: 530038
                    FacilityName: APLNG Pipeline
                    Flag: GREEN
                    Description: All OK
                    LastUpdated: '2018-11-30T23:50:45Z'
                errors: []
                warnings: []
        '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 missing from URL or 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.
          content:
            application/json:
              example:
                data: {}
                errors:
                - code: 73
                  title: InvalidBuySell
                  detail: BuySell value 24.1 is not valid
                  source: ''
        '429':
          description: This response is provided when the throttling limits are reached.
        '500':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
        '503':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
  /connectionPointNameplateRating:
    get:
      operationId: adhocReportForNameplateRatingForEachConnectionPointIdInBB
      summary: Adhoc report for nameplate rating for each connection point id in BB
      tags:
      - Report
      description: This report displays the nameplate rating for each connection point id connected to a BB pipeline or transitional compression facility. This report will be a combination of all submissions for Gate Station Nameplate Rating and Connection Point Nameplate Rating
      parameters:
      - name: EffectiveDate
        in: query
        required: false
        schema:
          type: string
        description: Gas day date that corresponding record takes effect. Any time component supplied will be ignored.
      - name: FacilityIds
        in: query
        required: false
        schema:
          type: integer
        description: A unique AEMO defined Facility identifier
      - name: ConnectionPointIds
        in: query
        required: false
        schema:
          type: integer
        description: A unique AEMO defined connection point identifier.
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful reponse with nameplate rating report
          content:
            application/json:
              example:
                transactionId: 3d73082e-5aee-42af-a5f5-811a22e9ce3g
                data:
                  GateStationNameplateRatingList:
                  - ConnectionPointName: Bomaderry
                    ConnectionPointID: 1202002
                    FacilityName: Eastern Gas Pipeline
                    FacilityType: PIPE
                    FacilityId: 520047
                    OwnerId: 13
                    OwnerName: Jemena EGP
                    OperatorId: 13
                    OperatorName: Jemena Eastern Gas Pipeline (1) Pty Ltd
                    CapacityQuantity: 220.561
                    EffectiveDate: '2018-03-23T14:00:00Z'
                    Description: M001
                    LastUpdated: '2018-12-03T12:45:21Z'
                  - ConnectionPointName: Bombala
                    ConnectionPointID: 1202002
                    FacilityName: Eastern Gas Pipeline
                    FacilityType: PIPE
                    FacilityId: 520047
                    OwnerId: 13
                    OwnerName: Jemena EGP
                    OperatorId: 13
                    OperatorName: Jemena Eastern Gas Pipeline (1) Pty Ltd
                    CapacityQuantity: 220.561
                    EffectiveDate: '2018-02-22T14:00:00Z'
                    Description: M001
                    LastUpdated: ''
                errors: []
                warnings: []
        '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 missing from URL or 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.
          content:
            application/json:
              example:
                data: {}
                errors:
                - code: 73
                  title: InvalidBuySell
                  detail: BuySell value 24.1 is not valid
                  source: ''
        '429':
          description: This response is provided when the throttling limits are reached.
        '500':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
        '503':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
  /gateStationNameplateRating:
    get:
      operationId: adhocReportForNameplateRatingOwnerAndOperatorForEachGateStationConnectedToABBPipeline
      summary: Adhoc report for nameplate rating, owner, and operator for each gate station connected to a BB pipeline.
      tags:
      - Report
      description: This report displays the displays the nameplate rating, owner, and operator for each gate station connected to a BB pipeline.
      parameters:
      - name: ConnectionPointIds
        in: query
        required: false
        schema:
          type: integer
        description: A unique AEMO defined connection point identifier.
      - name: EffectiveDate
        in: query
        required: false
        schema:
          type: string
        description: Gas day date that corresponding record takes effect. Any time component supplied will be ignored.
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful reponse with Gate station report
          content:
            application/json:
              example:
                transactionId: b56ad8c9-b236-4718-b06e-7daa2364c29d
                data:
                  GateStationNameplateRatingList:
                  - ConnectionPointName: ”Bomaderry”
                    ConnectionPointID: 1202002
                    FacilityName: Eastern Gas Pipeline
                    FacilityId: 520047
                    OwnerId: 94
                    OwnerName: Jemena EGP
                    OperatorName: Jemena Eastern Gas Pipeline (1) Pty Ltd
                    CapacityQuantity: 220.561
                    EffectiveDate: '2018-03-23T14:00:00Z'
                    Description: M125
                    LastUpdated: '2018-12-03T12:45:21Z'
                  - ConnectionPointName: Bombala
                    ConnectionPointID: 1202002
                    FacilityName: Eastern Gas Pipeline
                    FacilityId: 520047
                    OwnerId: 94
                    OwnerName: Jemena EGP
                    OperatorName: Jemena Eastern Gas Pipeline (1) Pty Ltd
                    CapacityQuantity: 220.561
                    EffectiveDate: '2018-02-22T14:00:00Z'
                    Description: Nameplate
                    LastUpdated: '2018-12-03T12:45:21Z'
                errors: []
                warnings: []
        '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 missing from URL or 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.
          content:
            application/json:
              example:
                data: {}
                errors:
                - code: 73
                  title: InvalidBuySell
                  detail: BuySell value 24.1 is not valid
                  source: ''
        '429':
          description: This response is provided when the throttling limits are reached.
        '500':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
        '503':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
  /registeredContact:
    get:
      operationId: adhocReportForRegisteredContactDetailsForEachParticipant
      summary: Adhoc report for registered contact details for each participant
      tags:
      - Report
      description: Provides a report of registered contact details for each participant.
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful reponse with registered contact report
          content:
            application/json:
              example:
                transactionId: 259b39be-9510-474c-98cc-b659b76e8391
                data:
                  RegisteredContactsList:
                  - PersonId: 200734
                    PersonName: John Smith
                    CompanyId: 139
                    CompanyName: Australian Energy Market Operator
                    Position: Manager Mkt Ops
                    Email: john.smith@gasco.com.au
                    LastUpdated: '2018-08-13T14:00:00Z'
                errors: []
                warnings: []
  /nameplateRating:
    get:
      operationId: adhocReportForStandingNameplateCapacity
      summary: Adhoc report for standing nameplate capacity
      tags:
      - Report
      description: This report displays the standing nameplate capacity of all BB facilities and transitional compression facility. Nameplate rating relates to maximum daily quantities in TJ under normal operating conditions.
      parameters:
      - name: EffectiveDate
        in: query
        required: false
        schema:
          type: string
        description: Gas day date that corresponding record takes effect. Any time component supplied will be ignored.
      - name: CapacityTypes
        in: query
        required: false
        schema:
          type: string
          enum:
          - STORAGE
          - MDQ
        description: "Capacity type values can be -\n\nSTORAGE — Holding capacity in storage; \n\nMDQ — Daily maximum firm capacity under the expected operating conditions."
      - name: FacilityIds
        in: query
        required: false
        schema:
          type: integer
        description: A unique AEMO defined Facility identifier
      - name: FacilityTypes
        in: query
        required: false
        schema:
          type: string
        description: Facility type associated with the Facility Id.
      - name: FlowDirections
        in: query
        required: false
        schema:
          type: string
          enum:
          - RECEIPT
          - DELIVERY
          - 'null'
        description: "Gas flow direction. Values can be either- \nRECEIPT — A flow of gas into the BB facility\n\nDELIVERY — A flow of gas out of the BB facility.\n\nNONE – will be displayed for all other BB facilities and transitional compression facilities."
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful reponse with standing nameplate capacity report
          content:
            application/json:
              example:
                transactionId: ff6f1b62-7932-4df7-b527-e306115e407g
                data:
                  NameplateRatingList:
                  - FacilityId: 530043
                    FacilityName: APLNG Pipeline
                    FacilityType: PIPE
                    CapacityType: MDQ
                    CapacityQuantity: '1560.321'
                    FlowDirection: NONE
                    CapacityDescription: ' This transmission capacity is the amount of gas that the Culcairn delivery point is able to withdraw from this pipeline facility'
                    ReceiptLocation: 1808012
                    DeliveryLocation: 1300405
                    EffectiveDate: '2018-09-03T14:00:00Z'
                    Description: increase in nameplate pipeline capacity due to completion of VNIE Phase B
                    LastUpdated: '2020-06-01T01:18:21Z'
                errors: []
                warnings: []
        '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 missing from URL or 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.
          content:
            application/json:
              example:
                data: {}
                errors:
                - code: 73
                  title: InvalidBuySell
                  detail: BuySell value 24.1 is not valid
                  source: ''
        '429':
          description: This response is provided when the throttling limits are reached.
        '500':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
        '503':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
  /states:
    get:
      operationId: adhocReportOnStates
      summary: Adhoc report on states
      tags:
      - Report
      description: This report displays states
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful reponse with states report
          content:
            application/json:
              example:
                transactionId: 272b86e5-6e99-4df4-8bff-a4c04f0e126d
                data:
                  StateList:
                  - StateId: 3
                    StateShortName: VIC
                    StateName: Victoria
                errors: []
                warnings: []
        '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 missing from URL or 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.
          content:
            application/json:
              example:
                data: {}
                errors:
                - code: 73
                  title: InvalidBuySell
                  detail: BuySell value 24.1 is not valid
                  source: ''
        '429':
          description: This response is provided when the throttling limits are reached.
        '500':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
        '503':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
  /stateNominationsAndForecasts:
    get:
      operationId: adhocReportOnTheDailyNominationsAndForecasts
      summary: Adhoc report on the daily nominations and forecasts
      tags:
      - Report
      description: This report displays the daily nominations and forecasts
      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: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful reponse with daily production and flow report
          content:
            application/json:
              example:
                transactionId: 1978aaf0-0f5c-48ea-b863-39021e586327
                data:
                  StateNominationsAndForecastsList:
                  - GasDate: '2017-12-02T14:00:00Z'
                    StateId: 3
                    StateName: Victoria
                    StateShortName: VIC
                    Demand: 5
                    Supply: 10
                    LastUpdated: '2018-07-29T14:17:21Z'
                  - GasDate: '2020-05-06T00:00:00Z'
                    StateId: 2
                    StateName: New South Wales and ACT
                    StateShortName: NSW
                    Demand: 105.029
                    Supply: 0
                    LastUpdated: '2020-05-07T12:09:38Z'
                errors: []
                warnings: []
        '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 missing from URL or 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.
          content:
            application/json:
              example:
                data: {}
                errors:
                - code: 73
                  title: InvalidBuySell
                  detail: BuySell value 24.1 is not valid
                  source: ''
        '429':
          description: This response is provided when the throttling limits are reached.
        '500':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
        '503':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
  /stateDailyProductionAndFlow:
    get:
      operationId: adhocReportOnTheDailyProductionAndFlow
      summary: Adhoc report on the daily production and flow
      tags:
      - Report
      description: This report displays the daily production and flow
      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: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful reponse with daily production and flow report
          content:
            application/json:
              example:
                transactionId: c5b5b78d-75ed-4f7e-8a03-0c0777e286dd
                data:
                  StateDailyProductionAndFlowList:
                  - GasDate: '2017-12-02T14:00:00Z'
                    StateId: 3
                    StateName: Victoria
                    StateShortName: VIC
                    Demand: 5
                    Supply: 10
                    LastUpdated: '2018-07-29T14:17:21Z'
                  - GasDate: '2020-05-06T00:00:00Z'
                    StateId: 2
                    StateName: New South Wales and ACT
                    StateShortName: NSW
                    Demand: 105.029
                    Supply: 0
                    LastUpdated: '2020-05-07T12:09:38Z'
                errors: []
                warnings: []
        '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 missing from URL or 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.
          content:
            application/json:
              example:
                data: {}
                errors:
                - code: 73
                  title: InvalidBuySell
                  detail: BuySell value 24.1 is not valid
                  source: ''
        '429':
          description: This response is provided when the throttling limits are reached.
        '500':
          description: e-Hub is operational but downstream systems are not available.
          content:
            application/json:
              example:
                Exception: Application Unavailable
        '503':
          description: e-Hub is operational but downstream systems are no

# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aemo/refs/heads/main/openapi/aemo-report-api-openapi.yml