YML FILE FORMAT

The feed must contain only relevant ads. The feed URL must be persistent and accessible via HTTP.

All data values ​​(including URLs) must be masked using XML entities. This ensures that special characters are displayed correctly in the system. The file encoding must remain UTF-8.

The file consists of a root element <realty-feed> with nested elements. Each ad contains the following blocks:</realty-feed>

Each offer has an internal-id attribute for internal accounting and can contain an external-id for updating data from an external system. You can also specify whether to publish or unpublish the offer.

Indicates (for sale or rent), (apartment, house, commercial property, etc.) and additional subcategories (for example, <property-type> for residential or commercial).</property-type>

All geographic data must be in Ukrainian:

• country
• region
• district
• settlement
• street

If desired, you can add coordinates (latitude and longitude) for the exact location of the object.

The contact details of the agent or agency are specified, but for example the data can be conditional. For example: name, category (agency), organization, email and phone.

Indicated with currency and unit of measurement (м.кв), and for land plots – in acres or hectares. You can also add and other parameters of living space.

The field contains a detailed description of the property in Ukrainian:<description> DESCRIPTION IN UKRAINIAN LANGUAGE</description>.

Each offer can contain several links to photos of the property. It is recommended to use direct links to high-quality image files.

Here is an example of an offer structure in standard YML format:

<offer internal-id="1">
    <type>продаж</type>
    <category>будинок</category>
    <property-type>жила</property-type>
    <url>http://example.com/estate-1.html</url>
    <location>
        <country>Україна</country>
        <region>Львівська область</region>
        <district>Галицький район</district>
        <locality-name>Львів</locality-name><address>Вулиця Січових Стрільців, 10</address>
    </location>
    <sales-agent>
        <name>Ім’я агента</name>
        <category>агентство</category>
        <organization>Назва агентства</organization>
        <email>example@email.com</email>
        <phone>0000000000</phone>
    </sales-agent>
    <price>
        <value>150000</value>
        <currency>USD</currency>
    </price>
    <area>
        <value>120</value>
        <unit>кв.м</unit>
    </area>
    <description>ОПИС УКРАЇНСЬКОЮ МОВОЮ</description>
    <img>http://example.com/images/estate1.jpg</img>
</offer>