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

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": []
},

Example PHP Python
Request data:
{
 "id": "1",
 "method": "SerpstatKeywordProcedure.getSuggestions",
 "params": {
   "keyword": "iphone",
   "se": "g_us",
   "page": "1",
   "size": "10"
 }
}


Response data:
{
    "id": "1",
    "result": {
        "data": [
            {
                "keyword": "iphone x fre case release",
                "geo_names": []
            },
            {
                "keyword": "iphone 7 plus tekniset tiedot",
                "geo_names": []
            },
            {
                "keyword": "softlogic iphone x",
                "geo_names": []
            }
        ],
        "summary_info": {
            "page": 1,
            "total": 2652668,
            "left_lines": 998721
        }
    }
}