Public
Documentation Settings

Emitrr Public API

Welcome to the official documentation of Emitrr API specification. This API documentation will provide you all the necessary information to interact with Emitrr.

If you have any questions or problems please contact support at

support@emitrr.com

Common VariablesDescription
api_urlAPIs are accessed from this URL.
api_keyToken-based authentication to allow accessing the APIs.
account_idUnique ID of your account portal.
location_idUnique ID of your location portal under the account portal.

Errors

Emitrr uses traditional HTTP response codes to indicate the 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 failed given the information provided (e.g., a required parameter was not provided, invalid details provided, etc.). Codes in the 5xx range indicate an error with Emitrr's servers (these are rare).

Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.

HTTP Status Code Detail
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to validation error.
401 - Invalid API KeyInvalid or Expired API key.
403 - ForbiddenAPI key / User doesn't have permissions to perform the request.
403 - Quota exceededThe resource usage has exceeded the limits defined in the subscribed billing plan.
404 - Not FoundThe requested resource doesn't exist.
500, 502, 503, 504 - Server ErrorsSomething went wrong on Emitrr's end.