Zyte Data real estate schema v1.0#

Documentation Powered by Redocly

Standard Real Estate Schema (1.0)

Standard Real Estate Schema used in Zyte offering. Covers the typical set of attributes present in real estate offers published on-line.

Standard Real Estate Schema v1.0

Responses

Response Schema: application/json
url
required
string (URL)

URL with real estate data.

Array of objects or objects[ items ]

The list of breadcrumbs with URL and optional category name.

At least one of "name" or "url" is required. All levels of breadcrumbs should be included (e.g. "Home" or article title, if they are included in the breadcrumbs).

Array
Any of
string

Breadcrumb name or category name.

string (URL)

Breadcrumb URL.

realEstateId
string

The identifier of the real estate, usually assigned by the seller and unique within a website, similar to product SKU.

name
string

The name of the real estate.

datePublished
string

Publication date of the real estate offer.

Format: ISO 8601 format: "YYYY-MM-DDThh:mm:ssZ".

With timezone, if available.

datePublishedRaw
string

Same date as datePublished, but before parsing/normalization, i.e. as it appears on the website.

description
string

The description of the real estate.

Format:

  • trimmed (no whitespace at the beginning or the end of the description string),

  • line breaks included,

  • no length limit,

  • no normalization of Unicode characters,

  • no concatenation of description from different parts of the page.

object (Image)

The details of the main image of the real estate.

url
required
string (URL)

A URL of an image

Array of objects (Image) [ items ]

A list of URL values of all images of the real estate.

Array
url
required
string (URL)

A URL of an image

object

The details of the address of the real estate.

streetAddress
string

The street address of the real estate.

addressCity
string

The city the real estate is located in.

addressLocality
string

The locality to which the real estate belongs.

addressRegion
string

The region of the real estate location.

addressCountry
string

The country the real estate is located in. The country name or the two-letter ISO 3166-1 alpha-2 country code (https://en.wikipedia.org/wiki/ISO_3166-1).

postalCode
string

The numerical part of the postal code of the address.

postalCodeAux
string

The auxiliary part of the postal code. It may include a state abbreviation or town name, depending on local standards.

addressRaw
string

The raw address information, as it appears on the website.

latitude
number [ -90 .. 90 ]

Geographical latitude of the real estate location.

longitude
number [ -180 .. 180 ]

Geographical longitude of the real estate location.

Array of objects[ items ]

A structured area data of the real estate.

Array
value
string

A float number with the area of the real estate.

unitCode
string
Enum: "SQMT" "SQFT" "ACRE"

Takes one of the values: SQMT, SQFT, ACRE.

Unit of the area, one of:

  • SQMT (square meter),
  • SQFT (square foot),
  • ACRE (acre).
areaType
string
Enum: "LOT" "FLOOR"

Area generally can be applied to 2 scopes: LOT area (total area of property) and FLOOR area (area inside the building).

Takes one of the values: LOT, FLOOR.

raw
string

Area in the raw format, as it appears on the website.

numberOfBathroomsTotal
integer

The total number of bathrooms in the real estate.

numberOfFullBathrooms
integer

The number of full bathrooms in the real estate.

numberOfPartialBathrooms
integer

The number of half bathrooms in the real estate.

numberOfBedrooms
integer

The number of bedrooms in the real estate.

numberOfRooms
integer

The number of rooms (excluding bathrooms and closets) of the real estate.

tradeType
string
Enum: "BuyAction" "RentAction"

Type of a trade action: buying or renting. Takes one of the values: RentAction, BuyAction.

price
string

The offer price of the real estate.

rentalPeriod
string

The rental period to which the rental price applies, only available in case of rental. Usually daily, weekly, monthly, quarterly, yearly.

currencyRaw
string

Currency associated with the price, as appears on the page (no post-processing).

currency
string

The currency associated with the price, in ISO 4217 standard (e.g. USD).

Array of objects (A generic name:value field) [ items ]

A name-value pair field holding information pertaining to specific features. Usually in a form of a specification table or freeform specification list.

This field is skipped if additional requests are required for it to be extracted.

Array
name
required
string

Name of additional property.

value
string

Value of additional property.

propertyType
string

Type of the property, e.g. flat, house, land.

yearBuilt
integer

The year the real estate was constructed in.

virtualTourUrl
string (URL)

URL of virtual tour of the real estate.

object

Contains metadata about the data extraction process.

dateDownloaded
string

The timestamp at which the real estate data was downloaded.

Timezone: UTC.

Format: ISO 8601 format: "YYYY-MM-DDThh:mm:ssZ".

probability
number [ 0 .. 1 ]

The probability that the page belongs to certain data type.

Between 0 and 1.0. Always 1.0 for manual extraction.

Response samples

Content type
application/json
{
}