Concepts

Response & supplier model

How a search response is shaped — results, prices, deeplinks, and the supplier map.

Every search returns results[], meta, and _links. Each results[] entry is one unified stay per property, carrying a suppliers.<name> map across Booking.com, VRBO, Expedia, and Hotels.com.

The stay

Each stay holds the property-level fields:

  • id, name, type
  • location (address, coordinates, distanceInMeters), rating, capacity, policies, media
  • url — a Stay22 deeplink carrying your aid, so the booking is tracked to you

meta carries currency, page, pageSize, total, and hasMore (plus checkin, checkout, and nights for dated searches); _links.self is the canonical URL for the request and _links.next pages forward. See Pagination.

Suppliers

The suppliers.<name> map (e.g. booking, vrbo, expedia, hotelscom) holds, per supplier:

  • id and link — a Stay22 deeplink to that supplier, carrying your aid
  • price — present only when the search ran with dates; price.total is the full-stay amount in meta.currency (divide by meta.nights for per-night)

The provider filter is optional: omit it to return all suppliers, or pass provider=booking|vrbo|expedia|hotelscom to narrow the results to one.

In clustered responses, sparse stays flow through results[] and dense areas through clusters[]; a stay never appears in both. See Clustering.

On this page