Semrush

Use Semrush to query SEO reports for domains, subdomains, URLs, keywords, and backlinks. Choose a regional database and, where supported, a historical month in YYYYMM15 format. Domain vs. Domain compares up to five domains.

Before you start

Requests authenticate with a key query parameter and are billed in API units, which are metered separately from your Semrush subscription — line-based reports such as Backlinks and Referring Domains charge per row returned, so set Limit deliberately. Reports answer as CSV, and this integration decodes them into structured rows for you. Two API behaviours worth knowing: a rejected request comes back with HTTP 200 and a body like ERROR 132 :: API UNITS BALANCE IS ZERO (surfaced here as a normal tool error), and the API may omit a requested column from a response, so treat every field on a row as optional.

Not covered

The Semrush Trends, Projects (Site Audit, Position Tracking), and Listing Management APIs are separate products with their own endpoints and subscriptions, and are not part of this block. Three SEO API reports are also excluded: Comparison by Referring Domains (backlinks_matrix) and Batch Comparison (backlinks_comparison), whose multi-target array parameters do not fit the shared request builder, and Subdomain Organic Pages (subdomain_organic_unique), whose documented response format is inconsistent with every other report.

Use the block

Query the Semrush SEO API for domain, subdomain, and URL traffic overviews, organic and paid keywords, ad and product listing creatives, competitor sets, keyword research, and backlink profiles. Requires a Semrush subscription with API units.

Actions

Semrush Domain Overview

Get the Semrush rank plus organic and paid search totals for a domain in one regional database.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`displayDate`	string	No	Historical month in YYYYMM15 format

Output

Parameter	Type	Description
`overview`	json	Organic and paid search overview for the domain
↳ `domain`	string	Domain name
↳ `rank`	number	Semrush popularity rating of the target, based on organic traffic
↳ `organicKeywords`	number	Keywords bringing users via the Google top 100 organic results
↳ `organicTraffic`	number	Traffic brought via the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of the organic keywords
↳ `paidKeywords`	number	Keywords the target is buying in Google Ads
↳ `paidTraffic`	number	Traffic brought via paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget

Semrush Domain Overview (All Databases)

Get organic and paid search totals for a domain across every regional Semrush database.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	No	Regional database code to restrict the report to, for example us
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displaySort`	string	No	Sort order, for example rk_asc, or_desc, or ot_desc

Output

Parameter	Type	Description
`databases`	array	One row of domain totals per regional database
↳ `database`	string	Regional database the row belongs to
↳ `domain`	string	Domain name
↳ `rank`	number	Semrush popularity rating of the target, based on organic traffic
↳ `organicKeywords`	number	Keywords bringing users via the Google top 100 organic results
↳ `organicTraffic`	number	Traffic brought via the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of the organic keywords
↳ `paidKeywords`	number	Keywords the target is buying in Google Ads
↳ `paidTraffic`	number	Traffic brought via paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget
↳ `plaKeywords`	number	Keywords used for product listing ads
↳ `plaUniques`	number	Number of unique product listing ads

Semrush Domain Overview History

Get the historical trend of a domain rank plus its organic and paid search totals.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDaily`	boolean	No	Return daily data points for the last 31 days instead of monthly ones
`displaySort`	string	No	Sort order, for example dt_desc or dt_asc

Output

Parameter	Type	Description
`history`	array	Historical data points, in the requested sort order
↳ `date`	string	Data collection date in YYYYMMDD or YYYYMM format
↳ `rank`	number	Semrush popularity rating of the target, based on organic traffic
↳ `organicKeywords`	number	Keywords bringing users via the Google top 100 organic results
↳ `organicTraffic`	number	Traffic brought via the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of the organic keywords
↳ `paidKeywords`	number	Keywords the target is buying in Google Ads
↳ `paidTraffic`	number	Traffic brought via paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget

Semrush Domain Organic Keywords

