Требования к фиду для новостроек

О формате YRL

Фид с объявлениями для Яндекс.Недвижимости составляется на языке YRL (Yandex Realty Language), разработанном в Яндексе.

YRL основан на стандарте XML (Extensible Markup Language). Как и XML, YRL не позволяет использовать первые 32 ASCII-символа в текстовых полях (исключения — табуляция, перевод строки, возврат каретки). Также стандарт строго требует кодировать в тексте следующие символы:

Символ, который нужно заменить Код для YRL-файла
" "
& &
> >
< &lt;
' &apos;
Кодировка

Файл фида должен быть создан в кодировке UTF-8.

Заголовок документа

YRL-документ должен начинаться (с нулевого символа первой строки) со стандартного XML-заголовка.

<?xml version="1.0" encoding="utf-8"?>
Корневой элемент

Корневой элемент YRL-фида (realty-feed) должен содержать элемент generation-date с датой создания фида и элементы offer, в каждом из которых должна находиться информация из одного объявления. Чтобы указать пространство имен в XML, используйте атрибут xmlns="http://webmaster.yandex.ru/schemas/feed/realty/2010-06".

<realty-feed xmlns="http://webmaster.yandex.ru/schemas/feed/realty/2010-06">   <generation-date>2010-10-05T16:36:00+04:00</generation-date>   
 <offer>     
  ...   
 </offer>   
 ... 
</realty-feed>
Формат даты

Все даты и время следует указывать согласно стандарту ISO 8601. В общем случае — в формате YYYY-MM-DDTHH:mm:ss+00:00, где:

  • YYYY — год;

  • MM — месяц;

  • DD — день;

  • HH — час;

  • mm — минута;

  • ss — секунда;

  • +00:00 — указание часового пояса (для Москвы — +03:00).

Ниже описаны все возможные элементы фида, сгруппированные по их назначению в языке YRL.

Общая информация об объявлении

У элемента offer есть обязательный атрибут internal-id, который должен быть уникальным для каждого объявления. Этот атрибут можно заполнять, например, идентификатором объявления в вашей базе данных.

<offer internal-id="1245">
 ...
</offer>
Примечание. Элементы со строго ограниченным набором значений могут содержать только перечисленные варианты. Использование других значений приведет к ошибке обработки фида.
Элемент Обязательный элемент Описание
type

Тип сделки «продажа»

property-type

Тип недвижимости.

Строго ограниченное значение: «жилая»

category

Категория объекта.

Возможные значения:

  • «дом»/«house»
  • «квартира»/«flat»
  • «таунхаус»/«townhouse»
url

URL страницы объявления или жилого комплекса

creation-date

Дата создания объявления.

Указывается в формате YYYY-MM-DDTHH:mm:ss+00:00

last-update-date

Дата последнего обновления объявления.

Указывается в формате YYYY-MM-DDTHH:mm:ss+00:00

expire-date

Дата и время, до которых объявление актуально.

Указывается в формате YYYY-MM-DDTHH:mm:ss+00:00

location

Набор элементов, описывающих местоположение объекта.

<location>     
      <country/>
      <region/>
      <district/>
      <locality-name/>
      …
 </location>
country

Страна, в которой расположен объект.

Примечание. В настоящее время объявления принимаются только для объектов недвижимости, расположенных в России
region

Название субъекта РФ.

Необязательный параметр для объектов в Москве и Санкт-Петербурге

district

Название района субъекта РФ

locality-name

Название населенного пункта

sub-locality-name

Район населенного пункта

address

Улица и номер дома.

Номер дома необязательно указывать для загородной недвижимости
direction

Шоссе.

Элемент передается только для объектов в Москве и Московской области

distance

Расстояние по шоссе до МКАД.

Значение указывается в километрах.

Элемент передается только для объектов в Москве и Московской области

latitude

Географическая широта

longitude

Географическая долгота

metro

Ближайшая станция метро.

Если станций несколько, каждая должна быть указана в отдельном элементе. Во вложенных тегах указывается подробная информация.

<metro>           
      <name/>
      <time-on-foot/>
      <time-on-transport/>
</metro>
name

Название станции метро

time-on-transport

Время до метро в минутах на транспорте

time-on-foot

Время до метро в минутах пешком

railway-station

Ближайшая железнодорожная станция.

Элемент указывается только для загородной недвижимости

vas

