Authentication

How to authenticated with the Etainabl API

The Etainabl API uses API key authentication. All requests must include your API key in the x-api-key header.

Getting Your API Key

API keys must be requested via Etainabl support. Once issued, your key will be in the format:

USERID:{encryptedKey}

Making Authenticated Requests

Include the x-api-key header in every request:

curl -X GET "https://api.etainabl.com/2.0/assets" \
  -H "x-api-key: YOUR_API_KEY"

Rate Limiting

All API endpoints are rate limited. If you exceed the rate limit, you will receive a 429 Too Many Requests response. Please implement appropriate backoff and retry logic in your integration.

Scopes

Your API key is associated with a role that determines which resources you can access. The available scopes are:

ScopeDescription
read:accountsList and retrieve accounts (meters); also required for consumption and emissions analytics
read:assetsList and retrieve assets (sites)
read:invoicesList and retrieve invoices
read:readingsList and retrieve readings
read:consumptionsList and retrieve non-cumulative/interval consumption data

Base URL

All API endpoints are served from:

https://api.etainabl.com/2.0

Note: The deprecated x-public-api-key header is no longer recommended. Please use x-api-key for all new integrations.