SQUAKE API Documentation

Introduction

Trusted technology to achieve your carbon targets.

The SQUAKE Solution Suite is live with industry leaders from several travel and logistics segments and performs accurate carbon calculations for all types of activities (e.g. flights, road, accommodation amongst others) according to national and international standards. It automates carbon reductions and/or compensations along the supply chain, from supplier selection (SAF, DAC, ecological restoration) to inventory management, invoicing and credit retirement.

Customer Support

For any issues or inquiries, you can reach our dedicated customer support team through our Support Page. This is the best place to ask questions, report incidents, or get assistance with integrating or using SQUAKE's solutions.

Contact Forms

Our contact forms are designed to help you communicate with us effectively. Whether you want to get in contact with our support team or need to report an incident, we've got you covered. Please use the appropriate form below:

  • Contact Form: Get in contact with our customer support team or share your thoughts and suggestions about our services and processes.
  • Incident Form: Report any issues or incidents you've encountered, and our support team will respond as soon as possible.

Authentication

SQUAKE uses API keys to authenticate requests. You can create and revoke API keys in the Dashboard, which you can access by contacting us under product@squake.earth. You should securely store your API keys; and encrypt them on rest if possible. Be aware that each API key is shown exactly once in the UI during creation. SQUAKE advises rotating API keys on a regular basis.

To use the sandbox environment, a separate API key must be created. Switch to sandbox mode in the dashboard, then create an API key.

All requests must be authenticated and made over HTTPS. SQUAKE supports TLS 1.2 - TLS 1.3. Requests without authentication or via plain HTTP result in an error.

When using HTTP Basic Auth, the API key is the username; leave the password blank. For bearer auth, pass the API key as the token.

Example using HTTP Basic Auth (note: there is no password, but a colon is still required):

curl https://api.squake.earth/v2/pricing -u <YOUR_API_KEY>

Example using bearer auth:

curl https://api.squake.earth/v2/pricing -H "Authorization: Bearer <YOUR_API_KEY>"

Request ID

SQUAKE associates each API request with a unique identifier. Find this value in the SQUAKE-Request-Id header. If you need to contact us regarding a specific request, providing the request identifier helps the resolution process.

Uptime Monitoring

Please visit status.squake.earth to check our uptime monitor. You can subscribe to events to stay informed of any service disruption. We will also publish a post-mortem about any incident should one occur.

You can programmatically check if servers are reachable. Read the documentation of the Health Check endpoints for details. The health check endpoints are the only endpoints that do not require authentication.

Sandbox

There is a sandbox server available for testing at

https://api.sandbox.squake.earth

Sandbox and production are separate systems and share no data. Sandbox uses less computing power and may be slower than production. Both sandbox and production environments run the same version of the API; thus, they share the same feature set.

To use the sandbox environment, a separate API key must be created. Switch to sandbox mode in the dashboard, then create an API key.

Static IP Addresses

All outgoing traffic originates from one of the following static IP addresses. SQUAKE owns these IP addresses and never shares them for any other traffic.

EnvironmentIP AddressGeo Region
Production52.59.66.213Europa/Germany
Production52.7.39.159USA
Sandbox18.197.251.125Europa/Germany

Getting Started with SQUAKE API

This guide will help you make requests to the SQUAKE API in order to calculate emissions for a travel journey.

Choose a group of Endpoints

SQUAKE API has the following group of endpoints:

  • Calculations - Calculates carbon emissions for various activities in a low-latency process.
  • Pricing - Returns pricing for a given product and carbon quantity, valid for two weeks by default.
  • Combined Calculation & Pricing - Performs carbon calculation and pricing in a single call for convenience.
  • Carbon Comparison - Compares carbon quantities to recognizable items like cars or light bulbs.
  • Purchases - Registers a purchase to compensate for carbon emissions, requiring a prior pricing quote.
  • Products - Lists purchasable compensation options, including single climate projects and bundles.
  • Files - Manages file attachments related to purchases, such as compensation confirmations.
  • Webhooks - Allows you to receive notifications about events happening in SQUAKE.
  • Audits - Provides a list of audits or a specific audit for calculations.
  • Health Check - Verifies if SQUAKE's server is reachable.

Precision of Calculations

Bus Databases

If you want operator-specific calculations for buses, then use the following dataset supported by SQUAKE's methodology.

Car Databases

If you have specific information about car models, then use one of the following methodologies: ADEME (France), US-EPA (USA) and EU-EEA (EU).

Hotel Databases

Use the HCMI and SQUAKE methodologies database to obtain more accurate emissions. If you know an eco-label, use SQUAKE's eco-label dataset.

GLEC Databases

For road and sea logistics activities according to GLEC, use the GLEC dataset.

Train Databases

For operator-specific calculations for trains, use the train dataset.

Van Databases

For van calculations, use the EU-EEA supported dataset.

Carbon Comparison

Compare carbon quantities to more recognizable items like cars or kettles. View accepted units in this comparison database.


Download OpenAPI description
Languages
Servers
Production

https://api.squake.earth/

Sandbox

https://api.sandbox.squake.earth/

Calculations

Operations

Pricing

Operations

Combined Calculation & Pricing

