Skip to Content
OpenRoam Docs
Hotels

Search hotel destinations

Finds the places to search hotels in by name: a country, a region, a city or a district.

GET
/v1/hotels/destinations

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.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Query Parameters

q*string

Required. Free text over place names, for example downtown dub; at most 100 characters, without control characters.

countryCode?string

Optional ISO 3166-1 alpha-2 country, in either case: only places in that country. A blank value is rejected.

limit?integer

The most places to return, 1 to 100; default 10.

Formatint32

Response Body

OK

  1. 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.

Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/hotels/destinations?q=string&limit=10'
Example Response
{  "items": [    {      "id": "string",      "name": "string",      "countryCode": "string",      "category": "country",      "logoUrl": "string"    }  ]}