List the keywords a domain ranks for in Google organic search, with position, volume, and traffic share.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displayDaily`	boolean	No	Return daily data points for the last 31 days instead of monthly ones
`displaySort`	string	No	Sort order, for example tr_desc, po_asc, or nq_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`keywords`	array	Organic keywords the domain ranks for
↳ `keyword`	string	Keyword phrase
↳ `position`	number	Position in the Google top 100 results, where 0 means not ranked
↳ `previousPosition`	number	Position held at the previous data collection
↳ `positionDifference`	number	Change between the previous and the current position
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `url`	string	URL of the ranking or advertised page
↳ `trafficPercent`	number	Share of the traffic to the target driven by this keyword
↳ `traffic`	number	Estimated traffic driven by this keyword
↳ `trafficCost`	number	Share of the traffic cost of the target attributed to this keyword
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `numberOfResults`	number	Total organic results returned for the keyword
↳ `keywordDifficulty`	number	Estimated difficulty of ranking for the keyword (0-100)
↳ `intents`	array	Keyword intents: 0 commercial, 1 informational, 2 navigational, 3 transactional
↳ `trends`	array	Relative search interest over the last 12 months

Semrush Domain Paid Keywords

List the keywords a domain buys in Google Ads, with ad position, copy, and traffic share.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displaySort`	string	No	Sort order, for example po_asc, tr_desc, or nq_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`keywords`	array	Paid keywords the domain bids on
↳ `keyword`	string	Keyword phrase
↳ `position`	number	Position in the Google top 100 results, where 0 means not ranked
↳ `previousPosition`	number	Position held at the previous data collection
↳ `positionDifference`	number	Change between the previous and the current position
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `url`	string	URL of the ranking or advertised page
↳ `visibleUrl`	string	Display URL shown in the ad
↳ `title`	string	Ad or product title
↳ `description`	string	Ad text
↳ `traffic`	number	Estimated traffic driven by this keyword
↳ `trafficPercent`	number	Share of the traffic to the target driven by this keyword
↳ `trafficCost`	number	Estimated traffic cost attributed to this keyword
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `numberOfResults`	number	Total organic results returned for the keyword

Semrush Domain Ad Copies

List the unique Google Ads creatives a domain runs, with title, description, and keyword count.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example pc_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Tt\|Co\|sale

Output

Parameter	Type	Description
`ads`	array	Unique ad creatives the domain runs
↳ `title`	string	Ad or product title
↳ `description`	string	Ad text
↳ `visibleUrl`	string	Display URL shown in the ad
↳ `url`	string	URL of the ranking or advertised page
↳ `numberOfKeywords`	number	Number of keywords the ad runs on

Semrush Domain Ad History

List a domain’s past Google Ads placements month by month, with the copy used each time.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example dt_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Ph\|Co\|shoes

Output

Parameter	Type	Description
`ads`	array	Historical ad placements, one row per keyword and month
↳ `keyword`	string	Keyword phrase
↳ `date`	string	Data collection date in YYYYMMDD or YYYYMM format
↳ `position`	number	Position in the Google top 100 results, where 0 means not ranked
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `trafficPercent`	number	Share of the traffic to the target driven by this keyword
↳ `url`	string	URL of the ranking or advertised page
↳ `title`	string	Ad or product title
↳ `description`	string	Ad text
↳ `visibleUrl`	string	Display URL shown in the ad

Semrush Organic Competitors

List the domains competing with a target domain in Google organic search results.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displaySort`	string	No	Sort order, for example np_desc or cr_desc

Output

Parameter	Type	Description
`competitors`	array	Competing domains ranked by competitor relevance
↳ `domain`	string	Domain name
↳ `competitorRelevance`	number	Competition level based on the total keyword count of each domain
↳ `commonKeywords`	number	Keywords both domains rank for in the top 100 organic results
↳ `organicKeywords`	number	Keywords this competing domain ranks for in the Google top 100 organic results
↳ `organicTraffic`	number	Traffic this competing domain gets from the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of this competing domain organic keywords
↳ `paidKeywords`	number	Keywords this competing domain is buying in Google Ads

Semrush Paid Competitors

List the domains competing with a target domain in Google paid search results.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displaySort`	string	No	Sort order, for example np_desc or cr_desc

Output

Parameter	Type	Description
`competitors`	array	Competing advertisers ranked by competitor relevance
↳ `domain`	string	Domain name
↳ `competitorRelevance`	number	Competition level based on the total keyword count of each domain
↳ `commonKeywords`	number	Keywords both domains rank for in the top 100 organic results
↳ `paidKeywords`	number	Keywords this competing domain is buying in Google Ads
↳ `paidTraffic`	number	Traffic this competing domain gets from paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget of this competing domain
↳ `organicKeywords`	number	Keywords this competing domain ranks for in the Google top 100 organic results

Semrush Domain PLA Keywords

List the keywords that trigger a domain’s product listing ads, with the promoted product and price.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example nq_desc or po_asc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`keywords`	array	Product listing ad keywords for the domain
↳ `keyword`	string	Keyword phrase
↳ `position`	number	Position in the Google top 100 results, where 0 means not ranked
↳ `previousPosition`	number	Position held at the previous data collection
↳ `positionDifference`	number	Change between the previous and the current position
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `shopName`	string	Name of the shop running the product listing ad
↳ `url`	string	URL of the ranking or advertised page
↳ `title`	string	Ad or product title
↳ `productPrice`	number	Price of the promoted product
↳ `timestamp`	number	Unix timestamp of the data point

