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

# Piloterr plugin

> Piloterr is a scraping API for public web data. This plugin fetches and renders pages, captures screenshots, detects website technology, extracts contact details, scrapes Google search and news, reads LinkedIn companies, profiles, jobs and posts, and finds and verifies professional emails.

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

Authenticate with the API key from your Piloterr dashboard; the plugin sends it in the x-api-key header. Every operation is a GET against [https://api.piloterr.com](https://api.piloterr.com) and each call costs the credits listed on the endpoint page (account.usage and account.getJob are free). Errors answer \{"error": "\<message>"}; Piloterr signals rate limits as 401 with a "Rate limit exceeded" message rather than 429, and the plugin retries those twice with core's exponential backoff (1 s, then 2 s), unless the message reports an exhausted quota. The docs prescribe exponential backoff for 500s only; 400/402/403 are never retried.
The fields global parameter filters the response by comma-separated field names with dot notation. soft\_fail and is\_async are not part of this plugin (a failed call surfaces as an error with Piloterr's message); poll jobs started elsewhere with account.getJob.
web.crawler and web.webunlocker answer a JSON-encoded HTML string, web.rendering the rendered HTML, and web.screenshot a base64-encoded file. web.webunlocker only works for domains on Piloterr's whitelist. Every operation is described in the official reference: [https://docs.piloterr.com/reference](https://docs.piloterr.com/reference)

**What you get:**

* 19 typed API operations

## Setup

**1. Install**

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

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

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

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

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

## Example API calls

**Enrich a company by domain**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.piloterr.api.linkedin.companyInfo({ domain: 'guideflow.com' });
```

**Scrape a Google search**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.piloterr.api.google.search({ query: 'best electric cars 2024' });
```

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

## What's next

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