NAV
Command Line Ruby Python PHP Perl Java 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 and Nodejs! 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"
# Ruby Version: 3.1.2

# Load required modules
require 'net/http'
require 'json'
require 'uri'

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

def call_api(api_path)
  uri = URI.parse("URL Here#{api_path}")
  response = Net::HTTP.get_response(uri)
  puts response.uri
  JSON.parse(response.body)
end

# Call the call_api method to create a usable
# object named api_object from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include for example https://summary.ekmpush.com
api_object = call_api('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 api_object

'''
Python version: 3.9.12
'''

# Required Python Modules
import urllib.request
import urllib.error
import urllib.parse
import json
import pprint

# This function accesses the api_request URL and converts
# the contents to a usable Python object and returns it
def call_api ( api_request ):
    '''
    Make http request
    '''
    response = urllib.request.urlopen(api_request)
    response = response.read()
    json_object = json.loads(response.decode())
    return json_object

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

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

<?php
// PHP 8.0.17 (cli)

// 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);

}
?>    
#!/usr/bin/perl
# Perl version: v5.34
# CPAN.pm version 2.2
# Perl Modules Version:
# JSON: 4.05
# LWP::Protocol::https: 6.10
# LWP::Simple: 6.62
#
# OS Prerequisites
# UBUNTU
# apt install cpanminus
#
# Install Perl Modules
#       cpan LWP::Simple
#       cpan LWP::Protocol::https
#       cpan JSON

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

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

# Call the call_api function to create a usable
# object named api_object from the API request URL.
# Put the API request URL in the call
my $api_object = call_api('URL Here');

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($api_object);    ## no critic (InputOutput::RequireCheckedSyscalls)

/*
 openjdk version "17.0.2" 2022-01-18

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

 This example uses version 20220320 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20220320/json-20220320.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-20220320.jar ./EKM.java
 4. Run
  java -cp .:./json-20220320.jar EKM
*/

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

@java.lang.SuppressWarnings({"java:S106", "java:S112", "java:S125"})

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();

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

    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>
/*
* Requirements
* NodeJS: v16.14.2
* Axios:  0.27.2
*/

// Load modules
const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'URL Here',
  timeout: 1000 * 15,
})

// This code accesses the apiRequest query and
// logs the response data or the error
;(async () => {
  try {
    const res = await apiClient.get('URI Here');
    const apiResData = res.data;

    console.log(JSON.stringify(apiResData, null, 2));
  } catch (error) {
    console.error(error.message);
  }
})();

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

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: Realtime API Builder

Realtime HTTPS Request

HTTPS Request

curl -s
"https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles"
# Ruby Version: 3.1.2

# Load required modules
require 'net/http'
require 'json'
require 'uri'

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

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

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

# This example digs deeper into the JSON and displays the first
# kwh_tot value for the first read of the first meter
readmeter_json = api_object['readMeter']
readset_json = readmeter_json['ReadSet']
readset_0_json = readset_json[0]
readdata_json = readset_0_json['ReadData']
readdata_0_json = readdata_json[0]
kwh_tot = readdata_0_json['kWh_Tot']
pp "kWh_Tot: #{kwh_tot}"

'''
Python version: 3.9.12
'''

# Required Python Modules
import urllib.request
import urllib.error
import urllib.parse
import json
import pprint

# This function accesses the api_request URL and converts
# the contents to a usable Python object and returns it
def call_api ( api_request ):
    '''Make http request'''
    response = urllib.request.urlopen(api_request)
    response = response.read()
    json_object = json.loads(response.decode())
    return json_object

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

api_object = call_api("https://api.ekmpush.com/readMeter\
?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles")


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

# This example digs deeper into the JSON and displays the first
# kwh_tot value for the first read of the first meter
readmeter_json = api_object['readMeter']
readset_json = readmeter_json['ReadSet']
readset_0_json = readset_json[0]
readdata_json = readset_0_json['ReadData']
readdata_0_json = readdata_json[0]
kwh_tot = readdata_0_json["kWh_Tot"]
print("kWh_Tot: ", kwh_tot)

<?php
// PHP 8.0.17 (cli)

// 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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles');

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


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


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

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

}
?>
#!/usr/bin/perl
# Perl version: v5.34
# CPAN.pm version 2.2
# Perl Modules Version:
# JSON: 4.05
# LWP::Protocol::https: 6.10
# LWP::Simple: 6.62
#
# OS Prerequisites
# UBUNTU
# apt install cpanminus
#
# Install Perl Modules
#       cpan LWP::Simple
#       cpan LWP::Protocol::https
#       cpan JSON

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

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

# Call the call_api function to create a usable
# object named api_object from the API request URL.
# Put the API request URL in the call
my $api_object = call_api(
'https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles'
);

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($api_object);    ## no critic (InputOutput::RequireCheckedSyscalls)

# This example digs deeper into the JSON and displays the first
# kwh_tot value for the first read of the first meter
my $readmeter_json  = $api_object->{readMeter};
my $readset_json    = $readmeter_json->{ReadSet};
my $readset_0_json  = $readset_json->[0];
my $readdata_json   = $readset_0_json->{ReadData};
my $readdata_0_json = $readdata_json->[0];
my $kwh_tot         = $readdata_0_json->{kWh_Tot};

print "kWh_Tot: $kwh_tot";    ## no critic (InputOutput::RequireCheckedSyscalls)

/*
 openjdk version "17.0.2" 2022-01-18

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

 This example uses version 20220320 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20220320/json-20220320.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-20220320.jar ./EKM.java
 4. Run
  java -cp .:./json-20220320.jar EKM
*/

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

@java.lang.SuppressWarnings({"java:S106", "java:S112", "java:S125"})

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();

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

    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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles");


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

        // This example digs deaper into the JSON and displays the first
        // kwh_tot value for the first read of the first meter
        JSONObject readmeterJson = apiObject.getJSONObject("readMeter");
        JSONArray readsetJson = readmeterJson.getJSONArray("ReadSet");
        JSONObject readset0Json = readsetJson.getJSONObject(0);
        JSONArray readDataJson = readset0Json.getJSONArray("ReadData");
        JSONObject readData0Json = readDataJson.getJSONObject(0);
        Object kwhTot = readData0Json.get("kWh_Tot");
        System.out.println("kWh_Tot: " + kwhTot); // NOPMD

        }
}

<!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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles',function(apiObject){

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


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

      });

};

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

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

</head>
  <body onload="example()">
    <div id="result"> </div>
    <div id="kwh_tot"> </div>
  </body>
</html>
/*
* Requirements
* NodeJS: v16.14.2
* Axios:  0.27.2
*/

// Load modules
const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'https://api.ekmpush.com/readMeter',
  timeout: 1000 * 15,
})

// This code accesses the apiRequest query
// and logs the response data or the error
;(async () => {
  try {
    const res = await apiClient.get(
        '?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles');
    const apiResData = res.data;
    // This gets the kWh Tot from the first read of the first ReadSet
    const kWhTot = apiResData.readMeter.ReadSet[0].ReadData[0].kWh_Tot;

    console.log(JSON.stringify(apiResData, null, 2));
    console.log(`kWh Tot: ${kWhTot}`);
  } catch (error) {
    console.error(error.message);
  }
})();