Semrush Domain PLA Copies

List the unique product listing ads a domain runs, with product title, price, and shop name.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domain`	string	Yes	Domain to analyze, for example example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination

Output

Parameter	Type	Description
`ads`	array	Unique product listing ads the domain runs
↳ `title`	string	Ad or product title
↳ `productPrice`	number	Price of the promoted product
↳ `shopName`	string	Name of the shop running the product listing ad
↳ `url`	string	URL of the ranking or advertised page

Semrush Domain vs. Domain

Compare up to five domains on the keywords they rank for, returning each domain’s position side by side.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`domains`	string	Yes	Comma-separated list of up to five domains to compare
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`competitionType`	string	No	Which keyword set to compare: or for organic or ad for paid
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example nq_desc or cp_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`domains`	array	The compared domains, in the order their positions appear
`keywords`	array	Keywords with each compared domain’s position
↳ `keyword`	string	Keyword phrase
↳ `positions`	json	Position of each compared domain, keyed by domain, where 0 means not ranked
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)

Semrush Subdomain Overview

Get the organic and paid search totals for a subdomain in one regional database.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`subdomain`	string	Yes	Subdomain to analyze, for example blog.example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`displayDate`	string	No	Historical month in YYYYMM15 format

Output

Parameter	Type	Description
`overview`	json	Organic and paid search overview for the subdomain
↳ `domain`	string	Domain name
↳ `rank`	number	Semrush popularity rating of the target, based on organic traffic
↳ `organicKeywords`	number	Keywords bringing users via the Google top 100 organic results
↳ `organicTraffic`	number	Traffic brought via the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of the organic keywords
↳ `paidKeywords`	number	Keywords the target is buying in Google Ads
↳ `paidTraffic`	number	Traffic brought via paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget

Semrush Subdomain Overview (All Databases)

Get organic and paid search totals for a subdomain across every regional Semrush database.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`subdomain`	string	Yes	Subdomain to analyze, for example blog.example.com
`database`	string	No	Regional database code to restrict the report to, for example us
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displaySort`	string	No	Sort order, for example rk_asc or ot_desc

Output

Parameter	Type	Description
`databases`	array	One row of subdomain totals per regional database
↳ `database`	string	Regional database the row belongs to
↳ `domain`	string	Domain name
↳ `rank`	number	Semrush popularity rating of the target, based on organic traffic
↳ `organicKeywords`	number	Keywords bringing users via the Google top 100 organic results
↳ `organicTraffic`	number	Traffic brought via the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of the organic keywords
↳ `paidKeywords`	number	Keywords the target is buying in Google Ads
↳ `paidTraffic`	number	Traffic brought via paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget
↳ `plaKeywords`	number	Keywords used for product listing ads
↳ `plaUniques`	number	Number of unique product listing ads

Semrush Subdomain Overview History

Get the historical trend of a subdomain’s organic and paid search totals.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`subdomain`	string	Yes	Subdomain to analyze, for example blog.example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDaily`	boolean	No	Return daily data points for the last 31 days instead of monthly ones
`displaySort`	string	No	Sort order, for example dt_desc or dt_asc

Output

Parameter	Type	Description
`history`	array	Historical data points, in the requested sort order
↳ `date`	string	Data collection date in YYYYMMDD or YYYYMM format
↳ `rank`	number	Semrush popularity rating of the target, based on organic traffic
↳ `organicKeywords`	number	Keywords bringing users via the Google top 100 organic results
↳ `organicTraffic`	number	Traffic brought via the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of the organic keywords
↳ `paidKeywords`	number	Keywords the target is buying in Google Ads
↳ `paidTraffic`	number	Traffic brought via paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget

Semrush Subdomain Organic Keywords

List the keywords a subdomain ranks for in Google organic search.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`subdomain`	string	Yes	Subdomain to analyze, for example blog.example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displayDaily`	boolean	No	Return daily data points for the last 31 days instead of monthly ones
`displaySort`	string	No	Sort order, for example tr_desc, po_asc, or nq_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`keywords`	array	Organic keywords the subdomain ranks for
↳ `keyword`	string	Keyword phrase
↳ `position`	number	Position in the Google top 100 results, where 0 means not ranked
↳ `previousPosition`	number	Position held at the previous data collection
↳ `positionDifference`	number	Change between the previous and the current position
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `url`	string	URL of the ranking or advertised page
↳ `trafficPercent`	number	Share of the traffic to the target driven by this keyword
↳ `traffic`	number	Estimated traffic driven by this keyword
↳ `trafficCost`	number	Share of the traffic cost of the target attributed to this keyword
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `numberOfResults`	number	Total organic results returned for the keyword
↳ `keywordDifficulty`	number	Estimated difficulty of ranking for the keyword (0-100)
↳ `intents`	array	Keyword intents: 0 commercial, 1 informational, 2 navigational, 3 transactional
↳ `trends`	array	Relative search interest over the last 12 months

