GreenHub

# Getting Started

TIP

Before start using the GreenHub API, be sure to understand our privacy policy. You can read it here.

The GreenHub API provides access to the project's data repository. The repository contains real-world data gathered from a diverse population of Android devices.

Using the API you will be able to query all the data collected from the Android devices via our app BatteryHub.

# Create An Account

In order to start using the GreenHub API, first you will need to create an account in our GreenHub Farmer web app.

  1. Head over to https://farmer.greenhubproject.org/register.
  2. Fill the necessary fields to complete the registration process.
  3. After you create your account, it will be necessary to verify your email address.
  4. So check your inbox, and follow the email instructions you just got.
  5. You should be redirected to the GreenHub Farmer homepage and you should be able to see the dashboard contents.

You can now login with your credentials and use the web app at https://farmer.greenhubproject.org/login.

That's it! It will only takes a couple of minutes to create an account.

# Obtaining The API Key

WARNING

You must verify your account before having access to the API key!

Once logged-in, you will find a section called API Credentials as shown on the image below:

alt text

Then copy your API token and keep it in a save place. You can now start using the GreenHub API and the other services.

← Schema →