# Get the price calendar of a dynamic set's member listings.

`GET /sets/{set_id}/price_calendar`

> Wheelhouse Revenue Management API. Web version: https://docs.usewheelhouse.com/rm/reference/rm-get-set-price-calendar · OpenAPI spec: https://docs.usewheelhouse.com/rm/openapi.yaml · Operation ID: `rmGetSetPriceCalendar` · Tag: Dynamic Sets

Returns a night-by-night calendar for each **active member listing** of the set — the API equivalent of the set calendar in the Wheelhouse app. Each listing carries its own array of nights, with prices converted to a single currency so they are comparable across comps priced differently.

Available only for **small sets**: a set with more than 25 member listings responds with `422`. Every membership counts toward that limit, whatever its status, even though the response itself covers only the active ones. **Paid sets only** — a free set responds with `404`; upgrade it first with `POST /sets/{set_id}/upgrade`. Both limits follow the detailed per-night scraping that backs this data, which Wheelhouse requests only for paid sets at or under that size.

The shape follows `GET /listings/{listing_id}/price_calendar` with two deliberate differences, because a comparison listing is not one of your own: there is no `is_booked` flag and no `reservation_id`. See `booking_probability_percent` on the night object for what replaces them.

## Request

`GET https://api.usewheelhouse.com/ss_api/v1/sets/{set_id}/price_calendar`

Authentication: send your RM API key in the `X-Integration-Api-Key` header (see https://docs.usewheelhouse.com/rm/authentication.md). Read-only keys can call this endpoint.

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `set_id` | integer | yes | The Wheelhouse internal dynamic set ID. |

### Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `start_date` | string (date) | no | First stay date to return (inclusive). Defaults to today. |
| `end_date` | string (date) | no | Last stay date to return (inclusive). Defaults to 545 days out, the maximum calendar horizon. The range may not exceed 3 years. |
| `currency` | string | no | ISO-4217 3-letter currency code to convert prices to. Defaults to the set's own currency, so nights are comparable across comps priced in different currencies. |

### Example request

```bash
curl -X GET 'https://api.usewheelhouse.com/ss_api/v1/sets/{set_id}/price_calendar' \
  -H 'X-Integration-Api-Key: <your RM API key>'
```

Only required parameters and body fields are filled in, with placeholder values. Add the optional ones you need from the lists above; some are required in combination, as their descriptions say.

## Responses

### 200

One calendar per active member listing.

Body (`application/json`): array of object

- `listing_id` (integer): The Wheelhouse internal listing ID of the member listing.
- `title` (string, nullable): The member listing's title, for labelling the calendar.
- `currency` (string): ISO-4217 currency code every price in this listing's calendar is expressed in.
- `price_calendar` (array of object `set_calendar_day_response`): The listing's nights, ordered by stay date.
  - Each item: One night of a member listing's calendar. Mirrors the single-listing price calendar (`GET /listings/{listing_id}/price_calendar`) minus three fields. Two do not carry over to a comparison listing: `is_booked`, which for a comp would be an estimate rather than a fact, and `reservation_id`, which a comp has none of — the underlying assessment is reported as `booking_probability_percent` in their place. The third, `created_at`, is dropped as an internal record-keeping timestamp of no use here.

    Note there is deliberately no `status` field either, unlike the Comp Set API's calendar: that field separates booked from blocked using the same probability, so offering it would reintroduce exactly the estimate left out above. Use `is_available`, which is observed directly, together with `booking_probability_percent`.
  - `stay_date` (string (date)): The stay date.
  - `price` (integer, nullable): The observed price for this night, converted to the response `currency` and rounded. For an available night this is the live price; for an unavailable one it is the price it was last seen at.
  - `currency` (string): ISO-4217 currency code the price is expressed in.
  - `is_available` (boolean): Whether the night is available to book. This is observed directly, unlike the booked/blocked distinction.
  - `booking_probability_percent` (integer, min: 0, max: 90): Wheelhouse's assessment of the likelihood this night is booked rather than merely held, as a whole percentage. For a comparison listing we observe only that a night became unavailable, not why, so this replaces the `is_booked` flag of the single-listing calendar.

    **Bounded to 10–90 for unavailable nights.** We never assert certainty about a listing we infer from scraping rather than receive reservations for, so a value of `10` means "10% or less" and `90` means "90% or more" — matching the app's set calendar, which renders those cases as `<10%` and `>90%`. Do not read `10` and `90` as exact.

    An **available** night reports `0`: its state is observed rather than inferred, and the app shows no probability for it at all. So `0` is the only value outside the band, and it always pairs with `is_available: true`.
  - `block_time` (string (date-time), nullable): When this night was first observed as unavailable (ISO-8601). Null while the night is still available.
  - `unit_number` (integer): The unit number. Always `0` in practice, since comparison listings come from scraped channels that have no units.

Example shape (generated from the schema; placeholder values, not a real response):

```json
[
  {
    "listing_id": 0,
    "title": "string",
    "currency": "string",
    "price_calendar": [
      {
        "stay_date": "2026-01-01",
        "price": 0,
        "currency": "string",
        "is_available": true,
        "booking_probability_percent": 0,
        "block_time": "2026-01-01T00:00:00Z",
        "unit_number": 0
      }
    ]
  }
]
```

### 400

The date range exceeds 3 years, ends before it starts, or an unsupported currency was requested.

### 401

API key authorization failed.

### 404

Dynamic set not found, not accessible to the user, or not a paid set.

### 422

The set has more than 25 member listings, which is more than the set calendar supports. All memberships count toward the limit, whatever their status.

### 429

Rate limit exceeded — the API key has sent too many requests. Wait before retrying. See the **Rate Limits** section in the overview for the recommended exponential backoff strategy.

Body (`application/json`): object

- `error` (string, example: `API token is at rate limit`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "API token is at rate limit"
}
```
