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

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

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

Summary HTTPS Request

Summary API request example

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&fields=kWh_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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&fields=kWh_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


#json_object * kwh_tot_max;
#summary = json_object_array_get_idx(apiObject,0);
#json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
#printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));

# This example digs deeper into the JSON and displays the first
# kwh_tot_max value for the first summary read
summary = apiObject[0]
kwh_tot_max = summary['kWh_Tot_Max']
pp "kWh_Tot_Max: #{kwh_tot_max}"

# 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&fields=kWh_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)

# This example digs deeper into the JSON and displays the first
# kwh_tot_max value for the first summary read
summary = apiObject[0]
kwh_tot_max = summary['kWh_Tot_Max']
print("kWh_Tot_Max: ", kwh_tot_max)

<?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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&fields=kWh_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 example digs deeper into the JSON and displays the first
// kwh_tot_max value for the first summary read
$summary = $apiObject[0];
$kwh_tot_max = $summary->kWh_Tot_Max;
echo "kWh_Tot_Max: $kwh_tot_max";


// 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&fields=kWh_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);

# This example digs deeper into the JSON and displays the first
# kwh_tot_max value for the first summary read
my $summary = $apiObject->[0];
my $kwh_tot_max = $summary->{kWh_Tot_Max};
print "kWh_Tot_Max: $kwh_tot_max";
/*
 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 JSONArray 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();

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

    public static void main(String[] args) throws Exception {
        // Call the callApi function to create a usable
        // object named apiObject from the API request URL.
        // Put the API request URL in the call
        JSONArray apiObject = EKM.callApi("https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&fields=kWh_Tot*");

        // 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 deeper into the JSON and displays the first
        // kwh_tot_max value for the first summary read
        JSONObject summary = apiObject.getJSONObject(0);
        Object kwh_tot_max = summary.get("kWh_Tot_Max");
        System.out.println("kWh_Tot_Max: " + kwh_tot_max);

    }
}

<!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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&fields=kWh_Tot*',function(apiObject){
      //document.getElementById("result2").innerHTML = "<pre>hello</pre>"; 
      // 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 deeper into the JSON and displays the first
      // kwh_tot_max value for the first summary read
      summary = apiObject[0];
      kwh_tot_max = summary["kWh_Tot_Max"];
      document.getElementById("kwh_tot_max").innerHTML = "<pre>kWh_Tot_Max: "+kwh_tot_max+"</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_max"> </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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&fields=kWh_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 example digs deeper into the JSON and displays the first
        // kwh_tot_max value for the first summary read
        summary = apiObject[0];
        kwh_tot_max = summary["kWh_Tot_Max"];
        console.log("kWh_Tot_Max: " + kwh_tot_max);



});

// 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&fields=kWh_Tot*");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deeper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));     

    return 0;
}

The above example returns the following results:


[
   {
      "Start_Time_Stamp_UTC_ms": 1477413208860,
      "End_Time_Stamp_UTC_ms": 1477413899852,
      "End_Date": "Tue Oct 25 2016 16:44:59 GMT+0000 (GMT)",
      "Start_Date": "Tue Oct 25 2016 16:33:28 GMT+0000 (GMT)",
      "Meter": "17507",
      "Protocol": "v3",
      "Count": 692,
      "kWh_Tot_DeltaMin": 0,
      "kWh_Tot_DeltaMax": 0.1,
      "kWh_Tot_Min": 121523.2,
      "kWh_Tot_Max": 121523.5,
      "kWh_Tot_Diff": 0.3
   }
]


[{"Start_Time_Stamp_UTC_ms"=>1477413208860,
  "End_Time_Stamp_UTC_ms"=>1477413899852,
  "End_Date"=>"Tue Oct 25 2016 16:44:59 GMT+0000 (GMT)",
  "Start_Date"=>"Tue Oct 25 2016 16:33:28 GMT+0000 (GMT)",
  "Meter"=>17507,
  "Protocol"=>"v3",
  "Count"=>692,
  "rejected_bad"=>0,
  "rejected_duplicates"=>0,
  "kWh_Tot_DeltaMin"=>0,
  "kWh_Tot_DeltaMax"=>0.1,
  "kWh_Tot_Min"=>121523.2,
  "kWh_Tot_Max"=>121523.5,
  "kWh_Tot_Diff"=>0.3}]
"kWh_Tot_Max: 121523.5"


[{u'Count': 692,
  u'End_Date': u'Tue Oct 25 2016 16:44:59 GMT+0000 (GMT)',
  u'End_Time_Stamp_UTC_ms': 1477413899852,
  u'Meter': 17507,
  u'Protocol': u'v3',
  u'Start_Date': u'Tue Oct 25 2016 16:33:28 GMT+0000 (GMT)',
  u'Start_Time_Stamp_UTC_ms': 1477413208860,
  u'kWh_Tot_DeltaMax': 0.10000000000000001,
  u'kWh_Tot_DeltaMin': 0,
  u'kWh_Tot_Diff': 0.29999999999999999,
  u'kWh_Tot_Max': 121523.5,
  u'kWh_Tot_Min': 121523.2,
  u'rejected_bad': 0,
  u'rejected_duplicates': 0}]
kWh_Tot_Max:  121523.5


array(1) {
  [0]=>
  object(stdClass)#1 (14) {
    ["Start_Time_Stamp_UTC_ms"]=>
    int(1477413208860)
    ["End_Time_Stamp_UTC_ms"]=>
    int(1477413899852)
    ["End_Date"]=>
    string(39) "Tue Oct 25 2016 16:44:59 GMT+0000 (GMT)"
    ["Start_Date"]=>
    string(39) "Tue Oct 25 2016 16:33:28 GMT+0000 (GMT)"
    ["Meter"]=>
    int(17507)
    ["Protocol"]=>
    string(2) "v3"
    ["Count"]=>
    int(692)
    ["rejected_bad"]=>
    int(0)
    ["rejected_duplicates"]=>
    int(0)
    ["kWh_Tot_DeltaMin"]=>
    int(0)
    ["kWh_Tot_DeltaMax"]=>
    float(0.1)
    ["kWh_Tot_Min"]=>
    float(121523.2)
    ["kWh_Tot_Max"]=>
    float(121523.5)
    ["kWh_Tot_Diff"]=>
    float(0.2)
  }
}
kWh_Tot_Max: 121523.5

$VAR1 = [
          {
            'End_Time_Stamp_UTC_ms' => '1477413899852',
            'Start_Date' => 'Tue Oct 25 2016 16:33:28 GMT+0000 (GMT)',
            'End_Date' => 'Tue Oct 25 2016 16:44:59 GMT+0000 (GMT)',
            'kWh_Tot_Min' => '121523.2',
            'kWh_Tot_DeltaMin' => 0,
            'Start_Time_Stamp_UTC_ms' => '1477413208860',
            'rejected_duplicates' => 0,
            'rejected_bad' => 0,
            'kWh_Tot_Max' => '121523.5',
            'Count' => 692,
            'kWh_Tot_Diff' => '0.3',
            'Meter' => 17507,
            'Protocol' => 'v3',
            'kWh_Tot_DeltaMax' => '0.1'
          }
        ];
kWh_Tot_Max: 121523.5

[{
    "Meter": 17507,
    "Count": 692,
    "End_Time_Stamp_UTC_ms": 1477413899852,
    "End_Date": "Tue Oct 25 2016 16:44:59 GMT+0000 (GMT)",
    "kWh_Tot_Diff": 0.3,
    "kWh_Tot_DeltaMin": 0,
    "kWh_Tot_DeltaMax": 0.1,
    "rejected_duplicates": 0,
    "Start_Date": "Tue Oct 25 2016 16:33:28 GMT+0000 (GMT)",
    "rejected_bad": 0,
    "kWh_Tot_Max": 121523.5,
    "Start_Time_Stamp_UTC_ms": 1477413208860,
    "kWh_Tot_Min": 121523.2,
    "Protocol": "v3"
}]
kWh_Tot_Max: 121523.5


[
    {
        "Start_Time_Stamp_UTC_ms": 1477413208860,
        "End_Time_Stamp_UTC_ms": 1477413899852,
        "End_Date": "Tue Oct 25 2016 16:44:59 GMT+0000 (GMT)",
        "Start_Date": "Tue Oct 25 2016 16:33:28 GMT+0000 (GMT)",
        "Meter": 17507,
        "Protocol": "v3",
        "Count": 692,
        "rejected_bad": 0,
        "rejected_duplicates": 0,
        "kWh_Tot_DeltaMin": 0,
        "kWh_Tot_DeltaMax": 0.1,
        "kWh_Tot_Min": 121523.2,
        "kWh_Tot_Max": 121523.5,
        "kWh_Tot_Diff": 0.3
    }
]
kWh_Tot_Max: 121523.5


[
    {
        "Start_Time_Stamp_UTC_ms": 1477413208860,
        "End_Time_Stamp_UTC_ms": 1477413899852,
        "End_Date": "Tue Oct 25 2016 16:44:59 GMT+0000 (GMT)",
        "Start_Date": "Tue Oct 25 2016 16:33:28 GMT+0000 (GMT)",
        "Meter": 17507,
        "Protocol": "v3",
        "Count": 692,
        "rejected_bad": 0,
        "rejected_duplicates": 0,
        "kWh_Tot_DeltaMin": 0,
        "kWh_Tot_DeltaMax": 0.1,
        "kWh_Tot_Min": 121523.2,
        "kWh_Tot_Max": 121523.5,
        "kWh_Tot_Diff": 0.3
    }
]
kWh_Tot_Max: 121523.5


{
  "Start_Time_Stamp_UTC_ms":1477413208860,
  "End_Time_Stamp_UTC_ms":1477413899852,
  "End_Date":"Tue Oct 25 2016 16:44:59 GMT+0000 (GMT)",
  "Start_Date":"Tue Oct 25 2016 16:33:28 GMT+0000 (GMT)",
  "Meter":"17507",
  "Protocol":"v3",
  "Count": 692,
  "kWh_Tot_DeltaMin":0,
  "kWh_Tot_DeltaMax":0.100000,
  "kWh_Tot_Min":121523.200000,
  "kWh_Tot_Max":121523.500000,
  "kWh_Tot_Diff":0.300000
}
kWh_Tot_Max: 121523.500000

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

https://summary.ekmpush.com/summary?

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

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

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=1&field=kWh_Tot*

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

https Address Description
https://summary.ekmpush.com/summary? Beginning of the https address
meters Parameter for calling the meter
17507 Exact meter to call
key Parameter for calling the key
MTAxMDoyMDIw EKM Push authorization key that is assigned to the meter
format Parameter for calling the file format to return as
html Language format to return the data as (html, xml, json, csv)
report Parameter for calling a specific time period
15 This will show 15 minute summary result increments. This is also the default time period number that the Summary API uses to return the results in if the report parameter is not specified
limit Parameter that sets the number of rows to show in the report
1 This will only show one row in the summary report. The default number is ten ( 10 ) that will show in the report if the limit parameter is not specified
field Parameter for calling specific fields in the report
kWh_Tot* Type of field to display in the summary results. An asterisk ( * ) will be included at the end of each field type if you are wanting to include all values in that field. Example: Calling the kWh_Tot* parameter will include the DeltaMin, DeltaMax, Min, Max and Diff values for the associated field.

Summary Meter Number and Key

The EKM Summary Meter Number is the number of your meter that you have in service. In the following examples of this Summary API document, we will be using the meter number 17507 in all of our https calls. To use your own meter number simply replace the example meter number, 17507, with your own meter number.

The EKM Summary Key is the same Authorization Key that you received for your Realtime EKM Push Account. In the following examples of this Summary 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.

Summary 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://summary.ekmpush.com/summary?meters=300000369&key=MTExOjExMQ&format=json&report=15&limit=5&fields=kWh_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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=300000369&ver=v4&key=MTExOjExMQ&fmt=json&')

# 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://summary.ekmpush.com/summary?meters=300000369&key=MTExOjExMQ&format=json&report=15&limit=5&fields=kWh_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://summary.ekmpush.com/summary?meters=300000369&key=MTExOjExMQ&format=json&report=15&limit=5&fields=kWh_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://summary.ekmpush.com/summary?meters=300000369&key=MTExOjExMQ&format=json&report=15&limit=5&fields=kWh_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 JSONArray 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();

        JSONArray jsonObject = new JSONArray(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
         */
        JSONArray apiObject = EKM.callApi("https://summary.ekmpush.com/summary?meters=300000369&key=MTExOjExMQ&format=json&report=15&limit=5&fields=kWh_Tot*");

        /*
         You can access any part of the apiObject using code like this:
         String Protocol = apiObject.getJSONObject(0).getString("Protocol");
        */

    // 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://summary.ekmpush.com/summary?meters=300000369&key=MTExOjExMQ&format=json&report=15&limit=5&fields=kWh_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://summary.ekmpush.com/summary?meters=300000369&key=MTExOjExMQ&format=json&report=15&limit=5&fields=kWh_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://summary.ekmpush.com/summary?meters=300000369&key=MTExOjExMQ&format=json&report=15&limit=5&fields=kWh_Tot*");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,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://summary.ekmpush.com/summary?meters=300000369&key=MTExOjExMQ&format=html&report=15&limit=5&fields=kWh_Tot*

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