The above example returns the following results:

{
    "readMeter": {
        "Requested": 1,
        "ReadSet": [
            {
                "Meter": "17507",
                "Group": 0,
                "Send_Interval": 60,
                "Protocol": "v3",
                "MAC_Addr": "40:16:fa:01:02:26",
                "Tz_Offset_Sec": -25200,
                "Bad_Reads": 0,
                "Good_Reads": 1,
                "Credits": 1000000,
                "Push_Version": "Push2",
                "ReadData": [
                    {
                        "Good": 1,
                        "Date": "2022-04-15",
                        "Time": "10:27:15.141",
                        "Time_Stamp_UTC_ms": 1650043635141,
                        "Firmware": "15",
                        "Model": "1710",
                        "kWh_Tot": "50986.8",
                        "kWh_Tariff_1": "5143.0",
                        "kWh_Tariff_2": "45843.8",
                        "Rev_kWh_Tot": "0.7",
                        "Rev_kWh_Tariff_1": "0.4",
                        "Rev_kWh_Tariff_2": "0.3",
                        "RMS_Volts_Ln_1": "123.5",
                        "RMS_Volts_Ln_2": "123.6",
                        "Amps_Ln_1": "4.0",
                        "Amps_Ln_2": "4.0",
                        "Power_Factor_Ln_1": "100",
                        "Power_Factor_Ln_2": "100",
                        "Power_Factor_Ln_3": "200",
                        "Cos_Theta_Ln_1": "1.00",
                        "Cos_Theta_Ln_2": "1.00",
                        "Cos_Theta_Ln_3": "0.00 C",
                        "RMS_Watts_Ln_1": "498",
                        "RMS_Watts_Ln_2": "498",
                        "RMS_Watts_Tot": "998",
                        "RMS_Watts_Max_Demand": "5050",
                        "Max_Demand_Period": "1",
                        "CT_Ratio": "200",
                        "Meter_Status_Code": "00"
                    }
                ]
            }
        ]
    }
}
{"readMeter"=>
  {"Requested"=>1,
   "ReadSet"=>
    [{"Meter"=>"17507",
      "Group"=>0,
      "Send_Interval"=>60,
      "Protocol"=>"v3",
      "MAC_Addr"=>"40:16:fa:01:02:26",
      "Tz_Offset_Sec"=>-25200,
      "Bad_Reads"=>0,
      "Good_Reads"=>1,
      "Credits"=>1000000,
      "Push_Version"=>"Push2",
      "ReadData"=>
       [{"Good"=>1,
         "Date"=>"2022-04-15",
         "Time"=>"10:27:15.141",
         "Time_Stamp_UTC_ms"=>1650043635141,
         "Firmware"=>"15",
         "Model"=>"1710",
         "kWh_Tot"=>"50986.8",
         "kWh_Tariff_1"=>"5143.0",
         "kWh_Tariff_2"=>"45843.8",
         "Rev_kWh_Tot"=>"0.7",
         "Rev_kWh_Tariff_1"=>"0.4",
         "Rev_kWh_Tariff_2"=>"0.3",
         "RMS_Volts_Ln_1"=>"123.5",
         "RMS_Volts_Ln_2"=>"123.6",
         "Amps_Ln_1"=>"4.0",
         "Amps_Ln_2"=>"4.0",
         "Power_Factor_Ln_1"=>"100",
         "Power_Factor_Ln_2"=>"100",
         "Power_Factor_Ln_3"=>"200",
         "Cos_Theta_Ln_1"=>"1.00",
         "Cos_Theta_Ln_2"=>"1.00",
         "Cos_Theta_Ln_3"=>"0.00 C",
         "RMS_Watts_Ln_1"=>"498",
         "RMS_Watts_Ln_2"=>"498",
         "RMS_Watts_Tot"=>"998",
         "RMS_Watts_Max_Demand"=>"5050",
         "Max_Demand_Period"=>"1",
         "CT_Ratio"=>"200",
         "Meter_Status_Code"=>"00"}]}]}}
"kWh_Tot: 50986.8"
{'readMeter': {'ReadSet': [{'Bad_Reads': 0,
                            'Credits': 1000000,
                            'Good_Reads': 1,
                            'Group': 0,
                            'MAC_Addr': '40:16:fa:01:02:26',
                            'Meter': '17507',
                            'Protocol': 'v3',
                            'Push_Version': 'Push2',
                            'ReadData': [{'Amps_Ln_1': '4.0',
                                          'Amps_Ln_2': '4.0',
                                          'CT_Ratio': '200',
                                          'Cos_Theta_Ln_1': '1.00',
                                          'Cos_Theta_Ln_2': '1.00',
                                          'Cos_Theta_Ln_3': '0.00 C',
                                          'Date': '2022-04-15',
                                          'Firmware': '15',
                                          'Good': 1,
                                          'Max_Demand_Period': '1',
                                          'Meter_Status_Code': '00',
                                          'Model': '1710',
                                          'Power_Factor_Ln_1': '100',
                                          'Power_Factor_Ln_2': '100',
                                          'Power_Factor_Ln_3': '200',
                                          'RMS_Volts_Ln_1': '123.5',
                                          'RMS_Volts_Ln_2': '123.6',
                                          'RMS_Watts_Ln_1': '498',
                                          'RMS_Watts_Ln_2': '498',
                                          'RMS_Watts_Max_Demand': '5050',
                                          'RMS_Watts_Tot': '998',
                                          'Rev_kWh_Tariff_1': '0.4',
                                          'Rev_kWh_Tariff_2': '0.3',
                                          'Rev_kWh_Tot': '0.7',
                                          'Time': '10:27:15.141',
                                          'Time_Stamp_UTC_ms': 1650043635141,
                                          'kWh_Tariff_1': '5143.0',
                                          'kWh_Tariff_2': '45843.8',
                                          'kWh_Tot': '50986.8'}],
                            'Send_Interval': 60,
                            'Tz_Offset_Sec': -25200}],
               'Requested': 1}}
