NAV
Command Line Ruby Python PHP Perl Java C NodeJS Javascript

Introduction

Welcome to the EKM METERING API!

We at EKM see easy access to your data, and the scalable systems behind the EKM Push, as crucial to moving our products into the future. To that end, we do what is unheard of in our industry, we give you your data for FREE.

The EKM API is organized around Representational State Transfer, or REST. You can use our Application Programming Interface, or API, to access EKM API endpoints, which can get you information on various EKM Push meter data and utilize it in your own application, database, billing system, or building automation system.

We have language bindings in Shell (cURL), Ruby, Python, PHP, Java, Javascript, Nodejs and C! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients, and we support cross-origin resource sharing to allow you to interact securely with our API from a client-side web application (though you should remember that you should never expose your secret EKM Push API key in any public website’s client-side code). JSON will be returned in all responses from the API, including errors (though if you’re using API bindings, we will convert the response to the appropriate language-specific object).

Authentication

To authorize, make sure to use your personal EKM Push account key.

The examples in this API documentation use the demo key of MTAxMDoyMDIw. Please make sure you remove this key and place your personal key in the https address if you are trying to access the meters in your account.

With shell, you can just pass the correct address with each request
curl -s "URL Here"
Authorization: "EKM Push Key"
# Load required modules
require 'net/http'
require 'json'

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
def callApi(apiRequest)
    json = Net::HTTP.get('io.ekmpush.com',apiRequest)
    return JSON.parse(json)
end

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://io.ekmpush.com
apiObject = callApi('URI Here')

# This just displays the object but you can use what ever
# code you would like to work with the object here
require 'pp'
pp apiObject
# Required Python Modules
import urllib.request, urllib.error, urllib.parse
import json

# This function accesses the apiRequest URL and converts
# the contents to a usable Python object and returns it
def callApi ( apiRequest ):
        response = urllib.request.urlopen(apiRequest)
        response = response.read()
        jsonObject = json.loads(response.decode())
        return jsonObject

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
apiObject = callApi("URL Here")

# This just displays the object but you can use what ever
# code you would like to work with the object here
import pprint
pprint.pprint(apiObject)
<?php
// Call the callApi function to create a usable
// object named $apiObject from the API request URL.
// Put the API request URL in the call
$apiObject=callApi('URL Here');

// This just displays the object but you can use what ever
// code you would like to work with the object here
var_dump($apiObject);

// This function accesses the apiRequest URL and converts
// the contents to a usable PHP object and returns it
function callApi ($apiRequest='') {

        $json=@file_get_contents($apiRequest);
        $jsonObject=json_decode($json);
        return ($jsonObject);

}
?>
/*
 Download the correct org.json jar version for your
 needs from: https://mvnrepository.com/artifact/org.json/json

 This example uses version 20190722 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20190722/json-20190722.jar

 Instructions to run this program

 1. Put this code in a file named EKM.java
 2. Copy the downloaded org.json jar and EKM.java to the same directory
 3. Compile
  javac -cp .:./json-20190722.jar ./EKM.java
 4. Run
  java -cp .:./json-20190722.jar EKM
*/


//Import required classes
import java.net.*;
import java.io.*;
import org.json.*;

public class EKM {
    public static JSONObject callApi(String apiRequest) throws Exception {

        // This code accesses the apiRequest URL and converts
        // the contents to a usable JSON object

        URL url = new URL(apiRequest);
        URLConnection connection = url.openConnection();
        BufferedReader in = new BufferedReader(
                                               new InputStreamReader(
                                                                     connection.getInputStream()));

        StringBuilder response = new StringBuilder();
        String inputLine;

        while ((inputLine = in.readLine()) != null)
            response.append(inputLine);

        in.close();

        JSONObject jsonObject = new JSONObject(response.toString());
        return jsonObject;
    }

    public static void main(String[] args) throws Exception {
        /*
         Call callApi to create a usable
         object named apiObject from the API request URL.
         Put the API request URL in the call
         */
        JSONObject apiObject = EKM.callApi("URL Here");

        /*
         You can access any part of the apiObject using code like this:
         JSONArray  readData = apiObject.getJSONObject("readMeter").getJSONArray("ReadSet").
         getJSONObject(0).getJSONArray("ReadData");
        */

        // This just outputs the whole apiObject
        System.out.println(apiObject.toString(4));
    }
}
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">

// The example function is called from the 
// body tag when the page loads
function example(){

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('URL Here',function(apiObject){

       // This just displays the object in the result div
       // you can use what ever code you would like to work 
       // with the object here
       document.getElementById("result").innerHTML = "<pre>"+JSON.stringify(apiObject, null, 4)+"</pre>";
       });

};

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback) {
    var xhttp = new XMLHttpRequest();
    xhttp.onreadystatechange = function() {
      if (xhttp.readyState == 4 && xhttp.status == 200) {
        var jsonObject = JSON.parse(xhttp.responseText);
        callback(jsonObject);
      }
    };
    xhttp.open("GET", apiRequest, true);
    xhttp.send();
}
</script>

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
// NodeJS requires the "request" module to access the API
// Install by running "npm install request" from the shell prompt

// Load "request" module
var request = require("request");

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('URL Here', function (apiObject) {


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        console.log(JSON.stringify(apiObject, null, 4));
});

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback){

        var options = { method: 'GET'
                        , uri: apiRequest
                        , timeout: 1000*15
                        , strictSSL: false
                        , rejectUnhauthorized : false
                      };

        request(options, function (error, response, body) {
                if(error){
                        console.log(error);
                        throw error;
                }else{
                     var jsonObject = JSON.parse(body);
                     callback(jsonObject);
                }
        });
}
/*
 *  Install json-c if its not installed
 *  https://github.com/json-c/json-c/wiki
 *
 *  Below is command to install json-c on centos
 *  yum install json-c-devel
 *
 *  Saved this example code to a file named ekm.c
 *  - Compile
 *  gcc ekm.c -o ekm -lcurl  -ljson-c
 *  - Run
 *  ./ekm
 *
 */
// Required Includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h> //your directory may vary depending on your OS
#include <json/json.h> //your directory may vary
// End Includes

// Code reqired for curl
struct string {
    char *data;
    size_t len;
};

void init_string(struct string *response) {
    response->len = 0;
    response->data = (char*)malloc(response->len+1);
    if (response->data == NULL) {
        fprintf(stderr, "malloc() failed\n");
        exit(EXIT_FAILURE);
    }
    response->data[0] = '\0';
}

size_t curlData(void *data, size_t size, size_t nmemb, struct string *response)
{
    size_t new_len = response->len + size*nmemb;
    response->data = (char*)realloc(response->data, new_len+1);
    if (response->data == NULL) {
        fprintf(stderr, "realloc() failed\n");
        exit(EXIT_FAILURE);
    }
    memcpy(response->data+response->len, data, size*nmemb);
    response->data[new_len] = '\0';
    response->len = new_len;

    return size*nmemb;
}
// End required Curl coding

// This function accesses the api URL and converts
// the contents to a usable JSON-C object and returns it
struct json_object* callAPI(const char * url){
    CURL *curl;
    CURLcode res;
    json_object * jsonObject;
    curl = curl_easy_init();
    if(curl) {
        struct string response;
        init_string(&response);

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlData);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        res = curl_easy_perform(curl);
        if(CURLE_OK == res){
            jsonObject = json_tokener_parse(response.data);
        }
        free(response.data);
    }

    curl_easy_cleanup(curl);
    curl_global_cleanup();
    return jsonObject;
}

int main(void)
{

    // Call the callApi function to create a usable
    // object named apiObject from the API request URL.
    // Put the API request URL in the call
    json_object * apiObject = callAPI("URL Here");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here
    json_object * readmeter_json;
    json_object_object_get_ex(apiObject,"readMeter",&readmeter_json);
    printf("Complete readMeter Object: \n%s", json_object_to_json_string_ext(readmeter_json,JSON_C_TO_STRING_PRETTY));

    // This example digs deaper into the JSON and displays the first
    // kwh_tot value for the first read of the first meter
    json_object * readset_json;
    json_object * readset_0_json;
    json_object * readdata_json;
    json_object * readdata_0_json;
    json_object * kwh_tot;
    json_object_object_get_ex(readmeter_json,"ReadSet",&readset_json);
    readset_0_json = json_object_array_get_idx(readset_json,0);
    json_object_object_get_ex(readset_0_json,"ReadData",&readdata_json);
    readdata_0_json = json_object_array_get_idx(readdata_json,0);
    json_object_object_get_ex(readdata_0_json,"kWh_Tot",&kwh_tot);
    printf("\nkWh_Tot: %s", json_object_to_json_string_ext(kwh_tot,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

Make sure to replace the sample key: MTAxMDoyMDIw, with your API key in the https address.

EKM uses API keys to allow access to the API. You authenticate to the EKM API by providing one of your unique API keys in each request. Each Push account holder is provided with an EKM Push User Key, which provides access to all meters in their account. This key carries lots of privileges so we encourage you to keep it secret. In addition to this master key, additional keys are also provided to give access to each meter individually, and keys can be created to provide access to sub groups of meters upon request. These secondary keys can be used to share single meters, or a subset of meters, without sharing access to all meters in an account. For example, if you are a landlord with multiple rentals and meters, you could share specific meter keys with each of your tenants, so that they could have access to only the data that pertains to their usage.

Authentication to the API occurs via HTTP Basic Auth. Provide your API key as the basic authorized username. You do not need to provide a password. You must authenticate for all requests.

The EKM Push API expects the API key to be included in all requests to the server. The key is included in the URL in the following way:

Authorization: key=MTAxMDoyMDIw

Legacy Realtime API

If you are developing your own app, cloud-to-cloud solution, billing system, or other SAS solution, our Real-Time API allows you to easily access your EKM Push data in any format that you need. Below you will find descriptions regarding how to access the data, and about the filters you can apply so the data comes to you in a format that is easily digested and inserted into your software solution.

The real-time API provides the 1000 latest meter reads for each of your meters. If your meter is being read once per minute, the data will be made available once per minute, per meter. Whether you have 1 meter or 10,000 meters, this is the easiest and most scalable way to access your data.

The EKM Dash, EKM Widget, encompass.io, wattvision.com, pvoutput.org, the other solutions in our Push App Store, as well as other customers that have their own custom solutions, all use this API to access their data. We use the same API as you and do not give ourselves any special permissions, we see what you see, which forces us to make the API as great as possible for everyone. We have even given you code examples that can be copy and pasted into your own software language to make the data access that much easier.

Use the API definition, metered values definition, code snippet suggestion, and guide to get you on your way to developing your next killer app. If you create something great, let us know; we’re open to adding all useful apps into the Push App Store.

We also have a Realtime API Request Builder Tool found here: https://apibuilder.ekmmetering.com

Legacy HTTPS Request

HTTPS Request

curl -s
"https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1"
# Load required modules
require 'net/http'
require 'json'
require 'uri'

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
def callApi(api_path)
  uri = URI.parse("https://io.ekmpush.com#{api_path}")
  response = Net::HTTP.get_response(uri)
  puts response.uri
  JSON.parse(response.body)
end

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://io.ekmpush.com
apiObject = callApi('/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1')

# This just displays the object but you can use what ever
# code you would like to work with the object here
require 'pp'
pp apiObject


# This example digs deeper into the JSON and displays the first
# kwh_tot value for the first read of the first meter
readmeter_json = apiObject['readMeter']
readset_json = readmeter_json['ReadSet']
readset_0_json = readset_json[0]
readdata_json = readset_0_json['ReadData']
readdata_0_json = readdata_json[0]
kwh_tot = readdata_0_json["kWh_Tot"]
pp "kWh_Tot: #{kwh_tot}" 
# Required Python Modules
import urllib.request, urllib.error, urllib.parse
import json

# This function accesses the apiRequest URL and converts
# the contents to a usable Python object and returns it
def callApi ( apiRequest ):
        response = urllib.request.urlopen(apiRequest)
        response = response.read()
        jsonObject = json.loads(response.decode())
        return jsonObject

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1")

# This just displays the object but you can use what ever
# code you would like to work with the object here
import pprint
pprint.pprint(apiObject)

# This example digs deeper into the JSON and displays the first
# kwh_tot value for the first read of the first meter
readmeter_json = apiObject['readMeter']
readset_json = readmeter_json['ReadSet']
readset_0_json = readset_json[0]
readdata_json = readset_0_json['ReadData']
readdata_0_json = readdata_json[0]
kwh_tot = readdata_0_json["kWh_Tot"]
print("kWh_Tot: ", kwh_tot)
<?php
// Call the callApi function to create a usable
// object named $apiObject from the API request URL.
// Put the API request URL in the call
$apiObject=callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1');

// This just displays the object but you can use what ever
// code you would like to work with the object here
var_dump($apiObject);


// This example digs deeper into the JSON and displays the first
// kwh_tot value for the first read of the first meter
$readmeter_json = $apiObject->readMeter;
$readset_json = $readmeter_json->ReadSet;
$readset_0_json = $readset_json[0];
$readdata_json = $readset_0_json->ReadData;
$readdata_0_json = $readdata_json[0];
$kwh_tot = $readdata_0_json->kWh_Tot;
echo "kWh_Tot: $kwh_tot";


// This function accesses the apiRequest URL and converts
// the contents to a usable PHP object and returns it
function callApi ($apiRequest='') {

        $json=@file_get_contents($apiRequest);
        $jsonObject=json_decode($json);
        return ($jsonObject);

}

?>
# Install JSON module
# for example on centos 6.5
# yum install cpan
# cpan JSON


# Required Perl Modules
use LWP::Simple;
use JSON;
use Data::Dumper;

# This function accesses the apiRequest URL and converts
# the contents to a usable Perl object and returns it
sub callApi{
        my $apiRequest = shift;
        my $json_text = get($apiRequest);
        my $jsonObject = JSON->new->utf8->decode($json_text);
        return $jsonObject;
}

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
my $apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1");

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($apiObject);

# This example digs deeper into the JSON and displays the first
# kwh_tot value for the first read of the first meter
my $readmeter_json = $apiObject->{readMeter};
my $readset_json = $readmeter_json->{ReadSet};
my $readset_0_json = $readset_json->[0];
my $readdata_json = $readset_0_json->{ReadData};
my $readdata_0_json = $readdata_json->[0];
my $kwh_tot = $readdata_0_json->{kWh_Tot};
print "kWh_Tot: $kwh_tot";
/*
 Download the correct org.json jar version for your
 needs from: https://mvnrepository.com/artifact/org.json/json

 This example uses version 20131018 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20190722/json-20190722.jar

 Instructions to run this program

 1. Put this code in a file named EKM.java
 2. Copy the downloaded org.json jar and EKM.java to the same directory
 3. Compile
  javac -cp .:./json-20190722.jar ./EKM.java
 4. Run
  java -cp .:./json-20190722.jar EKM
*/


//Import required classes
import java.net.*;
import java.io.*;
import org.json.*;

public class EKM {
    public static JSONObject callApi(String apiRequest) throws Exception {

        // This code accesses the apiRequest URL and converts
        // the contents to a usable JSON object

        URL url = new URL(apiRequest);
        URLConnection connection = url.openConnection();
        BufferedReader in = new BufferedReader(
                                               new InputStreamReader(
                                                                     connection.getInputStream()));

        StringBuilder response = new StringBuilder();
        String inputLine;

        while ((inputLine = in.readLine()) != null)
            response.append(inputLine);

        in.close();

        JSONObject jsonObject = new JSONObject(response.toString());
        return jsonObject;
    }

    public static void main(String[] args) throws Exception {
        /*
         Call callApi to create a usable
         object named apiObject from the API request URL.
         Put the API request URL in the call
         */
        JSONObject apiObject = EKM.callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1");


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        System.out.println(apiObject.toString(4));


        // This example digs deaper into the JSON and displays the first
        // kwh_tot value for the first read of the first meter
        JSONObject readmeter_json = apiObject.getJSONObject("readMeter");
        JSONArray readset_json = readmeter_json.getJSONArray("ReadSet");
        JSONObject readset_0_json = readset_json.getJSONObject(0);
        JSONArray readdata_json = readset_0_json.getJSONArray("ReadData");
        JSONObject readdata_0_json = readdata_json.getJSONObject(0);
        Object kwh_tot = readdata_0_json.get("kWh_Tot");
        System.out.println("kWh_Tot: " + kwh_tot);

        }
}
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">

// The example function is called from the
// body tag when the page loads
function example(){

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1',function(apiObject){

      // This just displays the object in the result div
      // you can use what ever code you would like to work
      // with the object here
      document.getElementById("result").innerHTML = "<pre>"+JSON.stringify(apiObject, null, 4)+"</pre>";


      // This example digs deaper into the JSON and displays the first
      // kwh_tot value for the first read of the first meter
      readmeter_json = apiObject['readMeter'];
      readset_json = readmeter_json['ReadSet'];
      readset_0_json = readset_json[0];
      readdata_json = readset_0_json['ReadData'];
      readdata_0_json = readdata_json[0];
      kwh_tot = readdata_0_json["kWh_Tot"];
      document.getElementById("kwh_tot").innerHTML = "<pre>kWh_Tot: "+kwh_tot+"</pre>";

      });

};

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback) {
    var xhttp = new XMLHttpRequest();

    xhttp.onreadystatechange = function() {
      if (xhttp.readyState == 4 && xhttp.status == 200) {
        var jsonObject = JSON.parse(xhttp.responseText);
        callback(jsonObject);
      }
    };
    xhttp.open("GET", apiRequest, true);
    xhttp.send();
}
</script>