https://summary.ekmpush.com/summary?meters=300000369&key=MTExOjExMQ&format=html&report=15&limit=5&fields=kWh_Tot*

Click to try


URL Parameters

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

Summary Query Multiple Meters

Aggregate

Query Multiple Meters

curl -s
"https://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_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) t15ows 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) t15ows 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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_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);
                        t15ow 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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_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 deeper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));     

    return 0;
}

To see multiple meters in your summary report, for example: meters 17507 and 15635, your https address should look like the following:

https://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*

Click to try


As you can see in the example above, all that is changed to the https address is the addition of the extra meter to the end of the meters parameter: 17507~15635.

The example below is the same as above except it is using a comma ( , ) to separate the meter numbers.

https://summary.ekmpush.com/summary?meters=17507,15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*

This will allow you to call multiple meters to get their reports.

Bulk

Bulk

curl -s
"https://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*&bulk=1"
# 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('summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*&bulk=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
 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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*&bulk=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)
<?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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*&bulk=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 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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_Tot*&bulk=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);
/*
 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) t15ows 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) t15ows 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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*&bulk=1");

        /*
         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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*&bulk=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 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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*&bulk=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 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);
                        t15ow 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://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=json&report=15&limit=5&fields=kWh_Tot*&bulk=1");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deeper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));     

    return 0;
}

The Bulk parameter is to override the default action to aggregate all meters in a group.

If Bulk is set, then all meters are reported separately as a bulk dump.


The Bulk parameter can be set to zero ( 0 ) or one ( 1 ) if including it in your https address. If the parameter is not included in the address then the summary results will default it to zero ( 0 ) and will aggregate the meters in the report and display it as a combined summary.

https://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*&bulk=BULK

https://summary.ekmpush.com/summary?meters=17507~15635&key=MTAxMDoyMDIw&format=html&report=15&limit=5&fields=kWh_Tot*&bulk=1

Click to try


URL Parameter

Parameter Description
bulk Can be either zero ( 0 ) or one ( 1 ). Default is zero ( 0 )

Summary Output Formats

Output Formats


https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=xml&report=15&limit=1&timelimit=1&fields=kWh_Tot*

The above URL returns XML structured like this:


<summaries>
<summary>
<Start_Time_Stamp_UTC_ms>1451334601376</Start_Time_Stamp_UTC_ms>
<End_Time_Stamp_UTC_ms>1451335503375</End_Time_Stamp_UTC_ms>
<End_Date>Mon Dec 28 2015 20:45:03 GMT+0000 (GMT)</End_Date>
<Start_Date>Mon Dec 28 2015 20:30:01 GMT+0000 (GMT)</Start_Date>
<Meter>17507</Meter>
<Protocol>v3</Protocol>
<Count>903</Count>
<kWh_Tot_DeltaMin>0</kWh_Tot_DeltaMin>
<kWh_Tot_DeltaMax>0.1</kWh_Tot_DeltaMax>
<kWh_Tot_Min>107042</kWh_Tot_Min>
<kWh_Tot_Max>107042.9</kWh_Tot_Max>
<kWh_Tot_Diff>0.9</kWh_Tot_Diff>
</summary>
</summaries>

Output forat: JSON


https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&timelimit=1&fields=kWh_Tot*

The above URL returns JSON structured like this:


[
   {
      "Start_Time_Stamp_UTC_ms": 1451334601376,
      "End_Time_Stamp_UTC_ms": 1451335503375,
      "End_Date": "Mon Dec 28 2015 20:45:03 GMT+0000 (GMT)",
      "Start_Date": "Mon Dec 28 2015 20:30:01 GMT+0000 (GMT)",
      "Meter": "17507",
      "Protocol": "v3",
      "Count": 903,
      "kWh_Tot_DeltaMin": 0,
      "kWh_Tot_DeltaMax": 0.1,
      "kWh_Tot_Min": 107042,
      "kWh_Tot_Max": 107042.9,
      "kWh_Tot_Diff": 0.9
   }
]

Output format: CSV


https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=csv&report=15&limit=1&timelimit=1&fields=kWh_Tot*

The above URL returns CSV structured like this:


"Start_Time_Stamp_UTC_ms","End_Time_Stamp_UTC_ms","End_Date","Start_Date","Meter","Protocol","Count","kWh_Tot_DeltaMin","kWh_Tot_DeltaMax","kWh_Tot_Min","kWh_Tot_Max","kWh_Tot_Diff"
1451334601376,1451335503375,"Mon Dec 28 2015 20:45:03 GMT+0000 (GMT)","Mon Dec 28 2015 20:30:01 GMT+0000 (GMT)","17507","v3",903,0,0.1,107042,107042.9,0.9

You can call up different output formats to return the summary results in. These formats can be: HTML, XML, JSON and CSV.

To retrieve the different formats, all that is required is to change the FORMAT, to the type you want to call.

Example URL

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=FORMAT&report=15&limit=1&timelimit=1&fields=kWh_Tot*


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

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=1&timelimit=1&fields=kWh_Tot*

Click to try


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

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=xml&report=15&limit=1&timelimit=1&fields=kWh_Tot*

Click to try


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

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=1&timelimit=1&fields=kWh_Tot*

Click to try


Click the link below to see the meter data returned in the CSV format. ( Comma Separated Values )

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=csv&report=15&limit=1&timelimit=1&fields=kWh_Tot*

Click to try


URL Parameters

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

Summary Reports

Report

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_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 JSONArray 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();

        JSONArray jsonObject = new JSONArray(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
         */
        JSONArray apiObject = EKM.callApi("https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot");

        /*
         You can access any part of the apiObject using code like this:
         String Protocol = apiObject.getJSONObject(0).getString("Protocol");
        */

    // 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

