---
title: "Get a rate calendar"
url: "https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78/operations/getRateCalendar"
---

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

# Get a rate calendar

`GET` `/properties/{propertyCode}/calendar`

Operation ID: `getRateCalendar`

Day-by-day availability and the lowest Best Available Rate (per room per night, before taxes) for up to 93 days, for date pickers and "flexible dates" views. Indicative only; price a real stay with `/properties/{propertyCode}/availability`.

## Path parameters

- `propertyCode` (string, required) - Property code (case-insensitive).

## Query parameters

- `start_date` (string, date, required)
- `end_date` (string, date, required)
- `room_type` (string, optional)

## Responses

- `200` - Calendar days.
- `404` - Not found, or owned by another partner.
- `422` - Invalid input or a booking rule violation.

## 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:
  /properties/{propertyCode}/calendar:
    get:
      tags:
        - Availability
      operationId: getRateCalendar
      summary: Get a rate calendar
      description: >
        Day-by-day availability and the lowest Best Available Rate (per room per
        night, before taxes)

        for up to 93 days, for date pickers and "flexible dates" views.
        Indicative only; price a real

        stay with `/properties/{propertyCode}/availability`.
      parameters:
        - $ref: "#/components/parameters/PropertyCode"
        - name: start_date
          in: query
          required: true
          schema:
            type: string
            format: date
        - name: end_date
          in: query
          required: true
          schema:
            type: string
            format: date
        - name: room_type
          in: query
          schema:
            type: string
      responses:
        "200":
          description: Calendar days.
          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:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/CalendarDay"
                  meta:
                    type: object
                    properties:
                      property_code:
                        type: string
                      room_type:
                        type:
                          - string
                          - "null"
                      rate_basis:
                        type: string
        "404":
          $ref: "#/components/responses/NotFound"
        "422":
          $ref: "#/components/responses/ValidationFailed"
security:
  - KongKeyAuth: []
  - KongConsumer: []
components:
  parameters:
    PropertyCode:
      name: propertyCode
      in: path
      required: true
      description: Property code (case-insensitive).
      schema:
        type: string
        examples:
          - KTNYC
  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
  schemas:
    CalendarDay:
      type: object
      properties:
        date:
          type: string
          format: date
        is_available:
          type: boolean
        available_units:
          type: integer
        closed_to_arrival:
          type: boolean
        min_length_of_stay:
          type:
            - integer
            - "null"
        lowest_rate:
          oneOf:
            - $ref: "#/components/schemas/Money"
            - type: "null"
        currency:
          type: string
    Money:
      type: string
      pattern: ^-?\d+\.\d{2}$
      description: Decimal amount in the property currency.
      examples:
        - "389.00"
    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
    ValidationProblem:
      allOf:
        - $ref: "#/components/schemas/Problem"
        - type: object
          properties:
            errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
            restrictions:
              type: array
              items:
                type: string
  responses:
    NotFound:
      description: Not found, or owned by another partner.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/Problem"
          example:
            type: https://developers.konghotels.example/problems/not-found
            title: Resource not found
            status: 404
            detail: Property not found.
            instance: /properties/KXXXX
            request_id: 9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d
    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
  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."
```