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

Keyword Reports

2.2.1. Phrase Match Keywords (keywords)

The keywords method shows organic keywords associated with the researched keyword that domains are ranking for in Google`s top-100 results and for every found keyword you’ll see its volume, CPC and level of competition. The data set is similar to the Keyword research — SEO research  Keywords selection 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
minus_keywords   filtering by negative keywords (separated by commas) string
right_spelling filtering by misspelled keywords 

not_contains - contains misspelled keywords;

contains - does not contain misspelled keywords

To sort the results apply the 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 found results
hits Contains the answer
keyword Specified keyword
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
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)
social_domains Social domains (Facebook, Youtube,etc.) which rank for a keyword in top-10
right_spelling Proposed correction for a keyword with a spelling error
keyword_length Number of words divided by space in a keyword
lang Language
keyword_length Number of words divided by space in a keyword
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": "iphone 11",
    "keyword_id": "76373283",
    "cost": 0.7,
    "concurrency": 100,
    "found_results": 96,
    "region_queries_count": 2240000,
    "types": [
        "also_asks",
        "ads_top"
        ],
    "geo_names": [],
    "social_domains": [
        "wikipedia",
        "pinterest",
        "reddit",
        "amazon"
        ],
    "right_spelling": null,
    "lang": null,
    "keyword_length": 2,
    "difficulty": 30.39
},

2.2.2. Keyword overview (keyword_info)

The keyword_info method provides you with the keyword overview showing its volume, CPC, level of competition, etc. The data set is similar to the Overview report in Keyword research.

General request parameters and instructions for using Serpstat API

Response parameters
Parameter Description 
result Contains the answer
keyword Specified keyword
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
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)
social_domains Social domains (Facebook, Youtube,etc.) which rank for a keyword in top-10
right_spelling Proposed correction for a keyword with a spelling error
lang Language
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

We charge 1 API credit per query. Part of the API response for which you spend 1 credit:

{
    "result": {
        "keyword": "iphone",
        "keyword_id": "10300893",
        "cost": 1.8822413793103445,
        "concurrency": 100,
        "found_results": 79,
        "region_queries_count": 1220000,
        "types": [
            "shopping_top",
            "kn_graph_carousel_list",
            "also_asks"
        ],
        "geo_names": [],
        "social_domains": [
            "wikipedia",
            "amazon",
            "reddit"
        ],
        "right_spelling": null,
        "lang": null,
        "difficulty": 89.5890633703002,
        "suggestions_count": 2652668,
        "keywords_count": 8323766
    },

2.2.3. Keyword search suggestions (suggestions)

The suggestions method shows search suggestions for the keyword you requested (they are found by the full-text search). Use question=1 parameter to get questions only. The data set is similar to the Keyword research — SEO research  Search suggestions 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 found results
hits Contains the answer
keyword Search suggestion
geo_names List of toponyms in the array (if toponyms are present in the keywords)
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 1 limit is charged:

{
    "keyword": "iphone x fre case release",
    "geo_names": [],
    "_id": "db44a9cbdacc966c4d6dc85f5f47f056"
},

2.2.4. Related Keywords (related_keywords)

The related_keywords method shows all search queries that are semantically related to the searched keyword. The data set is similar to the Keyword research — SEO research  Related 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: number (set to the 1st page by default).

To sort the results apply the 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 found related keywords
hits Contains the answer
keyword Related keyword
region_queries_count Search volume in selected search engine database
cost Cost per click, $
concurrency Keyword competition in PPC (0-100%)
geo_names List of in the array (if are present in the keywords)
types A list of special elements shown in (for example, video, carousel or map)
right_spelling Proposed correction for a keyword with a spelling error
weight The degree of keywords similarity
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": "when will next iphone come out",
    "region_queries_count": 2900,
    "cost": 6.75,
    "concurrency": 2,
    "geo_names": [],
    "types": [
        "also_asks",
        "snip_breadcrumbs"
        ],
    "weight": 1,
    "difficulty": 67
}

2.2.5. Top for a keyword (keyword_top)

The keyword_top method shows you Google's top-100 or Yandex's top-50 search results for the analyzed keyword. The data set is similar to the Top pages report in Keyword research.

General request parameters and instructions for using Serpstat API

Response parameters
Parameter Description
result Contains the answer
top Contains the result
position Domain's position for a keyword
url Page that ranks for the keyword
domain Domain which ranks for the keyword
subdomain Subdomain which ranks for the keyword
types A list of special elements shown in SERP (for example, video, carousel or map)
ads Number of found Ads (if there are ads in the results)
results Number of results
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:

{
    "position": 1,
    "url": "https://www.apple.com/iphone/",
    "domain": "apple.com",
    "subdomain": "www.apple.com",
    "types": [
        "shopping_top",
        "kn_graph_carousel_list",
        "also_asks",
        "snip_breadcrumbs"
        ]
},

2.2.6. Competitors (competitors)

The competitors method lists the domains that rank for the given keyword in Google top-20 results. The data set is similar to the Keyword research — SEO research  Competitors report.

General request parameters and instructions for using Serpstat API

Response parameters
Parameter Description 
result Contains the answer
"domain.com" Domain-competitor that contains the answer
domain Domain
visible Domain's 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 upgrade
keywords_dynamic Change in the number of keywords since the last update
traff_dynamic Traffic change since the last update
ads_dynamic Change in the number of keywords used in PPC Ads
new_keywords The number of acquired keywords for the domain since the last update
out_keywords Number of keywords lost by a domain since the last update
rised_keywords Number of domain's keywords which positions have improved since the last update
down_keywords Number of domain's keywords which positions have dropped since the last update
ad_keywords Number of keywords used by domain in PPC Ads
ads Number of Ads
intersected Number of domain keywords which contain a target keyword
relevance Domain's relevance to the 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:

{
"apple.com": {
    "domain": "apple.com",
    "visible": 3417.2564,
    "keywords": 46650466,
    "traff": 1998603882,
    "visible_dynamic": 6.359480000000076,
    "keywords_dynamic": -751,
    "traff_dynamic": 7691041,
    "ads_dynamic": -390,
    "new_keywords": 153290,
    "out_keywords": 154041,
    "rised_keywords": 453556,
    "down_keywords": 465903,
    "ad_keywords": 5422,
    "ads": 4018,
    "visible_mysql": 0,
    "intersected": 829994,
    "relevance": 1.78,
    "our_relevance": 41.19
},

2.2.7. Advertising report (ad_keywords)

The ad_keywords method returns paid keywords and ads copies that pop up for the queried keyword in paid search resultsThe data set is similar to the Keyword research 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


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 search results for the keyword
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 ""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": "iphone see",
    "keyword_id": 50423945,
    "keyword_length": 2,
    "domain": "apple.com",
    "subdomain": "www.apple.com",
    "url": "https://www.apple.com/iphone-se/",
    "url_crc": 818000116,
    "title": "iPhone SE - Apple Official Site",
    "text": "The A13 Bionic chip is built for speed. It’s just what you’ve been waiting for.",
    "crc": -1550457144,
    "position": 1,
    "type": "1",
    "cost": 1.54,
    "concurrency": 100,
    "found_results": 2920000000,
    "region_queries_count": 1500000,
    "region_queries_count_last": 1830000,
    "types": [
        "top_stories",
        "also_asks",
        "kn_graph_carousel_list",
        "shopping_top",
        "ads_top"
        ],
    "geo_names": [],
    "difficulty": 73.432686121561062,
    "modified_date": "2021-07-14",
    "_id": "50423945_1"
},

2.2.8. Most Popular Phrases (top_words)

The top_words method helps you to find popular words for building search suggestions. The data set is similar to the most popular words in the Search suggestions report of Keyword research.

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 search suggestions
hits An array of top words for the search suggestion
keyword Popular word for the search suggestion
count
How many search suggestions appear for the popular word
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": "app",
    "count": 32
},

2.2.9. Keywords for V4 words (SerpstatKeywordProcedure.getKeywords)

The SerpstatKeywordProcedure.getKeywords shows organic keywords associated with the researched keyword that domains are ranking for in Google`s top-100 results and for every found keyword you’ll see its volume, CPC and level of competition. The data set is similar to the Keyword research — SEO research  Keywords selection report.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Type

Optional

Default value

Value Options

id

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

int/string

no

1, test

method

API method name

string

no

SerpstatKeywordProcedure.getKeywords

params

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

array

no

keyword

Keyword to search for

string

no

iphone

se

ID of the search base to be searched

string

no

g_us

minusKeywords

Negative keyword array

array

yes

[ ]empty array

["app", "apple"]

filters

Filter conditions

array

yes

 

{"cost_from": 0.1}

{"right_spelling": false

sort

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

field — field to sort by:
* cost
* concurrency
* found_results
* region_queries_count

* region_queries_count_wide
* keyword_length

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

array

yes

['cost' => 'asc', 'region_queries_count' => 'desc']

{"keyword": "desc"} 

or

['cost' => 'asc', 'region_queries_count' => 'desc']

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

"size": "10"

min: 1, max: 1000

To filter the results, use the following parameters:

Parameter Description Possible values 
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 competition for PPC keyword  0-100
concurrency_to max competition for PPC keyword  0-100
minus_keywords Negative keywords filter (a list of keywords separated by a comma) string

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data Array with data

keyword

Keyword

cost

Cost per click, $

concurrency

Keyword competition in the PPC (0-100%)

found_results

Number of results found for the keyword

region_queries_count

Search volume in a selected region

region_queries_count_wide

Search volume in selected search engine database in 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)