</head>
  <body onload="example()">
    <div id="result"> </div>
    <div id="kwh_tot"> </div>
  </body>
</html>
// NodeJS requires the "request" module to access the API
// Install by running "npm install request" from the shell prompt

// Load "request" module
var request = require("request");

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1', function (apiObject) {


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        console.log(JSON.stringify(apiObject, null, 4));


        // This example digs deaper into the JSON and displays the first
        // kwh_tot value for the first read of the first meter
        readmeter_json = apiObject['readMeter'];
        readset_json = readmeter_json['ReadSet'];
        readset_0_json = readset_json[0];
        readdata_json = readset_0_json['ReadData'];
        readdata_0_json = readdata_json[0];
        kwh_tot = readdata_0_json["kWh_Tot"];
        console.log("kWh_Tot: " + kwh_tot);


});

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback){

        var options = { method: 'GET'
                        , uri: apiRequest
                        , timeout: 1000*15
                        , strictSSL: false
                        , rejectUnhauthorized : false
                      };

        request(options, function (error, response, body) {
                if(error){
                        console.log(error);
                        throw error;
                }else{
                     var jsonObject = JSON.parse(body);
                     callback(jsonObject);
                }
        });
}
/*
 *  Install json-c if its not installed
 *  https://github.com/json-c/json-c/wiki
 *
 *  Below is command to install json-c on centos
 *  yum install json-c-devel
 *
 *  Saved this example code to a file named ekm.c
 *  - Compile
 *  gcc ekm.c -o ekm -lcurl  -ljson-c
 *  - Run
 *  ./ekm
 *
 */
// Required Includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h> //your directory may vary depending on your OS
#include <json/json.h> //your directory may vary
// End Includes

// Code reqired for curl
struct string {
    char *data;
    size_t len;
};

void init_string(struct string *response) {
    response->len = 0;
    response->data = (char*)malloc(response->len+1);
    if (response->data == NULL) {
        fprintf(stderr, "malloc() failed\n");
        exit(EXIT_FAILURE);
    }
    response->data[0] = '\0';
}

size_t curlData(void *data, size_t size, size_t nmemb, struct string *response)
{
    size_t new_len = response->len + size*nmemb;
    response->data = (char*)realloc(response->data, new_len+1);
    if (response->data == NULL) {
        fprintf(stderr, "realloc() failed\n");
        exit(EXIT_FAILURE);
    }
    memcpy(response->data+response->len, data, size*nmemb);
    response->data[new_len] = '\0';
    response->len = new_len;

    return size*nmemb;
}
// End required Curl coding

// This function accesses the api URL and converts
// the contents to a usable JSON-C object and returns it
struct json_object* callAPI(const char * url){
    CURL *curl;
    CURLcode res;
    json_object * jsonObject;
    curl = curl_easy_init();
    if(curl) {
        struct string response;
        init_string(&response);

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlData);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        res = curl_easy_perform(curl);
        if(CURLE_OK == res){
            jsonObject = json_tokener_parse(response.data);
        }
        free(response.data);
    }

    curl_easy_cleanup(curl);
    curl_global_cleanup();
    return jsonObject;
}

int main(void)
{

    // Call the callApi function to create a usable
    // object named apiObject from the API request URL.
    // Put the API request URL in the call
    json_object * apiObject = callAPI("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here
    json_object * readmeter_json;
    json_object_object_get_ex(apiObject,"readMeter",&readmeter_json);
    printf("Complete readMeter Object: \n%s", json_object_to_json_string_ext(readmeter_json,JSON_C_TO_STRING_PRETTY));

    // This example digs deeper into the JSON and displays the first
    // kwh_tot value for the first read of the first meter
    json_object * readset_json;
    json_object * readset_0_json;
    json_object * readdata_json;
    json_object * readdata_0_json;
    json_object * kwh_tot;
    json_object_object_get_ex(readmeter_json,"ReadSet",&readset_json);
    readset_0_json = json_object_array_get_idx(readset_json,0);
    json_object_object_get_ex(readset_0_json,"ReadData",&readdata_json);
    readdata_0_json = json_object_array_get_idx(readdata_json,0);
    json_object_object_get_ex(readdata_0_json,"kWh_Tot",&kwh_tot);
    printf("\nkWh_Tot: %s", json_object_to_json_string_ext(kwh_tot,JSON_C_TO_STRING_PRETTY));     

    return 0;
}

The above example returns the following results:

{
  "readMeter": {
    "Requested":1,
    "ReadSet":[
      {
      "Meter":"17507",
      "Group":1010,
      "Interval":1,
      "Protocol":"v3",
      "MAC_Addr":"40:16:fa:01:00:06",
      "Tz_Offset_Sec":0,
      "Bad_Reads":0,
      "Good_Reads":1,
      "Credits":1000000,
      "ReadData": [
        {
        "Good":1,
        "Date":"2015-11-04",
        "Time":"18:54:57.235",
        "Time_Stamp_UTC_ms":1446663297235,
        "Firmware":"13",
        "Model":"1710",
        "kWh_Tot":"104042.7",
        "kWh_Tariff_1":"68443.6",
        "kWh_Tariff_2":"35599.1",
        "Rev_kWh_Tot":"31567.1",
        "Rev_kWh_Tariff_1":"21351.6",
        "Rev_kWh_Tariff_2":"10215.5",
        "RMS_Volts_Ln_1":"123.7",
        "RMS_Volts_Ln_2":"123.8",
        "Amps_Ln_1":"1.2",
        "Amps_Ln_2":"3.0",
        "RMS_Watts_Ln_1":"130",
        "RMS_Watts_Ln_2":"310",
        "RMS_Watts_Tot":"440",
        "Power_Factor_Ln_1":"100",
        "Power_Factor_Ln_2":"103",
        "Power_Factor_Ln_3":"200",
        "RMS_Watts_Max_Demand":"15055",
        "Max_Demand_Period":"1",
        "CT_Ratio":"200",
        "Meter_Status_Code":"30"
        }
        ]
      }
      ]
    }
}                                                          

{"readMeter"=>
  {"Requested"=>1,
   "ReadSet"=>
    [{"Meter"=>"17507",
      "Group"=>1010,
      "Interval"=>1,
      "Protocol"=>"v3",
      "MAC_Addr"=>"40:16:fa:01:00:06",
      "Tz_Offset_Sec"=>0,
      "Bad_Reads"=>0,
      "Good_Reads"=>1,
      "Credits"=>1000000,
      "ReadData"=>
       [{"Good"=>1,
         "Date"=>"2016-10-25",
         "Time"=>"18:22:03.870",
         "Time_Stamp_UTC_ms"=>1477419723870,
         "Firmware"=>"13",
         "Model"=>"1710",
         "kWh_Tot"=>"121525.4",
         "kWh_Tariff_1"=>"80780.4",
         "kWh_Tariff_2"=>"40745.0",
         "Rev_kWh_Tot"=>"38138.2",
         "Rev_kWh_Tariff_1"=>"26107.2",
         "Rev_kWh_Tariff_2"=>"12031.0",
         "RMS_Volts_Ln_1"=>"122.9",
         "RMS_Volts_Ln_2"=>"122.9",
         "Amps_Ln_1"=>"1.4",
         "Amps_Ln_2"=>"2.6",
         "RMS_Watts_Ln_1"=>"148",
         "RMS_Watts_Ln_2"=>"258",
         "RMS_Watts_Tot"=>"406",
         "Power_Factor_Ln_1"=>"99",
         "Power_Factor_Ln_2"=>"107",
         "Power_Factor_Ln_3"=>"200",
         "RMS_Watts_Max_Demand"=>"15055",
         "Max_Demand_Period"=>"1",
         "CT_Ratio"=>"200",
         "Meter_Status_Code"=>"30"}]}]}}
"kWh_Tot: 121525.4"
{u'readMeter': {u'ReadSet': [{u'Bad_Reads': 0,
                              u'Credits': 1000000,
                              u'Good_Reads': 1,
                              u'Group': 1010,
                              u'Interval': 1,
                              u'MAC_Addr': u'40:16:fa:01:00:06',
                              u'Meter': u'17507',
                              u'Protocol': u'v3',
                              u'ReadData': [{u'Amps_Ln_1': u'1.4',
                                             u'Amps_Ln_2': u'5.2',
                                             u'CT_Ratio': u'200',
                                             u'Date': u'2016-10-25',
                                             u'Firmware': u'13',
                                             u'Good': 1,
                                             u'Max_Demand_Period': u'1',
                                             u'Meter_Status_Code': u'30',
                                             u'Model': u'1710',
                                             u'Power_Factor_Ln_1': u'99',
                                             u'Power_Factor_Ln_2': u'102',
                                             u'Power_Factor_Ln_3': u'200',
                                             u'RMS_Volts_Ln_1': u'122.8',
                                             u'RMS_Volts_Ln_2': u'122.9',
                                             u'RMS_Watts_Ln_1': u'160',
                                             u'RMS_Watts_Ln_2': u'428',
                                             u'RMS_Watts_Max_Demand': u'15055',
                                             u'RMS_Watts_Tot': u'590',
                                             u'Rev_kWh_Tariff_1': u'26107.2',
                                             u'Rev_kWh_Tariff_2': u'12031.0',
                                             u'Rev_kWh_Tot': u'38138.2',
                                             u'Time': u'18:24:57.870',
                                             u'Time_Stamp_UTC_ms': 1477419897870,
                                             u'kWh_Tariff_1': u'80780.4',
                                             u'kWh_Tariff_2': u'40745.1',
                                             u'kWh_Tot': u'121525.5'}],
                              u'Tz_Offset_Sec': 0}],
                u'Requested': 1}}
kWh_Tot:  121525.5
object(stdClass)#1 (1) {
  ["readMeter"]=>
  object(stdClass)#2 (2) {
    ["Requested"]=>
    int(1)
    ["ReadSet"]=>
    array(1) {
      [0]=>
      object(stdClass)#3 (10) {
        ["Meter"]=>
        string(5) "17507"
        ["Group"]=>
        int(1010)
        ["Interval"]=>
        int(1)
        ["Protocol"]=>
        string(2) "v3"
        ["MAC_Addr"]=>
        string(17) "40:16:fa:01:00:06"
        ["Tz_Offset_Sec"]=>
        int(0)
        ["Bad_Reads"]=>
        int(0)
        ["Good_Reads"]=>
        int(1)
        ["Credits"]=>
        int(1000000)
        ["ReadData"]=>
        array(1) {
          [0]=>
          object(stdClass)#4 (26) {
            ["Good"]=>
            int(1)
            ["Date"]=>
            string(10) "2016-10-25"
            ["Time"]=>
            string(12) "18:18:24.855"
            ["Time_Stamp_UTC_ms"]=>
            int(1477419504855)
            ["Firmware"]=>
            string(2) "13"
            ["Model"]=>
            string(4) "1710"
            ["kWh_Tot"]=>
            string(8) "121525.3"
            ["kWh_Tariff_1"]=>
            string(7) "80780.4"
            ["kWh_Tariff_2"]=>
            string(7) "40744.9"
            ["Rev_kWh_Tot"]=>
            string(7) "38138.2"
            ["Rev_kWh_Tariff_1"]=>
            string(7) "26107.2"
            ["Rev_kWh_Tariff_2"]=>
            string(7) "12031.0"
            ["RMS_Volts_Ln_1"]=>
            string(5) "122.9"
            ["RMS_Volts_Ln_2"]=>
            string(5) "122.9"
            ["Amps_Ln_1"]=>
            string(3) "1.4"
            ["Amps_Ln_2"]=>
            string(3) "3.6"
            ["RMS_Watts_Ln_1"]=>
            string(3) "148"
            ["RMS_Watts_Ln_2"]=>
            string(3) "418"
            ["RMS_Watts_Tot"]=>
            string(3) "566"
            ["Power_Factor_Ln_1"]=>
            string(2) "99"
            ["Power_Factor_Ln_2"]=>
            string(3) "100"
            ["Power_Factor_Ln_3"]=>
            string(3) "200"
            ["RMS_Watts_Max_Demand"]=>
            string(5) "15055"
            ["Max_Demand_Period"]=>
            string(1) "1"
            ["CT_Ratio"]=>
            string(3) "200"
            ["Meter_Status_Code"]=>
            string(2) "30"
          }
        }
      }
    }
  }
}
kWh_Tot: 121525.3
$VAR1 = {
          'readMeter' => {
                           'Requested' => 1,
                           'ReadSet' => [
                                          {
                                            'ReadData' => [
                                                            {
                                                              'RMS_Volts_Ln_1' => '123.0',
                                                              'Power_Factor_Ln_3' => '200',
                                                              'Time' => '18:25:42.850',
                                                              'Rev_kWh_Tot' => '38138.2',
                                                              'RMS_Watts_Tot' => '410',
                                                              'CT_Ratio' => '200',
                                                              'RMS_Volts_Ln_2' => '123.1',
                                                              'Model' => '1710',
                                                              'Time_Stamp_UTC_ms' => '1477419942850',
                                                              'kWh_Tariff_2' => '40745.1',
                                                              'Power_Factor_Ln_2' => '107',
                                                              'Firmware' => '13',
                                                              'RMS_Watts_Max_Demand' => '15055',
                                                              'Rev_kWh_Tariff_1' => '26107.2',
                                                              'Amps_Ln_2' => '2.6',
                                                              'RMS_Watts_Ln_2' => '258',
                                                              'Good' => 1,
                                                              'Amps_Ln_1' => '1.4',
                                                              'Meter_Status_Code' => '30',
                                                              'Date' => '2016-10-25',
                                                              'RMS_Watts_Ln_1' => '150',
                                                              'kWh_Tariff_1' => '80780.4',
                                                              'Rev_kWh_Tariff_2' => '12031.0',
                                                              'kWh_Tot' => '121525.5',
                                                              'Max_Demand_Period' => '1',
                                                              'Power_Factor_Ln_1' => '99'
                                                            }
                                                          ],
                                            'MAC_Addr' => '40:16:fa:01:00:06',
                                            'Interval' => 1,
                                            'Tz_Offset_Sec' => 0,
                                            'Credits' => 1000000,
                                            'Bad_Reads' => 0,
                                            'Group' => 1010,
                                            'Meter' => '17507',
                                            'Protocol' => 'v3',
                                            'Good_Reads' => 1
                                          }
                                        ]
                         }
        };
