AMEE Developer Centre

Table of Contents

  1. Latest News: AMEE 2 Released!
  2. Getting Started
    1. Act On CO2
  3. Contents

Welcome to the AMEE Developer site. AMEE is a neutral, open platform for measuring energy consumption. This platform is exposed as a RESTful HTTP-based web service with XML, JSON and Atom interfaces.

Latest News: AMEE 2 Released!

Version 2 of the AMEE API has recently been released, with major new functionality such as enhanced time resolution, built-in unit conversions, and Atom support. See What's New in AMEE 2 for all the details. Most changes are in the Profile API, and the documentation there has been updated with the latest information.

Getting Started

First, sign up for an API key. You will then be emailed a username, password and URL. If you enter the URL in a web browser, you can browse AMEE via a built-in web interface. The URLs in this web interface are exactly the same as the URLs you will use in your code, so it is a good way to explore.

AMEE allows you to store many kinds of energy data, ranging from precise measurements of electricty usage, up to generalised calculations of emissions for entire buildings. To store this energy data in AMEE, you add data to a Profile. The API performs calculations for each ProfileItem item you enter and calculates CO2 emissions based on a combination of built-in emissions factors and the data that you provide.

The documentation below describes the AMEE API, which consists of a number of different resource types. Each resource type represents multiple types of data. To find out what data and methodologies are available through the API, visit our data wiki.

Act On CO2

If you want to duplicate the functionality of the ActOnCO2 calculator, good starting points are the description and spreadsheets on the wiki.

Contents

Attachments