> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.pricelabs.co/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.pricelabs.co/_mcp/server.

# Market Insights

### `get_str_index`

Surfaces short-term rental market data at the country, state, or regional level. Shows occupancy rates, RevPAR, and year-over-year trends broken down by month — helpful for understanding whether your market is heating up or cooling down.

Monetary metric values (e.g. RevPAR, ADR) are converted to regional currency. The response includes a `currency` field indicating which currency the values are denominated in.

**Best for:** Macro market questions, comparing regions, spotting seasonal demand patterns.

**Example:** "Occupancy trends in Spain?"

### `get_listing_neighborhood_market`

Provides a neighborhood-level market snapshot for a specific listing, including base-price context and nearby market conditions. Returns structured JSON suited for integration-style analysis. For richer competitor maps, demand trends, and compset comparisons, use `get_neighbourhood_data` instead.

**Best for:** Understanding how a listing sits relative to its local market, base-price benchmarking.

**Example:** "Give me a market snapshot for listing **834874**"

### `get_neighbourhood_data`

Returns market and competitor insights for a listing — pricing, demand trends, and comparison analysis. Supports opt-in heavy payloads via `include_*` flags so you can pull only the data you need.

**Include flags** (all optional, default off):

| Flag                    | Request when you need…                     |
| ----------------------- | ------------------------------------------ |
| `include_prices`        | Monthly averages or daily price breakdowns |
| `include_future_prices` | Your listing's upcoming prices             |
| `include_occupancy`     | Occupancy trends for the market            |

**Best for:** Competitor analysis, demand trends, compset comparisons, neighbourhood deep dives.

**Example:** "Compare **Sunset Villa** to nearby competitors"

### `get_neighborhood_data_sources`

Shows which compsets a listing's neighbourhood data can be based on, and which one is in effect today. Three sources exist: **Nearby Listings** (`NL`), **Market Dashboards** (`MD`) and **Competitor Listings** (`CCC`).

Each source comes back with the sub-options it needs — bedroom buckets for `NL`, the account's Market Dashboard reports for `MD` — and a source that is not available says why, so you can tell "no Market Dashboards on this account" apart from "Competitor Listings needs at least 20 listings".

Read-only. Call this first to get valid `md_id` and `br_selection` values before changing anything.

**Best for:** Seeing what a listing is being compared against, and what else it could be compared against.

**Example:** "What is **Sunset Villa** being compared to?"

### `get_md_report_compsets`

Lists the compsets on one Market Dashboard report, for use when assigning `MD` as a listing's source. Pass the `md_id` you picked from `get_neighborhood_data_sources`.

Each compset has a `value`, a `label` and a `group`. The **`value` is the identifier** — it is the only form `set_neighborhood_data_source` accepts. The `label` is display text and is not a valid parameter value, so show the label if it reads better, but always send the value.

**Best for:** Finding the exact compset to assign on a Market Dashboard.

**Example:** "What compsets are on my Snowmass dashboard?"

### `set_neighborhood_data_source`

Changes which compset a listing's neighbourhood data is based on — the same setting as the compset selector on the Neighborhood Data tab. This is a write, and it changes the market data every later question about that listing is answered from.

What each source needs:

| Source                      | Required                                                               |
| --------------------------- | ---------------------------------------------------------------------- |
| `NL` — Nearby Listings      | `br_selection`, comma-separated bedroom counts from `br_range_options` |
| `MD` — Market Dashboards    | `md_id` **and** `md_compset` (a compset's `value`)                     |
| `CCC` — Competitor Listings | nothing, but the account must have the feature                         |

Values are checked against the listing's own live options before anything is saved, so an unknown bedroom count, dashboard or compset is rejected outright and the error lists what was valid instead. Requires OAuth customization write access, which is granted separately from write access — a connection that can change prices cannot change the compset unless customization write was granted too.

**Best for:** Repointing a listing at a different market when the default comparison is not the right one.

**Example:** "Compare **Sunset Villa** against the Snowmass dashboard instead"