kWh_Tot: 121525.5
[{
    "Meter": 17507,
    "Count": 689,
    "End_Time_Stamp_UTC_ms": 1477419299858,
    "End_Date": "Tue Oct 25 2016 18:14:59 GMT+0000 (GMT)",
    "kWh_Tot_Diff": 0.2,
    "kWh_Tot_DeltaMin": 0,
    "kWh_Tot_DeltaMax": 0.1,
    "rejected_duplicates": 0,
    "Start_Date": "Tue Oct 25 2016 18:03:31 GMT+0000 (GMT)",
    "rejected_bad": 0,
    "kWh_Tot_Max": 121525.3,
    "Start_Time_Stamp_UTC_ms": 1477418611868,
    "kWh_Tot_Min": 121525.1,
    "Protocol": "v3"
}]
kWh_Tot_Max: 121525.3
{
    "readMeter": {
        "Requested": 1,
        "ReadSet": [
            {
                "Meter": "17507",
                "Group": 1010,
                "Interval": 1,
                "Protocol": "v3",
                "MAC_Addr": "40:16:fa:01:00:06",
                "Tz_Offset_Sec": 0,
                "Bad_Reads": 0,
                "Good_Reads": 1,
                "Credits": 1000000,
                "ReadData": [
                    {
                        "Good": 1,
                        "Date": "2015-11-22",
                        "Time": "01:52:44.853",
                        "Time_Stamp_UTC_ms": 1448157164853,
                        "Firmware": "13",
                        "Model": "1710",
                        "kWh_Tot": "105011.6",
                        "kWh_Tariff_1": "69148.0",
                        "kWh_Tariff_2": "35863.6",
                        "Rev_kWh_Tot": "31958.3",
                        "Rev_kWh_Tariff_1": "21638.9",
                        "Rev_kWh_Tariff_2": "10319.4",
                        "RMS_Volts_Ln_1": "121.1",
                        "RMS_Volts_Ln_2": "121.2",
                        "Amps_Ln_1": "1.8",
                        "Amps_Ln_2": "8.8",
                        "RMS_Watts_Ln_1": "204",
                        "RMS_Watts_Ln_2": "1046",
                        "RMS_Watts_Tot": "1250",
                        "Power_Factor_Ln_1": "100",
                        "Power_Factor_Ln_2": "99",
                        "Power_Factor_Ln_3": "200",
                        "RMS_Watts_Max_Demand": "15055",
                        "Max_Demand_Period": "1",
                        "CT_Ratio": "200",
                        "Meter_Status_Code": "30"
                    }
                ]
            }
        ]
    }
}
kWh_Tot: 105011.6
/*
{
    "readMeter": {
        "Requested": 1,
        "ReadSet": [
            {
                "Meter": "17507",
                "Group": 1010,
                "Interval": 1,
                "Protocol": "v3",
                "MAC_Addr": "40:16:fa:01:00:06",
                "Tz_Offset_Sec": 0,
                "Bad_Reads": 0,
                "Good_Reads": 1,
                "Credits": 1000000,
                "ReadData": [
                    {
                        "Good": 1,
                        "Date": "2016-10-25",
                        "Time": "18:16:48.857",
                        "Time_Stamp_UTC_ms": 1477419408857,
                        "Firmware": "13",
                        "Model": "1710",
                        "kWh_Tot": "121525.3",
                        "kWh_Tariff_1": "80780.4",
                        "kWh_Tariff_2": "40744.9",
                        "Rev_kWh_Tot": "38138.2",
                        "Rev_kWh_Tariff_1": "26107.2",
                        "Rev_kWh_Tariff_2": "12031.0",
                        "RMS_Volts_Ln_1": "123.1",
                        "RMS_Volts_Ln_2": "123.1",
                        "Amps_Ln_1": "1.4",
                        "Amps_Ln_2": "3.6",
                        "RMS_Watts_Ln_1": "152",
                        "RMS_Watts_Ln_2": "420",
                        "RMS_Watts_Tot": "572",
                        "Power_Factor_Ln_1": "100",
                        "Power_Factor_Ln_2": "100",
                        "Power_Factor_Ln_3": "200",
                        "RMS_Watts_Max_Demand": "15055",
                        "Max_Demand_Period": "1",
                        "CT_Ratio": "200",
                        "Meter_Status_Code": "30"
                    }
                ]
            }
        ]
    }
}
kWh_Tot: 121525.3
*/
Complete readMeter Object:
{
  "Requested":1,
  "ReadSet":[
    {
      "Meter":"17507",
      "Group":1010,
      "Interval":1,
      "Protocol":"v3",
      "MAC_Addr":"40:16:fa:01:00:06",
      "Tz_Offset_Sec":0,
      "Bad_Reads":0,
      "Good_Reads":1,
      "Credits":1000000,
      "ReadData":[
        {
          "Good":1,
          "Date":"2015-11-27",
          "Time":"21:37:11.850",
          "Time_Stamp_UTC_ms":1448660231850,
          "Firmware":"13",
          "Model":"1710",
          "kWh_Tot":"105300.0",
          "kWh_Tariff_1":"69346.0",
          "kWh_Tariff_2":"35954.0",
          "Rev_kWh_Tot":"32063.6",
          "Rev_kWh_Tariff_1":"21711.0",
          "Rev_kWh_Tariff_2":"10352.6",
          "RMS_Volts_Ln_1":"124.0",
          "RMS_Volts_Ln_2":"124.0",
          "Amps_Ln_1":"6.8",
          "Amps_Ln_2":"3.8",
          "RMS_Watts_Ln_1":"730",
          "RMS_Watts_Ln_2":"448",
          "RMS_Watts_Tot":"1180",
          "Power_Factor_Ln_1":"114",
          "Power_Factor_Ln_2":"100",
          "Power_Factor_Ln_3":"200",
          "RMS_Watts_Max_Demand":"15055",
          "Max_Demand_Period":"1",
          "CT_Ratio":"200",
          "Meter_Status_Code":"30"
        }
      ]
    }
  ]
}
kWh_Tot: "105300.0"

All https requests will begin with the following information in the https address:

https://io.ekmpush.com/readMeter?

The information that you provide, such as the meter version (i.e. v3), your EKM Push Key (i.e. MTAxMDoyMDIw), and all other associated information will follow the beginning https address.

Example below of what a typical realtime https address will look like:

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10

Example of the information that is in a typical https call is as follows:

https Address Description
https://io.ekmpush.com/readMeter? Beginning of the https address
meters Parameter for calling the meter
17507 Exact meter number to call
ver Parameter for stating version of meter to query
v3 Meter version number (v3,v4)
key Parameter for calling the key
MTAxMDoyMDIw EKM Push authorization key
fmt Parameter expecting the file format to return as
html Language format to return the data as (html,xml,json,csv)
cnt Parameter for expecting how many meter readings to call
1 Exact number of meter readings

Here is an example URL:

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=1

Click to try

Legacy Meter Number and Key

The EKM Push Meter Number is the number of your meter that you have in service. In the following examples of this API document, we will be using the meter number 17507 in all of our https calls. Meter 17507 is a version 3 Meter so you will also set the “ver” parameter to v3. To use your own meter number simply replace the example meter number, of 17507, with your own meter number, and replace v3 with the version of your meter (v3 or v4)

The EKM Push Key is your own Authorization Key that you received for your Push Account. In the following examples of this API document, we will be using the following key MTAxMDoyMDIw in all of our https calls. You will need to change the example key, of MTAxMDoyMDIw, with your own private key in order to access your meters that you have associated with your account.

Legacy Get a Specific Meter

This endpoint retrieves a specific meter and all the read data associated with it. In this example we will be using key MTExOjExMQ and meter number 300000369 to show a v4 meter. All other examples in this API will use the key MTAxMDoyMDIw and a v3 meter.

Get a Specific EKM Meter

curl -s
"https://io.ekmpush.com/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=json&cnt=10"
# Load required modules
require 'net/http'
require 'json'
require 'uri'

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call

def callApi(api_path)
  uri = URI.parse("https://io.ekmpush.com#{api_path}")
  response = Net::HTTP.get_response(uri)
  puts response.uri
  JSON.parse(response.body)
end

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://io.ekmpush.com
apiObject = callApi('/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=json&cnt=10')

# This just displays the object but you can use what ever
# code you would like to work with the object here
require 'pp'
pp apiObject
# Required Python Modules
import urllib.request, urllib.error, urllib.parse
import json

# This function accesses the apiRequest URL and converts
# the contents to a usable Python object and returns it
def callApi ( apiRequest ):
        response = urllib.request.urlopen(apiRequest)
        response = response.read()
        jsonObject = json.loads(response.decode())
        return jsonObject

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
apiObject = callApi("https://io.ekmpush.com/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=json&cnt=10")

# This just displays the object but you can use what ever
# code you would like to work with the object here
import pprint
pprint.pprint(apiObject)
<?php
// Call the callApi function to create a usable
// object named $apiObject from the API request URL.
// Put the API request URL in the call
$apiObject=callApi('https://io.ekmpush.com/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=json&cnt=10');

// This just displays the object but you can use what ever
// code you would like to work with the object here
var_dump($apiObject);

// This function accesses the apiRequest URL and converts
// the contents to a usable PHP object and returns it
function callApi ($apiRequest='') {

        $json=@file_get_contents($apiRequest);
        $jsonObject=json_decode($json);
        return ($jsonObject);

}
?>
# Install JSON module
# for example on centos 6.5
# yum install cpan
# cpan JSON


# Required Perl Modules
use LWP::Simple;
use JSON;
use Data::Dumper;

# This function accesses the apiRequest URL and converts
# the contents to a usable Perl object and returns it
sub callApi{
        my $apiRequest = shift;
        my $json_text = get(q[$apiRequest]);
        my $jsonObject = JSON->new->utf8->decode($json_text);
        return $jsonObject;
}

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
my $apiObject = callApi("https://io.ekmpush.com/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=json&cnt=10");

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($apiObject);
/*
 Download the correct org.json jar version for your
 needs from: https://mvnrepository.com/artifact/org.json/json

 This example uses version 20131018 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20190722/json-20190722.jar

 Instructions to run this program

 1. Put this code in a file named EKM.java
 2. Copy the downloaded org.json jar and EKM.java to the same directory
 3. Compile
  javac -cp .:./json-20190722.jar ./EKM.java
 4. Run
  java -cp .:./json-20190722.jar EKM
*/


//Import required classes
import java.net.*;
import java.io.*;
import org.json.*;

public class EKM {
    public static JSONObject callApi(String apiRequest) throws Exception {

        // This code accesses the apiRequest URL and converts
        // the contents to a usable JSON object

        URL url = new URL(apiRequest);
        URLConnection connection = url.openConnection();
        BufferedReader in = new BufferedReader(
                                               new InputStreamReader(
                                                                     connection.getInputStream()));

        StringBuilder response = new StringBuilder();
        String inputLine;

        while ((inputLine = in.readLine()) != null)
            response.append(inputLine);

        in.close();

        JSONObject jsonObject = new JSONObject(response.toString());
        return jsonObject;
    }

    public static void main(String[] args) throws Exception {
        /*
         Call callApi to create a usable
         object named apiObject from the API request URL.
         Put the API request URL in the call
         */
        JSONObject apiObject = EKM.callApi("https://io.ekmpush.com/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=json&cnt=10");

        /*
         You can access any part of the apiObject using code like this:
         JSONArray  readData = apiObject.getJSONObject("readMeter").getJSONArray("ReadSet").
         getJSONObject(0).getJSONArray("ReadData");
        */

        // This just outputs the whole apiObject
        System.out.println(apiObject.toString(4));
    }
}
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">

// The example function is called from the
// body tag when the page loads
function example(){

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=json&cnt=10',function(apiObject){

       // This just displays the object in the result div
       // you can use what ever code you would like to work
       // with the object here
       document.getElementById("result").innerHTML = "<pre>"+JSON.stringify(apiObject, null, 4)+"</pre>";
       });

};

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback) {
    var xhttp = new XMLHttpRequest();
    xhttp.onreadystatechange = function() {
      if (xhttp.readyState == 4 && xhttp.status == 200) {
        var jsonObject = JSON.parse(xhttp.responseText);
        callback(jsonObject);
      }
    };
    xhttp.open("GET", apiRequest, true);
    xhttp.send();
}
</script>

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
// NodeJS requires the "request" module to access the API
// Install by running "npm install request" from the shell prompt

// Load "request" module
var request = require("request");

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=json&cnt=10', function (apiObject) {


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        console.log(JSON.stringify(apiObject, null, 4));
});

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback){

        var options = { method: 'GET'
                        , uri: apiRequest
                        , timeout: 1000*15
                        , strictSSL: false
                        , rejectUnhauthorized : false
                      };

        request(options, function (error, response, body) {
                if(error){
                        console.log(error);
                        throw error;
                }else{
                     var jsonObject = JSON.parse(body);
                     callback(jsonObject);
                }
        });
}
/*
 *  Install json-c if its not installed
 *  https://github.com/json-c/json-c/wiki
 *
 *  Below is command to install json-c on centos
 *  yum install json-c-devel
 *
 *  Saved this example code to a file named ekm.c
 *  - Compile
 *  gcc ekm.c -o ekm -lcurl  -ljson-c
 *  - Run
 *  ./ekm
 *
 */
// Required Includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h> //your directory may vary depending on your OS
#include <json/json.h> //your directory may vary
// End Includes

// Code reqired for curl
struct string {
    char *data;
    size_t len;
};

void init_string(struct string *response) {
    response->len = 0;
    response->data = (char*)malloc(response->len+1);
    if (response->data == NULL) {
        fprintf(stderr, "malloc() failed\n");
        exit(EXIT_FAILURE);
    }
    response->data[0] = '\0';
}

size_t curlData(void *data, size_t size, size_t nmemb, struct string *response)
{
    size_t new_len = response->len + size*nmemb;
    response->data = (char*)realloc(response->data, new_len+1);
    if (response->data == NULL) {
        fprintf(stderr, "realloc() failed\n");
        exit(EXIT_FAILURE);
    }
    memcpy(response->data+response->len, data, size*nmemb);
    response->data[new_len] = '\0';
    response->len = new_len;

    return size*nmemb;
}
// End required Curl coding

// This function accesses the api URL and converts
// the contents to a usable JSON-C object and returns it
struct json_object* callAPI(const char * url){
    CURL *curl;
    CURLcode res;
    json_object * jsonObject;
    curl = curl_easy_init();
    if(curl) {
        struct string response;
        init_string(&response);

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlData);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        res = curl_easy_perform(curl);
        if(CURLE_OK == res){
            jsonObject = json_tokener_parse(response.data);
        }
        free(response.data);
    }

    curl_easy_cleanup(curl);
    curl_global_cleanup();
    return jsonObject;
}

