Get access to 30+ marketing and SEO tools. analyze competitors, keywords, and backlinks for free..
Sign in Sign Up

We use cookies to make Serpstat better. By clicking "Accept cookies", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. Learn more

Domain Reports

2.1.1. Domain Summary (domain_info)

The domain_info method gives you general information about domain: site visibility, estimated SEO traffic, the number of organic and paid keywords of the domain. The data set is similar to the Overview report.

General request parameters and instructions for using Serpstat API

Response parameters
Parameter Description
result Contains the answer
domain A domain of the analyzed site
visible Site visibility
keywords The number of keywords found in the chosen search engine
traff
Estimated search traffic based on keyword positions and search volume
visible_dynamic Dynamics of visibility since the last update
keywords_dynamic Dynamics of the number of keywords since the last update
traff_dynamic Dynamics of estimate traffic since the last update
ads_dynamic Dynamics of changes in PPC Ads
date Current visibility, keywords, and traffic verification date
new_keywords Number of new keywords since the last monitoring
out_keywords Number of lost keywords lost since the last monitoring
rised_keywords Number of keywords which positions of the domain have improved since the last monitoring
down_keywords Number of keywords which positions of the domain have dropped since the last monitoring
ad_keywords Number of keywords in PPC
ads Number of the PPC ads
prev_date Previous verification date
status_msg Response "Ok" or "Error" report on a successful or unsuccessful request
status_code Response code "200" — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines API credits remaining

Part of the API response for which you spend 5 credits:

{
    "domain": "nike.com",
    "visible": 222.88057000000001,
    "keywords": 2613344,
    "traff": 255497238,
    "visible_dynamic": 10.063649999999996,
    "keywords_dynamic": 9610,
    "traff_dynamic": 15189516,
    "ads_dynamic": -99,
    "date": "2021-05-13",
    "new_keywords": 40573,
    "out_keywords": 30963,
    "rised_keywords": 49642,
    "down_keywords": 43635,
    "ad_keywords": 1098,
    "ads": 840,
    "prev_date": "2021-04-29"
  }


If you'd like to get advice on Serpstat's features, order your free 30-minute demo.
Still have questions? Contact the tech support chat.

2.1.2. Domain History (domain_history)

The domain_history method provides historical data on the number of keywords and visibility of the domain. 

General request parameters and instructions for using Serpstat API

Response parameters
Parameter Description
result Contains the answer
domain A domain of the analyzed site
keywords Number of keywords found in the chosen search engine
traff Estimated search traffic based on keyword positions and search volume
visible Site visibility
visible_static Dynamics of visibility since the last update
new_keywords Number of new keywords since the last N-days monitoring
out_keywords Number of lost keywords since the last N-days monitoring
rised_keywords Number of keywords which positions of the domain have improved over the last N-days
down_keywords Number of keywords which positions of the domain have dropped over the last N-days
ad_keywords Number of keywords in PPC
ads Number of the PPC ads
date Verification date of a particular array element
status_msg Response "Ok" or "Error" report on a successful or unsuccessful request
status_code Response code "200" — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines API credits remaining

Part of the API response for which you spend 1 credit:

{
    "domain": "nike.com",
    "keywords": 2603734,
    "traff": 240307722,
    "visible": 212.81692000000001,
    "visible_static": 212.81692000000001,
    "visible_mysql": 0,
    "new_keywords": 32499,
    "out_keywords": 37326,
    "rised_keywords": 40518,
    "down_keywords": 43717,
    "ad_keywords": 1197,
    "ads": 929,
    "date": "2021-04-29"
},

2.1.3. Domain Organic Keywords (domain_keywords)

The domain_keywords method shows keywords which the analyzed domain ranks for in Google top-100 or Yandex top-50 search results. The data set is similar to the Domain analysis — SEO research  Keywords report. You can get up to 60 000 results in this report.

General request parameters and instructions for using Serpstat API

Following parameters can be used for pagination:
page_size: number of results per page (default: 100, max: 1000)
page: page number (set to the 1st page by default)

You can use the following parameters to filter the results:

Parameter Description Possible settings
position_from min position for a keyword  1-100
position_to max position for a keyword  1-100
queries_from min number of monthly searches  0-100,000,000
queries_to max number of monthly searches  0-100,000,000
cost_from min CPC  0-200
cost_to max CPC  0-200
concurrency_from min level of competition  1-100
concurrency_to max level of competition  1-100
url filtering by url  string
keywords filtering by keywords (list of keywords separated by commas)  string
minus_keywords filtering by negative keywords (separated by commas)  string
pm_url lookup belonging to the partial url  1/0 (active/inactive)


To sort the results apply the following parameters:
sort: field that needs to be sorted
ordersorting order (asc - ascending, desc -  descending)

Response parameters
Parameter Description
result Contains the answer
total Number of keywords which the domain ranks for in top of search results
hits
Contains the answer
domain Domain which ranks for the keyword
subdomain Subdomain which ranks for the keyword
keyword Keyword which the domain ranks for
keyword_length Number of words divided by space in a keyword
url URL of a page which appears in SERP for the keyword
position Domain's position for a keyword
types A list of special elements shown in SERP (for example, video, carousel or map)
found_results

The number of results found for the keyword

cost Cost per click, $
concurrency Keyword competition in PPC (0-100%)
region_queries_count Search volume in selected search engine database
region_queries_count_wide
Search volume in selected search engine database in broad match
geo_names List of toponyms in the array (if toponyms are present in the keywords)
traff
Approximate traffic by keyword depending on its volume and position
difficulty
The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100%)
dynamic How the position of this keyword has changed
status_msg Response "Ok" or "Error" report on a successful or unsuccessful request
status_code Response code "200" — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines API credits remaining

Part of the API response for which you spend 1 credit:

{
    "domain": "nike.com",
    "subdomain": "www.nike.com",
    "keyword": "nikews",
    "keyword_length": 1,
    "url": "https://www.nike.com/",
    "position": 1,
    "types": [
        "also_asks",
        "snip_search_box",
        "snip_breadcrumbs"
    ],
    "found_results": 1140000,
    "cost": 0.64000000000000001,
    "concurrency": 3,
    "region_queries_count": 20400000,
    "region_queries_count_wide": 0,
    "geo_names": [],
    "traff": 3058470,
    "difficulty": null,
    "dynamic": null,
    "_id": "4197266083-1"
},

2.1.4. List of domain's URLs (domain_urls)

The domain_urls method returns the list of URLs within the analyzed domain and the number of keywords for each URL. The data set is similar to the Top pages report of the Domain Analysis, excluding the information about traffic and number of Facebook shares.

General request parameters and instructions for using Serpstat API

Following parameters can be used for pagination:
page_size: number of results per page (default: 100, max: 1000)
page: page number (set to the 1st page by default)

Response parameters
Parameter Description
result Contains the answer
total Number of found results
hits
Contains the answer
url Domain's URL
keywords Number of keywords which the URL ranks for
status_msg Response "Ok" or "Error" report on a successful or unsuccessful request
status_code Response code "200" — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines API credits remaining

Part of the API response for which you spend 1 credit:

{
    "url": "https://www.nike.com/",
    "keywords": 66466
},

2.1.5. Domain Comparison (domains_intersection)

The domains_intersection method returns common keywords of up to 3 domains. The data set is similar to the Domain vs domain report.

General request parameters and instructions for using Serpstat API

Following parameters can be used for pagination:
page_size: number of results per page (default: 100, max: 1000)
page: page number (set to the 1st page by default)

Response parameters
Parameter Description
result Contains the answer
total Number of common keywords 
hits
Contains the answer
region_queries_count Keyword volume in selected search engine
types A list of special elements shown in SERP (for example, video, carousel or map)
cost Cost per click, $
keyword_length Number of words divided by space in a keyword
concurrency Keyword competition in PPC (0-100%)
geo_names List of toponyms in the array (if toponyms are present in the keywords)
region_queries_count_wide Search volume in broad match
keyword Keyword which the domains ranks for
found_results Number of results found for the keyword
domain 1,2,3 Domain which ranks for the keyword (1,2,3)
subdomain 1,2,3 Subdomain which ranks for the keyword (1,2,3)
url 1,2,3 URL of a page which appears in SERP for the keyword (1,2,3)
position 1,2,3 Positions of the compared domains for a given keyword (1,2,3)
dynamic 1,2,3 How the position of the domain (1,2,3) by this keyword has changed
status_msg Response "Ok" or "Error" report on a successful or unsuccessful request
status_code Response code "200" — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines API credits remaining

Part of the API response for which you spend 1 credit:

 {
    "region_queries_count": 1,
    "types": [
        "video",
        "related_search",
        "also_asks",
        "snip_breadcrumbs"
    ],
    "cost": 0,
    "keyword_length": 6,
    "modified_date": "2020-06-25",
    "concurrency": 0,
    "geo_names": [],
    "traff": 0,
    "region_queries_count_wide": 0,
    "keyword": "shoes youth size 8 on sale",
    "found_results": 688000000,
    "domain3": "puma.com",
    "subdomain3": "us.puma.com",
    "url3": "https://us.puma.com/en/us/kids",
    "position3": 35,
    "dynamic3": -17,
    "domain1": "nike.com",
    "subdomain1": "www.nike.com",
    "url1": "https://www.nike.com/w/boys-sale-shoes-1onraz3yaepzy7ok",
    "position1": 18,
    "dynamic1": null,
    "domain2": "adidas.com",
    "subdomain2": "www.adidas.com",
    "url2": "https://www.adidas.com/us/kids-youth-shoes",
    "position2": 28,
    "dynamic2": -10
},

2.1.6. Common and Unique Keywords (domains_uniq_keywords)

The domains_uniq_keywords method returns unique keywords of two domains that the third domain does not rank for. The data set is similar to the Domain vs domain report.

General request parameters and instructions for using Serpstat API

Following parameters can be used for pagination:
page_size: number of results per page (default: 100, max: 1000)
page: page number (set to the 1st page by default)

You can use the following parameters to filter the results

Parameter Description Possible settings
queries_from min number of monthly searches  0-100,000,000
queries_to max number of monthly searches  0-100,000,000
cost_from min CPC  0-200
cost_to max CPC  0-200
concurrency_from min level of competition  1-100
concurrency_to max level of competition  1-100

Response parameters
Parameter Description
result Contains the answer
total Number of unique keywords of two domains that the third domain does not rank for
hits
Contains the answer
region_queries_count Search volume in selected search engine database
types A list of special elements shown in SERP (for example, video, carousel or map)
cost Cost per click, $
keyword_length Number of words divided by space in a keyword
url URL of a page which appears in SERP for the keyword
concurrency Keyword competition in PPC (0-100%)
geo_names List of toponyms in the array (if toponyms are present in the keywords)
region_queries_count_wide Search volume in broad match
domain Domain 1 which ranks for the keyword
subdomain Subdomain which ranks for the keyword
dynamic How the position of the domain by this keyword has changed
position Position of the domain 1 for a keyword
keyword Keyword which the domain ranks for
found_results The number of results found for the keyword
"domain" Positions of the analyzed domains for a keyword
status_msg Response "OK" or "Error" report on a successful or unsuccessful request
status_code Response code "200" — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines API credits remaining

