The Climatiq API is designed to help developers build tools to automate calculation of the environmental impact of any business or organization's activity.
The API is organized around REST. It has predictable resource-oriented URLs; accepts JSON-encoded request bodies; returns JSON-encoded responses; and uses standard HTTP response codes, authentication, and verbs. To help maintain security, all requests must be made over HTTPS. Calls made over plain HTTP will fail.
Every operation on our REST API requires authentication using an API key. Detailed information can be found on our Authentication page.
The Climatiq API uses conventional HTTP response codes to indicate the success or failure of an API request, such as
200 for "OK", and
400 for "Bad Request".
The full list of status codes used, and errors returned can be found here.
To enable compression, define an
Accept-Encoding header with the value
gzip for gzip compression
br for brotli compression.