social_domains

Social domains listed top-10 for a selected keyword

right_spelling

Recommended correction of  a misspelled keyword
lang Language
keyword_length Number of words divided by space in a keyword
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. You can get no more than 60000 results per a query. Part of the API response, for which 1 credit is charged:

{
    "keyword": "how to download you tube videos on iphone",
    "cost": 0.56999999999999995,
    "concurrency": 1,
    "found_results": 729000000,
    "region_queries_count": 9900,
    "region_queries_count_wide": 0,
    "types": [
        "a_box_fsnippet",
        "local_related_search",
        "related_search"
        ],
    "geo_names": [],
    "social_domains": [
        "youtube",
        "reddit"
        ],
    "right_spelling": "how to download youtube videos on iphone",
    "lang": null,
    "keyword_length": 8,
    "difficulty": 17.57
},

2.2.10. Keyword info V4 (SerpstatKeywordProcedure.getKeywordsInfo)

The SerpstatKeywordProcedure.getKeywordsInfo method provides you with the keyword overview showing its volume, CPC, level of competition, etc. The data set is similar to the Overview report in Keyword research.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Type

Optional

Default value

Value Options

id

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

int/string

no

1, test

method

API method name

string

no

SerpstatKeywordProcedure.getKeywordsInfo

params

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

array

no

keywords

Array with keywords to search for

array

no

["iphone", "iphone 11"]

se

ID of the search base to be searched

string

no

g_us

sort

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

field — field to sort by (all numeric fields, except suggestions_count and keywords_count)

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

array

yes

[ ]empty array

{"cost": "desc"}

filers

Filter conditions

array

yes

true; false

{"right_spelling": true}

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data

Array with data

keyword

Keyword

cost

Cost per click, $

concurrency

Keyword competition in PPC (0-100%)

found_results

Number of results found for the keyword

region_queries_count

Search volume in the selected region

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)

social_domains

Social domains listed top-10 by the keyword

right_spelling

Recommended correction of  a misspelled keyword

lang

Language

difficulty

Competition level for a keyword to advance in organic search in the top-10 positions

suggestions_count

Number of search suggestions

keywords_count

Number of keywords

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. You can get no more than 60000 results per a query. Part of the API response, for which 1 credit is charged:

{
    "keyword": "iphone",
    "cost": 1.8822413793103445,
    "concurrency": 100,
    "found_results": 79,
    "region_queries_count": 1220000,
    "region_queries_count_wide": 0,
    "region_queries_count_phrase": 0,
    "types": [
        "shopping_top",
        "kn_graph_carousel_list",
        "also_asks"
        ],
    "geo_names": [],
    "social_domains": [
        "wikipedia",
        "amazon",
        "reddit"
        ],
    "right_spelling": null,
    "lang": null,
    "difficulty": 89.5890633703002,
    "suggestions_count": 2652668,
    "keywords_count": 8323766
},

2.2.11. V4 Search suggestions on V4 keyword (SerpstatKeywordProcedure.getSuggestions)

The SerpstatKeywordProcedure.getSuggestions method shows search suggestions for the keyword you requested (they are found by the full-text search). The data set is similar to the Keyword research — SEO research  Search suggestions report.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Type

Optional

Default value

Value Options

id

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

int/string

no

1, test

method

API method name

string

no

SerpstatKeywordProcedure.getSuggestions

params

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

array

no

keyword

Keyword to search for

string

no

iphone

se

ID of the search base to be searched

string

no

g_us

page Page number in response int yes 1 "page": "5"
size Number of results per page in response int 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

keyword

Search suggestion

geo_names

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

summary_info

Object with data

page

Page number

total

Number of found search suggestions

left_lines

API credits remaining

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

{
    "keyword": "iphone x fre case release",
    "geo_names": []
},

2.2.12. Related keywords V4 (SerpstatKeywordProcedure.getRelatedKeywords)