int main(void)
{

    // Call the callApi function to create a usable
    // object named apiObject from the API request URL.
    // Put the API request URL in the call
    json_object * apiObject = callAPI("https://io.ekmpush.com/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=json&cnt=10");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here
    json_object * readmeter_json;
    json_object_object_get_ex(apiObject,"readMeter",&readmeter_json);
    printf("Complete readMeter Object: \n%s", json_object_to_json_string_ext(readmeter_json,JSON_C_TO_STRING_PRETTY));

    // This example digs deaper into the JSON and displays the first
    // kwh_tot value for the first read of the first meter
    json_object * readset_json;
    json_object * readset_0_json;
    json_object * readdata_json;
    json_object * readdata_0_json;
    json_object * kwh_tot;
    json_object_object_get_ex(readmeter_json,"ReadSet",&readset_json);
    readset_0_json = json_object_array_get_idx(readset_json,0);
    json_object_object_get_ex(readset_0_json,"ReadData",&readdata_json);
    readdata_0_json = json_object_array_get_idx(readdata_json,0);
    json_object_object_get_ex(readdata_0_json,"kWh_Tot",&kwh_tot);
    printf("\nkWh_Tot: %s", json_object_to_json_string_ext(kwh_tot,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

If you would like to filter to just 1 meter you can add the filter: meters=METER_ID

In the example below the METER_ID being used is: 300000369

https://io.ekmpush.com/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=html&cnt=10


The link below is an example of the read data with the associated meter

https://io.ekmpush.com/readMeter?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=html&cnt=10

Click to try


URL Parameters

Parameter Description
meters The ID or number of the meter you want to retrieve

Legacy Query Multiple Meters

Query Multiple Meters

curl -s
"https://io.ekmpush.com/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10"
# Load required modules
require 'net/http'
require 'json'
require 'uri'

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call

def callApi(api_path)
  uri = URI.parse("https://io.ekmpush.com#{api_path}")
  response = Net::HTTP.get_response(uri)
  puts response.uri
  JSON.parse(response.body)
end

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://io.ekmpush.com
apiObject = callApi('/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10')

# This just displays the object but you can use what ever
# code you would like to work with the object here
require 'pp'
pp apiObject
# Required Python Modules
import urllib.request, urllib.error, urllib.parse
import json

# This function accesses the apiRequest URL and converts
# the contents to a usable Python object and returns it
def callApi ( apiRequest ):
        response = urllib.request.urlopen(apiRequest)
        response = response.read()
        jsonObject = json.loads(response.decode())
        return jsonObject

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10")

# This just displays the object but you can use what ever
# code you would like to work with the object here
import pprint
pprint.pprint(apiObject)
<?php
// Call the callApi function to create a usable
// object named $apiObject from the API request URL.
// Put the API request URL in the call
$apiObject=callApi('https://io.ekmpush.com/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10');

// This just displays the object but you can use what ever
// code you would like to work with the object here
var_dump($apiObject);

// This function accesses the apiRequest URL and converts
// the contents to a usable PHP object and returns it
function callApi ($apiRequest='') {

        $json=@file_get_contents($apiRequest);
        $jsonObject=json_decode($json);
        return ($jsonObject);

}
?>
# Install JSON module
# for example on centos 6.5
# yum install cpan
# cpan JSON


# Required Perl Modules
use LWP::Simple;
use JSON;
use Data::Dumper;

# This function accesses the apiRequest URL and converts
# the contents to a usable Perl object and returns it
sub callApi{
        my $apiRequest = shift;
        my $json_text = get(q[$apiRequest]);
        my $jsonObject = JSON->new->utf8->decode($json_text);
        return $jsonObject;
}

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
my $apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10");

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($apiObject);
/*
 Download the correct org.json jar version for your
 needs from: https://mvnrepository.com/artifact/org.json/json

 This example uses version 20131018 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20190722/json-20190722.jar

 Instructions to run this program

 1. Put this code in a file named EKM.java
 2. Copy the downloaded org.json jar and EKM.java to the same directory
 3. Compile
  javac -cp .:./json-20190722.jar ./EKM.java
 4. Run
  java -cp .:./json-20190722.jar EKM
*/


//Import required classes
import java.net.*;
import java.io.*;
import org.json.*;

public class EKM {
    public static JSONObject callApi(String apiRequest) throws Exception {

        // This code accesses the apiRequest URL and converts
        // the contents to a usable JSON object

        URL url = new URL(apiRequest);
        URLConnection connection = url.openConnection();
        BufferedReader in = new BufferedReader(
                                               new InputStreamReader(
                                                                     connection.getInputStream()));

        StringBuilder response = new StringBuilder();
        String inputLine;

        while ((inputLine = in.readLine()) != null)
            response.append(inputLine);

        in.close();

        JSONObject jsonObject = new JSONObject(response.toString());
        return jsonObject;
    }

    public static void main(String[] args) throws Exception {
        /*
         Call callApi to create a usable
         object named apiObject from the API request URL.
         Put the API request URL in the call
         */
        JSONObject apiObject = EKM.callApi("https://io.ekmpush.com/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10");

        /*
         You can access any part of the apiObject using code like this:
         JSONArray  readData = apiObject.getJSONObject("readMeter").getJSONArray("ReadSet").
         getJSONObject(0).getJSONArray("ReadData");
        */

        // This just outputs the whole apiObject
        System.out.println(apiObject.toString(4));
    }
}
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">

// The example function is called from the
// body tag when the page loads
function example(){

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10',function(apiObject){

       // This just displays the object in the result div
       // you can use what ever code you would like to work
       // with the object here
       document.getElementById("result").innerHTML = "<pre>"+JSON.stringify(apiObject, null, 4)+"</pre>";
       });

};

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback) {
    var xhttp = new XMLHttpRequest();
    xhttp.onreadystatechange = function() {
      if (xhttp.readyState == 4 && xhttp.status == 200) {
        var jsonObject = JSON.parse(xhttp.responseText);
        callback(jsonObject);
      }
    };
    xhttp.open("GET", apiRequest, true);
    xhttp.send();
}
</script>

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
// NodeJS requires the "request" module to access the API
// Install by running "npm install request" from the shell prompt

// Load "request" module
var request = require("request");

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10', function (apiObject) {


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        console.log(JSON.stringify(apiObject, null, 4));
});

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback){

        var options = { method: 'GET'
                        , uri: apiRequest
                        , timeout: 1000*15
                        , strictSSL: false
                        , rejectUnhauthorized : false
                      };

        request(options, function (error, response, body) {
                if(error){
                        console.log(error);
                        throw error;
                }else{
                     var jsonObject = JSON.parse(body);
                     callback(jsonObject);
                }
        });
}
/*
 *  Install json-c if its not installed
 *  https://github.com/json-c/json-c/wiki
 *
 *  Below is command to install json-c on centos
 *  yum install json-c-devel
 *
 *  Saved this example code to a file named ekm.c
 *  - Compile
 *  gcc ekm.c -o ekm -lcurl  -ljson-c
 *  - Run
 *  ./ekm
 *
 */
// Required Includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h> //your directory may vary depending on your OS
#include <json/json.h> //your directory may vary
// End Includes

// Code reqired for curl
struct string {
    char *data;
    size_t len;
};

void init_string(struct string *response) {
    response->len = 0;
    response->data = (char*)malloc(response->len+1);
    if (response->data == NULL) {
        fprintf(stderr, "malloc() failed\n");
        exit(EXIT_FAILURE);
    }
    response->data[0] = '\0';
}

size_t curlData(void *data, size_t size, size_t nmemb, struct string *response)
{
    size_t new_len = response->len + size*nmemb;
    response->data = (char*)realloc(response->data, new_len+1);
    if (response->data == NULL) {
        fprintf(stderr, "realloc() failed\n");
        exit(EXIT_FAILURE);
    }
    memcpy(response->data+response->len, data, size*nmemb);
    response->data[new_len] = '\0';
    response->len = new_len;

    return size*nmemb;
}
// End required Curl coding

// This function accesses the api URL and converts
// the contents to a usable JSON-C object and returns it
struct json_object* callAPI(const char * url){
    CURL *curl;
    CURLcode res;
    json_object * jsonObject;
    curl = curl_easy_init();
    if(curl) {
        struct string response;
        init_string(&response);

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlData);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        res = curl_easy_perform(curl);
        if(CURLE_OK == res){
            jsonObject = json_tokener_parse(response.data);
        }
        free(response.data);
    }

    curl_easy_cleanup(curl);
    curl_global_cleanup();
    return jsonObject;
}

int main(void)
{

    // Call the callApi function to create a usable
    // object named apiObject from the API request URL.
    // Put the API request URL in the call
    json_object * apiObject = callAPI("https://io.ekmpush.com/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here
    json_object * readmeter_json;
    json_object_object_get_ex(apiObject,"readMeter",&readmeter_json);
    printf("Complete readMeter Object: \n%s", json_object_to_json_string_ext(readmeter_json,JSON_C_TO_STRING_PRETTY));

    // This example digs deaper into the JSON and displays the first
    // kwh_tot value for the first read of the first meter
    json_object * readset_json;
    json_object * readset_0_json;
    json_object * readdata_json;
    json_object * readdata_0_json;
    json_object * kwh_tot;
    json_object_object_get_ex(readmeter_json,"ReadSet",&readset_json);
    readset_0_json = json_object_array_get_idx(readset_json,0);
    json_object_object_get_ex(readset_0_json,"ReadData",&readdata_json);
    readdata_0_json = json_object_array_get_idx(readdata_json,0);
    json_object_object_get_ex(readdata_0_json,"kWh_Tot",&kwh_tot);
    printf("\nkWh_Tot: %s", json_object_to_json_string_ext(kwh_tot,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

To see multiple meter readings, i.e. meter number 17507 and 15635 from v3 meters, your https address should look like the following:

https://io.ekmpush.com/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10


As you can see in the above example, all that was changed in the https address is the addition of the extra meter to the end of the meters parameter: 17507~15635. This will allow you to call multiple meters to get their individual data readings.

https://io.ekmpush.com/readMeter?meters=17507~15635&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10

Click to try


Legacy Output Formats

Output format: XML

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=xml&cnt=1

The above URL returns XML structured like this:

<readMeter Requested="1">
<ReadSet Meter="17507" Group="1010" Interval="1" Protocol="v3" MAC_Addr="40:16:fa:01:00:06" Tz_Offset_Sec="0" Bad_Reads="0" Good_Reads="1" Credits="1000000">
<ReadData Good="1" Date="2015-11-04" Time="19:15:12.208" Time_Stamp_UTC_ms="1446664512208" Firmware="13" Model="1710" kWh_Tot="104043.0" kWh_Tariff_1="68443.6" kWh_Tariff_2="35599.4" Rev_kWh_Tot="31567.2" Rev_kWh_Tariff_1="21351.6" Rev_kWh_Tariff_2="10215.6" RMS_Volts_Ln_1="122.8" RMS_Volts_Ln_2="122.8" Amps_Ln_1="1.2" Amps_Ln_2="13.0" RMS_Watts_Ln_1="130" RMS_Watts_Ln_2="1596" RMS_Watts_Tot="1726" Power_Factor_Ln_1="100" Power_Factor_Ln_2="100" Power_Factor_Ln_3="200" RMS_Watts_Max_Demand="15055" Max_Demand_Period="1" CT_Ratio="200" Meter_Status_Code="30"/>
</ReadSet>
</readMeter>

Output format: JSON

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1

The above URL returns JSON structured like this:

{
  "readMeter": {
    "Requested":1,
    "ReadSet":[
      {
      "Meter":"17507",
      "Group":1010,
      "Interval":1,
      "Protocol":"v3",
      "MAC_Addr":"40:16:fa:01:00:06",
      "Tz_Offset_Sec":0,
      "Bad_Reads":0,
      "Good_Reads":1,
      "Credits":1000000,
      "ReadData": [
        {
        "Good":1,
        "Date":"2015-11-04",
        "Time":"19:20:30.202",
        "Time_Stamp_UTC_ms":1446664830202,
        "Firmware":"13",
        "Model":"1710",
        "kWh_Tot":"104043.1",
        "kWh_Tariff_1":"68443.6",
        "kWh_Tariff_2":"35599.5",
        "Rev_kWh_Tot":"31567.2",
        "Rev_kWh_Tariff_1":"21351.6",
        "Rev_kWh_Tariff_2":"10215.6",
        "RMS_Volts_Ln_1":"124.9",
        "RMS_Volts_Ln_2":"124.9",
        "Amps_Ln_1":"1.2",
        "Amps_Ln_2":"2.8",
        "RMS_Watts_Ln_1":"132",
        "RMS_Watts_Ln_2":"288",
        "RMS_Watts_Tot":"422",
        "Power_Factor_Ln_1":"100",
        "Power_Factor_Ln_2":"103",
        "Power_Factor_Ln_3":"200",
        "RMS_Watts_Max_Demand":"15055",
        "Max_Demand_Period":"1",
        "CT_Ratio":"200",
        "Meter_Status_Code":"30"
        }
        ]
      }
      ]
    }
}

Output format: CSV

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=csv&cnt=1

The above URL returns CSV structured like this:

Meter,Date,Time,Time_Stamp_UTC_ms,kWh_Tot,kWh_Tariff_1,kWh_Tariff_2,Rev_kWh_Tot,Rev_kWh_Tariff_1,Rev_kWh_Tariff_2,RMS_Volts_Ln_1,RMS_Volts_Ln_2,Amps_Ln_1,Amps_Ln_2,RMS_Watts_Ln_1,RMS_Watts_Ln_2,RMS_Watts_Tot,Power_Factor_Ln_1,Power_Factor_Ln_2,Power_Factor_Ln_3,RMS_Watts_Max_Demand,CT_Ratio
17507,11/04/2015,19:30:39,1446665439231,104043.3,68443.6,35599.7,31567.3,21351.6,10215.7,124.0,124.1,1.2,4.0,132,468,600,100,100,200,15055,200

You can call up different output formats to return the meter data in. These formats can be: html, xml, json and csv.

To retrieve the different formats, all that is required is to change the FORMAT (written as fmt in the https address), to the type you want to call:

Example URL

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=FORMAT&cnt=1&tz=America~Los_Angeles


The example below will return the meter data in the HTML format ( HyperText Markup Language )

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=1&tz=America~Los_Angeles

Click to try


Click the link below to see the meter data returned in the XML format ( Extensible Markup Language )

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=xml&cnt=1&tz=America~Los_Angeles

Click to try


Click the link below to see the meter data returned in the JSON format ( JavaScript Object Notation )

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles

Click to try


Click the link below to download the meter data in the CSV format ( Comma Separated Values )

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=csv&cnt=1&tz=America~Los_Angeles

Click to try


URL Parameters

Parameter Description
fmt Available formats are: html, xml, json, and csv

Legacy Number of Meter Reads

Number of Meter Readings

curl -s
"https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1000"
# Load required modules
require 'net/http'
require 'json'
require 'uri'

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call

def callApi(api_path)
  uri = URI.parse("https://io.ekmpush.com#{api_path}")
  response = Net::HTTP.get_response(uri)
  puts response.uri
  JSON.parse(response.body)
end

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://io.ekmpush.com
apiObject = callApi('/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1000')

# This just displays the object but you can use what ever
# code you would like to work with the object here
require 'pp'
pp apiObject
# Required Python Modules
import urllib.request, urllib.error, urllib.parse
import json

# This function accesses the apiRequest URL and converts
# the contents to a usable Python object and returns it
def callApi ( apiRequest ):
        response = urllib.request.urlopen(apiRequest)
        response = response.read()
        jsonObject = json.loads(response.decode())
        return jsonObject

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1000")

# This just displays the object but you can use what ever
# code you would like to work with the object here
import pprint
pprint.pprint(apiObject)
<?php
// Call the callApi function to create a usable
// object named $apiObject from the API request URL.
// Put the API request URL in the call
$apiObject=callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1000');

// This just displays the object but you can use what ever
// code you would like to work with the object here
var_dump($apiObject);

// This function accesses the apiRequest URL and converts
// the contents to a usable PHP object and returns it
function callApi ($apiRequest='') {

        $json=@file_get_contents($apiRequest);
        $jsonObject=json_decode($json);
        return ($jsonObject);

}
?>
# Install JSON module
# for example on centos 6.5
# yum install cpan
# cpan JSON


# Required Perl Modules
use LWP::Simple;
use JSON;
use Data::Dumper;

# This function accesses the apiRequest URL and converts
# the contents to a usable Perl object and returns it
sub callApi{
        my $apiRequest = shift;
        my $json_text = get(q[$apiRequest]);
        my $jsonObject = JSON->new->utf8->decode($json_text);
        return $jsonObject;
}

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
my $apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1000");

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($apiObject);
/*
 Download the correct org.json jar version for your
 needs from: https://mvnrepository.com/artifact/org.json/json

 This example uses version 20131018 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20190722/json-20190722.jar

 Instructions to run this program

 1. Put this code in a file named EKM.java
 2. Copy the downloaded org.json jar and EKM.java to the same directory
 3. Compile
  javac -cp .:./json-20190722.jar ./EKM.java
 4. Run
  java -cp .:./json-20190722.jar EKM
*/


//Import required classes
import java.net.*;
import java.io.*;
import org.json.*;

public class EKM {
    public static JSONObject callApi(String apiRequest) throws Exception {

        // This code accesses the apiRequest URL and converts
        // the contents to a usable JSON object

        URL url = new URL(apiRequest);
        URLConnection connection = url.openConnection();
        BufferedReader in = new BufferedReader(
                                               new InputStreamReader(
                                                                     connection.getInputStream()));

        StringBuilder response = new StringBuilder();
        String inputLine;

        while ((inputLine = in.readLine()) != null)
            response.append(inputLine);

        in.close();

        JSONObject jsonObject = new JSONObject(response.toString());
        return jsonObject;
    }

    public static void main(String[] args) throws Exception {
        /*
         Call callApi to create a usable
         object named apiObject from the API request URL.
         Put the API request URL in the call
         */
        JSONObject apiObject = EKM.callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1000");

        /*
         You can access any part of the apiObject using code like this:
         JSONArray  readData = apiObject.getJSONObject("readMeter").getJSONArray("ReadSet").
         getJSONObject(0).getJSONArray("ReadData");
        */

        // This just outputs the whole apiObject
        System.out.println(apiObject.toString(4));
    }
}
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">

// The example function is called from the
// body tag when the page loads
function example(){

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1000',function(apiObject){

       // This just displays the object in the result div
       // you can use what ever code you would like to work
       // with the object here
       document.getElementById("result").innerHTML = "<pre>"+JSON.stringify(apiObject, null, 4)+"</pre>";
       });

};

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback) {
    var xhttp = new XMLHttpRequest();
    xhttp.onreadystatechange = function() {
      if (xhttp.readyState == 4 && xhttp.status == 200) {
        var jsonObject = JSON.parse(xhttp.responseText);
        callback(jsonObject);
      }
    };
    xhttp.open("GET", apiRequest, true);
    xhttp.send();
}
</script>

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
// NodeJS requires the "request" module to access the API
// Install by running "npm install request" from the shell prompt

// Load "request" module
var request = require("request");

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1000', function (apiObject) {


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        console.log(JSON.stringify(apiObject, null, 4));
});

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback){

        var options = { method: 'GET'
                        , uri: apiRequest
                        , timeout: 1000*15
                        , strictSSL: false
                        , rejectUnhauthorized : false
                      };

        request(options, function (error, response, body) {
                if(error){
                        console.log(error);
                        throw error;
                }else{
                     var jsonObject = JSON.parse(body);
                     callback(jsonObject);
                }
        });
}
/*
 *  Install json-c if its not installed
 *  https://github.com/json-c/json-c/wiki
 *
 *  Below is command to install json-c on centos
 *  yum install json-c-devel
 *
 *  Saved this example code to a file named ekm.c
 *  - Compile
 *  gcc ekm.c -o ekm -lcurl  -ljson-c
 *  - Run
 *  ./ekm
 *
 */
