List of domain's URLs (domain_urls)

domain_urls

Returns the list of URLs within the analyzed domain. Also, shows the number of keywords from top-100 for each URL.

Pagination

Following parameters can be used for pagination:

page_size : number of results per page (default: 100, max: 1000)
page : page number (set to the 1st page by default)

Metrics	Description
result	Encapsulates the answer
total	Number of keywords for which the domain ranks in top-100
url	URL
keywords	Keyword for which the domain ranks
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	API limits remaining

Part of the API response, for which 1 limit is charged:

{
"url": "http://example.com/",
"keywords": 182
}

Example PHP Python

Request data:

api.serpstat.com/v3/domain_urls?query=example.com&token=XXX&se=XXX

Response data:

{
  "result": {
    "total": 4,
    "hits": [
      {
        "url": "https://example.com/",
        "keywords": 346
      },
      {
        "url": "http://example.com/",
        "keywords": 182
      }
    ]
  },
  "status_msg": "OK",
  "status_code": 200,
  "left_lines": 344806
}

<?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',
];
$domain = 'example.com';
// 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\DomainUrlsMethod(
    $domain,
    \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();
}

import codecs
import json
import pprint
import urllib.request as urlrequest
from urllib.parse import urlencode

host = 'http://api.serpstat.com/v3'

method = 'domain_urls'
params = {
    'query': 'example.com',  # 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)

List of domain's URLs (domain_urls)

{ "url": "http://example.com/", "keywords": 182 }

{
"url": "http://example.com/",
"keywords": 182
}