Types

PropertyListing

Example

{
  "type": "PropertyListing",
  "addressCountry": "CA",
  "addressLocality": "Gotham City",
  "addressRegion": "NJ",
  "brokerAttribution": "homes@opendoor.com",
  "buyerAgent": {
    "email": "butch.byers@example.com",
    "identifier": {
      "agentKey": "xxxx"
    },
    "name": "Butch Byers",
    "type": "RealEstateAgent"
  },
  "buyerOffice": {
    "email": "gcr@example.com",
    "identifier": {
      "officeKey": "grc1"
    },
    "name": "Gotham City Real Estate",
    "type": "RealEstateOffice"
  },
  "closeDate": "2019-08-24T14:15:22Z",
  "image": [
    {
      "type": "ImageObject",
      "@id": "http://example.com",
      "id": "http://user.example.com/public/logo/image.jpg",
      "name": "image.jpg",
      "encodingFormat": "image/jpeg",
      "about": "http://user.example.com/profile/card#me",
      "url": "http://user.example.com/public/profile/image.jpg"
    }
  ],
  "internetAddressDisplayYN": "Y",
  "latitude": 40.75,
  "listingAgent": {
    "type": "RealEstateAgent",
    "name": "Lori Listagent",
    "telephone": "1-252-574-0160",
    "email": "lorilistagent@example.com"
  },
  "listingContractDate": "2019-08-24T14:15:22Z",
  "listingId": "GOTHAM-MLS+12345",
  "listingOffice": {
    "name": "Gotham City Real Estate",
    "type": "RealEstateOffice"
  },
  "listingOriginatingSystem": {
    "identifier": {
      "bhhsmlsid": "xxxx",
      "resoouid": "not-yet-available"
    },
    "name": "MLSListings",
    "type": "MultipleListingService"
  },
  "listingPrice": {
    "type": "PriceSpecification",
    "price": 75000,
    "priceCurrency": "USD"
  },
  "listingStatus": "Active",
  "livingArea": {
    "type": "QuantitativeValue",
    "unitCode": "SqFt",
    "unitText": "Square Feet",
    "value": 1500
  },
  "longitude": 73.98,
  "lotSize": {
    "type": "QuantitativeValue",
    "unitCode": "AC",
    "unitText": "Acres",
    "value": 0.5
  },
  "modificationTimestamp": "2022-11-17T00:00:00",
  "numberOfBathrooms": "2",
  "numberOfBedrooms": "3",
  "numberOfRooms": "7",
  "originatingSystemKey": 12345,
  "originatingSystemName": "GOTHAM-MLS",
  "postalCode": "10010",
  "propertySubType": "ApartmentPropertyType",
  "propertyType": "RESI",
  "purchaseContractDate": "2019-08-24T14:15:22Z",
  "stories": 2,
  "streetAddress": "1007 Mountain Gate Rd",
  "universalPropertyId": "US-04015-N-R-11022331-N",
  "url": "https://www.example.com/homedetails/1007-Mountain-Gate-Rd-Gotham-City-Gotham/10007",
  "yearBuilt": 1988
}

Schema

