Public property preview — no key required

Unauthenticated, cacheable preview of a single property: the landing target of the per-property rel=alternate links published on bluepillow.com, and the most-fetched surface of this API. An agent following one of those links must never hit an authentication wall, so this endpoint answers without a key and returns a lean static record — identity, rating, star class, operator coverage, thumbnail and web URL — plus a machine-readable upgrade block describing how to reach the full toolset. Deliberately NO prices and NO availability: live data belongs to the authenticated tier, and the upgrade block says so explicitly. Rate limits are per IP and unauthenticated: 120 requests/minute (240 for recognized crawlers) and 60000/day. A 429 carries Retry-After and the same upgrade pitch — an authenticated key raises the ceiling to 60000/day.

get/properties/{property_id}/preview

Request

  • Base URL: https://api.b2a.bluepillow.com/v1
  • URL: https://api.b2a.bluepillow.com/v1/properties/{property_id}/preview
  • Auth: none required

Path parameters

property_idstring required

Query parameters

srcstring

Short provenance tag, echoed into our own traffic counters so we can tell which channel sent the fetch. Free-form, max 32 chars.

Response

Preview record. Cache-Control is public, max-age=3600; the server also caches upstream for 6 hours, so two fetches of the same property within the window are identical.

idstring required
namestring required
property_typestring required
ratingnumber nullable

0-5 scale, coarse in practice (upstream scores arrive rounded). Read it together with rating_count.

rating_countinteger nullable
starsinteger nullable
ota_coverageOTA[]
thumbnail_urlstring uri nullable
web_urlstring uri nullable

Changes

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