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

# Stack Exchange plugin

> Read public and authenticated Stack Exchange content across individual sites and the network, and invoke documented API v2.3 write methods with OAuth user authorization.

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

Select a documented method with the route field. Per-site methods require a site parameter; network methods do not. OAuth connection requests the documented `read_inbox`, `write_access`, and `private_info` scopes together so every user-context method can be called, plus `no_expiry`, because Stack Exchange issues no refresh token. Stack Exchange requires a registered redirect URI. Anonymous and app-key requests can read pages 1 to 25 only.

**What you get:**

* 3 typed API operations

## Setup

**1. Install**

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

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

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

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

export const corsair = createCorsair({
	plugins: [
		stackexchange(),
	],
	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 Stack Exchange API key before the first call: `pnpm corsair setup --plugin=stackexchange --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}
> stackexchange()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

> [tab] OAuth 2.0
>
> Open [hub.corsair.dev](https://hub.corsair.dev/dashboard), navigate to your project, and enter the **client ID** and **client secret** from your Stack Exchange OAuth app.
>
> ```ts theme={null}
> stackexchange({
> 	authType: 'oauth_2',
> })
> ```
>
> More: [OAuth 2.0](https://docs.corsair.dev/concepts/oauth)

**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: 'stackexchange',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List recent Stack Overflow questions**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.stackexchange.api.site.read({
	route: 'questions',
	site: 'stackoverflow',
	parameters: { pagesize: 10 },
});
```

**Preview question markdown**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.stackexchange.api.site.write({
	route: 'render-question',
	site: 'stackoverflow',
	parameters: { title: 'A question about API integration', body: 'Markdown body for rendering only', tags: 'api;testing' },
});
```

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

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/stackexchange/api.md)
>
> Every `stackexchange.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.