NameTypeDescription
(root)objecta real estate property listed for sale
typestringallowed ("PropertyListing")
addressCountrystringallowed ("CA", "DE", "GR", "IN", "IT", "MX", "PE", "PT", "ES", "AE", "GB", "US") two-letter ISO 3166-1 alpha-2 country code
addressLocalitystringCity, Township. <= 50 characters
addressRegionstringabbreviated state or province
brokerAttributionstringBroker Attribution can be an email or phone or any text.
buyerAgentobjectthe buyer's RealEstateAgent
buyerOfficeobjectthe buyer's RealEstateOffice
closeDatestringWith for-sale listings, the date the purchase agreement was fulfilled. With lease listings, the date the requirements were fulfilled, such as contract and/or deposit. format (date-time)
imagetuple<object allOf, ...optional<any>>an ImageObject or URI reference to an image on the web.
image.0 (index)object allOf-
image.0.0 (allOf item)allOfan image, video or document availble for download
image.0.0.0 (allOf item)object-
image.0.0.0.typestringThe item type (Linked-Data @type) pattern (^[A-Z][a-zA-Z0-9]+$)
image.0.0.0.@idstringthe liked data uri for the Thing format (uri)
image.0.0.0 (property names)-pattern (^[a-z@$][a-zA-Z0-9-_]+$)
image.0.0.1 (allOf item)--
image.0.0.1.typestringallowed ("MediaObject", "ImageObject", "DigitalDocument")
image.0.0.1.idstringthe URL to access the item. format (uri)
image.0.0.1.namestringthe file name of the object.
image.0.0.1.encodingFormatstringMIME type
image.0.0.1.aboutstringURI to the subject of the image or logo format (uri)
image.0.0.1.urlstringURL of the image content format (uri)
image.0.1 (allOf item)--
image.0.1.typestringallowed ("ImageObject")
image.0.1.idany-
image.0.1.nameany-
image.0.1.encodingFormatany-
internetAddressDisplayYNstringallowed ("Y", "N")
latitudenumberThe latitude of a location.
listingAgentobjectthe agent/broker representing the seller in a real estate transaction
listingContractDatestringThe effective date of the agreement between the seller and the seller's broker. format (date-time)
listingIdstringthe local identifier for the listing
listingOfficeobjectthe listing office
listingOriginatingSystemobjectThe place where the item is originally input by the user.
listingPriceobject-
listingStatusstringallowed ("Active", "Pending", "Sold", "Canceled", "Prelisted", "OffMarket", "Private")
livingAreaobjectproperty indoor space
longitudenumberThe longitude of a location.
lotSizeobjectoutdoor space minValue, maxValue
modificationTimestampstringThe date when the listing was last modified. format (date-time)
numberOfBathroomsstringthe number of bathrooms
numberOfBedroomsstringthe number of bedrooms
numberOfRoomsstringthe total number of rooms in the building
originatingSystemKeystringthe listing identifier from the original MLS, aka MLSID.
originatingSystemNamestringthe name of the MLS where the listing was originally input
postalCodestringZip/Post Code <= 12 characters
propertySubTypestringallowed ("ApartmentPropertyType", "BoatSlipPropertyType", "CabinPropertyType", "CondominiumPropertyType", "DeededParkingPropertyType", "DuplexPropertyType", "FarmPropertyType", "ManufacturedHomePropertyType", "ManufacturedOnLandPropertyType", "MobileHomePropertyType", "OwnYourOwnPropertyType", "QuadruplexPropertyType", "RanchPropertyType", "SingleFamilyPropertyType", "StockCooperativePropertyType", "TimesharePropertyType", "TownhousePropertyType", "TriplexPropertyType", "AgriculturePropertyType", "BusinessPropertyType", "HotelMotelPropertyType", "IndustrialPropertyType", "MixedUsePropertyType", "MultiFamilyPropertyType", "OfficePropertyType", "RetailPropertyType", "UnimprovedLandPropertyType", "WarehousePropertyType") RESO property sub-type (see range for allowed values)
propertyTypestringallowed ("RESI", "RLSE", "RINC", "LAND", "MOBI", "FARM", "COMS", "COML", "BUSO") RESO property type (see range for allowed values) 4 characters
purchaseContractDatestringWith for-sale listings, the date an offer was accepted and the listing was no longer on market. With lease listings this may represent a meeting of the minds to lease, but some contractual requirements are yet to be fulfilled, such as contract signing or receipt of the deposit. format (date-time)
storiesnumberhe number of floors in the property
streetAddressstringthe street address <= 75 characters
universalPropertyIdstringThe Universal Property Identifier is a unique identifier for all real property in the US and Canada. It is based on country and local identification methods and is limited to real property. For cases such as shares of real property, units, and other more granular cases, please utilize the UniversalPropertySubId.
urlstringURL of the item. format (uri)
yearBuiltnumberthe year the structure was created
Previous
ProgramMembership
Next
PropertySearch