Operations

Carbon Comparison

Operations

Purchases

Operations

Products

Operations

Retrieve Products

Request

A product is any purchasable compensation option SQUAKE offers. In the simplest case, a product maps to a single climate project such as "Sustainable Biofuel for Shipping". Depending on client need, SQUAKE also offers bundles of multiple climate projects; these can be centered around specific goals, e.g.,"carbon reduction", "location", or what is desired to achieve a particular price point or sustainability goal. Feel free to contact us for more information or custom products.

Security
Bearer-Auth
Query
localestring(Locale)[ 2 .. 5 ] characters^(?:[a-z]{2}|[a-z]{2}-[A-Z]{2})$

Descriptions of products can be localized.

Default "en"
Enum"de""en""es""fr""hi""it""ja""pt""pt-BR""zh-CN"
pagenumber>= 1

An optional parameter that enables pagination, by default the amount of items per page is 25

itemsnumber[ 1 .. 25 ]

An optional parameter that enables pagination, this controls the amount of items per page. Can be used separetly or in conjunction with page

categorystring

Allows filtering of the categories of a product, filters by code

classstring

Allows filtering of the classes of a product, filters by code

impact_typestring

Allows filtering of the impact types of a product, filters by code

curl -i -X GET \
  'https://api.squake.earth/v2/products?category=Water&class=Nature%20Based&impact_type=string&items=5&locale=en&page=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Headers
SQUAKE-Request-Idany(SQUAKE-Request-Id)

Unique identifier linked to this API request. If you need to contact us regarding a specific request, providing the request identifier helps the resolution process.

Bodyapplication/jsonArray [
idstringproduct_[A-Za-z0-9]*required
locationsArray of objects(Location)

List of all locations impacted by the projects used in this product.

certificationsArray of strings(Certification)

List of all certifications the projects for this product hold.

Items Enum"American Carbon Registry""Australian Biodiversity Unit""BAFU VER""Clean Development Mechanism""DNV""Ernst & Young""European Biochar Certification""Gold Standard CER""Gold Standard VER""I-REC"
titlestring

A short human readable summary of the description.

descriptionstring

A human readable description.

sdgsArray of integers

The Sustainable Development Goals (SDGs) aim to transform our world. They are a call to action to end poverty and inequality, protect the planet, and ensure that all people enjoy health, justice and prosperity.

filesArray of objects(File)

Images attached to the product.

pricesArray of objects(Price)

Multiple prices may exist, for example, when future price changes are already known.

categoriesArray of objects(ProductCategory)
impact_typesArray of objects(ImpactType)
classesArray of objects(ProjectClass)
]
Response
application/json
[ { "id": "product_2rsg35sfsdf", "locations": [], "certifications": [], "title": "string", "description": "string", "sdgs": [], "files": [], "prices": [], "categories": [], "impact_types": [], "classes": [] } ]

Retrieve a Product

Request

Retrieve details about a specific product

Security
Bearer-Auth
Path
idstringrequired

The product ID

Query
localestring(Locale)[ 2 .. 5 ] characters^(?:[a-z]{2}|[a-z]{2}-[A-Z]{2})$

Descriptions of products can be localized.

Default "en"
Enum"de""en""es""fr""hi""it""ja""pt""pt-BR""zh-CN"
curl -i -X GET \
  'https://api.squake.earth/v2/products/{id}?locale=en' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Headers
SQUAKE-Request-Idany(SQUAKE-Request-Id)

Unique identifier linked to this API request. If you need to contact us regarding a specific request, providing the request identifier helps the resolution process.

Bodyapplication/json
idstringproduct_[A-Za-z0-9]*required
locationsArray of objects(Location)

List of all locations impacted by the projects used in this product.

certificationsArray of strings(Certification)

List of all certifications the projects for this product hold.

Items Enum"American Carbon Registry""Australian Biodiversity Unit""BAFU VER""Clean Development Mechanism""DNV""Ernst & Young""European Biochar Certification""Gold Standard CER""Gold Standard VER""I-REC"
titlestring

A short human readable summary of the description.

descriptionstring

A human readable description.

sdgsArray of integers

The Sustainable Development Goals (SDGs) aim to transform our world. They are a call to action to end poverty and inequality, protect the planet, and ensure that all people enjoy health, justice and prosperity.

filesArray of objects(File)

Images attached to the product.

pricesArray of objects(Price)

Multiple prices may exist, for example, when future price changes are already known.

categoriesArray of objects(ProductCategory)
impact_typesArray of objects(ImpactType)
classesArray of objects(ProjectClass)
Response
application/json
{ "id": "product_2rsg35sfsdf", "locations": [ {} ], "certifications": [ "European Biochar Certification" ], "title": "string", "description": "string", "sdgs": [ 7 ], "files": [ {} ], "prices": [ {} ], "categories": [ {} ], "impact_types": [ {} ], "classes": [ {} ] }

Files

Operations

Webhooks

Operations

Audits

Audit logs are created when enabled on calculation requests.

ℹ️ To use this feature you need to have it enabled for your account, please contact us for more information.
Operations

Health Check

Check if SQUAKE's server can be reached.

Operations