# Retrieve real-time room availability

Retrieve real-time room availability and corresponding pricing based on specified criteria such as date range, room type, occupancy, and applicable rate plans

Endpoint: GET /api/v3/availabilities
Version: 3.0.4
Security: OAuth2

## Query parameters:

  - `dateFrom` (string, required)
    The start date of the availability search

  - `dateTo` (string, required)
    The end date of the availability search

  - `inventoryType` (string, required)
    The type of inventory to search for, either UNIT or UNIT_TYPE

  - `guests` (integer)
    The number of guests for the booking

  - `unitTypeType` (array)
    List of unit type types to search for, e.g. STUDIO, ONE_BEDROOM, TWO_BEDROOM

  - `promoCode` (string)
    Promotional code to apply to the search

  - `featureIds` (array)
    List of feature facility IDs to search for

  - `rateCode` (string)
    Rate code to apply to the search

  - `rateId` (integer)
    Rate Id to apply to the search

  - `ratePlanIds` (array)
    List of rate plan IDs to search for

  - `buildingIds` (array)
    List of building IDs to search for

  - `cityId` (integer)
    City Id to search for

  - `areaId` (integer)
    Area Id to search for

  - `bookingType` (string)
    Restrict results based on type of booking

## Response 200 fields (application/json):

  - `content` (array)

  - `content.inventoryType` (string)
    Inventory type, can be UNIT or UNIT_TYPE
    Enum: "UNIT", "UNIT_TYPE"

  - `content.inventoryTypeId` (integer)
    Inventory type ID, this is the ID of the Unit or Unit Type available
    Example: 1

  - `content.inventoryTypeName` (string)
    Inventory type name, this is the name of the Unit or Unit Type available
    Example: "1 Bedroom Apartment"

  - `content.buildingId` (integer)
    Building ID, this is the ID of the building where the Unit or Unit Type is available
    Example: 1

  - `content.buildingName` (string)
    Building name, this is the name of the building where the Unit or Unit Type is available
    Example: "Building 1"

  - `content.rateAvailabilities` (array)
    List of rate availabilities for the Unit or Unit Type
    Example: []

  - `content.rateAvailabilities.rateId` (integer)
    Rate ID
    Example: 1

  - `content.rateAvailabilities.rateCode` (string)
    Rate code
    Example: "SUMMER21"

  - `content.rateAvailabilities.description` (string)
    Description of the rate
    Example: "Summer Special Rate"

  - `content.rateAvailabilities.shortName` (string)
    Short name of the rate
    Example: "Summer Rate"

  - `content.rateAvailabilities.webDescription` (string)
    Web description of the rate
    Example: "Special summer rate with discounts"

  - `content.rateAvailabilities.interval` (object)
    Date interval for the rate

  - `content.rateAvailabilities.interval.dateFrom` (string)

  - `content.rateAvailabilities.interval.dateTo` (string)

  - `content.rateAvailabilities.priceFrom` (object)

  - `content.rateAvailabilities.priceFrom.gross` (number)

  - `content.rateAvailabilities.priceFrom.net` (number)

  - `content.rateAvailabilities.priceFrom.vat` (number)

  - `content.rateAvailabilities.promoPriceFrom` (object)

  - `content.rateAvailabilities.rateType` (string)
    Type of the rate
    Enum: "DAILY", "WEEKLY", "MONTHLY"

  - `content.rateAvailabilities.nights` (integer)
    Number of nights
    Example: 3

  - `content.rateAvailabilities.priceFromInterval` (number)
    Price from interval
    Example: 300

  - `content.rateAvailabilities.totals` (object)

  - `content.rateAvailabilities.avgTotals` (object)

  - `content.rateAvailabilities.avgRate` (number)
    Average rate
    Example: 100

  - `content.rateAvailabilities.promoTotals` (object)

  - `content.rateAvailabilities.promoAvgRate` (number)
    Promotional average rate
    Example: 80

  - `content.rateAvailabilities.promoCode` (string)
    Promotional code
    Example: "SUMMER21"

  - `content.rateAvailabilities.bookingTerms` (string)
    Booking terms
    Example: "Non-refundable"

  - `content.rateAvailabilities.ratePlanIdentifier` (string)
    Rate plan identifier
    Example: "RP123"

  - `content.rateAvailabilities.currencySymbol` (string)
    Currency symbol
    Example: "$"

  - `content.rateAvailabilities.currencyCode` (string)
    Currency code
    Example: "USD"

  - `content.rateAvailabilities.primaryCurrencyPriceFrom` (object)

  - `content.rateAvailabilities.tokeniseCard` (boolean)
    Tokenise card
    Example: true

  - `content.rateAvailabilities.dueNow` (object)

  - `content.rateAvailabilities.extrasDueNow` (object)

  - `content.rateAvailabilities.totalDeposit` (object)

  - `content.rateAvailabilities.initialDeposit` (number)
    Initial deposit
    Example: 50

  - `content.rateAvailabilities.vatInclusive` (boolean)
    VAT inclusive
    Example: true

  - `content.rateAvailabilities.compulsoryExtras` (array)
    List of compulsory extras included in the rate

  - `content.rateAvailabilities.compulsoryExtras.id` (integer)

  - `content.rateAvailabilities.compulsoryExtras.description` (string)

  - `content.rateAvailabilities.compulsoryExtras.descriptionTranslations` (array)

  - `content.rateAvailabilities.compulsoryExtras.grossNetVat` (object)

  - `content.rateAvailabilities.compulsoryExtras.webDescription` (string)

  - `content.rateAvailabilities.compulsoryExtras.frequency` (string)

  - `content.rateAvailabilities.compulsoryExtras.webCategory` (string)

  - `content.rateAvailabilities.compulsoryExtras.compulsory` (boolean)

  - `content.rateAvailabilities.compulsoryExtras.building` (string)

  - `content.rateAvailabilities.compulsoryExtras.unitType` (string)

  - `content.rateAvailabilities.compulsoryExtras.images` (array)

  - `content.rateAvailabilities.compulsoryExtras.images.type` (string)
    Enum: "GENERAL"

  - `content.rateAvailabilities.compulsoryExtras.images.url` (string)

  - `content.rateAvailabilities.compulsoryExtras.images.name` (string)

  - `content.rateAvailabilities.compulsoryExtras.images.thirdPartyUrl` (string)

  - `content.rateAvailabilities.compulsoryExtras.lengthOfStay` (number)

  - `content.rateAvailabilities.compulsoryExtras.pricingModel` (string)

  - `content.rateAvailabilities.compulsoryExtras.percentageValue` (number)

  - `content.rateAvailabilities.compulsoryExtras.roomRateBasis` (string)

  - `page` (object)

  - `page.size` (integer)

  - `page.totalElements` (integer)

  - `page.totalPages` (integer)

  - `page.number` (integer)