Overview - Corsair

Use ZenRows through Corsair: one client, typed API calls. Every call goes through https://api.zenrows.com. The key travels in the X-API-Key header, or in the apikey query parameter when customHeaders is on, because ZenRows copies every request header onto the target page in that mode. A Fetch answer is not always JSON. fetch.page returns the page itself as HTML, Markdown or plaintext, fetch.cssExtract and fetch.outputs return a JSON object, and fetch.extract returns { html, parsed }. ZenRows labels all of these text/plain, so the operation you call is what tells you the shape. A crawl is a job. crawl.start returns a crawl_id and spends credits per page, crawl.get reads its status and one page of results, and polling it with the same cursor returns only new URLs. On Corsair’s cloud, get_job and the job card follow it for you. Extract needs a domain prepared first. extract.getDomainStatus says whether it is ready; extract.prepareDomain asks for it, which takes minutes and one slot of the monthly allowance. fetch.cssExtract works on any site with no preparation. What you get:

19 typed API operations

Setup

Install

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

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

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

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

Add the plugin

corsair.ts

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

export const corsair = createCorsair({
	plugins: [
		zenrows(),
	],
	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)

No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

zenrows()

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

Example API calls

Fetch a page as HTML

const tenant = corsair.withTenant('acme');
await tenant.zenrows.api.fetch.page({ url: 'https://example.com' });

Crawl the first two pages of a site

const tenant = corsair.withTenant('acme');
await tenant.zenrows.api.crawl.start({ url: 'https://www.scrapingcourse.com/ecommerce/', maxPages: 2 });

See the full list on the API page.

What’s next

API reference

Every zenrows.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.

​Setup

​Example API calls

​What’s next