Getting Started with the Modo Energy API
Modo Energy's API is designed for battery operators, owners, and utilities looking to build state-of-the-art energy data systems.
All the data on the Modo Energy platform is available on our API.
This reference is designed to make it easy for you to access and understand the data that is available.
Advantages of the Modo Energy API:
- a single API that brings together all the energy data you need - across free, paid and Modo proprietary data
- modern documentation and API interface
- reliable and high-throughput
- leverage our live chat support throughout your API journey
π How to Start
Click on 'API Reference' in the top navigation. The left-hand navigation of the API Reference provides comprehensive information about each endpoint in the API.
Get your API Token on the platform (here), find your favourite endpoint on the reference page, authenticate yourself with your token, and start making calls!
For more information on how to get started, take a look at Making your first API call
π¦ Interactive API Docs
Our API documentation is interactive and let's you play around with endpoints and data before you start building. After you pick which endpoint you want to call, fill in any required parameters and your x-token and click 'Try It!'.
Now you can preview the data that would be returned, and we even provide you with the code for the call in your preferred programming language. Copy, paste and you are off to the races!
Conventions
The API is intended to be simple and easy to use. There are few rules we follow.
The base URL to send all API requests is 'api.modoenergy.com'. HTTPS is required for all API requests.
Modo Energy's API follows RESTful conventions when possible, with all operations performed via GET requests on page and database resources. Request and response bodies are encoded as JSON.
The full URL for data points follows this template:
api.modoenergy.com/pub/v1/ locale
/ source
/datapoint
locale
- gb for Great Britain
source
- where the original data comes from, examples are: national-grid
, n2ex
, modo
datapoint
- the exact data we are looking for. Go to the API reference section to search for a specific endpoint
Everything is always lowercase, and we use.-
whenever you feel there should be a space
π¬ We're here to help!
We would love to support you with your project. If you get stuck use the Intercom widget on the bottom right of any page or shoot us an email
Can't wait to hear from you!
Updated about 1 year ago