Part of the API response for which you spend 1 credit:

 {
    "region_queries_count": 10,
    "types": [
        "carousel",
        "sponsored"
    ],
    "cost": 1.28,
    "keyword_length": 8,
    "url": "http://store.nike.com/us/en_us/pw/womens-tops-t-shirts/7ptZobp",
    "concurrency": 100,
    "geo_names": [],
    "region_queries_count_wide": null,
    "domain": "nike.com",
    "subdomain": "store.nike.com",
    "dynamic": null,
    "position": 47,
    "keyword": "womens red and white striped long sleeve t-shirt",
    "found_results": "4370000",
    "_id": "215854703-47",
    "adidas.com": 78,
    "nike.com": 47
},

2.1.7. Competitors in Organic Search (competitors)

The competitors method returns the list of competitors for a domain in top 20 Google search results. The data set is similar to the Competitors report of the domain.

General request parameters and instructions for using Serpstat API

Response parameters
Parameter Description 
result Contains the answer
domain Domain
visible Domain's visibility
keywords The number of keywords of the domain found in the chosen search engine
traff Estimated search traffic based on keyword positions and search volume
visible_dynamic Dynamics of visibility since the last update
keywords_dynamic Dynamics of the number of keywords since the last update
traff_dynamic Dynamics of estimate traffic since the last update
ads_dynamic Dynamics of changes in PPC Ads
new_keywords Number of new keywords since the last monitoring
out_keywords Number of lost keywords lost since the last monitoring
rised_keywords Number of keywords which positions of the domain have improved since the last monitoring
down_keywords Number of keywords which positions of the domain have dropped since the last monitoring
ad_keywords Number of keywords in PPC
ads Number of the PPC ads
intersected Keywords domains have in common
not_intersected Number of missed keywords of the domain that the competing domain ranks for
relevance Relevance - calculates the percentage of similar keywords domains share (0-100%)
status_msg Response "OK" or "Error" report on a successful or unsuccessful request
status_code Response code "200" — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits).
left_lines API credits remaining

Part of the API response for which you spend 1 credit:

{
    "domain": "snipesusa.com",
    "visible": 6.7542200000000001,
    "keywords": 205235,
    "traff": 3678917,
    "visible_dynamic": -1.2196999999999996,
    "keywords_dynamic": -6195,
    "traff_dynamic": -383469,
    "ads_dynamic": 10,
    "new_keywords": 7363,
    "out_keywords": 13558,
    "rised_keywords": 5671,
    "down_keywords": 9733,
    "ad_keywords": 40,
    "ads": 38,
    "visible_mysql": 0,
    "intersected": 140871,
    "not_intersected": 64364,
    "relevance": 68.640000000000001,
    "new_relevance": 5.1799999999999997,
    "our_relevance": 5.2999999999999998
},

2.1.8. Advertising report with specified name of domain (ad_keywords)

The ad_keywords method returns paid keywords and ads copies that pop up for the queried domain in paid search results. The data set is similar to the Domain analysis  PPC research  Keywords report. 

General request parameters and instructions for using Serpstat API

Following parameters can be used for pagination:
page_size: number of results per page (default: 100, max: 1000)
page: page number (set to the 1st page by default)

You can use the following parameters to filter the results:

Parameter Description Possible settings
position_from min position for a keyword  1-100
position_to max position for a keyword  1-100
queries_from min number of monthly searches  0-100,000,000
queries_to max number of monthly searches  0-100,000,000
cost_from min CPC  0-200
cost_to max CPC  0-200
concurrency_from min level of competition  1-100
concurrency_to max level of competition  1-100
right_spelling filtering by misspelled keywords 

not_contains - contains misspelled keywords;

contains - does not contain misspelled keywords


To sort the results apply following parameters:
sort: field that needs to be sorted
order: sorting order (asc — ascending, desc — descending)

Response parameters
Parameter Description
result Contains the answer
total Number of paid keywords of the domain
hits Contains the answer
keyword Keyword which domain's ad is displayed in SERP
keyword_length Number of words divided by space in a keyword
domain Domain
subdomain Subdomain of the domain
url URL where the ad leads
title Ad Title
text Ad text
position Ad position
type Ad placement type in relation to SERP (1 - above; 2 - under; 3 - side)
cost Cost per click, $
concurrency Keyword competition in PPC (0-100%)
found_results The number of results found for the keyword
region_queries_count Search volume in selected search engine database
region_queries_count_last Search volume (last month)
types A list of special elements shown in SERP (for example, video, carousel or map)
geo_names List of toponyms in the array (if toponyms are present in the keywords)
difficulty The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100%)
status_msg Response "OK" or "Error" report on a successful or unsuccessful request
status_code Response code "200" — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines API credits remaining

Part of the API response for which you spend 1 credit:

 {
    "keyword": "nike koshes",
    "keyword_length": 2,
    "domain": "nike.com",
    "subdomain": "www.nike.com",
    "url": "https://www.nike.com/gb/w/sale-3yaep",
    "title": "Nike.com Official Clearance - Stock Up On Clearance Shoes",
    "text": "Nike Clearance Gear Gives You A Chance To Add Top-Flight Products To Your Collection. Find The Items That Match Your Style And Complete Your Look. Shop Clearance Now. Medical Workers Save 10% Shop With Nike Experts. Free Shipping for Members.",
    "position": 1,
    "type": "1",
    "cost": 0.29999999999999999,
    "concurrency": 100,
    "found_results": 64,
    "region_queries_count": 1000000,
    "region_queries_count_last": 10,
    "types": [
        "ads_top"
    ],
    "geo_names": [],
    "difficulty": null,
    "_id": "4754893372_1"
},

2.1.9. Domain Top Pages (get_top_urls)

The get_top_urls method returns website pages in hierarchical order. Also, it shows the number of keywords from Google top-100 or Yandex top-50 for each URL, approximate traffic of the page and Facebook shares. The data set is similar to the Top pages report of the Domain Analysis.

