--- title: "Get Availability" method: GET path: "/availability" --- # Get Availability `GET /availability` ## Request - Base URL: `https://rooms.aero/partnerapi` - URL: `https://rooms.aero/partnerapi/availability` - Auth: API key in header `Partner-Authorization` Bulk availability: every upcoming check-in date with a rate for a program or a set of hotels, one object per hotel, check-in date and stay length (1 to 5 nights), with the same filters as the Explore pages. Only dates retrieved within the last 21 days are returned. Use this for broad scans; use Search for an area and date range. ## Query parameters - `source` string - `hotel_id` string - `start_date` string - `end_date` string - `nights` integer - `brand` string - `category` string - `country` string - `rate_type` 'award' | 'cash' | 'any' - `room_type` 'standard' | 'suite' | 'any' - `max_points` integer - `min_cpp` number - `order_by` 'arrival_date' | 'lowest_award' | 'lowest_cash' | 'last_checked' - `include_hotel` boolean - `skip` integer - `take` integer ## Response `200` 200 - AvailabilityList: A page of availability. - `data` Availability[] - `id` string: Identifier for the availability. Use it with Get Availability Details. - `hotel_id` string: The hotel. - `hotel` Hotel: One property in one loyalty program. The same object is returned by every endpoint that mentions a hotel. - `id` string: rooms.aero's identifier for the hotel. Use it as hotel_id on the other endpoints. - `source` string: The loyalty program key. The keys are listed on the Concepts page. - `program` string: The loyalty program's display name. - `name` string: Hotel name. - `brand` string: Program-specific brand code. The Concepts page maps codes to names. - `award_category` string: Program-specific award category, for programs with an award chart. Empty otherwise. - `address` string: Street address as published by the program. - `city` string: City. - `state` string: State, province or region; may be empty. - `country` string: Country, as a display name. - `latitude` number: Latitude in decimal degrees. - `longitude` number: Longitude in decimal degrees. - `image_url` string: A representative photo, when the program publishes one. - `description` string: Short description from the program; may be empty. - `internal_id` string: The program's own property code (Hilton ctyhocn, Hyatt spirit code, Marriott property code, and so on). - `open` boolean: Whether the property is open. - `url` string: The hotel's page on rooms.aero. - `lowest_award` integer, nullable: The cheapest award, in points, seen for any upcoming date in the last two weeks. Null when none is known. Populated by Get Hotels and Search; omitted from availability rows. - `standard_award_availability_percent` integer, nullable: Share of checked upcoming dates with any award available, over standard_award_availability_window_days. Null until enough dates have been checked. - `standard_award_availability_window_days` integer, nullable: The window the percentage was measured over. - `standard_award_availability_updated_at` string, date-time, nullable: When the percentage was last recomputed. RFC 3339 timestamp. - `last_checked_at` string, date-time, nullable: When the property's rates were last retrieved. Null if never. RFC 3339 timestamp. - `created_at` string, date-time: When rooms.aero started tracking the hotel. RFC 3339 timestamp. - `updated_at` string, date-time: When the hotel record last changed. RFC 3339 timestamp. - `source` string: The loyalty program key. - `arrival_date` string: Check-in date. Formatted YYYY-MM-DD. - `departure_date` string: Check-out date. Formatted YYYY-MM-DD. - `num_nights` integer: Length of stay. - `cash_currency_code` string: ISO 4217 code for every cash cost on this object. Cash costs are in the currency's minor unit (cents) for the whole stay. - `standard_award_available` boolean: Whether a standard room was bookable with points. - `standard_award_cost` integer: Cheapest standard room award, in points. - `standard_cash_available` boolean: Whether a standard room was bookable for cash. - `standard_cash_cost` integer: Cheapest standard room cash rate, in the minor unit of cash_currency_code. - `standard_cpp` number: Cash value of each point for the standard room, in US cents, when both rates were seen; 0 otherwise. - `suite_award_available` boolean: Whether a suite was bookable with points. - `suite_award_cost` integer: Cheapest suite award, in points. - `suite_cash_available` boolean: Whether a suite was bookable for cash. - `suite_cash_cost` integer: Cheapest suite cash rate, in the minor unit of cash_currency_code. - `suite_cpp` number: Cash value of each point for the suite, in US cents; 0 when either rate is missing. - `booking_link` BookingLink: A deep link into the program's own booking flow for this stay. - `label` string: Text to show on the link. - `url` string: The booking URL. - `rooms` Room[]: Every room type seen on this date, cheapest award first. Only Get Availability Details includes rooms. - `id` string: Identifier for the room offer. - `availability_id` string: The availability this room belongs to. - `hotel_id` string: The hotel. - `source` string: The loyalty program key. - `room_code` string: The program's room type code. - `name` string: Room type name. - `description` string: Plain-text description; the program's HTML is stripped. - `image_url` string: A photo of the room type, when available. - `suite` boolean: Whether rooms.aero classifies this room as a suite. - `accessible` boolean: Whether the room is an accessible room type. - `award_cost` integer: Points for the whole stay. 0 when no award rate was offered. - `cash_cost` integer: Cash for the whole stay, in the minor unit (cents) of cash_cost_currency. 0 when no cash rate was offered. - `cash_cost_currency` string: ISO 4217 code for cash_cost. - `arrival_date` string: Check-in date. Formatted YYYY-MM-DD. - `departure_date` string: Check-out date. Formatted YYYY-MM-DD. - `num_nights` integer: Length of stay. - `last_checked_at` string, date-time: When this room offer was last seen. RFC 3339 timestamp. - `last_checked_at` string, date-time: When this date's rates were last retrieved. RFC 3339 timestamp. - `created_at` string, date-time: When this date was first seen. RFC 3339 timestamp. - `count` integer: Number of items in this response. - `has_more` boolean: Whether another page exists. - `more_url` string: URL of the next page. Omitted on the last page. ## Other responses - `400`: Invalid or missing parameter - `401`: Missing, unknown or unsubscribed credentials: missing_partner_key, bad_partner_key, bad_partner_token, invalid_scope or user_subscription_expired - `429`: Daily quota exhausted --- [API](https://skmtc.dev/seats/apis/rooms-api.md) - [All operations](https://skmtc.dev/seats/apis/rooms-api/llms.txt) - [OpenAPI document](https://skmtc.dev/seats/apis/rooms-api/revisions/e164f8ea0b28?raw)