API

Overview

The Helium API allows you to manage your account, campaigns, ads, or generate reports. This documentation provides you the required information to successfully make use of the API. The Helium API is organized around REST. 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, such as HTTP authentication and HTTP terminology, which are understood by off-the-shelf HTTP clients. JSON is returned in all responses from the API, including errors.

Authentication

You authenticate to the Helium API by providing your API key in the request. Keep your credentials secret. Authentication to the API occurs via HTTP Basic Auth. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate for all requests. curl uses the -u flag to pass basic auth credentials. Adding a colon : after your API key will prevent it from asking you for a password. To receive data or make changes to your account, replace the example API key with your actual API key.

Errors

Helium uses conventional HTTP response codes to indicate 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 resulted from the provided information (e.g. a required parameter was missing or invalid), and codes in the 5xx range indicate an error with Helium's servers.