Getting site information

Returns information about the site.

  1. Request format
  2. Response format
  3. Response codes

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/

Path parameters

Name Required Type Default value Description
user-id Yes int64 User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user method.
host-id Yes host id The site ID. To get it, use the GET /user/{user-id}/hosts method.

Response format

Example

{
  "host_id": "https:ya.ru:443",
  "verified": true,
  "ascii_host_url": "https://ya.ru/",
  "unicode_host_url": "https://ya.ru/",
  "main_mirror": {
    "host_id": "http:xn--d1acpjx3f.xn--p1ai:80",
    "ascii_host_url": "http://xn--d1acpjx3f.xn--p1ai/",
    "unicode_host_url": "http://яндекс.рф/",
    "verified": false
  },
  "host_data_status": "NOT_INDEXED",
  "host_display_name": "Ya.ru"
}
Name Required Type Description
host_id Yes host id ID of the requested site.
ascii_host_url Yes string The site's ASCII URL
unicode_host_url Yes string The site's UTF-8 URL.
verified Yes boolean Whether the site is verified.
main_mirror No The site's main mirror, if there is one.
host_data_status No ApiHostDataStatus Information about the site (shown if the site is verified).
host_display_name No string The site name to display.

Site indexing status (ApiHostDataStatus)

Source Description
NOT_INDEXED The site isn't indexed yet.
NOT_LOADED The site data isn't uploaded to Yandex.Webmaster yet.
OK The site is indexed. The data is available in Yandex.Webmaster.

Response codes

To view the response structure in detail, click the reason.

Code Reason Description
200 OK
403

INVALID_USER_ID

The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_FOUND

The site is not in the list of the user's sites.

{
  "error_code": "HOST_NOT_FOUND",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}