// Required Includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h> //your directory may vary depending on your OS
#include <json/json.h> //your directory may vary
// End Includes

// Code reqired for curl
struct string {
    char *data;
    size_t len;
};

void init_string(struct string *response) {
    response->len = 0;
    response->data = (char*)malloc(response->len+1);
    if (response->data == NULL) {
        fprintf(stderr, "malloc() failed\n");
        exit(EXIT_FAILURE);
    }
    response->data[0] = '\0';
}

size_t curlData(void *data, size_t size, size_t nmemb, struct string *response)
{
    size_t new_len = response->len + size*nmemb;
    response->data = (char*)realloc(response->data, new_len+1);
    if (response->data == NULL) {
        fprintf(stderr, "realloc() failed\n");
        exit(EXIT_FAILURE);
    }
    memcpy(response->data+response->len, data, size*nmemb);
    response->data[new_len] = '\0';
    response->len = new_len;

    return size*nmemb;
}
// End required Curl coding

// This function accesses the api URL and converts
// the contents to a usable JSON-C object and returns it
struct json_object* callAPI(const char * url){
    CURL *curl;
    CURLcode res;
    json_object * jsonObject;
    curl = curl_easy_init();
    if(curl) {
        struct string response;
        init_string(&response);

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlData);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        res = curl_easy_perform(curl);
        if(CURLE_OK == res){
            jsonObject = json_tokener_parse(response.data);
        }
        free(response.data);
    }

    curl_easy_cleanup(curl);
    curl_global_cleanup();
    return jsonObject;
}

int main(void)
{

    // Call the callApi function to create a usable
    // object named apiObject from the API request URL.
    // Put the API request URL in the call
    json_object * apiObject = callAPI("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1000");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here
    json_object * readmeter_json;
    json_object_object_get_ex(apiObject,"readMeter",&readmeter_json);
    printf("Complete readMeter Object: \n%s", json_object_to_json_string_ext(readmeter_json,JSON_C_TO_STRING_PRETTY));

    // This example digs deaper into the JSON and displays the first
    // kwh_tot value for the first read of the first meter
    json_object * readset_json;
    json_object * readset_0_json;
    json_object * readdata_json;
    json_object * readdata_0_json;
    json_object * kwh_tot;
    json_object_object_get_ex(readmeter_json,"ReadSet",&readset_json);
    readset_0_json = json_object_array_get_idx(readset_json,0);
    json_object_object_get_ex(readset_0_json,"ReadData",&readdata_json);
    readdata_0_json = json_object_array_get_idx(readdata_json,0);
    json_object_object_get_ex(readdata_0_json,"kWh_Tot",&kwh_tot);
    printf("\nkWh_Tot: %s", json_object_to_json_string_ext(kwh_tot,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

The following https format will provide 10 readings of meter data from all Omnimeter Pulse v.3 meters in the EKM Push account with key MTAxMDoyMDIw.

https://io.ekmpush.com/readMeter?ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=READ_COUNT

Replace READ_COUNT with the number 10 to call the amount of meter data to read.

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10


The link below will show the example of the meter data that is associated with the provided key and the specified number of 10 meter data readings. It will display it as html data.

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10

Click to try


You can also request anywhere from 1 to 1000 meter reads from any given meter with the following format:

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=READ_COUNT

For 1 meter reading replace READ_COUNT with the number 1 as in the example below:

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=1

Click to try


or for 1000 meter readings replace READ_COUNT with the number 1000 as in the example below:

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=1000

Click to try


URL Parameters

Parameters Description
cnt Number of meter reads to display

Legacy Time Zones

Time Zones

curl -s
"https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles"
# Load required modules
require 'net/http'
require 'json'
require 'uri'

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call

def callApi(api_path)
  uri = URI.parse("https://io.ekmpush.com#{api_path}")
  response = Net::HTTP.get_response(uri)
  puts response.uri
  JSON.parse(response.body)
end

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://io.ekmpush.com
apiObject = callApi('/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles')

# This just displays the object but you can use what ever
# code you would like to work with the object here
require 'pp'
pp apiObject
# Required Python Modules
import urllib.request, urllib.error, urllib.parse
import json

# This function accesses the apiRequest URL and converts
# the contents to a usable Python object and returns it
def callApi ( apiRequest ):
        response = urllib.request.urlopen(apiRequest)
        response = response.read()
        jsonObject = json.loads(response.decode())
        return jsonObject

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call

# This just displays the object but you can use what ever
# code you would like to work with the object here
import pprint
pprint.pprint(apiObject)
<?php
// Call the callApi function to create a usable
// object named $apiObject from the API request URL.
// Put the API request URL in the call
$apiObject=callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles');

// This just displays the object but you can use what ever
// code you would like to work with the object here
var_dump($apiObject);

// This function accesses the apiRequest URL and converts
// the contents to a usable PHP object and returns it
function callApi ($apiRequest='') {

        $json=@file_get_contents($apiRequest);
        $jsonObject=json_decode($json);
        return ($jsonObject);

}
?>
# Install JSON module
# for example on centos 6.5
# yum install cpan
# cpan JSON


# Required Perl Modules
use LWP::Simple;
use JSON;
use Data::Dumper;

# This function accesses the apiRequest URL and converts
# the contents to a usable Perl object and returns it
sub callApi{
        my $apiRequest = shift;
        my $json_text = get(q[$apiRequest]);
        my $jsonObject = JSON->new->utf8->decode($json_text);
        return $jsonObject;
}

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
my $apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles");

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($apiObject);
/*
 Download the correct org.json jar version for your
 needs from: https://mvnrepository.com/artifact/org.json/json

 This example uses version 20131018 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20190722/json-20190722.jar

 Instructions to run this program

 1. Put this code in a file named EKM.java
 2. Copy the downloaded org.json jar and EKM.java to the same directory
 3. Compile
  javac -cp .:./json-20190722.jar ./EKM.java
 4. Run
  java -cp .:./json-20190722.jar EKM
*/


//Import required classes
import java.net.*;
import java.io.*;
import org.json.*;

public class EKM {
    public static JSONObject callApi(String apiRequest) throws Exception {

        // This code accesses the apiRequest URL and converts
        // the contents to a usable JSON object

        URL url = new URL(apiRequest);
        URLConnection connection = url.openConnection();
        BufferedReader in = new BufferedReader(
                                               new InputStreamReader(
                                                                     connection.getInputStream()));

        StringBuilder response = new StringBuilder();
        String inputLine;

        while ((inputLine = in.readLine()) != null)
            response.append(inputLine);

        in.close();

        JSONObject jsonObject = new JSONObject(response.toString());
        return jsonObject;
    }

    public static void main(String[] args) throws Exception {
        /*
         Call callApi to create a usable
         object named apiObject from the API request URL.
         Put the API request URL in the call
         */
        JSONObject apiObject = EKM.callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles");

        /*
         You can access any part of the apiObject using code like this:
         JSONArray  readData = apiObject.getJSONObject("readMeter").getJSONArray("ReadSet").
         getJSONObject(0).getJSONArray("ReadData");
        */

        // This just outputs the whole apiObject
        System.out.println(apiObject.toString(4));
    }
}
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">

// The example function is called from the
// body tag when the page loads
function example(){

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles',function(apiObject){

       // This just displays the object in the result div
       // you can use what ever code you would like to work
       // with the object here
       document.getElementById("result").innerHTML = "<pre>"+JSON.stringify(apiObject, null, 4)+"</pre>";
       });

};

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback) {
    var xhttp = new XMLHttpRequest();
    xhttp.onreadystatechange = function() {
      if (xhttp.readyState == 4 && xhttp.status == 200) {
        var jsonObject = JSON.parse(xhttp.responseText);
        callback(jsonObject);
      }
    };
    xhttp.open("GET", apiRequest, true);
    xhttp.send();
}
</script>

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
// NodeJS requires the "request" module to access the API
// Install by running "npm install request" from the shell prompt

// Load "request" module
var request = require("request");

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles', function (apiObject) {


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        console.log(JSON.stringify(apiObject, null, 4));
});

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback){

        var options = { method: 'GET'
                        , uri: apiRequest
                        , timeout: 1000*15
                        , strictSSL: false
                        , rejectUnhauthorized : false
                      };

        request(options, function (error, response, body) {
                if(error){
                        console.log(error);
                        throw error;
                }else{
                     var jsonObject = JSON.parse(body);
                     callback(jsonObject);
                }
        });
}
/*
 *  Install json-c if its not installed
 *  https://github.com/json-c/json-c/wiki
 *
 *  Below is command to install json-c on centos
 *  yum install json-c-devel
 *
 *  Saved this example code to a file named ekm.c
 *  - Compile
 *  gcc ekm.c -o ekm -lcurl  -ljson-c
 *  - Run
 *  ./ekm
 *
 */
// Required Includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h> //your directory may vary depending on your OS
#include <json/json.h> //your directory may vary
// End Includes

// Code reqired for curl
struct string {
    char *data;
    size_t len;
};

void init_string(struct string *response) {
    response->len = 0;
    response->data = (char*)malloc(response->len+1);
    if (response->data == NULL) {
        fprintf(stderr, "malloc() failed\n");
        exit(EXIT_FAILURE);
    }
    response->data[0] = '\0';
}

size_t curlData(void *data, size_t size, size_t nmemb, struct string *response)
{
    size_t new_len = response->len + size*nmemb;
    response->data = (char*)realloc(response->data, new_len+1);
    if (response->data == NULL) {
        fprintf(stderr, "realloc() failed\n");
        exit(EXIT_FAILURE);
    }
    memcpy(response->data+response->len, data, size*nmemb);
    response->data[new_len] = '\0';
    response->len = new_len;

    return size*nmemb;
}
// End required Curl coding

// This function accesses the api URL and converts
// the contents to a usable JSON-C object and returns it
struct json_object* callAPI(const char * url){
    CURL *curl;
    CURLcode res;
    json_object * jsonObject;
    curl = curl_easy_init();
    if(curl) {
        struct string response;
        init_string(&response);

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlData);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        res = curl_easy_perform(curl);
        if(CURLE_OK == res){
            jsonObject = json_tokener_parse(response.data);
        }
        free(response.data);
    }

    curl_easy_cleanup(curl);
    curl_global_cleanup();
    return jsonObject;
}

