Introduction

The MyHomeEQ Usage Calculation API using Green Button provides a modern, RESTful, scalable solution to the problem of reading Green Button data for Realtors and Real Estate data providers.

Specifications

Endpoint

https://www.myhomeeq.com/usage-calc/

Content Negotiation

The Usage Calculation API will respond to all requests with a document type of "application/json". Data will be returned as a JSON object.

Test Green Button XML Files

These ComEd-based, Green Button formatted files are for demonstration purposes only, and contain realistic dummy data.

Usage

Version

Request

Method Path Parameters Description
GET /version None The current version number of the API.

Response

Example Description
 {
  "data": {
   "api_version": "0.9"
  }
 }

Usage Calculation

Request

Method Path Parameters Description
POST / {
 "utility_name ":"ComEd",
 "xml":"<?xml version='1.0' encoding='UTF-8'?> [...] "
}
Request for cost summary information using a Green Button XML file as input. Both "utility_name" and "xml" fields are required. Currently only "ComEd" is supported for "utility_name".

Response

Example Description
{
  "data": {
   "number_of_months_in_period": 12,
   "start_date": "07/14/2015",
   "end_date": "08/12/2014",
   "period_electric_cost": "500.47",
   "period_average_monthly_electric_cost": "41.71"
 }
}
A JSON list of yearly cost and average monthly cost of the last year's worth of data available.

Created by MyHomeEQ