Top for a keyword (keyword_top)
keyword_top
This report shows you Google top 100 organic search results for the keyword you requested.
| Metrics | Description |
| result | Encapsulates the answer |
| results | Number of results |
| top | Encapsulates the result |
| url | Page that is ranking on the ""position"" |
| domain | Domain |
| position | Domain's position for a keyword |
| snippet | the description which is shown in the SERP |
| title | Title |
| ads | Ads found |
| status_msg | Response "OK" or "Error" report on a successful or unsuccessful request |
| status_code | Response code "200" — successful request. Errors occur when limits are exceeded (number of simultaneous requests or account limits) |
| left_lines | Number of remaining API queries |
Request data:
<?php
// This example works on serpstat-sdk only
// https://github.com/SerpstatGlobal/serpstat-sdk
require_once __DIR__ . '/../vendor/autoload.php';
// configure your application
$config = [
'token' => '19666fc1ae1724da1d5ea2f3a99d5f5a',
];
$keywords = 'keywords';
// init client with your serpstat api token
$apiClient = new \Serpstat\Sdk\Core\ApiGuzzleHttpClient($config['token']);
// create instance of any api method class
// list of methods classes in folder src\Methods
$apiMethod = new \Serpstat\Sdk\Methods\KeywordTopMethod(
$keywords,
\Serpstat\Sdk\Interfaces\IApiClient::SE_GOOGLE_RU
);
try {
// try call api method
$response = $apiClient->call($apiMethod);
} catch (\Exception $e) {
// catch api error
$response = $e->getMessage();
}Response data:
"{
""result"":{
""results"":""2720000000"",
""top"":[
{
""url"":""https:\/\/www.example.com\/ru\/example\/"",
""domain"":""example.com"",
""position"":1,
""snippet"":""\u041f\u043e\u0437\u043d\u0430\u043a\u043e\u043c\u044c\u0442\u0435\u0441\u044c \u0441 example<\/em> \u2014 \u0441\u0430\u043c\u044b\u043c \u043c\u043e\u0449\u043d\u044b\u043c \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u044c\u043d\u044b\u043c \u0443\u0441\u0442\u0440\u043e\u0439\u0441\u0442\u0432\u043e\u043c \u0432 \u043c\u0438\u0440\u0435. \u0423\u0437\u043d\u0430\u0439\u0442\u0435 \u0431\u043e\u043b\u044c\u0448\u0435 \u043e\u0431 iPhone<\/em> 7, iPhone<\/em> 7 Plus \u0438 iPhone<\/em> 6s."",
""title"":""example \u2013 example (RU)""
},
],
""ads"":[
]
},
""status_msg"":""OK"",
""status_code"":200,
""left_lines"":998691
}"Request data:
import codecs
import json
import pprint
import urllib.request as urlrequest
from urllib.parse import urlencode
host = 'http://api.serpstat.com/v3'
method = 'keyword_top'
params = {
'query': 'buy%20laptop', # string for get info
'se': 'g_us', # string search engine
'token': 'ijmiom4f5m34905g03um8342dm04923lre3w', # string personal token
}
api_url = "{host}/{method}?{params}".format(
host=host,
method=method,
params=urlencode(params)
)
try:
json_data = urlrequest.urlopen(api_url).read()
except Exception as e0:
print("API request error: {error}".format(error=e0))
data = json.loads(json_data)
pprint.pprint(data)Response data:
"{
""result"":{
""results"":""2720000000"",
""top"":[
{
""url"":""https:\/\/www.example.com\/ru\/example\/"",
""domain"":""example.com"",
""position"":1,
""snippet"":""\u041f\u043e\u0437\u043d\u0430\u043a\u043e\u043c\u044c\u0442\u0435\u0441\u044c \u0441 example<\/em> \u2014 \u0441\u0430\u043c\u044b\u043c \u043c\u043e\u0449\u043d\u044b\u043c \u043f\u0435\u0440\u0441\u043e\u043d\u0430\u043b\u044c\u043d\u044b\u043c \u0443\u0441\u0442\u0440\u043e\u0439\u0441\u0442\u0432\u043e\u043c \u0432 \u043c\u0438\u0440\u0435. \u0423\u0437\u043d\u0430\u0439\u0442\u0435 \u0431\u043e\u043b\u044c\u0448\u0435 \u043e\u0431 iPhone<\/em> 7, iPhone<\/em> 7 Plus \u0438 iPhone<\/em> 6s."",
""title"":""example \u2013 example (RU)""
},
],
""ads"":[
]
},
""status_msg"":""OK"",
""status_code"":200,
""left_lines"":998691
}"