int main(void)
{

    // Call the callApi function to create a usable
    // object named apiObject from the API request URL.
    // Put the API request URL in the call
    json_object * apiObject = callAPI("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here
    json_object * readmeter_json;
    json_object_object_get_ex(apiObject,"readMeter",&readmeter_json);
    printf("Complete readMeter Object: \n%s", json_object_to_json_string_ext(readmeter_json,JSON_C_TO_STRING_PRETTY));

    // This example digs deaper into the JSON and displays the first
    // kwh_tot value for the first read of the first meter
    json_object * readset_json;
    json_object * readset_0_json;
    json_object * readdata_json;
    json_object * readdata_0_json;
    json_object * kwh_tot;
    json_object_object_get_ex(readmeter_json,"ReadSet",&readset_json);
    readset_0_json = json_object_array_get_idx(readset_json,0);
    json_object_object_get_ex(readset_0_json,"ReadData",&readdata_json);
    readdata_0_json = json_object_array_get_idx(readdata_json,0);
    json_object_object_get_ex(readdata_0_json,"kWh_Tot",&kwh_tot);
    printf("\nkWh_Tot: %s", json_object_to_json_string_ext(kwh_tot,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

By default the Push system returns the time as UTC Time (computer time) in milliseconds.

If you would like the time returned in a specific time zone you can add this to the URL call:

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=TIME_ZONE

In the example below the TIME ZONE that is being requested is the country of America and the city where the meter is in service, is Los Angeles.

The time zone of this location will be in the PACIFIC TIME ZONE, UTC offset -8:00.


The example link below will return the html request for the given parameters in the https address.

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=America~Los_Angeles

Click to try


Click the link below to go to the Wikipedia database for time zones and related information.

Click for Time Zone Information

URL Parameters

Parameter Description
tz The time zone is the country and city where the meter is in service. Example: America~Los_Angeles

Legacy Timestamp Call

Timestamp Data Call

curl -s
"https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919"
# Load required modules
require 'net/http'
require 'json'
require 'uri'

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call

def callApi(api_path)
  uri = URI.parse("https://io.ekmpush.com#{api_path}")
  response = Net::HTTP.get_response(uri)
  puts response.uri
  JSON.parse(response.body)
end

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://io.ekmpush.com
apiObject = callApi('/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919')

# This just displays the object but you can use what ever
# code you would like to work with the object here
require 'pp'
pp apiObject
# Required Python Modules
import urllib.request, urllib.error, urllib.parse
import json

# This function accesses the apiRequest URL and converts
# the contents to a usable Python object and returns it
def callApi ( apiRequest ):
        response = urllib.request.urlopen(apiRequest)
        response = response.read()
        jsonObject = json.loads(response.decode())
        return jsonObject

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919")

# This just displays the object but you can use what ever
# code you would like to work with the object here
import pprint
pprint.pprint(apiObject)
<?php
// Call the callApi function to create a usable
// object named $apiObject from the API request URL.
// Put the API request URL in the call
$apiObject=callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919');

// This just displays the object but you can use what ever
// code you would like to work with the object here
var_dump($apiObject);

// This function accesses the apiRequest URL and converts
// the contents to a usable PHP object and returns it
function callApi ($apiRequest='') {

        $json=@file_get_contents($apiRequest);
        $jsonObject=json_decode($json);
        return ($jsonObject);

}
?>
# Install JSON module
# for example on centos 6.5
# yum install cpan
# cpan JSON


# Required Perl Modules
use LWP::Simple;
use JSON;
use Data::Dumper;

# This function accesses the apiRequest URL and converts
# the contents to a usable Perl object and returns it
sub callApi{
        my $apiRequest = shift;
        my $json_text = get(q[$apiRequest]);
        my $jsonObject = JSON->new->utf8->decode($json_text);
        return $jsonObject;
}

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
my $apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919");

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($apiObject);
/*
 Download the correct org.json jar version for your
 needs from: https://mvnrepository.com/artifact/org.json/json

 This example uses version 20131018 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20190722/json-20190722.jar

 Instructions to run this program

 1. Put this code in a file named EKM.java
 2. Copy the downloaded org.json jar and EKM.java to the same directory
 3. Compile
  javac -cp .:./json-20190722.jar ./EKM.java
 4. Run
  java -cp .:./json-20190722.jar EKM
*/


//Import required classes
import java.net.*;
import java.io.*;
import org.json.*;

public class EKM {
    public static JSONObject callApi(String apiRequest) throws Exception {

        // This code accesses the apiRequest URL and converts
        // the contents to a usable JSON object

        URL url = new URL(apiRequest);
        URLConnection connection = url.openConnection();
        BufferedReader in = new BufferedReader(
                                               new InputStreamReader(
                                                                     connection.getInputStream()));

        StringBuilder response = new StringBuilder();
        String inputLine;

        while ((inputLine = in.readLine()) != null)
            response.append(inputLine);

        in.close();

        JSONObject jsonObject = new JSONObject(response.toString());
        return jsonObject;
    }

    public static void main(String[] args) throws Exception {
        /*
         Call callApi to create a usable
         object named apiObject from the API request URL.
         Put the API request URL in the call
         */
        JSONObject apiObject = EKM.callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919");

        /*
         You can access any part of the apiObject using code like this:
         JSONArray  readData = apiObject.getJSONObject("readMeter").getJSONArray("ReadSet").
         getJSONObject(0).getJSONArray("ReadData");
        */

        // This just outputs the whole apiObject
        System.out.println(apiObject.toString(4));
    }
}
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">

// The example function is called from the
// body tag when the page loads
function example(){

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919',function(apiObject){

       // This just displays the object in the result div
       // you can use what ever code you would like to work
       // with the object here
       document.getElementById("result").innerHTML = "<pre>"+JSON.stringify(apiObject, null, 4)+"</pre>";
       });

};

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback) {
    var xhttp = new XMLHttpRequest();
    xhttp.onreadystatechange = function() {
      if (xhttp.readyState == 4 && xhttp.status == 200) {
        var jsonObject = JSON.parse(xhttp.responseText);
        callback(jsonObject);
      }
    };
    xhttp.open("GET", apiRequest, true);
    xhttp.send();
}
</script>

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
// NodeJS requires the "request" module to access the API
// Install by running "npm install request" from the shell prompt

// Load "request" module
var request = require("request");

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919', function (apiObject) {


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        console.log(JSON.stringify(apiObject, null, 4));
});

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback){

        var options = { method: 'GET'
                        , uri: apiRequest
                        , timeout: 1000*15
                        , strictSSL: false
                        , rejectUnhauthorized : false
                      };

        request(options, function (error, response, body) {
                if(error){
                        console.log(error);
                        throw error;
                }else{
                     var jsonObject = JSON.parse(body);
                     callback(jsonObject);
                }
        });
}
/*
 *  Install json-c if its not installed
 *  https://github.com/json-c/json-c/wiki
 *
 *  Below is command to install json-c on centos
 *  yum install json-c-devel
 *
 *  Saved this example code to a file named ekm.c
 *  - Compile
 *  gcc ekm.c -o ekm -lcurl  -ljson-c
 *  - Run
 *  ./ekm
 *
 */
// Required Includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h> //your directory may vary depending on your OS
#include <json/json.h> //your directory may vary
// End Includes

// Code reqired for curl
struct string {
    char *data;
    size_t len;
};

void init_string(struct string *response) {
    response->len = 0;
    response->data = (char*)malloc(response->len+1);
    if (response->data == NULL) {
        fprintf(stderr, "malloc() failed\n");
        exit(EXIT_FAILURE);
    }
    response->data[0] = '\0';
}

size_t curlData(void *data, size_t size, size_t nmemb, struct string *response)
{
    size_t new_len = response->len + size*nmemb;
    response->data = (char*)realloc(response->data, new_len+1);
    if (response->data == NULL) {
        fprintf(stderr, "realloc() failed\n");
        exit(EXIT_FAILURE);
    }
    memcpy(response->data+response->len, data, size*nmemb);
    response->data[new_len] = '\0';
    response->len = new_len;

    return size*nmemb;
}
// End required Curl coding

// This function accesses the api URL and converts
// the contents to a usable JSON-C object and returns it
struct json_object* callAPI(const char * url){
    CURL *curl;
    CURLcode res;
    json_object * jsonObject;
    curl = curl_easy_init();
    if(curl) {
        struct string response;
        init_string(&response);

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlData);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        res = curl_easy_perform(curl);
        if(CURLE_OK == res){
            jsonObject = json_tokener_parse(response.data);
        }
        free(response.data);
    }

    curl_easy_cleanup(curl);
    curl_global_cleanup();
    return jsonObject;
}

int main(void)
{

    // Call the callApi function to create a usable
    // object named apiObject from the API request URL.
    // Put the API request URL in the call
    json_object * apiObject = callAPI("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here
    json_object * readmeter_json;
    json_object_object_get_ex(apiObject,"readMeter",&readmeter_json);
    printf("Complete readMeter Object: \n%s", json_object_to_json_string_ext(readmeter_json,JSON_C_TO_STRING_PRETTY));

    // This example digs deaper into the JSON and displays the first
    // kwh_tot value for the first read of the first meter
    json_object * readset_json;
    json_object * readset_0_json;
    json_object * readdata_json;
    json_object * readdata_0_json;
    json_object * kwh_tot;
    json_object_object_get_ex(readmeter_json,"ReadSet",&readset_json);
    readset_0_json = json_object_array_get_idx(readset_json,0);
    json_object_object_get_ex(readset_0_json,"ReadData",&readdata_json);
    readdata_0_json = json_object_array_get_idx(readdata_json,0);
    json_object_object_get_ex(readdata_0_json,"kWh_Tot",&kwh_tot);
    printf("\nkWh_Tot: %s", json_object_to_json_string_ext(kwh_tot,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

You can call all available data from a given timestamp.

With this you can call up to 1000 meter readings from the last time you retrieved data. So you might get just 1 reading back or 1000 readings depending on how many meter readings have been inserted since your last call ( timestamp ).

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=America~Los_Angeles&until=UNTIL

You can also use the filter “since”: since=Time

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=America~Los_Angeles&since=SINCE

The Time can either be the current time or a previous period in time that you want to obtain a specific meter data reading. The time will be formatted in milliseconds.

Example below is how the https address will look like using the until time parameter. To see an example of the since parameter just replace until with since in the https address, the time being used is - 1415218436919. Remember, the time is formatted in milliseconds.

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=America~Los_Angeles&since=1415218436919

URL Parameters

Parameter Description
since or until Since the last call or Until a certain call. The timestamp is in UTC Time ( computer time ), formatted in milliseconds.

Legacy Date and Time

You can use start_date and end_date to report on a range of data for entire days or you can also add the start_time and end_time parameters to select what time period in the start_date and end_date range to report on.

Legacy Start Date & End Date

Start Date & End Date

curl -s
"https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_date=06112015&end_date=07112015"
# Load required modules
require 'net/http'
require 'json'
require 'uri'

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call

def callApi(api_path)
  uri = URI.parse("https://io.ekmpush.com#{api_path}")
  response = Net::HTTP.get_response(uri)
  puts response.uri
  JSON.parse(response.body)
end

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://io.ekmpush.com
apiObject = callApi('/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_date=06112015&end_date=07112015')

# This just displays the object but you can use what ever
# code you would like to work with the object here
require 'pp'
pp apiObject
# Required Python Modules
import urllib.request, urllib.error, urllib.parse
import json

# This function accesses the apiRequest URL and converts
# the contents to a usable Python object and returns it
def callApi ( apiRequest ):
        response = urllib.request.urlopen(apiRequest)
        response = response.read()
        jsonObject = json.loads(response.decode())
        return jsonObject

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
apiObject = callApi("https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_date=06112015&end_date=07112015")

# This just displays the object but you can use what ever
# code you would like to work with the object here
import pprint
pprint.pprint(apiObject)
<?php
// Call the callApi function to create a usable
// object named $apiObject from the API request URL.
// Put the API request URL in the call
$apiObject=callApi('https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_date=06112015&end_date=07112015');

// This just displays the object but you can use what ever
// code you would like to work with the object here
var_dump($apiObject);

// This function accesses the apiRequest URL and converts
// the contents to a usable PHP object and returns it
function callApi ($apiRequest='') {

        $json=@file_get_contents($apiRequest);
        $jsonObject=json_decode($json);
        return ($jsonObject);

}
?>
# Install JSON module
# for example on centos 6.5
# yum install cpan
# cpan JSON


# Required Perl Modules
use LWP::Simple;
use JSON;
use Data::Dumper;

# This function accesses the apiRequest URL and converts
# the contents to a usable Perl object and returns it
sub callApi{
        my $apiRequest = shift;
        my $json_text = get(q[$apiRequest]);
        my $jsonObject = JSON->new->utf8->decode($json_text);
        return $jsonObject;
}

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
my $apiObject = callApi("https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_date=06112015&end_date=07112015");

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($apiObject);
/*
 Download the correct org.json jar version for your
 needs from: https://mvnrepository.com/artifact/org.json/json

 This example uses version 20131018 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20190722/json-20190722.jar

 Instructions to run this program

 1. Put this code in a file named EKM.java
 2. Copy the downloaded org.json jar and EKM.java to the same directory
 3. Compile
  javac -cp .:./json-20190722.jar ./EKM.java
 4. Run
  java -cp .:./json-20190722.jar EKM
*/


//Import required classes
import java.net.*;
import java.io.*;
import org.json.*;

public class EKM {
    public static JSONObject callApi(String apiRequest) throws Exception {

        // This code accesses the apiRequest URL and converts
        // the contents to a usable JSON object

        URL url = new URL(apiRequest);
        URLConnection connection = url.openConnection();
        BufferedReader in = new BufferedReader(
                                               new InputStreamReader(
                                                                     connection.getInputStream()));

        StringBuilder response = new StringBuilder();
        String inputLine;

        while ((inputLine = in.readLine()) != null)
            response.append(inputLine);

        in.close();

        JSONObject jsonObject = new JSONObject(response.toString());
        return jsonObject;
    }

    public static void main(String[] args) throws Exception {
        /*
         Call callApi to create a usable
         object named apiObject from the API request URL.
         Put the API request URL in the call
         */
        JSONObject apiObject = EKM.callApi("https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_date=06112015&end_date=07112015");

        /*
         You can access any part of the apiObject using code like this:
         JSONArray  readData = apiObject.getJSONObject("readMeter").getJSONArray("ReadSet").
         getJSONObject(0).getJSONArray("ReadData");
        */

        // This just outputs the whole apiObject
        System.out.println(apiObject.toString(4));
    }
}
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">

// The example function is called from the
// body tag when the page loads
function example(){

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_date=06112015&end_date=07112015',function(apiObject){

       // This just displays the object in the result div
       // you can use what ever code you would like to work
       // with the object here
       document.getElementById("result").innerHTML = "<pre>"+JSON.stringify(apiObject, null, 4)+"</pre>";
       });

};

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback) {
    var xhttp = new XMLHttpRequest();
    xhttp.onreadystatechange = function() {
      if (xhttp.readyState == 4 && xhttp.status == 200) {
        var jsonObject = JSON.parse(xhttp.responseText);
        callback(jsonObject);
      }
    };
    xhttp.open("GET", apiRequest, true);
    xhttp.send();
}
</script>

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
// NodeJS requires the "request" module to access the API
// Install by running "npm install request" from the shell prompt

// Load "request" module
var request = require("request");

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_date=06112015&end_date=07112015', function (apiObject) {


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        console.log(JSON.stringify(apiObject, null, 4));
});

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback){

        var options = { method: 'GET'
                        , uri: apiRequest
                        , timeout: 1000*15
                        , strictSSL: false
                        , rejectUnhauthorized : false
                      };

        request(options, function (error, response, body) {
                if(error){
                        console.log(error);
                        throw error;
                }else{
                     var jsonObject = JSON.parse(body);
                     callback(jsonObject);
                }
        });
}
/*
 *  Install json-c if its not installed
 *  https://github.com/json-c/json-c/wiki
 *
 *  Below is command to install json-c on centos
 *  yum install json-c-devel
 *
 *  Saved this example code to a file named ekm.c
 *  - Compile
 *  gcc ekm.c -o ekm -lcurl  -ljson-c
 *  - Run
 *  ./ekm
 *
 */