Дополнительная услуга по продвижению объявления.

Указывается, если к объявлению должна быть применена дополнительная услуга.

Возможные значения:

  • «premium»
  • «raise»
  • «promotion»

В зависимости от типа недвижимости (городская или загородная) обязательны разные параметры, описывающие адрес.

Для городской недвижимости обязательны поля:

  • district (обязателен для городов, находящихся в областях субъектов РФ);
  • locality-name (название населенного пункта);
  • address (улица или улица и дом).

Для загородной недвижимости обязательны поля:

  • district (район субъекта РФ)

    или

    locality-name (название населенного пункта)

    или

    direction (шоссе — для объектов в Московской области)

    или

    railway-station (ближайшая железнодорожная станция).

Пример использования тегов <region>, <district> и <sub-locality-name> при описании адреса
<location>
    <country>Россия</country>
    <region>Московская область</region>
    <district>Одинцовский район</district>
    <locality-name>Одинцово</locality-name>
        <sub-locality-name>Центральный</sub-locality-name>
        <non-admin-sub-locality>Центр</non-admin-sub-locality>
    <address>Пушкинская ул., д. 12</address>
    <direction>Минское шоссе</direction>
</location>
Пример использования тега <metro> при описании городской недвижимости
<location>
       <country>Россия</country>
       <locality-name>Санкт-Петербург</locality-name>
       <sub-locality-name>Адмиралтейский</sub-locality-name>
       <address>Измайловский пр., 16</address>
       <metro>
          <name>Технологический институт</name>
          <time-on-foot>10</time-on-foot>
          <time-on-transport>5</time-on-transport>
       </metro>
</location>
Пример использования тегов <direction> и <distance> при описании загородной недвижимости (для Москвской области)
<location>
       <country>Россия</country>
       <region>Московская область</region>
       <district>Истринский район</district>
       <locality-name>деревня Подушкино</locality-name>
       <direction>Рублево-Успенское шоссе</direction>
       <distance>10</distance>
</location>

Информация о продавце

Примечание. Элементы со строго ограниченным набором значений могут содержать только перечисленные варианты. Использование других значений приведет к ошибке обработки фида.
Элемент Обязательный элемент Описание
sales-agent

Информация о продавце.

Во вложенных тегах указывается подробная информация.

<sales-agent>
    <name/>
    <phone/>
    <category/>
    <organization/>
    <url/>
    <photo/>
    …
</sales-agent>
phone

Номер телефона.

Номер указывается в международном формате.

Если номеров несколько, каждый из них необходимо передавать в отдельном элементе phone.

Примечание. Для агентств недвижимости обязательно должны быть указаны прямые телефоны агентов
category

Тип продавца.

Строго ограниченные значения:

  • «агентство»/«agency»
  • «застройщик»/«developer»
organization

Название организации

url

Сайт агентства или застройщика

email

Электронный адрес продавца

photo

Ссылка на логотип компании

Информация об условиях сделки

Элемент Обязательный элемент Описание
price

Набор элементов, описывающих цену объекта.

<price>
  <value/>
  <currency/>
  <unit/>
  <period/>
</price>
value

Цена.

Сумма указывается без пробелов.

Цена должна включать НДС (если он есть) и постоянные эксплуатационные расходы (для коммерческой недвижимости)

currency

Валюта, в которой указана цена.

Цену предложения следует передавать только в той валюте, которая указана в объявлении.

Возможные значения:

  • «RUR» или «RUB» (российский рубль)
  • «EUR» (евро)
  • «USD» (американский доллар)
unit

Единица площади помещения или.

Элемент используется, если цена указана за единицу площади.

Возможные значения: «кв. м»/«sq. m»

Пример передачи данных о цене квартиры
<price>
    <value>4000000</value>
    <currency>RUR</currency>
</price>
Пример передачи данных о цене 1 кв. м.
<price>
    <value>60000</value>
    <currency>RUB</currency>
    <unit>кв.м</unit>
</price>

Информация об объекте

Элемент Обязательный элемент Описание
image

Фотография объекта и планировки.

Можно передавать несколько элементов.

Фотографии планировки следует передавать с атрибутом tag. Возможные значения атрибута: plan, plan 3d и т. п.

<image tag="plan">
 ...
</image>
Внимание. В качестве разделителя в значении атрибута используется пробел:
  • 3d plan — фотография будет использована для изображения планировки объекта,
  • 3dplan — не будет.