General request parameters and instructions for using Serpstat API

Following parameters can be used for pagination:
page_size: number of results per page (default: 100, max: 1000)
page: page number (set to the 1st page by default)

Following parameters can be used for sorting:
sort: field that needs to be sorted
order: sorting order (asc - ascending, desc -  descending)

Response parameters
Parameter Description
result Contains the answer
total The total number of the website pages
hits
Contains the answer
url URL of the domain
organic_keywords The number of keywords the URL ranks for in Google top-100 or Yandex top-50 results
facebook_shares The number of Facebook shares of the researched domain's page
potencial_traff The approximate traffic of the page by keywords depending on its volume and position
status_msg Response "Ok" or "Error" report on a successful or unsuccessful request
status_code Response code "200" — successful request. Errors occur when credits are exceeded (number of simultaneous requests or account credits)
left_lines API credits remaining

Part of the API response for which you spend 1 credit:

{
    "url": "https://www.nike.com/",
    "organic_keywords": 65134,
    "facebook_shares": 701305,
    "potencial_traff": 39481276
},

2.1.10. Domain Summary V4 (SerpstatDomainProcedure.getDomainsInfo)

The SerpstatDomainProcedure.getDomainsInfo method provides with the summary information for an array of domains. The data set is similar to the Batch analysis report excluding the infomation about link profile.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter Description Optional Value options
id A request id: the response contains the same id. Enter any number (number) or text (string) value no 1, test
method API method name no SerpstatDomainProcedure.getDomainsInfo
params The object with parameters {...}, it lists all the following parameters and arrays [...] no
domains Array of domains no ["nike.com", "adidas.com" ]
se ID of the search base to be searched no g_us, y_213

Response parameters
Parameter Description
id Response id corresponds the request id
result Contains the answer 
data Array with data
domain Analyzed domain
visible Site visibility
keywords Number of keywords found in the chosen search engine
traff
Estimated search traffic based on keyword positions and search volume
visible_dynamic Change in visibility since the last monitoring
keywords_dynamic Change in the number of keywords since the last monitoring
traff_dynamic Traffic change since the last monitoring
ads_dynamic Dynamics of changes in PPC Ads
new_keywords Number of new keywords for the domain since the last monitoring
out_keywords Number of keywords lost by a domain since the last monitoring
rised_keywords Number of domain keywords for which positions have improved since the last monitoring
down_keywords Number of domain keywords for which positions have dropped since the last monitoring
ad_keywords Number of keywords in PPC
ads Number of PPC Ads
prev_date Previous verification date
summary_info Object with data
page Page number
left_lines API credits remaining

Credits: for each domain for which information is received, 5 credits is chargedPart of the API response, for which 5 credits is charged:

{
    "domain": "adidas.com",
    "visible": 38.226520000000001,
    "keywords": 1360672,
    "traff": 54388418,
    "visible_dynamic": 0.47296000000000049,
    "keywords_dynamic": -5503,
    "traff_dynamic": -370839,
    "ads_dynamic": 66,
    "new_keywords": 21333,
    "out_keywords": 26836,
    "rised_keywords": 33457,
    "down_keywords": 31140,
    "ad_keywords": 203,
    "ads": 199,
    "prev_date": "2021-05-13"
}

If you'd like to get advice on Serpstat's features, order youfree 30-minute demo.Still have questions? Contact the tech support chat.

2.1.11. Domain history V4 (SerpstatDomainProcedure.getDomainsHistory)

The SerpstatDomainProcedure.getDomainsHistory method provides you with the historical data on a domain’s number of keywords and visibility. 

General request parameters and instructions for using Serpstat API

Request parameters
Parameter Description Optional Default value Value options
id A request id: the response contains the same id. Enter any number (number) or text (string) value no 1, test
method API method name no SerpstatDomainProcedure.getDomainsHistory
params The object with parameters {...}, it lists all the following parameters and arrays [...] no
domain Domain name no nike.com
se ID of the search base to be searched no g_us
sort Order of sorting the results in the format: {{{field}}: {{order}}}

field — field to sort by:
* keywords
* traff
* visible
* visible_static
* new_keywords
* out_keywords
* rised_keywords
* down_keywords
* ad_keywords
* ads
* date

order — sort direction (asc — ascending, desc — descending)
yes {"ads":"desc"}
page Page number in response yes 1 5
size Number of results per page in response yes 100 100-1000

Response parameters
Parameter Description
id Response id corresponds the request id
result Contains the answer
data Array with data
domain Analyzed domain
keywords Number of keywords found in the chosen search engine
traff Estimated search traffic based on keyword positions and search volume
visible Site visibility
visible_static Change in visibility since the last monitoring
new_keywords Number of new keywords since the last N-days monitoring
out_keywords Number of lost keywords since the last N-days monitoring
rised_keywords Number of keywords which positions of the domain have improved over the last N-days
down_keywords Number of keywords which positions of the domain have dropped over the last N-days
ad_keywords Number of keywords in PPC
ads Number of ads in PPC
date Verification date of a particular array element
summary_info Object with data
page Page number
total Number of results for request
left_lines API credits remaining

Credits: the number of charged credits corresponds to the number of results obtained. Part of the API response, for which 1 credit is charged:

{
    "domain": "nike.com",
    "keywords": 2603734,
    "traff": 240307722,
    "visible": 212.81692,
    "visible_static": 212.81692,
    "new_keywords": 32499,
    "out_keywords": 37326,
    "rised_keywords": 40518,
    "down_keywords": 43717,
    "ad_keywords": 1197,
    "ads": 929,
    "date": "2021-04-29"
},

2.1.12. Top search engine keywords by V4 domain (SerpstatDomainProcedure.getDomainKeywords)

