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.
Quick Start
Install the plugin:
pnpm install @corsair-dev/ahrefs
import { createCorsair } from "corsair";
import { ahrefs } from "@corsair-dev/ahrefs";
export const corsair = createCorsair({
plugins: [ahrefs()],
database: db,
kek: process.env.CORSAIR_KEK!,
});
import { createCorsair } from "corsair";
import { ahrefs } from "@corsair-dev/ahrefs";
export const corsair = createCorsair({
multiTenancy: true,
plugins: [ahrefs()],
database: db,
kek: process.env.CORSAIR_KEK!,
});
Authentication
Supported Auth Types
API Key Setup
pnpm corsair setup --plugin=ahrefs api_key=your-api-key
pnpm corsair setup --plugin=ahrefs api_key=their-api-key --tenant=user_abc123
Options
| Option | Type | Description |
|---|
authType | 'api_key' | Authentication method |
key | string | API key (optional, uses database if not provided) |
hooks | object | Endpoint hooks for custom logic |
errorHandlers | object | Custom error handlers |
Usage
// Get domain rating
const rating = await corsair.ahrefs.api.siteExplorer.getDomainRating({
target: "example.com",
date: "2024-01-01",
});
// Get backlinks stats
const stats = await corsair.ahrefs.api.siteExplorer.backlinksStats({
target: "example.com",
date: "2024-01-01",
mode: "domain",
});
// Get organic keywords
const keywords = await corsair.ahrefs.api.siteExplorer.organicKeywords({
target: "example.com",
select: "keyword,volume,position",
});
// Keyword overview
const overview = await corsair.ahrefs.api.keywordsExplorer.overview({
keywords: ["seo tools", "backlink checker"],
country: "us",
select: "keyword,volume,difficulty",
});
// Rank tracker overview
const ranks = await corsair.ahrefs.api.rankTracker.overview({
campaign_id: 123,
});
// SERP overview
const serp = await corsair.ahrefs.api.serp.overview({
keyword: "best seo tools",
country: "us",
select: "url,domain_rating,traffic",
});
const tenant = corsair.withTenant("workspace-123");
// Get domain rating
const rating = await tenant.ahrefs.api.siteExplorer.getDomainRating({
target: "example.com",
date: "2024-01-01",
});
// Get backlinks stats
const stats = await tenant.ahrefs.api.siteExplorer.backlinksStats({
target: "example.com",
date: "2024-01-01",
mode: "domain",
});
// Get organic keywords
const keywords = await tenant.ahrefs.api.siteExplorer.organicKeywords({
target: "example.com",
select: "keyword,volume,position",
});