Overview
The Hybird API gives your own systems direct access to your Hybird data. Use it to feed measurements into a CTS or BMS, an energy management or ESG reporting platform, a data warehouse or BI tool, or an application you've built yourself.
Hybird panels already send their measurements to Hybird, so you don't need extra hardware to use the API: no gateway, no Modbus converter, no extra boxes or components in the panel. Your system reads the data straight from the Hybird API over a secure internet connection (HTTPS).
This article explains how it works, what you can read, how to get an API user, and where to find the API documentation.
How it works
The panel sends data. The Hybird Edge Controller in the panel sends breaker measurements to Hybird over its own internet connection. This already happens on every operating panel.
Hybird stores the data. Measurements are processed and stored per account, site, panel and breaker.
Your system reads the data. Your application, platform or integration middleware sends HTTPS requests to the Hybird API with a token for your API user and gets JSON back.
Because the integration runs server to server, the electrician doesn't need to install anything extra, and your developers or integrators don't need physical access to the panel.
Common uses
CTS and BMS: show consumption and circuit status for each board alongside the rest of the building's technical systems.
Energy management and ESG reporting: bring consumption for each site and each circuit into your reporting platform.
Data warehouse and BI: store Hybird data with your other business data and build your own dashboards.
Your own applications and workflows: use Hybird data in the tools your team or your customers already use.
What you can read
The API follows the same structure as Hybird OS: account › site › panel › breaker. Your API user can read the same things you can see in Hybird OS for the accounts it has access to, including:
Sites, panels and breakers, with their names and how they relate to each other
Latest measurements for each breaker, such as current, voltage, leakage and breaker state
Energy consumption over time, for each breaker and for groups of breakers
Alarms and events
The API documentation lists every endpoint and field. See step 4 below.
Step 1 · Email us the accounts you want access to
API users are set up by the Hybird team. Write to [email protected] and include:
Your company and, if relevant, the project or building.
The Hybird accounts you want access to. List every account or site your integration needs to read. If you're not sure of the account names, give us the site addresses and we'll match them.
Who the API user is for: the name and email address of the person or team responsible for the integration. We recommend a shared team mailbox rather than a personal one, so access doesn't depend on one person.
What you'll use it for, for example a CTS reading consumption for each board, or a nightly import into your data warehouse. This helps us advise on the best approach.
If you are a contractor, integrator or partner working for the owner of a Hybird account, we may confirm access with the account owner before creating the user.
Step 2 · We create your API user
We create an API user and give it access to the accounts you listed. The API user is a normal Hybird user, which means it can:
Sign in to Hybird OS in a browser, so you can see the same sites, panels and breakers your integration will read.
Use the API for the same accounts. It can reach exactly what it can see in Hybird OS and nothing more.
We'll email you when the user is ready, along with the web address for your account.
Step 3 · Sign in to Hybird OS
Go to your account's web address, for example https://youraccount.hybird.energy, enter the email address of the API user and click Sign in.
Step 4 · Open the API docs
While you're signed in, open the API documentation for your account by adding /api/v1/docs to your account's web address:
This page lists every available endpoint, its parameters and example responses. The page only opens when you're signed in. If you see an Unauthorized message, sign in first (step 3) and reload the page.
Step 5 · Create a token and connect your system
In Hybird OS, go to Team, click your API user, then Tokens, and create an API token. A read-only token is enough for most integrations.
Store the token like a password and share it only with the people or systems that need it. Anyone with the token can read what the API user can read.
Configure your system to call the endpoints it needs, with the token on each request, as shown in the API docs.
Daily file exports
If your system prefers files to live requests, for example a data warehouse or archive, we can make daily exports available through the same API. Exports run once a day at 02:00 UTC and contain one compressed CSV file per dataset for the previous day, for example breaker measurements and meter measurements. Your system can list the available files at /api/v1/exports.json and download each one from the link it gives. Ask us in your email in step 1 if you want this set up.
Good practice
Use the documented API only. Build against the endpoints listed at /api/v1/docs. Don't copy IDs out of Hybird OS page addresses, and don't use undocumented or internal endpoints, because they can change without notice.
Find resources through the API. Start from your sites and follow them down to panels and breakers, rather than hard-coding IDs.
Poll at a sensible interval. Fetch the latest measurements as often as your system actually needs, and use consumption history or daily exports for historical data rather than polling it again and again.
Keep tokens safe. Use one token for each system so you can remove one without affecting the others, and remove tokens you no longer use. Removing the API user's access in Hybird OS also removes its API access.
Frequently asked questions
Do we need to add a gateway, Modbus module or other components to the installation?
No. The Hybird panel already sends its data to Hybird, and your system reads it from the Hybird API over the internet. All you need is a system that can make HTTPS requests and read JSON. Most modern CTS, BMS and data platforms can do this directly or through their integration layer.
Can we switch breakers through the API?
Not through the integration API today. The API is for reading data. Switching breakers stays in Hybird OS and the Hybird app, where every switch is confirmed by a person. If your project needs your system to control switching, tell us in your email and we'll discuss it with you.
Can we go through the integration with our electrician, integrator or CTS contractor?
Yes. Write to [email protected] and we'll set up a meeting with everyone involved.
Can we get API access for more accounts later?
Yes. Email us with the additional accounts or sites and we'll add them to your existing API user.
Can we connect an AI assistant instead?
Yes, using the same user and permissions. See Connecting your own AI assistant to Hybird over MCP.
Need help?
Ask Maggie in the support chat at the bottom-right of help.hybird.energy, or write to [email protected].
Related articles
Summary
Any system that can make HTTPS requests, whether a CTS or BMS, a reporting platform, a data warehouse or your own application, can read Hybird data straight from the Hybird API, with no extra hardware in the installation.
Email [email protected] with the accounts you want access to. We'll create an API user that can sign in to Hybird OS and use the API.
Open https://youraccount.hybird.energy/api/v1/docs while signed in to see every endpoint, create a read-only token, and connect your system.