Documents Ekmmetering EKM Metering API

Name: EKM Metering API
Brand: EKM Metering API
Availability: InStock

✓ Official Vendor SpecIOTSensor Databasic6 EndpointsREST

For Agents

Read real-time EKM smart meter data, fetch account details, and create or update Push3 gateway triggers using HTTP Basic authentication with an API key.

Install Jentic One Beta

Connect the EKM Metering API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the EKM Metering API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with EKM Metering API.

Read the latest meter values via GET /readmeter (Realtime API)

Fetch account and device information through GET /account

List configured Push3 gateway triggers with GET /triggers

GET STARTED

Start building with EKM Metering API

Explore with Jentic

View OpenAPI Document

The EKM Push API exposes real-time and historical readings from EKM Omnimeter smart meters and ioStack gateway devices. The REST interface returns JSON and authenticates with HTTP Basic where the API key is supplied as the username. This curated specification covers the realtime read endpoint, account information, and full CRUD for Push3 gateway triggers, giving agents the operations needed to monitor consumption and react to threshold-driven events. It is intended for energy monitoring, sub-metering, and building-management workflows.

Use Cases

Patterns agents use EKM Metering API for, with concrete tasks.

★ Real-Time Energy Monitoring

Pull the latest meter readings from EKM Omnimeter and ioStack devices via GET /readmeter and feed them into dashboards or alerting pipelines. The realtime endpoint exposes up to the most recent 1,000 readings per meter, suitable for short-window monitoring and operational visibility. A live monitor can be assembled in a few hours of integration work.

GET /readmeter with a meter serial filter, parse the JSON response, and emit the latest kWh reading to a monitoring dashboard.

Threshold-Based Triggers

Configure Push3 gateway triggers via POST /triggers, then list, update, or delete them through the /triggers collection. Triggers let the gateway fire actions when meter values cross thresholds, supporting demand-response and anomaly-detection workflows without a polling layer in client code.

POST /triggers with a kW threshold and a webhook URL, then GET /triggers to confirm the trigger appears in the list.

Account and Device Inventory

Use GET /account to enumerate the meters, gateways, and account settings tied to the API key. This provides a starting inventory for orchestration jobs that target specific devices and confirms the credential has access to the expected hardware before issuing reads or trigger updates.

GET /account, parse the device list, and pick the first meter serial number to use as the target for subsequent /readmeter calls.

AI Agent Energy Workflows via Jentic

An AI agent uses Jentic to search for energy-monitoring intents, load the matching EKM operation, and execute reads or trigger updates while Jentic isolates the API key. This supports agents that watch consumption and act when thresholds are crossed without ever holding the raw credential.

Search Jentic for 'read smart meter data', execute GET /readmeter for a target meter, and create a trigger via POST /triggers if the reading exceeds a configured threshold.

Key Endpoints

6 endpoints — the ekm push api exposes real-time and historical readings from ekm omnimeter smart meters and iostack gateway devices.

METHOD

PATH

DESCRIPTION

GET

/readmeter

Read meter data (Realtime API)

GET

/account

Get account information

GET

/triggers

List triggers

POST

/triggers

Create trigger

PUT

/triggers/{id}

Update trigger

DELETE

/triggers/{id}

Delete trigger

GET

/readmeter

Read meter data (Realtime API)

GET

/account

Get account information

GET

/triggers

List triggers

POST

/triggers

Create trigger

PUT

/triggers/{id}

Update trigger

DELETE

/triggers/{id}

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The EKM Push API key is stored encrypted in the Jentic vault and applied as HTTP Basic at execution time. Agents only see a scoped reference, so /readmeter and /triggers calls never expose the raw key.

Intent-based discovery

Agents search Jentic with intents like 'read smart meter data' or 'create an energy trigger' and receive the matching EKM operation with its parameter schema, ready to execute without consulting the spec by hand.

Time to first call

Direct integration: 1-2 days to wire auth, polling, and trigger CRUD. Through Jentic: under an hour from search to first realtime reading.

FAQs

Specific to using EKM Metering API through Jentic.

What authentication does the EKM Metering API use?

It uses HTTP Basic authentication. You supply your EKM Push API key as the username with no password. Through Jentic, the key is stored encrypted in the vault and the Basic header is constructed at execution time so the secret never enters the agent's context.

Can I read live meter data with the EKM Metering API?

Yes. GET /readmeter on https://api.ekmpush.com returns the latest readings (up to the most recent 1,000 per meter) in JSON, with filters for meter serial and time window.

What are the rate limits for the EKM Metering API?

The OpenAPI spec does not declare explicit rate limits. EKM recommends polling the realtime endpoint no more often than meter sample frequency (typically 1-15 seconds depending on hardware) and applying retries with backoff on transient errors.

How do I create a gateway trigger through the EKM Metering API via Jentic?

Run pip install jentic and search for 'create an iot trigger'. Jentic returns POST /triggers with its schema; execute it with the threshold and action payload, and Jentic injects the EKM Basic auth credential from the vault.

Can I update an existing trigger?

Yes. PUT /triggers/{id} updates the trigger with the given ID, and DELETE /triggers/{id} removes it. List the current triggers with GET /triggers first to confirm the ID you want to modify.

Does the EKM Metering API include account information?

Yes. GET /account returns the account context and the devices associated with the key, useful for confirming permission scope and enumerating meter serials before reading data.

Documents Ekmmetering EKM Metering API

Connect the EKM Metering API to your agent

Capabilities

Start building with EKM Metering API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs