---
title: "Search availability across properties"
url: "https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78/operations/searchAvailability"
---

> Full API specification: https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78.md

# Search availability across properties

`GET` `/availability`

Operation ID: `searchAvailability`

For metasearch and listing pages. Returns the cheapest sellable offer per property for a destination, a list of properties, or a radius (one of `destination`, `properties` or `latitude`+`longitude` is required). Up to 50 properties are evaluated per call.

## Query parameters

- `destination` (string, optional)
- `properties` (string, optional) - Comma-separated property codes.
- `latitude` (number, optional)
- `longitude` (number, optional)
- `radius_km` (number, optional)
- `check_in` (string, date, required) - Arrival date (property-local), today or later.
- `check_out` (string, date, required) - Departure date, after check_in. Maximum 30 nights.
- `adults` (integer, required)
- `children` (integer, optional)
- `rooms` (integer, optional) - Rooms of the same type. 10+ rooms must be a group request.
- `max_total` (number, optional) - Exclude properties whose cheapest total exceeds this amount (property currency).
- `promotion_code` (string, optional)

## Responses

- `200` - Available properties.
- `422` - Invalid input or a booking rule violation.
- `429` - Rate limit exceeded.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Kong Hotels Partner API
  version: 1.0.0
servers:
  - url: https://api.konghotels.cloud
    description: Kong Gateway
paths:
  /availability:
    get:
      tags:
        - Availability
      operationId: searchAvailability
      summary: Search availability across properties
      description: >
        For metasearch and listing pages. Returns the cheapest sellable offer
        per property for a

        destination, a list of properties, or a radius (one of `destination`,
        `properties` or

        `latitude`+`longitude` is required). Up to 50 properties are evaluated
        per call.
      parameters:
        - name: destination
          in: query
          schema:
            type: string
            examples:
              - tokyo
        - name: properties
          in: query
          description: Comma-separated property codes.
          schema:
            type: string
            examples:
              - KTNYC,KBBRK
        - name: latitude
          in: query
          schema:
            type: number
        - name: longitude
          in: query
          schema:
            type: number
        - name: radius_km
          in: query
          schema:
            type: number
            default: 25
        - $ref: "#/components/parameters/CheckIn"
        - $ref: "#/components/parameters/CheckOut"
        - $ref: "#/components/parameters/Adults"
        - $ref: "#/components/parameters/Children"
        - $ref: "#/components/parameters/Rooms"
        - name: max_total
          in: query
          description: Exclude properties whose cheapest total exceeds this amount
            (property currency).
          schema:
            type: number
        - name: promotion_code
          in: query
          schema:
            type: string
      responses:
        "200":
          description: Available properties.
          headers:
            X-Request-ID:
              $ref: "#/components/headers/RequestId"
            X-RateLimit-Limit:
              $ref: "#/components/headers/RateLimitLimit"
            X-RateLimit-Remaining:
              $ref: "#/components/headers/RateLimitRemaining"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AvailabilitySearchResponse"
        "422":
          $ref: "#/components/responses/ValidationFailed"
        "429":
          $ref: "#/components/responses/RateLimited"
security:
  - KongKeyAuth: []
  - KongConsumer: []
