GetProspect plugin

Use GetProspect through Corsair: one client, typed API calls. Authenticate with an API key in the x-api-key header. Search endpoints may be free, while reveals, email verification, and selected background jobs spend credits or wallet funds; inspect credits and rate limits before billable operations. Poll asynchronous job resources explicitly. Webhook management and the event stream are not exposed in this scope. What you get:

71 typed API operations

Setup

Install

npm install corsair @corsair-dev/getprospect better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/getprospect better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/getprospect better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/getprospect better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { getprospect } from '@corsair-dev/getprospect';

export const corsair = createCorsair({
	plugins: [
		getprospect({
			authType: 'api_key',
		}),
	],
	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 for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)

Store the GetProspect API key before the first call: pnpm corsair setup --plugin=getprospect --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.

getprospect({
	authType: 'api_key',
})

More: API Key

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.

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

Example API calls

account.meGet

const tenant = corsair.withTenant('acme');
await tenant.getprospect.api.account.meGet({});

blocklist.companiesAdd

const tenant = corsair.withTenant('acme');
await tenant.getprospect.api.blocklist.companiesAdd({});

See the full list on the API page.

What’s next

API reference

Every getprospect.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Overview

Plugins