> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Ecologi plugin

> Fund tree planting, carbon avoidance, carbon removal and habitat restoration through Ecologi's Impact API, and read any profile's impact totals.

Use **Ecologi** through Corsair: one client, typed API calls, local DB sync.

The reporting reads (`*.get`) are public: they send no API key and work for any Ecologi username. An unknown username returns HTTP 404. The username is the row id and is not written to the event.

The purchase operations (`*.purchase`, `trees.purchaseLocal`) spend money. They need the API key from Ecologi's Impact API page, sent as a Bearer token, and are billed to the account on the 1st of each month (minimum invoice GBP 3). Pass `test: true` to get the expected response without being charged. Send an `idempotencyKey` so a retried request is not bought twice. The `name` is shown publicly on a public profile, so don't send a customer's name without permission. A `recipientEmail` sends that person an email about the purchase.

**What you get:**

* 10 typed API operations
* 5 synced entities (`carbonOffsets`, `carbonRemovals`, `habitats`, `impacts`, `trees`) for fast `.search()` / `.list()`

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/ecologi better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/ecologi better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/ecologi better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/ecologi better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { ecologi } from '@corsair-dev/ecologi';

export const corsair = createCorsair({
	plugins: [
		ecologi(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Ecologi API key before the first call: `pnpm corsair setup --plugin=ecologi --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> ecologi()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'ecologi',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Read trees**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.ecologi.api.trees.get({ username: 'ecologi' });
```

**`carbonOffsets.purchase`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.ecologi.api.carbonOffsets.purchase({});
```

See the full list on the [API](https://docs.corsair.dev/plugins/ecologi/api.md) page.

## Query synced data

Synced entities support `tenant.ecologi.db.<entity>.search()` and `.list()`: `carbonOffsets`, `carbonRemovals`, `habitats`, `impacts`, `trees`.

See [Database](https://docs.corsair.dev/plugins/ecologi/database.md) for filters and operators.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/ecologi/api.md)
>
> Every `ecologi.api.*` operation with input and output types.

> [card] [Database](https://docs.corsair.dev/plugins/ecologi/database.md)
>
> Synced entities, search filters, and operators.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.