// Required Includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h> //your directory may vary depending on your OS
#include <json/json.h> //your directory may vary
// End Includes

// Code reqired for curl
struct string {
    char *data;
    size_t len;
};

void init_string(struct string *response) {
    response->len = 0;
    response->data = (char*)malloc(response->len+1);
    if (response->data == NULL) {
        fprintf(stderr, "malloc() failed\n");
        exit(EXIT_FAILURE);
    }
    response->data[0] = '\0';
}

size_t curlData(void *data, size_t size, size_t nmemb, struct string *response)
{
    size_t new_len = response->len + size*nmemb;
    response->data = (char*)realloc(response->data, new_len+1);
    if (response->data == NULL) {
        fprintf(stderr, "realloc() failed\n");
        exit(EXIT_FAILURE);
    }
    memcpy(response->data+response->len, data, size*nmemb);
    response->data[new_len] = '\0';
    response->len = new_len;

    return size*nmemb;
}
// End required Curl coding

// This function accesses the api URL and converts
// the contents to a usable JSON-C object and returns it
struct json_object* callAPI(const char * url){
    CURL *curl;
    CURLcode res;
    json_object * jsonObject;
    curl = curl_easy_init();
    if(curl) {
        struct string response;
        init_string(&response);

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlData);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        res = curl_easy_perform(curl);
        if(CURLE_OK == res){
            jsonObject = json_tokener_parse(response.data);
        }
        free(response.data);
    }

    curl_easy_cleanup(curl);
    curl_global_cleanup();
    return jsonObject;
}

int main(void)
{

    // Call the callApi function to create a usable
    // object named apiObject from the API request URL.
    // Put the API request URL in the call
    json_object * apiObject = callAPI("https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_date=06112015&end_date=07112015");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here
    json_object * readmeter_json;
    json_object_object_get_ex(apiObject,"readMeter",&readmeter_json);
    printf("Complete readMeter Object: \n%s", json_object_to_json_string_ext(readmeter_json,JSON_C_TO_STRING_PRETTY));

    // This example digs deaper into the JSON and displays the first
    // kwh_tot value for the first read of the first meter
    json_object * readset_json;
    json_object * readset_0_json;
    json_object * readdata_json;
    json_object * readdata_0_json;
    json_object * kwh_tot;
    json_object_object_get_ex(readmeter_json,"ReadSet",&readset_json);
    readset_0_json = json_object_array_get_idx(readset_json,0);
    json_object_object_get_ex(readset_0_json,"ReadData",&readdata_json);
    readdata_0_json = json_object_array_get_idx(readdata_json,0);
    json_object_object_get_ex(readdata_0_json,"kWh_Tot",&kwh_tot);
    printf("\nkWh_Tot: %s", json_object_to_json_string_ext(kwh_tot,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

You can also call the available meter read data for a given meter by a specified date with the following parameters in the https address.

https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=America~Los_Angeles&start_date=DDMMYYYY&end_date=DDMMYYYY

Date Parameter

Parameter Description
dd Indicates the day of the month. Example: 06, for the sixth day of the month.
mm Indicates the month to be called. Example: 11, for the month of November.
yyyy Indicates the year to be called. Example: 2015, for the year 2015.

Let’s say you would like to pull the meter reading data for November 06, 2015 to November 07, 2015. Your https address would look like the following:

https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=America~Los_Angeles&start_date=06112015&end_date=07112015

URL Parameters

Parameter Description
start_date Date for the meter reading to begin. Example of ddmmyyyy is as follows: 06112015 = November 6, 2015
end_date Data for the meter reading to end. Example of ddmmyyyy is as follows: 07112015 = November 7, 2015

Legacy Start Time & End Time

Start Time & End Time

curl -s
"https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500"
# Load required modules
require 'net/http'
require 'json'
require 'uri'

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call

def callApi(api_path)
  uri = URI.parse("https://io.ekmpush.com#{api_path}")
  response = Net::HTTP.get_response(uri)
  puts response.uri
  JSON.parse(response.body)
end

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://io.ekmpush.com
apiObject = callApi('/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500')

# This just displays the object but you can use what ever
# code you would like to work with the object here
require 'pp'
pp apiObject
# Required Python Modules
import urllib.request, urllib.error, urllib.parse
import json

# This function accesses the apiRequest URL and converts
# the contents to a usable Python object and returns it
def callApi ( apiRequest ):
        response = urllib.request.urlopen(apiRequest)
        response = response.read()
        jsonObject = json.loads(response.decode())
        return jsonObject

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
apiObject = callApi("https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500")

# This just displays the object but you can use what ever
# code you would like to work with the object here
import pprint
pprint.pprint(apiObject)
<?php
// Call the callApi function to create a usable
// object named $apiObject from the API request URL.
// Put the API request URL in the call
$apiObject=callApi('https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500');

// This just displays the object but you can use what ever
// code you would like to work with the object here
var_dump($apiObject);

// This function accesses the apiRequest URL and converts
// the contents to a usable PHP object and returns it
function callApi ($apiRequest='') {

        $json=@file_get_contents($apiRequest);
        $jsonObject=json_decode($json);
        return ($jsonObject);

}
?>
# Install JSON module
# for example on centos 6.5
# yum install cpan
# cpan JSON


# Required Perl Modules
use LWP::Simple;
use JSON;
use Data::Dumper;

# This function accesses the apiRequest URL and converts
# the contents to a usable Perl object and returns it
sub callApi{
        my $apiRequest = shift;
        my $json_text = get(q[$apiRequest]);
        my $jsonObject = JSON->new->utf8->decode($json_text);
        return $jsonObject;
}

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
my $apiObject = callApi("https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500");

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($apiObject);
/*
 Download the correct org.json jar version for your
 needs from: https://mvnrepository.com/artifact/org.json/json

 This example uses version 20131018 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20190722/json-20190722.jar

 Instructions to run this program

 1. Put this code in a file named EKM.java
 2. Copy the downloaded org.json jar and EKM.java to the same directory
 3. Compile
  javac -cp .:./json-20190722.jar ./EKM.java
 4. Run
  java -cp .:./json-20190722.jar EKM
*/


//Import required classes
import java.net.*;
import java.io.*;
import org.json.*;

public class EKM {
    public static JSONObject callApi(String apiRequest) throws Exception {

        // This code accesses the apiRequest URL and converts
        // the contents to a usable JSON object

        URL url = new URL(apiRequest);
        URLConnection connection = url.openConnection();
        BufferedReader in = new BufferedReader(
                                               new InputStreamReader(
                                                                     connection.getInputStream()));

        StringBuilder response = new StringBuilder();
        String inputLine;

        while ((inputLine = in.readLine()) != null)
            response.append(inputLine);

        in.close();

        JSONObject jsonObject = new JSONObject(response.toString());
        return jsonObject;
    }

    public static void main(String[] args) throws Exception {
        /*
         Call callApi to create a usable
         object named apiObject from the API request URL.
         Put the API request URL in the call
         */
        JSONObject apiObject = EKM.callApi("https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500");

        /*
         You can access any part of the apiObject using code like this:
         JSONArray  readData = apiObject.getJSONObject("readMeter").getJSONArray("ReadSet").
         getJSONObject(0).getJSONArray("ReadData");
        */

        // This just outputs the whole apiObject
        System.out.println(apiObject.toString(4));
    }
}
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">

// The example function is called from the
// body tag when the page loads
function example(){

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500',function(apiObject){

       // This just displays the object in the result div
       // you can use what ever code you would like to work
       // with the object here
       document.getElementById("result").innerHTML = "<pre>"+JSON.stringify(apiObject, null, 4)+"</pre>";
       });

};

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback) {
    var xhttp = new XMLHttpRequest();
    xhttp.onreadystatechange = function() {
      if (xhttp.readyState == 4 && xhttp.status == 200) {
        var jsonObject = JSON.parse(xhttp.responseText);
        callback(jsonObject);
      }
    };
    xhttp.open("GET", apiRequest, true);
    xhttp.send();
}
</script>

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
// NodeJS requires the "request" module to access the API
// Install by running "npm install request" from the shell prompt

// Load "request" module
var request = require("request");

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500', function (apiObject) {


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        console.log(JSON.stringify(apiObject, null, 4));
});

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback){

        var options = { method: 'GET'
                        , uri: apiRequest
                        , timeout: 1000*15
                        , strictSSL: false
                        , rejectUnhauthorized : false
                      };

        request(options, function (error, response, body) {
                if(error){
                        console.log(error);
                        throw error;
                }else{
                     var jsonObject = JSON.parse(body);
                     callback(jsonObject);
                }
        });
}
/*
 *  Install json-c if its not installed
 *  https://github.com/json-c/json-c/wiki
 *
 *  Below is command to install json-c on centos
 *  yum install json-c-devel
 *
 *  Saved this example code to a file named ekm.c
 *  - Compile
 *  gcc ekm.c -o ekm -lcurl  -ljson-c
 *  - Run
 *  ./ekm
 *
 */
// Required Includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h> //your directory may vary depending on your OS
#include <json/json.h> //your directory may vary
// End Includes

// Code reqired for curl
struct string {
    char *data;
    size_t len;
};

void init_string(struct string *response) {
    response->len = 0;
    response->data = (char*)malloc(response->len+1);
    if (response->data == NULL) {
        fprintf(stderr, "malloc() failed\n");
        exit(EXIT_FAILURE);
    }
    response->data[0] = '\0';
}

size_t curlData(void *data, size_t size, size_t nmemb, struct string *response)
{
    size_t new_len = response->len + size*nmemb;
    response->data = (char*)realloc(response->data, new_len+1);
    if (response->data == NULL) {
        fprintf(stderr, "realloc() failed\n");
        exit(EXIT_FAILURE);
    }
    memcpy(response->data+response->len, data, size*nmemb);
    response->data[new_len] = '\0';
    response->len = new_len;

    return size*nmemb;
}
// End required Curl coding

// This function accesses the api URL and converts
// the contents to a usable JSON-C object and returns it
struct json_object* callAPI(const char * url){
    CURL *curl;
    CURLcode res;
    json_object * jsonObject;
    curl = curl_easy_init();
    if(curl) {
        struct string response;
        init_string(&response);

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlData);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        res = curl_easy_perform(curl);
        if(CURLE_OK == res){
            jsonObject = json_tokener_parse(response.data);
        }
        free(response.data);
    }

    curl_easy_cleanup(curl);
    curl_global_cleanup();
    return jsonObject;
}

int main(void)
{

    // Call the callApi function to create a usable
    // object named apiObject from the API request URL.
    // Put the API request URL in the call
    json_object * apiObject = callAPI("https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here
    json_object * readmeter_json;
    json_object_object_get_ex(apiObject,"readMeter",&readmeter_json);
    printf("Complete readMeter Object: \n%s", json_object_to_json_string_ext(readmeter_json,JSON_C_TO_STRING_PRETTY));

    // This example digs deaper into the JSON and displays the first
    // kwh_tot value for the first read of the first meter
    json_object * readset_json;
    json_object * readset_0_json;
    json_object * readdata_json;
    json_object * readdata_0_json;
    json_object * kwh_tot;
    json_object_object_get_ex(readmeter_json,"ReadSet",&readset_json);
    readset_0_json = json_object_array_get_idx(readset_json,0);
    json_object_object_get_ex(readset_0_json,"ReadData",&readdata_json);
    readdata_0_json = json_object_array_get_idx(readdata_json,0);
    json_object_object_get_ex(readdata_0_json,"kWh_Tot",&kwh_tot);
    printf("\nkWh_Tot: %s", json_object_to_json_string_ext(kwh_tot,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

You can also call the available meter read data for a given meter by a specified time when using start_date and end_date with the following https parameters

This format is similar to the start and end date https request.

https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=America~Los_Angeles&start_date=30042015&start_time=HHMMSS&end_time=HHMMSS

Time Parameters

Parameter Description
hh Indicates the hours of the day. Example: 0600, for 6:00 A.M. or 13:00, for 1:00 P.M.
mm Indicates the minutes of the hour. Example: 0624, for 24 minutes into the hour of 6:00 A.M. or 6:24 A.M.
ss Indicates the seconds of the minute. Example: 062430, for 30 seconds into the minute of 24, or 6:24.30 A.M.

If you want to pull the meter reading data for a specific period of the day, let’s say for 062400 A.M. to 062500 A.M., then your https address would look like the following:

https://io.ekmpush.com/readMeter??meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500


You can also call data from any number of seconds ago. The example below will call all available data from 300 seconds ago.

Instead of adding the start_time and end_time parameter use the back=seconds parameter.

https://io.ekmpush.com/readMeter?meters=300001290&ver=v4&key=MTAxMDoyMDIw&fmt=html&cnt=1000&tz=America~Los_Angeles&back=300

Click to try


URL Parameters

Parameter Description
start_time Time to begin the data call. Format in which the time is written in: hhmmss - hours, minutes, seconds. Example: 062400 = 6:24.00 A.M.
end_time Time to end the data call. Format in which the time is written in: hhmmss- hours, minutes, seconds. Example: 062500 = 6:25.00 A.M.
back Time in seconds, up to 300 seconds

Legacy Fields

Fields

curl -s
"https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot"
# Load required modules
require 'net/http'
require 'json'
require 'uri'

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call

def callApi(api_path)
  uri = URI.parse("https://io.ekmpush.com#{api_path}")
  response = Net::HTTP.get_response(uri)
  puts response.uri
  JSON.parse(response.body)
end

# Call the callApi method to create a usable
# object named apiObject from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://io.ekmpush.com
apiObject = callApi('/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot')

# This just displays the object but you can use what ever
# code you would like to work with the object here
require 'pp'
pp apiObject
# Required Python Modules
import urllib.request, urllib.error, urllib.parse
import json

# This function accesses the apiRequest URL and converts
# the contents to a usable Python object and returns it
def callApi ( apiRequest ):
        response = urllib.request.urlopen(apiRequest)
        response = response.read()
        jsonObject = json.loads(response.decode())
        return jsonObject

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot")

# This just displays the object but you can use what ever
# code you would like to work with the object here
import pprint
pprint.pprint(apiObject)
<?php
// Call the callApi function to create a usable
// object named $apiObject from the API request URL.
// Put the API request URL in the call
$apiObject=callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot');

// This just displays the object but you can use what ever
// code you would like to work with the object here
var_dump($apiObject);

// This function accesses the apiRequest URL and converts
// the contents to a usable PHP object and returns it
function callApi ($apiRequest='') {

        $json=@file_get_contents($apiRequest);
        $jsonObject=json_decode($json);
        return ($jsonObject);

}
?>

# Install JSON module
# for example on centos 6.5
# yum install cpan
# cpan JSON


# Required Perl Modules
use LWP::Simple;
use JSON;
use Data::Dumper;

# This function accesses the apiRequest URL and converts
# the contents to a usable Perl object and returns it
sub callApi{
        my $apiRequest = shift;
        my $json_text = get(q[$apiRequest]);
        my $jsonObject = JSON->new->utf8->decode($json_text);
        return $jsonObject;
}

# Call the callApi function to create a usable
# object named apiObject from the API request URL.
# Put the API request URL in the call
my $apiObject = callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot");

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($apiObject);
/*
 Download the correct org.json jar version for your
 needs from: https://mvnrepository.com/artifact/org.json/json

 This example uses version 20131018 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20190722/json-20190722.jar

 Instructions to run this program

 1. Put this code in a file named EKM.java
 2. Copy the downloaded org.json jar and EKM.java to the same directory
 3. Compile
  javac -cp .:./json-20190722.jar ./EKM.java
 4. Run
  java -cp .:./json-20190722.jar EKM
*/


//Import required classes
import java.net.*;
import java.io.*;
import org.json.*;

public class EKM {
    public static JSONObject callApi(String apiRequest) throws Exception {

        // This code accesses the apiRequest URL and converts
        // the contents to a usable JSON object

        URL url = new URL(apiRequest);
        URLConnection connection = url.openConnection();
        BufferedReader in = new BufferedReader(
                                               new InputStreamReader(
                                                                     connection.getInputStream()));

        StringBuilder response = new StringBuilder();
        String inputLine;

        while ((inputLine = in.readLine()) != null)
            response.append(inputLine);

        in.close();

        JSONObject jsonObject = new JSONObject(response.toString());
        return jsonObject;
    }

    public static void main(String[] args) throws Exception {
        /*
         Call callApi to create a usable
         object named apiObject from the API request URL.
         Put the API request URL in the call
         */
        JSONObject apiObject = EKM.callApi("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot");

        /*
         You can access any part of the apiObject using code like this:
         JSONArray  readData = apiObject.getJSONObject("readMeter").getJSONArray("ReadSet").
         getJSONObject(0).getJSONArray("ReadData");
        */

        // This just outputs the whole apiObject
        System.out.println(apiObject.toString(4));
    }
}
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">

// The example function is called from the
// body tag when the page loads
function example(){

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot',function(apiObject){

       // This just displays the object in the result div
       // you can use what ever code you would like to work
       // with the object here
       document.getElementById("result").innerHTML = "<pre>"+JSON.stringify(apiObject, null, 4)+"</pre>";
       });

};

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback) {
    var xhttp = new XMLHttpRequest();
    xhttp.onreadystatechange = function() {
      if (xhttp.readyState == 4 && xhttp.status == 200) {
        var jsonObject = JSON.parse(xhttp.responseText);
        callback(jsonObject);
      }
    };
    xhttp.open("GET", apiRequest, true);
    xhttp.send();
}
</script>

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
// NodeJS requires the "request" module to access the API
// Install by running "npm install request" from the shell prompt

// Load "request" module
var request = require("request");

// Call the callApi function to create a usable
// object named apiObject from the API request URL.
// Put the API request URL in the call
callApi('https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot', function (apiObject) {


        // This just displays the object but you can use what ever
        // code you would like to work with the object here
        console.log(JSON.stringify(apiObject, null, 4));
});

// This code accesses the apiRequest URL and converts
// the contents to a usable JSON object named apiObject
function callApi(apiRequest,callback){

        var options = { method: 'GET'
                        , uri: apiRequest
                        , timeout: 1000*15
                        , strictSSL: false
                        , rejectUnhauthorized : false
                      };

        request(options, function (error, response, body) {
                if(error){
                        console.log(error);
                        throw error;
                }else{
                     var jsonObject = JSON.parse(body);
                     callback(jsonObject);
                }
        });
}
/*
 *  Install json-c if its not installed
 *  https://github.com/json-c/json-c/wiki
 *
 *  Below is command to install json-c on centos
 *  yum install json-c-devel
 *
 *  Saved this example code to a file named ekm.c
 *  - Compile
 *  gcc ekm.c -o ekm -lcurl  -ljson-c
 *  - Run
 *  ./ekm
 *
 */
// Required Includes
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h> //your directory may vary depending on your OS
#include <json/json.h> //your directory may vary
// End Includes

// Code reqired for curl
struct string {
    char *data;
    size_t len;
};

void init_string(struct string *response) {
    response->len = 0;
    response->data = (char*)malloc(response->len+1);
    if (response->data == NULL) {
        fprintf(stderr, "malloc() failed\n");
        exit(EXIT_FAILURE);
    }
    response->data[0] = '\0';
}

size_t curlData(void *data, size_t size, size_t nmemb, struct string *response)
{
    size_t new_len = response->len + size*nmemb;
    response->data = (char*)realloc(response->data, new_len+1);
    if (response->data == NULL) {
        fprintf(stderr, "realloc() failed\n");
        exit(EXIT_FAILURE);
    }
    memcpy(response->data+response->len, data, size*nmemb);
    response->data[new_len] = '\0';
    response->len = new_len;

    return size*nmemb;
}
// End required Curl coding

// This function accesses the api URL and converts
// the contents to a usable JSON-C object and returns it
struct json_object* callAPI(const char * url){
    CURL *curl;
    CURLcode res;
    json_object * jsonObject;
    curl = curl_easy_init();
    if(curl) {
        struct string response;
        init_string(&response);

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlData);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        res = curl_easy_perform(curl);
        if(CURLE_OK == res){
            jsonObject = json_tokener_parse(response.data);
        }
        free(response.data);
    }

    curl_easy_cleanup(curl);
    curl_global_cleanup();
    return jsonObject;
}

