Browse documentation
GET

Hilton Rooms API - Starting Cash Rates

Get dated room types with one starting cash offer per room type.

Overview

Get available Hilton room types and starting cash offers for a dated stay with StayAPI. Compare USD or GBP stay totals, room metadata, and published tax flags.

Scope

Use hotel_code from Search or URL to ID. One room with no children is fixed. pricing_scope is starting_rates: this is not a full rate-plan list, reward or points inventory, or booking quote. Amounts and availability can change before booking.

Authentication

Send your StayAPI key in the X-API-Key header. Successful requests return JSON; failures use RFC 7807 Problem Details.

Endpoint URL

GET https://api.stayapi.com/v1/hilton/rooms

Parameters

Parameter Type Required Description
hotel_code string Required Exactly seven letters or digits, from Search or URL to ID. Returned uppercase.
check_in date Required Valid YYYY-MM-DD date, today or later.
check_out date Required Valid YYYY-MM-DD date after check_in.
adults integer Optional 1 to 4 adults. Default: 2. One room and no children.
currency enum Optional USD or GBP display currency. Default: USD.

Response schema

Field Type Description
success / hotel_code / check_in / check_out / adults mixed Successful request and normalized stay context.
currency / native_currency string Requested display currency and Hilton source currency, respectively.
pricing_scope string Always starting_rates: one starting cash offer per room type.
total integer Number of available room types returned, not a room count.
room_types array Available room code, name, description, nullable occupancy, beds, accessible and suite flags, photos, and rates.
room_types[].rates[].rate_plan_code string Identifier of the starting cash offer.
room_types[].rates[].per_night number Average nightly display amount for the stay.
room_types[].rates[].total / total_formatted number / string Exact published stay total. Do not multiply the rounded per_night amount to calculate it.
room_types[].rates[].currency string Display currency of the offer.
room_types[].rates[].includes_taxes_and_service_charges boolean Published tax-and-service-charge indicator; does not establish treatment of every possible property fee.
room_types[].rates[].rate_changes_during_stay boolean Whether the published rate changes during the stay.

Errors and limitations

Errors use RFC 7807 Problem Details with provider: "hilton" and a correlation id.

  • 400 INVALID_INPUT: invalid search form, hotel code, dates, occupancy, or currency.
  • 400 INVALID_URL: supply a canonical HTTPS Hilton hotel or reservation rooms URL.
  • 422: a required parameter is missing or a typed parameter is outside its declared contract.
  • 502 UPSTREAM_ERROR: Hilton data could not be retrieved or verified. An unverified sold-out rooms result also returns an error.
  • 504: the request timed out.
  • 503: service temporarily unavailable; honor Retry-After when supplied.

Related Hilton endpoints