# Get time-series market metrics.

`GET /market_report/{market_id}/time_series`

> Wheelhouse Revenue Management API. Web version: https://docs.usewheelhouse.com/rm/reference/rm-get-market-time-series · OpenAPI spec: https://docs.usewheelhouse.com/rm/openapi.yaml · Operation ID: `rmGetMarketTimeSeries` · Tag: Market Reports

Returns daily time-series data for one or more market-level metrics over a date range. RM API users can only access markets in which they have at least one Pro tier listing.

Available metrics: `asking_rate_w_fees`, `occupancy`, `occupancy_adjusted`, `adr_w_fees`, `lead_time`, `revpar_adjusted_w_fees`, `revpar_w_fees`, `revenue_w_fees`, `nights_bookable`.

**Same time last year.** Pass `basis=stly` to get each stay date's values as they stood around the same time last year: the market's figures for the stay date 52 weeks earlier, returned under this year's `stay_date` with the same fields, so the rows of both bases can be joined on `stay_date`. `updated_at` is then when last year's figures were generated. A value is `null` where last year has no data for that stay date, and a bedroom group last year's market was not broken down by returns 204. Last year's figures are refreshed weekly, so the last few days of the one-year horizon can be missing from the response, and a range that lies entirely within them returns 204. `basis=stly` is in early access: accounts without early access get a 403, and a market whose last year figures are not available yet returns a 404.

## Request

`GET https://api.usewheelhouse.com/ss_api/v1/market_report/{market_id}/time_series`

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 |
| --- | --- | --- | --- |
| `market_id` | integer | yes | The Wheelhouse internal market ID (from `GET /market_report` or `/listings`). |

### Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `metric` | array of string | no | Metrics to include. Defaults to all metrics. Send more than one in brackets (`?metric[]=asking_rate_w_fees&metric[]=occupancy`); a key repeated without brackets keeps only its last value. (each item one of: `occupancy`, `occupancy_adjusted`, `nights_bookable`, `asking_rate_w_fees`, `adr_w_fees`, `lead_time`, `revpar_adjusted_w_fees`, `revpar_w_fees`, `revenue_w_fees`) |
| `start_date` | string (date) | no | Start of the date range (YYYY-MM-DD). Defaults to today. Must be within 3 years in the past and 1 year in the future. |
| `end_date` | string (date) | no | End of the date range (YYYY-MM-DD). Defaults to 1 year from today. Must be after `start_date`. |
| `performance` | string | no | Filter to a performance tier. Omit to include all tiers. (one of: `low`, `average`, `high`) |
| `bedrooms` | string | no | Filter to this bedroom group. Omit to include all bedroom counts. Which groups a market is broken down by depends on the listings in it, so they differ from market to market: a market with many larger listings is broken down further (`0`, `1`, `2`, `3`, `4`, `5`, `6+`) than one without them (`0`, `1`, `2+`). Read a market's groups from `GET /market_report/{market_id}/bedroom_groups` rather than assuming a fixed set. A group the market has no data for is rejected, and the error names the groups it does have. The top group holds every listing with at least that many bedrooms. A request for a top group is answered from the exact bedroom count it names where the market is broken down past it, so `4+` returns the 4 bedroom group in a market broken down into `4`, `5` and `6+`.  (pattern: `^\d{1,2}\+?$`, example: `2`) |
| `property_type` | string | no | Filter to a property type. Omit to include all property types. (one of: `apartment`, `bnb`, `boat`, `bus`, `cabin`, `camper`, `camping`, `castle`, `holiday_home`, `hostel`, `hotel`, `house`, `houseboat`, `island`, `mill`, `other`, `room`, `shared`, `tower`) |
| `basis` | string | no | Today's values (`current`) or the values as they stood around the same time last year (`stly`). See the description above for what `stly` returns. `stly` is in early access. (one of: `current`, `stly`, default: `current`) |

### Example request

```bash
curl -X GET 'https://api.usewheelhouse.com/ss_api/v1/market_report/{market_id}/time_series' \
  -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

Time-series market data.

Body (`application/json`): object

- `currency` (string): ISO-4217 currency code for monetary metrics.
- `updated_at` (string, example: `2026-08-30 04:17:22 UTC`): When the underlying market report was last generated, as a timestamp with a time zone abbreviation rather than ISO-8601.
- `data` (array of object): Daily metric values.
  - `stay_date` (string (date)): Stay date (YYYY-MM-DD).
  - `occupancy` (number, nullable): Occupancy rate (0–1). Present when `occupancy` is requested.
  - `occupancy_adjusted` (number, nullable): Occupancy rate over open (non-blocked) nights (0–1). Present when `occupancy_adjusted` is requested.
  - `nights_bookable` (number, nullable): Number of open (non-blocked) available room-nights. Present when `nights_bookable` is requested.
  - `asking_rate_w_fees` (number, nullable): Average asking rate including fees. Present when `asking_rate_w_fees` is requested.
  - `adr_w_fees` (number, nullable): Average daily rate including fees of booked rooms. Present when `adr_w_fees` is requested.
  - `lead_time` (number, nullable): Average lead time in days. Present when `lead_time` is requested.
  - `revpar_adjusted_w_fees` (number, nullable): Revenue per open available room-night including fees. Present when `revpar_adjusted_w_fees` is requested.
  - `revpar_w_fees` (number, nullable): Revenue per available room-night including fees. Present when `revpar_w_fees` is requested.
  - `revenue_w_fees` (number, nullable): Total revenue including fees. Present when `revenue_w_fees` is requested.

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

```json
{
  "currency": "string",
  "updated_at": "2026-08-30 04:17:22 UTC",
  "data": [
    {
      "stay_date": "2026-01-01",
      "occupancy": 0,
      "occupancy_adjusted": 0,
      "nights_bookable": 0,
      "asking_rate_w_fees": 0,
      "adr_w_fees": 0,
      "lead_time": 0,
      "revpar_adjusted_w_fees": 0,
      "revpar_w_fees": 0,
      "revenue_w_fees": 0
    }
  ]
}
```

### 204

Not enough data for the requested parameters.

### 400

Invalid parameter value (e.g. invalid date range, or a `bedrooms` group this market is not broken down by).

### 401

API key authorization failed.

### 403

`basis=stly` was requested by an account without early access to it.

### 404

Market not found or not accessible, or, with `basis=stly`, last year's figures for this market are not available yet.

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