int main(void)
{

    // Call the callApi function to create a usable
    // object named apiObject from the API request URL.
    // Put the API request URL in the call
    json_object * apiObject = callAPI("https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here
    json_object * readmeter_json;
    json_object_object_get_ex(apiObject,"readMeter",&readmeter_json);
    printf("Complete readMeter Object: \n%s", json_object_to_json_string_ext(readmeter_json,JSON_C_TO_STRING_PRETTY));

    // This example digs deaper into the JSON and displays the first
    // kwh_tot value for the first read of the first meter
    json_object * readset_json;
    json_object * readset_0_json;
    json_object * readdata_json;
    json_object * readdata_0_json;
    json_object * kwh_tot;
    json_object_object_get_ex(readmeter_json,"ReadSet",&readset_json);
    readset_0_json = json_object_array_get_idx(readset_json,0);
    json_object_object_get_ex(readset_0_json,"ReadData",&readdata_json);
    readdata_0_json = json_object_array_get_idx(readdata_json,0);
    json_object_object_get_ex(readdata_0_json,"kWh_Tot",&kwh_tot);
    printf("\nkWh_Tot: %s", json_object_to_json_string_ext(kwh_tot,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

You can filter for just the data fields you are interested in by using fields=FIELDS, after the time zone call parameter.

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=America~Los_Angeles&fields=FIELDS


In the example below we are only interested in finding out the Total Kilowatt Hours, Reverse kWh, and Total Watts. To retrieve the data associated with the different fields use the abbreviated name of the field you are interested in after the fields parameter, followed by a tilde separator if calling for more than one field.

https://io.ekmpush.com/readMeter?meters=17507&ver=v3&key=MTAxMDoyMDIw&fmt=html&cnt=10&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot

Click to try


The data fields that you are interested in is not limited to these three in the example above. You can add just one field or include as many as your needs require.

URL Parameters

The fields below are for the v3 and v4 meters

Fields Description
kWh_Tot Total Kilowatt Hour
kWh_Tariff_1 Kilowatt Hour for Tariff 1
kWh_Tariff_2 Kilowatt Hour for Tariff 2
kWh_Tariff_3 Kilowatt Hour for Tariff 3
kWh_Tariff_4 Kilowatt Hour for Tariff 4
Rev_kWh_Tot Total Reverse Kilowatt Hour
Rev_kWh_Tariff_1 Reverse Kilowatt Hour for Tariff 1
Rev_kWh_Tariff_2 Reverse Kilowatt Hour for Tariff 2
Rev_kWh_Tariff_3 Reverse Kilowatt Hour for Tariff 3
Rev_kWh_Tariff_4 Reverse Kilowatt Hour for Tariff 4
RMS_Volts_Ln_1 Root-Mean-Squared Volts on line 1
RMS_Volts_Ln_2 Root-Mean-Squared Volts on line 2
RMS_Volts_Ln_3 Root-Mean-Squared Volts on line 3
Amps_Ln_1 Amps on line 1
Amps_Ln_2 Amps on line 2
Amps_Ln_3 Amps on line 3
Power_Factor_Ln_1 Power Factor on line 1
Power_Factor_Ln_2 Power Factor on line 2
Power_Factor_Ln_3 Power Factor on line 3
RMS_Watts_Ln_1 Root-Mean-Squared Watts on line 1
RMS_Watts_Ln_2 Root-Mean-Squared Watts on line 2
RMS_Watts_Ln_3 Root-Mean-Squared Watts on line 3
RMS_Watts_Tot Total Watts (all lines)
RMS_Watts_Max_Demand Max Demand
Max_Demand_Period Max Demand Period
15 min = 1
30 min = 2
Hour = 3
CT_Ratio Current Transformer Ratio

The fields below are additional fields only for the v4 meter

Fields Description
Pulse_Cnt_1 Pulse Count on input 1
Pulse_Cnt_2 Pulse Count on input 2
Pulse_Cnt_3 Pulse Count on input 3
Pulse_Ratio_1 Pulse Input Ratio on input 1
Pulse_Ratio_2 Pulse Input Ratio on input 2
Pulse_Ratio_3 Pulse Input Ratio on input 3
State_In State of Inputs
Line1/Line2/Line3
High/High/High = 0
High/High/Low = 1
High/Low/High = 2
High/Low/Low = 3
Low/High/High = 4
Low/High/Low = 5
Low/Low/High = 6
Low/Low/Low = 7
Reactive_Energy_Tot Total Kilo Volt Amperes Reactive Hours
kWh_Rst Resettable Kilowatt Hour
Rev_kWh_Rst Resettable Reverse Kilowatt Hour
kWh_Scale Decimal places for Kilowatt Hour
0 Decimal Places = 0
1 Decimal Place = 1
2 Decimal Places = 2
Reactive_Pwr_Ln_1 Volt-Amperes Reactive on line 1
Reactive_Pwr_Ln_2 Volt-Amperes Reactive on line 2
Reactive_Pwr_Ln_3 Volt-Amperes Reactive on line 3
Reactive_Pwr_Tot Total Volt-Amperes Reactive
Line_Freq Frequency (Hz)
State_Watts_Dir Real-time Direction of Current
Line1/Line2/Line3
Forward/Forward/Forward = 1
Forward/Forward/Reverse = 2
Forward/Reverse/Forward = 3
Reverse/Forward/Forward = 4
Forward/Reverse/Reverse = 5
Reverse/Forward/Reverse = 6
Reverse/Reverse/Forward = 7
Reverse/Reverse/Reverse = 8
State_Out State of Outputs
OFF/OFF = 1
OFF/ON = 2
ON/OFF = 3
ON/ON = 4
kWh_Ln_1 Total Kilowatt Hour on line 1
kWh_Ln_2 Total Kilowatt Hour on line 2
kWh_Ln_3 Total Kilowatt Hour on line 3
Rev_kWh_Ln_1 Reverse Kilowatt Hour on line 1
Rev_kWh_Ln_2 Reverse Kilowatt Hour on line 2
Rev_kWh_Ln_3 Reverse Kilowatt Hour on line 3
Max_Demand_Rst Max Demand Auto Reset Status
OFF = 0
Monthly = 1
Weekly = 2
Daily = 3
Hourly = 4
Net_Calc_Watts_Ln_1 Net Watts on line 1
Net_Calc_Watts_Ln_2 Net Watts on line 2
Net_Calc_Watts_Ln_3 Net Watts on line 3
Net_Calc_Watts_Tot Total Net Watts
CF_Ratio Settable Pulse Output Ratio (Crest Factor Ratio)

Realtime API

Click here to go to Realtime Documentation

If you are developing your own app, cloud-to-cloud solution, billing system, or other SAS solution, our Real-Time API allows you to easily access your EKM Push data in any format that you need. Below you will find descriptions regarding how to access the data, and about the filters you can apply so the data comes to you in a format that is easily digested and inserted into your software solution.

The real-time API provides the 1000 latest meter reads for each of your meters. If your meter is being read once per minute, the data will be made available once per minute, per meter. Whether you have 1 meter or 10,000 meters, this is the easiest and most scalable way to access your data.

The EKM Dash, EKM Widget, encompass.io, wattvision.com, pvoutput.org, the other solutions in our Push App Store, as well as other customers that have their own custom solutions, all use this API to access their data. We use the same API as you and do not give ourselves any special permissions, we see what you see, which forces us to make the API as great as possible for everyone. We have even given you code examples that can be copy and pasted into your own software language to make the data access that much easier.

Use the API definition, metered values definition, code snippet suggestion, and guide to get you on your way to developing your next killer app. If you create something great, let us know; we’re open to adding all useful apps into the Push App Store.

We also have a Realtime API Request Builder Tool found here: https://apibuilder.ekmmetering.com

We also have Documentation for our Legacy Realtime API here: Legacy Realtime API

Summary API

Click here to go to Summary Documentation

Our Summary API takes every Real-Time read, over 15 minute time periods, and summarizes them into single 15 minute summaries. We store this data forever to provide a long term historical dataset for each meter. Our system can then combine these summaries together to summarize hours, days, weeks, and months. This dataset is often the best way to get historical values like kWh, pulse counts, etc. It also provides averages, min. and max. values, difference, and more. We make this data available to you via our Summary API in a very similar way to our Real-Time API.

You can use the Summary API definition to access the data you need, from 15 minutes to years of data. We have gone to great lengths to provide this data for free in order to add value to our metering systems. The Summary API, the Real-Time API, great affordable hardware, and scalable access to your data are all components of the most powerful, and highest value metering system available in the world.

We also have a Summary API Request Builder Tool found here: https://apibuilder.ekmmetering.com/summary.html

RS-485 Communications

Click here to go to RS-485 Documentation

This section is for developers, or individuals, that want to communicate with their EKM Meters directly using their own software or embedded solution.

The code examples found in this section are in the simplest possible method to get you started. You are welcome to make them more robust.

First we start you out just connecting to the meter. You will find there is a very simple command line process to help you get started.

After that we cover the CRC method required for most communication to the meter.

Then we put it all together, in a simple test script that will show reads, and also open and close the relays.

Last we cover how to convert the 255 character strings that the meter responds with to a usable array containing field names and their values. It is our hope that after you go through these steps you will have all the information you need, to build whatever tools you like to access the meter.

Our meters use an IEC 62056-21 communication standard that has been optimized for our own needs. We are more than happy to share this with you. With this you can write your own software or embedded solution to access your meter data.

IEC 62056 is a set of standards for Electricity metering data exchange by International Electrotechnical Commission.

To learn more about the IEC 62056 standard click the button below to visit the WikiPedia website.

Additional PDF docs are available:

v.3 Meter Settings Protocol

v.3 Meter Parsing

v.4 Meter Settings Protocol

v.4 Meter Parsing

v.4 Meter Alternate Modbus Protocol

If you are coding in Python you can also make use of our ekmmeters.py API.

Errors

EKM uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided, and codes in the 5xx range indicate an error with EKM’s servers (these are rare). Not all errors map cleanly onto HTTP response codes, however. When a request is valid but does not complete successfully, we return a 402 error code.

The EKM API uses the following error codes:

Error Code Meaning
400 Bad Request – Your request is invalid
401 Unauthorized – Your API key is wrong
402 Request Failed – The parameters were valid but the request failed.
403 Forbidden – The meter requested is hidden for administrators only
404 Not Found – The specified meter could not be found
405 Method Not Allowed – You tried to access a meter with an invalid method
406 Not Acceptable – You requested a format that isn’t html, xml, csv or json
410 Gone – The meter requested has been removed from our servers
418 Unknown
429 Too Many Requests – You’re requesting too many meter readings! Slow down!
500 Internal Server Error – We had a problem with our server. Try again later.
502 Bad Gateway – The proxy server received an invalid response
503 Service Unavailable – We’re temporarily offline for maintenance. Please try again later.