The report parameter is used to define the time period in which the summary results are returned as.

The example below shows the https address format. Parameters than can be used are as follows: 15 is for a 15 minute summary report, hr is for an hourly summary report, dy is for a daily summary report, wk is for a weekly summary report, and mo is for a monthly summary report. Range is used to aggregate all summaries within the set date range into one summary report.

Replace REPORT with one of the report parameters that you want to call the meter reading in.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=REPORT&fields=kWh_Tot*


Example for the 15 minute summary report:

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&fields=kWh_Tot*

Click to try


Example for the hr

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=hr&fields=kWh_Tot*

Click to try


Example for the dy

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=dy&fields=kWh_Tot*

Click to try


Example for the wk

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=wk&fields=kWh_Tot*

Click to try


Example for the mo

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=mo&fields=kWh_Tot*

Click to try


The example below is used when calling for a monthly summary report that is used in a billing cycle. Replace the # in the mo# call with a number correlating to a day of the month, between 2-28.

Example: report=mo15.

Example URL:

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=mo#&fields=kWh_Tot*

Example for the monthly range

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=mo15&fields=kWh_Tot*

Click to try


Example for range

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=range&fields=kWh_Tot*

Click to try


URL Parameters

Parameter Description
report 15, hr, dy, wk, mo, mo#, range