Если фотографий с атрибутом tag несколько, то для изображения планировки используется первая из них.

Если таких фотографий нет, то фотография для изображения планировки определяется автоматически.

Не следует передавать изображения, не имеющие прямого отношения к объекту (например, логотипы или фотографии сотрудников).

area

Набор элементов, передающих площадь объекта.

Значение и единицы измерения площади передаются во вложенных тэгах:

<area>
  <value/>
  <unit/> 
</area>
value

Площадь.

Указывается числовое значение

unit

Единица площади помещения.

Элемент используется, если цена указана за единицу площади.

Возможные значения: «кв. м»/«sq. m»

living-space

Жилая площадь.

<living-space>
   <value/>
   <unit/>
</living-space>
room-space

Площадь комнаты.

Количество передаваемых элементов должно соответствовать количеству комнат.

<room-space>
   <value/>
   <unit/>
</room-space>
kitchen-space

Площадь кухни.

<kitchen-space>
   <value/>
   <unit/>
</kitchen-space>
renovation

Ремонт.

Возможные значения:

  • «дизайнерский»
  • «евро»
  • «с отделкой»
  • «требует ремонта»
  • «хороший»
  • «частичный ремонт»
  • «черновая отделка»
description

Дополнительная информация.

Описание в свободной форме

Пример передачи данных о площадях объекта недвижимости
<area>
    <value>56</value>
    <unit>кв. м</unit>
</area>
<living-space>
    <value>36</value>
    <unit>кв. м</unit>
</living-space>
<room-space>
    <value>20</value>   
    <unit>кв. м</unit> 
</room-space>
<room-space>
    <value>16</value>   
    <unit>кв. м</unit> 
</room-space>
<kitchen-space>
    <value>8</value>
    <unit>кв. м</unit>
</kitchen-space>

Описание жилого помещения

Примечание. Элементы со строго ограниченным набором значений могут содержать только перечисленные варианты. Использование других значений приведет к ошибке обработки фида.
Элемент Обязательный элемент Описание
new-flat

Признак новостройки.

Строго ограниченные значения: «да», «true», «1», «+»

floor

Этаж

rooms

Общее количество комнат в квартире.

При свободной планировке количество комнат указывается согласно паспорту объекта
rooms-type

Тип комнат.

Возможные значения:

  • «раздельные»
  • «смежные»
apartments

Апартаменты.

Строго ограниченные значения:

  • «да»/«нет»
  • «true»/«false»
  • «1»/«0»
  • «+»/«-»
studio

Студия.

Строго ограниченные значения: «да», «true», «1», «+»

open-plan

Свободная планировка.

Строго ограниченные значения: «да», «true», «1», «+»

balcony

Тип балкона.

Возможные значения: «балкон», «лоджия», «2 балкона», «2 лоджии» и т. п.

window-view

Вид из окон.

Возможные значения:

  • «во двор»
  • «на улицу»
floor-covering

Покрытие пола.

Возможные значения:

  • «ковролин»
  • «ламинат»
  • «линолеум»
  • «паркет»
bathroom-unit

Тип санузла.

Возможные значения:

  • «раздельный»
  • «совмещенный»
  • числовое значение (например « 2 »)

Описание здания

Примечание. Элементы со строго ограниченным набором значений могут содержать только перечисленные варианты. Использование других значений приведет к ошибке обработки фида.
Элемент Обязательный элемент Описание
floors-total

Общее количество этажей в доме

building-name

Название жилого комплекса.

Примечание. В настоящее время элемент поддерживается только для объектов в Московской, Ленинградской, Ростовской, Свердловской областях и Краснодарском крае

Передавать нужно только название ЖК.

Пример:

<building-name>Северная жемчужина</building-name>
yandex-building-id

Идентификатор жилого комплекса в базе данных Яндекса.

Примечание. В настоящее время элемент поддерживается только для объектов в Московской, Ленинградской, Ростовской, Свердловской областях и Краснодарском крае

Элемент следует передавать, чтобы объявления корректно подгружались к соответствующему жилому комплексу

Идентификатор отображается в адресе страницы, на которой размещена карточка жилого комплекса.

Полный список идентификаторов yandex-building-id предоставляется по запросу с указанием региона на info@realty.yandex.ru

building-state

Стадия строительства дома.

