API

Every ahrefs.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Keywords Explorer

overview

keywordsExplorer.overview Get keyword metrics such as volume, difficulty, CPC, clicks, and traffic potential Risk: read

await corsair.ahrefs.api.keywordsExplorer.overview({});

Input

Name	Type	Required	Description
`timeout`	`number`	No	—
`limit`	`number`	No	—
`order_by`	`string`	No	—
`where`	`string`	No	—
`select`	`string`	Yes	—
`volume_monthly_date_to`	`string`	No	—
`volume_monthly_date_from`	`string`	No	—
`target_mode`	`exact \| prefix \| domain \| subdomains`	No	—
`target`	`string`	No	—
`target_position`	`in_top10 \| in_top100`	No	—
`country`	`string`	Yes	—
`keywords`	`string \| string[]`	No	—
`keyword_list_id`	`number`	No	—
`output`	`json`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  clicks?: number | null,
  cpc?: number | null,
  cps?: number | null,
  difficulty?: number | null,
  first_seen?: string | null,
  global_volume?: number | null,
  intents?: {
    informational?: boolean,
    navigational?: boolean,
    commercial?: boolean,
    transactional?: boolean,
    branded?: boolean,
    local?: boolean
  } | null,
  keyword: string,
  parent_topic?: string | null,
  parent_volume?: number | null,
  searches_pct_clicks_organic_and_paid?: number | null,
  searches_pct_clicks_organic_only?: number | null,
  searches_pct_clicks_paid_only?: number | null,
  serp_features?: string[],
  serp_last_update?: string | null,
  traffic_potential?: number | null,
  volume?: number | null,
  volume_desktop_pct?: number | null,
  volume_mobile_pct?: number | null,
  volume_monthly?: number | null,
  volume_monthly_history?: {
  }[]
}[]

Rank Tracker

overview

rankTracker.overview Get Rank Tracker keyword overview data for a project and device Risk: read

await corsair.ahrefs.api.rankTracker.overview({});

Input

Name	Type	Required	Description
`timeout`	`number`	No	—
`limit`	`number`	No	—
`order_by`	`string`	No	—
`where`	`string`	No	—
`select`	`string`	Yes	—
`date_compared`	`string`	No	—
`date`	`string`	Yes	—
`device`	`desktop \| mobile`	Yes	—
`project_id`	`number`	Yes	—
`volume_mode`	`monthly \| average`	No	—
`output`	`json`	No	—

Output

Name	Type	Required	Description
`overviews`	`object[]`	Yes	—

overviews full type

{
  keyword?: string | null,
  country?: string,
  device?: string,
  position?: number | null,
  previous_position?: number | null,
  best_position_kind?: string | null,
  clicks?: number | null,
  volume?: number | null,
  traffic?: number | null,
  url?: string | null
}[]

Serp

overview

serp.overview Get SERP positions for a keyword and country, including ranking page metrics Risk: read

await corsair.ahrefs.api.serp.overview({});

Input

Name	Type	Required	Description
`select`	`string`	Yes	—
`top_positions`	`number`	No	—
`date`	`string`	No	—
`country`	`string`	Yes	—
`keyword`	`string`	Yes	—
`output`	`json`	No	—

Output

Name	Type	Required	Description
`positions`	`object[]`	Yes	—

positions full type

{
  position: number,
  url?: string | null,
  title?: string | null,
  type?: string[],
  domain_rating?: number | null,
  ahrefs_rank?: number | null,
  backlinks?: number | null,
  refdomains?: number | null,
  traffic?: number | null,
  value?: number | null,
  update_date?: string | null
}[]

Site Explorer

backlinksStats

siteExplorer.backlinksStats Get live and all-time backlink and referring-domain counts for a target Risk: read

await corsair.ahrefs.api.siteExplorer.backlinksStats({});

Input

Name	Type	Required	Description
`protocol`	`both \| http \| https`	No	—
`target`	`string`	Yes	—
`date`	`string`	Yes	—
`output`	`json`	No	—
`mode`	`exact \| prefix \| domain \| subdomains`	No	—

Output

Name	Type	Required	Description
`metrics`	`object`	Yes	—

metrics full type

{
  all_time?: number | null,
  all_time_refdomains?: number | null,
  live?: number | null,
  live_refdomains?: number | null
}

getDomainRating

siteExplorer.getDomainRating Get Ahrefs Domain Rating and Ahrefs Rank for a target Risk: read

await corsair.ahrefs.api.siteExplorer.getDomainRating({});

Input

Name	Type	Required	Description
`protocol`	`both \| http \| https`	No	—
`target`	`string`	Yes	—
`date`	`string`	Yes	—
`output`	`json`	No	—

Output

