API service for Australian electricity market data.

A RESTful microservice for accessing, processing, and visualising Australian electricity grid data.

Overview

This service provides real-time and historical electricity market data through a standardised API. It is designed to support analytics, visualisation tools, and integration with downstream services such as prediction models.

Features

• Live electricity grid data endpoints
• Historical time-series data access
• Secure API key authentication
• Dockerised deployment for portability
• Health monitoring endpoint

Getting Started

Run With Docker

Build the image:

docker build -t electricitygrid-api.

Run the container:

docker run --rm -p 3000:3000 \
  -e PORT=3000\
  -e API_KEY=your-api-key \
  -e OPENELECTRICITY_API_KEY=your-openelectricity-key \
  -e S3_BUCKET-your-s3-bucket\
  -e AWS_REGION-ap-southeast-2 \

Check the service:

curl http://localhost:3000/v1/health

For protected endpoints, send the API key as a bearer token (use local-dev-token):

curl http://localhost:3000/v1/live \
  -H "Authorization: Bearer your-api-key"

GitHub Container Image

The GitHub Actions workflow in .github/workflows/docker-image-yml:

• builds the Docker image for pull requests
• builds and pushes the image to GitHub Container Registry

Published images will use:

ghcr.io/<owner>/<repo>