README.md

AMEEconnect Documentation (v3)

How to get started with ameeConnect

• Sign up for API credentials at https://www.amee.com/api
• Find the model for the activity you want to measure (i.e. transport, electricty, manufacturing processes) on discover.amee.com
• Read over the quickstart and docs to see how to make requests for the model you're using.

How to get help

1. If there's anything that isn't clear about the API, the first place after the docs to go is the knowledge base there help.amee.com.

2. The next best place is either to ask on the developer mailing list if you have a question you would happily share publicly.

3. Finally the question is more suited to private conversation, you can contact our support team directly at help@amee.com.

Table of Contents

Introduction

• About This Manual
• Before You Start
• API Versions

Quick Start

• Getting Started
• Choose Your Model
• Do the Calculation

Get Emission Factors

• Models and Contexts
• Using AMEEdiscover
• Fetching Emission Factors

Perform Calculations

• Doing a Calculation
• Getting Results
• Store Data
• Using AMEEconnect to Store Data
• Creating a Profile
• Storing Inputs
• Fetching Return Values
• List Stored Profile Items
• Building Time Series
• Naming Profile Items
• Time Series Queries

Advanced Options

• Specifying API Version
• Units
• Matrix Parameters
• Search
• Authority
• Paging
• Interactive Context Selection

AMEEconnect API reference

• Models
• Contexts
• Emission Factors
• Profiles
• Profile Items
• Batch Operations
• Search
• Authentication
• UIDs
• Date and Time Representation

References

Example Apps and Libraries

Other versions of this documentation

This is the documentation for AMEEconnect, API version 3, written in Markdown. For version 2 documentation, please check out the v2_maintenance branch. the v2_maintenance branch relies on docbook to generate html documentation.

License

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.