
Official MCP server for MAQAMI, a hotel and flight booking platform with 3M+ hotels.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Cancel a confirmed tour or activity booking. First show the customer the refund from `getExperienceBookingCancelPreview` and wait for a clear yes. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
The email address used to make the booking. The server checks it against the booking before returning or changing anything.
MAQAMI experience booking ID from the booking confirmation
The booking holder's last name, if the customer gives it. Optional.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Cancel a confirmed tour or activity booking. First show the customer the refund from `getExperienceBookingCancelPreview` and wait for a clear yes. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to make the booking. The server checks it against the booking before returning or changing anything. |
| lastName | string | The booking holder's last name, if the customer gives it. Optional. |
| bookingId* | string | MAQAMI experience booking ID from the booking confirmation |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bookingId",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to make the booking. The server checks it against the booking before returning or changing anything."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name, if the customer gives it. Optional."
},
"bookingId": {
"type": "string",
"description": "MAQAMI experience booking ID from the booking confirmation"
}
},
"additionalProperties": false
}Cancel a confirmed hotel booking. First check the cancellation policy with `get_bookings_bookingid` and confirm with the customer: a non-refundable booking, or one past its free-cancellation deadline, can be charged in full. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to make the booking. The server checks it against the booking before returning or changing anything. |
| lastName | string | The booking holder's last name, if the customer gives it. Optional. |
| bookingId* | string | The unique booking identifier to cancel |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bookingId",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to make the booking. The server checks it against the booking before returning or changing anything."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name, if the customer gives it. Optional."
},
"bookingId": {
"type": "string",
"description": "The unique booking identifier to cancel"
}
},
"additionalProperties": false
}Look up a tour or activity booking: status, booking details and the voucher once it is confirmed. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to make the booking. The server checks it against the booking before returning or changing anything. |
| lastName | string | The booking holder's last name, if the customer gives it. Optional. |
| bookingId* | string | MAQAMI experience booking ID from the booking confirmation |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bookingId",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to make the booking. The server checks it against the booking before returning or changing anything."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name, if the customer gives it. Optional."
},
"bookingId": {
"type": "string",
"description": "MAQAMI experience booking ID from the booking confirmation"
}
},
"additionalProperties": false
}## Overview Preview the refund amount and cancellation fee for a booking before committing to cancel it. ## When to Use - **Cancellation confirmation screens** - Show the guest exactly what they'll be refunded - **Support tooling** - Check whether a booking is still cancellable before offering a refund ## What You Get - **`cancellable`** - Whether the booking can currently be cancelled - **`policy`** - `cancellationFee`, `refundAmount`, `refundType`, `estimateConfidence`, `currency`, `sellingPrice` ## Quick Start Use this with the `bookingId` from `POST /experiences/bookings`. This does not cancel the booking - `cancelExperienceBooking` cancels it. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to make the booking. The server checks it against the booking before returning or changing anything. |
| lastName | string | The booking holder's last name, if the customer gives it. Optional. |
| bookingId* | string | MAQAMI experience booking ID from the booking confirmation |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bookingId",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to make the booking. The server checks it against the booking before returning or changing anything."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name, if the customer gives it. Optional."
},
"bookingId": {
"type": "string",
"description": "MAQAMI experience booking ID from the booking confirmation"
}
},
"additionalProperties": false
}## Overview Returns the tax schema of a hotel as normalized static data, independent of the supply provider the rules were learned from. Each entry describes one tax or fee: whether it is already included in the room rate, whether it is a percentage of the rate or a fixed amount, and how fixed amounts scale (per adult and/or per night). ## When to Use - **Price transparency** - Show guests which taxes and fees apply at a property - **Amount-due-at-property estimates** - Excluded taxes are typically collected at the hotel - **Tax auditing** - Compare supplier-declared taxes against the reference schema ## Notes - Fixed amounts are expressed in USD - Percentage rates apply to the room rate (e.g. 14.62 means 14.62%) - The schema is learned by an offline pipeline; hotels without learned data return 404 - Enterprise accounts also receive `category`, `chargeType`, and `payAtProperty` on each tax. `payAtProperty` is always the opposite of `included`. When the hotel declared the rule, an enterprise response may also include `appliedPer`, `appliedOn`, `validFrom`, and `validTo`
| Argument | Type | Description |
|---|---|---|
| hotelId* | string | Unique identifier of the hotel, in 'lp' format or numeric. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"hotelId"
],
"properties": {
"hotelId": {
"type": "string",
"description": "Unique identifier of the hotel, in 'lp' format or numeric."
}
},
"additionalProperties": false
}Look up a confirmed hotel booking: status, hotel, dates, rooms, guests, price and cancellation policy. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to make the booking. The server checks it against the booking before returning or changing anything. |
| lastName | string | The booking holder's last name, if the customer gives it. Optional. |
| bookingId* | string | The unique booking identifier (e.g. '2rSJvdDru') |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bookingId",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to make the booking. The server checks it against the booking before returning or changing anything."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name, if the customer gives it. Optional."
},
"bookingId": {
"type": "string",
"description": "The unique booking identifier (e.g. '2rSJvdDru')"
}
},
"additionalProperties": false
}## Overview Get all available hotel chains (e.g., Marriott, Hilton, IHG). Use chain IDs to filter hotel searches by brand. ## When to Use - **Chain filters** - Filter hotels by chain/brand - **Brand selection** - Let users search for specific hotel chains - **Reference data** - Get chain IDs for use in search filters ## What You Get - **Chain list** - All available hotel chains - **Chain IDs** - Numeric IDs for use in search filters - **Chain names** - Hotel chain/brand names ## Quick Start No parameters required. Returns all hotel chains with IDs. Use chain IDs in hotel search filters.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}## Overview Get a list of all cities within a specific country. Perfect for building location dropdowns and city selection interfaces. ## When to Use - **City dropdowns** - Populate city selection lists - **Location filters** - Filter hotels by city - **Geographic data** - Get city lists for specific countries - **Form autocomplete** - Build city autocomplete features ## What You Get - **City list** - All cities in the specified country - **City names** - Formatted city names ready for display ## Quick Start Provide the `countryCode` in ISO-2 format (e.g., "US", "GB"). Returns all cities in that country. Use the [Get Country List endpoint](/v3.0.0/reference/get_data-countries) to get country codes.
| Argument | Type | Description |
|---|---|---|
| timeout | number | request timeout in seconds |
| countryCode* | string | Country code in iso-2 format (example: SG) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"countryCode"
],
"properties": {
"timeout": {
"type": "number",
"description": "request timeout in seconds"
},
"countryCode": {
"type": "string",
"description": "Country code in iso-2 format (example: SG)"
}
},
"additionalProperties": false
}## Overview Get a complete list of all countries available in the system with their ISO-2 country codes. Essential for building country selection interfaces. ## When to Use - **Country dropdowns** - Populate country selection lists - **Location filters** - Filter hotels or searches by country - **Form inputs** - Build country selection forms - **Reference data** - Get country codes for use in other endpoints ## What You Get - **Country list** - All available countries - **ISO-2 codes** - Standard country codes (e.g., "US", "GB", "FR") - **Country names** - Full country names ## Quick Start No parameters required. Returns all countries with their ISO-2 codes.
| Argument | Type | Description |
|---|---|---|
| timeout | number | request timeout in seconds |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"timeout": {
"type": "number",
"description": "request timeout in seconds"
}
},
"additionalProperties": false
}## Overview Get all available currencies with their codes, names, and the countries where each currency is used. Perfect for building currency selection interfaces. ## When to Use - **Currency dropdowns** - Populate currency selection lists - **Price display** - Show prices in different currencies - **Currency conversion** - Get currency information for conversion - **Reference data** - Get currency codes for use in booking endpoints ## What You Get - **Currency list** - All available currencies - **Currency codes** - ISO currency codes (e.g., "USD", "EUR", "GBP") - **Currency names** - Full currency names - **Country mapping** - Countries where each currency is used ## Quick Start No parameters required. Returns all currencies with codes, names, and country mappings.
| Argument | Type | Description |
|---|---|---|
| timeout | number | request timeout in seconds |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"timeout": {
"type": "number",
"description": "request timeout in seconds"
}
},
"additionalProperties": false
}## Overview Get all available hotel facilities (amenities) with multi-language translations. Use these facility IDs to filter hotel searches by amenities. ## When to Use - **Facility filters** - Build amenity filtering in hotel searches - **Facility display** - Show available facilities with translated names - **Multi-language support** - Display facilities in user's language - **Reference data** - Get facility IDs for use in search filters ## What You Get - **Facility list** - All available hotel facilities - **Facility IDs** - Numeric IDs for use in search filters - **Multi-language names** - Facility names in multiple languages - **Translations** - Localized facility names ## Quick Start No parameters required. Returns all facilities with IDs and multi-language translations. Use facility IDs in hotel search filters.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}## Overview Retrieve a list of airlines with optional filtering by name, alliance, and active status. ## When to Use - **Airline directory** - Build a searchable list of airlines for display or filtering - **Alliance filtering** - Filter airlines by alliance membership (Star Alliance, oneworld, SkyTeam) - **Active airlines** - Retrieve only currently operating airlines ## What You Get - **Full airline records** including name, IATA/ICAO codes, country, alliance, and logo URL - **Alliance membership** for each airline - **Active status** to identify currently operating carriers - **Filtered results** based on query, alliance, and active status parameters ## Quick Start Call with no parameters to get all airlines. Use `q` to search by name, `alliance` to filter by alliance, and `activeOnly=true` to exclude inactive carriers.
| Argument | Type | Description |
|---|---|---|
| q | string | Search query (e.g., 'AA' or 'American') |
| limit | integer | Maximum number of results |
| alliance | string | Filter by airline alliance |
| activeOnly | boolean | Only return currently active airlines |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"q": {
"type": "string",
"description": "Search query (e.g., 'AA' or 'American')"
},
"limit": {
"type": "integer",
"description": "Maximum number of results"
},
"alliance": {
"enum": [
"star_alliance",
"oneworld",
"skyteam",
"vanilla_alliance"
],
"type": "string",
"description": "Filter by airline alliance"
},
"activeOnly": {
"type": "boolean",
"description": "Only return currently active airlines"
}
},
"additionalProperties": false
}## Overview Retrieve a lightweight list of airline IATA codes with names for autocomplete and lookup purposes. ## When to Use - **Autocomplete dropdowns** - Populate airline search inputs with a minimal list - **Client-side filtering** - Download the full list once and filter locally - **Code validation** - Build a lookup table of valid airline codes ## What You Get - **IATA codes** for all airlines in the database - **Airline names** paired with each code - **Active filtering** available via the `activeOnly` parameter ## Quick Start Call with no parameters to get all airline IATA codes and names. Use `activeOnly=true` to filter out inactive airlines.
| Argument | Type | Description |
|---|---|---|
| activeOnly | boolean | Only return currently active airlines |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"activeOnly": {
"type": "boolean",
"description": "Only return currently active airlines"
}
},
"additionalProperties": false
}## Overview Retrieve full details for a specific airline using its 2-letter IATA code. ## When to Use - **Airline display** - Show airline name, logo, and alliance for a given IATA code - **Flight result enrichment** - Fetch airline details to display alongside search results - **Data validation** - Verify an airline code and retrieve its metadata ## What You Get - **Airline details** including name, IATA/ICAO codes, and country - **Alliance membership** (Star Alliance, oneworld, SkyTeam, or Vanilla Alliance) - **Logo URL** for displaying the airline's logo in your UI - **Active status** indicating whether the airline is currently operating ## Quick Start Provide the 2-letter IATA code (e.g., `AA` for American Airlines) in the URL path.
| Argument | Type | Description |
|---|---|---|
| iataCode* | string | 2-letter IATA airline code (e.g., AA) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"iataCode"
],
"properties": {
"iataCode": {
"type": "string",
"description": "2-letter IATA airline code (e.g., AA)"
}
},
"additionalProperties": false
}## Overview Search for airports by name, city, or IATA code using a text query. Returns matching airports for use in autocomplete and search inputs. ## When to Use - **Airport autocomplete** - Power origin/destination search inputs with type-ahead suggestions - **Airport discovery** - Find airports in a city or region by name - **Search validation** - Look up airports before constructing a flight search request ## What You Get - **Matching airports** ranked by relevance to the query - **IATA codes** for `legs[].origin` and `legs[].destination` in `post_flights_rates` - **City and country** details for display purposes - **Geographic coordinates** for map-based interfaces ## Quick Start Provide a `q` query string (minimum 2 characters) to search by airport name, city, or code. Returns matching airports ordered by relevance.
| Argument | Type | Description |
|---|---|---|
| q* | string | Search query (minimum 2 characters, e.g., 'JFK' or 'New York') |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Search query (minimum 2 characters, e.g., 'JFK' or 'New York')"
}
},
"additionalProperties": false
}## Overview Retrieve a lightweight list of airport IATA codes with names for autocomplete and lookup purposes. ## When to Use - **Autocomplete dropdowns** - Populate airport search inputs with a full list of codes and names - **Client-side filtering** - Download the full list once and filter locally - **Code validation** - Build a lookup table of valid airport codes ## What You Get - **IATA codes** for all airports in the database - **Airport names** paired with each code - **Filtered results** when the `q` query parameter is provided ## Quick Start Call with no parameters to get all airport codes and names. Use the `q` parameter to filter by name or code.
| Argument | Type | Description |
|---|---|---|
| q* | string | Search query |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Search query"
}
},
"additionalProperties": false
}## Overview Retrieve detailed information for a specific airport using its 3-letter IATA code. ## When to Use - **Airport display** - Show airport name, city, and country for a given IATA code - **Flight result enrichment** - Fetch airport details to display alongside origin/destination in search results - **Autocomplete validation** - Verify an airport code and retrieve its full details ## What You Get - **Airport details** including name, city, country, and timezone - **IATA and ICAO codes** for the airport - **Geographic coordinates** (latitude and longitude) - **Country and city** information for display purposes ## Quick Start Provide the 3-letter IATA code (e.g., `JFK` for John F. Kennedy International) in the URL path.
| Argument | Type | Description |
|---|---|---|
| iataCode* | string | 3-letter IATA airport code (e.g., JFK) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"iataCode"
],
"properties": {
"iataCode": {
"type": "string",
"description": "3-letter IATA airport code (e.g., JFK)"
}
},
"additionalProperties": false
}## Overview Get comprehensive details about a specific hotel including descriptions, amenities, images, location, and ratings. Perfect for displaying hotel detail pages. ## When to Use - **Hotel detail pages** - Show complete hotel information - **Booking pages** - Display hotel details before booking - **Hotel profiles** - Build rich hotel information pages - **Content display** - Show descriptions, amenities, and images ## What You Get - **Complete hotel information** - Name, address, description, and ratings - **Amenities list** - All available facilities and services - **Image gallery** - Hotel photos and images - **Location details** - Address, coordinates, and location information - **Hotel metadata** - Star rating, chain information, and classifications ## Quick Start Provide the `hotelId` as a query parameter. Returns complete hotel details including all metadata, amenities, and images.
| Argument | Type | Description |
|---|---|---|
| hotelId* | string | Unique ID of a hotel |
| timeout | number | request timeout in seconds |
| language | string | The language code, indicating in which language the results should be returned. e.g. 'fr' |
| advancedAccessibilityOnly | boolean | If `true`, accessibility section will be returned |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"hotelId"
],
"properties": {
"hotelId": {
"type": "string",
"description": "Unique ID of a hotel"
},
"timeout": {
"type": "number",
"description": "request timeout in seconds"
},
"language": {
"type": "string",
"description": "The language code, indicating in which language the results should be returned. e.g. 'fr'"
},
"advancedAccessibilityOnly": {
"type": "boolean",
"description": "If `true`, accessibility section will be returned"
}
},
"additionalProperties": false
}## Overview **Beta Feature** - Ask natural language questions about a specific hotel and get AI-powered answers based on the hotel's information. ## When to Use - **Hotel Q&A** - Answer customer questions about hotels - **Information lookup** - Get specific details about amenities, services, or features - **Conversational interfaces** - Build chat interfaces for hotel information - **Detailed inquiries** - Ask about specific aspects like restaurants, parking, or amenities ## What You Get - **AI-generated answers** - Relevant responses to your questions - **Hotel-specific information** - Answers based on the hotel's actual data - **Natural language responses** - Human-readable answers ## Example Questions - "What amenities does this hotel have?" - "Is there parking available?" - "What does a meal at the restaurant look like?" ## Key Features - **Web search option** - Enable `allowWebSearch` to get additional information from the web - **Hotel context** - Answers are specific to the hotel you're asking about - **Natural language** - Ask questions conversationally ## Quick Start Provide the `hotelId` and your `question`. Optionally enable `allowWebSearch` for web-enhanced answers. **Note:** This is a beta feature and may be subject to changes.
| Argument | Type | Description |
|---|---|---|
| query* | string | The question to ask about the hotel |
| hotelId* | string | Unique ID of the hotel (MAQAMI format) |
| allowWebSearch | boolean | Whether to allow web search for additional information. Default is false. |
Find hotels by name or place with a semantic text search. Returns up to 5 matches (set `limit` for more) with name, address, city, country and a relevance score. Check the name and city before using an `id`. For an exact hotel name, `get_data_hotels` with `hotelName` and `cityName` or `countryCode` is more precise.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of matches to return. Defaults to 5. |
| query* | string | The semantic search query (e.g. 'Burj Jumeirah Dubai'). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"query"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"description": "Maximum number of matches to return. Defaults to 5."
},
"query": {
"type": "string",
"description": "The semantic search query (e.g. 'Burj Jumeirah Dubai')."
}
},
"additionalProperties": false
}## Overview Search and retrieve hotel listings based on various criteria. Get hotel metadata including names, addresses, ratings, amenities, and images for display in your application. ## When to Use - **Hotel listings** - Display hotel search results - **Location-based search** - Find hotels by city, coordinates, or Place ID - **Hotel discovery** - Browse hotels in specific areas - **Metadata retrieval** - Get hotel information for display ## What You Get - **Hotel list** - Matching hotels with complete metadata - **Basic information** - Names, addresses, ratings, and locations - **Amenities** - Available facilities and features - **Images** - Hotel photos for display - **Identifiers** - Hotel IDs for use in rate searches ## Search Options - **By city** - Search hotels in a specific city - **By coordinates** - Find hotels near latitude/longitude with radius - **By Place ID** - Get hotels within a specific place boundary - **By hotel IDs** - Retrieve specific hotels by their IDs ## Quick Start Provide search criteria (city, coordinates+radius, placeId, or hotelIds). Returns matching hotels with complete metadata.
| Argument | Type | Description |
|---|---|---|
| zip | string | ZIP code of the location |
| limit | integer | Specifies the maximum number of results to return. By default, this is set to 200, even if not explicitly defined. If a higher limit is specified, the maximum allowed is 5000 results |
| offset | integer | Specifies the number of rows to skip before starting to return rows |
| radius | integer | radius in meters (min 1000m) |
## Overview **Beta Feature** - Search hotel rooms using visual and text-based queries. Uses image search technology to match your query against room images and find hotels with rooms that match your visual preferences, amenities, or style. ## When to Use - **Visual room search** - Find rooms based on visual characteristics like "luxury modernist comfort" or "blue accessible bathroom" - **Style-based search** - Search for rooms by design style like "art deco hotel room" or "brutalist room" - **Amenity-focused search** - Find rooms with specific features like "twin room with a city view" or "room with a skylight" - **Geographic filtering** - Limit results to hotels near a specific location using coordinates or Place ID - **City and country filtering** - Filter results by city and/or country ## What You Get - **Matching hotels** - Hotels grouped by hotel ID with rooms that match your query - **Room details** - Room name, image URL, and similarity score (rounded to 3 decimals) for each matching room - **Hotel metadata** - ID, name, address, city, country, and rating for each hotel - **Geographic filtering** - Optionally limit results to a specific area using coordinates or Place ID - **City and country filters** - Filter results by city and/or country code ## Example Queries - "luxury modernist comfort" - "an extremely fun room or art deco hotel room" - "luxurious accessible bathroom or blue accessible bathroom with walk in shower" - "twin room with a city view" - "a room filled with paintings" - "a hotel room with a skylight" ## Geographic Filtering You can optionally limit search results to a specific geographic area: - **Using coordinates**: Provide `latitude`, `longitude`, and optionally `radius` (in kilometers, default: 12km) - **Using Place ID**: Provide `placeId` - the place's location will be automatically fetched and the search will use the place's viewport boundaries (or the provided `radius` if viewport is unavailable) - **Using city/country**: Provide `city` and/or `country` to filter results by location ## Quick Start Provide a `query` parameter describing the room you're looking for. Optionally add geographic filtering with `latitude`/`longitude` or `placeId` to limit results to a specific area. **Note:** This is a beta feature and may be subject to changes.
| Argument |
|---|
## Overview **Beta Feature** - Search hotels using natural language queries. Uses AI to understand search intent and find hotels that match the meaning, not just keywords. ## When to Use - **Natural language search** - Let users search with phrases like "romantic getaway in London" - **Intent-based matching** - Find hotels matching the vibe or style, not just location - **Conversational search** - Support natural language hotel discovery - **Semantic matching** - Get hotels that semantically match the query ## What You Get - **Matching hotels** - Hotels that semantically match your query - **Semantic attributes** - Tags, persona, style, location_type, and story for each hotel - **Relevance scores** - How well each hotel matches the query - **Hotel metadata** - ID, name, photos, address, city, country ## Example Queries - "Romantic getaway in London with Italian vibes" - "Hotels near Paris" - "Family-friendly beachfront hotels" ## Quick Start Provide a natural language `query` parameter. Returns hotels with semantic matching scores and attributes. **Note:** This is a beta feature and may be subject to changes.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Maximum number of results to return. Default is 3. |
| query* | string | Semantic search query. This can be a natural language description of what you're looking for, e.g. 'romantic getaway in london with italian vibes' |
| min_rating | number | Minimum hotel rating to filter results. Default is 0 (no minimum rating filter). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"query"
],
"properties": {
"limit": {
"type": "integer",
"description": "Maximum number of results to return. Default is 3."
},
"query": {
"type": "string",
"description": "Semantic search query. This can be a natural language description of what you're looking for, e.g. 'romantic getaway in london with italian vibes'"
},
"min_rating": {
"type": "number",
"description": "Minimum hotel rating to filter results. Default is 0 (no minimum rating filter)."
}
},
"additionalProperties": false
}## Overview Get all available hotel type classifications (e.g., resort, boutique, business hotel). Use type IDs to filter hotel searches. ## When to Use - **Type filters** - Filter hotels by type in search - **Type display** - Show hotel type classifications - **Reference data** - Get hotel type IDs for filtering ## What You Get - **Hotel type list** - All available hotel types - **Type IDs** - Numeric IDs for use in search filters - **Type names** - Hotel type classifications ## Quick Start No parameters required. Returns all hotel types with IDs. Use type IDs in hotel search filters.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}## Overview Get IATA (International Air Transport Association) airport codes with airport names, coordinates, and country information. Useful for airport-based hotel searches. ## When to Use - **Airport searches** - Find hotels near airports - **Location selection** - Let users search by airport codes - **Geographic data** - Get airport locations and coordinates - **Reference data** - Get IATA codes for use in hotel searches ## What You Get - **Airport list** - All available airports with IATA codes - **Airport names** - Full airport names - **Coordinates** - Latitude and longitude for each airport - **Country codes** - ISO-2 country codes for each airport ## Quick Start No parameters required. Returns all airports with IATA codes, names, coordinates, and country information.
| Argument | Type | Description |
|---|---|---|
| timeout | number | request timeout in seconds |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"timeout": {
"type": "number",
"description": "request timeout in seconds"
}
},
"additionalProperties": false
}## Overview Get all supported languages for hotel translations and content localization. Use language codes to request hotel data in specific languages. ## When to Use - **Language selection** - Display available languages to users - **Content localization** - Get language codes for API requests - **Multi-language support** - Build language switchers in your application - **Reference data** - Validate language codes before making requests ## What You Get - **Language list** - All supported and enabled languages - **Language codes** - ISO 639-1 codes (e.g., 'en', 'es', 'fr') - **Language names** - Human-readable language names in English ## Quick Start No parameters required. Returns all supported languages with codes and names. Use language codes in hotel search and detail requests.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}## Overview Retrieve guest reviews and ratings for a specific hotel. Display authentic feedback from previous guests to help users make informed booking decisions. ## When to Use - **Review display** - Show guest reviews on hotel detail pages - **Rating aggregation** - Display average ratings and review counts - **Trust building** - Show authentic guest feedback - **Decision support** - Help users evaluate hotels before booking ## What You Get - **Guest reviews** - Individual review text and ratings - **Review dates** - When each review was written - **Ratings** - Numerical and textual ratings - **Guest feedback** - Detailed comments from previous guests ## Quick Start Provide the `hotelId` as a query parameter. Returns all reviews for that hotel with ratings and comments.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Specifies the maximum number of results to return. By default, this is set to 200, even if not explicitly defined. If a higher limit is specified, the maximum allowed is 5000 results |
| offset | integer | Specifies the number of reviews to skip, defaults to 0 |
| hotelId* | string | Unique ID of a hotel |
| timeout | number | request timeout in seconds |
| language | string | ISO 639-1 language code (e.g., 'fr', 'es', 'de') to translate reviews using AI. If not provided, the reviews will be returned in the default language (en). When this parameter is provided, the maximum number of reviews returned is 10. |
Look up a confirmed flight booking: status, passengers, flights, booking references, fare rules and price. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to make the booking. The server checks it against the booking before returning or changing anything. |
| lastName | string | The booking holder's last name, if the customer gives it. Optional. |
| bookingId* | string | The unique flight booking identifier |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bookingId",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to make the booking. The server checks it against the booking before returning or changing anything."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name, if the customer gives it. Optional."
},
"bookingId": {
"type": "string",
"description": "The unique flight booking identifier"
}
},
"additionalProperties": false
}## Overview Returns refund eligibility, estimated refund amounts, and penalty details for a booking **without actually cancelling it**. Useful before `post_flights_bookings_bookingid_cancellations` to understand the financial impact of cancellation. ## When to Use - **Pre-cancellation review** — Show the customer the potential maximum refund (not guaranteed) before they confirm cancellation - **Refund estimation** — Display potential maximum refund and penalty amounts in the booking management UI (refund is not granted until cancel completes) - **Eligibility check** — Determine whether the booking is within the void window (`isVoidable`) or eligible for a partial refund (`isRefundable`) ## What You Get - **`confidence`** — How reliable the quote is (`confirmed`, `estimated`, `heuristic`, `unknown`) - **`isRefundable` / `isVoidable`** — Quick eligibility flags - **`refund` / `penalty`** — Aggregate amounts with margin applied. `refund` is the potential maximum the airline may refund — not a granted/guaranteed amount - **`penalties[]`** — Itemised penalty breakdown when available - **`tickets[]`** — Per-ticket detail when available - **`destination`** — Where the refund goes - **`vouchers[]`** — Airline travel vouchers / credit-shells when `destination` is `voucher`; omitted when absent. Distinct from MAQAMI discount `voucherCode` on prebook ## Concurrent cancellation If a cancellation was already submitted and is still awaiting provider confirmation, this endpoint returns **HTTP 409** with code `49007` (`CONCURRENT_OPERATION`). A new quote is not available until that cancellation completes or fails. ## Refund amount caveat The `refund` amount on a cancellation quote is the **potential maximum** the airline may refund if cancellation proceeds under the quoted conditions. It is an estimate for decision-making only and is **not granted** — the final refund (if any) is determined when cancellation completes and may be lower or zero. The refund may arrive asynchronously once the airline determines the final amount. ## Key Features - **Non-destructive** — Does not cancel the booking; safe to call before user confirmation - **Margin-applied pricing** — All amounts (including voucher `pricing.display`) reflect the same margin applied at booking time ## Quick Start Provide the `bookingId` from the flight booking confirmation. Each call checks the airline live. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
## Overview Retrieve the ancillary services (seats, baggage) for an existing flight booking: services that are **already booked** together with the live catalog of services that **can still be booked**. ## When to Use - **Post-booking upsell** - Show the passenger which seats and bags they can still add after the booking was created - **Booking management** - Display the services already attached to the booking with the prices that were charged - **Availability refresh** - The bookable catalog is fetched live from the provider on every call ## What You Get - **`groups`** - Bookable services grouped by category (seat, baggage) with post-margin prices and encoded `serviceId`s - **`bookedServices`** - Services already attached to the booking; entries booked through the API carry the exact price that was charged at attach time - **`expiresAt`** - Validity window of the bookable catalog ## Key Features - **Read-only**: Safe to call at any time; the catalog reflects live availability - **Consistent pricing**: Booked services echo the post-margin amounts the user actually paid ## Quick Start Provide the `bookingId` from the flight booking confirmation. On a ticketed booking (status `CONFIRMED`) `groups` lists only what can be sold after ticketing (provider-dependent, usually baggage) and only when `canAddServicesAfterTicketing` is true; buy them with `POST /flights/bookings/{bookingId}/services` and `/services/confirm`. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to make the booking. The server checks it against the booking before returning or changing anything. |
| lastName | string | The booking holder's last name, if the customer gives it. Optional. |
Retrieve a hotel prebook by its `prebookId`: final price, cancellation terms, room details and the `checkoutUrl` (`https://book.maqami.co/booking?prebookId=...`). Bookings are paid and confirmed only on MAQAMI's website, through the `checkoutUrl`.
| Argument | Type | Description |
|---|---|---|
| prebookId* | string | (Required) The unique identifier of the prebook session. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"prebookId"
],
"properties": {
"prebookId": {
"type": "string",
"description": "(Required) The unique identifier of the prebook session."
}
},
"additionalProperties": false
}Find a customer's hotel bookings by the email address and last name used to book. Both must match the booking holder; nothing is returned otherwise. Returns each booking with its `bookingId`, status, hotel, dates, guests, price and cancellation policy. To look up, change or cancel one booking, use its `bookingId` with the same `email` in the booking tools.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to make the bookings. |
| lastName* | string | The booking holder's last name. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email",
"lastName"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to make the bookings."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name."
}
},
"additionalProperties": false
}## Overview **Hard Amendment** — Search for alternative rates at the same hotel and create prebook sessions for a confirmed booking. Used when the guest needs to change their check-in/check-out dates or room occupancy. ## When to Use - **Date changes** — Guest needs different check-in or check-out dates - **Occupancy changes** — Guest needs a different number of adults or children - **Hard amendments** — Situations where the booking must be cancelled and re-booked with new parameters ## How It Works 1. The system searches for live availability at the same hotel with the new parameters. 2. Up to `maxPrebooks` alternative rates are selected (sorted by price ascending). Defaults to 3 when omitted; capped at 10 (any larger value is silently clamped to 10). 3. A prebook session is created for each rate. 4. The caller receives a list of `prebookId` values with prices to show the guest. ## What You Get - **Up to `maxPrebooks` prebook sessions** — Each with a `prebookId`, final pricing, cancellation policies, and room details - **Price comparison** — `priceDifferencePercent` shows how each alternative compares to the **original booking's selling price** (negative = cheaper than what the guest paid, positive = more expensive) - **Policy change flags** — `cancellationChanged` and `boardChanged` highlight any policy differences ## Key Notes - The booking must be in **CONFIRMED** status. - If the original booking is non-refundable, only non-refundable alternatives are returned (unless overridden with `refundableRatesOnly`). - The nationality and currency of the original booking are used for the availability search. ## Quick Start 1. Call this endpoint with the `bookingId` and new `occupancies`/dates — get back up to `maxPrebooks` `prebookId` values. **On this server**: rebooking is not available, so use this only to show the guest alternative prices. To change a booking, cancel it if its policy allows and make a new booking, or contact MAQAMI support. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to make the booking. The server checks it against the booking before returning or changing anything. |
## Overview Generate short, AI-written "Smart Highlight" cards for a hotel. Each highlight is a title plus a one or two sentence description, generated directly in the requested language. **Pricing**: $0.02 per request **Rate Limiting**: This endpoint is rate-limited to **10 requests per minute**. Exceeding this limit will result in a `429 Too Many Requests` response. ## When to Use - **Hotel detail pages** - Show a few compelling reasons to consider a property - **Partner-specific tone** - Adjust voice and emphasis per surface via `tone`, `style` and per-highlight `context` ## What You Get - Exactly `count` highlights, always, in the requested order - `type` echoed back from the request so you can map each card to your own UI - `generated` indicating whether the copy is AI-generated or template fallback ## Behaviour Hotel facts are resolved server-side from `hotelId`; the caller never supplies them. The model sees the name, city, country, street address, parking, and description, plus a sample of facilities, rooms, policies, and nearby places (with a server-computed distance phrase: on the property, short walk, short drive, or longer drive; farther places are omitted), guest sentiment strengths when stored (not drawbacks), and classification (star rating, hotel type, chain). Generated copy is grounded in those facts. Straight apostrophes in titles and descriptions are normalized to typographic apostrophes. Enterprise API keys also omit wifi and the phrase modern amenities from the facts and from the copy, and they omit review-style wording such as guests say. Other API keys still return wifi and connectivity copy when the request asks for it. When `tone` or `style` specify length or format, those rules override the default title and description lengths. If AI generation fails, the endpoint still returns `200` with the requested number of neutral template highlights and `generated: false`. It never returns an empty array for a valid hotel. Results are cached, so repeated calls with an identical request body return identical copy. `tone` and `style` are truncated to 200 characters (5,000 for enterprise accounts). Each highlight `context` is truncated to 300 characters (10,000 for enterprise accounts).
| Argument | Type | Description |
|---|
Flight bookings are cancelled on MAQAMI's website, not in this chat. When a customer wants to cancel a flight, give them https://book.maqami.co/manage-bookings and tell them to continue from there: choose "Flight reservations", enter the last name and the booking ID, then follow the steps to see the refund and cancel. Calling this tool returns the same link and steps.
| Argument | Type | Description |
|---|---|---|
| bookingId | string | Optional: the flight booking ID, if the customer gave it. |
{
"type": "object",
"properties": {
"bookingId": {
"type": "string",
"description": "Optional: the flight booking ID, if the customer gave it."
}
},
"additionalProperties": false
}## Overview Search for available flights with real-time pricing from multiple providers. The itinerary **must** be sent as a non-empty `legs` array. Each leg follows the provider **SearchLeg** shape: required `origin`, `destination`, and `date` (YYYY-MM-DD); optional `direction` (`OUTBOUND` or `INBOUND`); optional per-leg `filters` that override global `filters` for that leg only. **Not supported:** top-level `origin`, `destination`, `departureDate`, or `returnDate` — use `legs` only. ## When to Use - **Listings** — live prices for search results UI - **One-way, round-trip, or multi-city** — one leg per segment, in order - **Filtering** — cabin class, stops, price, refundability, times (globally or per leg) ## What You Get - Offers from multiple providers - Itineraries with segments, layovers, and durations - Price breakdown (fares, taxes, fees) and baggage hints ## Key Features - Multi-provider aggregation in one request - Global `filters`, `sort` ## Quick Start **Required:** `legs` (at least one object with `origin`, `destination`, `date`), `adults` (≥ 1), `currency` **Date limit:** each leg `date` must not be more than 11 months from today. **Round-trip:** two legs (e.g. outbound then return with `direction` `OUTBOUND` / `INBOUND`). **One-way:** one leg. ## Booking The response includes `searchUrl`, the same search on book.maqami.co. Flights are booked and paid only on MAQAMI's website: `post_flights_verify` re-prices the chosen offer and returns its `checkoutUrl`.
| Argument | Type | Description |
|---|---|---|
| legs* | array | Ordered itinerary legs (provider SearchLeg). One-way: one entry. Round-trip: outbound then inbound. Multi-city / open-jaw: additional legs in travel order. |
| sort | object | Sort options for results |
| adults* |
## Overview Confirm a flight offer is still available and retrieve the latest pricing before proceeding to booking. Returns the checkout link for the verified offer. ## When to Use - **Pre-booking validation** - Confirm offer availability after user selects a flight - **Price confirmation** - Show users the guaranteed price - **Fare rule retrieval** - Get the latest cancellation and change policies ## What You Get - **Verified pricing** with up-to-date fare breakdown - **`changes`** (when present) — cabin/fare flags, human-readable `messages`, and **`pricing`** (`old` / `new` full OfferPricing) instead of deprecated scalar currency/prices - **Journey `pricing`** — `original` (provider/PCC) and `display` (customer) price breakdown per provider FlattenedJourney - **Fare family details** including name and included amenities - **Baggage policy** for each passenger type and segment - **Booking terms** including cancellation and change fee rules ## Key Features - **Real-time price check**: Confirms current availability and price with the provider - **Updated baggage info**: Returns the latest baggage allowances at time of verification - **Fare rules**: Includes cancellation and change fee policies before commitment ## Quick Start Provide the `offerId` from `post_flights_rates` search results. The verified offer data gives the customer a booking summary. ## Booking The response includes `checkoutUrl` (`https://book.maqami.co/flights/booking?offerId=...`). Flights are booked and paid only on MAQAMI's website: the `checkoutUrl` opens checkout for this fare, where the customer enters passenger details, pays securely and receives the confirmation. This tool takes no card or passport details.
| Argument | Type | Description |
|---|---|---|
| offerId* | string | The offerId from the search results |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"offerId"
],
"properties": {
"offerId": {
"type": "string",
"description": "The offerId from the search results"
}
},
"additionalProperties": false
}## Overview Get the cheapest available rate for each hotel in your list. Perfect for displaying price comparisons without loading full rate details. ## When to Use - **Show price ranges** on hotel listing pages - **Quick price comparisons** across multiple hotels - **Optimize performance** when you only need the lowest price, not all rate options - **Build price filters** or sorting by price ## What You Get - **Minimum rate per hotel** - the cheapest available room option - **Basic rate information** - price, currency, and availability - **Fast response** - optimized for quick price lookups ## Key Features - **Lightweight** - Returns only the minimum rate, not all options - **Same parameters** as the main rates endpoint for consistency - **Perfect for listings** - Ideal when displaying multiple hotels where users just need to see starting prices ## Quick Start Provide a list of hotel IDs, dates, and guest occupancy. The endpoint returns the cheapest rate available for each hotel.
| Argument | Type | Description |
|---|---|---|
| checkin* | string | Check in date in YYYY-MM-DD (ISO 8601) format |
| timeout | number | Request timeout in seconds |
| checkout* | string | Check out date in YYYY-MM-DD (ISO 8601) format |
| currency* | string | Booking currency |
| hotelIds* | array | List of hotel IDs |
## Overview Search for hotel rates and availability across multiple hotels. This is your primary endpoint for finding bookable hotel rooms with real-time pricing. ## When to Use - **Display hotel listings** with prices on your search results page - **Show detailed rate options** for specific hotels users are viewing - **Support multi-room bookings** for families or groups - **Filter hotels** by location, amenities, ratings, or AI-powered semantic search ## What You Get - **Real-time rates** with availability and pricing - **Multiple room options** per hotel, sorted by price - **Complete booking details** including cancellation policies, meal plans, and room types - **Hotel information** (name, photos, address, ratings) when searching by filters ## Key Features - **Multiple search methods**: Search by hotel IDs, city/country, coordinates, Place ID, IATA code, or natural language (AI search) - **Flexible filtering**: Filter by star rating, facilities, hotel chains, accessibility, and more - **Multi-room support**: Book multiple rooms with different guest configurations in one request - **Performance optimized**: Default limit of 200 hotels (expandable to 5,000), recommended timeout of 6-12 seconds - **Price consistency**: Optional `sessionId` ensures rates stay consistent across listing and detail searches within a user session ## Quick Start **Required fields**: `checkin`, `checkout`, `currency`, `guestNationality`, `occupancies`, plus one location method (hotel IDs, city/country, coordinates, Place ID, or IATA code) **Tip**: When searching by filters (like `aiSearch` or `cityName`), hotel data is automatically included. For direct hotel ID searches, set `includeHotelData=true` to include hotel names and photos. **Price consistency**: Generate a unique `sessionId` per user search session and include it on every rates request in that session, using the same `checkin`, and `checkout`.
| Argument | Type | Description |
|---|---|---|
| zip | string | The zip code of the search location. This is a filter on top of the main query. |
## Overview Locks the chosen hotel rate and returns the final price, cancellation terms and a checkout link on MAQAMI's website. ## When to Use When the customer has chosen a hotel, room, dates and guests and reviewed the price and cancellation terms. ## Quick Start Pass the `offerId` from `post_hotels_rates` exactly as it was returned. ## What You Get - **prebookId** - The locked rate - **Final price and cancellation terms** - For the customer to review - **checkoutUrl** - `https://book.maqami.co/booking?prebookId=...` ## Payment Bookings are paid and confirmed only on MAQAMI's website. The `checkoutUrl` opens checkout for this exact rate, where the customer enters guest details, pays securely and receives the confirmation. This tool takes no payment details and does not confirm the booking.
| Argument | Type | Description |
|---|---|---|
| offerId* | string | The offerId from post_hotels_rates on this server, passed exactly as returned. |
| timeout | integer | |
| bedTypeIds | array | An optional array of bed type IDs to specify preferred bed configurations for the rooms being booked. The availability of specific bed types depends on the hotel's inventory. |
| voucherCode | string | An optional voucher code to apply discounts to the booking. The vouchers API allows creation of these discounts |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"offerId"
],
"properties": {
"offerId": {
"type": "string",
"description": "The offerId from post_hotels_rates on this server, passed exactly as returned."
},
"timeout": {
"type": "integer"
},
"bedTypeIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An optional array of bed type IDs to specify preferred bed configurations for the rooms being booked. The availability of specific bed types depends on the hotel's inventory."
},
"voucherCode": {
"type": "string",
"description": "An optional voucher code to apply discounts to the booking. The vouchers API allows creation of these discounts"
}
},
"additionalProperties": false
}Correct the booking holder's name, email or phone on a confirmed hotel booking, for example to fix a typo. It does not change dates, rooms or guests. To show the customer prices for other dates or guests, use `post_bookings_bookingid_alternative_prebooks`. Pass the `bookingId`, the `email` currently on the booking and the corrected `holder` (`firstName`, `lastName`, `email`, optional `phone`). Confirm the new details with the customer before calling. Requires the `bookingId` and the `email` used to book: the server only returns or changes a booking when they match.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address currently on the booking, used to verify the customer. A new email goes in holder.email. |
| holder* | object | The corrected booking holder. Send firstName, lastName and email even if only one of them changes. |
| remarks | string | Optional note for the amendment. |
| lastName | string | The booking holder's last name, if the customer gives it. Optional. |
| bookingId* | string | The booking ID from the booking confirmation. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bookingId",
"email",
"holder"
],
"properties": {
"email": {
"type": "string",
"description": "The email address currently on the booking, used to verify the customer. A new email goes in holder.email."
},
"holder": {
"type": "object",
"required": [
"firstName",
"lastName",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The holder's email address."
},
"phone": {
"type": "string",
"description": "The holder's phone number."
},
"lastName": {
"type": "string",
"description": "The holder's last name."
},
"firstName": {
"type": "string",
"description": "The holder's first name."
}
},
"description": "The corrected booking holder. Send firstName, lastName and email even if only one of them changes.",
"additionalProperties": false
},
"remarks": {
"type": "string",
"description": "Optional note for the amendment."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name, if the customer gives it. Optional."
},
"bookingId": {
"type": "string",
"description": "The booking ID from the booking confirmation."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"hotelId",
"query"
],
"properties": {
"query": {
"type": "string",
"description": "The question to ask about the hotel"
},
"hotelId": {
"type": "string",
"description": "Unique ID of the hotel (MAQAMI format)"
},
"allowWebSearch": {
"type": "boolean",
"description": "Whether to allow web search for additional information. Default is false."
}
},
"additionalProperties": false
}| placeId |
| string |
| Unique ID of a place retrieved from the `/data/places` endpoint. When provided, the API fetches place details and searches for hotels within a 1km radius of the place location center, or a specific hotel when the placeId refers to a property. The response includes a `place` object containing the place information used in the search. |
| timeout | number | request timeout in seconds |
| aiSearch | string | Search term for AI search. Uses semantic search to find hotels matching the query intent. Examples: 'Romantic getaway with Italian vibes in London near the London Eye', 'Hotels near the Eiffel tower' |
| chainIds | string | Comma-separated list of hotel chain ids. e.g. '14675,14677' |
| cityName | string | Name of the city |
| hotelIds | string | Comma-separated list of hotel IDs (e.g., 'lp1897,lp1343') to fetch specific hotels by their IDs. This is a valid main query parameter that can be used instead of other search criteria. |
| language | string | The language code, indicating in which language the results should be returned. e.g. 'fr' |
| latitude | number | Latitude geo coordinates |
| hotelName | string | Name of the hotel (loose match, case-insensitive, e.g. 'hilton') |
| longitude | number | Longitude geo coordinates |
| minRating | number | Minimum rating of the hotel. e.g. 8.6 |
| starRating | string | Comma-separated list of star ratings. Note: star ratings have 2 allowed decimals '.0' and '.5' from 1 to 5. e.g. '3.5,4.0,5.0' |
| countryCode | string | Country code ISO-2 code - example (SG) |
| facilityIds | string | Comma-separated list of facilities. e.g. '1,2,3' |
| hotelTypeIds | string | Comma-separated list of hotel types. e.g. '201,204,208' |
| lastUpdatedAt | string | Retrieve only the hotels that have been updated since the provided date and time (using the RFC3339 format) |
| minReviewsCount | number | Minimum number of reviews. e.g. 100 |
| advancedAccessibilityOnly | boolean | If `true`, only hotels with advanced accessibility will be returned |
| strictFacilitiesFiltering | boolean | If `true`, only hotels with all the specified facilities will be returned |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"zip": {
"type": "string",
"description": "ZIP code of the location"
},
"limit": {
"type": "integer",
"description": "Specifies the maximum number of results to return. By default, this is set to 200, even if not explicitly defined. If a higher limit is specified, the maximum allowed is 5000 results"
},
"offset": {
"type": "integer",
"description": "Specifies the number of rows to skip before starting to return rows"
},
"radius": {
"type": "integer",
"description": "radius in meters (min 1000m)"
},
"placeId": {
"type": "string",
"description": "Unique ID of a place retrieved from the `/data/places` endpoint. When provided, the API fetches place details and searches for hotels within a 1km radius of the place location center, or a specific hotel when the placeId refers to a property. The response includes a `place` object containing the place information used in the search."
},
"timeout": {
"type": "number",
"description": "request timeout in seconds"
},
"aiSearch": {
"type": "string",
"description": "Search term for AI search. Uses semantic search to find hotels matching the query intent. Examples: 'Romantic getaway with Italian vibes in London near the London Eye', 'Hotels near the Eiffel tower'"
},
"chainIds": {
"type": "string",
"description": "Comma-separated list of hotel chain ids. e.g. '14675,14677'"
},
"cityName": {
"type": "string",
"description": "Name of the city"
},
"hotelIds": {
"type": "string",
"description": "Comma-separated list of hotel IDs (e.g., 'lp1897,lp1343') to fetch specific hotels by their IDs. This is a valid main query parameter that can be used instead of other search criteria."
},
"language": {
"type": "string",
"description": "The language code, indicating in which language the results should be returned. e.g. 'fr'"
},
"latitude": {
"type": "number",
"description": "Latitude geo coordinates"
},
"hotelName": {
"type": "string",
"description": "Name of the hotel (loose match, case-insensitive, e.g. 'hilton')"
},
"longitude": {
"type": "number",
"description": "Longitude geo coordinates"
},
"minRating": {
"type": "number",
"description": "Minimum rating of the hotel. e.g. 8.6"
},
"starRating": {
"type": "string",
"description": "Comma-separated list of star ratings. Note: star ratings have 2 allowed decimals '.0' and '.5' from 1 to 5. e.g. '3.5,4.0,5.0'"
},
"countryCode": {
"type": "string",
"description": "Country code ISO-2 code - example (SG)"
},
"facilityIds": {
"type": "string",
"description": "Comma-separated list of facilities. e.g. '1,2,3'"
},
"hotelTypeIds": {
"type": "string",
"description": "Comma-separated list of hotel types. e.g. '201,204,208'"
},
"lastUpdatedAt": {
"type": "string",
"description": "Retrieve only the hotels that have been updated since the provided date and time (using the RFC3339 format)"
},
"minReviewsCount": {
"type": "number",
"description": "Minimum number of reviews. e.g. 100"
},
"advancedAccessibilityOnly": {
"type": "boolean",
"description": "If `true`, only hotels with advanced accessibility will be returned"
},
"strictFacilitiesFiltering": {
"type": "boolean",
"description": "If `true`, only hotels with all the specified facilities will be returned"
}
},
"additionalProperties": false
}| Type |
|---|
| Description |
|---|
| city | string | Filter results by city name. Can be used alone or together with country. |
| limit | integer | Maximum number of results to return (maps to top_k in the API) |
| query* | string | Search query describing the room you're looking for. Can be visual (e.g., 'luxury modernist comfort', 'blue accessible bathroom'), amenity-based (e.g., 'twin room with a city view'), or style-based (e.g., 'art deco hotel room', 'brutalist room') |
| radius | number | Search radius in kilometers. Only used when latitude/longitude is provided, or when placeId is provided but the place does not have viewport information. When placeId is provided and viewport is available, the viewport boundaries are used instead of this radius. Default is 12km. |
| country | string | Filter results by country code (ISO 3166-1 alpha-2 format, e.g., 'FR', 'US'). Can be used alone or together with city. |
| placeId | string | Place ID. If provided, the search will be limited to hotels within the place's viewport boundaries (or the provided `radius` if viewport is unavailable). The place's latitude and longitude will be automatically fetched. |
| latitude | number | Latitude coordinate for geographic filtering. Must be provided together with longitude. Ignored if placeId is provided. |
| longitude | number | Longitude coordinate for geographic filtering. Must be provided together with latitude. Ignored if placeId is provided. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"query"
],
"properties": {
"city": {
"type": "string",
"description": "Filter results by city name. Can be used alone or together with country."
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return (maps to top_k in the API)"
},
"query": {
"type": "string",
"description": "Search query describing the room you're looking for. Can be visual (e.g., 'luxury modernist comfort', 'blue accessible bathroom'), amenity-based (e.g., 'twin room with a city view'), or style-based (e.g., 'art deco hotel room', 'brutalist room')"
},
"radius": {
"type": "number",
"description": "Search radius in kilometers. Only used when latitude/longitude is provided, or when placeId is provided but the place does not have viewport information. When placeId is provided and viewport is available, the viewport boundaries are used instead of this radius. Default is 12km."
},
"country": {
"type": "string",
"description": "Filter results by country code (ISO 3166-1 alpha-2 format, e.g., 'FR', 'US'). Can be used alone or together with city."
},
"placeId": {
"type": "string",
"description": "Place ID. If provided, the search will be limited to hotels within the place's viewport boundaries (or the provided `radius` if viewport is unavailable). The place's latitude and longitude will be automatically fetched."
},
"latitude": {
"type": "number",
"description": "Latitude coordinate for geographic filtering. Must be provided together with longitude. Ignored if placeId is provided."
},
"longitude": {
"type": "number",
"description": "Longitude coordinate for geographic filtering. Must be provided together with latitude. Ignored if placeId is provided."
}
},
"additionalProperties": false
}| getSentiment | boolean | If set to true, an AI sentiment analysis of the last 1000 reviews will be returned |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"hotelId"
],
"properties": {
"limit": {
"type": "integer",
"description": "Specifies the maximum number of results to return. By default, this is set to 200, even if not explicitly defined. If a higher limit is specified, the maximum allowed is 5000 results"
},
"offset": {
"type": "integer",
"description": "Specifies the number of reviews to skip, defaults to 0"
},
"hotelId": {
"type": "string",
"description": "Unique ID of a hotel"
},
"timeout": {
"type": "number",
"description": "request timeout in seconds"
},
"language": {
"type": "string",
"description": "ISO 639-1 language code (e.g., 'fr', 'es', 'de') to translate reviews using AI. If not provided, the reviews will be returned in the default language (en). When this parameter is provided, the maximum number of reviews returned is 10."
},
"getSentiment": {
"type": "boolean",
"description": "If set to true, an AI sentiment analysis of the last 1000 reviews will be returned"
}
},
"additionalProperties": false
}| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to make the booking. The server checks it against the booking before returning or changing anything. |
| lastName | string | The booking holder's last name, if the customer gives it. Optional. |
| bookingId* | string | The unique booking identifier |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bookingId",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to make the booking. The server checks it against the booking before returning or changing anything."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name, if the customer gives it. Optional."
},
"bookingId": {
"type": "string",
"description": "The unique booking identifier"
}
},
"additionalProperties": false
}| bookingId* | string | The unique booking identifier |
| forceRefresh | boolean | Bypass the provider's 15-minute services cache |
| includeServicesHistory | boolean | Include non-confirmed bookedServices rows (pending, requested, failed, replaced, dropped). By default only confirmed rows are returned. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bookingId",
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to make the booking. The server checks it against the booking before returning or changing anything."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name, if the customer gives it. Optional."
},
"bookingId": {
"type": "string",
"description": "The unique booking identifier"
},
"forceRefresh": {
"type": "boolean",
"description": "Bypass the provider's 15-minute services cache"
},
"includeServicesHistory": {
"type": "boolean",
"description": "Include non-confirmed bookedServices rows (pending, requested, failed, replaced, dropped). By default only confirmed rows are returned."
}
},
"additionalProperties": false
}| checkin | string | The new check-in date in YYYY-MM-DD format. Must be before `checkout`. |
| checkout | string | The new check-out date in YYYY-MM-DD format. Must be after `checkin`. |
| lastName | string | The booking holder's last name, if the customer gives it. Optional. |
| boardType | string | Filter results by board/meal-plan type (e.g. `RO` for Room Only, `BB` for Bed & Breakfast). Leave empty to return all board types. |
| bookingId* | string | (Required) The unique identifier of the confirmed booking to amend. |
| maxPrebooks | integer | Maximum number of alternative prebook sessions to create. Defaults to 3 when omitted. Values above 10 are silently capped at 10; values ≤ 0 fall back to the default. The response may contain fewer entries when the hotel does not have enough distinct alternative offers. |
| occupancies* | array | The desired room occupancies for the amended stay. One entry per room. |
| refundableRatesOnly | boolean | When true, only fully refundable alternative rates are returned. Defaults to false (or true if the original booking was refundable). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"bookingId",
"email",
"occupancies"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to make the booking. The server checks it against the booking before returning or changing anything."
},
"checkin": {
"type": "string",
"description": "The new check-in date in YYYY-MM-DD format. Must be before `checkout`."
},
"checkout": {
"type": "string",
"description": "The new check-out date in YYYY-MM-DD format. Must be after `checkin`."
},
"lastName": {
"type": "string",
"description": "The booking holder's last name, if the customer gives it. Optional."
},
"boardType": {
"type": "string",
"description": "Filter results by board/meal-plan type (e.g. `RO` for Room Only, `BB` for Bed & Breakfast). Leave empty to return all board types."
},
"bookingId": {
"type": "string",
"description": "(Required) The unique identifier of the confirmed booking to amend."
},
"maxPrebooks": {
"type": "integer",
"description": "Maximum number of alternative prebook sessions to create. Defaults to 3 when omitted. Values above 10 are silently capped at 10; values ≤ 0 fall back to the default. The response may contain fewer entries when the hotel does not have enough distinct alternative offers."
},
"occupancies": {
"type": "array",
"items": {
"type": "object",
"required": [
"adults"
],
"properties": {
"adults": {
"type": "integer",
"description": "Number of adults for this room."
},
"children": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Ages of children for this room (empty array if no children)."
}
},
"additionalProperties": false
},
"description": "The desired room occupancies for the amended stay. One entry per room."
},
"refundableRatesOnly": {
"type": "boolean",
"description": "When true, only fully refundable alternative rates are returned. Defaults to false (or true if the original booking was refundable)."
}
},
"additionalProperties": false
}| tone | string | Global writing guidance, e.g. `professional and inviting` or `calm and practical`. Truncated to 200 characters (5,000 for enterprise accounts). |
| count | integer | Number of highlights to generate. If `highlights` is supplied, `count` must equal its length. |
| style | string | Formatting preferences such as title or description length. When supplied, these rules override the default title (2-4 words) and description (~180 characters) lengths. Truncated to 200 characters (5,000 for enterprise accounts). |
| hotelId* | string | Unique ID of the hotel (MAQAMI format) |
| language* | string | Language code. Highlights are generated directly in this language. |
| highlights | array | Per-highlight guidance. Omit for generic generation. When supplied, its length must equal `count` and the response preserves this order. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"hotelId",
"language"
],
"properties": {
"tone": {
"type": "string",
"description": "Global writing guidance, e.g. `professional and inviting` or `calm and practical`. Truncated to 200 characters (5,000 for enterprise accounts)."
},
"count": {
"type": "integer",
"description": "Number of highlights to generate. If `highlights` is supplied, `count` must equal its length."
},
"style": {
"type": "string",
"description": "Formatting preferences such as title or description length. When supplied, these rules override the default title (2-4 words) and description (~180 characters) lengths. Truncated to 200 characters (5,000 for enterprise accounts)."
},
"hotelId": {
"type": "string",
"description": "Unique ID of the hotel (MAQAMI format)"
},
"language": {
"type": "string",
"description": "Language code. Highlights are generated directly in this language."
},
"highlights": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Partner-defined category label, echoed back in the response."
},
"context": {
"type": "string",
"description": "Free-text guidance describing what this highlight should emphasise. Treated as topic guidance only; claims not supported by the hotel's data will not be invented. Truncated to 300 characters (10,000 for enterprise accounts)."
}
},
"additionalProperties": false
},
"description": "Per-highlight guidance. Omit for generic generation. When supplied, its length must equal `count` and the response preserves this order."
}
},
"additionalProperties": false
}| integer |
| Number of adults (12+) |
| country | string | Optional ISO 3166-1 alpha-2 country code for point of sale |
| filters | object | Optional filters to refine search results |
| infants | integer | Number of infants (<2) |
| children | integer | Number of children (2-11) |
| currency* | string | ISO 4217 currency code |
| cabinClass | string | Cabin class (provider SearchFilters codes only). Same enum as filters.cabinClass. |
| infantAges | array | Age of each infant (under 2, per IATA). Length must equal infants count. Optional — omit if ages are not relevant. |
| childrenAges | array | Age of each child (2–11 inclusive, per IATA). Length must equal children count. Optional — omit if ages are not relevant. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"legs",
"adults",
"currency"
],
"properties": {
"legs": {
"type": "array",
"items": {
"type": "object",
"required": [
"origin",
"destination",
"date"
],
"properties": {
"date": {
"type": "string",
"description": "Departure date for this leg (YYYY-MM-DD). Must not be more than 11 months from today."
},
"origin": {
"type": "string",
"description": "Origin airport or city IATA code for this leg"
},
"filters": {
"type": "object",
"properties": {
"maxStops": {
"type": "integer",
"description": "Max stops for this leg. Counts connections between segments and en-route technical stops inside a segment (segments[].stopCount); 0 = genuinely non-stop."
},
"maxDuration": {
"type": "integer",
"description": "Max leg duration in minutes"
},
"flightNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by flight numbers (e.g. SK500, AF123)"
},
"excludeAirlines": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exclude airlines on this leg only (2-character IATA airline codes, case-insensitive): a journey is removed when a flight on this leg is marketed or operated by one of them. Replaces the top-level filters.excludeAirlines on this leg; airlines excluded on your account are always excluded."
},
"arrivalTimeAfter": {
"type": "string",
"description": "Arrival after this local time (HH:MM, 24h)"
},
"excludeOvernight": {
"type": "boolean",
"description": "Exclude red-eye flights and overnight layovers"
},
"arrivalTimeBefore": {
"type": "string",
"description": "Arrival before this local time (HH:MM, 24h)"
},
"departureTimeAfter": {
"type": "string",
"description": "Departure after this local time (HH:MM, 24h)"
},
"flightNumbersMatch": {
"enum": [
"any",
"all"
],
"type": "string"
},
"departureTimeBefore": {
"type": "string",
"description": "Departure before this local time (HH:MM, 24h)"
},
"excludeConnectionAirports": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exclude layovers at these airports (e.g. IST, DOH)"
}
},
"description": "Optional per-leg filters overriding global `filters` for this leg",
"additionalProperties": false
},
"direction": {
"enum": [
"OUTBOUND",
"INBOUND"
],
"type": "string"
},
"destination": {
"type": "string",
"description": "Destination airport or city IATA code for this leg"
}
},
"additionalProperties": false
},
"description": "Ordered itinerary legs (provider SearchLeg). One-way: one entry. Round-trip: outbound then inbound. Multi-city / open-jaw: additional legs in travel order."
},
"sort": {
"type": "object",
"properties": {
"sortBy": {
"enum": [
"price",
"duration",
"departure",
"arrival",
"stops"
],
"type": "string"
},
"sortOrder": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
"description": "Sort options for results",
"additionalProperties": false
},
"adults": {
"type": "integer",
"description": "Number of adults (12+)"
},
"country": {
"type": "string",
"description": "Optional ISO 3166-1 alpha-2 country code for point of sale"
},
"filters": {
"type": "object",
"properties": {
"maxPrice": {
"type": "number",
"description": "Maximum total price (offer total, in search currency)"
},
"maxStops": {
"type": "integer",
"description": "Maximum number of stops: -1 or omit = any, 0 = genuinely non-stop, 1 = 1 or fewer, 2 = 2 or fewer. Stops include both connections between segments and en-route technical stops inside a segment (segments[].stopCount), so a single flight number with a technical landing is excluded by maxStops: 0."
},
"minPrice": {
"type": "number",
"description": "Minimum total price (offer total, in search currency)"
},
"cabinClass": {
"enum": [
"ECONOMY",
"PREMIUM_ECONOMY",
"BUSINESS",
"FIRST",
"Economy",
"Business",
"First"
],
"type": "string"
},
"maxDuration": {
"type": "integer",
"description": "Maximum total journey duration in minutes (inclusive). Journeys exceeding this duration are excluded."
},
"legDurations": {
"type": "array",
"items": {
"type": "object",
"required": [
"direction",
"maxMinutes"
],
"properties": {
"direction": {
"enum": [
"OUTBOUND",
"INBOUND"
],
"type": "string"
},
"maxMinutes": {
"type": "integer",
"description": "Maximum leg duration in minutes (inclusive)"
}
},
"additionalProperties": false
},
"description": "Per-leg max duration constraints. Each entry limits one direction (OUTBOUND or INBOUND) independently."
},
"flightNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by flight numbers (e.g. SK500, AF123)"
},
"changeableOnly": {
"type": "boolean",
"description": "When true, only show offers with changeable (modifiable) fares"
},
"refundableOnly": {
"type": "boolean",
"description": "When true, only show offers with refundable fares"
},
"cabinClassMatch": {
"enum": [
"exactly",
"at_least"
],
"type": "string"
},
"excludeAirlines": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exclude airlines (2-character IATA airline codes, case-insensitive): a journey is removed when any of its flights is marketed or operated by one of them (codeshares included), and an offer is removed when one of them is its validating (ticketing) carrier. A leg's own filters.excludeAirlines replaces this list on that leg. Airlines excluded on your account are always excluded in addition to this list."
},
"excludeOvernight": {
"type": "boolean",
"description": "Exclude red-eye flights and overnight layovers"
},
"arrivalTimeBefore": {
"type": "string",
"description": "Filter journeys arriving before this time (HH:MM, 24h)"
},
"flightNumbersMatch": {
"enum": [
"any",
"all"
],
"type": "string"
},
"includesCarryOnBag": {
"type": "boolean",
"description": "Only show offers with carry-on included"
},
"includesCheckedBag": {
"type": "boolean",
"description": "Only show offers with checked bag included"
},
"departureTimeBefore": {
"type": "string",
"description": "Filter journeys departing before this time (HH:MM, 24h)"
},
"showCheapestOfferOnly": {
"type": "boolean",
"description": "Return only cheapest offer per journey"
},
"excludeConnectionAirports": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exclude layovers at these airports (e.g. IST, DOH)"
}
},
"description": "Optional filters to refine search results",
"additionalProperties": false
},
"infants": {
"type": "integer",
"description": "Number of infants (<2)"
},
"children": {
"type": "integer",
"description": "Number of children (2-11)"
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code"
},
"cabinClass": {
"enum": [
"ECONOMY",
"PREMIUM_ECONOMY",
"BUSINESS",
"FIRST"
],
"type": "string",
"description": "Cabin class (provider SearchFilters codes only). Same enum as filters.cabinClass."
},
"infantAges": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Age of each infant (under 2, per IATA). Length must equal infants count. Optional — omit if ages are not relevant."
},
"childrenAges": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Age of each child (2–11 inclusive, per IATA). Length must equal children count. Optional — omit if ages are not relevant."
}
},
"additionalProperties": false
}| occupancies* | array |
| guestNationality* | string | Guest nationality (ISO 2-code) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"hotelIds",
"occupancies",
"checkin",
"checkout",
"currency",
"guestNationality"
],
"properties": {
"checkin": {
"type": "string",
"description": "Check in date in YYYY-MM-DD (ISO 8601) format"
},
"timeout": {
"type": "number",
"description": "Request timeout in seconds"
},
"checkout": {
"type": "string",
"description": "Check out date in YYYY-MM-DD (ISO 8601) format"
},
"currency": {
"type": "string",
"description": "Booking currency"
},
"hotelIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of hotel IDs"
},
"occupancies": {
"type": "array",
"items": {
"type": "object",
"required": [
"adults"
],
"properties": {
"adults": {
"type": "integer",
"description": "Number of adults in each selected room"
},
"children": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ages of children of each selected room"
}
},
"additionalProperties": false
}
},
"guestNationality": {
"type": "string",
"description": "Guest nationality (ISO 2-code)"
}
},
"additionalProperties": false
}| feed |
| string |
| Which rate feed to search. Leave unset to use the default feed. |
| sort | array | Sorting criteria for the results. Multiple criteria can be provided, processed in order. The default sorting is by top picks (weighted by search popularity, review quality, and content completeness). Use 'revenue' to sort by historical booking value and monetary performance. |
| limit | integer | The maximum number of results to return. Defaults to 200, max allowed is 5000. |
| offset | integer | The number of results to skip for pagination. This paginates the passed hotels not the results returned so the actual returned results will vary. |
| radius | integer | The search radius in meters for location-based searches. Pairs with latitude to do a lat/long search. |
| stream | boolean | If true, enables streaming mode where response data is sent incrementally instead of as a single payload. |
| checkin* | string | The check-in date in YYYY-MM-DD format (ISO 8601). |
| placeId | string | The unique Place ID of the search location. Instead of using hotel IDs, pass a Place ID to get all the hotels in the specified region. This is a valid main query. |
| timeout | integer | The maximum time in seconds before the request times out. This is when the live request for rates will cut off responses; it will take a few more ms to return the value. |
| aiSearch | string | AI-powered hotel search based on a natural language query. Uses semantic search to find hotels matching the query intent. Examples: 'Romantic getaway with Italian vibes in London near the London Eye', 'hotels near Paris'. This is a valid main query. |
| bedTypes | array | Filter results by bed types extracted from room names. Only rates from rooms matching the specified bed types will be returned. Example values: 'double', 'twin', 'king', 'queen', 'single'. |
| chainIds | array | An array of hotel chain IDs to filter the search results. This is a filter on top of the main query. |
| checkout* | string | The check-out date in YYYY-MM-DD format (ISO 8601). |
| cityName | string | The name of the city to search for hotels in. Pairs with countryCode to do a country/city search. |
| currency* | string | The currency in which the prices will be displayed. |
| hotelIds | array | An array of hotel IDs to search for availability and pricing. Get them from `get_data_hotels` or `get_data_hotel_search`. |
| iataCode | string | The IATA code of the search location, typically an airport code. Instead of using hotel IDs, you can search by IATA code. This is a valid main query. |
| latitude | number | The latitude coordinate for location-based hotel searches. Instead of using hotel IDs, you can search by lat/long and a radius around that spot. This is a valid main query. |
| boardType | string | Filter results by board type(s). Can be a single value (e.g., 'BI') or comma-separated values (e.g., 'BI,HB') for OR logic. Example values: RO (Room Only), BI (Breakfast Included), HB (Half Board), FB (Full Board), AI (All Inclusive), DI (Dinner Included), LI (Lunch Included), BDI (Breakfast and Dinner Included), BLI (Breakfast and Lunch Included), LDI (Lunch and Dinner Included). |
| hotelName | string | A case-insensitive search for a hotel's name (e.g., 'Hilton'). |
| longitude | number | The longitude coordinate for location-based hotel searches. Pairs with latitude to do a lat/long search. |
| minRating | number | The minimum rating (on a scale of 0-5) required for hotels in search results. This is a filter on top of the main query. |
| sessionId | string | Optional client-generated session identifier that ensures price consistency for the user's search session. Pass the same `sessionId` with the same `checkin` and `checkout` across related requests in that session. |
| facilities | array | An array of facility IDs. Results will include hotels with at least one of these facilities by default. This is a filter on top of the main query. |
| starRating | array | An array of hotel star ratings to include. Ratings are rounded to the nearest half-star (e.g., [3.5, 4.0, 4.5, 5.0]). This is a filter on top of the main query. |
| countryCode | string | The country code in ISO 2-letter format (e.g., 'SG' for Singapore). Instead of using hotel IDs, you can search by country/city. This is a valid main query. |
| occupancies* | array | An array of objects specifying the number of guests per room. Required. |
| roomMapping | boolean | Enable room mapping to retrieve the mappedRoomId for each room. This allows you to link a rate to its specific room by combining it with hotel details, providing access to room images and additional information |
| hotelTypeIds | array | An array of hotel type IDs to filter the search results. This is a filter on top of the main query. |
| roomAmenities | array | Legacy room-level amenity filter. Only rates from rooms that match the specified amenities will be returned. Use amenityFilterLogic to control flat AND/OR behavior. If roomAmenitiesFilter is provided, it takes precedence over this field. |
| loyaltyProgram | string | Loyalty program identifier used to request loyalty-eligible rates from supported suppliers. When set, rates that support the program may return member pricing and benefits. |
| minReviewsCount | integer | The minimum number of reviews a hotel must have to be included in results. This is a filter on top of the main query. |
| guestNationality* | string | The guest's nationality in ISO 2-letter country code format. |
| includeHotelData | boolean | If `true`, includes hotel data (name, main photo, address, rating) in the response even when searching by direct hotel IDs. By default, hotel data is only included when searching by filters (e.g., using `aiSearch`, `countryCode`, `cityName`, etc.). Setting this to `true` enables hotel data inclusion for all search types. |
| maxRatesPerHotel | integer | The number of room rates to return per hotel, sorted by price (cheapest first). Set to 1 to just get the cheapest rate for each hotel, this is helpful for listing pages. Try increasing this if you are missing rate types, and be aware that the cap is applied before room mapping. |
| amenityFilterLogic | string | Legacy logic applied to roomAmenities. 'AND': room must have all specified amenities. 'OR': room must have at least one specified amenity. Ignored when roomAmenitiesFilter is provided. |
| refundableRatesOnly | boolean | If true, only refundable rates (RFN) will be included in the response. |
| roomAmenitiesFilter | string | Grouped room-level amenity filter. Use '-' for OR within a group and ',' for AND across groups. Example: '1-2,3-4' means (1 OR 2) AND (3 OR 4). If provided, this field takes precedence over roomAmenities and amenityFilterLogic. |
| loyaltyProgramDetails | array | Loyalty membership details forwarded to supported suppliers to unlock member rates and benefits. Provide one entry per loyalty program membership. |
| strictFacilityFiltering | boolean | If enabled, only hotels with all specified facilities will be returned. |
| advancedAccessibilityOnly | boolean | If true, only hotels with advanced accessibility features will be returned. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"occupancies",
"currency",
"guestNationality",
"checkin",
"checkout"
],
"properties": {
"zip": {
"type": "string",
"description": "The zip code of the search location. This is a filter on top of the main query."
},
"feed": {
"type": "string",
"description": "Which rate feed to search. Leave unset to use the default feed."
},
"sort": {
"type": "array",
"items": {
"type": "object",
"required": [
"field"
],
"properties": {
"field": {
"enum": [
"top_picks",
"price",
"revenue"
],
"type": "string"
},
"direction": {
"enum": [
"ascending",
"descending"
],
"type": "string"
}
},
"additionalProperties": false
},
"description": "Sorting criteria for the results. Multiple criteria can be provided, processed in order. The default sorting is by top picks (weighted by search popularity, review quality, and content completeness). Use 'revenue' to sort by historical booking value and monetary performance."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to return. Defaults to 200, max allowed is 5000."
},
"offset": {
"type": "integer",
"description": "The number of results to skip for pagination. This paginates the passed hotels not the results returned so the actual returned results will vary."
},
"radius": {
"type": "integer",
"description": "The search radius in meters for location-based searches. Pairs with latitude to do a lat/long search."
},
"stream": {
"type": "boolean",
"description": "If true, enables streaming mode where response data is sent incrementally instead of as a single payload."
},
"checkin": {
"type": "string",
"description": "The check-in date in YYYY-MM-DD format (ISO 8601)."
},
"placeId": {
"type": "string",
"description": "The unique Place ID of the search location. Instead of using hotel IDs, pass a Place ID to get all the hotels in the specified region. This is a valid main query."
},
"timeout": {
"type": "integer",
"description": "The maximum time in seconds before the request times out. This is when the live request for rates will cut off responses; it will take a few more ms to return the value."
},
"aiSearch": {
"type": "string",
"description": "AI-powered hotel search based on a natural language query. Uses semantic search to find hotels matching the query intent. Examples: 'Romantic getaway with Italian vibes in London near the London Eye', 'hotels near Paris'. This is a valid main query."
},
"bedTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter results by bed types extracted from room names. Only rates from rooms matching the specified bed types will be returned. Example values: 'double', 'twin', 'king', 'queen', 'single'."
},
"chainIds": {
"type": "array",
"items": {
"type": "number"
},
"description": "An array of hotel chain IDs to filter the search results. This is a filter on top of the main query."
},
"checkout": {
"type": "string",
"description": "The check-out date in YYYY-MM-DD format (ISO 8601)."
},
"cityName": {
"type": "string",
"description": "The name of the city to search for hotels in. Pairs with countryCode to do a country/city search."
},
"currency": {
"type": "string",
"description": "The currency in which the prices will be displayed."
},
"hotelIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of hotel IDs to search for availability and pricing. Get them from `get_data_hotels` or `get_data_hotel_search`."
},
"iataCode": {
"type": "string",
"description": "The IATA code of the search location, typically an airport code. Instead of using hotel IDs, you can search by IATA code. This is a valid main query."
},
"latitude": {
"type": "number",
"description": "The latitude coordinate for location-based hotel searches. Instead of using hotel IDs, you can search by lat/long and a radius around that spot. This is a valid main query."
},
"boardType": {
"type": "string",
"description": "Filter results by board type(s). Can be a single value (e.g., 'BI') or comma-separated values (e.g., 'BI,HB') for OR logic. Example values: RO (Room Only), BI (Breakfast Included), HB (Half Board), FB (Full Board), AI (All Inclusive), DI (Dinner Included), LI (Lunch Included), BDI (Breakfast and Dinner Included), BLI (Breakfast and Lunch Included), LDI (Lunch and Dinner Included)."
},
"hotelName": {
"type": "string",
"description": "A case-insensitive search for a hotel's name (e.g., 'Hilton')."
},
"longitude": {
"type": "number",
"description": "The longitude coordinate for location-based hotel searches. Pairs with latitude to do a lat/long search."
},
"minRating": {
"type": "number",
"description": "The minimum rating (on a scale of 0-5) required for hotels in search results. This is a filter on top of the main query."
},
"sessionId": {
"type": "string",
"description": "Optional client-generated session identifier that ensures price consistency for the user's search session. Pass the same `sessionId` with the same `checkin` and `checkout` across related requests in that session."
},
"facilities": {
"type": "array",
"items": {
"type": "number"
},
"description": "An array of facility IDs. Results will include hotels with at least one of these facilities by default. This is a filter on top of the main query."
},
"starRating": {
"type": "array",
"items": {
"type": "number"
},
"description": "An array of hotel star ratings to include. Ratings are rounded to the nearest half-star (e.g., [3.5, 4.0, 4.5, 5.0]). This is a filter on top of the main query."
},
"countryCode": {
"type": "string",
"description": "The country code in ISO 2-letter format (e.g., 'SG' for Singapore). Instead of using hotel IDs, you can search by country/city. This is a valid main query."
},
"occupancies": {
"type": "array",
"items": {
"type": "object",
"required": [
"adults"
],
"properties": {
"adults": {
"type": "integer",
"description": "Number of adults in each selected room"
},
"children": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ages of children of each selected room"
}
},
"additionalProperties": false
},
"description": "An array of objects specifying the number of guests per room. Required."
},
"roomMapping": {
"type": "boolean",
"description": "Enable room mapping to retrieve the mappedRoomId for each room. This allows you to link a rate to its specific room by combining it with hotel details, providing access to room images and additional information"
},
"hotelTypeIds": {
"type": "array",
"items": {
"type": "number"
},
"description": "An array of hotel type IDs to filter the search results. This is a filter on top of the main query."
},
"roomAmenities": {
"type": "array",
"items": {
"type": "number"
},
"description": "Legacy room-level amenity filter. Only rates from rooms that match the specified amenities will be returned. Use amenityFilterLogic to control flat AND/OR behavior. If roomAmenitiesFilter is provided, it takes precedence over this field."
},
"loyaltyProgram": {
"type": "string",
"description": "Loyalty program identifier used to request loyalty-eligible rates from supported suppliers. When set, rates that support the program may return member pricing and benefits."
},
"minReviewsCount": {
"type": "integer",
"description": "The minimum number of reviews a hotel must have to be included in results. This is a filter on top of the main query."
},
"guestNationality": {
"type": "string",
"description": "The guest's nationality in ISO 2-letter country code format."
},
"includeHotelData": {
"type": "boolean",
"description": "If `true`, includes hotel data (name, main photo, address, rating) in the response even when searching by direct hotel IDs. By default, hotel data is only included when searching by filters (e.g., using `aiSearch`, `countryCode`, `cityName`, etc.). Setting this to `true` enables hotel data inclusion for all search types."
},
"maxRatesPerHotel": {
"type": "integer",
"description": "The number of room rates to return per hotel, sorted by price (cheapest first). Set to 1 to just get the cheapest rate for each hotel, this is helpful for listing pages. Try increasing this if you are missing rate types, and be aware that the cap is applied before room mapping."
},
"amenityFilterLogic": {
"enum": [
"AND",
"OR"
],
"type": "string",
"description": "Legacy logic applied to roomAmenities. 'AND': room must have all specified amenities. 'OR': room must have at least one specified amenity. Ignored when roomAmenitiesFilter is provided."
},
"refundableRatesOnly": {
"type": "boolean",
"description": "If true, only refundable rates (RFN) will be included in the response."
},
"roomAmenitiesFilter": {
"type": "string",
"description": "Grouped room-level amenity filter. Use '-' for OR within a group and ',' for AND across groups. Example: '1-2,3-4' means (1 OR 2) AND (3 OR 4). If provided, this field takes precedence over roomAmenities and amenityFilterLogic."
},
"loyaltyProgramDetails": {
"type": "array",
"items": {
"type": "object",
"required": [
"membershipId",
"programId"
],
"properties": {
"programId": {
"type": "string",
"description": "The loyalty program identifier (e.g., 'HH' for Hilton Honors)."
},
"membershipId": {
"type": "string",
"description": "The guest's membership ID for the loyalty program."
}
},
"additionalProperties": false
},
"description": "Loyalty membership details forwarded to supported suppliers to unlock member rates and benefits. Provide one entry per loyalty program membership."
},
"strictFacilityFiltering": {
"type": "boolean",
"description": "If enabled, only hotels with all specified facilities will be returned."
},
"advancedAccessibilityOnly": {
"type": "boolean",
"description": "If true, only hotels with advanced accessibility features will be returned."
}
},
"additionalProperties": false
}