Ahrefs icon

Ahrefs

SEO toolkit for backlinks, keywords, site audits, and competitive research.

48 searches9 actionsPollingAuth: API key

AI-assisted documentation22 min read

This documentation is compiled from our integration source code, internal specs for Ahrefs, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Ahrefs on WEXTL →

Connecting Ahrefs takes an active account plus an API access token from your account settings — no other setup is required.[3]

  • API KeypasswordRequired

    You can create and manage existing API keys via Account settings -> API keys.

    [1]
  1. Log in to your WEXTL account, add the Ahrefs node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Ahrefs account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Connecting Ahrefs to WEXTL®
Video slide demonstrates how to integrate Ahrefs in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Get a Competitor's OverviewSearch
Input fields[3]
FieldType
DateRequired
date
DeviceRequired
choice
Project IDRequired
choice
Select ColumnsRequired
choice
Date Compareddate
Limitnumber
Order Bychoice
Output Formatchoice
Timeoutnumber
Volume Modechoice
Wheretext
Output fields[3]
FieldType
Competitors listarray
Countrytext
Keywordtext
Keyword difficultynumber
Keyword has databoolean
Keyword is frozenboolean
Languagetext
Locationtext
Serp featuresarray
Serp updatedtext
Serp updated prevtext
Tagsarray
Volumenumber
Get a Keywords ListSearch
Input fields[3]
FieldType
Keyword List IDRequired
number
Output Formatchoice
Output fields[3]
FieldType
Keywordtext
Get a SERP OverviewSearch
Input fields[3]
FieldType
Project IDRequired
choice
DeviceRequired
choice
KeywordRequired
text
Datedate
Language Codetext
Location IDnumber
Output Formatchoice
Top Positionsnumber
Output fields[3]
FieldType
Positionnumber
Titletext
URLtext
Typearray
Update datedate
Nr wordsnumber
Domain ratingnumber
URL ratingnumber
Ahrefs ranknumber
Backlinksnumber
Refdomainsnumber
Trafficnumber
Valuenumber
Keywordsnumber
Top keywordtext
Top keyword volumenumber
Get a SERP OverviewSearch
Input fields[3]
FieldType
KeywordRequired
text
Select ColumnsRequired
choice
Datedate
Output Formatchoice
Top Positionsnumber
Output fields[3]
FieldType
Positionnumber
Titletext
URLtext
Typearray
Update datedate
Nr wordsnumber
Domain ratingnumber
URL ratingnumber
Ahrefs ranknumber
Backlinksnumber
Refdomainsnumber
Trafficnumber
Valuenumber
Keywordsnumber
Top keywordtext
Top keyword volumenumber
Get AI ResponsesSearch
Input fields[3]
FieldType
Data SourceRequired
choice
Select ColumnsRequired
choice
Brandtext
Competitorstext
Datedate
Markettext
Order Bychoice
Output Formatchoice
Timeoutnumber
Wheretext
Limitnumber
Output fields[3]
FieldType
Countrytext
Linksarray
Questiontext
Responsetext
Volumenumber
Get AnchorsSearch
Input fields[3]
FieldType
TargetRequired
text
SelectRequired
choice
Historychoice
Limitnumber
Modechoice
Order Bychoice
Outputchoice
Protocolchoice
Timeoutnumber
Wheretext
Output fields[3]
FieldType
Anchortext
Dofollow linksnumber
First seendate
Last seendate
Links to targetnumber
Lost linksnumber
New linksnumber
Refdomainsnumber
Refpagesnumber
Top domain ratingnumber
Get BacklinksSearch
Get Backlinks StatsAction
Input fields[3]
FieldType
DateRequired
date
TargetRequired
text
Modechoice
Outputchoice
Protocolchoice
Output fields[3]
FieldType
Metricsobject
Livenumber
All timenumber
Live refdomainsnumber
All time refdomainsnumber
Get Best by External LinksSearch
Get Best by Internal LinksSearch
Get Broken BacklinksSearch
Get Competitor PagesSearch
Input fields[3]
FieldType
DateRequired
date
DeviceRequired
choice
Project IDchoice
Select Columnschoice
Date Compareddate
Limitnumber
Order Bychoice
Output Formatchoice
Target and Tracked Competitors Onlyboolean
Timeoutnumber
Volume Modechoice
Wheretext
Output fields[3]
FieldType
Keywordsnumber
Share of traffic valuenumber
Share of traffic value prevnumber
Share of voicenumber
Share of voice prevnumber
Statustext
Titletext
Title prevtext
Trafficnumber
Traffic prevnumber
Traffic valuenumber
Traffic value prevnumber
URLtext
Get CompetitorsSearch
Input fields[3]
FieldType
Project IDRequired
number
Output Formatchoice
Output fields[3]
FieldType
URLtext
Modetext
Get Crawler IP AddressesSearch
Input fields[3]
FieldType
Outputchoice
Limitnumber
Output fields[3]
FieldType
IP addresstext
Get Crawler IP RangesSearch
Input fields[3]
FieldType
Outputchoice
Limitnumber
Output fields[3]
FieldType
Ipv 4prefixtext
Get Domain RatingAction
Input fields[3]
FieldType
DateRequired
date
TargetRequired
text
Output Formatchoice
Protocolchoice
Output fields[3]
FieldType
Domain ratingobject
Domain ratingnumber
Ahrefs ranknumber
Get Domain Rating HistorySearch
Input fields[3]
FieldType
Date FromRequired
date
TargetRequired
text
Date Todate
History Groupingchoice
Outputchoice
Limitnumber
Output fields[3]
FieldType
Datedate
Domain ratingnumber
Get KeywordsSearch
Input fields[3]
FieldType
SelectRequired
choice
Keyword List IDnumber
Keywordstext
Limitnumber
Order Bychoice
Outputchoice
Search Enginechoice
Targettext
Target Modechoice
Target Positionchoice
Timeoutnumber
Volume Monthly Date Fromdate
Volume Monthly Date Todate
Wheretext
Output fields[3]
FieldType
Clicksnumber
Cpcnumber
Cpsnumber
Difficultynumber
First seendate
Global volumenumber
Intentsobject
Keywordtext
Parent topictext
Parent volumenumber
Searches pct clicks organic and paidnumber
Searches pct clicks organic onlynumber
Searches pct clicks paid onlynumber
Serp featuresarray
Serp last updatetext
Traffic potentialnumber
Volumenumber
Volume desktop pctnumber
Volume mobile pctnumber
Volume monthlynumber
1other output field
Get KeywordsSearch
Input fields[3]
FieldType
Project IDRequired
number
Output Formatchoice
Limitnumber
Output fields[3]
FieldType
Keywordtext
Language codetext
Languagetext
Location IDnumber
Locationtext
Tagsarray
Get Keywords HistorySearch
Input fields[3]
FieldType
Date FromRequired
date
TargetRequired
text
Date Todate
History Groupingchoice
Modechoice
Output Formatchoice
Protocolchoice
Select Columnschoice
Limitnumber
Output fields[3]
FieldType
Datedate
Top 11 20number
Top 11 plusnumber
Top 21 50number
Top 3number
Top 4 10number
Top 51 plusnumber
Get Limits and UsageAction
Input fields[3]
FieldType
Output FormatRequired
choice
Output fields[3]
FieldType
Subscriptiontext
Usage reset datetext
Units limit workspacenumber
Units usage workspacenumber
Units limit API keynumber
Units usage API keynumber
API key expiration datetext
Get Linked DomainsSearch
Input fields[3]
FieldType
SelectRequired
choice
TargetRequired
text
Limitnumber
Modechoice
Order Bychoice
Outputchoice
Protocolchoice
Timeoutnumber
Wheretext
Output fields[3]
FieldType
Dofollow linked domainsnumber
Dofollow linksnumber
Dofollow refdomainsnumber
Domaintext
Domain ratingnumber
First seentext
Is root domainboolean
Linked domain trafficnumber
Linked pagesnumber
Links from targetnumber
Get Matching TermsSearch
Input fields[3]
FieldType
SelectRequired
choice
Keyword List IDnumber
Keywordstext
Limitnumber
Match Modechoice
Order Bychoice
Outputchoice
Search Enginetext
Termschoice
Timeoutnumber
Wheretext
Output fields[3]
FieldType
Cpcnumber
Cpsnumber
Difficultynumber
First seendate
Global volumenumber
Intentsobject
Keywordtext
Parent topictext
Serp featuresarray
Serp last updatetext
Traffic potentialnumber
Volumenumber
Volume desktop pctnumber
Volume mobile pctnumber
Volume monthlynumber
Get MetricsAction
Input fields[3]
FieldType
TargetRequired
text
DateRequired
date
Modechoice
Outputchoice
Protocolchoice
Volume Modechoice
Output fields[3]
FieldType
Metricsobject
Org keywordsnumber
Paid keywordsnumber
Org keywords 1 3number
Org trafficnumber
Org costnumber
Paid trafficnumber
Paid costnumber
Paid pagesnumber
Get Metrics by CountrySearch
Input fields[3]
FieldType
DateRequired
date
TargetRequired
text
Modechoice
Outputchoice
Protocolchoice
Selectchoice
Volume Modechoice
Limitnumber
Output fields[3]
FieldType
Countrytext
Org costnumber
Org keywordsnumber
Org keywords 1 3number
Org trafficnumber
Paid costnumber
Paid keywordsnumber
Paid pagesnumber
Paid trafficnumber
Get Metrics HistorySearch
Input fields[3]
FieldType
Start DateRequired
date
TargetRequired
text
End Datedate
History Groupingchoice
Modechoice
Output Formatchoice
Protocolchoice
Limitnumber
Output fields[3]
FieldType
Datedate
Org costnumber
Org trafficnumber
Paid costnumber
Paid trafficnumber
Get Organic CompetitorsSearch
Input fields[3]
FieldType
DateRequired
date
SelectRequired
choice
TargetRequired
text
Date Compareddate
Limitnumber
Modechoice
Order Bychoice
Outputchoice
Protocolchoice
Timeoutnumber
Volume Modechoice
Wheretext
Output fields[3]
FieldType
Competitor domaintext
Competitor URLtext
Domain ratingnumber
Group modetext
Keywords commonnumber
Keywords competitornumber
Keywords targetnumber
Pagesnumber
Pages diffnumber
Pages mergednumber
Pages prevnumber
Sharenumber
Trafficnumber
Traffic diffnumber
Traffic mergednumber
Traffic prevnumber
Valuenumber
Value diffnumber
Value mergednumber
Value prevnumber
Get Organic KeywordsSearch
Input fields[3]
FieldType
DateRequired
date
SelectRequired
choice
TargetRequired
text
Date Compareddate
Limitnumber
Modechoice
Order Bychoice
Output Formatchoice
Protocolchoice
Timeoutnumber
Volume Modechoice
Wheretext
Limitnumber
Output fields[3]
FieldType
All positionsarray
All positions prevarray
Best positionnumber
Best position diffnumber
Best position has thumbnailboolean
Best position has thumbnail prevboolean
Best position has videoboolean
Best position has video prevboolean
Best position kindtext
Best position kind mergedtext
Best position kind prevtext
Best position prevnumber
Best position settext
Best position set prevtext
Best position URLtext
Best position URL prevtext
Cpcnumber
Cpc mergednumber
Cpc prevnumber
Is best position set top 11 50boolean
46other output fields
Get Outgoing External AnchorsSearch
Input fields[3]
FieldType
TargetRequired
text
SelectRequired
choice
Limitnumber
Modechoice
Order Bychoice
Outputchoice
Protocolchoice
Timeoutnumber
Wheretext
Output fields[3]
FieldType
Anchortext
Dofollow linksnumber
First seendate
Linked domainsnumber
Linked pagesnumber
Links from targetnumber
Get Outgoing Internal AnchorsSearch
Input fields[3]
FieldType
TargetRequired
text
SelectRequired
choice
Limitnumber
Modechoice
Order Bychoice
Outputchoice
Protocolchoice
Timeoutnumber
Wheretext
Output fields[3]
FieldType
Anchortext
Dofollow linksnumber
First seendate
Linked pagesnumber
Links from targetnumber
Get Outlink StatsAction
Input fields[3]
FieldType
DateRequired
date
TargetRequired
text
Modechoice
Outputchoice
Protocolchoice
Output fields[3]
FieldType
Metricsobject
Outgoing linksnumber
Outgoing links dofollownumber
Linked domainsnumber
Linked domains dofollownumber
Get Page ContentAction
Input fields[3]
FieldType
Project IDRequired
choice
SelectRequired
choice
Target URLRequired
url
Datedate
Outputchoice
Output fields[3]
FieldType
Crawl datetimetext
Page texttext
Raw HTMLtext
Rendered HTMLtext
Get Pages by TrafficAction
Input fields[3]
FieldType
TargetRequired
text
Modechoice
Output Formatchoice
Protocolchoice
Volume Modechoice
Output fields[3]
FieldType
Range 0 pagesnumber
Range 100 trafficnumber
Range 100 pagesnumber
Range 1k trafficnumber
Range 1k pagesnumber
Range 5k trafficnumber
Range 5k pagesnumber
Range 10k trafficnumber
Range 10k pagesnumber
Range 10k plus trafficnumber
Range 10k plus pagesnumber
Get Pages HistorySearch
Input fields[3]
FieldType
Start DateRequired
date
TargetRequired
text
End Datedate
History Groupingchoice
Modechoice
Output Formatchoice
Protocolchoice
Limitnumber
Output fields[3]
FieldType
Datedate
Pagesnumber
Get Paid PagesSearch
Input fields[3]
FieldType
DateRequired
date
SelectRequired
choice
TargetRequired
text
Date Compareddate
Limitnumber
Modechoice
Order Bychoice
Outputchoice
Protocolchoice
Timeoutnumber
Volume Modechoice
Wheretext
Output fields[3]
FieldType
Ads countnumber
Ads count diffnumber
Ads count prevnumber
Keywordsnumber
Keywords diffnumber
Keywords diff percentnumber
Keywords mergednumber
Keywords prevnumber
Raw URLtext
Raw URL prevtext
Referring domainsnumber
Statustext
Sum trafficnumber
Sum traffic mergednumber
Sum traffic prevnumber
Top keywordtext
Top keyword best positionnumber
Top keyword best position diffnumber
Top keyword best position kindtext
Top keyword best position kind prevtext
17other output fields
Get Project Health ScoresSearch
Input fields[3]
FieldType
OutputRequired
choice
Limitnumber
Output fields[3]
FieldType
Project IDtext
Project nametext
Target protocoltext
Target URLtext
Target modetext
Datedate
Statustext
Health scorenumber
Get Project IssuesSearch
Input fields[3]
FieldType
Project IDRequired
choice
Datedate
Date Compareddate
Output Formatchoice
Limitnumber
Output fields[3]
FieldType
Issue IDtext
Nametext
Importancetext
Categorytext
Is indexableboolean
Crawlednumber
Changenumber
Addednumber
Newnumber
Removednumber
Missingnumber
Get ProjectsSearch
Input fields[3]
FieldType
Project IDRequired
number
Accesschoice
Has Keywordsboolean
Outputchoice
Owned Byemail
Limitnumber
Output fields[3]
FieldType
Project IDtext
Project nametext
URLtext
Modetext
Protocoltext
Accesstext
Owned bytext
Keyword countnumber
Get Rank TrackersSearch
Input fields[3]
FieldType
DateRequired
date
DeviceRequired
choice
Project IDRequired
choice
Select ColumnsRequired
choice
Date Compareddate
Limitnumber
Order Bychoice
Output Formatchoice
Timeoutnumber
Volume Modechoice
Wheretext
Date Todate
Date Fromdate
Output fields[3]
FieldType
Best position has thumbnailboolean
Best position has thumbnail previousboolean
Best position has video previewboolean
Best position has video preview previousboolean
Best position kindtext
Best position kind previoustext
Clicksnumber
Clicks per searchnumber
Cost per clicknumber
Countrytext
Country prevtext
Created atdate
Is brandedboolean
Is commercialboolean
Is informationalboolean
Is localboolean
Is navigationalboolean
Is transactionalboolean
Keywordtext
Keyword difficultynumber
30other output fields
Get Ref DomainsSearch
Input fields[3]
FieldType
TargetRequired
text
SelectRequired
choice
Historychoice
Limitnumber
Modechoice
Order Bychoice
Outputchoice
Protocolchoice
Timeoutnumber
Wheretext
Output fields[3]
FieldType
Dofollow linked domainsnumber
Dofollow linksnumber
Dofollow refdomainsnumber
Domaintext
Domain ratingnumber
First seendate
IP sourcetext
Is root domainboolean
Last seendate
Links to targetnumber
Lost linksnumber
New linksnumber
Positions source domainnumber
Traffic domainnumber
Get Ref Domains HistorySearch
Input fields[3]
FieldType
Start DateRequired
date
TargetRequired
text
End Datedate
History Groupingchoice
Modechoice
Output Formatchoice
Protocolchoice
Limitnumber
Output fields[3]
FieldType
Datedate
Refdomainsnumber
Get Related TermsSearch
Input fields[3]
FieldType
SelectRequired
choice
Keyword List IDRequired
number
Keywordstext
Limitnumber
Order Bychoice
Outputchoice
Termschoice
Timeoutnumber
View Forchoice
Wheretext
Output fields[3]
FieldType
Cpcnumber
Cpsnumber
Difficultynumber
First seendate
Global volumenumber
Intentsobject
Keywordtext
Parent topictext
Serp featuresarray
Serp last updatetext
Traffic potentialnumber
Volumenumber
Volume desktop pctnumber
Volume mobile pctnumber
Volume monthlynumber
Get Search SuggestionsSearch
Input fields[3]
FieldType
SelectRequired
choice
Keyword List IDRequired
number
KeywordsRequired
text
Order Bychoice
Output Formatchoice
Timeoutnumber
Filter Expressiontext
Limitnumber
Output fields[3]
FieldType
Cpcnumber
Cpsnumber
Difficultynumber
First seendate
Global volumenumber
Intentsobject
Keywordtext
Parent topictext
Serp featuresarray
Serp last updatetext
Traffic potentialnumber
Volumenumber
Volume desktop pctnumber
Volume mobile pctnumber
Volume monthlynumber
Get Top PagesSearch
Input fields[3]
FieldType
DateRequired
date
SelectRequired
choice
TargetRequired
text
Date Compareddate
Modechoice
Order Bychoice
Outputchoice
Protocolchoice
Timeoutnumber
Volume Modechoice
Wheretext
Limitnumber
Output fields[3]
FieldType
Keywordsnumber
Keywords diffnumber
Keywords diff percentnumber
Keywords mergednumber
Keywords prevnumber
Raw URLtext
Raw URL prevtext
Referring domainsnumber
Statustext
Sum trafficnumber
Sum traffic mergednumber
Sum traffic prevnumber
Top keywordtext
Top keyword best positionnumber
Top keyword best position diffnumber
Top keyword best position kindtext
Top keyword best position kind prevtext
Top keyword best position prevnumber
Top keyword best position titletext
Top keyword best position title prevtext
14other output fields
Get Total Search Volume HistorySearch
Input fields[3]
FieldType
Date FromRequired
date
TargetRequired
text
Date Todate
History Groupingchoice
Modechoice
Outputchoice
Protocolchoice
Top Positionschoice
Volume Modechoice
Limitnumber
Output fields[3]
FieldType
Datedate
Total search volumenumber
Get URL Rating HistorySearch
Input fields[3]
FieldType
TargetRequired
text
Date FromRequired
date
Date Todate
History Groupingchoice
Outputchoice
Limitnumber
Output fields[3]
FieldType
Datedate
URL ratingnumber
Get Volume by CountrySearch
Input fields[3]
FieldType
KeywordRequired
text
Date Fromdate
Date Todate
Output Formatchoice
Limitnumber
Output fields[3]
FieldType
Datedate
Volumenumber
Get Volume HistorySearch
Input fields[3]
FieldType
KeywordRequired
text
Output Formatchoice
Limitnumber
Output fields[3]
FieldType
Countrytext
Volumenumber
Add a Keywords ListAction
Input fields[3]
FieldType
Keyword List IDRequired
number
Output Formatchoice
Keywordsarray
Output fields[3]
FieldType
Keywordsarray
Add CompetitorsAction
Input fields[3]
FieldType
Project IDRequired
number
Output Formatchoice
CompetitorsRequired
array
Output fields[3]
FieldType
Competitorsarray
Create a ProjectAction
Input fields[3]
FieldType
Project NameRequired
text
URLRequired
url
ModeRequired
choice
ProtocolRequired
choice
Accesschoice
Owned Byemail
Output fields[3]
FieldType
Projectsarray
Create Batch AnalysisAction
Input fields[3]
FieldType
SelectRequired
choice
TargetsRequired
array
Order Bychoice
Volume Modechoice
Outputchoice
Output fields[3]
FieldType
Targetsarray
Create KeywordsAction
Input fields[3]
FieldType
Project IDRequired
number
Output Formatchoice
Keywordsarray
LocationsRequired
array
Output fields[3]
FieldType
Keywordsarray
Delete a CompetitorAction
Input fields[3]
FieldType
Project IDRequired
number
Output Formatchoice
CompetitorsRequired
array
Output fields[3]
FieldType
Competitorsarray
Delete a Keyword ListAction
Input fields[3]
FieldType
Keyword List IDRequired
number
Output Formatchoice
Keywordsarray
Output fields[3]
FieldType
Keywordsarray
Delete KeywordsAction
Input fields[3]
FieldType
Project IDRequired
number
Output Formatchoice
Keywordsarray
Output fields[3]
FieldType
Keywordsarray
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Look for Ahrefs templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Ahrefs Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Ahrefs.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:38