Semrush Subdomain Paid Keywords

List the keywords a subdomain buys in Google Ads.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`subdomain`	string	Yes	Subdomain to analyze, for example blog.example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displaySort`	string	No	Sort order, for example po_asc, tr_desc, or nq_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`keywords`	array	Paid keywords the subdomain bids on
↳ `keyword`	string	Keyword phrase
↳ `position`	number	Position in the Google top 100 results, where 0 means not ranked
↳ `previousPosition`	number	Position held at the previous data collection
↳ `positionDifference`	number	Change between the previous and the current position
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `url`	string	URL of the ranking or advertised page
↳ `visibleUrl`	string	Display URL shown in the ad
↳ `title`	string	Ad or product title
↳ `description`	string	Ad text
↳ `traffic`	number	Estimated traffic driven by this keyword
↳ `trafficPercent`	number	Share of the traffic to the target driven by this keyword
↳ `trafficCost`	number	Estimated traffic cost attributed to this keyword
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `numberOfResults`	number	Total organic results returned for the keyword

Semrush Subdomain Ad Copies

List the unique Google Ads creatives a subdomain runs.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`subdomain`	string	Yes	Subdomain to analyze, for example blog.example.com
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example pc_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Tt\|Co\|sale

Output

Parameter	Type	Description
`ads`	array	Unique ad creatives the subdomain runs
↳ `title`	string	Ad or product title
↳ `description`	string	Ad text
↳ `visibleUrl`	string	Display URL shown in the ad
↳ `url`	string	URL of the ranking or advertised page
↳ `numberOfKeywords`	number	Number of keywords the ad runs on

Semrush URL Overview

Get the organic and paid search totals for a single URL in one regional database.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`url`	string	Yes	Full URL to analyze, for example https://example.com/pricing
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`displayDate`	string	No	Historical month in YYYYMM15 format

Output

Parameter	Type	Description
`overview`	json	Organic and paid search overview for the URL
↳ `domain`	string	Domain name
↳ `rank`	number	Semrush popularity rating of the target, based on organic traffic
↳ `organicKeywords`	number	Keywords bringing users via the Google top 100 organic results
↳ `organicTraffic`	number	Traffic brought via the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of the organic keywords
↳ `paidKeywords`	number	Keywords the target is buying in Google Ads
↳ `paidTraffic`	number	Traffic brought via paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget

Semrush URL Overview (All Databases)

Get organic and paid search totals for a single URL across every regional Semrush database.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`url`	string	Yes	Full URL to analyze, for example https://example.com/pricing
`database`	string	No	Regional database code to restrict the report to, for example us
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displaySort`	string	No	Sort order, for example rk_asc or ot_desc

Output

Parameter	Type	Description
`databases`	array	One row of URL totals per regional database
↳ `database`	string	Regional database the row belongs to
↳ `domain`	string	Domain name
↳ `rank`	number	Semrush popularity rating of the target, based on organic traffic
↳ `organicKeywords`	number	Keywords bringing users via the Google top 100 organic results
↳ `organicTraffic`	number	Traffic brought via the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of the organic keywords
↳ `paidKeywords`	number	Keywords the target is buying in Google Ads
↳ `paidTraffic`	number	Traffic brought via paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget
↳ `plaKeywords`	number	Keywords used for product listing ads
↳ `plaUniques`	number	Number of unique product listing ads

Semrush URL Overview History