Summary Number of Summaries

Number of Summaries

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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

# 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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)

<?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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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);
/*
 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 JSONArray 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();

        JSONArray jsonObject = new JSONArray(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
         */
        JSONArray apiObject = EKM.callApi("https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*");

        /*
         You can access any part of the apiObject using code like this:
         String Protocol = apiObject.getJSONObject(0).getString("Protocol");
        */

    // 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

The limit parameter determines the number of rows to show in the summary results. If the limit call is not included in the url it will default to the number of rows to show in the results page. The default number will be 10 ( ten ) rows. If your summary report results exceed more than the default amount of rows needed, then you must set the number of rows in the limit parameter. If you use the default amount of rows then your summary will not display all of the results that were queried.

The Limit number can be any number from 1 to the number of summary rows that you need to display.

The following is an example of what your https address will look like when calling the limit parameter:

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=LIMIT&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*

Replace LIMIT with the number 20 to call the number of rows to display in the summary results:

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*


The link below will show the example of the meter data that is associated with the provided key and the specified number of 20 summary rows on the results page. It will display it as html data.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=20&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*

Click to try


You can also request anywhere from 1 to 1000 rows to display in the summary results depending on your needs.

For 1 row replace LIMIT with the number 1 as in the example below:

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=1&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*

Click to try