The SerpstatDomainProcedure.getDomainKeywords method keywords which the analyzed domain ranks for in Google top-100 or Yandex top-50 search results. The data set is similar to the Domain analysis — SEO research  Keywords report. You can get up to 60 000 results in this report.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Optional

Default value

Value options

id A request id: the response contains the same id. Enter any number (number) or text (string) value no 1, test

method

API method name

no

SerpstatDomainProcedure.
getDomainKeywords

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

no

domain

Domain name

no

 

nike.com

se

ID of the search base to be searched

no

 

g_us

url

Link to refine your search

yes

null

https://www.nike.com/soccer

keywords

Array of keywords to search for

yes

[]

["shop", "nike"]

minusKeywords

Negative keyword array

yes

[]

["nikes", "nke"]

filters

Filter conditions

yes

{"concurrency_from": "0",
"concurrency_to": "1"}

sort

Order of sorting the results in the format: {{{field}}: {{order}}}

field — field to sort by:
* region_queries_count
* types
* cost
* keyword_length
* concurrency
* geo_names
* traff
* region_queries_count_wide
* dynamic
* position
* found_results

order — sort direction (asc — ascending, desc — descending)

yes

{"position": "asc", "region_queries_count":"desc"}

{"cost": "asc"}

page

Page number in response

yes

1

"page": "5"

size

Number of results per page in response

yes

100

"size": "10"

min: 1, max: 1000

To filter the results use the following parameters:

Parameter Description Possible value
position_from min position for a keyword  1-100
position_to max position for a keyword  1-100
queries_from min number of monthly searches  0-100,000,000
queries_to max number of monthly searches  0-100,000,000
cost_from min CPC  0-200
cost_to max CPC  0-200
concurrency_from min competition value  1-100
concurrency_to max competition value  1-100

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data

Array with data

domain

Analyzed domain

subdomain

Subdomain appeared in search results for a given keyword

keyword

Keyword which the domain ranks for

keyword_length

Number of words divided by space in a keyword

url URL appeared in the search result for the query
position Domain's position for a keyword
types List of special elements shown in SERP (for example, video, carousel or map)
found_results Number of results found for the keyword
cost Cost per click, $

concurrency

Keyword competition in the PPC (0-100%)

region_queries_count Search volume in a selected region
region_queries_count_wide Search volume in selected search engine database in broad match

geo_names

List of toponyms in the array (if toponyms are present in the keywords)

traff

Approximate traffic by keyword depending on its volume and position

difficulty

The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100%)

right_spelling

Recommended correction of a misspelled keyword

dynamic Position change for the keyword
summary_info Object with data
page Page number
total Number of keywords which the domain ranks for in top of search results

left_lines

API credits remaining

Part of the API response, for which 1 credit is charged:

{
    "domain": "nike.com",
    "subdomain": "www.nike.com",
    "keyword": "nike socer",
    "keyword_length": 2,
    "url": "https://www.nike.com/soccer",
    "position": 1,
    "types": [
        "shopping_rhs",
        "ads_top",
        "snip_breadcrumbs"
    ],
    "found_results": 90,
    "cost": 0.48,
    "concurrency": 100,
    "region_queries_count": 9900,
    "region_queries_count_wide": 0,
    "geo_names": [],
    "traff": 1484,
    "difficulty": 20.35,
    "right_spelling": "nike soccer",
    "dynamic": 0
},

2.1.13. List of domain URLs V4 (SerpstatDomainProcedure.getDomainUrls)

The SerpstatDomainProcedure.getDomainUrls method returns the list of URLs within the analyzed domain and the number of keywords for each URL. The data set is similar to the Top pages report of the Domain Analysis, excluding the information about traffic and number of Facebook shares.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Optional

Default value

Value options

id A request id: the response contains the same id. Enter any number (number) or text (string) value no 1, test

method

API method name

no

SerpstatDomainProcedure.
getDomainUrls

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

no

domain

Domain name

no

-

nike.com

se

ID of the search base to be searched

no

-

g_us

sort

Order of sorting the results in the format: {{{field}}: {{order}}}

field — field to sort by:
* keywords

order — sort direction (asc — ascending, desc — descending)

yes

{"keywords":"desc"}

{"keywords":"asc"}

page

Page number in response

yes

1

"page": "5"

size

Number of results per page in response

yes

100

"size": "3"

min: 1, max: 1000

Response parameters
Parameter Description
id Response id corresponds the request id
result Contains the answer
data Array with data
url Domain's URL
keywords Number of keywords which the URL ranks for
summary_info Object with data
page Page number
total Number of found URLs
left_lines API credits remaining

Part of the API response, for which 1 credit is charged:

{
    "url": "https://www.nike.com/",
    "keywords": 64785
},

2.1.14. Domains intersection V4 (SerpstatDomainProcedure.getDomainsIntersection)

The SerpstatDomainProcedure.getDomainsIntersection method returns common keywords of up to 3 domains. The data set is similar to the Domain vs domain report.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Optional

Default value

Value options

id A request id: the response contains the same id. Enter any number (number) or text (string) value no 1, test

method

API method name

no

SerpstatDomainProcedure.getDomainsIntersection

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

no

domains

Array of domains (min2, max3)

no

-

["starbucks.com", "apple.com"]

se

ID of the search base to be searched

no

-

g_us

page

Page number in response

yes

1

"page": "5"

size

Number of results per page in response

yes

100

"size": "10"

min: 1, max: 1000

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data Array with data

region_queries_count

Search volume in selected region

types

List of special elements shown in SERP (for example, video, carousel or map)

cost

Cost per click, $

keyword_length

Number of words divided by space in a keyword

concurrency

Keyword competition in the PPC (0-100%)

geo_names

List of toponyms in the array (if toponyms are present in the keywords)

traff

Estimated search traffic based on keyword positions and search volume

region_queries_count_wide

Search volume (broad match)

