HOME Digital Data Standard (1.0.0)

Download OpenAPI specification:

E-mail: contact@thehomeproject.eu URL: https://www.thehomeproject.eu

Introduction

The HOME Digital Data Standard is build to create a univocal way to share student housing data. It also serves as a the technical specifications document to use when creating a JSON Feed, which allows housing providers and housing intermediaries to publish their student housing offers on the HOME solution, and with that, in the Erasmus+ App.

This openapi specifications are based on this document.

Digital Data Standard

JSON Feed

HOME Digital Data Standard

Responses

Response samples

Content type

application/json

{"metadata": {"version": "0.0.1"
},
"listings": [{"id": "AZ-18-004-01-01 H",
"groupId": "AZ-18",
"listingUrl": "https://www.partnerwebsite.com/listings/uniqueid",
"lastUpdated": "2021-12-01T11:05:46.000Z",
"housingType": "apartment",
"propertyType": "private_property",
"address": {"houseNumber": "40",
"street": "Coolsingel",
"city": "Rotterdam",
"state": "South-Holland",
"postalCode": "3011 AD",
"countryCode": "NL"
},
"latitude": 9.94948,
"longitude": 48.42339,
"title": "Room in Apartment Klerkegade",
"description": "This is an example room description, should be 50 characters at least.",
"rent": {"amount": 500000
},
"securityDeposit": {"amount": 800000
},
"costs": {"administrationFee": "excluded_from_rent",
"electricity": "included_in_rent",
"gas": "included_in_rent",
"internet": "included_in_rent",
"water": "included_in_rent",
"cleaningServices": "unknown",
"otherAdditionalCosts": "not_applicable"
},
"currencyCode": "EUR",
"availability": {"startDate": "2021-10-01",
"endDate": "2026-11-30"
},
"rentalConditions": {"minimumStayMonths": 2
},
"facilities": {"furnished": "yes",
"bedroomLock": "no",
"balconyTerrace": "private",
"extraStorage": "no",
"bathroom": "shared",
"kitchen": "shared",
"commonArea": "shared",
"carParking": "no",
"bicycleParking": "shared",
"toilet": "shared",
"wheelchairAccessible": "no",
"visuallyImpairedAccessible": "yes",
"airconditioning": "yes",
"bed": "single",
"closet": "yes",
"desk": "yes",
"chair": "yes",
"dishwasher": "no",
"kitchenware": "yes",
"bath": "yes",
"shower": "no",
"dryer": "no",
"dryingRack": "yes",
"tv": "yes",
"washingMachine": "yes",
"wifi": "yes",
"heating": "yes",
"smokeAlarm": "yes",
"24hrConciergeReception": "yes",
"videoSurveillance": "no",
"elevator": "no",
"oven": "yes",
"stove": "yes",
"iron": "yes",
"ironBoard": "unknown",
"sportsFacilities": "no",
"pool": "no",
"gameRoom": "no",
"sharedStudyArea": "unknown",
"microwave": "no",
"bedLinen": "unknown",
"pillowDuvet": "unknown",
"towels": "yes"
},
"rules": {"animals": "not_allowed",
"playingMusic": "discussable",
"smoking": "outsideOnly",
"couples": "allowed",
"overnightVisitors": "allowed"
},
"media": [{"type": "image_raw",
"url": "https://cdn.example.com/photos/1.jpg",
"title": "living_room_image"
},
{"type": "image_raw",
"url": "https://cdn.example.com/photos/2.jpg",
"title": "bedroom_image"
},
{"type": "image_raw",
"url": "https://cdn.example.com/photos/3.jpg",
"title": "shed_image"
},
{"type": "video_raw",
"url": "https://cdn.example.com/videos/1.mp4",
"title": "walkthrough"
}
],
"maximumOccupancy": 1,
"floorNumber": "4",
"bedroomCount": 1,
"bedroomSize": 14,
"totalSize": 140,
"contractEnglishTranslation": "true",
"communicationEnglish": "true",
"bookableOnline": "true",
"internationalGuarantor": "true",
"energyLabel": "C"
},
{"id": "AB-29-024-01-03 H",
"groupId": "AB-29",
"listingUrl": "https://www.partnerwebsite.com/listings/uniqueid",
"lastUpdated": "2021-12-01T11:05:46.000Z",
"housingType": "apartment",
"propertyType": "private_property",
"address": {"houseNumber": "38",
"street": "Coolsingel",
"city": "Rotterdam",
"state": "South-Holland",
"postalCode": "3011 AD",
"countryCode": "NL"
},
"latitude": 9.94948,
"longitude": 48.42339,
"title": "Room in Apartment Klerkegade",
"description": "This is an example room description, should be 50 characters at least.",
"rent": {"amount": 450000
},
"securityDeposit": {"amount": 900000
},
"costs": {"administrationFee": "excluded_from_rent",
"electricity": "included_in_rent",
"gas": "included_in_rent",
"internet": "included_in_rent",
"water": "included_in_rent",
"cleaningServices": "included_in_rent",
"otherAdditionalCosts": "not_applicable"
},
"currencyCode": "EUR",
"availability": {"startDate": "2021-10-01",
"endDate": "2026-11-30"
},
"rentalConditions": {"minimumStayMonths": 2
},
"facilities": {"furnished": "yes",
"bedroomLock": "no",
"balconyTerrace": "private",
"extraStorage": "no",
"bathroom": "private",
"kitchen": "shared",
"commonArea": "shared",
"carParking": "no",
"bicycleParking": "shared",
"toilet": "private",
"wheelchairAccessible": "yes",
"visuallyImpairedAccessible": "yes",
"airconditioning": "yes",
"bed": "double",
"closet": "yes",
"desk": "yes",
"chair": "yes",
"dishwasher": "no",
"kitchenware": "yes",
"bath": "yes",
"shower": "no",
"dryer": "no",
"dryingRack": "yes",
"tv": "yes",
"washingMachine": "yes",
"wifi": "yes",
"heating": "yes",
"smokeAlarm": "no",
"24hrConciergeReception": "no",
"videoSurveillance": "no",
"elevator": "no",
"oven": "yes",
"stove": "yes",
"iron": "yes",
"ironBoard": "yes",
"sportsFacilities": "no",
"pool": "no",
"gameRoom": "no",
"sharedStudyArea": "unknown",
"microwave": "yes",
"bedLinen": "unknown",
"pillowDuvet": "unknown",
"towels": "yes"
},
"rules": {"animals": "not_allowed",
"playingMusic": "discussable",
"smoking": "outsideOnly",
"couples": "unknown",
"overnightVisitors": "allowed"
},
"media": [{"type": "image_raw",
"url": "https://cdn.example.com/photos/1.jpg",
"title": "living_room_image"
},
{"type": "image_raw",
"url": "https://cdn.example.com/photos/2.jpg",
"title": "bedroom_image"
},
{"type": "image_raw",
"url": "https://cdn.example.com/photos/3.jpg",
"title": "shed_image"
},
{"type": "video_raw",
"url": "https://cdn.example.com/videos/1.mp4",
"title": "walkthrough"
}
],
"maximumOccupancy": 1,
"floorNumber": "4",
"bedroomCount": 1,
"bedroomSize": 14,
"totalSize": 140,
"contractEnglishTranslation": "true",
"communicationEnglish": "true",
"bookableOnline": "true",
"internationalGuarantor": "true",
"energyLabel": "A"
}
],
"pagination": {"page": 1,
"size": 4,
"totalPages": 1,
"totalListings": 4
}
}