Name	Type	Required	Description
`domain_rating`	`object`	Yes	—

domain_rating full type

{
  ahrefs_rank?: number | null,
  domain_rating?: number | null
}

organicKeywords

siteExplorer.organicKeywords List organic keywords a target ranks for, including positions and traffic metrics Risk: read

await corsair.ahrefs.api.siteExplorer.organicKeywords({});

Input

Name	Type	Required	Description
`protocol`	`both \| http \| https`	No	—
`target`	`string`	Yes	—
`date`	`string`	Yes	—
`output`	`json`	No	—
`timeout`	`number`	No	—
`limit`	`number`	No	—
`order_by`	`string`	No	—
`where`	`string`	No	—
`select`	`string`	Yes	—
`mode`	`exact \| prefix \| domain \| subdomains`	No	—
`country`	`string`	Yes	—
`date_compared`	`string`	No	—
`volume_mode`	`monthly \| average`	No	—

Output

Name	Type	Required	Description
`keywords`	`object[]`	Yes	—

keywords full type

{
  keyword?: string | null,
  keyword_country?: string,
  best_position?: number | null,
  best_position_url?: string | null,
  keyword_difficulty?: number | null,
  volume?: number | null,
  cpc?: number | null,
  sum_traffic?: number | null,
  serp_features?: string[],
  last_update?: string | null,
  status?: string
}[]

refdomains

siteExplorer.refdomains List referring domains linking to a target Risk: read

await corsair.ahrefs.api.siteExplorer.refdomains({});

Input

Name	Type	Required	Description
`protocol`	`both \| http \| https`	No	—
`target`	`string`	Yes	—
`date`	`string`	Yes	—
`output`	`json`	No	—
`timeout`	`number`	No	—
`limit`	`number`	No	—
`order_by`	`string`	No	—
`where`	`string`	No	—
`select`	`string`	Yes	—
`mode`	`exact \| prefix \| domain \| subdomains`	No	—
`history`	`string`	No	—

Output

Name	Type	Required	Description
`refdomains`	`object[]`	Yes	—

refdomains full type

{
  domain: string,
  domain_rating?: number | null,
  dofollow_links?: number | null,
  dofollow_refdomains?: number | null,
  links?: number | null,
  refdomains?: number | null,
  first_seen?: string | null,
  last_visited?: string | null
}[]

topPages

siteExplorer.topPages List top organic pages for a target with traffic, keyword, and link metrics Risk: read

await corsair.ahrefs.api.siteExplorer.topPages({});

Input

Name	Type	Required	Description
`protocol`	`both \| http \| https`	No	—
`target`	`string`	Yes	—
`date`	`string`	Yes	—
`output`	`json`	No	—
`timeout`	`number`	No	—
`limit`	`number`	No	—
`order_by`	`string`	No	—
`where`	`string`	No	—
`select`	`string`	Yes	—
`mode`	`exact \| prefix \| domain \| subdomains`	No	—
`country`	`string`	Yes	—
`date_compared`	`string`	No	—
`volume_mode`	`monthly \| average`	No	—

Output

Name	Type	Required	Description
`pages`	`object[]`	Yes	—

pages full type

{
  raw_url: string,
  keywords?: number | null,
  referring_domains?: number | null,
  sum_traffic?: number | null,
  value?: number | null,
  page_type?: string | null,
  status?: string
}[]

Subscription Info

limitsAndUsage

subscriptionInfo.limitsAndUsage Get Ahrefs subscription limits and API unit usage Risk: read

await corsair.ahrefs.api.subscriptionInfo.limitsAndUsage({});

Input

Name	Type	Required	Description
`output`	`json`	No	—

Output

Name	Type	Required	Description
`limits_and_usage`	`object`	Yes	—

limits_and_usage full type

{
  api_key_expiration_date: string,
  subscription: string,
  units_limit_api_key?: number | null,
  units_limit_workspace?: number | null,
  units_usage_api_key: number,
  units_usage_workspace?: number | null,
  usage_reset_date: string
}

Overview

Plugins

Keywords Explorer

overview

Rank Tracker

overview

Serp

overview

Site Explorer

backlinksStats

getDomainRating

organicKeywords

refdomains

topPages

Subscription Info

limitsAndUsage

​Keywords Explorer

​overview

​Rank Tracker

​overview

​Serp

​overview

​Site Explorer

​backlinksStats

​getDomainRating

​organicKeywords

​refdomains

​topPages

​Subscription Info

​limitsAndUsage

Keywords Explorer

overview

Rank Tracker

overview

Serp

overview

Site Explorer

backlinksStats

getDomainRating

organicKeywords

refdomains

topPages

Subscription Info

limitsAndUsage