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

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 / 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. 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 (there are both Google and Yandex databases available, for example: g_us or y_157).

string

no

g_us

filters

Filter conditions

array

yes

 

Connection strengh of related keywords:
{"weight":{{weight_from}}
{"weight":{{weight_to}}

Misspelled keywords:
{"right_spelling":true}
{"right_spelling":false}

Keyword Volume:
{"region_queries_count": 1}
{"region_queries_count_to": 2}
{"region_queries_count_from": 3}

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:

"data": {
            "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": "iphone",
        "filters": {
            "weight": "1",
            "right_spelling": false,
            "region_queries_count_to": 2
        },
        "sort": {
            "keyword": "asc"
        },
        "se": "g_us",
        "page": "1",
        "size": "10"
    }
}

Response data:
{
    "id": "1",
    "result": {
        "data": {
            "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
            },
        "summary_info": {
            "page": 1,
            "total": 2230,
            "left_lines": 998671
        }
    }
}

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.

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

Open support chat