Endpoints overview
This page gives an overview of the ekko Climate API endpoints. For full request and response schemas, see the API reference.
The base URL for all endpoints is:
https://api.ekko.earth/v3All requests must be made over HTTPS and authenticated with your API key in the Authorization header as a Bearer token. See Authentication and security for details.
Endpoint groups
Organisations
Manage organisations in your hierarchy.
| Method | Endpoint | Description |
|---|---|---|
POST | /organisations | Create an organisation |
GET | /organisations/{id} | Get organisation |
Quotes
Generate footprint calculations and lock in pricing. Carbon returns a carbon footprint, nature returns a biodiversity footprint in Mean Species Abundance (MSA). See Footprinting for how the two compare and nature footprint methodology for the biodiversity metric.
| Method | Endpoint | Description |
|---|---|---|
POST | /quotes/carbon | Create a carbon quote |
POST | /quotes/nature | Create a nature quote |
Direct API integration only
The quote endpoints are used in direct API integrations. If you're using an SDK, the quote is generated automatically in the backend.
SDK sessions
Create sessions for the ekko SDKs.
| Method | Endpoint | Description |
|---|---|---|
POST | /checkout/sessions | Create a checkout SDK session |
POST | /post-purchase/sessions | Create a post-purchase SDK session |
ImpactPay
Create sessions for the hosted ImpactPay experience.
| Method | Endpoint | Description |
|---|---|---|
POST | /impactpay/sessions | Create an ImpactPay session |
Funds
Allocate funds to projects, reverse allocations and retrieve reconciliation records.
| Method | Endpoint | Description |
|---|---|---|
POST | /funds/allocations | Allocate funds to a project |
POST | /funds/allocations/{id}/reverse | Reverse a funds allocation |
GET | /funds/allocations/impact | List impact recon records |
GET | /funds/allocations/{id}/impact | Get impact recon record |
GET | /funds/allocations/profit-share | List profit share recon records |
GET | /funds/allocations/{id}/profit-share | Get profit share recon record |
Impact partners and projects
Retrieve details on impact partners and their projects.
| Method | Endpoint | Description |
|---|---|---|
GET | /impact-partners | View impact partner details |
GET | /impact-partners/projects | View project details |