kWh_Tot:  50986.8
object(stdClass)#4 (1) {
  ["readMeter"]=>
  object(stdClass)#1 (2) {
    ["Requested"]=>
    int(1)
    ["ReadSet"]=>
    array(1) {
      [0]=>
      object(stdClass)#2 (11) {
        ["Meter"]=>
        string(5) "17507"
        ["Group"]=>
        int(0)
        ["Send_Interval"]=>
        int(60)
        ["Protocol"]=>
        string(2) "v3"
        ["MAC_Addr"]=>
        string(17) "40:16:fa:01:02:26"
        ["Tz_Offset_Sec"]=>
        int(-25200)
        ["Bad_Reads"]=>
        int(0)
        ["Good_Reads"]=>
        int(1)
        ["Credits"]=>
        int(1000000)
        ["Push_Version"]=>
        string(5) "Push2"
        ["ReadData"]=>
        array(1) {
          [0]=>
          object(stdClass)#3 (29) {
            ["Good"]=>
            int(1)
            ["Date"]=>
            string(10) "2022-04-15"
            ["Time"]=>
            string(12) "10:27:15.141"
            ["Time_Stamp_UTC_ms"]=>
            int(1650043635141)
            ["Firmware"]=>
            string(2) "15"
            ["Model"]=>
            string(4) "1710"
            ["kWh_Tot"]=>
            string(7) "50986.8"
            ["kWh_Tariff_1"]=>
            string(6) "5143.0"
            ["kWh_Tariff_2"]=>
            string(7) "45843.8"
            ["Rev_kWh_Tot"]=>
            string(3) "0.7"
            ["Rev_kWh_Tariff_1"]=>
            string(3) "0.4"
            ["Rev_kWh_Tariff_2"]=>
            string(3) "0.3"
            ["RMS_Volts_Ln_1"]=>
            string(5) "123.5"
            ["RMS_Volts_Ln_2"]=>
            string(5) "123.6"
            ["Amps_Ln_1"]=>
            string(4) "4.0"
            ["Amps_Ln_2"]=>
            string(4) "4.0"
            ["Power_Factor_Ln_1"]=>
            string(3) "100"
            ["Power_Factor_Ln_2"]=>
            string(3) "100"
            ["Power_Factor_Ln_3"]=>
            string(3) "200"
            ["Cos_Theta_Ln_1"]=>
            string(4) "1.00"
            ["Cos_Theta_Ln_2"]=>
            string(4) "1.00"
            ["Cos_Theta_Ln_3"]=>
            string(6) "0.00 C"
            ["RMS_Watts_Ln_1"]=>
            string(4) "498"
            ["RMS_Watts_Ln_2"]=>
            string(4) "498"
            ["RMS_Watts_Tot"]=>
            string(4) "998"
            ["RMS_Watts_Max_Demand"]=>
            string(4) "5050"
            ["Max_Demand_Period"]=>
            string(1) "1"
            ["CT_Ratio"]=>
            string(3) "200"
            ["Meter_Status_Code"]=>
            string(2) "00"
          }
        }
      }
    }
  }
}
kWh_Tot: 50986.8
$VAR1 = {
          'readMeter' => {
                           'ReadSet' => [
                                          {
                                            'Meter' => '17507',
                                            'Group' => 0,
                                            'Send_Interval' => 60,
                                            'Protocol' => 'v3',
                                            'MAC_Addr' => '40:16:fa:01:02:26',
                                            'Tz_Offset_Sec' => -25200,
                                            'Bad_Reads' => 0,
                                            'Good_Reads' => 1,                                            
                                            'Credits' => 1000000,                                            
                                            'Push_Version' => 'Push2',                                            
                                            'ReadData' => [
                                                            {
                                                              'Good' => 1,
                                                              'Date' => '2022-04-15',
                                                              'Time' => '10:27:15.141',
                                                              'Time_Stamp_UTC_ms' => '1650043635141',
                                                              'Firmware' => '15',
                                                              'Model' => '1710',
                                                              'kWh_Tot' => '50986.8',
                                                              'kWh_Tariff_1' => '5143.0',
                                                              'kWh_Tariff_2' => '45843.8',
                                                              'Rev_kWh_Tot' => '0.7',
                                                              'Rev_kWh_Tariff_1' => '0.4',
                                                              'Rev_kWh_Tariff_2' => '0.3',
                                                              'RMS_Volts_Ln_1' => '123.5',
                                                              'RMS_Volts_Ln_2' => '123.6',
                                                              'Amps_Ln_1' => '4.0',
                                                              'Amps_Ln_2' => '4.0',
                                                              'Power_Factor_Ln_1' => '100',
                                                              'Power_Factor_Ln_2' => '100',
                                                              'Power_Factor_Ln_3' => '200',
                                                              'Cos_Theta_Ln_1' => '1.00',
                                                              'Cos_Theta_Ln_2' => '1.00',
                                                              'Cos_Theta_Ln_3' => '0.00 C',
                                                              'RMS_Watts_Ln_1' => '498',
                                                              'RMS_Watts_Ln_2' => '498',
                                                              'RMS_Watts_Tot' => '998',
                                                              'RMS_Watts_Max_Demand' => '5050',
                                                              'Max_Demand_Period' => '1',
                                                              'CT_Ratio' => '200',                                                              
                                                              'Meter_Status_Code' => '00'                                                              
                                                            }
                                                          ]
                                          }
                                        ],
                           'Requested' => 1
                         }
        };
