Semrush Developers

Price: 10 API units per line info

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

Request parameters

Name	Value/Type	Description
type*	subfolder_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.
subfolder*	example.com/blog/	A unique name of a website's subfolder you’d like to investigate.
database*	database	A regional database (one value from the list).
export_escape	1	If this parameter uses the value `"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; if "1", 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 the past or choose an actual 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=subfolder_rank&key=YOUR_API_KEY&export_columns=Or,Ot,Oc,Ad,At,Ac&subfolder=tools.seobook.com/general/&database=us

Response example

Organic Keywords;Organic Traffic;Organic Cost;Adwords Keywords;Adwords Traffic;Adwords Cost
207;261;478;0;0;0

Price: 10 API units per line info

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

Request parameters

Name	Value/Type	Description
type*	subfolder_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.
subfolder*	example.com/blog/	A unique name of a website's subfolder 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 is not specified or equals to 0, the default value will be 10,000 lines. Please keep in mind that the max number of the returned results is 100,000. If you need more results, refer to display_offset.
display_offset	integer	This parameter allows you to skip a specified number of results before sending a report. Please keep in mind that if you use the option display_offset, display_limit, the value should be increased by value display_offset. Please keep in mind that if you need more than the first 100,000 results, add the value of display_offset to the value of display_limit.
export_escape	1	If this parameter uses the value `"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; if "1", the response will not 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 is not specified, your report will show monthly results for the current month and for 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	Required columns must be separated by commas; if this parameter is not specified, 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 either ascending or descending order. Sortings

* Fields marked by an asterisk (*) are required

Endpoint

https://api.semrush.com/

Request example

https://api.semrush.com/?type=subfolder_rank_history&key=YOUR_API_KEY&display_limit=10&export_columns=Or,Ot,Oc,Ad,At,Ac,Dt&subfolder=tools.seobook.com/general/&database=us

Response example

Organic Keywords;Organic Traffic;Organic Cost;Adwords Keywords;Adwords Traffic;Adwords Cost;Date
276;327;653;0;0;0;20230215
204;300;648;0;0;0;20230115
271;337;946;0;0;0;20221215
220;324;874;0;0;0;20221115
206;313;954;0;0;0;20221015
189;301;940;0;0;0;20220915
161;302;972;0;0;0;20220815
223;427;1157;0;0;0;20220715
201;346;771;0;0;0;20220615
220;302;806;0;0;0;20220515

Price: 10 API units per line info

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

Request parameters