or for 1000 rows replace LIMIT with the number 1000 as in the example below:

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=1000&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*

Click to try


URL Parameters

Parameters Description
limit Number of rows to display in the summary results page

Summary Offset & Timelimit

Offset

Offset

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&fields=kWh_Tot*~RMS_Volts_Ln_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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&fields=kWh_Tot*~RMS_Volts_Ln_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

# 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&fields=kWh_Tot*~RMS_Volts_Ln_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)

<?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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&fields=kWh_Tot*~RMS_Volts_Ln_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);
/*
 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 JSONArray 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();

        JSONArray jsonObject = new JSONArray(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
         */
        JSONArray apiObject = EKM.callApi("https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&fields=kWh_Tot*~RMS_Volts_Ln_1*");

        /*
         You can access any part of the apiObject using code like this:
         String Protocol = apiObject.getJSONObject(0).getString("Protocol");
        */

    // 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&fields=kWh_Tot*~RMS_Volts_Ln_1*");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

The offset parameter is used when you want to paginate through the summary results.

The offset can be zero ( 0 ) or any number greater than. The default is zero ( 0 ) if not specified in the https address.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=OFFSET&fields=kWh_Tot*~RMS_Volts_Ln_1*

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&fields=kWh_Tot*~RMS_Volts_Ln_1*

URL Parameter

Parameter Description
offset Any number from zero ( 0 ) to the number needed

Timelimit

Timelimit

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&fields=kWh_Tot*~RMS_Volts_Ln_1*"

# 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('summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&fields=kWh_Tot*~RMS_Volts_Ln_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

# 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&fields=kWh_Tot*~RMS_Volts_Ln_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)

<?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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&fields=kWh_Tot*~RMS_Volts_Ln_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);
/*
 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://mvnrepository.com/artifact/org.json/json/20131018

 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-20131018.jar ./EKM.java
 4. Run
  java -cp .:./json-20131018.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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&fields=kWh_Tot*~RMS_Volts_Ln_1*");

        /*
         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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&fields=kWh_Tot*~RMS_Volts_Ln_1*");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

The timelimit parameter is used only to calculate the default start_date. The number that is inputted in the timelimit parameter is subtracted from the end_date.

Example: If you set the timelimit to equal 5, then the default start_date will begin 5 hours before the end_date. If your end_date is 12:00 P.M. then your start_date will begin at 7:00 A.M. Your summary results will begin from that time.


The timelimit parameter can be one ( 1 ) or any positive integer.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&timelimit=TIMELIMIT&fields=kWh_Tot*~RMS_Volts_Ln_1*

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&timelimit=5&fields=kWh_Tot*~RMS_Volts_Ln_1*

Click to try


URL Parameter

Parameter Description
timelimit Any number from one ( 1 ) to the number needed

Summary Time Zones

Time Zones

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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://summary.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('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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

# 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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);

/*
 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 JSONArray 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();

        JSONArray jsonObject = new JSONArray(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
         */
        JSONArray apiObject = EKM.callApi("https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*");

        /*
         You can access any part of the apiObject using code like this:
         String Protocol = apiObject.getJSONObject(0).getString("Protocol");
        */

    // 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