kWh_Tot: 50986.8
{"readMeter": {
    "Requested": 1,
    "ReadSet": [{
        "Good_Reads": 1,
        "Group": 0,
        "Credits": 1000000,
        "Push_Version": "Push2",
        "Meter": "17507",
        "Bad_Reads": 0,
        "Send_Interval": 60,
        "Protocol": "v3",
        "ReadData": [{
            "kWh_Tot": "50986.8",
            "Rev_kWh_Tariff_2": "0.3",
            "Rev_kWh_Tariff_1": "0.4",
            "Max_Demand_Period": "1",
            "Time": "10:27:15.141",
            "Meter_Status_Code": "00",
            "Amps_Ln_1": "4.0",
            "Amps_Ln_2": "4.0",
            "RMS_Volts_Ln_1": "123.5",
            "RMS_Volts_Ln_2": "123.6",
            "RMS_Watts_Max_Demand": "5050",
            "CT_Ratio": "200",
            "Firmware": "15",
            "RMS_Watts_Tot": "998",
            "Time_Stamp_UTC_ms": 1650043635141,
            "Power_Factor_Ln_3": "200",
            "Power_Factor_Ln_2": "100",
            "Power_Factor_Ln_1": "100",
            "kWh_Tariff_2": "45843.8",
            "kWh_Tariff_1": "5143.0",
            "Date": "2022-04-15",
            "Cos_Theta_Ln_3": "0.00 C",
            "RMS_Watts_Ln_1": "498",
            "Cos_Theta_Ln_2": "1.00",
            "Rev_kWh_Tot": "0.7",
            "Cos_Theta_Ln_1": "1.00",
            "RMS_Watts_Ln_2": "498",
            "Model": "1710",
            "Good": 1
        }],
        "Tz_Offset_Sec": -25200,
        "MAC_Addr": "40:16:fa:01:02:26"
    }]
}}
kWh_Tot: 50986.8
{
    "readMeter": {
        "Requested": 1,
        "ReadSet": [
            {
                "Meter": "17507",
                "Group": 0,
                "Send_Interval": 60,
                "Protocol": "v3",
                "MAC_Addr": "40:16:fa:01:02:26",
                "Tz_Offset_Sec": -25200,
                "Bad_Reads": 0,
                "Good_Reads": 1,
                "Credits": 1000000,
                "Push_Version": "Push2",
                "ReadData": [
                    {
                        "Good": 1,
                        "Date": "2022-04-15",
                        "Time": "10:27:15.141",
                        "Time_Stamp_UTC_ms": 1650043635141,
                        "Firmware": "15",
                        "Model": "1710",
                        "kWh_Tot": "50986.8",
                        "kWh_Tariff_1": "5143.0",
                        "kWh_Tariff_2": "45843.8",
                        "Rev_kWh_Tot": "0.7",
                        "Rev_kWh_Tariff_1": "0.4",
                        "Rev_kWh_Tariff_2": "0.3",
                        "RMS_Volts_Ln_1": "123.5",
                        "RMS_Volts_Ln_2": "123.6",
                        "Amps_Ln_1": "4.0",
                        "Amps_Ln_2": "4.0",
                        "Power_Factor_Ln_1": "100",
                        "Power_Factor_Ln_2": "100",
                        "Power_Factor_Ln_3": "200",
                        "Cos_Theta_Ln_1": "1.00",
                        "Cos_Theta_Ln_2": "1.00",
                        "Cos_Theta_Ln_3": "0.00 C",
                        "RMS_Watts_Ln_1": "498",
                        "RMS_Watts_Ln_2": "498",
                        "RMS_Watts_Tot": "998",
                        "RMS_Watts_Max_Demand": "5050",
                        "Max_Demand_Period": "1",
                        "CT_Ratio": "200",
                        "Meter_Status_Code": "00"
                    }
                ]
            }
        ]
    }
}
kWh_Tot: 50986.8
{
  "readMeter": {
    "Requested": 1,
    "ReadSet": [
      {
        "Meter": "17507",
        "Group": 0,
        "Send_Interval": 60,
        "Protocol": "v3",
        "MAC_Addr": "40:16:fa:01:02:26",
        "Tz_Offset_Sec": -25200,
        "Bad_Reads": 0,
        "Good_Reads": 1,
        "Credits": 1000000,
        "Push_Version": "Push2",
        "ReadData": [
          {
              "Good": 1,
              "Date": "2022-04-15",
              "Time": "10:27:15.141",
              "Time_Stamp_UTC_ms": 1650043635141,
              "Firmware": "15",
              "Model": "1710",
              "kWh_Tot": "50986.8",
              "kWh_Tariff_1": "5143.0",
              "kWh_Tariff_2": "45843.8",
              "Rev_kWh_Tot": "0.7",
              "Rev_kWh_Tariff_1": "0.4",
              "Rev_kWh_Tariff_2": "0.3",
              "RMS_Volts_Ln_1": "123.5",
              "RMS_Volts_Ln_2": "123.6",
              "Amps_Ln_1": "4.0",
              "Amps_Ln_2": "4.0",
              "Power_Factor_Ln_1": "100",
              "Power_Factor_Ln_2": "100",
              "Power_Factor_Ln_3": "200",
              "Cos_Theta_Ln_1": "1.00",
              "Cos_Theta_Ln_2": "1.00",
              "Cos_Theta_Ln_3": "0.00 C",
              "RMS_Watts_Ln_1": "498",
              "RMS_Watts_Ln_2": "498",
              "RMS_Watts_Tot": "998",
              "RMS_Watts_Max_Demand": "5050",
              "Max_Demand_Period": "1",
              "CT_Ratio": "200",
              "Meter_Status_Code": "00"
          }
        ]
      }
    ]
  }
}
kWh Tot: 50986.8

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

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

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

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

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

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

https Address Description
https://api.ekmpush.com/readMeter? Beginning of the https address
meters Parameter for calling the meter
17507 Exact meter number to call
key Parameter for calling the key
MTAxMDoyMDIw EKM Push authorization key
fmt Parameter expecting the file format to return as
json Language format to return the data as (html,xml,json,csv)
cnt Parameter for expecting how many meter readings to call
1 Exact number of meter readings
tz Parameter for selecting your timezone
America~Los_Angeles Timezone selected

Here is an example URL:

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

Click to try

Realtime Meter Number and Key

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

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

Realtime 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. All other examples in this API will use the key MTAxMDoyMDIw.

Get a Specific EKM Meter

curl -s
"https://api.ekmpush.com/readMeter?meters=300000369&key=MTExOjExMQ&fmt=json&cnt=1"
# Ruby Version: 3.1.2

# Load required modules
require 'net/http'
require 'json'
require 'uri'

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

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

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

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

'''
Python version: 3.9.12
'''

# Required Python Modules
import urllib.request
import urllib.error
import urllib.parse
import json
import pprint

# This function accesses the api_request URL and converts
# the contents to a usable Python object and returns it
def call_api ( api_request ):
    '''Make http request'''
    response = urllib.request.urlopen(api_request)
    response = response.read()
    json_object = json.loads(response.decode())
    return json_object

# Call the call_api function to create a usable
# object named api_object from the API request URL.
# Put the API request URL in the call
api_object = call_api("https://api.ekmpush.com/readMeter\
?meters=300000369&key=MTExOjExMQ&fmt=json&cnt=1")


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

<?php
// PHP 8.0.17 (cli)

// 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://api.ekmpush.com/readMeter?meters=300000369&key=MTExOjExMQ&fmt=json&cnt=1');

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

// This 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);

}
?>
#!/usr/bin/perl
# Perl version: v5.34
# CPAN.pm version 2.2
# Perl Modules Version:
# JSON: 4.05
# LWP::Protocol::https: 6.10
# LWP::Simple: 6.62
#
# OS Prerequisites
# UBUNTU
# apt install cpanminus
#
# Install Perl Modules
#       cpan LWP::Simple
#       cpan LWP::Protocol::https
#       cpan JSON

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

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

# Call the call_api function to create a usable
# object named api_object from the API request URL.
# Put the API request URL in the call
my $api_object = call_api(
'https://api.ekmpush.com/readMeter?meters=300000369&key=MTExOjExMQ&fmt=json&cnt=1'
);

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($api_object);    ## no critic (InputOutput::RequireCheckedSyscalls)

/*
 openjdk version "17.0.2" 2022-01-18

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

 This example uses version 20220320 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20220320/json-20220320.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-20220320.jar ./EKM.java
 4. Run
  java -cp .:./json-20220320.jar EKM
*/

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

@java.lang.SuppressWarnings({"java:S106", "java:S112", "java:S125"})

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();

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

    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://api.ekmpush.com/readMeter?meters=300000369&key=MTExOjExMQ&fmt=json&cnt=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://api.ekmpush.com/readMeter?meters=300000369&key=MTExOjExMQ&fmt=json&cnt=1',function(apiObject){

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

};

// This 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>
/*
* Requirements
* NodeJS: v16.14.2
* Axios:  0.27.2
*/

// Load modules
const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'https://api.ekmpush.com/readMeter',
  timeout: 1000 * 15,
})

// This code accesses the apiRequest query and
// logs the response data or the error
;(async () => {
  try {
    const res = await apiClient.get(
        '?meters=300000369&key=MTExOjExMQ&fmt=json&cnt=1');
    const apiResData = res.data;

    console.log(JSON.stringify(apiResData, null, 2));
  } catch (error) {
    console.error(error.message);
  }
})();

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://api.ekmpush.com/readMeter?meters=300000369&key=MTExOjExMQ&fmt=json&cnt=1


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

https://api.ekmpush.com/readMeter?meters=300000369&key=MTExOjExMQ&fmt=json&cnt=1

Click to try


URL Parameters

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

Realtime Query Multiple Meters

Query Multiple Meters