The SerpstatKeywordProcedure.getRelatedKeywords method shows all search queries that are semantically related to the searched keyword. The data set is similar to the Keyword research — SEO research  Related keywords report.

General request parameters and instructions for using Serpstat API

Request parameter

Parameter

Description

Type

Optional

Default value

Value Options

id

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

int/string

no

1, test

method

API method name

string

no

SerpstatKeywordProcedure.getRelatedKeywords

params

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

array no

keyword

Keyword to search for

string

no

iphone

se

ID of the search base to be searched

string

no

g_us

filters

Filter conditions

array

yes

 

Link strengh of related words
{"weight": {{weight_from}}

{"right_spelling": true}

sort

Synonyms for "/"Order of sorting the results in the format: {{{field}}: {{order}}}

field — field to sort by:
* cost
* concurrency
* weight
* region_queries_count
* keyword


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

array

yes

['cost' => 'asc', 'region_queries_count' => 'desc']

 cost: {{"asc"|"desc"}}}

page Page number in response int yes 1 "page": "5"
size Number of results per page in response int 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

keyword

Related keyword

region_queries_count

Search volume in selected region

cost

Cost per click, $

concurrency

Keyword competition in the PPC (0-100%)

geo_names

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

types

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

right_spelling

Recommended correction of a misspelled keyword

weight

Connection strength of related 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 Total number of related keywords found
left_lines API credits remaining

Credits: the number of charged credits corresponds to the number of results obtained upon request. You can get no more than 60000 results per a query. Part of the API response, for which 1 credit is charged:

"11 pro price iphone": {
    "keyword": "11 pro price iphone",
    "region_queries_count": 70,
    "cost": 0,
    "concurrency": 0,
    "geo_names": [],
    "types": [
        "related_search",
        "top_stories",
        "shopping_top",
        "also_asks",
        "kn_graph_carousel_list",
        "snip_breadcrumbs"
        ],
    "right_spelling": null,
    "weight": 1,
    "difficulty": 85.95114002363806
},

2.2.13. Keyword top V4 (SerpstatKeywordProcedure.getKeywordTop)

The SerpstatKeywordProcedure.getKeywordTop method shows you Google's top-100 or Yandex's top-50 search results for the analyzed keyword. The data set is similar to the Top pages report in Keyword research.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Type

Optional

Default value

Value Options

id

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

int/string

no

1, test

method

API method name

string

no

SerpstatKeywordProcedure.getKeywordTop

params

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

array

no

keyword

Keyword to search for

string

no

iphone

se

ID of the search base to be searched

string

no

g_us

filters

Filter conditions

int

yes

 {"top_size": 100}

{"top_size": 100}

top_size digital value from 1 to 100

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data Array with data

top

Contains the result

position

Domain's position for a keyword

url

Page that ranks for the keyword

domain

Domain which ranks for the keyword

subdomain

Subdomain which ranks for the keyword

types

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

ads

Number of found Ads (if there are ads in the results)

results

Number of results

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. You can get no more than 60000 results per a query. Part of the API response, for which 1 credit is charged:

{
    "position": 1,
    "url": "https://www.apple.com/iphone/",
    "domain": "apple.com",
    "subdomain": "www.apple.com",
    "types": [
        "shopping_top",
        "kn_graph_carousel_list",
        "also_asks",
        "snip_breadcrumbs"
        ]
},

2.2.14. Keyword competitors V4 (SerpstatKeywordProcedure.getCompetitors)

The SerpstatKeywordProcedure.getCompetitors method lists the domains that rank for the given keyword in Google top-20 results. The data set is similar to the Keyword research — SEO research  Competitors report.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Type

Optional

Default value

Value Options

id

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

int/string

no

1, test

method API method name string no SerpstatKeywordProcedure.getCompetitors

params

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

array

no

keyword

Keyword to search for

string

no

iphone

se

ID of the search base to be searched

string

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
* our_relevance

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

array

yes

 [ ] empty array

{"keyword": "desc"} 

or

{"visible": "asc"}

size

Number of results per page in response

int

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

domain

Domain

visible

Domain's 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 upgrade
keywords_dynamic Change in the number of keywords since the last upgrade
traff_dynamic Traffic change since the last upgrade
ads_dynamic Keyword change in PPC Ads
new_keywords Number of new keywords for the domain since the last upgrade
out_keywords Number of keywords lost by a domain since the last upgrade
rised_keywords Number of domain keywords which positions have improved since the last upgrade
down_keywords Number of domain keywords which positions have dropped since the last upgrade
ad_keywords Number of keywords in PPC
ads Number of Ads
intersected Number of domain keywords which contain a target keyword
relevance Domain's relevance to the keyword
summary_info Object with data
page Page number
left_lines Number of remaining API lines

