Space Weather API

Introduction

Purpose

The Space Weather API provides access to near real-time data from the Australian Space Weather Forecasting Centre section of the Australian Bureau of Meteorology.

API specification

Data can be obtained using an HTTP POST request to the appropriate URL. An API key and any relevant options must be included in the request body. The request body and the response are in JSON. The character encoding is UTF-8.

For API details, please refer to the API specification.

Data description

The API currently provides data as described below.

• the most recent A index for the Australian region, or historical values
• the most recent K index for the Australian region or for one of several observing sites, or historical values
• the most recent Dst index for the Australian region, or historical values.
• details of any magnetic alert current for the Australian region
• details of any geophysical warning currently active for the Australian region
• details of any aurora notice (alert, watch, outlook) current for the Australian region

We plan to make more data available in the future. Data is available at no charge, though this remains subject to change.

Registration

To use the Space Weather API, you first need to register. This will provide you with an API key that must be included in all your API request messages.

Demonstration

The demo page demonstrates the Space Weather API, providing live examples of requests and responses.

Examples

The examples page provides examples of code that uses the API, in several programming languages.

Feedback

We are keen to hear what you think. Please send your questions, comments and other feedback to sws-data-api@bom.gov.au.