HotelFilters

Filter criteria for hotels

canonicalCityIdstring

Filter by canonical city ID

Example: city_123456

countryCodestring

Filter by country code (ISO 3166-1 alpha-2)

Example: ES

categorystring

Deprecated: Use categories instead. Single category filter (e.g., '3STAR')

categoriesstring[]

Multi-category filter. Values can be:

• Numeric: "1", "2", "3", "4", "5" (auto-converted to "1STAR", etc.)
• Full format: "1STAR", "2STAR", "3STAR", "4STAR", "4STAR_SUP", "5STAR"

Example: ["3STAR","4STAR","5STAR"]

boardCodesstring[]

Filter by board/meal plan codes. Returns hotels with ANY of these boards.

Example: ["AI","HB","BB"]

roomCodesstring[]

Filter by room codes (future use)

hotelNamestring

Partial match search on hotel name (case-insensitive)

Example: Hilton

hasMediaboolean

When true, only hotels with media; when false, only without. Omit for no filter.

amenityCodesstring[]

Hotel must have ALL of these amenity base codes.

nearby object

Geo-proximity filter

latitudenumber<double>required

Latitude coordinate

Possible values: >= -90 and <= 90

Example: 39.4699

longitudenumber<double>required

Longitude coordinate

Possible values: >= -180 and <= 180

Example: -0.3763

radiusKmnumber<double>

Search radius in kilometers (max 500km)

Possible values: >= 0 and <= 500

Default value: 50

Example: 10

HotelFilters

{
  "canonicalCityId": "city_123456",
  "countryCode": "ES",
  "category": "string",
  "categories": [
    "3STAR",
    "4STAR",
    "5STAR"
  ],
  "boardCodes": [
    "AI",
    "HB",
    "BB"
  ],
  "roomCodes": [
    "string"
  ],
  "hotelName": "Hilton",
  "hasMedia": true,
  "amenityCodes": [
    "string"
  ],
  "nearby": {
    "latitude": 39.4699,
    "longitude": -0.3763,
    "radiusKm": 10
  }
}