API Documentation

Getting started with our API

We have several resources to make using our API easy, even for non-coders!

The API is an HTTP RESTful collection of endpoints you can hit with a browser or application, returning JSON payloads.

We send live price and market data via private and public WebSocket connections.

1. We have detailed Public API Documentation on Postman! Postman is a common tool for building, testing and writing documentation for APIs.

2. We have an official Free Excel Add-in available in the Microsoft Store that adds live TOD Markets price data to your existing spreadsheets: Excel Add-In

3. We have an open-source API and WebSocket example project for JavaScript and Python here: https://github.com/Temple-Electricity/TOD-Markets-API-Examples

API Documentation

View the detailed Public API Documentation on Postman

WebSocket Live price connection

Our web-based trading platform connects to your company’s private websocket connection to the server, which sends your unique price and order information to you. Your integration projects can also access the same WebSocket connection to receive live price and order updates as they happen without resorting to polling the HTTP endpoints.

The initial ‘Handshake’ to connect to the private WebSocket channel takes a few steps, so we have provided a working example in both Python and JavaScript in this open-source project on GitHub, here:

https://github.com/Temple-Electricity/TOD-Markets-API-Examples

Getting your API key

Visit your user profile using the top right user menu.

Open

Then scroll to the bottom of the profile page to generate a new API Key:

1. Enter a token name to identify it, eg ‘Trading system - read only’

2. Select the permission you want the new key to have

3. Select the expiry date of your new token, which defaults to 12 months. (The system will send you daily reminder emails 14 days before it expires).

Open

Be sure to copy this API key and don’t share it!

API key permissions

Before May 2026, API keys would have the same system permissions as the user who generated them. If those permissions were modified, the API key would also inherit the user’s modified permissions.

After May 2026, a user can give their new API keys limited permissions. However, the permission of any API key will still be limited by the originating user’s system permissions.

‘Read only’ means the user can access the platform and view the market price data; this is the minimum level of access to the platform and data.

‘Trade’ means that the user can create and modify orders on the platform or via our voice brokers.