API Reference

Get Availability

get
https://rooms.aero/partnerapi/availability

Retrieve every upcoming date with a rate for a program or a set of hotels.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Get Availability is the Explore pages as an API. It returns one object per hotel, check-in date and stay length (1 to 5 nights), for a whole program (source) or for up to 50 specific hotels (hotel_id). start_date and end_date bound the check-in date; nights selects one stay length. Use it for broad scans such as "every Hyatt award in Japan under 20,000 points"; use Search when you have an area and dates in mind.

By default rows must offer an award in some room class. rate_type and room_type change that: rate_type=cash lists cash rates instead (the data behind the cheapest-cash pages), and room_type=suite restricts everything, including max_points, min_cpp and the lowest_* orderings, to suites.

Only upcoming arrival dates retrieved within the last 21 days are returned. Set include_hotel=false to drop the embedded hotel and booking link when you already have the hotels.

Query Params
string

Loyalty program key(s), comma-delimited if multiple, such as "hyatt,hilton". The keys are listed on the Concepts page. Required unless hotel_id is given.

string

Only these hotels. Comma-delimited if multiple, at most 50. Required unless source is given.

string

Earliest check-in date, YYYY-MM-DD. Dates bound the check-in date, not the whole stay; use nights for the stay length.

string

Latest check-in date, YYYY-MM-DD.

integer
1 to 5

Only stays of exactly this many nights, 1 to 5. Omit for every stay length.

string

Only hotels with these brand codes. Comma-delimited if multiple.

string

Only hotels in these award categories. Comma-delimited if multiple.

string

Only hotels in these countries. Comma-delimited if multiple.

string
enum
Defaults to award

Which kind of rate a row must offer: award (points), cash, or any.

Allowed:
string
enum
Defaults to any

Which room class must offer it: standard, suite, or any. Also scopes max_points, min_cpp and the lowest_* orderings to that class.

Allowed:
integer

Only rows with an award at or below this many points.

number

Only rows whose award is worth at least this many US cents per point (a cash rate must have been seen).

string
enum
Defaults to arrival_date

arrival_date (soonest first), lowest_award (cheapest points first), lowest_cash (cheapest cash first, compared in USD), or last_checked (most recently retrieved first). Ties are broken by id so pages are stable.

Allowed:
boolean
Defaults to true

Embed the hotel object and booking link on each row. Set to false for a smaller payload when you already have the hotels.

integer
Defaults to 0

How many results to skip. Pagination is skip/take: request the next page with skip = skip + take, or follow more_url.

integer
1 to 500
Defaults to 100

Maximum results to return. Must be between 1 and 500.

Responses

Updated about 3 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago

Did this page help you?