Skip to main content
GET
Read collected accommodation context
Read source room labels, explicit room measurements, advert descriptions and typed amenities where supplied. Booking.com, Agoda, Trip.com, Airbnb and VRBO have different retained fields. Unknown sections remain unavailable. Source star classifications and category scores retain their category and unknown scale; they do not become a verified or averaged guest rating. Booking.com search-offer flags remain dated source observations with bookable_offer_verified=false. Source policies and offer flags do not guarantee current cancellation terms, breakfast, room inventory or a bookable price. This retained read costs one credit, makes no source request and does not extend expiry.

Authorizations

x-api-key
string
header
required

Path Parameters

stay_id
string
required
Minimum string length: 1

Query Parameters

fields
string

Response-only comma-separated field paths relative to data items; up to 32 paths. Source requests and billing are unchanged.

Maximum string length: 4127
format
enum<string>
default:json

Response-only export format. JSON retains the envelope; CSV/NDJSON contain data records, with request/credit metadata in headers. Errors stay JSON.

Available options:
json,
csv,
ndjson

Response

Successful response; meta discloses source completeness

data
object
required
meta
object
required