Строго ограниченные значения:

  • «built» (дом построен, но не сдан)
  • «hand-over» (сдан в эксплуатацию)
  • «unfinished» (строится)

Если значения built-year и ready-quarter указаны в прошедшем времени, для тэга building-state следует передавать значение hand-over

built-year

Год сдачи.

Год необходимо указывать полностью, например — «1996», а не «96»

ready-quarter

Квартал сдачи дома.

Строго ограниченные значения: «1», «2», «3», «4»

building-phase

Очередь строительства.

Возможные значения: «очередь 1», «II очередь», «3» и т. п.

building-type

Тип дома.

Возможные значения:

  • «кирпичный»
  • «монолит»
  • «панельный»
building-series

Серия дома

building-section

Корпус (секция) дома.

Возможные значения: «корпус 1», «корпус А», «дом 3» и т. п.

ceiling-height

Высота потолков в метрах

lift

Наличие лифта.

Строго ограниченные значения:

  • «да»/«нет»
  • «true»/«false»
  • «1»/«0»
  • «+»/«-»
rubbish-chute

Наличие мусоропровода.

Строго ограниченные значения:

  • «да»/«нет»
  • «true»/«false»
  • «1»/«0»
  • «+»/«-»
guarded-building

Закрытая территория.

Строго ограниченные значения:

  • «да»/«нет»
  • «true»/«false»
  • «1»/«0»
  • «+»/«-»
parking

Наличие охраняемой парковки.

Строго ограниченные значения:

  • «да»/«нет»
  • «true»/«false»
  • «1»/«0»
  • «+»/«-»
is-elite

Элитная недвижимость.

Строго ограниченные значения:

  • «да»/«нет»
  • «true»/«false»
  • «1»/«0»
  • «+»/«-»

Пример корректного YRL-файла

<?xml version="1.0" encoding="UTF-8"?> 
<realty-feed xmlns="http://webmaster.yandex.ru/schemas/feed/realty/2010-06">
<generation-date>2010-12-11T12:00:00+04:00</generation-date>   
<offer internal-id="15782295">
<type>продажа</type>
<property-type>жилая</property-type>
<category>квартира</category>
<url>http://www.developer.ru/search18</url>
<creation-date>2015-04-02T19:00:06+03:00</creation-date>
<location>
  <country>Россия</country>
   <locality-name>Санкт-Петербург</locality-name>
   <address>18-я линия В.О., 32</address>
   <metro>
     <name>Василеостровская</name>
   </metro>
</location>
<price>
  <value>4780000</value>
  <currency>RUR</currency>
</price>
<sales-agent>
  <phone>+7812500400</phone>
  <organization>ЗАО "Застройщик"</organization>
  <url>http://www.developer.ru/</url>
   <category>developer</category>
  <photo>http://www.developer.ru/company/logo</photo>
</sales-agent>
<rooms>2</rooms>
<new-flat>1</new-flat>
<bathroom-unit>раздельный</bathroom-unit>
<balcony>балкон</balcony>
<floor>13</floor>
<floors-total>15</floors-total>
<building-name>Северная фантазия</building-name>
<yandex-building-id>12345</yandex-building-id>
<building-section>Корпус 1</building-section>
<building-state>unfinished</building-state>
<ready-quarter>3</ready-quarter>
<built-year>2018</built-year>
<building-phase>3</building-phase>
<image>http://www.developer.ru/images/plans/000001289.jpg</image>
<description>Продается 2 к. кв., 13 этаж, 15 минут на машине до метро "Василеостровская". Дом комфорт-класса с продуманными планировочными решениями и широким выбором квартир. Внутренний двор «Северной фантазии» выполнен по эксклюзивному дизайн-проекту. В районе постройки нового ЖК развита инфраструктура: школы и детские сады, больница, аптеки магазины, кафе и спортивные центры. Доступны разные условия ипотеки, скидки и зачет жилья.</description>
<area>
  <value>63.00</value>
  <unit>кв. м</unit>
</area>
<living-space>
  <value>50.00</value>
  <unit>кв. м</unit>
</living-space>
<kitchen-space>
  <value>10.00</value>
  <unit>кв. м</unit>
</kitchen-space>
<room-space>
  <value>15</value>
  <unit>кв. м</unit>
</room-space>
<room-space>
  <value>35</value>
  <unit>кв. м</unit>
</room-space>
</offer>
</realty-feed>