curl -s
"https://api.ekmpush.com/readMeter?meters=17507~15635&key=MTAxMDoyMDIw&fmt=json&cnt=1"
# Ruby Version: 3.1.2

# Load required modules
require 'net/http'
require 'json'
require 'uri'

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

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

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

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

'''
Python version: 3.9.12
'''

# Required Python Modules
import urllib.request
import urllib.error
import urllib.parse
import json
import pprint

# This function accesses the api_request URL and converts
# the contents to a usable Python object and returns it
def call_api ( api_request ):
    '''Make http request'''
    response = urllib.request.urlopen(api_request)
    response = response.read()
    json_object = json.loads(response.decode())
    return json_object

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

api_object = call_api("https://api.ekmpush.com/readMeter\
?meters=17507~15635&key=MTAxMDoyMDIw&fmt=json&cnt=1")


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

<?php
// PHP 8.0.17 (cli)

// 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://api.ekmpush.com/readMeter?meters=17507~15635&key=MTAxMDoyMDIw&fmt=json&cnt=1');

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

// This 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);

}
?>
#!/usr/bin/perl
# Perl version: v5.34
# CPAN.pm version 2.2
# Perl Modules Version:
# JSON: 4.05
# LWP::Protocol::https: 6.10
# LWP::Simple: 6.62
#
# OS Prerequisites
# UBUNTU
# apt install cpanminus
#
# Install Perl Modules
#       cpan LWP::Simple
#       cpan LWP::Protocol::https
#       cpan JSON

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

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

# Call the call_api function to create a usable
# object named api_object from the API request URL.
# Put the API request URL in the call
my $api_object = call_api(
'https://api.ekmpush.com/readMeter?meters=17507~15635&key=MTAxMDoyMDIw&fmt=json&cnt=1'
);

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($api_object);    ## no critic (InputOutput::RequireCheckedSyscalls)

/*
 openjdk version "17.0.2" 2022-01-18

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

 This example uses version 20220320 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20220320/json-20220320.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-20220320.jar ./EKM.java
 4. Run
  java -cp .:./json-20220320.jar EKM
*/

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

@java.lang.SuppressWarnings({"java:S106", "java:S112", "java:S125"})

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();

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

    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://api.ekmpush.com/readMeter?meters=17507~15635&key=MTAxMDoyMDIw&fmt=json&cnt=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://api.ekmpush.com/readMeter?meters=17507~15635&key=MTAxMDoyMDIw&fmt=json&cnt=1',function(apiObject){

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

};

// This 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>
/*
* Requirements
* NodeJS: v16.14.2
* Axios:  0.27.2
*/

// Load modules
const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'https://api.ekmpush.com/readMeter',
  timeout: 1000 * 15,
})

// This code accesses the apiRequest query and
// logs the response data or the error
;(async () => {
  try {
    const res = await apiClient.get(
        '?meters=17507~15635&key=MTAxMDoyMDIw&fmt=json&cnt=1');
    const apiResData = res.data;

    console.log(JSON.stringify(apiResData, null, 2));
  } catch (error) {
    console.error(error.message);
  }
})();

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

https://api.ekmpush.com/readMeter?meters=17507~15635&key=MTAxMDoyMDIw&fmt=json&cnt=1


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

https://api.ekmpush.com/readMeter?meters=17507~15635&key=MTAxMDoyMDIw&fmt=json&cnt=1

Click to try


Realtime Output Formats

Output format: XML

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

The above URL returns XML structured like this:

<readMeter Requested="1">
<ReadSet Meter="17507" Group="0" Send_Interval="60" Protocol="v3" MAC_Addr="40:16:fa:01:02:26" Tz_Offset_Sec="-25200" Bad_Reads="0" Good_Reads="1" Credits="1000000" Push_Version="Push2">
<ReadData Good="1" Date="2022-04-15" Time="10:27:15.141" Time_Stamp_UTC_ms="1650043635141" Firmware="15" Model="1710" kWh_Tot="50986.8" kWh_Tariff_1="5143.0" kWh_Tariff_2="45843.8" Rev_kWh_Tot="0.7" Rev_kWh_Tariff_1="0.4" Rev_kWh_Tariff_2="0.3" RMS_Volts_Ln_1="123.5" RMS_Volts_Ln_2="123.6" Amps_Ln_1="4.0" Amps_Ln_2="4.0" Power_Factor_Ln_1="100" Power_Factor_Ln_2="100" Power_Factor_Ln_3="200" Cos_Theta_Ln_1="1.00" Cos_Theta_Ln_2="1.00" Cos_Theta_Ln_3="0.00 C" RMS_Watts_Ln_1="498" RMS_Watts_Ln_2="498" RMS_Watts_Tot="998" RMS_Watts_Max_Demand="5050" Max_Demand_Period="1" CT_Ratio="200" Meter_Status_Code="00"/>
</ReadSet>
</readMeter>

Output format: JSON

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

The above URL returns JSON structured like this:

{
  "readMeter": {
    "Requested": 1,
    "ReadSet": [
      {
        "Meter": "17507",
        "Group": 0,
        "Send_Interval": 60,
        "Protocol": "v3",
        "MAC_Addr": "40:16:fa:01:02:26",
        "Tz_Offset_Sec": -25200,
        "Bad_Reads": 0,
        "Good_Reads": 1,
        "Credits": 1000000,
        "Push_Version": "Push2",
        "ReadData": [
          {
              "Good": 1,
              "Date": "2022-04-15",
              "Time": "10:27:15.141",
              "Time_Stamp_UTC_ms": 1650043635141,
              "Firmware": "15",
              "Model": "1710",
              "kWh_Tot": "50986.8",
              "kWh_Tariff_1": "5143.0",
              "kWh_Tariff_2": "45843.8",
              "Rev_kWh_Tot": "0.7",
              "Rev_kWh_Tariff_1": "0.4",
              "Rev_kWh_Tariff_2": "0.3",
              "RMS_Volts_Ln_1": "123.5",
              "RMS_Volts_Ln_2": "123.6",
              "Amps_Ln_1": "4.0",
              "Amps_Ln_2": "4.0",
              "Power_Factor_Ln_1": "100",
              "Power_Factor_Ln_2": "100",
              "Power_Factor_Ln_3": "200",
              "Cos_Theta_Ln_1": "1.00",
              "Cos_Theta_Ln_2": "1.00",
              "Cos_Theta_Ln_3": "0.00 C",
              "RMS_Watts_Ln_1": "498",
              "RMS_Watts_Ln_2": "498",
              "RMS_Watts_Tot": "998",
              "RMS_Watts_Max_Demand": "5050",
              "Max_Demand_Period": "1",
              "CT_Ratio": "200",
              "Meter_Status_Code": "00"
          }
        ]
      }
    ]
  }
}

Output format: CSV

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

The above URL returns CSV structured like this:

Meter,Good,Date,Time,Time_Stamp_UTC_ms,Meter_Time,Firmware,Model,Good_Reads_Ratio,Read_Attempts,kWh_Tot,kWh_Tariff_1,kWh_Tariff_2,kWh_Tariff_3,kWh_Tariff_4,Rev_kWh_Tot,Rev_kWh_Tariff_1,Rev_kWh_Tariff_2,Rev_kWh_Tariff_3,Rev_kWh_Tariff_4,RMS_Volts_Ln_1,RMS_Volts_Ln_2,RMS_Volts_Ln_3,Amps_Ln_1,Amps_Ln_2,Amps_Ln_3,Power_Factor_Ln_1,Power_Factor_Ln_2,Power_Factor_Ln_3,Cos_Theta_Ln_1,Cos_Theta_Ln_2,Cos_Theta_Ln_3,RMS_Watts_Ln_1,RMS_Watts_Ln_2,RMS_Watts_Ln_3,RMS_Watts_Tot,RMS_Watts_Max_Demand,Max_Demand_Period,CT_Ratio,Meter_Status_Code
17507,1,4/15/2022,10:27:15.141,1650043635141,,15,1710,,,50986.8,5143,45843.8,,,0.7,0.4,0.3,,,123.5,123.6,,4,4,,100,100,200,1,1,0.00 C,498,498,,998,5050,1,200,0

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

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

Example URL

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


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

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

Click to try


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

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

Click to try


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

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

Click to try


+

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

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

Click to try


URL Parameters

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

Realtime Number of Meter Reads

Number of Meter Readings

curl -s
"https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1000"
# Ruby Version: 3.1.2

# Load required modules
require 'net/http'
require 'json'
require 'uri'

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

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

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

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

'''
Python version: 3.9.12
'''

# Required Python Modules
import urllib.request
import urllib.error
import urllib.parse
import json
import pprint

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

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

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

<?php
// PHP 8.0.17 (cli)

// 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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1000');

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

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

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

}
?>
#!/usr/bin/perl
# Perl version: v5.34
# CPAN.pm version 2.2
# Perl Modules Version:
# JSON: 4.05
# LWP::Protocol::https: 6.10
# LWP::Simple: 6.62
#
# OS Prerequisites
# UBUNTU
# apt install cpanminus
#
# Install Perl Modules
#       cpan LWP::Simple
#       cpan LWP::Protocol::https
#       cpan JSON

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

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

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

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($api_object);    ## no critic (InputOutput::RequireCheckedSyscalls)

/*
 openjdk version "17.0.2" 2022-01-18

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

 This example uses version 20220320 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20220320/json-20220320.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-20220320.jar ./EKM.java
 4. Run
  java -cp .:./json-20220320.jar EKM
*/

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

@java.lang.SuppressWarnings({"java:S106", "java:S112", "java:S125"})

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();

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

    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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1000");

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

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

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

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

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

};

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

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
/*
* Requirements
* NodeJS: v16.14.2
* Axios:  0.27.2
*/

// Load modules
const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'https://api.ekmpush.com/readMeter',
  timeout: 1000 * 15,
})

// This code accesses the apiRequest query and
// logs the response data or the error
;(async () => {
  try {
    const res = await apiClient.get(
        '?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1000');
    const apiResData = res.data;

    console.log(JSON.stringify(apiResData, null, 2));
  } catch (error) {
    console.error(error.message);
  }
})();

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

https://api.ekmpush.com/readMeter?key=MTAxMDoyMDIw&fmt=json&cnt=READ_COUNT

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

https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=10


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

https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=10

Click to try


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

https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=READ_COUNT

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

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

Click to try


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

https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1000

Click to try


URL Parameters

Parameters Description
cnt Number of meter reads to display

Realtime Time Zones

Time Zones

curl -s
"https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles"
# Ruby Version: 3.1.2

# Load required modules
require 'net/http'
require 'json'
require 'uri'

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

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

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

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

'''
Python version: 3.9.12
'''

# Required Python Modules
import urllib.request
import urllib.error
import urllib.parse
import json
import pprint

# This function accesses the api_request URL and converts
# the contents to a usable Python object and returns it
def call_api ( api_request ):
    '''Make http request'''
    response = urllib.request.urlopen(api_request)
    response = response.read()
    json_object = json.loads(response.decode())
    return json_object

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

api_object = call_api("https://api.ekmpush.com/readMeter\
?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles")


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

<?php
// PHP 8.0.17 (cli)

// 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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles');

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

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

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

}
?>
#!/usr/bin/perl
# Perl version: v5.34
# CPAN.pm version 2.2
# Perl Modules Version:
# JSON: 4.05
# LWP::Protocol::https: 6.10
# LWP::Simple: 6.62
#
# OS Prerequisites
# UBUNTU
# apt install cpanminus
#
# Install Perl Modules
#       cpan LWP::Simple
#       cpan LWP::Protocol::https
#       cpan JSON

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

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

# Call the call_api function to create a usable
# object named api_object from the API request URL.
# Put the API request URL in the call
my $api_object = call_api(
'https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles'
);

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($api_object);    ## no critic (InputOutput::RequireCheckedSyscalls)

/*
 openjdk version "17.0.2" 2022-01-18

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

 This example uses version 20220320 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20220320/json-20220320.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-20220320.jar ./EKM.java
 4. Run
  java -cp .:./json-20220320.jar EKM
*/

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

@java.lang.SuppressWarnings({"java:S106", "java:S112", "java:S125"})

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();

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

    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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles");

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

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

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

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

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

};

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

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
/*
* Requirements
* NodeJS: v16.14.2
* Axios:  0.27.2
*/

// Load modules
const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'https://api.ekmpush.com/readMeter',
  timeout: 1000 * 15,
})

// This code accesses the apiRequest query and
// logs the response data or the error
;(async () => {
  try {
    const res = await apiClient.get(
        '?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles');
    const apiResData = res.data;

    console.log(JSON.stringify(apiResData, null, 2));
  } catch (error) {
    console.error(error.message);
  }
})();

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

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

https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=TIME_ZONE

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

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


The example link below will return the json data for the given parameters in the https address.

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

Click to try


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

Click for Time Zone Information

URL Parameters

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

Realtime Timestamp Call

Timestamp Data Call

curl -s
"https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919"
# Ruby Version: 3.1.2

# Load required modules
require 'net/http'
require 'json'
require 'uri'

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

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

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

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

'''
Python version: 3.9.12
'''

# Required Python Modules
import urllib.request
import urllib.error
import urllib.parse
import json
import pprint

# This function accesses the api_request URL and converts
# the contents to a usable Python object and returns it
def call_api ( api_request ):
    '''Make http request'''
    response = urllib.request.urlopen(api_request)
    response = response.read()
    json_object = json.loads(response.decode())
    return json_object

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

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

<?php
// PHP 8.0.17 (cli)

// 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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919');

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

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

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

}
?>
#!/usr/bin/perl
# Perl version: v5.34
# CPAN.pm version 2.2
# Perl Modules Version:
# JSON: 4.05
# LWP::Protocol::https: 6.10
# LWP::Simple: 6.62
#
# OS Prerequisites
# UBUNTU
# apt install cpanminus
#
# Install Perl Modules
#       cpan LWP::Simple
#       cpan LWP::Protocol::https
#       cpan JSON

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

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

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

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($api_object);    ## no critic (InputOutput::RequireCheckedSyscalls)

