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

# IP2Proxy plugin

> Detect whether an IP address is a proxy, VPN, Tor exit, or data-center address, and return the location fields for the selected package.

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

Each lookup spends credits. PX1 spends 1 credit and PX11 spends 11. A successful body has `response` set to `OK`. Any other `response` is a failed lookup.

IP2Location no longer takes new registrations for the IP2Proxy web service; keys from existing accounts keep working. New users get proxy data from IP2Location.io instead.

**What you get:**

* 2 typed API operations
* 1 synced entity (`checks`) for fast `.search()` / `.list()`

## Setup

**1. Install**

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

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

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

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

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

## Example API calls

**Check whether an IP is a proxy**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.ip2proxy.api.proxy.checkProxy({ ip: '8.8.8.8' });
```

**Write**

*No write-style endpoint inferred; pick any operation from the [API](https://docs.corsair.dev/plugins/ip2proxy/api.md) reference.*

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

## Query synced data

Synced entities support `tenant.ip2proxy.db.<entity>.search()` and `.list()`: `checks`.

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

## What's next

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

> [card] [Database](https://docs.corsair.dev/plugins/ip2proxy/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.