Getting Started

About the API

The Submission API allows participants to submit data to the Gas Bulletin Board (GBB).

Data submission from BB reporting entities to the GBB are divided into two key areas:

1. Data transfer formats which includes the form, validation rules, and timing of submissions.

2. Data submission methods to the BB, and how the success and failure of those submissions is communicated back to the submitter.

For details on how to get access and business rules for this API, see the BB Submission Guide.

API status

Final, participants can use this specification to build their APIs.

Assumed knowledge

• API and JSON or YAML basics

• API Reference online help

• Connecting to AEMO's Electricity IT systems

Getting Access

Registration is required to be a participant in the GBB. See GBB facility registration.

Prerequisites

Before using the Submission API, you must:

• Have a Participant ID. If your company is a Registered Participant, it is set up during the registration process.Have a Participant ID with an effective date of registration.

• Have a user ID and password with access rights provided by your company's participant administrator. For details, see user rights access below.

• Understand the applicable rules and procedures. See Related rules and procedures.

• Have an API gateway and a TLS Certificate.

• Test your submission in the pre-production environment before submitting to production. AEMO encourages participants to use the pre-production environment to test procedures and train staff.

Related rules and procedures

• NGR Part 18: Natural Gas Services Bulletin Board - AEMC Energy Rules

• NGR Part 27: East coast gas system reliability and supply adequacy

• AEMO | Procedures and guides

API Details

Authentication

• API connections use mTLS certificates to secure the transport layer with encrypted communication and secure interactions between participants’ and AEMO’s systems.

• TLS Certificates are self-managed by participants.

• All communications between AEMO’s API gateway and participants’ gateways use HTTPS. AEMO APIs do not support HTTP.

Authorisation

All API requests are authorised by Basic HTTP authentication (Basic Auth) using a Base64-encoded username and password. The credentials are assigned by your company’s participant administrator.

When making an API request, include the Base64-encoded string in a HTTPS Authorization header.

User rights access

Participant administrators provide access to the Submission API using the GBB - Gas Bulletin Board entity.

For details about user rights access, creating new Participant Users and assigning rights, see the User RIghts Management help.

Compression

You can submit your API compressed or uncompressed. Compression protocols are gzip or deflate.

Throttling

To control traffic, AEMO implements throttling on API endpoint requests. When requests exceed the throttling limit, a HTTP 429 or 422 response is returned.

Endpoints

Below are the base URLs used for this API:

Parameters

Paths, Headers, Request Body and Responses can be found in the API Reference (OpenAPI Spec).