Search hotel destinations
Finds the places to search hotels in by name: a country, a region, a city or a district.
Finds the places to search hotels in by name: a country, a region, a city or a district.
Returns { items }: at most limit places whose names match q, most relevant first, without
paging. Send a place's id as searchCriteria.location.geoNodeId in a search; it finds the
hotels of every place inside it. name includes the place's parents, for example "Downtown Dubai,
Dubai, United Arab Emirates", and category is its level: country, region, city
or area. Only places where OpenRoam has had hotels are listed.
q is required: plain text, at most 100 characters, without control characters. countryCode
keeps the places of one ISO 3166-1 alpha-2 country; limit is 1–100 (default 10). An invalid or blank
value, or any other query parameter, gives 400 / 10001. 503 / 10007 when the destination index is
unavailable or does not answer within 5 seconds: retry.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
q*stringRequired. Free text over place names, for example downtown dub; at most 100 characters, without control characters.
countryCode?stringOptional ISO 3166-1 alpha-2 country, in either case: only places in that country. A blank value is rejected.
limit?integerThe most places to return, 1 to 100; default 10.
int32OK
- response
The places to search hotels in that best match q, most relevant first: at most limit, not paged.
items*array<>The matching places; empty when none matches.
curl -X GET 'https://api.sandbox.openroam.com/v1/hotels/destinations?q=string&limit=10'{ "items": [ { "id": "string", "name": "string", "countryCode": "string", "category": "country", "logoUrl": "string" } ]}Get hotel catalog files GET
Returns download links for the current hotel catalog files. Returns `{ generatedAt, hotelCount, files: [{ variant, url, sizeBytes }] }`, one zip per variant. Each zip holds `hotels.jsonl`: one hotel per line, in the item shape that search and `properties/{id}` return, with `offers` empty. `withoutImages` carries each hotel's main image as `logoUrl` and an empty `details.imageUrls`; `withImages` also lists every gallery image there. `generatedAt` is null and `files` empty before the first catalog is built, and after a release that changes the line format until the first build in the new format: the route never links a file whose lines have another format. The route takes no query parameters.
Get a hotel GET
Returns one hotel's content: the item that search returns, without `offers`. Use it to show a hotel's information: name, description, star rating, address, images, amenities and contact. A hotel has no price without a stay, so the response has no `offers` key; send the `id` in a search's `searchCriteria.hotelIds` for its rates. The route serves the hotels of the OpenRoam catalog, as the catalog files list them. An ID that is unknown, not a hotel ID, or not in the catalog (such as a temporary ID a search gave a hotel outside the catalog) gives 404 / 10004. The route takes no query parameters.