Apartment

A Schema.org Type

Thing > Place > Accommodation > Apartment

[more...]

Canonical URL: https://schema.org/Apartment
Check for open issues.

An apartment (in American English) or flat (in British English) is a self-contained housing unit (a type of residential real estate) that occupies only part of a building (source: Wikipedia, the free encyclopedia, see http://en.wikipedia.org/wiki/Apartment).

Property	Expected Type	Description
Properties from Apartment
`numberOfRooms`	Number or QuantitativeValue	The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business. Typical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue.
`occupancy`	QuantitativeValue	The allowed total occupancy for the accommodation in persons (including infants etc). For individual accommodations, this is not necessarily the legal maximum but defines the permitted usage as per the contractual agreement (e.g. a double room used by a single person). Typical unit code(s): C62 for person.
Properties from Accommodation
`accommodationCategory`	Text	Category of an Accommodation, following real estate conventions, e.g. RESO (see PropertySubType, and PropertyType fields for suggested values).
`accommodationFloorPlan`	FloorPlan	A floorplan of some Accommodation.
`amenityFeature`	LocationFeatureSpecification	An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
`bed`	BedDetails or BedType or Text	The type of bed or beds included in the accommodation. For the single case of just one bed of a certain type, you use bed directly with a text. If you want to indicate the quantity of a certain kind of bed, use an instance of BedDetails. For more detailed information, use the amenityFeature property.
`floorLevel`	Text	The floor level for an Accommodation in a multi-storey building. Since counting systems vary internationally, the local system should be used where possible.
`floorSize`	QuantitativeValue	The size of the accommodation, e.g. in square meter or squarefoot. Typical unit code(s): MTK for square meter, FTK for square foot, or YDK for square yard.
`leaseLength`	Duration or QuantitativeValue	Length of the lease for some Accommodation, either particular to some Offer or in some cases intrinsic to the property.
`numberOfBathroomsTotal`	Integer	The total integer number of bathrooms in some Accommodation, following real estate conventions as documented in RESO: "The simple sum of the number of bathrooms. For example for a property with two Full Bathrooms and one Half Bathroom, the Bathrooms Total Integer will be 3.". See also numberOfRooms.
`numberOfBedrooms`	Number or QuantitativeValue	The total integer number of bedrooms in a some Accommodation, ApartmentComplex or FloorPlan.
`numberOfFullBathrooms`	Number	Number of full bathrooms - The total number of full and ¾ bathrooms in an Accommodation. This corresponds to the BathroomsFull field in RESO.
`numberOfPartialBathrooms`	Number	Number of partial bathrooms - The total number of half and ¼ bathrooms in an Accommodation. This corresponds to the BathroomsPartial field in RESO.
`numberOfRooms`	Number or QuantitativeValue	The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business. Typical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue.
`occupancy`	QuantitativeValue	The allowed total occupancy for the accommodation in persons (including infants etc). For individual accommodations, this is not necessarily the legal maximum but defines the permitted usage as per the contractual agreement (e.g. a double room used by a single person). Typical unit code(s): C62 for person.
`permittedUsage`	Text	Indications regarding the permitted usage of the accommodation.
`petsAllowed`	Boolean or Text	Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value.
`tourBookingPage`	URL	A page providing information on how to book a tour of some Place, such as an Accommodation or ApartmentComplex in a real estate setting, as well as other kinds of tours as appropriate.
`yearBuilt`	Number	The year an Accommodation was constructed. This corresponds to the YearBuilt field in RESO.
Properties from Place
`additionalProperty`	PropertyValue	A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org. Note: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism.
`address`	PostalAddress or Text	Physical address of the item.
`aggregateRating`	AggregateRating	The overall rating, based on a collection of reviews or ratings, of the item.
`amenityFeature`	LocationFeatureSpecification	An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs.
`branchCode`	Text	A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs. For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch.
`containedInPlace`	Place	The basic containment relation between a place and one that contains it. Supersedes containedIn. Inverse property: containsPlace
`containsPlace`	Place	The basic containment relation between a place and another that it contains. Inverse property: containedInPlace
`event`	Event	Upcoming or past event associated with this place, organization, or action. Supersedes events.
`faxNumber`	Text	The fax number.
`geo`	GeoCoordinates or GeoShape	The geo coordinates of the place.
`geoContains`	GeospatialGeometry or Place	Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in DE-9IM.
`geoCoveredBy`	GeospatialGeometry or Place	Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in DE-9IM.
`geoCovers`	GeospatialGeometry or Place	Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in DE-9IM.
`geoCrosses`	GeospatialGeometry or Place	Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in DE-9IM.
`geoDisjoint`	GeospatialGeometry or Place	Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in DE-9IM.)
`geoEquals`	GeospatialGeometry or Place	Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in DE-9IM. "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship).
`geoIntersects`	GeospatialGeometry or Place	Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in DE-9IM.
`geoOverlaps`	GeospatialGeometry or Place	Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in DE-9IM.
`geoTouches`	GeospatialGeometry or Place	Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in DE-9IM.)
`geoWithin`	GeospatialGeometry or Place	Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in DE-9IM.
`globalLocationNumber`	Text	The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations.
`hasCertification`	Certification	Certification information about a product, organization, service, place, or person.
`hasDriveThroughService`	Boolean	Indicates whether some facility (e.g. FoodEstablishment, CovidTestingFacility) offers a service that can be used by driving through in a car. In the case of CovidTestingFacility such facilities could potentially help with social distancing from other potentially-infected users.
`hasGS1DigitalLink`	URL	The GS1 digital link associated with the object. This URL should conform to the particular requirements of digital links. The link should only contain the Application Identifiers (AIs) that are relevant for the entity being annotated, for instance a Product or an Organization, and for the correct granularity. In particular, for products: A Digital Link that contains a serial number (AI `21`) should only be present on instances of IndividualProduct A Digital Link that contains a lot number (AI `10`) should be annotated as SomeProduct if only products from that lot are sold, or IndividualProduct if there is only a specific product. A Digital Link that contains a global model number (AI `8013`) should be attached to a Product or a ProductModel. Other item types should be adapted similarly.
`hasMap`	Map or URL	A URL to a map of the place. Supersedes map, maps.
`isAccessibleForFree`	Boolean	A flag to signal that the item, event, or place is accessible for free. Supersedes free.
`isicV4`	Text	The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place.
`keywords`	DefinedTerm or Text or URL	Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
`latitude`	Number or Text	The latitude of a location. For example `37.42242` (WGS 84).
`logo`	ImageObject or URL	An associated logo.
`longitude`	Number or Text	The longitude of a location. For example `-122.08585` (WGS 84).
`maximumAttendeeCapacity`	Integer	The total number of individuals that may attend an event or venue.
`openingHoursSpecification`	OpeningHoursSpecification	The opening hours of a certain place.
`photo`	ImageObject or Photograph	A photograph of this place. Supersedes photos.
`publicAccess`	Boolean	A flag to signal that the Place is open to public visitors. If this property is omitted there is no assumed default boolean value.
`review`	Review	A review of the item. Supersedes reviews.
`slogan`	Text	A slogan or motto associated with the item.
`smokingAllowed`	Boolean	Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
`specialOpeningHoursSpecification`	OpeningHoursSpecification	The special opening hours of a certain place. Use this to explicitly override general opening hours brought in scope by openingHoursSpecification or openingHours.
`telephone`	Text	The telephone number.
`tourBookingPage`	URL	A page providing information on how to book a tour of some Place, such as an Accommodation or ApartmentComplex in a real estate setting, as well as other kinds of tours as appropriate.
Properties from Thing
`additionalType`	Text or URL	An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
`alternateName`	Text	An alias for the item.
`description`	Text or TextObject	A description of the item.
`disambiguatingDescription`	Text	A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
`identifier`	PropertyValue or Text or URL	The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
`image`	ImageObject or URL	An image of the item. This can be a URL or a fully described ImageObject.
`mainEntityOfPage`	CreativeWork or URL	Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. Inverse property: mainEntity
`name`	Text	The name of the item.
`potentialAction`	Action	Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
`sameAs`	URL	URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
`subjectOf`	CreativeWork or Event	A CreativeWork or Event about this Thing. Inverse property: about
`url`	URL	URL of the item.