keyword

Keyword ranking the given website

found_results

Number of results found for the keyword
domain 1,2,3 Domain which ranks for the keyword (1,2,3)
subdomain 1,2,3 Subdomain which ranks for the keyword (1,2,3)
url 1,2,3 URL of a page which appears in SERP for the keyword (1,2,3)
position 1,2,3 Positions of the compared domains for a given keyword (1,2,3)
dynamic 1,2,3 How the position of the domain (1,2,3) by this keyword has changed
summary_info Object with data
page Номер страницы
total Number of found common keywords
left_lines API credits remaining

Credits: the number of charged credits corresponds to the number of results obtained upon request.

Part of the API response, for which 1 credit is charged:

{
    "region_queries_count": 1,
    "types": [
        "video",
        "related_search",
        "also_asks",
        "snip_breadcrumbs"
        ],
    "cost": 0,
    "keyword_length": 6,
    "concurrency": 0,
    "geo_names": [],
    "traff": 0,
    "region_queries_count_wide": 0,
    "keyword": "shoes youth size 8 on sale",
    "found_results": 688000000,
    "domain3": "puma.com",
    "subdomain3": "us.puma.com",
    "url3": "https://us.puma.com/en/us/kids",
    "position3": 35,
    "dynamic3": -17,
    "domain1": "nike.com",
    "subdomain1": "www.nike.com",
    "url1": "https://www.nike.com/w/boys-sale-shoes-1onraz3yaepzy7ok",
    "position1": 18,
    "dynamic1": null,
    "domain2": "adidas.com",
    "subdomain2": "www.adidas.com",
    "url2": "https://www.adidas.com/us/kids-youth-shoes",
    "position2": 28,
    "dynamic2": -10
},

2.1.15. General and unique keywords V4 (SerpstatDomainProcedure.getDomainsUniqKeywords)

The SerpstatDomainProcedure.getDomainsUniqKeyword method returns unique keywords of two domains that the third domain does not rank for. The data set is similar to the Domain vs domain report.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Optional

Default value

Value Options

id A request id: the response contains the same id. Enter any number (number) or text (string) value no 1, test

method

API method name

no

SerpstatDomainProcedure.getDomainsUniqKeyword

params The object with parameters {...}, it lists all the following parameters and arrays [...] no

domains

Array of domains (min 1, max 2)

no

["nike.com", "adidas.com"]

minusDomain

Domain with keywords which must not intersect domains parameters

no

puma.com

se

ID of the search base to be searched

no

g_us

filters

Filter conditions

no

 

{"queries_from": 30}
{"queries_to": 40}

page

Page number in response

yes

1 "page": "5"
size Number of results per page in response yes 100

"size": "10"

min: 1, max: 1000

To filter the results, use the following parameters:

Parameter Description Possible values 
queries_from min volume of monthly searches  0-100000000
queries_to max volume of monthly searches  0-100000000
cost_from min CPC  0-200
cost_to max CPC  0-200
concurrency_from min value of competitor’s keyword in the PPC  0-100
concurrency_to max value of competitor’s keyword in the PPC  0-100

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data Array with data
date Search result issue date

region_queries_count

Search volume in selected region

types List of special elements shown in SERP (for example, video, carousel or map)
cost Cost per click, $

keyword_length

Number of words divided by space in a keyword

url

URLs displayed in SERP by the given keyword

concurrency Keyword competition in PPC (0-100%)
difficulty The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100%)
geo_names List of toponyms in the array (if toponyms are present in the keywords)
right_spelling Recommended correction of a misspelled keyword

traff

Approximate traffic by keyword depending on its volume and position

region_queries_count_wide

Search volume (broad match)

domain

Analyzed domain

subdomain

Subdomain displayed in search result by the given keyword

dynamic

Position change for the keyword

position

Domain's position for a keyword

keyword

Keyword which the domain ranks for

found_results

Number of results found for keyword
domain.com Positions of the analyzed domains for a keyword
summary_info Object with data
page Page number
total Number of found keywords
left_lines API credits remaining

Credits: the number of charged credits corresponds to the number of results obtained upon request. Part of the API response, for which 1 credit is charged:

{
    "date": "2020-05-01",
    "region_queries_count": 3600,
    "types": [
        "kn_graph_carousel_list",
        "pic",
        "related_search",
        "snip_breadcrumbs"
        ],
    "cost": 0.53000000000000003,
    "keyword_length": 1,
    "url": "https://www.nike.com/w/womens-hoodies-pullovers-5e1x6z6rive",
    "concurrency": 100,
    "difficulty": 19.431026858090227,
    "geo_names": [],
    "right_spelling": "long hoodie",
    "traff": 0,
    "region_queries_count_wide": 0,
    "domain": "nike.com",
    "subdomain": "www.nike.com",
    "dynamic": null,
    "position": 55,
    "keyword": "longhoodie",
    "found_results": 628000000,
    "adidas.com": 11,
    "nike.com": 55
},

2.1.16. Domain competitors in V4 search result (SerpstatDomainProcedure.getCompetitors)

The SerpstatDomainProcedure.getCompetitors method brings in the list of domain competitors in top 20 Google search results. The data set is similar to the Competitors report of the domain.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Optional

Default value

Value options

id A request id: the response contains the same id. Enter any number (number) or text (string) value no 1, test
method API method name no SerpstatDomainProcedure.getCompetitors

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

no

domain

Domain name

no

-

nike.com

se

ID of the search base to be searched

no

-

g_us

sort

Order of sorting the results in the format: {{{field}}: {{order}}}

field — field to sort by:
visible
keywords
traff
visible_dynamic
keywords_dynamic
traff_dynamic
ads_dynamic
new_keywords
out_keywords
rised_keywords
down_keywords
ad_keywords
ads
intersected
relevance
new_relevance
our_relevance

