Operational Forecasting
Endpoint details
This is a collection of APIs required for operational forecasting to send and receive operation forecasting data to external service providers.
API status
Available in preproduction.
Audience
The primary audience is Forecasting-as-a-Service (FAAS) e.g. Overspeed.
The secondary audience is AEMO's internal application support team.
Related resources
For additional information, see:
OpenAPI specification
You can download the OpenAPI Specification for the following environments:
Pre-production: OpenAPI specification (TBC)
Production: OpenAPI specification (TBC)
Prerequisites
Before using the Post Operational Product API, see API Requirements in Markets Portal Help. You must also:
Get access
Register with AEMO to use APIs
Request an AEMO SSL certificate to call the APIs
Request for Client Id and Secret associated with API
Call relevant operation with Client Id and Secret to generate the access token
Use the access token and the SSL certificate to access Operational Forecasting Installation APIs
Payload format
This API supports a JSON format payload.
API gateway
Participants can connect to the AEMO API Gateway through the internet. See URL format in the API Reference.
All communications between AEMO’s API gateway and participants’ gateways use HTTPS. AEMO APIs do not support HTTP.
Authentication Methods
This API is using the following Security Policies:
Authorization
The API are configured in APIM which will be using AD authentication based on JWT token, however the API when called from APIM application will implement Authentication/Authorization based on AEMO proprietary identity service. The end point will be configured with APIM.
Assumption:
Data is validated prior to being posted to ODS and NEM. Most of the validation should take place at schema level
During the onboarding process, AEMO will provide authorization to API endpoints and require data entities
Rate limit
To control traffic, AEMO implements a rate limit of 250 requests per minute.
If requests exceed the rate limit, the payload is rejected.
Response codes
See Response codes in the API Reference.
Submission rules
The submission rules for the Operational Forecasting Product API are:
Payload format - JSON
Schema validation - JSON schema
HTTP Methods - GET and POST
Authentication Mechanisms - as per AEMO standard
Request parameters - specific to each API
Performance - specific to each API
Submission size
A submission request or response has a payload limit of 10 MB (uncompressed).
Submission processing
AEMO saves the provided operational forecasting product to their operational data platforms and is acknowledged by AEMO’s systems.
Submission response
Follows standard response codes and throws exception on validation fails.
Validation
The JSON schema will be validated.