Получение информации о сайте

Возвращает информацию о сайте.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

Формат запроса

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

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts.

Формат ответа

Пример

{
  "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"
}
Имя Обязательный Тип Описание
host_id Да host id ID запрошенного сайта.
ascii_host_url Да string ASCII URL сайта
unicode_host_url Да string UTF-8 URL сайта.
verified Да boolean Подтвержден ли сайт.
main_mirror Нет Главное зеркало сайта, если есть.
host_data_status Нет ApiHostDataStatus Информация о сайте (показывается, если сайт подтвержден).
host_display_name Нет string Отображаемое имя сайта.

Статус индексирования сайта (ApiHostDataStatus)

Источник Описание
NOT_INDEXED Сайт еще не проиндексирован.
NOT_LOADED Данные о сайте еще не загружены в Яндекс.Вебмастер.
OK Сайт проиндексирован, данные доступны в Яндекс.Вебмастере.

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код Причина Описание
200 OK
403

INVALID_USER_ID

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.

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

Сайт отсутствует в списке сайтов пользователя.

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