/*
 openjdk version "17.0.2" 2022-01-18

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

 This example uses version 20220320 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20220320/json-20220320.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-20220320.jar ./EKM.java
 4. Run
  java -cp .:./json-20220320.jar EKM
*/

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

@java.lang.SuppressWarnings({"java:S106", "java:S112", "java:S125"})

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();

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

    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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919");

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

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

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

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

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

};

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

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
/*
* Requirements
* NodeJS: v16.14.2
* Axios:  0.27.2
*/

// Load modules
const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'https://api.ekmpush.com/readMeter',
  timeout: 1000 * 15,
})

// This code accesses the apiRequest query and
// logs the response data or the error
;(async () => {
  try {
    const res = await apiClient.get('?meters=17507&key=MTAxMDoyMDIw&fmt=json&' +
        'cnt=10&tz=America~Los_Angeles&since=1415218436919');
    const apiResData = res.data;

    console.log(JSON.stringify(apiResData, null, 2));
  } catch (error) {
    console.error(error.message);
  }
})();

You can call all available data from a given timestamp.

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

https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&until=UNTIL

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

https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=SINCE

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

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

https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=10&tz=America~Los_Angeles&since=1415218436919

Click to try

URL Parameters

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

Realtime Date and Time

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

Realtime Start Date & End Date

Start Date & End Date

curl -s
"https://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_date=06112021&end_date=07112021"
# Ruby Version: 3.1.2

# Load required modules
require 'net/http'
require 'json'
require 'uri'

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

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

# Call the call_api method to create a usable
# object named api_object from the API request URI
# Put the API request URI in the call
# URI only NOT URL - Do not include https://api.ekmpush.com
api_object = call_api('/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json'\
  '&cnt=1&tz=America~Los_Angeles&start_date=06112021&end_date=07112021')

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

'''
Python version: 3.9.12
'''

# Required Python Modules
import urllib.request
import urllib.error
import urllib.parse
import json
import pprint

# This function accesses the api_request URL and converts
# the contents to a usable Python object and returns it
def call_api ( api_request ):
    '''Make http request'''
    response = urllib.request.urlopen(api_request)
    response = response.read()
    json_object = json.loads(response.decode())
    return json_object

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

api_object = call_api("https://api.ekmpush.com/readMeter\
?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles\
&start_date=06112021&end_date=07112021")


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

<?php
// PHP 8.0.17 (cli)

// 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://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_date=06112021&end_date=07112021');

// 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);

}
?>
#!/usr/bin/perl
# Perl version: v5.34
# CPAN.pm version 2.2
# Perl Modules Version:
# JSON: 4.05
# LWP::Protocol::https: 6.10
# LWP::Simple: 6.62
#
# OS Prerequisites
# UBUNTU
# apt install cpanminus
#
# Install Perl Modules
#       cpan LWP::Simple
#       cpan LWP::Protocol::https
#       cpan JSON

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

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

# Call the call_api function to create a usable
# object named api_object from the API request URL.
# Put the API request URL in the call
my $api_object = call_api(
'https://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_date=06112021&end_date=07112021'
);

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($api_object);    ## no critic (InputOutput::RequireCheckedSyscalls)

/*
 openjdk version "17.0.2" 2022-01-18

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

 This example uses version 20220320 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20220320/json-20220320.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-20220320.jar ./EKM.java
 4. Run
  java -cp .:./json-20220320.jar EKM
*/

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

@java.lang.SuppressWarnings({"java:S106", "java:S112", "java:S125"})

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();

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

    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://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_date=06112021&end_date=07112021");

        /*
         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://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_date=06112021&end_date=07112021',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>
/*
* Requirements
* NodeJS: v16.14.2
* Axios:  0.27.2
*/

// Load modules
const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'https://api.ekmpush.com/readMeter',
  timeout: 1000 * 15,
})

// This code accesses the apiRequest query and
// logs the response data or the error
;(async () => {
  try {
    const res = await apiClient.get(
        '?meters=300001290&key=MTAxMDoyMDIw&fmt=json&' +
        'cnt=1&tz=America~Los_Angeles&start_date=06112021&end_date=07112021');
    const apiResData = res.data;

    console.log(JSON.stringify(apiResData, null, 2));
  } catch (error) {
    console.error(error.message);
  }
})();

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

https://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_date=DDMMYYYY&end_date=DDMMYYYY

Date Parameter

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

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

https://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_date=06112021&end_date=07112021

Click to try

URL Parameters

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

Realtime Start Time & End Time

Start Time & End Time

curl -s
"https://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_time=062400&end_time=062500"
# Ruby Version: 3.1.2

# Load required modules
require 'net/http'
require 'json'
require 'uri'

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

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

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

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

'''
Python version: 3.9.12
'''

# Required Python Modules
import urllib.request
import urllib.error
import urllib.parse
import json
import pprint

# This function accesses the api_request URL and converts
# the contents to a usable Python object and returns it
def call_api ( api_request ):
    '''Make http request'''
    response = urllib.request.urlopen(api_request)
    response = response.read()
    json_object = json.loads(response.decode())
    return json_object

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

api_object = call_api("https://api.ekmpush.com/readMeter\
?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles\
&start_time=062400&end_time=062500")


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

<?php
// PHP 8.0.17 (cli)

// 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://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_time=062400&end_time=062500');

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

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

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

}
?>
#!/usr/bin/perl
# Perl version: v5.34
# CPAN.pm version 2.2
# Perl Modules Version:
# JSON: 4.05
# LWP::Protocol::https: 6.10
# LWP::Simple: 6.62
#
# OS Prerequisites
# UBUNTU
# apt install cpanminus
#
# Install Perl Modules
#       cpan LWP::Simple
#       cpan LWP::Protocol::https
#       cpan JSON

# Required Perl Modules3
use strict;
use warnings;
use LWP::Simple;
use JSON;
use Data::Dumper;

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

# Call the call_api function to create a usable
# object named api_object from the API request URL.
# Put the API request URL in the call
my $api_object = call_api(
'https://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_time=062400&end_time=062500'
);

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($api_object);    ## no critic (InputOutput::RequireCheckedSyscalls)

/*
 openjdk version "17.0.2" 2022-01-18

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

 This example uses version 20220320 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20220320/json-20220320.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-20220320.jar ./EKM.java
 4. Run
  java -cp .:./json-20220320.jar EKM
*/

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

@java.lang.SuppressWarnings({"java:S106", "java:S112", "java:S125"})

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();

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

    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://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_time=062400&end_time=062500");

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

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

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

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

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

};

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

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
/*
* Requirements
* NodeJS: v16.14.2
* Axios:  0.27.2
*/

// Load modules
const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'https://api.ekmpush.com/readMeter',
  timeout: 1000 * 15,
})

// This code accesses the apiRequest query and
// logs the response data or the error
;(async () => {
  try {
    const res = await apiClient.get('?meters=300001290&key=MTAxMDoyMDIw&' +
    'fmt=json&cnt=10&tz=America~Los_Angeles&start_time=062400&end_time=062500');
    const apiResData = res.data;

    console.log(JSON.stringify(apiResData, null, 2));
  } catch (error) {
    console.error(error.message);
  }
})();

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

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