Name	Value/Type	Description
type*	subfolder_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.
subfolder*	example.com/blog/	A unique name of a website's subfolder you’d like to investigate.
database	database	A regional database; if this parameter is not specified, your request will be sent to all regional databases.
display_limit	integer	The number of results returned to a request; if this parameter is not specified or equals to 0, the default value will be 10,000 lines. Please keep in mind that the max number of the returned results is 100,000. If you need more results, refer to display_offset.
display_offset	integer	This parameter allows you to skip a specified number of results before sending a report. Please keep in mind that if you use the option display_offset, display_limit, the value should be increased by value display_offset. Please keep in mind that if you need more than the first 100,000 results, add the value of display_offset to the value of display_limit.
export_escape	1	If this parameter uses the value `"1"`, the report’s columns will be wrapped in double quotation marks (").
display_date	date in format "YYYYMM15"	A date on which a report will be shown. You can roll back to the past or choose an actual 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	Required columns must be separated by commas; if this parameter is not specified, 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 either 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=subfolder_ranks&export_columns=Db,Or,Ot,Oc,Ad,At,Ac,Sh,Sv&subfolder=tools.seobook.com/general/&database=us

Response example

Database;Organic Keywords;Organic Traffic;Organic Cost;Adwords Keywords;Adwords Traffic;Adwords Cost;PLA keywords;PLA uniques
us;207;261;478;0;0;0;0;0

Price: 10 API units per line info

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

Request parameters

Name	Value/Type	Description
type*	subfolder_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.
subfolder*	example.com/blog/	A unique name of a website 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 is not specified or equals to 0, the default value will be 10,000 lines. Please keep in mind that the max number of the returned results is 100,000. If you need more results, refer to display_offset.
display_offset	integer	This parameter allows you to skip a specified number of results before sending a report. Please keep in mind that if you use the option display_offset, display_limit, the value should be increased by value display_offset. Please keep in mind that if you need more than the first 100,000 results, add the value of display_offset to the value of display_limit.
export_escape	1	If this parameter uses the value `"1"`, the report’s columns will be wrapped in double quotation marks (").
display_date	date in format "YYYYMM15"	A date on which a report will be shown. You can roll back to the past or choose an actual 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 is not specified, your report will show monthly results for the current month and for 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	Required columns must be separated by commas; if this parameter is not specified, 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 either ascending or descending order. Sortings
display_positions	new, lost, rise or fall	The value "new" indicates keywords with which a subfolder entered Google's top 100 organic or paid search results; "lost" indicates keywords that no longer bring a subfolder to Google's top 100 organic or paid search results; "rise" indicates keywords that helped a subfolder to get a higher ranking in Google's top 100 organic or paid search results; "fall" indicates keywords that are currently helping a subfolder 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	Filters for columns. Filters
display_positions_type	organic, all, serp_features	The value “organic” indicates keywords where the subfolder ranks only in the traditional positions on the SERP. Applied to the method by default; “all” indicates keywords where the subdomain ranks for traditional positions and the keywords where domain ranks in SERP Features; “serp_features” indicates keywords where the domain ranks only in SERP Features.

* Fields marked by an asterisk (*) are required

Endpoint

https://api.semrush.com/

Request example

https://api.semrush.com/?type=subfolder_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&subfolder=tools.seobook.com/general/&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
seo keyword density checker;4;4;0;20;2.03;http://tools.seobook.com/general/keyword-density/;0.38;0.41;0.24;2000000;0.14,0.09,0.09,0.09,0.09,0.09,0.09,0.09,0.09,0.09,0.09,0.09
seo keyword density;10;10;0;90;3.45;http://tools.seobook.com/general/keyword-density/;0.38;1.25;0.01;2330000;0.52,0.33,0.52,0.42,0.23,0.66,0.52,0.42,0.33,0.42,1.00,0.33
seo analiser;69;69;0;110;4.61;http://tools.seobook.com/general/keyword-density/;0.00;0.00;0.17;10700000;0.07,0.28,0.28,0.05,0.05,0.05,0.28,0.66,0.17,1.00,0.35,0.66
seo spyder;74;74;0;70;3.57;http://tools.seobook.com/general/spider-test/;0.00;0.00;0.03;2230000;0.17,0.05,0.64,0.64,0.11,1.00,0.11,1.00,0.11,0.00,0.17,0.52
seo analysier;79;79;0;30;4.84;http://tools.seobook.com/general/keyword-density/;0.00;0.00;0.17;8550000;0.00,0.00,0.03,0.07,0.00,0.00,0.00,0.00,1.00,0.26,0.00,0.00
reciprocal links seo;42;42;0;40;0.00;http://tools.seobook.com/general/link-check/;0.00;0.00;0.02;1920000;0.34,0.26,0.19,0.03,0.00,0.00,0.03,0.00,0.07,0.19,0.26,0.34
test seo;76;76;0;260;3.63;http://tools.seobook.com/general/spider-test/;0.00;0.00;0.06;221000000;0.43,0.66,0.82,0.82,0.66,0.82,0.82,0.82,0.23,0.28,0.53,0.43
spider seo;52;52;0;90;3.57;http://tools.seobook.com/general/spider-test/;0.00;0.00;0.03;12100000;0.41,0.17,1.00,0.82,0.29,0.29,0.29,0.29,0.41,0.29,0.52,1.00
reciprocal linking seo;46;46;0;50;0.00;http://tools.seobook.com/general/link-check/;0.00;0.00;0.01;2270000;1.00,0.18,0.18,0.18,0.18,0.18,0.18,0.18,0.18,1.00,1.00,1.00
analyser seo;44;44;0;50;3.90;http://tools.seobook.com/general/keyword-density/;0.00;0.00;0.01;3580000;0.00,0.03,0.06,0.34,0.06,0.06,0.00,0.00,0.00,0.34,1.00,0.21

Price: 20 API units per line info

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

Request parameters

Name	Value/Type	Description
type*	subfolder_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.
subfolder*	example.com/blog/	A unique name of a website's subfolder 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 is not specified or equals to 0, the default value will be 10,000 lines. Please keep in mind that the max number of the returned results is 100,000. If you need more results, refer to display_offset.
display_offset	integer	This parameter allows you to skip a specified number of results before sending a report. Please keep in mind that if you use the option display_offset, display_limit, the value should be increased by value display_offset. Please keep in mind that if you need more than the first 100,000 results, add the value of display_offset to the value of display_limit.
export_escape	1	If this parameter uses the value "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; if "1", 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 the past or choose an actual 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	Required columns must be separated by commas; if this parameter is not specified, 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 either ascending or descending order. Sortings
display_positions	new, lost, rise or fall	The value "new" indicates keywords with which a subfolder entered Google's top 100 organic or paid search results; "lost" indicates keywords that no longer bring a subfolder to Google's top 100 organic or paid search results; "rise" indicates keywords that helped a subfolder to get a higher ranking in Google's top 100 organic or paid search results; "fall" indicates keywords that are currently helping a subfolder 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=subfolder_adwords&key=YOUR_API_KEY&display_limit=10&export_columns=Ph,Po,Pp,Pd,Nq,Cp,Ur,Tr,Tc,Co,Nr,Td&subfolder=ebay.com/help/&display_sort=po_asc&database=us

Response example

Keyword;Position;Previous Position;Position Difference;Search Volume;CPC;Url;Traffic (%);Traffic Cost (%);Competition;Number of Results;Trends
ebayebay;1;1;0;2900;0.32;https://www.ebay.com/help/home;2.03;0.75;0.46;70;0.66,0.24,0.66,0.44,0.35,0.66,0.66,0.53,0.35,0.66,1.00,0.29
how to withdraw offer on ebay;1;0;-1;30;1.00;https://www.ebay.com/help/buying/buy-now/making-best-offer?id=4019;0.01;0.01;0.14;81;0.09,0.09,0.09,0.09,0.09,0.09,0.09,0.09,0.09,0.04,0.52,0.14
contact enay;1;1;0;70;1.85;https://www.ebay.com/help/-/contact-ebay/contact-ebay?id=4379;0.04;0.10;0.08;84;0.63,0.36,0.45,0.45,1.00,0.45,1.00,0.45,0.63,0.45,0.36,0.45
ebay how to cancel offer;1;1;0;90;1.00;https://www.ebay.com/help/buying/buy-now/making-best-offer?id=4019;0.05;0.06;0.14;55;0.64,0.52,0.64,0.64,0.52,0.64,0.64,0.52,0.41,0.52,0.64,0.64
myebaywatchlist;1;1;0;40;2.73;https://www.ebay.com/help/buying/search-tips/watchlist?id=4046;0.01;0.08;0.08;43;0.06,0.00,0.00,0.00,1.00,0.00,0.00,0.00,0.00,0.00,0.02,0.00
ebay cancel best offer;1;0;-1;90;1.00;https://www.ebay.com/help/buying/buy-now/making-best-offer?id=4019;0.05;0.06;0.14;73;0.82,0.82,1.00,1.00,0.82,0.29,0.23,0.29,0.17,0.29,0.52,0.23
block a buyer;1;1;0;90;0.80;https://www.ebay.com/help/selling/resolving-buyer-issues/blocking-buyer-ebay?id=4082;0.05;0.05;0.26;132000000;1.00,0.78,0.64,0.64,0.35,0.50,0.50,0.64,0.64,0.50,0.50,0.64
historical currency converter by year;1;1;0;70;0.00;https://www.ebay.com/help/buying/paying-items/paying-items?id=4009;0.04;0.00;0.03;61400000;0.66,0.42,0.52,0.42,0.33,0.19,0.33,0.33,0.14,0.09,0.23,0.09

Subfolder reports

Subfolder Overview (One database)

Request parameters

Subfolder Overview (History)

Request parameters

Subfolder Overview (All databases)

Request parameters

Subfolder Organic Search Keywords

Request parameters

Subfolder Paid Search Keywords

Request parameters