order — sort direction (asc — ascending, desc — descending)

yes

{"relevance":"desc"}

{"ads":"desc"}

page

Page number in response

yes

1

"page": "1"

size

Number of results per page in response

yes

100

"size": "50"

min: 50, max: 1000

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data

Array with data

visible

Site visibility

domain

Domain

keywords

Number of keywords found in the chosen search engine

traff

Approximate traffic by keyword depending on its volume and position

visible_dynamic

Dynamics of visibility since the last update

keywords_dynamic

Dynamics of the number of keywords since the last update

traff_dynamic Dynamics of estimate traffic since the last update
ads_dynamic Dynamics of changes in PPC Ads
new_keywords Number of new keywords for the domain since the last monitoring
out_keywords Number of keywords lost by a domain since the last monitoring
rised_keywords Number of domain keywords for which positions have improved since the last monitoring
down_keywords Number of domain keywords for which positions have dropped since the last monitoring
ad_keywords Number of keywords in the PPC
ads Number of ads
intersected Keywords domains have in common
not_intersected Number of missed keywords of the domain that the competing domain ranks for
relevance Relevance - calculates the percentage of similar keywords domains share (0-100%)
summary_info Object with data
page Page number
left_lines API credits remaining

Credits: the number of charged credits corresponds to the number of results obtained upon request. Part of the API response, for which 1 credit is charged:

 {
    "domain": "thesolesupplier.co.uk",
    "visible": 1.57363,
    "keywords": 273939,
    "traff": 987621,
    "visible_dynamic": 0.21043000000000012,
    "keywords_dynamic": 2761,
    "traff_dynamic": 82601,
    "ads_dynamic": 0,
    "new_keywords": 6341,
    "out_keywords": 3580,
    "rised_keywords": 11264,
    "down_keywords": 6878,
    "ad_keywords": 0,
    "ads": 0,
    "intersected": 192486,
    "not_intersected": 81453,
    "relevance": 70.27,
    "new_relevance": 7.04,
    "our_relevance": 7.26
},

2.1.17. Advertising report with specified name of domain V4 (SerpstatDomainProcedure.getAdKeywords)

The SerpstatDomainProcedure.getAdKeywords method returns paid keywords and ads copies that pop up for the queried domain in paid search results. The data set is similar to the Domain analysis  PPC research  Keywords report. 

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Value

Optional

Default value

Value Options

id

A request id: the response contains the same id. Enter any number (number) or text (string) value

no

1, test

method

API method name

no

SerpstatDomainProcedure.getAdKeywords

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

no

domain

Domain name

no

nike.com

se

ID of the search base to be searched

no

g_us

url

Link to refine your search

yes

 

https://www.nike.com/nike-by-you

keywords

Array of key phrases to search for

yes

[]

["nike", "id"]

minusKeywords

Negative keyword array

yes

[]

["nikeid"]

filters

Filter conditions

yes

 

{ "concurrency_from": "0", "concurrency_to": "1" }

sort

Order of sorting the results in the format:
{{{field}}: {{order}}}

field - field to sort by:
keyword_length
position
type
cost
concurrency
found_results
region_queries_count
region_queries_count_wide
types
difficulty
geo_names

order - sort direction (asc - ascending, desc - descending)

yes

{"position": "asc", "region_queries_count":"desc"}

{"cost": "asc"}

page

Page number in response

yes

1

"page": "1"

size

Number of results per page in response

yes

100

"size": "50"

min: 1, max: 1000

To filter the results, use the following parameters:

Parameter Description Possible values
position_from min position for a keyword  1-100
position_to max position for a keyword  1-100
queries_from min number of monthly searches  0-100000000
queries_to max number of monthly searches  0-100000000
cost_from min CPC  0-200
cost_to max CPC  0-200
concurrency_from min level of competition  0-100
concurrency_to max level of competition  0-100

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data

Array with data

keyword Keyword the analyzed domain bids on in Google Ads
keyword_length Number of words divided by space in a keyword
domain Analyzed domain
subdomain Subdomain of the analyzed domain
url URL where the ad leads
title Ad Title
text Ad text
position Ad position
type Ad placement type in relation to SERP (1 - above; 2 - under; 3 - side)
cost Cost per click, $
concurrency Competition in Google Ads (0-100%)
found_results Number of results found for the keyword

region_queries_count

Search volume in selected search engine database

region_queries_count_wide

Search volume (broad match)

types

List of special elements shown in SERP (for example, video, carousel or map)

geo_names

List of toponyms in the array (if toponyms are present in the keywords)

difficulty

The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 0 to 100%)

summary_info

Object with data

page Page number

total

Number of found results

left_lines

API credits remaining

Credits: the number of charged credits corresponds to the number of results obtained upon request. Part of the API response, for which 1 credit is charged:

{
    "keyword": "customize id nike",
    "keyword_length": 3,
    "domain": "nike.com",
    "subdomain": "www.nike.com",
    "url": "https://www.nike.com/nike-by-you",
    "title": "Custom Nike Shoes - Nike By You Shoe Customizer",
    "text": "Pick From Your Favorite Nike Styles & Color Them To Reflect Your Unique Personality.",
    "position": 1,
    "type": "1",
    "cost": 2.54,
    "concurrency": 59,
    "found_results": 24800000,
    "region_queries_count": 320,
    "region_queries_count_wide": 0,
    "types": [
        "ads_top",
        "also_asks"
        ],
    "geo_names": [],
    "difficulty": 60.572786294554405
},

2.1.18. Domain top URLs V4 (SerpstatDomainProcedure.getTopUrls)

The SerpstatDomainProcedure.getTopUrls method returns website pages in hierarchical order. Also, it shows the number of keywords from Google top-100 or Yandex top-50 for each URL, approximate traffic of the page and Facebook shares. The data set is similar to the Top pages report of the Domain Analysis.

