Holidu Property Description API Documentation Get the full description text of a property split in paragraphs, with the language and a flag for machine translation.
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": {
"market": "com",
"offer_id": "63793870",
"description": {
"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 ",
"description_unit": null,
"description_parent": null,
"outside_description": "The Clignancourt district, located in the 18th arrondissement of Paris, is known for its famous flea market, the Puces de Saint-Ouen. Explore this giant market ",
"is_translated_with_ai": false,
"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 you ",
"description_unit_in_paragraphs": null
}
},
"meta": {
"billable": true,
"endpoint_family": "property_description"
},
"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"
}Resource Not Found
The offer id is unknown or the property is no longer listed. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "property_description"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested Holidu resource was not found."
},
"success": false
}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_description"
},
"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.