https://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_date=30042021&start_time=HHMMSS&end_time=HHMMSS

Time Parameters

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

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

https://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&start_time=062400&end_time=062500

Click to try


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

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

https://api.ekmpush.com/readMeter?meters=300001290&key=MTAxMDoyMDIw&fmt=json&cnt=1000&tz=America~Los_Angeles&back=300

Click to try


URL Parameters

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

Realtime Fields

Fields

curl -s
"https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot"
# Ruby Version: 3.1.2

# Load required modules
require 'net/http'
require 'json'
require 'uri'

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

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

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

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

'''
Python version: 3.9.12
'''

# Required Python Modules
import urllib.request
import urllib.error
import urllib.parse
import json
import pprint

# This function accesses the api_request URL and converts
# the contents to a usable Python object and returns it
def call_api ( api_request ):
    '''Make http request'''
    response = urllib.request.urlopen(api_request)
    response = response.read()
    json_object = json.loads(response.decode())
    return json_object

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

api_object = call_api("https://api.ekmpush.com/readMeter\
?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles\
&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot")

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

<?php
// PHP 8.0.17 (cli)

// 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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot');

// This just displays the object but you can use what ever
// code you would like to work with the object here
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);

}

?>
#!/usr/bin/perl
# Perl version: v5.34
# CPAN.pm version 2.2
# Perl Modules Version:
# JSON: 4.05
# LWP::Protocol::https: 6.10
# LWP::Simple: 6.62
#
# OS Prerequisites
# UBUNTU
# apt install cpanminus
#
# Install Perl Modules
#       cpan LWP::Simple
#       cpan LWP::Protocol::https
#       cpan JSON

# Required Perl Modules3
use strict;
use warnings;
use LWP::Simple;
use JSON;
use Data::Dumper;

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

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

# This just displays the object but you can use what ever
# code you would like to work with the object here
print Dumper($api_object);    ## no critic (InputOutput::RequireCheckedSyscalls)

/*
 openjdk version "17.0.2" 2022-01-18

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

 This example uses version 20220320 accessible here:
 https://repo1.maven.org/maven2/org/json/json/20220320/json-20220320.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-20220320.jar ./EKM.java
 4. Run
  java -cp .:./json-20220320.jar EKM
*/

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

@java.lang.SuppressWarnings({"java:S106", "java:S112", "java:S125"})

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();

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

    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://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot");

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

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

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

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

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

};

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

</head>
  <body onload="example()">
    <div id="result"/>
  </body>
</html>
/*
* Requirements
* NodeJS: v16.14.2
* Axios:  0.27.2
*/

// Load modules
const axios = require('axios');

const apiClient = axios.create({
  baseURL: 'https://api.ekmpush.com/readMeter',
  timeout: 1000 * 15,
})

// This code accesses the apiRequest query and
// logs the response data or the error
;(async () => {
  try {
    const res = await apiClient.get('?meters=17507&key=MTAxMDoyMDIw&' +
    'fmt=json&cnt=1&tz=America~Los_Angeles&' +
    'fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot');
    const apiResData = res.data;

    console.log(JSON.stringify(apiResData, null, 2));
  } catch (error) {
    console.error(error.message);
  }
})();

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

https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&fields=FIELDS


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

https://api.ekmpush.com/readMeter?meters=17507&key=MTAxMDoyMDIw&fmt=json&cnt=1&tz=America~Los_Angeles&fields=kWh_Tot~Rev_kWh_Tot~RMS_Watts_Tot

Click to try


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

URL Parameters

The fields below are for the v3, v4 and v5 meters

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

The fields below are additional fields only for the v4 and v5 meters

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

Account API

Click here to go to Account API Documentation

This API provides information for accounts and devices owned by the account.

Get information for the specified target, which can be account, gateway, or meter.

You could make API request with the EKM Push Key that is your own Authorization Key that you received for your Push Account, or instead the EKM Push Key you could use Gateway Key for more restricted access. Be aware that if you use the Gateway Key, you will only receive information regards to that gateway.

Gateway Settings API

Click here to go to Gateway Settings API Documentation

This API is used to send commands and settings to devices connected to a Push3 gateway as well as the gateway device itself.

Trigger API

Click here to go to Trigger API Documentation

A REST API to lookup/create/update/delete triggers.

EKM Push3 gateway triggers are one of the most powerful tools that EKM has to offer. You can automate how and when the EKM Push system will react to metered values. You can have the Push gateway send you an email or control a relay to turn on/off a switch or close a valve based on the metered data for example. Push3 gateways have the ability trigger specific actions based on conditions that you set up. Triggers live on the Push3 gateways so they will continue to function even without an internet connection. Triggers can control the relays on the v.4 Omnimeters, in order to turn something on or off, or they can email you notifications of the trigger. Please note: v.3 Omnimeters do not have controllable relays, so the relay triggers will not work, but the email triggers will.

Summary API

Click here to go to Summary Documentation

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

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

We also have a Summary API Request Builder Tool found here: Summary API Builder

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/v.5 Meter Settings Protocol

v.4/v.5 Meter Parsing

v.4/v.5 Meter Alternate Modbus Protocol

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

Status Codes

EKM uses conventional HTTP response codes in addition to our API Status 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).

The EKM API uses the following API specific Status codes:

API Status Code Meaning
1000 There is not data for: {meters}
1001 There is not data for: {meters} between ${startDate} and ${endDate}
1002 There is not data for: {meters} This meter first reported on:
1003 There is not data for: {meters} This meter last reported on:
1004 Timezone is not supported for this date range request
1100 All invalid query requests
1101 Invalid format
1102 Invalid value
1103 Invalid parameter
1200 Found invalid meter: {meter} for key: MTAxMDoyMDIw
1300 Oops! It looks like there was an unexpected error. Try checking your query for issues or hold tight while we see what we can do. This error has been reported.

The EKM API also uses the following HTTP Status codes:

HTTP Status Code Meaning
200 OK – The request succeeded.
400 Bad Request – The server could not understand the request due to invalid syntax.
401 Unauthorized – Although the HTTP standard specifies “unauthorized”, semantically this response means “unauthenticated”. That is, the client must authenticate itself to get the requested response.
403 Forbidden – The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client’s identity is known to the server.
404 Not Found – The server can not find the requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 Forbidden to hide the existence of a resource from an unauthorized client. This response code is probably the most well known due to its frequent occurrence on the web.
429 Too Many Requests – The user has sent too many requests in a given amount of time (“rate limiting”).
500 Internal Server Error – The server has encountered a situation it does not know how to handle.
501 Not Implemented – The Vertical Bar otherwise known as “pipe” request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD.
502 Bad Gateway – This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response.
503 Service Unavailable – The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This response should be used for temporary conditions and the Retry-After HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached.
504 Gateway Timeout – This error response is given when the server is acting as a gateway and cannot get a response in time.
505 HTTP Version Not Supported – The HTTP version used in the request is not supported by the server.
506 Variant Also Negotiates – The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.
510 Not Extended – Further extensions to the request are required for the server to fulfill it.
511 Network Authentication Required – Indicates that the client needs to authenticate to gain network access.