Get canonical property record

get/properties/{property_id}

Request

  • Base URL: https://api.b2a.bluepillow.com/v1
  • URL: https://api.b2a.bluepillow.com/v1/properties/{property_id}
  • Auth: HTTP bearer

Path parameters

property_idstring required

Query parameters

includestring

Comma-separated enrichments: reviews_aggregate (score + total count + per-OTA distribution), reviews_sample (up to 5 recent review texts), reviews_extended (up to 20 recent review texts; supersedes reviews_sample). Review texts carry a reviews_meta block declaring the deliberate cap, and are returned only when no dates are provided.

user_countrystring

User's country (ISO-3166 alpha-2). Drives the booking-link locale and, when currency is omitted, the pricing currency. Defaults to US.

languagestring
currencystring

Pricing currency (ISO-4217) of the returned offers, asked of the booking sources directly. When omitted, derived from user_country; defaults to USD.

Headers

B2A-Versionstring date

Response

Property found

idstring required
namestring required
brandstring nullable
chainstring nullable
property_type'hotel' | 'aparthotel' | 'apartment' | 'villa' | 'bnb' | 'hostel' | 'resort' required
ratingnumber required
starsinteger nullable
amenitiesstring[] required
web_urlstring nullable

BluePillow property-page URL with the caller's search context (check-in/out, language, currency, party size) baked into query params. Links directly to the BluePillow listing page, not an OTA. None when the search context is too sparse to build a meaningful URL (e.g. single-property lookup without dates).

descriptionstring nullable

Free-text property description from the canonical AccomodationIndex doc. Populated by the single-property endpoint; null when not available or on the search path.

ota_coverageOTA[] required
availability_status'available' | 'unavailable' | 'unknown'

Live availability state: available = BP confirmed bookable rooms; unavailable = BP reported no rooms for the requested dates; unknown = dates not provided or live fan-out was skipped.

Changes

No recorded changes to this operation across all 1 revision of this API.