Related keywords

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 / Related keywords report.

General request parameters and instructions for using Serpstat API

Search databases available

Request parameter

Parameter

Description

Type

Optional

Default value

Value Options

id

A request id: the response contains the same id.

int/string

no

Text or number value

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

Any string value (for example: seo)

se

ID of the search base to be searched.

string

no

For example: g_us (search databases list)

filters

Filter conditions

array

yes

Connection strengh of related keywords:
"weight":{weight_from} - Connection strength from
"weight":{weight_to} - Connection strength to

Misspelled keywords:
"right_spelling":{true} - Contains all
"right_spelling":{false} - Does not contain all

Keyword Volume:
"region_queries_count": 1 - Keyword volume by the selected region
"region_queries_count_to": 2 - Keyword volume by the selected region to
"region_queries_count_from": 3 - Keyword volume by the selected region from

Difficulty:
"difficilty": 1 (0-100) - Keyword difficulty
"difficilty_to": 5 (0-100) - Keyword difficulty to
"difficilty_from": 1 (0-100) - Keyword difficulty from

Concurrency:
"concurrency": 1 (1-100) - Competition level
"concurrency_to": 10 (1-100) - Competition level to
"concurrency_from": 1 (1-100) - Competition level from

Cost:
"cost": 1 (0-200) - Cost per click ($)
"cost_from": 1 (0-200) - Cost per click from in ($)
"cost_to": 10 (0-200) - Cost per click to ($)

Number of words in a phrase:
"keyword_length": 1 (any numeric value) - Number of words in the keyword
"keyword_length_to": 10 (any numeric value) - Number of words in the keyword to
"keyword_length_from": 1 (any numeric value) - Number of words in the keyword from

Toponyms:
"geo_names": {"contain" | "not_contain"} - Array of toponyms, if the toponym is present in the keyword ( contains | does not contain )

Special elements:
"types": {"snip_also_ask", "sport", "news"} - The type of special elements in the output (for example: people also ask, sports summaries, news, etc.)

Available values for types:

map, pic, video, news, adv, calc, spec, graph, market, island, answer, carousel, sponsored, also_asks, map_local, a_box_c_converter, a_box_card, a_box_color_picker, a_box_dictionary, a_box_dtime, a_box_earthquake, a_box_flights, a_box_fsnippet, a_box_g_converter, a_box_map, a_box_nutrition, a_box_population, a_box_some, a_box_sports, a_box_stock, a_box_translation, a_box_weather, a_box_when_is, ads_bot, ads_top, bests, car_loan_calc, discover_places, kn_graph_brand, kn_graph_card, kn_graph_carousel_list, kn_graph_carousel_table, kn_graph_disambiguation, kn_graph_health, kn_graph_hotel_booking, kn_graph_local, local_pack, mortgage_calc, refine_by_brand, related_search, research, shopping_rhs, shopping_top, shopping_bottom, snip_breadcrumbs, snip_doc_type, snip_https, snip_image_thumbnail, snip_info, snip_reviews_stars, snip_search_box, snip_sitelinks, snip_twitter, snip_video_thumbnail, snip_feedback, snip_also_ask, snippet_steps_list, prices, top_stories, adv_banner, afisha, auto, avia, collections, companies, converter, entity, fact, homonyms, math, metro, music, oplata, pogoda, radio, rasp, realty, related, snippet_dates, snippet_file, snippet_image, snippet_recipe, snippet_list, snippet_price, snippet_rating, snippet_redir, snippet_showcase, snippet_sitelinks, snippet_social, snippet_table, snippet_video, sport, taxi, time, translate, travel, tv (more about SERP features)

Keywords:

"keyword_contain": string — Contains all (exact matching)
"keyword_not_contain": string — Doesn't contain all (exact matching)
"keyword_contain_one_of": array — Contains one of (exact matching)
"keyword_not_contain_one_of": array — Doesn't contain one of (exact matching)
"keyword_contain_broad_match": array — Contains all (broad matching)
"keyword_not_contain_broad_match": array — Doesn't contain all (broad matching)
"keyword_contain_one_of_broad_match": array — Contains one of (broad matching) 
"keyword_not_contain_one_of_broad_match": array — Doesn't contain one of (broad matching)

Language:
"lang": {uk,ru,en,bg,pl,de,es,it,fr,ro,be,hu,ka,el...} — Keyword language
Language filtration works only for g_ua database

sort

Sort by data (ascending and descending)

array

yes

"keyword"

"keyword" - Sort results alphabetically

"weight" - Sort results by the number of URLs in the top 20 results

"difficulty" - Sort the results by the level of keywords competition level to advance in organic search in the top-10

"cost" - Sort the results by cost per click (in USD)

order

Sort direction

array

yes

 "desc"

Sort direction (asc — ascending, desc — descending)

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

"size": 10 (any number value)

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 (USD), that is monthly updated.

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

The number of URLs in the top 20 results, which are ranked by the search keyword and the keyword from the report.

difficulty

The assessment of the level of competition for a keyword to advance in organic search in the top-10 (from 1 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. With the Serpstat API, you can only get the first 60,000 results, regardless of the number and size of the queries themselves. For more data - use the export option in the Domain Analysis, Keyword Analysis, or URL Analysis sections, or contact the manager for a personal upload of the results. Part of the API response, for which 1 credit is charged:

        {
            "6 plus portrait dimensions": {
                "keyword": "6 plus portrait dimensions",
                "region_queries_count": 1,
                "cost": 0,
                "concurrency": 0,
                "geo_names": [],
                "types": [
                    "also_asks",
                    "video",
                    "related_search",
                    "snip_breadcrumbs"
                ],
                "right_spelling": null,
                "weight": 1,
                "difficulty": null
            }

Example
Request data:
{
    "id": 1,
    "method": "SerpstatKeywordProcedure.getRelatedKeywords",
    "params": {
        "keyword": "seo",
        "se": "g_us",
        "filters": {
            "keyword_contain": "competitor",
            "types": "also_asks"
            },
        "sort": {"keyword":"asc"},
        "page": 1,
        "size": 3
    }
}

Response data:
{
    "id": "1",
    "result": {
        "data": [
            {
                "keyword": "how to competitor website analysis in hindi",
                "region_queries_count": 1,
                "cost": 0,
                "concurrency": 0,
                "geo_names": [],
                "types": [
                    "also_asks",
                    "related_search",
                    "snip_breadcrumbs"
                ],
                "right_spelling": null,
                "weight": 1,
                "difficulty": 11.026413636841786
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 1,
            "left_lines": 994613
        }
    }
}

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