Reference
property.json

Fields

The feed is an allowlist: only the fields below can ever appear in it. Nested fields are written as dotted paths.

Listing

id
string required

Stable identifier for this listing. Use it to match a listing you already hold; it changes only when the broker deliberately relists the property under a new identity.

kind
enum required

The category of property. Determines which other fields are present.

Codes kinds
kind_label
i18n_string optional

The agency's own name for this category. A display hint only — never key on it, agencies rename these freely.

status
enum required

Availability of the listing. Kept for compatibility and always consistent with system_status (active is published as available). Sold and archived properties are never present in the feed at all.

Codes status
system_status
enum optional

The listing's lifecycle stage as recorded in the agency's CRM. Present on every listing in documents generated since it was introduced; documents written earlier may lack it. A feed only ever contains active and reserved listings — sold and archive are defined so a portal can interpret a listing disappearing, never because a listing appears with them.

Codes system_status
updated_at
datetime required

When this listing last changed, ISO 8601 with offset. Diff against your stored copy to find what moved since the last fetch.

title
string recommended

Short human-readable headline for the listing.

descriptions
array recommended

Free-text descriptions, one entry per language. Plain text; no markup.

descriptions.locale
string

ISO 639-1 language code, e.g. "lt" or "en".

descriptions.content
string

The description body.

Offer

sale
object conditional

Present if and only if the property is for sale. Its presence IS the for-sale flag; there is no separate boolean.

sale.price
money

Asking price.

sale.price_per_m2
money

Asking price divided by area_m2, as quoted by the agency.

rent
object conditional

Present if and only if the property is for rent. Its presence IS the for-rent flag.

rent.price
money

Rent per period.

rent.price_per_m2
money

Rent divided by area_m2, as quoted by the agency.

rent.period
enum

The unit the rent price is quoted in. Never assume monthly.

Codes rent_period

Location

location
object required

Where the property is. Keys are OMITTED, not blanked, when the agency has chosen to hide the exact location — you will never be asked to hide something we sent you.

location.precision
enum

How precisely this location is disclosed.

Codes location_precision
location.municipality
string

Municipality (savivaldybė).

location.city
string

City or settlement.

location.district
string

District or neighbourhood within the city.

location.street
string

Street name. Omitted when precision is "district".

location.building_number
string

House or building number. Omitted when precision is "district".

location.coordinates
object

WGS84 latitude and longitude. Omitted entirely when precision is "district".

location.coordinates.lat
decimal

Latitude in WGS84 decimal degrees.

location.coordinates.lon
decimal

Longitude in WGS84 decimal degrees.

JSON
"location": {
  "precision": "district",
  "municipality": "Vilniaus m. sav.",
  "city": "Vilnius",
  "district": "Žirmūnai"
}

Example. With precision set to "district", street, building_number and coordinates are omitted, not blanked.

Size

area_m2
decimal · m² required

Usable floor area in SQUARE METRES. Always m², regardless of the unit the agency quotes internally.

rooms
integer recommended

Number of rooms.

floor
integer recommended

Which floor the unit is on. Negative values are basement levels. Absent when the floor is not stated.

floors_total
integer recommended

Number of floors in the building.

land_area_m2
decimal · m² recommended

Area of the land parcel belonging to a house, in SQUARE METRES. For a land property the parcel area is area_m2 itself and this field is absent.

area_from_m2
decimal · m² optional

Smallest area available, in SQUARE METRES, when commercial premises can be divided into units.

area_to_m2
decimal · m² optional

Largest area available, in SQUARE METRES, when commercial premises can be divided into units.

floors_from
integer optional

Lowest floor the offered commercial premises occupy.

floors_to
integer optional

Highest floor the offered commercial premises occupy.

Building

year_built
integer recommended

Year the building was completed.

year_renovated
integer optional

Year of the most recent major renovation, if any.

building
object recommended

Properties of the building the unit sits in.

building.structure
enum

Construction type of the building.

Codes building_structure
building.form
enum

The form of house - detached, semi-detached, townhouse, homestead and so on. Present for houses only.

Codes building_form
building.heating
enum

How the unit is heated.

Codes building_heating
building.condition
enum

Fit-out and repair state of the unit.

Codes building_condition
building.energy_class
enum

EU energy performance certificate class.

Codes energy_class
building.windows
enum

Window frame material.

Codes window_type
features
enum_set optional

Amenities present. An unlisted code means "not stated", not "absent".

Codes features
purposes
enum_set recommended

Permitted or intended uses. Present for land and commercial premises, which routinely carry more than one.

Codes purposes

Garage

garage
object optional

Garage detail. Present for a garage, and for a house that includes one. Note this is a FIELD named garage; the property kind of the same name is separate.

garage.type
enum

Construction type of the garage.

Codes garage_type
garage.cars_fit
integer

How many cars fit.

Media

media
array recommended

Photos, video and virtual tours, in the order the agency arranged them.

media.type
enum

What kind of media this is.

Codes media_type
media.url
string

Absolute URL.

media.position
integer

Display order for photos, ascending.

media.provider
string

Hosting provider for a virtual tour, e.g. "matterport".

Contact

contact
object required

The agent handling this listing. Always an agent, never the property owner.

contact.name
string

Agent's full name.

contact.email
string

Agent's email address.

contact.phone
string

Agent's phone number in international format.

Išmanus duomenų valdymo įrankis, padedantis šiuolaikiškoms kompanijoms efektyviai planuoti, parduoti ir administruoti nekilnojamąjį turtą.

© 2026 TopBroker

Funkcijos

Produktas

Kodėl TopBroker

Įmonė