Get the historical trend of a URL’s organic and paid search totals.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`url`	string	Yes	Full URL to analyze, for example https://example.com/pricing
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDaily`	boolean	No	Return daily data points for the last 31 days instead of monthly ones
`displaySort`	string	No	Sort order, for example dt_desc or dt_asc

Output

Parameter	Type	Description
`history`	array	Historical data points, in the requested sort order
↳ `date`	string	Data collection date in YYYYMMDD or YYYYMM format
↳ `rank`	number	Semrush popularity rating of the target, based on organic traffic
↳ `organicKeywords`	number	Keywords bringing users via the Google top 100 organic results
↳ `organicTraffic`	number	Traffic brought via the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of the organic keywords
↳ `paidKeywords`	number	Keywords the target is buying in Google Ads
↳ `paidTraffic`	number	Traffic brought via paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget

Semrush URL Organic Keywords

List the keywords a single URL ranks for in Google organic search.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`url`	string	Yes	Full URL to analyze, for example https://example.com/pricing
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displaySort`	string	No	Sort order, for example tr_desc, po_asc, or nq_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`keywords`	array	Organic keywords the URL ranks for
↳ `keyword`	string	Keyword phrase
↳ `position`	number	Position in the Google top 100 results, where 0 means not ranked
↳ `previousPosition`	number	Position held at the previous data collection
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `keywordDifficulty`	number	Estimated difficulty of ranking for the keyword (0-100)
↳ `trafficPercent`	number	Share of the traffic to the target driven by this keyword
↳ `traffic`	number	Estimated traffic driven by this keyword
↳ `trafficCost`	number	Estimated traffic cost attributed to this keyword
↳ `numberOfResults`	number	Total organic results returned for the keyword
↳ `intents`	array	Keyword intents: 0 commercial, 1 informational, 2 navigational, 3 transactional
↳ `trends`	array	Relative search interest over the last 12 months

Semrush URL Paid Keywords

