# Availability Multi

<mark style="color:blue;">`GET`</mark> `https://api.rateparity.com/v1/availability/multi`

Returns multi-property availability for a chain code. Results include hotel metadata, lowest available rates, and filter metadata used for UI facets.

#### Query Parameters

| Name                                        | Type    | Description                                                            |
| ------------------------------------------- | ------- | ---------------------------------------------------------------------- |
| chainCode<mark style="color:red;">\*</mark> | String  | Chain code used to resolve availability credentials and property list. |
| checkin<mark style="color:red;">\*</mark>   | Date    | Check-in date in `YYYY-MM-DD` format.                                  |
| checkout<mark style="color:red;">\*</mark>  | Date    | Check-out date in `YYYY-MM-DD` format.                                 |
| adults                                      | Integer | Number of adults (must be greater than zero).                          |
| children                                    | Integer | Number of children.                                                    |
| infants                                     | Integer | Number of infants.                                                     |
| rooms                                       | Integer | Number of rooms.                                                       |
| currency<mark style="color:red;">\*</mark>  | String  | Target currency code for prices.                                       |
| device                                      | String  | Visitor device; `DESKTOP` (default) or `MOBILE`.                       |
| lang                                        | String  | Language code passed to the availability engine.                       |
| sortBy                                      | String  | Sort field; one of `PRICE`, `POPULARITY`, `NAME`, or `DISTANCE`.       |
| sortOrder                                   | String  | Sort order; `ASC` or `DESC`.                                           |
| minPrice                                    | Double  | Minimum price filter.                                                  |
| maxPrice                                    | Double  | Maximum price filter.                                                  |
| destination                                 | String  | Destination name filter.                                               |
| rating                                      | Array   | Hotel rating filter; can be repeated for multiple ratings.             |
| boards                                      | Array   | Hotel boards filter; can be repeated for multiple boards.              |
| propertyName                                | String  | Property name search substring.                                        |

{% tabs %}
{% tab title="200: OK Availability returned" %}
{% code lineNumbers="true" %}

```json
{
  "hotels": [
    {
      "code": "WOLAWARSAW",
      "name": "White Olive Elite Warsaw",
      "description": "City center hotel with rooftop pool",
      "url": "https://hotel.example.com/WOLAWARSAW",
      "targetUrl": "https://hotel.example.com/WOLAWARSAW/book",
      "includeInWidgetSearch": true,
      "rating": 5,
      "minprice": 210.0,
      "nightsMin": 1,
      "nightsMax": 14,
      "symbol": "€",
      "photo": "https://images.example.com/WOLAWARSAW/main.jpg",
      "photoM": "https://images.example.com/WOLAWARSAW/main_m.jpg",
      "photoL": "https://images.example.com/WOLAWARSAW/main_l.jpg",
      "location": {
        "name": "Warsaw",
        "lat": 52.2297,
        "lon": 21.0122
      },
      "beds": 2,
      "bathrooms": 1,
      "bedrooms": 1,
      "noOfPhotos": 12,
      "rates": [
        {
          "rate": "NRF",
          "room": "Deluxe City View",
          "board": 1,
          "price": 210.0,
          "discount": 0.0,
          "memberPrice": 200.0,
          "memberDiscount": 10.0,
          "remaining": 6
        },
        {
          "rate": "RF",
          "room": "Deluxe City View",
          "board": 2,
          "price": 230.0,
          "discount": 10.0,
          "remaining": 3
        }
      ]
    }
  ],
  "metadata": {
    "destinations": {
      "Warsaw": 1
    },
    "boards": {
      "1": 1,
      "2": 1
    },
    "ratings": {
      "5": 1
    },
    "minPrice": 210.0,
    "maxPrice": 230.0,
    "sortBy": "PRICE",
    "sortOrder": "ASC"
  },
  "checkin": "2026-04-18",
  "checkout": "2026-04-19",
  "adults": 2,
  "currency": "EUR",
  "symbol": "€"
}
```

{% endcode %}
{% endtab %}

{% tab title="400: Bad Request Validation failed (e.g., missing required parameters or invalid dates)" %}

```json
{
  "timestamp": "2025-11-25T14:13:22",
  "message": "Data provided is invalid"
}
```

{% endtab %}

{% tab title="401: Unauthorized Chain code could not be resolved or credentials are invalid" %}

{% endtab %}
{% endtabs %}

## Example

{% tabs %}
{% tab title="curl" %}

<pre><code><strong>curl 'https://api.rateparity.com/v1/availability/multi?chainCode=chaincode&#x26;checkin=2026-04-18&#x26;checkout=2026-04-19&#x26;adults=2¤cy=EUR'
</strong></code></pre>

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.rateparity.com/availability/availability-multi.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.