General request parameters and instructions for using Serpstat API

The given method can work for prolonged periods of time owing to particularity of data collection. The results are sorted by the number of keywords in descending order by default. 

Request parameters

Parameter

Description

Optional

Default value

Value options

id

A request id: the response contains the same id. Enter any number (number) or text (string) value

no

1, test

method

API method name

no

SerpstatDomainProcedure.getTopUrls

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

no

domain

Domain name

no

 

nike.com

se

ID of the search base to be searched

no

 

g_us

sort

Sort order of the results in the format:
{{{field}}: {{order}}}

field - field to sort by:
organic_keywords
facebook_shares
potencial_traff

order - sort direction (asc - ascending, desc - descending)

yes

{"organic_keywords":"desc"}

{"organic_keywords":"asc"}

filters

Filter conditions

yes

{"url_prefix": "https://www.nike.com/nike-by-you"}
{"url_contain": "nike-by-you"}
{"url_not_contain": "nike-by-you"}

page

Page number in response yes 1 "page": "1"

size

Number of results per page in response yes 100 "size": "50"

min: 50, max: 1000

 

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data Array with data

url

URL of the domain

organic_keywords

The number of keywords the URL ranks for in Google top-100 or Yandex top-50 results

facebook_shares

The number of Facebook shares of the researched domain's page

potential_traff

The approximate traffic of the page by keywords depending on its volume and position

summary_info Object with data

page

Page number

total

Total number of found results

left_lines

API credits remaining

Credits: the number of charged credits corresponds to the number of results obtained upon request. Part of the API response, for which 1 credit is charged:

{
    "url": "https://www.nike.com/id/w/nike-by-you-running-shoes-37v7jz6ealhzy7ok",
    "organic_keywords": 39,
    "facebook_shares": 0,
    "potencial_traff": 540
},

2.1.19. Domain competitors in V4 PPC (SerpstatDomainProcedure.getAdsCompetitors)

The SerpstatDomainProcedure.getAdsCompetitors method brings in the list of domain competitors in PPC. The data set is similar to the Competitors report in PPC research of the domain.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Optional

Default value

Value options

id

A request id: the response contains the same id. Enter any number (number) or text (string) value

no

1, test

method

API method name

no

SerpstatDomainProcedure.getAdsCompetitors

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

no

domain

Domain name

no

 

nike.com

se

ID of the search base to be searched

no

 

g_us

sort

Sort order of the results in the format:
{{{field}}: {{order}}}

field - field to sort by:
ads
keywords
intersected
missing_keywords

order - sort direction (asc - ascending, desc - descending)

yes

{"relevance":"desc"}

{"ads":"desc"}

page

Page number in response

yes

1

"page": "1"

size

Number of results per page in response

yes

100

"size": "50"

min: 50, max: 1000

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data

Array with data

domain

Domain

keywords

Number of paid keywords

ads Number of ads.
intersected Number of keywords bringing users to an analyzed domain and its competitor via paid results
missing_keywords Number of keywords that competitor use in PPC and analyzed domain does not use.
summary_info Object with data
page Page number
left_lines API credits remaining

Credits: the number of charged credits corresponds to the number of results obtained upon request. Part of the API response, for which 1 credit is charged:

{
    "domain": "finishline.com",
    "keywords": 495,
    "ads": 453,
    "intersected": 57,
    "missing_keywords": 438
},

2.1.20. Statistics on Credits V4 (SerpstatLimitsProcedure.getStats)

The SerpstatLimitsProcedure.getStats method is for checking the number of available and used API and Serpstat extension credits.

Credits for this method are not used.

Request parameters

Parameter

Description

Value options

id

A request id: the response contains the same id. Enter any number (number) or text (string) value

1, test

method

API method name

SerpstatLimitsProcedure.getStats

Response parameters
Parameter Description Value

id

Response id corresponds the request id

result

Contains the answer

data

Array with data

max_lines

Max number of API credits available per month int

used_lines

Number of API credits used int

left_lines

Number of available API credits int
user_info API User Information json object

user_id

User ID in Serpstat int

plugin_limits

Serpstat extension API credits information json object

hasApiPlugin

Availability of access to the Serpstat extension API:
true - have access
false - no access
bool

delayBetweenRequests

Number of Serpstat extension API requests per second int
total The number of credits per day for the Serpstat extension API int
used The number of used credits for the current day via the extension API int
left The number of remaining credits for the current day via the extension API int
summary_info Object with data
left_lines Number of remaining API lines

Share this article with your friends

Sign In Free Sign Up

You’ve reached your query limit.

Or email
Forgot password?
Or email
Optional
Back To Login

Don’t worry! Just fill in your email and we’ll send over your password.

Are you sure?

Awesome!

To complete your registration you need to enter your phone number

Back

We sent confirmation code to your phone number

Your phone Resend code Queries left

Something went wrong.

Contact our support team
Or confirm the registration using the Telegram bot Follow this link
Please pick the project to work on

Introducing Serpstat

Find out about the main features of the service in a convenient way for you!

Please send a request, and our specialist will offer you education options: a personal demonstration, a trial period, or materials for self-study and increasing expertise — everything for a comfortable start to work with Serpstat.

Name

Email

Phone

We are glad of your comment
I agree to Serpstat`s Privacy Policy.
Upgrade your plan

Upgrade your plan

Export is not available for your account. Please upgrade to Lite or higher to get access to the tool. Learn more

Sign Up Free

Thank you, we have saved your new mailing settings.

Invite
View Editing

E-mail
Message
Optional
E-mail
Message
Optional

You have run out of limits

You have reached the limit for the number of created projects. You cannot create new projects unless you increase the limits or delete existing projects.

I want more limits
Open support chat