List the keywords a single URL is advertised on in Google Ads, with the ad copy used.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`url`	string	Yes	Full URL to analyze, for example https://example.com/pricing
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displaySort`	string	No	Sort order, for example tr_desc, po_asc, or nq_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`keywords`	array	Paid keywords the URL is advertised on
↳ `keyword`	string	Keyword phrase
↳ `position`	number	Position in the Google top 100 results, where 0 means not ranked
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `traffic`	number	Estimated traffic driven by this keyword
↳ `trafficPercent`	number	Share of the traffic to the target driven by this keyword
↳ `trafficCost`	number	Estimated traffic cost attributed to this keyword
↳ `numberOfResults`	number	Total organic results returned for the keyword
↳ `trends`	array	Relative search interest over the last 12 months
↳ `title`	string	Ad or product title
↳ `description`	string	Ad text

Semrush Keyword Overview

Get search volume, CPC, competition, difficulty, and intent for a single keyword.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`phrase`	string	Yes	Keyword to analyze
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`displayDate`	string	No	Historical month in YYYYMM15 format

Output

Parameter	Type	Description
`overview`	json	Keyword metrics in the selected database
↳ `keyword`	string	Keyword phrase
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `numberOfResults`	number	Total organic results returned for the keyword
↳ `keywordDifficulty`	number	Estimated difficulty of ranking for the keyword (0-100)
↳ `intents`	array	Keyword intents: 0 commercial, 1 informational, 2 navigational, 3 transactional
↳ `trends`	array	Relative search interest over the last 12 months

Semrush Keyword Overview (All Databases)

Get search volume, CPC, and competition for a keyword across every regional Semrush database.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`phrase`	string	Yes	Keyword to analyze
`database`	string	No	Regional database code to restrict the report to, for example us

Output

Parameter	Type	Description
`databases`	array	One row of keyword metrics per regional database
↳ `date`	string	Data collection date in YYYYMMDD or YYYYMM format
↳ `database`	string	Regional database the row belongs to
↳ `keyword`	string	Keyword phrase
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `numberOfResults`	number	Total organic results returned for the keyword
↳ `intents`	array	Keyword intents: 0 commercial, 1 informational, 2 navigational, 3 transactional
↳ `keywordDifficulty`	number	Estimated difficulty of ranking for the keyword (0-100)

Semrush Batch Keyword Overview

Get search volume, CPC, competition, difficulty, and intent for up to 100 keywords at once.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`phrases`	string	Yes	Semicolon-separated list of keywords, for example ebay;seo
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`displayDate`	string	No	Historical month in YYYYMM15 format

Output

Parameter	Type	Description
`keywords`	array	Keyword metrics, one row per submitted keyword
↳ `keyword`	string	Keyword phrase
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `numberOfResults`	number	Total organic results returned for the keyword
↳ `keywordDifficulty`	number	Estimated difficulty of ranking for the keyword (0-100)
↳ `intents`	array	Keyword intents: 0 commercial, 1 informational, 2 navigational, 3 transactional
↳ `trends`	array	Relative search interest over the last 12 months

Semrush Keyword Difficulty

Get the Keyword Difficulty Index for up to 100 keywords at once.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`phrases`	string	Yes	Semicolon-separated list of keywords, for example ebay;seo
`database`	string	Yes	Regional database code, for example us, uk, de, or fr

Output

Parameter	Type	Description
`keywords`	array	Keyword difficulty scores, one row per submitted keyword
↳ `keyword`	string	Keyword phrase
↳ `keywordDifficulty`	number	Estimated difficulty of ranking for the keyword (0-100)

Find keywords semantically related to a seed keyword, with volume, difficulty, and relevance.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`phrase`	string	Yes	Keyword to analyze
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example nq_desc or kd_asc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`keywords`	array	Related keyword ideas for the seed keyword
↳ `keyword`	string	Keyword phrase
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `numberOfResults`	number	Total organic results returned for the keyword
↳ `keywordDifficulty`	number	Estimated difficulty of ranking for the keyword (0-100)
↳ `relatedRelevance`	number	Relevance of the result keyword to the seed keyword
↳ `keywordSerpFeatures`	array	IDs of all SERP features triggered by the keyword
↳ `intents`	array	Keyword intents: 0 commercial, 1 informational, 2 navigational, 3 transactional
↳ `trends`	array	Relative search interest over the last 12 months

Semrush Broad Match Keywords

Find broad-match and phrase-match variations of a seed keyword, with volume and difficulty.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`phrase`	string	Yes	Keyword to analyze
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example nq_desc or kd_asc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`keywords`	array	Broad match keyword variations of the seed keyword
↳ `keyword`	string	Keyword phrase
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `numberOfResults`	number	Total organic results returned for the keyword
↳ `keywordDifficulty`	number	Estimated difficulty of ranking for the keyword (0-100)
↳ `keywordSerpFeatures`	array	IDs of all SERP features triggered by the keyword
↳ `intents`	array	Keyword intents: 0 commercial, 1 informational, 2 navigational, 3 transactional
↳ `trends`	array	Relative search interest over the last 12 months

Semrush Keyword Questions

Find question-form keywords containing a seed keyword, with volume and difficulty.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`phrase`	string	Yes	Keyword to analyze
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example nq_desc or kd_asc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Nq\|Gt\|1000

Output

Parameter	Type	Description
`keywords`	array	Question keywords containing the seed keyword
↳ `keyword`	string	Keyword phrase
↳ `searchVolume`	number	Average monthly searches for the keyword
↳ `cpc`	number	Average cost per click in USD (Google Ads)
↳ `competition`	number	Competitive density of advertisers bidding on the keyword (0-1)
↳ `numberOfResults`	number	Total organic results returned for the keyword
↳ `keywordDifficulty`	number	Estimated difficulty of ranking for the keyword (0-100)
↳ `intents`	array	Keyword intents: 0 commercial, 1 informational, 2 navigational, 3 transactional
↳ `trends`	array	Relative search interest over the last 12 months

Semrush Organic Results

List the domains and URLs ranking in Google organic search results for a keyword.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`phrase`	string	Yes	Keyword to analyze
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format

Output

Parameter	Type	Description
`results`	array	Ranking pages for the keyword, in SERP order
↳ `position`	number	Position in the Google top 100 results, where 0 means not ranked
↳ `positionType`	string	Whether the position is a regular organic result or a SERP feature
↳ `domain`	string	Domain name
↳ `url`	string	URL of the ranking or advertised page
↳ `keywordSerpFeatures`	array	IDs of all SERP features triggered by the keyword
↳ `serpFeatures`	array	IDs of the SERP features the domain appears in for the keyword

Semrush Paid Results

List the domains and URLs advertising on a keyword in Google paid search results.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`phrase`	string	Yes	Keyword to analyze
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format

Output

Parameter	Type	Description
`results`	array	Advertisers appearing for the keyword
↳ `domain`	string	Domain name
↳ `url`	string	URL of the ranking or advertised page
↳ `visibleUrl`	string	Display URL shown in the ad

Semrush Keyword Ad History

List which domains advertised on a keyword month by month, with the copy each one used.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`phrase`	string	Yes	Keyword to analyze
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination

Output

Parameter	Type	Description
`ads`	array	Historical advertisers for the keyword, one row per domain and month
↳ `domain`	string	Domain name
↳ `date`	string	Data collection date in YYYYMMDD or YYYYMM format
↳ `position`	number	Position in the Google top 100 results, where 0 means not ranked
↳ `url`	string	URL of the ranking or advertised page
↳ `title`	string	Ad or product title
↳ `description`	string	Ad text
↳ `visibleUrl`	string	Display URL shown in the ad

Semrush Winners and Losers

List the domains that gained or lost the most organic and paid search visibility in a database.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displaySort`	string	No	Sort order, for example om_desc or tm_desc

Output

