Hotel Calendar
Hotel Award Calendar
Returns cached hotel availability and pricing for all supported dates associated with a specific AwardTool hotel. Results include cash prices, points rates, room details, estimated point values, and reservation links.
Endpoint
Request Body
Request Fields
hotel_id — AwardTool’s unique hotel identifier, such as hyatt_madel. Use the id returned by the hotel_all endpoint.
api_key — API key used to authenticate the request.
Response Fields
data — Hotel availability grouped by date. The response contains an object whose keys are dates in YYYY-MM-DD format. Each date contains an array of available rate records.
hotel_info — General information and summary statistics for the requested hotel.
hide_data — Indicates whether calendar data is hidden from the response.
status — Response status code. A value of 200 indicates success.
machine — Internal processing metadata. Clients should ignore this field.
usage — Internal usage metadata. Clients should ignore this field.
Calendar Data
Each date key within data contains an array of hotel rate records:
avail_date — Check-in date in YYYY-MM-DD format.
cash_price — Available cash price for the displayed room and rate plan.
points_rate — Points required for a one-night award stay. A value of null indicates that a points rate was not available.
point_value — Estimated redemption value in cents per point. A value of null indicates that a point value could not be calculated because no points rate was available.
rate_plan — Name of the available rate plan, such as Standard Room or Members Advance Purchase.
room_type — Room included in the displayed rate, such as 1 Queen Bed.
created_at — Date and time when AwardTool collected the rate, in ISO 8601 format.
res_link — Hotel booking link populated with the applicable check-in and checkout dates.
Hotel Information
id — AwardTool’s unique hotel identifier, such as hyatt_madel.
hotel_id — Hotel identifier used by the associated loyalty program.
name — Hotel’s display name.
brand — Parent hotel brand or loyalty program, such as hyatt.
sub_brand — Hotel’s sub-brand or collection.
availability — Human-readable award-availability percentage, such as 84%.
availability_num — Award-availability percentage with greater numeric precision.
cash_min — Lowest observed cash price.
cash_median — Median observed cash price.
cash_max — Highest observed cash price.
points_min — Lowest observed points rate.
points_median — Median observed points rate.
points_max — Highest observed points rate.
point_val_min — Lowest observed redemption value in cents per point.
point_val_median — Median observed redemption value in cents per point.
point_val_max — Highest observed redemption value in cents per point.
formatted_address — Hotel’s formatted address.
hotel_location — Hotel’s geographic coordinates.
-
latitude— Hotel’s latitude. -
longitude— Hotel’s longitude.
g_link — Google Maps link for the hotel.
g_rating — Hotel’s Google rating.
g_rating_total — Total number of Google ratings or reviews.
image — URL of the hotel image hosted by AwardTool.
update_date — Date when the hotel summary was updated, in YYYY-MM-DD format.
update_epoch — Unix timestamp associated with the latest hotel summary update.