Keyword overview

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

Search databases available

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"]
maximum is 1000 keywords in array

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"}

filters

Filter conditions

array

yes

"right_spelling": true$ "right_spelling": false

"minus_keywords": ["case", "red"]

"cost": "10";
"cost_to": "10";
"cost_from": 1

"concurrency": "7";
"concurrency_to": "7";
"concurrency_from": 1

"found_results": "100";
"found_results_to": "500";
"found_results_from": 300

"region_queries_count": "1000";
"region_queries_count_to": "2000";
"region_queries_count_from": 300

"region_queries_count_wide": "1000";
"region_queries_count_wide_to": "1500";
"region_queries_count_wide_from": 100

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 1000 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
},

Example
Request data:
{
    "id": "1",
    "method": "SerpstatKeywordProcedure.getKeywordsInfo",
    "params": {
        "keywords": [
            "iphone",
            "iphone 11"
        ],
        "se": "g_us",
        "filters": {
            "cost_from": 0.7,
            "region_queries_count_from": 100,
            "minus_keywords": ["case","red"]
        }
    }
}
Response data:
{
    "id": "1",
    "result": {
        "data": [
            {
                "keyword": "iphone 11",
                "cost": 0.71,
                "concurrency": 100,
                "found_results": 4460000000,
                "region_queries_count": 1500000,
                "region_queries_count_wide": 0,
                "region_queries_count_phrase": 0,
                "types": [
                    "video",
                    "shopping_top",
                    "also_asks"
                ],
                "geo_names": [],
                "social_domains": [
                    "wikipedia",
                    "amazon",
                    "pinterest"
                ],
                "right_spelling": null,
                "lang": null,
                "keyword_length": 2,
                "difficulty": 30.39
                ],
                "suggestions_count": 0,
                "keywords_count": 3406
            }
        ],
        "summary_info": {
            "page": 1,
            "left_lines": 999718
        }
    }
}

Share this article with your friends

Are you sure?

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.

Thank you, we have saved your new mailing settings.

Open support chat