Parameter	Type	Description
`domains`	array	Domains ranked by change in search visibility
↳ `domain`	string	Domain name
↳ `rank`	number	Semrush popularity rating of this domain, based on organic traffic
↳ `organicKeywords`	number	Keywords this domain ranks for in the Google top 100 organic results
↳ `organicTraffic`	number	Traffic this domain gets from the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of this domain organic keywords
↳ `paidKeywords`	number	Keywords this domain is buying in Google Ads
↳ `paidTraffic`	number	Traffic this domain gets from paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget of this domain
↳ `organicKeywordsDifference`	number	Change in organic keyword count since the previous month
↳ `organicTrafficDifference`	number	Change in organic traffic since the previous month
↳ `organicCostDifference`	number	Change in organic cost since the previous month
↳ `paidKeywordsDifference`	number	Change in paid keyword count since the previous month
↳ `paidTrafficDifference`	number	Change in paid traffic since the previous month
↳ `paidCostDifference`	number	Change in paid cost since the previous month

Semrush Top Domains

List the highest-ranked domains in a regional database by Semrush rank.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`database`	string	Yes	Regional database code, for example us, uk, de, or fr
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displayDate`	string	No	Historical month in YYYYMM15 format
`displayFilter`	string	No	Semrush display_filter expression, for example +\|Or\|Gt\|100000

Output

Parameter	Type	Description
`domains`	array	Top-ranked domains in the database
↳ `domain`	string	Domain name
↳ `rank`	number	Semrush popularity rating of this domain, based on organic traffic
↳ `organicKeywords`	number	Keywords this domain ranks for in the Google top 100 organic results
↳ `organicTraffic`	number	Traffic this domain gets from the Google top 100 organic results
↳ `organicCost`	number	Estimated Google Ads price of this domain organic keywords
↳ `paidKeywords`	number	Keywords this domain is buying in Google Ads
↳ `paidTraffic`	number	Traffic this domain gets from paid search results
↳ `paidCost`	number	Estimated monthly Google Ads budget of this domain

Semrush Backlinks Overview

Get the Authority Score and backlink profile totals for a domain, subdomain, or URL.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`target`	string	Yes	Root domain, subdomain, or URL to analyze
`targetType`	string	No	Scope of the target: root_domain, domain, or url. Defaults to root_domain

Output

Parameter	Type	Description
`overview`	json	Backlink profile totals for the target
↳ `authorityScore`	number	Semrush Authority Score (0-100)
↳ `total`	number	Total number of backlinks
↳ `domainsNum`	number	Number of referring domains
↳ `urlsNum`	number	Number of referring URLs
↳ `ipsNum`	number	Number of referring IPs
↳ `ipClassCNum`	number	Number of referring class C subnets
↳ `followsNum`	number	Number of followed backlinks
↳ `nofollowsNum`	number	Number of nofollow backlinks
↳ `sponsoredNum`	number	Number of backlinks marked rel="sponsored"
↳ `ugcNum`	number	Number of backlinks marked rel="ugc"
↳ `textsNum`	number	Number of text backlinks
↳ `imagesNum`	number	Number of image backlinks
↳ `formsNum`	number	Number of form backlinks
↳ `framesNum`	number	Number of frame backlinks

Semrush Backlinks

List the backlinks pointing at a domain, subdomain, or URL, with source page, anchor, and authority.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`target`	string	Yes	Root domain, subdomain, or URL to analyze
`targetType`	string	No	Scope of the target: root_domain, domain, or url. Defaults to root_domain
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example page_ascore_desc or last_seen_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|type\|\|newlink

Output

Parameter	Type	Description
`backlinks`	array	Backlinks pointing at the target
↳ `pageAuthorityScore`	number	Authority Score of the source page
↳ `sourceTitle`	string	Title of the linking page
↳ `sourceUrl`	string	URL of the linking page
↳ `targetUrl`	string	URL the backlink points to
↳ `anchor`	string	Anchor text of the backlink
↳ `nofollow`	string	Raw rel="nofollow" flag as returned by the API
↳ `externalLinksNum`	number	External links on the source page
↳ `internalLinksNum`	number	Internal links on the source page
↳ `firstSeen`	number	Unix timestamp when the link was first seen
↳ `lastSeen`	number	Unix timestamp when the link was last seen

Semrush Referring Domains

List the domains linking to a target, with Authority Score, backlink count, and country.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`target`	string	Yes	Root domain, subdomain, or URL to analyze
`targetType`	string	No	Scope of the target: root_domain, domain, or url. Defaults to root_domain
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example backlinks_num_desc or domain_ascore_desc
`displayFilter`	string	No	Semrush display_filter expression, for example +\|zone\|\|com

Output

Parameter	Type	Description
`domains`	array	Domains linking to the target
↳ `domainAuthorityScore`	number	Authority Score of the referring domain
↳ `domain`	string	Domain name
↳ `backlinksNum`	number	Number of backlinks
↳ `ip`	string	IP address
↳ `country`	string	Country of the referring domain
↳ `firstSeen`	number	Unix timestamp when the link was first seen
↳ `lastSeen`	number	Unix timestamp when the link was last seen

Semrush Referring IPs

List the IP addresses linking to a target, with the domain and backlink counts behind each one.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`target`	string	Yes	Root domain, subdomain, or URL to analyze
`targetType`	string	No	Scope of the target: root_domain, domain, or url. Defaults to root_domain
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example domains_num_desc or backlinks_num_desc

Output

Parameter	Type	Description
`ips`	array	IP addresses linking to the target
↳ `ip`	string	IP address
↳ `country`	string	Country of the referring domain
↳ `domainsNum`	number	Number of referring domains
↳ `backlinksNum`	number	Number of backlinks
↳ `firstSeen`	number	Unix timestamp when the link was first seen
↳ `lastSeen`	number	Unix timestamp when the link was last seen

Semrush Backlink TLD Distribution

Break a target’s backlink profile down by the top-level domain of its referring domains.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`target`	string	Yes	Root domain, subdomain, or URL to analyze
`targetType`	string	No	Scope of the target: root_domain, domain, or url. Defaults to root_domain
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example domains_num_desc or backlinks_num_desc

Output

Parameter	Type	Description
`zones`	array	Referring domain and backlink counts per top-level domain
↳ `zone`	string	Top-level domain zone
↳ `domainsNum`	number	Number of referring domains
↳ `backlinksNum`	number	Number of backlinks

Semrush Backlink Country Distribution

Break a target’s backlink profile down by the country of its referring domains.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`target`	string	Yes	Root domain, subdomain, or URL to analyze
`targetType`	string	No	Scope of the target: root_domain, domain, or url. Defaults to root_domain
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example domains_num_desc or backlinks_num_desc

Output

Parameter	Type	Description
`countries`	array	Referring domain and backlink counts per country
↳ `country`	string	Country of the referring domain
↳ `domainsNum`	number	Number of referring domains
↳ `backlinksNum`	number	Number of backlinks

Semrush Backlink Anchors

List the anchor texts used in backlinks to a target, with domain and backlink counts.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`target`	string	Yes	Root domain, subdomain, or URL to analyze
`targetType`	string	No	Scope of the target: root_domain, domain, or url. Defaults to root_domain
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example backlinks_num_desc or domains_num_desc

Output

Parameter	Type	Description
`anchors`	array	Anchor text distribution for the backlink profile
↳ `anchor`	string	Anchor text of the backlink
↳ `domainsNum`	number	Number of referring domains
↳ `backlinksNum`	number	Number of backlinks
↳ `firstSeen`	number	Unix timestamp when the link was first seen
↳ `lastSeen`	number	Unix timestamp when the link was last seen

Semrush Indexed Pages

List the pages of a target that attract backlinks, with response code and link counts.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`target`	string	Yes	Root domain, subdomain, or URL to analyze
`targetType`	string	No	Scope of the target: root_domain, domain, or url. Defaults to root_domain
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination
`displaySort`	string	No	Sort order, for example domains_num_desc or backlinks_num_desc

Output

Parameter	Type	Description
`pages`	array	Indexed pages of the target and the links they attract
↳ `sourceUrl`	string	URL of the linking page
↳ `sourceTitle`	string	Title of the linking page
↳ `responseCode`	number	HTTP status code the page returned when last crawled
↳ `backlinksNum`	number	Number of backlinks
↳ `domainsNum`	number	Number of referring domains
↳ `lastSeen`	number	Unix timestamp when the link was last seen
↳ `externalLinksNum`	number	External links on the source page
↳ `internalLinksNum`	number	Internal links on the source page

Semrush Backlink Competitors

List domains with a backlink profile similar to the target, ranked by shared referring domains.

Inputs and outputs

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	Semrush API key
`target`	string	Yes	Root domain, subdomain, or URL to analyze
`targetType`	string	No	Scope of the target: root_domain, domain, or url. Defaults to root_domain
`limit`	number	No	Maximum number of rows to return, capped at 100,000
`offset`	number	No	Number of rows to skip, for pagination

Output

Parameter	Type	Description
`competitors`	array	Domains with backlink profiles similar to the target
↳ `authorityScore`	number	Semrush Authority Score (0-100)
↳ `domain`	string	Domain name
↳ `similarity`	number	Backlink profile similarity to the target
↳ `commonRefdomains`	number	Referring domains shared with the target
↳ `domainsNum`	number	Number of referring domains
↳ `backlinksNum`	number	Number of backlinks