Acknowledgements

STI Accommodation Ontology

This element is based on the STI Accommodation Ontology, see http://ontologies.sti-innsbruck.at/acco/ns.html for details. Many class and property definitions are inspired by or based on abstracts from Wikipedia, the free encyclopedia.

Examples

Example 1

No Markup JSON-LD Structure

Example notes or example HTML without markup.

Apartment example with min and max occupancy limits and floor size of 81 square meters(JSON-LD only).

Example encoded as JSON-LD in a HTML script tag.

<script type="application/ld+json">
    {
        "@context": "https://schema.org",
        "@type": "Apartment",
        "name": "227  Lynn Street - Medium apartment",
        "description": "Great downtown accommodation for family or group of friends.",
        "numberOfRooms": 3,
        "occupancy": {
            "@type": "QuantitativeValue",
            "minValue": 1,
            "maxValue": 4
        },
        "floorLevel": "5",
        "floorSize": {
            "@type": "QuantitativeValue",
            "value": 81,
            "unitCode": "MTK"
        },
        "numberOfBathroomsTotal": 2,
        "numberOfBedrooms": 2,
        "petsAllowed": true,
        "tourBookingPage": "http://example.com",
        "yearBuilt": 2005,
        "telephone": "+1-617-312-9783",
        "address": {
            "@type": "PostalAddress",
            "addressCountry": "US",
            "addressLocality": "West Roxbury",
            "addressRegion": "MA",
            "postalCode": "02132",
            "streetAddress": "227  Lynn Street"
        },
        "latitude": 42.2742,
        "longitude": -71.1430
    }
</script>

Structured representation of the JSON-LD example.