Holidu Property Units API Documentation List every unit of a property that has several units, each with details, amenities, photos, price, rooms and house rules. A single-unit property returns an empty list.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
1 optional filter available.
string
Required
Holidu offer id (a number) from a search result, e.g. 63793870.
1234567890
string
Optional
Country site: com (USD), de (EUR), uk (GBP) or fr (EUR). Defaults to com. An unknown value is rejected.
US
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"units": [
{
"id": "63793870",
"usps": [
{
"id": "USP_PEOPLE",
"unit": null,
"group": "PEOPLE",
"value": 2,
"format": "NUMBER"
},
{
"id": "USP_BED_ROOM",
"unit": null,
"group": "LAYOUT",
"value": 1,
"format": "NUMBER"
}
],
"price": {
"ccy": "USD",
"daily": 107,
"total": 107,
"nights": null,
"currency": "USD",
"is_exact": false,
"discount_type": null,
"discount_amount": null,
"discount_percentage": null,
"discount_description": null,
"strike_through_daily": null,
"strike_through_total": null
},
"rooms": [
{
"id": "bed_1",
"type": "BEDROOM",
"amenities": [
[]
],
"room_index": 0
}
],
"photos": [
{
"tags": [
"LIVING_ROOM",
"INSIDE"
],
"large": "https://img.holidu.com/images/0c36dc2e-0ccb-4794-8118-a6665a49d01c/l.jpg",
"medium": "https://img.holidu.com/images/0c36dc2e-0ccb-4794-8118-a6665a49d01c/m.jpg",
"overlay": false,
"high_res": "https://img.holidu.com/images/0c36dc2e-0ccb-4794-8118-a6665a49d01c/hr.jpg",
"thumbnail": "https://img.holidu.com/images/0c36dc2e-0ccb-4794-8118-a6665a49d01c/t.jpg"
},
{
"tags": [
"LIVING_ROOM",
"INSIDE"
],
"large": "https://img.holidu.com/images/dda288b4-16cb-4662-b02e-dd35cd34150e/l.jpg",
"medium": "https://img.holidu.com/images/dda288b4-16cb-4662-b02e-dd35cd34150e/m.jpg",
"overlay": false,
"high_res": "https://img.holidu.com/images/dda288b4-16cb-4662-b02e-dd35cd34150e/hr.jpg",
"thumbnail": "https://img.holidu.com/images/dda288b4-16cb-4662-b02e-dd35cd34150e/t.jpg"
}
],
"details": {
"area": {
"unit": "UNIT_SF",
"value": 237
},
"name": "GuestReady - Cozy Parisian Escape for 2",
"original": null,
"bed_types": [
"BED_QUEEN"
],
"long_name": "Vacation apartment for 2 people",
"unit_name": null,
"pets_count": null,
"short_name": [
"237 ft\u00b2",
"Apartment"
],
"description": "We are GuestReady, a property manager, and we want to ensure your stay will be as smooth and comfortable as possible. We are available 24/7 should you need any ",
"guests_count": 2,
"apartment_type": "APARTMENT",
"bedrooms_count": 1,
"short_description": null,
"apartment_type_title": "Apartment",
"description_language": "EN",
"out_side_description": null,
"alternative_long_name": null,
"description_in_paragraphs": "We are GuestReady, a property manager, and we want to ensure your stay will be as smooth and comfortable as possible. <br/><br/> We are available 24/7 should yo",
"is_cached_machine_translation": false
},
"usps_v2": [
{
"id": "USP_PEOPLE",
"unit": null,
"group": "PEOPLE",
"value": 2,
"format": "NUMBER"
},
{
"id": "USP_BED_ROOM",
"unit": null,
"group": "LAYOUT",
"value": 1,
"format": "NUMBER"
}
],
"sou_tags": [
{
"id": "ALMOST_BOOKED_OUT",
"value": "<strong>Almost booked out.</strong> We recommend you book soon."
}
],
"amenities": {
"AMENITIES_MULTI_UNIT": [
{
"id": "INTERNET",
"group": "INTERNET",
"value": "Internet",
"format": "STRING"
}
]
},
"available": null,
"house_rules": {
"checkin": "From 3:00\u202fPM to 10:00\u202fPM",
"checkout": "Until 11:00\u202fAM",
"house_rules": [
{
"type": "PETS",
"value": "Pets not allowed",
"is_allowed": false
},
{
"type": "SMOKING",
"value": "Smoking not allowed",
"is_allowed": false
}
]
},
"amenities_v2": {
"AMENITY_KITCHEN": [
{
"id": "KITCHEN",
"group": "KITCHEN",
"value": "Kitchen",
"format": "STRING"
},
{
"id": "MICROWAVE",
"group": "MICROWAVE",
"value": "Microwave",
"format": "STRING"
}
],
"AMENITY_BATHROOM": [
{
"id": "HAIRDRYER",
"group": "HAIRDRYER",
"value": "Hairdryer",
"format": "STRING"
},
{
"id": "SHOWER",
"group": "SHOWER",
"value": "Shower",
"format": "STRING"
}
],
"AMENITY_ENTERTAINMENT": [
{
"id": "INTERNET_WIFI",
"group": "INTERNET",
"value": "Wi-Fi",
"format": "STRING"
},
{
"id": "INTERNET",
"group": "INTERNET",
"value": "Internet",
"format": "STRING"
}
],
"AMENITY_BEDROOM_AND_LAUNDRY": [
{
"id": "WASHER",
"group": "WASHER",
"value": "Washing machine",
"format": "STRING"
},
{
"id": "BEDLINEN",
"group": "BEDLINEN",
"value": "Bedlinen",
"format": "STRING"
}
],
"AMENITY_HEATING_AND_COOLING": [
{
"id": "HEATING",
"group": "HEATING",
"value": "Heating",
"format": "STRING"
}
],
"AMENITY_HEALTHCARE_AND_SAFETY": [
{
"id": "SMOKE_DETECTOR",
"group": "SMOKE_DETECTOR",
"value": "Smoke detector",
"format": "STRING"
}
],
"AMENITY_PROPERTY_FEATURES_AND_PARKING": [
{
"id": "ENTRANCE_PRIVATE",
"group": "ENTRANCE_PRIVATE",
"value": "Private entrance",
"format": "STRING"
}
]
},
"good_to_know": [
{
"id": "SUITABLE_CHILDREN",
"value": "Suitable for children"
}
],
"routing_type": "CHECKOUT",
"amenities_bed": [],
"detailed_price": null,
"characteristics": [
{
"id": "PETS",
"unit": null,
"value": "no",
"format": "STRING"
},
{
"id": "SMOKING",
"unit": null,
"value": "no",
"format": "STRING"
}
],
"capacity_rules_v2": {
"kids": null,
"adults": {
"label": "over 0 years of age",
"max_age": null,
"min_age": 0,
"max_number": 2,
"age_requested": false
},
"min_adults": 1
},
"unavailable_cause": null,
"essential_amenities": [
{
"id": "INTERNET_WIFI",
"group": "INTERNET",
"value": "Wi-Fi",
"format": "STRING"
},
{
"id": "TV",
"group": "TV",
"value": "TV",
"format": "STRING"
}
],
"enriched_description": null,
"is_free_cancellation": true,
"default_guest_selection": {
"kids": 0,
"adults": 2
},
"supports_parent_unit_structure": false
}
],
"market": "com",
"offer_id": "63793870",
"unit_count": 3
},
"meta": {
"billable": true,
"endpoint_family": "property_multiunit"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A required query parameter is missing or invalid. This response is not billable.
{
"errors": {
"market": [
"The market is one of com, de, uk, fr."
]
},
"message": "The request validation failed"
}Service Unavailable
Holidu could not be reached, answered with an unexpected shape or returned a result that does not match the request. This response is not billable. Retry later.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "property_multiunit"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "The Holidu API is temporarily unavailable. Please retry."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.