FAQs

Getting Started

Can I explore the APIs if I don’t have a developer account?

Yes. You can view our documentation and browse our APIs without an account.

How do I access the APIs?

You will need to be formally onboarded to each API by following the instructions outlined in it’s API Guide .

When will I know my onboarding has been completed?

You will get an email from the AEMO Support team. If you require an Subscription Key you will be mapped to a product and the key will be shared to you through email.

User and Accounts

Do I need to register?

If the API you need to access requires a Subscription key, you will need to register for the API.

When can I register a developer account?

You can register a developer account at any time but you will only receive an API Key once your Team has gone through formal onboarding.

Do internal AEMO employees need to register for a developer account?

Yes. If you wish to access the internal APIs you will need to raise a service now request.

API and API Keys

Do I need an API Key to use AEMO’s APIs?

You only need a Subscription key to access some of AEMO's APIs. APIs that require a key have this information included in its individual API Guide .

I have already been onboarded to use an API? Why can I not use all the APIs?

APIs sit under different services at AEMO. You will need to be formally onboarded to each API by following the instructions outlined in it’s API Guide .

I want to create a new API Key. How do I do this?

If you already have a Subscription Key for a specific product but wish to request another, you will need to raise a support hub ticket.

If you do not already have a Subscription Key you will need to be formally onboarded to the API or product by following the instructions outlined in its API Guide .

URM

How do I encrypt my username and password into base64 encoded?

You can use a tool such as Postman to encrypt your URM username and password.

In Postman, under the Authorization tab, select ‘Basic Auth’ and enter your username and password. Your password has now been encoded and will be sent as the Authorization header.

I’m getting a 422 error, what does this mean?

Your user does not have the correct permissions to execute the request. Get your Participant Admin to update your URM account in MSATS to the correct permissions.

Postman

How do I setup Postman?

See our Postman guide

I'm getting a 500 error, what is wrong?

Ensure that you are trying to connect to the correct URL and endpoint.

Support

I have an unknown error. Where can I get help?

Contact the support hub with details on the error.

Who can help with an account error?

Contact the support hub with details on the error.