Credits: the number of charged credits corresponds to the number of results obtained upon request. You can get no more than 60000 results per a query. Part of the API response, for which 1 credit is charged:

{
"apple.com": {
    "domain": "apple.com",
    "visible": 3417.2564,
    "keywords": 46650466,
    "traff": 1998603882,
    "visible_dynamic": 6.359480000000076,
    "keywords_dynamic": -751,
    "traff_dynamic": 7691041,
    "ads_dynamic": -390,
    "new_keywords": 153290,
    "out_keywords": 154041,
    "rised_keywords": 453556,
    "down_keywords": 465903,
    "ad_keywords": 5422,
    "ads": 4018,
    "intersected": 829984,
    "relevance": 1.78,
    "our_relevance": 9.97
},

2.2.15. Keyword Ads V4 (SerpstatKeywordProcedure.getAdKeywords)

The SerpstatKeywordProcedure.getAdKeywords returns paid keywords and ads copies that pop up for the queried keyword in paid search resultsThe data set is similar to the Keyword research — PPC research  Keywords report.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Type

Optional

Default value

Value Options

id

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

int/string

no

1, test

method

API method name

string

no

SerpstatKeywordProcedure.getAdKeywords

params

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

array

no

keyword

Keyword to search for

string

no

iphone

se

ID of the search base to be searched

string

no

g_us

domains

Domains list

array

yes

 [ ] 

["apple.com","verizon.com"]

minusKeywords

Negative keywords

array

yes

[]

["app", "apple"]

filters

Filter conditions

json object

yes

{"queries_from": 10} {"queries_to": 100}

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

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

json object

yes

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

{"cost": "asc"}

page

Page number in response

int

yes

1

"page": "5"

size Number of results per page in response int 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

position_from

Min position

1-100

position_to

Max position

1-100

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

results_from

Min result value 0-100000000

results_to

Max result value 0-100000000

length_from

Min value of a keyword’s length 0-100000000

length_to

Max value of a keyword’s length 0-100000000

Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data Array with data
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, $

Cost per click, $

Keyword competition in the PPC (0-100%)

found_results

Number of results found for the keyword

region_queries_count

Search volume in selected region

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 paid search results for the keyword

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": "upgrade iphone x to xs",
    "keyword_length": 5,
    "domain": "apple.com",
    "subdomain": "www.apple.com",
    "url": "https://www.apple.com/iphone/",
    "title": "Trade in for iPhone 12 - Apple Official Site",
    "text": "Get $90 - $515 off iPhone 12 when you trade in an iPhone 7 or newer. Terms apply. A14 Bionic Chip. 5G speed. Ceramic Shield. Super Retina XDR display. Services: Free no-contact delivery, Finance with Apple Card, 3% cash back w/Apple Card, Prepaid mail-in kit.",
    "position": 2,
    "type": "1",
    "cost": 0,
    "concurrency": 50,
    "found_results": 325000000,
    "region_queries_count": 10,
    "region_queries_count_wide": 0,
    "types": [
        "carousel",
        "also_asks",
        "video",
        "ads_top"
        ],
    "geo_names": [],
    "difficulty": null
},

2.2.20. PPC Keyword Competitors List V4 (SerpstatKeywordProcedure.getAdsCompetitors)

The SerpstatKeywordProcedure.getAdsCompetitors method performs list of competitors in PPC for the given keyword. The data set is similar to the Competitors report in PPC research of the keywords.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter Description Type Optional Default value Value Options
id A request id: the response contains the same id. Enter any number (number) or text (string) value int/string no 1, test
method API method name string no SerpstatKeywordProcedure.getAdsCompetitors
params The object with parameters {...}, it lists all the following parameters and arrays [...] array no
query Keyword by which competitors will be searched string no iphone
se Search engine ID string no g_us
page Page number in response int yes 1 "page": "5"
pageSize Number of results per page in response int yes 100 "pageSize": "100"

min: 100, max: 1000
sort

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

field - field to sort by:
ads
all
common

order - sort direction (asc - ascending, desc - descending)
json object yes {"common": "desc"}

Response parameters
Parameter Description
id Response id corresponds the request id
result Contains the answer
data Array with data
domain Competitor's domain
ads Number of ads for a domain
all Number of keywords for a domain in PPC
common Common keywords in PPC
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": "verizon.com",
    "ads": 8953,
    "all": 30855,
    "common": 1437
},

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