Semrush Developers

Price: 10 API units None info

This report provides live or historical data on a subdomain’s keyword rankings in both organic and paid search in a chosen regional database.

About the Domain Overview report ›

Request parameters

Name	Value/Type	Description
type	subdomain_rank	The report type.
key	API_KEY	An identification key assigned to a user after subscribing to Semrush. The key is available on the Profile page.
subdomain	shop.example.com	A unique name of a website's subdomain you’d like to investigate.
database	database	A regional database (one value from the list).
export_escape	1	If this parameter uses the value of `1`, the report’s columns will be wrapped in double quotation marks (").
export_decode	1 or 0	If this parameter uses the value `0`, the response will be sent as a URL-encoded string; otherwise, the response will not be converted.
display_date	date in format "YYYYMM15"	A date on which a report will be shown. You can roll back to a date in the past or choose the current date.
export_columns	Dn, Or, Xn, Ot, Oc, Ad, At, Ac, FKn, FP… Dn, Or, Xn, Ot, Oc, Ad, At, Ac, FKn, FPn, Ipu, Ip0, Ip1, Ip2, Ip3, Itu, It0, It1, It2, It3, Icu, Ic0, Ic1, Ic2, Ic3, Sr, Srb, St, Stb, Sc, Srn, Srl	Required columns must be separated by commas. If this parameter is not specified, default columns will be sent. Columns

* Fields marked by an asterisk (*) are required

Endpoint

https://api.semrush.com/

Request example

https://api.semrush.com/?type=subdomain_rank&key=YOUR_API_KEY&export_columns=Or,Ot,Oc,Ad,At,Ac&subdomain=partnernetwork.ebay.com&database=us

Response example

Organic Keywords;Organic Traffic;Organic Cost;Adwords Keywords;Adwords Traffic;Adwords Cost
1052;5383;8074;1;7;8

Price: 10 API units per line info

This report provides live or historical data on a subdomain’s keyword rankings in both organic and paid search in all regional databases.

About the Domain Overview report ›

Request parameters

Name	Value/Type	Description
type*	subdomain_ranks	The report type.
key*	API_KEY	An identification key assigned to a user after subscribing to Semrush. The key is available on the Profile page.
subdomain*	shop.example.com	A unique name of a website's subdomain you’d like to investigate.
database	database	A regional database. If this parameter isn't specified, your request will be sent to all regional databases.
display_limit	integer	The number of results returned to a request; if this parameter isn't specified or equals `0`, the default value will be 10,000 lines. Keep in mind that the max. number of the returned results is 100,000. If you need more results, use the `display_offset` parameter. The max. value for `display_limit` is 4,000,000.
display_offset	integer	This parameter allows you to skip a specified number of results before sending a report. Keep in mind that if you use the `display_offset` option, the `display_limit` value should be increased by the value set in `display_offset`. If you need more than the first 100,000 results, add the `display_offset` value to `display_limit`.
export_escape	1	If this parameter is set to `1`, the report’s columns will be wrapped in double quotation marks (").
display_date	date in format "YYYYMM15"	The date for which the report will be shown. You can roll back to a date in the past or choose the current date.
export_columns	Db, Dt, Dn, Or, Ot, Oc, Ad, At, Ac, Sh,… Db, Dt, Dn, Or, Ot, Oc, Ad, At, Ac, Sh, Sv, FKn, FPn, Sr, Srb, St, Stb, Sc, Srn, Srl	The required columns must be separated by commas. If this parameter isn't specified, the default columns will be sent. Columns
display_sort	or_asc, or_desc, ot_asc, ot_desc, oc_as… or_asc, or_desc, ot_asc, ot_desc, oc_asc, oc_desc, ad_asc, ad_desc, at_asc, at_desc, ac_asc, ac_desc	This parameter allows you to choose by which column you would like to sort your results in ascending or descending order. Sortings

* Fields marked by an asterisk (*) are required

Endpoint

https://api.semrush.com/

Request example

https://api.semrush.com/?key=YOUR_API_KEY&type=subdomain_ranks&export_columns=Db,Or,Ot,Oc,Ad,At,Ac,Sh,Sv&subdomain=partnernetwork.ebay.com&database=us

Response example

Database;Organic Keywords;Organic Traffic;Organic Cost;Adwords Keywords;Adwords Traffic;Adwords Cost;PLA keywords;PLA uniques
us;1052;5383;8074;1;7;8;0;0

Price: 10 API units per line info

This report provides live and historical data on a subdomain’s keyword rankings in both organic and paid search in a chosen database.

About the Domain Overview report ›

Request parameters

Name	Value/Type	Description
type*	subdomain_rank_history	The report type.
key*	API_KEY	An identification key assigned to a user after subscribing to Semrush. The key is available on the Profile page.
subdomain*	shop.example.com	A unique name of a website's subdomain you’d like to investigate.
database*	database	A regional database (one value from the list).
display_limit	integer	The number of results returned to a request; if this parameter isn't specified or equals `0`, the default value will be 10,000 lines. Keep in mind that the max. number of the returned results is 100,000. If you need more results, use the `display_offset` parameter. The max. value for `display_limit` is 4,000,000.
display_offset	integer	This parameter allows you to skip a specified number of results before sending a report. Keep in mind that if you use the `display_offset` option, the `display_limit` value should be increased by the value set in `display_offset`. If you need more than the first 100,000 results, add the `display_offset` value to `display_limit`.
export_escape	1	If this parameter is set to `1`, the report’s columns will be wrapped in double quotation marks (").
Export_decode	1 or 0	If this parameter is set to `0`, the response will be sent as a URL-encoded string; otherwise, the response won't be converted.
display_daily	1	This parameter allows you to get daily updates on position changes that occurred in the last 30 days or more. If the parameter isn't specified, your report will show monthly results for the current and previous months.
export_columns	Or, Xn, Ot, Oc, Ad, At, Ac, Dt, FKn, FP… Or, Xn, Ot, Oc, Ad, At, Ac, Dt, FKn, FPn, Sr, Srb, St, Stb, Sc	The required columns must be separated by commas. If this parameter isn't specified, the default columns will be sent. Columns
display_sort	dt_asc, dt_desc	This parameter allows you to choose by which column you would like to sort your results in ascending or descending order. Sortings

* Fields marked by an asterisk (*) are required

Endpoint

https://api.semrush.com/

Request example

https://api.semrush.com/?type=subdomain_rank_history&key=YOUR_API_KEY&display_limit=10&export_columns=Or,Ot,Oc,Ad,At,Ac,Dt&subdomain=partnernetwork.ebay.com&database=us

Response example

Organic Keywords;Organic Traffic;Organic Cost;Adwords Keywords;Adwords Traffic;Adwords Cost;Date
1259;8105;6634;1;7;8;20230215
1125;8133;7633;0;0;0;20230115
1116;5452;11365;0;0;0;20221215
966;5387;9436;2;13;16;20221115
983;5745;7820;0;0;0;20221015
952;6434;9496;2;12;13;20220915
936;5558;9932;2;12;14;20220815
897;6001;14572;0;0;0;20220715
730;5835;16546;0;0;0;20220615

Price: 10 API units per line info

This report lists keywords that bring users to a subdomain via Google's top 100 organic search results.

About the Organic Research Overview report ›

Request parameters

Name	Value/Type	Description
type*	subdomain_organic	The report type.
key*	API_KEY	An identification key assigned to a user after subscribing to Semrush. The key is available on the Profile page.
subdomain*	shop.example.com	A unique name of a website's subdomain you’d like to investigate.
database*	database	A regional database (one value from the list). Databases
display_limit	integer	The number of results returned to a request; if this parameter isn't specified or equals `0`, the default value will be 10,000 lines. Keep in mind that the max. number of the returned results is 100,000. If you need more results, use the `display_offset` parameter. The max. value for `display_limit` is 4,000,000.
display_offset	integer	This parameter allows you to skip a specified number of results before sending a report. Keep in mind that if you use the `display_offset` option, the `display_limit` value should be increased by the value set in `display_offset`. If you need more than the first 100,000 results, add the `display_offset` value to `display_limit`.
export_escape	1	If this parameter is set to `1`, the report’s columns will be wrapped in double quotation marks (").
display_date	date in format "YYYYMM15"	The date for which the report will be shown. You can roll back to a date in the past or choose the current date.
display_daily	1	This parameter allows you to get daily updates on position changes that occurred in the last 30 days or more. If the parameter isn't specified, your report will show monthly results for the current and previous months. This option is applied only when `display_positions` is set.
export_columns	Ph, Po, Pp, Pd, Nq, Cp, Ur, Tr, Tg, Tc,… Ph, Po, Pp, Pd, Nq, Cp, Ur, Tr, Tg, Tc, Co, Nr, Td, Kd, Fp, Fk, Ts, In, Pt	The required columns must be separated by commas. If this parameter isn't specified, the default columns will be sent. Columns
display_sort	po_asc, po_desc, tg_asc, tg_desc, tr_as… po_asc, po_desc, tg_asc, tg_desc, tr_asc, tr_desc, tc_asc, tc_desc, nq_asc, nq_desc, co_asc, co_desc, kd_asc, kd_desc, cp_asc, cp_desc, nr_asc, nr_desc, ts_asc, ts_desc	This parameter allows you to choose by which column you would like to sort your results in ascending or descending order. Sortings
display_positions	new, lost, rise or fall	The `new` value indicates keywords that brought a subdomain to Google's top 100 organic or paid search results; `lost` indicates keywords that no longer bring a subdomain to Google's top 100 organic or paid search results; `rise` indicates keywords that helped a subdomain get a higher ranking in Google's top 100 organic or paid search results; `fall` indicates keywords that are currently helping a subdomain remain in the Google top 100, though its ranking may have decreased.
display_filter	Ph, Po, Nq, Cp, Ur, Tg, Tr, Tc, Nr, Co,… Ph, Po, Nq, Cp, Ur, Tg, Tr, Tc, Nr, Co, Pp, Pd, Fp, Fk, In, Br	Filters for columns. Filters
display_positions_type	organic, all, serp_features	The `organic` value indicates keywords where a subdomain ranks only in the traditional positions on SERP, and it's applied to the method by default; `all` indicates keywords where a subdomain ranks for traditional positions and the keywords where it ranks for SERP Features; `serp_features` indicates keywords where a subdomain ranks only in the SERP Features.

* Fields marked by an asterisk (*) are required

Endpoint

https://api.semrush.com/

Request example

https://api.semrush.com/?type=subdomain_organic&key=YOUR_API_KEY&display_filter=%2B%7CPh%7CCo%7Cseo&display_limit=10&export_columns=Ph,Po,Pp,Pd,Nq,Cp,Ur,Tr,Tc,Co,Nr,Td&subdomain=tools.seobook.com&display_sort=tr_desc&database=us

Response example

Keyword;Position;Previous Position;Position Difference;Search Volume;CPC;Url;Traffic (%);Traffic Cost (%);Competition;Number of Results;Trends
tools seobook;1;1;0;40;0.00;http://tools.seobook.com/;2.81;0.00;0.13;123000;0.27,1.00,0.18,0.18,0.18,0.18,1.00,0.18,0.18,0.18,0.18,0.18
seo toolbar;3;3;0;260;2.69;http://tools.seobook.com/seo-toolbar/;1.84;2.51;0.04;4590000;0.18,0.11,0.05,0.03,0.81,0.28,0.23,0.44,0.35,0.44,1.00,0.81
seo tools;28;30;2;12100;4.34;http://tools.seobook.com/;1.58;3.43;0.26;257000000;0.81,0.66,0.66,0.81,0.81,1.00,0.81,0.81,0.81,0.81,1.00,1.00
seo book keyword tool;1;1;0;20;3.08;http://tools.seobook.com/keyword-tools/seobook/;1.40;2.15;0.14;4050000;0.11,0.07,0.07,0.07,0.07,0.07,0.07,0.07,0.26,0.07,0.07,0.07
free seo tools;18;20;2;4400;4.61;http://tools.seobook.com/;1.14;2.64;0.29;192000000;0.81,0.81,0.66,0.81,0.81,0.81,1.00,0.81,0.81,0.81,1.00,1.00
seo tollbar;3;3;0;170;2.69;http://tools.seobook.com/seo-toolbar/;1.14;1.63;0.04;5110000;0.43,0.82,0.53,0.53,0.66,0.66,1.00,0.17,0.02,0.28,0.00,0.00
seo for firefox;1;1;0;50;0.00;http://tools.seobook.com/firefox/seo-for-firefox.html;1.05;0.00;0.03;14400000;0.21,0.14,0.35,0.64,0.14,0.14,0.78,0.78,0.64,0.14,0.14,0.14
seo toolbar firefox;1;1;0;30;0.00;http://tools.seobook.com/seo-toolbar/;0.61;0.00;0.01;2410000;1.00,1.00,0.00,0.00,0.00,0.09,0.27,0.00,0.18,0.09,0.00,0.09
seo toolbar for firefox;4;4;0;90;0.00;http://tools.seobook.com/seo-toolbar/;0.43;0.00;0.01;2280000;0.17,0.64,1.00,0.52,0.52,0.52,0.82,0.52,0.17,0.29,0.29,0.41
best seo toolbar firefox;2;2;0;30;0.00;http://tools.seobook.com/seo-toolbar/;0.26;0.00;0.00;2850000;0.42,0.28,0.28,0.28,0.42,0.42,1.00,0.28,0.28,0.28,0.28,0.28

Price: 20 API units per line info

This report lists keywords that bring users to a subdomain via Google's paid search results.

About the Advertising Research Positions report ›

Request parameters

Name	Value/Type	Description
type*	subdomain_adwords	The report type.
key*	API_KEY	An identification key assigned to a user after subscribing to Semrush. The key is available on the Profile page.
subdomain*	shop.example.com	A unique name of a website's subdomain you’d like to investigate.
database*	database	A regional database (one value from the list). Databases
display_limit	integer	The number of results returned to a request; if this parameter isn't specified or equals `0`, the default value will be 10,000 lines. Keep in mind that the max. number of the returned results is 100,000. If you need more results, use the `display_offset` parameter. The max value for `display_limit` is 4,000,000.
display_offset	integer	This parameter allows you to skip a specified number of results before sending a report. Keep in mind that if you use the `display_offset` option, the `display_limit` value should be increased by the value set in `display_offset`. If you need more than the first 100,000 results, add the `display_offset` value to `display_limit`.
export_escape	1	If this parameter is set to `1`, the report’s columns will be wrapped in double quotation marks (").
export_decode	1 or 0	If this parameter is set to `0`, the response will be sent as a URL-encoded string; otherwise, the response won't be converted.
display_date	date in format "YYYYMM15"	The date for which the report will be shown. You can roll back to a date in the past or choose the current date.
export_columns	Ph, Po, Pp, Pd, Ab, Nq, Cp, Tg, Tr, Tc,… Ph, Po, Pp, Pd, Ab, Nq, Cp, Tg, Tr, Tc, Co, Nr, Td, Tt, Ds, Vu, Ur, Ts, Un	The required columns must be separated by commas. If this parameter isn't specified, the default columns will be sent. Columns
display_sort	po_asc, po_desc, tg_asc, tg_desc, tr_as… po_asc, po_desc, tg_asc, tg_desc, tr_asc, tr_desc, tc_asc, tc_desc, nq_asc, nq_desc	This parameter allows you to choose by which column you would like to sort your results in ascending or descending order. Sortings
display_positions	new, lost, rise or fall	The `new` value indicates keywords that brought a subdomain to Google's top 100 organic or paid search results; `lost` indicates keywords that no longer bring a subdomain to Google's top 100 organic or paid search results; `rise` indicates keywords that helped a subdomain get a higher ranking in Google's top 100 organic or paid search results; `fall` indicates keywords that are currently helping a subdomain remain in the Google top 100, though its ranking may have decreased.
display_filter	Ph, Po, Nq, Cp, Ur, Tg, Tr, Tc, Nr, Co,… Ph, Po, Nq, Cp, Ur, Tg, Tr, Tc, Nr, Co, Pp, Pd, Un	Filters for columns. Filters

* Fields marked by an asterisk (*) are required

Endpoint

https://api.semrush.com/

Request example

https://api.semrush.com/?type=subdomain_adwords&key=YOUR_API_KEY&display_limit=10&export_columns=Ph,Po,Pp,Pd,Nq,Cp,Vu,Tr,Tc,Co,Nr,Td&subdomain=www.ebay.com&display_sort=po_asc&database=us

Response example

Keyword;Position;Previous Position;Position Difference;Search Volume;CPC;Visible Url;Traffic (%);Traffic Cost (%);Competition;Number of Results;Trends
formalities by baum bros victorian rose collection;1;1;0;260;0.00;https://www.ebay.com;0.00;0.00;0.99;29;0.66,0.66,0.81,0.66,0.35,0.29,0.43,0.29,0.22,0.35,0.54,0.66
superman cards 1978 value;1;1;0;30;0.00;https://www.ebay.com;0.00;0.00;0.32;85;0.27,0.18,0.18,0.18,0.18,0.18,1.00,0.18,0.18,0.18,0.18,0.18
traxxas raptor body;1;1;0;90;0.21;https://www.ebay.com/;0.00;0.00;1.00;66;0.82,0.64,0.64,0.64,0.41,0.41,0.64,0.64,0.23,0.52,0.41,0.64
dtm motors;1;1;0;40;0.25;https://www.ebay.com;0.00;0.00;0.11;6810000;0.27,0.18,0.18,0.18,0.18,0.18,1.00,1.00,0.18,0.18,0.18,0.18
1958 encyclopedia britannica for sale;1;1;0;140;0.07;https://www.ebay.com;0.00;0.00;1.00;58;0.07,0.05,0.17,0.17,0.28,0.17,0.43,0.53,0.43,0.35,0.66,0.66
homer laughlin;1;1;0;2900;0.11;https://www.ebay.com;0.01;0.00;0.99;96;0.66,0.81,0.53,0.66,0.44,0.53,0.35,0.44,0.53,0.44,0.53,0.66
vintage silver napkin rings;1;0;-1;70;0.29;https://www.ebay.com;0.00;0.00;1.00;94;0.18,0.18,0.18,0.18,1.00,1.00,0.18,0.18,1.00,1.00,0.18,1.00
carbon fibre snooker cue;1;0;-1;30;0.42;https://www.ebay.com;0.00;0.00;1.00;85;0.07,0.07,0.07,0.07,0.07,0.07,0.07,0.07,0.07,0.07,0.42,0.07
ultralight hang glider;1;0;-1;110;0.00;https://www.ebay.com;0.00;0.00;0.92;1510000;0.34,0.43,0.34,0.43,0.53,0.34,0.43,0.28,0.28,0.21,0.28,0.28
weezer dusty gems and raw nuggets;1;1;0;110;0.00;https://www.ebay.com;0.00;0.00;0.04;69;0.15,0.28,0.43,0.34,0.43,0.34,0.34,0.34,0.34,0.28,0.28,0.28

Price: 10 API units per line info

This report shows unique pages of the analyzed subdomain ranking in Google's top 100 organic search results.

About the Organic Research Pages report ›

Request parameters

Name	Value/Type	Description
type*	subdomain_organic_unique	Report type.
key*	API_KEY	Identification key assigned to each user after subscribing to Semrush. You'll find it in Subscription info > API units.
subdomain*	shop.example.com	Unique name of a website's subdomain you'd like to investigate.
database*	database	Regional database (one value from the list). Databases
display_limit	integer	The number of results returned to a request; if this parameter isn't specified or equals `0`, the default value will be 10,000 lines. Keep in mind that the max. number of the returned results is 100,000. If you need more results, use the `display_offset` parameter. The max value for `display_limit` is 4,000,000.
display_offset	integer	This parameter lets you skip a specified number of results before sending the report. Keep in mind that if you use the `display_offset` option, the `display_limit` value should be increased by the value set in `display_offset`. If you need more than the first 100,000 results, add the `display_offset` value to `display_limit`.
export_escape	1	If this parameter is set to `1`, the report's columns will be wrapped in double quotation marks (`"`).
export_decode	1 or 0	If this parameter is set to `0`, the response will be sent as a URL-encoded string. If it's set to `1`, the response won't be converted.
display_date	date in format "YYYYMM15"	The date for which the report will be shown. You can roll back to a date in the past or choose the current date.
export_columns	Ur, Pc, Tg, Tr, Ipu, Ip0, Ip1, Ip2, Ip3… Ur, Pc, Tg, Tr, Ipu, Ip0, Ip1, Ip2, Ip3, Itu, It0, It1, It2, It3, Sr, St	The required columns must be separated by commas. If this parameter isn't specified, the default columns will be sent. Columns
display_sort	pc_asc, pc_desc, tg_asc, tg_desc, tr_as… pc_asc, pc_desc, tg_asc, tg_desc, tr_asc, tr_desc, sr_asc, sr_desc, st_asc, st_desc	This parameter lets you choose which column you would like to sort your results by in ascending or descending order. Sortings
display_filter	Ur, Pc, Tg, Tr, Ipu, Ip0, Ip1, Ip2, Ip3… Ur, Pc, Tg, Tr, Ipu, Ip0, Ip1, Ip2, Ip3, Sr, St	Filters for columns. Filters

* Fields marked by an asterisk (*) are required

Endpoint

https://api.semrush.com/

Request example

https://api.semrush.com/?type=subdomain_organic_unique&key=YOUR_API_KEY&display_filter=%2B%7CPc%7CGt%7C100&display_limit=10&export_columns=Ur,Pc,Tg,Tr&subdomain=tools.seobook.com&display_sort=tr_desc&database=us

Response example

Url,Number of Keywords,Traffic,Traffic (%)
"http://tools.seobook.com/firefox/rank-checker/","129","7","3.00"

Price: 40 API units per line

This report shows unique ad copies Semrush noticed when the subdomain ranked in Google's paid search results for keywords from our databases.

About the Ads Copies report ›

Request parameters

Name	Value/Type	Description
type*	subdomain_adwords_unique	Report type.
key*	API_KEY	Identification key assigned to each user after subscribing to Semrush. You'll find it in Subscription info > API units.
subdomain*	shop.example.com	Unique name of a website's subdomain you'd like to investigate.
database*	database	Regional database (one value from the list). Databases
display_limit	integer	The number of results returned to a request; if this parameter isn't specified or equals `0`, the default value will be 10,000 lines. Keep in mind that the max. number of the returned results is 100,000. If you need more results, use the `display_offset` parameter. The max value for `display_limit` is 4,000,000.
display_offset	integer	This parameter allows you to skip a specified number of results before sending the report. Keep in mind that if you use the `display_offset` option, the `display_limit` value should be increased by the value set in `display_offset`. If you need more than the first 100,000 results, add the `display_offset` value to `display_limit`.
export_escape	1	If this parameter is set to `1`, the report’s columns will be wrapped in double quotation marks (`"`).
export_decode	1 or 0	If this parameter is set to `0`, the response will be sent as a URL-encoded string; otherwise, the response won't be converted.
export_columns	Ph,Un,Tt,Ds,Vu,Ur,Pc,Ts	This parameter lets you specify the columns you need, separated by commas. If this parameter isn't set, the default columns will be sent. Columns
display_sort	pc_asc, pc_desc	This parameter lets you choose by which column you would like to sort your results in ascending or descending order. Sortings
display_filter	Tt, Ds, Vu	Filters for columns. Filters

* Fields marked by an asterisk (*) are required

Endpoint

https://api.semrush.com/

Request example

https://api.semrush.com/?type=subdomain_adwords_unique&key=YOUR_API_KEY&display_limit=3&export_columns=Tt,Ds,Vu,Ur,Pc&subdomain=www.ebay.com&database=us

Response example

Title;Description;Visible Url;Url;Number of Keywords
Authentic Designer Goods - Clothing Shoes and Accessories;Prada Gucci Burberry Lanvin Chanel ;www.ebay.com/usr/luxeloveshop;http://www.ebay.com/usr/luxeloveshop&ved=0CHYQ0Qw;633
Boat For Sale on eBay;Huge selection of Boat For Sale.Free Shipping available. Buy Now!;www.ebay.com/;http://rover.ebay.com/rover/1/711-42618-2056-0/2%3Fmpre%3Dhttp%253A%252F%252Fwww.ebay.com%252Fsch%252Fi.html%253F_nkw%253Dboat%252520for%252520sale%26keyword%3Dboat%2Bfor%2Bsale%26crlp%3D35687221484_2416792%26MT_ID%3D69%26geo_id%3D10232%26adpos%3D1s4%26device%3Dc&ved=0CIABENEM;361

Subdomain reports

Subdomain Overview (one database)

Request parameters

Subdomain Overview (all databases)

Request parameters

Subdomain Overview (history)

Request parameters

Subdomain Organic Search Keywords

Request parameters

Subdomain Paid Search Keywords

Request parameters

Subdomain Organic Pages

Request parameters

Ads Copies

Request parameters