Getting site information

Returns information about the site.

Request format

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

Response format

Example

JSON

XML

{
  "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"
}

<Data>
    <host_id>https:ya.ru:443</host_id>
    <verified>true</verified>
    <ascii_host_url>https://ya.ru/</ascii_host_url>
    <unicode_host_url>https://ya.ru/</unicode_host_url>
    <main_mirror>
        <host_id>http:xn--d1acpjx3f.xn--p1ai:80</host_id>
        <ascii_host_url>http://xn--d1acpjx3f.xn--p1ai/</ascii_host_url>
        <unicode_host_url>http://яндекс.рф/</unicode_host_url>
        <verified>false</verified>
    </main_mirror>
    <host_data_status>NOT_INDEXED</host_data_status>
    <host_display_name>Ya.ru</host_display_name>
</Data>

Site indexing status (ApiHostDataStatus)

Response codes

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

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

<Data>     
    <error_code>INVALID_USER_ID</error_code>     
    <available_user_id>1</available_user_id>     
    <error_message>Invalid user id. {user_id} should be used.</error_message> 
</Data>

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

<Data>     
    <error_code>HOST_NOT_FOUND</error_code>     
    <host_id>http:ya.ru:80</host_id>     
    <error_message>explicit error message</error_message>
</Data>

Related information

• Error codes and statuses