The Summary Time Zone parameter by default will return the time as UTC Time (computer time) in milliseconds. It will also show the time in the standard time format.

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

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&timelimit=5&timezone=TIME_ZONE&fields=kWh_Tot*~RMS_Volts_Ln_1*

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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*

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
timezone The time zone is the country and city where the meter is in service. Example: America~Los_Angeles.

Summary Start Date & End Date

Start Date & End Date

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_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 JSONArray 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();

        JSONArray jsonObject = new JSONArray(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
         */
        JSONArray apiObject = EKM.callApi("https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_Tot*");

        /*
         You can access any part of the apiObject using code like this:
         String Protocol = apiObject.getJSONObject(0).getString("Protocol");
        */

    // 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_Tot*");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

You can also call the available summary reports for a given meter by a specified date with the following parameters in the URL address:

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=YYYYMMDDhhmm&end_date=YYYYMMDDhhmm&fields=kWh_Tot*

Date Parameters

Parameters Description
YYYY Indicates the year to be called. example: 2019
MM Indicates the month to be called. Example: 12, for the month of December
DD Indicates the day of the month. Example: 01, for the first day of the month
hh Indicates the hour of the day. Example: 0900, for 9 A.M.
mm Indicates the minutes of the hour. Example: 0930, for 30 minutes into the hour of 9 A.M. or 9:30 A.M.

Lets say you would like to pull the summary report for December 01, 2019 9:00 A.M. to December 02, 2019 8:00 A.M.. Your https address should look like the following:

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=hr&limit=25&offset=0&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_Tot*

Click the link below to see an example.

Click to try


Range is used to aggregate all summaries within the set date range into one summary report.

Example of range for the report parameter

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=range&timezone=America~Los_Angeles&start_date=201912010900&end_date=201912020800&fields=kWh_Tot*

Click to try

URL Parameters

Parameter Description
start_date Date for the summary report to begin. Example of YYYYMMDDhhmm is as follows: 201912010900 = December 01, 2019 9:00 A.M.
end_date Data for the summary report to end. Example of YYYYMMDDhhmm is as follows: 201912020800 = December 02, 2019 8:00 A.M.

Summary Hours

Hours

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&hours=1300-1530&fields=kWh_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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&hours=1300-1530&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&hours=1300-1530&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&hours=1300-1530&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&hours=1300-1530&fields=kWh_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 JSONArray 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();

        JSONArray jsonObject = new JSONArray(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
         */
        JSONArray apiObject = EKM.callApi("https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&hours=1300-1530&fields=kWh_Tot*");

        /*
         You can access any part of the apiObject using code like this:
         String Protocol = apiObject.getJSONObject(0).getString("Protocol");
        */

    // 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&hours=1300-1530&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&hours=1300-1530&fields=kWh_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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&hours=1300-1530&fields=kWh_Tot*");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

You can also call the available summary results for a given meter by a specified time in the current day with the following https hours parameter.

This parameter is used to show the summary reports between the provided start and end hours. Example: 1300-1530

hours: hhmm-hhmm ( default 0000-2359 from 0000 to 2359 hours )

All time parameters will be in the 24-hour clock format, or military time.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&hours=hhmm-hhmm&fields=kWh_Tot*

Time Parameters

Parameter Description
hh Indicates the hour of the day. Example: 1300 for 1:00 P.M.
mm Indicates the minutes of the hour. Example: 1530 for 3:30 P.M.

Click the link below to see an example.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&hours=1300-1530&fields=kWh_Tot*

Click to try


URL Parameters

Parameter Description
hours The Format in which the Time is written in: hhmm - hours, minutes. Example: 1530 for 3:30 P.M.

Summary Days

Days

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot*&days=mon"
# 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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot*&days=mon')

# 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot*&days=mon")

# 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot*&days=mon');

// 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot*&days=mon");

# 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot*&days=mon");

        /*
         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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot*&days=mon',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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot*&days=mon', 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&fields=kWh_Tot*&days=mon");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));

    return 0;
}

The Days parameter is the same as the Hours parameter. It is used to check field values on specified days, rather than specified hours.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&fields=kWh_Tot*&days=DAYS

Just replace DAYS with a day of the week.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&fields=kWh_Tot*&days=mon

If you want to set more than 1 ( one ) day all that is needed is to use a tilde ( ~ ) in between each of the days that you want to include in the URL.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&fields=kWh_Tot*&days=mon~tue~wed


Click the link below to see an example.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=wk&limit=10&fields=kWh_Tot*&days=mon

Click to try


Days Parameters

Parameters Description
mon Monday
tue Tuesday
wed Wednesday
thu Thursday
fri Friday
sat Saturday
sun Sunday

Summary Fields

Fields

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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

# 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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)

<?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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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);
/*
 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 JSONArray 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();

        JSONArray jsonObject = new JSONArray(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
         */
        JSONArray apiObject = EKM.callApi("https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*");

        /*
         You can access any part of the apiObject using code like this:
         String Protocol = apiObject.getJSONObject(0).getString("Protocol");
        */

  // 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));     

    return 0;
}

You can filter for just the summary fields you are interested in by using fields=FIELDS parameter in the https address.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=FIELDS


In the example below we are only interested in finding out the kWh_Tot and RMS_Volts_ln_1. To retrieve the data associated with the different fields use the abbreviated name of the fields you are interested in after the fields parameter, followed by a tilde separator ( ~ ), or a comma ( , ), if calling for more than one field.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*

Click to try


The example below is the same as the one above, except is shows the address with a comma after the fields name instead of the tilde separator.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*,RMS_Volts_Ln_1*

Appending the asterisk ( * ) at the end of the field name will show all matching field values associated with the provided fields name.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot*~RMS_Volts_Ln_1*

Click to try

As you can see from the example above that when you append the asterisk ( * ) at the end of the fields name it returns all the associated values with that given fields.

For example, when you call the fields kWh_Tot* the results will include the values of DeltaMin, DeltaMax, Min, Max and Diff.


If you do not want to have all the fields results show in your query, or if you are only interested in a specific fields value you can call it by including the value at the end of the fields name instead of using the asterisk ( * ).

Example: kWh_Tot_DeltaMax

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot_DeltaMax,kWh_Tot_Max

Click to try


Example: kWh_Tot_Max

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot_Max

Click to try


If you want to include more than one fields value but not all associated values for a given fields, you would add that value to the address like you were calling another fields name.

Example: kWh_Tot_DeltaMax~kWh_Tot_Max

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=10&offset=0&timelimit=5&timezone=America~Los_Angeles&fields=kWh_Tot_DeltaMax~kWh_Tot_Max

Click to try


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

URL Parameters

The fields below are the Summary fields for v3 and v4 meters

FieldDescription
kWh_Tot*Total Kilowatt Hour
Show sub-fields
kWh_Tariff_1* Kilowatt Hour for Tariff 1
Show sub-fields
kWh_Tariff_2* Kilowatt Hour for Tariff 2
Show sub-fields
kWh_Tariff_3* Kilowatt Hour for Tariff 3
Show sub-fields
kWh_Tariff_4* Kilowatt Hour for Tariff 4
Show sub-fields
Rev_kWh_Tot* Total Reverse Kilowatt Hour
Show sub-fields
Rev_kWh_Tariff_1* Reverse Kilowatt Hour for Tariff 1
Show sub-fields
Rev_kWh_Tariff_2* Reverse Kilowatt Hour for Tariff 2
Show sub-fields
Rev_kWh_Tariff_3* Reverse Kilowatt Hour for Tariff 3
Show sub-fields
Rev_kWh_Tariff_4* Reverse Kilowatt Hour for Tariff 4
Show sub-fields

RMS_Volts_Ln_1* Root-Mean-Squared Volts on Ln 1
Show sub-fields
RMS_Volts_Ln_2* Root-Mean-Squared Volts on line 2
Show sub-fields
RMS_Volts_Ln_3* Root-Mean-Squared Volts on line 3
Show sub-fields
Amps_Ln_1* Amps on line 1
Show sub-fields
Amps_Ln_2* Amps on line 2
Show sub-fields
Amps_Ln_3* Amps on line 3
Show sub-fields
RMS Watts_Ln_1* Root-Mean-Squared Watts on line 1
Show sub-fields
RMS Watts_Ln_2* Root-Mean-Squared Watts on line 2
Show sub-fields
RMS Watts_Ln_3* Root-Mean-Squared Watts on line 3
Show sub-fields
RMS Watts_Tot* Total Root-Mean-Squared Watts all lines
Show sub-fields
Power_Factor_Ln_1* Power Factor on line 1
Show sub-fields
Power_Factor_Ln_2* Power Factor on line 2
Show sub-fields
Power_Factor_Ln_3* Power Factor on line 3
Show sub-fields
RMS_Watts_Max_Demand* Root-Mean-Squared Watts Max Demand
Show sub-fields
CT_Ratio* Current Transformer Ratio
Show sub-fields

The fields below are additional Summary fields only for v4 meters

Pulse_Cnt_1* Pulse Count on Input 1
Show sub-fields
Pulse_Cnt_2* Pulse Count on Input 2
Show sub-fields
Pulse_Cnt_3* Pulse Count on Input 3
Show sub-fields
Pulse_Ratio_1* Pulse Input Ratio on Input 1
Show sub-fields
Pulse_Ratio_2* Pulse Input Ratio on Input 2
Show sub-fields
Pulse_Ratio_3* Pulse Input Ratio on Input 3
Show sub-fields
Reactive_Energy_Tot* Total Kilo Volt Amperes Reactive Hours (kVARh)
Show sub-fields
kWh_Rst* Resettable Kilowatt Hour
Show sub-fields
Rev_kWh_Rst* Resettable Reverse Kilowatt Hour
Show sub-fields
Reactive_Pwr_Ln_1* Volt-Amperes Reactive on line 1
Show sub-fields
Reactive_Pwr_Ln_2* Volt-Amperes Reactive on line 2
Show sub-fields
Reactive_Pwr_Ln_3* Volt-Amperes Reactive on line 3
Show sub-fields
Reactive_Pwr_Tot* Total Volt-Amperes Reactive
Show sub-fields
Line_Freq* Frequency (Hz)
Show sub-fields
kWh_Ln_1* Total Kilowatt Hour on Line 1
Show sub-fields
kWh_Ln_2* Total Kilowatt Hour on Line 2
Show sub-fields
kWh_Ln_3* Total kilowatt Hour on Line 3
Show sub-fields
Rev_kWh_Ln_1* Reverse Kilowatt Hour on Line 1
Show sub-fields
Rev_kWh_Ln_2* Reverse Kilowatt Hour on Line 2
Show sub-fields
Rev_kWh_Ln_3* Reverse Kilowatt Hour on Line 3
Show sub-fields
Max_Demand_Rst* Max Demand Auto Reset Status
OFF = 0
Monthly = 1
Weekly = 2
Daily = 3
Hourly = 4
Show sub-fields
Net_Calc_Watts_Ln_1* Net Watts on Line 1
Show sub-fields
Net_Calc_Watts_Ln_2* Net Watts on Line 2
Show sub-fields
Net_Calc_Watts_Ln_3* Net Watts on Line 3
Show sub-fields
Net_Calc_Watts_Tot* Total Net Watts
Show sub-fields
CF_Ratio* Settable Pulse Output Ratio (Crest Factor Ratio)
Show sub-fields

Summary Normalize

Normalize

curl -s
"https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=wk&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*&normalize=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://summary.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://summary.ekmpush.com
apiObject = callApi('/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=wk&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*&normalize=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

# 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=wk&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*&normalize=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)

// 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=wk&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*&normalize=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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=wk&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*&normalize=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);
/*
 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 JSONArray 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();

        JSONArray jsonObject = new JSONArray(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
         */
        JSONArray apiObject = EKM.callApi("https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=wk&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*&normalize=1");

        /*
         You can access any part of the apiObject using code like this:
         String Protocol = apiObject.getJSONObject(0).getString("Protocol");
        */

    // 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=wk&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*&normalize=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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=wk&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*&normalize=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 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://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=json&report=wk&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*&normalize=1");

    // This just displays the object but you can use what ever
    // code you would like to work with the object here

    int arraylen = json_object_array_length(apiObject); /*Getting the length of the array*/
    json_object * summary;
    int i;
    printf("Complete Summary Object:\n");
    for (i=0; i< arraylen; i++){
    summary = json_object_array_get_idx(apiObject,i); /*Getting the array element at position i*/
    printf("\n%s", json_object_to_json_string_ext(summary,JSON_C_TO_STRING_PRETTY));
    }

    // This example digs deaper into the JSON and displays the first
    // kwh_tot_max value for the first summary read

    json_object * kwh_tot_max;
    summary = json_object_array_get_idx(apiObject,0);
    json_object_object_get_ex(summary,"kWh_Tot_Max",&kwh_tot_max);
    printf("\nkWh_Tot_Max: %s", json_object_to_json_string_ext(kwh_tot_max,JSON_C_TO_STRING_PRETTY));       

    return 0;
}

The normalize parameter rounds the Start Date times and End Date times to the beginning and end seconds of the parameter specified by the “Report” type. The beginning will be represented as :00 seconds. The end will be represented as :59 seconds. The hours and minutes would vary depending on the parameter specified by the “Report” type.

Example: If the report parameter is 15 ( 15 minutes ), then every row in the summary report will have the start date times be at 15 minute increments: 09:00:00, then 09:15:00, then 09:30:00 and so on. The end date times will end 15 minutes after the start date time: 09:14:59, then 09:29:59, then 09:44:59 and so on.

If you do not include the “Normalize” parameter in the https address it will use the default of zero ( 0 ). If the default is used the summary reports will not be rounded to the start date time of :00 seconds and end date time of :59 seconds. If you want the summary reports to have the start date time shown as :00 seconds and the end date time shown as :59 seconds, then the normalize parameter must be used and set to one ( 1 ).


The example below is what the https address will look like if using the normalize parameter with the report type set to 15 ( 15 minutes ).

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*&normalize=1

Click to try

The example below is without the normalize parameter.

https://summary.ekmpush.com/summary?meters=17507&key=MTAxMDoyMDIw&format=html&report=15&limit=12&timezone=America~Los_Angeles&fields=kWh_Tot*

Click to try

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.