> ## 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.

# Splitwise plugin

> Read and write a Splitwise account: groups, friends, expenses, comments and notifications.

Use **Splitwise** through Corsair: one client, typed API calls.

Create a personal key on your app's details page at [https://secure.splitwise.com/apps](https://secure.splitwise.com/apps), or use an OAuth access token. Send it as a Bearer token. Registering an app needs an active Splitwise Pro subscription (as of 11-2026).

Things to know before you write:

* **Money is a string.** Splitwise sends every amount as a decimal string such as `"25.0"`, and this plugin keeps that type in its outputs. Inputs take a number and send it as a two-decimal string.
* **A 200 can mean the write failed.** `groups.delete`, `groups.undelete`, `groups.addUser`, `groups.removeUser` and the expense writes answer 200 with `success: false` or a populated `errors` map. The plugin throws `SplitwiseOperationError` in that case, so a resolved promise means the write applied.
* **Updates replace shares.** Passing `users` to `expenses.update` replaces every share on the expense. The schema requires `cost` alongside it.
* **Splitting.** `expenses.create` takes either `split_equally: true` with a `group_id`, or a `users` list whose paid and owed amounts add up to `cost` in whole cents. Amounts take at most two decimal places. Both are checked before the request.
* **Writes that reach people are destructive.** Adding friends or group members invites them by email, and creating or editing an expense or commenting notifies the people on it. `friends.add`, `friends.addMany`, `groups.create`, `groups.addUser`, `expenses.create`, `expenses.update` and `comments.create` are `destructive`.
* **Errors.** HTTP failures are core's `ApiError`. `describeSplitwiseError` reads the message out of either error body, and `isNotLoggedIn` spots the 401 for a missing or revoked key.
* **Categories.** An expense must use a subcategory from `categories.list`; a parent category is rejected by the API.
* **Rate limits.** Splitwise answers 429 when you exceed them and does not publish the exact limits. Core retries a 429 up to three times, honouring `Retry-After`.
* **Reads only are replayed.** A 5xx is retried for a read. `expenses.create` is not idempotent, so a failed write is returned rather than sent again.

**What you get:**

* 27 typed API operations

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/splitwise 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 { splitwise } from '@corsair-dev/splitwise';

export const corsair = createCorsair({
	plugins: [
		splitwise(),
	],
	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 Splitwise API key before the first call: `pnpm corsair setup --plugin=splitwise --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}
> splitwise()
> ```
>
> 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: 'splitwise',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List your groups**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.splitwise.api.groups.list({});
```

**Split a brunch bill between two people**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.splitwise.api.expenses.create({
	description: 'Brunch',
	cost: 25,
	users: [{ user_id: 270896089, paid_share: 25, owed_share: 12.5 }, { user_id: 491923, paid_share: 0, owed_share: 12.5 }],
});
```

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

## What's next

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

> [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.