# Get daily price recommendations for a listing.

`GET /listings/{listing_id}/price_recommendations`

> Wheelhouse Revenue Management API. Web version: https://docs.usewheelhouse.com/rm/reference/rm-get-price-recommendations · OpenAPI spec: https://docs.usewheelhouse.com/rm/openapi.yaml · Operation ID: `rmGetPriceRecommendations` · Tag: Recommendations

Returns most up-to-date price recommendations for the listing.
The horizon of the price recommendations depends on the pricing tier this listing is in and can be
queried using the [pricing tier](https://docs.usewheelhouse.com/rm/reference/rm-get-listing-pricing-tier.md) endpoint. By default, `Free` listings
get a preview horizon of 30 days, and every other tier, including `Pro Trial` and `Pro Onboarding`,
gets 545 days (18 months). Some channels and listings differ. See [Pricing Tiers](https://docs.usewheelhouse.com/rm/concepts/pricing-tiers.md).
The `data` array starts from today's date and is returned in chronological order.

## Request

`GET https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/price_recommendations`

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 |
| --- | --- | --- | --- |
| `listing_id` | string | yes | The channel's unique listing identifier, or the Wheelhouse listing ID when `channel` is `wheelhouse`. |

### Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `channel` | string | yes | Channel name the listing is on (the `channel` field of the [/listings](https://docs.usewheelhouse.com/rm/reference/rm-get-listings.md) response), or the literal `wheelhouse` to read `listing_id` as a Wheelhouse listing ID instead. See [Identifying Listings](https://docs.usewheelhouse.com/rm/concepts/listings.md). |
| `currency` | string | no | ISO-4217 3-letter currency code (e.g. 'USD', 'GBP') to convert prices to. Uses listing's currency by default. |
| `attribution` | boolean | no | When true, includes detailed per-factor price attribution fields (`attr_*`) in each day's recommendation. (default: `false`) |
| `price_model` | string | no | The price model version to use. `current` is the model the listing gets without a pick of its own. `opt_in` is the opt-in model, and returns `400` when there are several; pass `price_model_id` instead. With no opt-in model, `opt_in` uses the price model currently active for the listing, as does omitting the parameter. (one of: `current`, `opt_in`) |
| `price_model_id` | integer | no | The ID of a price model to use, instead of `price_model`, from [GET /price_models](https://docs.usewheelhouse.com/rm/reference/rm-get-price-models.md). It must be one the listing can use and that has run for the listing's market, or the request returns `400`. |

### Example request

```bash
curl -X GET 'https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/price_recommendations?channel=<channel>' \
  -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

Daily price recommendations.

Body (`application/json`): object `recommendations_response`

Daily price recommendations for a listing.

- `data` (array of object `recommendations_response_data_item`): Daily recommendations for prices. Includes min stays as configured by settings.
  - Each item: One day of price recommendations. The `attr_*` and `historical_anchor_*` fields are present only when the request sets `attribution=true`.
  - `stay_date` (string (date), required): The date of the given price info (YYYY-MM-DD).
  - `price` (number, required): The recommended nightly price for this day.
  - `currency` (string, required): The ISO-4217 3-letter currency code of the price.
  - `min_stay` (integer, nullable): The minimum stay applied to reservations overlapping this day. Omitted unless min stays are configured. This is the final value after every rule in `minimum_stay_rules_v3` and the `min_min_stay` floor. It does not say which rule set it. See [How minimum stay rules combine](https://docs.usewheelhouse.com/rm/concepts/preferences-rules.md#how-minimum-stay-rules-combine) for the precedence and a worked example.
  - `min_price` (integer, nullable): The minimum price applied to this day, in `currency`: the higher of the listing's minimum price rule for the date and its absolute minimum price (`min_min_price`). On a day with a fixed custom rate the minimum price rules do not apply, so only the absolute minimum price counts. `price` is never below it. In a preview, it reflects the previewed preferences. `null` when no minimum applies to the day.
  - `custom_type` (string, nullable, one of: `adjusted`, `fixed`): Reflects if this price is based on a custom rate. `null` means this is the Wheelhouse recommendation; `fixed` means a fixed custom price; `adjusted` means a percentage adjustment. Note: the `adjusted` value here corresponds to `rate_type: "adjustment"` when writing via `PUT /listings/{listing_id}/custom_rates` — the form differs between write (`adjustment`) and read (`adjusted`).
  - `events` (array of object): The events in the listing's market that run over this date. An empty array means no event runs over the date. Several events can run over one date. Only returned by `GET /listings/{listing_id}/price_recommendations`, not by `POST /preferences/{listing_id}/preview`.
    - `title` (string, required, example: `Jazz Festival`): The name of the event.
    - `start_date` (string (date), required): The first date of the event (YYYY-MM-DD).
    - `end_date` (string (date), required): The last date of the event (YYYY-MM-DD), inclusive.
  - `attr_seasonality` (integer): Seasonality attribution. Only present if `attribution=true`.
  - `attr_local_demand` (integer): Local demand attribution. Only present if `attribution=true`.
  - `attr_availability` (integer): Availability/gap night attribution. Only present if `attribution=true`.
  - `attr_time` (integer): Time-based attribution. Only present if `attribution=true`.
  - `attr_custom_weekend` (integer): Day of week attribution. Only present if `attribution=true`.
  - `attr_scarcity` (integer): Scarcity attribution. Only present if `attribution=true`.
  - `attr_occupancy_pacing` (integer): Occupancy pacing attribution. Only present if `attribution=true`.
  - `attr_historical_anchoring` (integer): Historical anchoring attribution. Only present if `attribution=true`.
  - `attr_restriction` (integer): Min/max restriction attribution. Only present if `attribution=true`.
  - `attr_user_adjustment` (integer): User customization attribution. Only present if `attribution=true`.
  - `historical_anchor_date` (string (date)): The earlier date whose price historical anchoring held this date's recommendation up to: the same day of the week, in the same week a year earlier, or two years earlier when that date has no price. Only present if `attribution=true` and historical anchoring raised this date's price, with `attr_historical_anchoring` saying by how much.
  - `historical_anchor_pct` (number): The historical anchoring percentage in effect for this date, from the listing's `historical_anchoring_rules`, applied as `historical_anchoring_mode` describes. Present with `historical_anchor_date`.
  - `historical_anchor_price` (integer): The price on `historical_anchor_date` that anchoring weighed in, in this response's `currency`. Present with `historical_anchor_date`.
  - `historical_anchor_source` (string, one of: `observed`, `posted`): Where `historical_anchor_price` comes from: `observed`, the listing's price as Wheelhouse saw it on the channel once the date booked, or `posted`, the price Wheelhouse last posted for the date before it booked. Present with `historical_anchor_date`.
- `base_price` (integer): The base price the recommendations in `data` are computed from. This is the manual `base_price` from `GET /preferences/{listing_id}` when one is set, otherwise `base_price_recommended` multiplied by the preference `base_price_adjustment` and rounded. It is in the same currency as the prices in `data`, so a manual base price is converted and rounded when the requested `currency` differs from the preferences currency. Read the base price in use here, because the preferences and listing endpoints return `base_price` as `null` when the listing follows the recommendation. Same as `base_price_selected` on `GET /listings/{listing_id}/base_price_recommendation`. Never `null`.
- `base_price_recommended` (integer, nullable): The Wheelhouse data-driven recommended base price.
- `base_price_conservative` (integer, nullable): The Wheelhouse data-driven conservative base price.
- `base_price_aggressive` (integer, nullable): The Wheelhouse data-driven aggressive base price.
- `global_min_stay` (integer, nullable): The value from the global minimum stay rule — the default minimum stay applied when no higher-priority rule matches a date. Not the same as `min_min_stay` in preferences, which is the absolute floor that overrides all rules.
- `automatic_rate_posting_enabled` (boolean): Whether Wheelhouse automatically posts its price recommendations to the channel calendar. When `false`, recommendations are computed but not pushed to the channel. This setting does not affect custom rates set via the API — those are posted independently.

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

```json
{
  "data": [
    {
      "stay_date": "2026-01-01",
      "price": 0,
      "currency": "string",
      "min_stay": 0,
      "min_price": 0,
      "custom_type": "adjusted",
      "events": [
        {
          "title": "Jazz Festival",
          "start_date": "2026-01-01",
          "end_date": "2026-01-01"
        }
      ],
      "attr_seasonality": 0,
      "attr_local_demand": 0,
      "attr_availability": 0,
      "attr_time": 0,
      "attr_custom_weekend": 0,
      "attr_scarcity": 0,
      "attr_occupancy_pacing": 0,
      "attr_historical_anchoring": 0,
      "attr_restriction": 0,
      "attr_user_adjustment": 0,
      "historical_anchor_date": "2026-01-01",
      "historical_anchor_pct": 0,
      "historical_anchor_price": 0,
      "historical_anchor_source": "observed"
    }
  ],
  "base_price": 0,
  "base_price_recommended": 0,
  "base_price_conservative": 0,
  "base_price_aggressive": 0,
  "global_min_stay": 0,
  "automatic_rate_posting_enabled": true
}
```

### 400

The requested price model cannot be used for this listing, or `price_model=opt_in` is ambiguous.

### 401

API key authorization failed.

### 403

Listing authorization failed.

### 404

Listing not found.

### 406

The listing is inactive. See the **Inactive Listings** section in the overview.

Body (`application/json`): object

- `error` (string, example: `Listing '12345' is inactive`)

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

```json
{
  "error": "Listing '12345' is inactive"
}
```

### 422

Listing is not covered by a Wheelhouse market.

### 423

Price recommendations are still being generated. Retry after a brief delay.

### 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"
}
```