components:
  parameters:
    CheckIn:
      name: check_in
      in: query
      required: true
      description: Arrival date (property-local), today or later.
      schema:
        type: string
        format: date
        examples:
          - 2026-12-04
    CheckOut:
      name: check_out
      in: query
      required: true
      description: Departure date, after check_in. Maximum 30 nights.
      schema:
        type: string
        format: date
        examples:
          - 2026-12-07
    Adults:
      name: adults
      in: query
      required: true
      schema:
        type: integer
        minimum: 1
        maximum: 36
        examples:
          - 2
    Children:
      name: children
      in: query
      schema:
        type: integer
        minimum: 0
        maximum: 18
        default: 0
    Rooms:
      name: rooms
      in: query
      description: Rooms of the same type. 10+ rooms must be a group request.
      schema:
        type: integer
        minimum: 1
        maximum: 9
        default: 1
  headers:
    RequestId:
      description: Correlation ID for support.
      schema:
        type: string
    RateLimitLimit:
      description: Requests allowed per minute in this bucket.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  schemas:
    AvailabilitySearchResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              property:
                type: object
                properties:
                  code:
                    type: string
                  name:
                    type: string
                  brand:
                    $ref: "#/components/schemas/BrandCode"
                  star_rating:
                    type: integer
                  city:
                    type: string
                  distance_km:
                    type:
                      - number
                      - "null"
              currency:
                type: string
              offer_count:
                type: integer
              lowest_offer:
                type: object
                properties:
                  room_type_code:
                    type: string
                  room_type_name:
                    type: string
                  rate_plan_code:
                    type: string
                  meal_plan:
                    $ref: "#/components/schemas/MealPlan"
                  requires_membership:
                    type: boolean
                  is_refundable:
                    type: boolean
                  average_nightly_rate:
                    $ref: "#/components/schemas/Money"
                  tax_total:
                    $ref: "#/components/schemas/Money"
                  total:
                    $ref: "#/components/schemas/Money"
              links:
                type: object
                properties:
                  availability:
                    type: string
                    format: uri
        meta:
          type: object
          properties:
            check_in:
              type: string
              format: date
            check_out:
              type: string
              format: date
            properties_searched:
              type: integer
            properties_available:
              type: integer
            generated_at:
              type: string
              format: date-time
    BrandCode:
      type: string
      enum:
        - kong-summit
        - kong-tower
        - kong-lagoon
        - kong-canopy
        - kong-basecamp
    MealPlan:
      type: string
      enum:
        - room_only
        - breakfast
        - half_board
        - all_inclusive
    Money:
      type: string
      pattern: ^-?\d+\.\d{2}$
      description: Decimal amount in the property currency.
      examples:
        - "389.00"
    ValidationProblem:
      allOf:
        - $ref: "#/components/schemas/Problem"
        - type: object
          properties:
            errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
            restrictions:
              type: array
              items:
                type: string
    Problem:
      type: object
      description: RFC 9457 problem details. Extra members (e.g. `available_units`,
        `restrictions`, `reasons`) may be present.
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        request_id:
          type: string
      additionalProperties: true
  responses:
    ValidationFailed:
      description: Invalid input or a booking rule violation.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ValidationProblem"
          examples:
            validation:
              value:
                type: https://developers.konghotels.example/problems/validation-failed
                title: Validation failed
                status: 422
                detail: One or more fields are invalid.
                instance: /quotes
                request_id: 7e6d5c4b-3a2f-4e1d-8c0b-9a8f7e6d5c4b
                errors:
                  check_out:
                    - The check out field must be a date after check in.
            bookingRule:
              value:
                type: https://developers.konghotels.example/problems/booking-rule-violation
                title: Booking rule violation
                status: 422
                detail: Rate plan ADV cannot be sold for these dates.
                instance: /quotes
                request_id: 8f7e6d5c-4b3a-4f2e-9d1c-0b9a8f7e6d5c
                restrictions:
                  - min_advance_purchase
    RateLimited:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          $ref: "#/components/headers/RetryAfter"
        X-RateLimit-Limit:
          $ref: "#/components/headers/RateLimitLimit"
        X-RateLimit-Remaining:
          $ref: "#/components/headers/RateLimitRemaining"
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/Problem"
          example:
            type: https://developers.konghotels.example/problems/rate-limited
            title: Too many requests
            status: 429
            detail: Rate limit exceeded. Retry after the number of seconds in the
              Retry-After header.
            instance: /availability
            request_id: 5b4a3f2e-1d0c-4b9a-8f7e-6d5c4b3a2f1e
  securitySchemes:
    KongKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your API key, validated by Kong Gateway. The header name depends on
        the gateway's key-auth configuration.
    KongConsumer:
      type: apiKey
      in: header
      name: X-Consumer-ID
      description: "**Local development only.** Simulates the consumer identity Kong
        Gateway injects after authentication."
```