API Design

The LiveAPI is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the LiveAPI for free in Development mode with some limitations. This does not affect your data in Production mode, nor does it interact with any production instance. It is an environment that offers functionality for testing.

Production mode offers you full, unlimited access to every feature of your selected plan, and begins processing live requests when in use.


LiveAPI uses access tokens to authenticate the API requests. To make a successful request to access a resource in LiveAPI, you must pass a Token ID and Secret key in the authorization header of each request.

The Authentication is performed via HTTP basic auth where you pass the Token ID in the username value and the Secret key in the password value.

API Protocol

The LiveAPI follows the REST standard taking advantage of HTTP methodologies defined by the RFC 2616 protocol. It uses GET/POST requests to communicate and HTTP response codes to indicate status and errors.

All responses come in the standard JSON and all requests must include Content-Type: application/json Header, and a valid JSON body when applicable.


For more information on Access Tokens and authenticating request, refer to this guide.