# Get the bedroom groups a market is broken down by.

`GET /market_report/{market_id}/bedroom_groups`

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

Returns the bedroom groups the market's report is broken down by, in ascending order, with the number of listings behind each one. Pass a group's `bedrooms` value to the time-series and distribution endpoints. RM API users can only access markets in which they have at least one Pro tier listing.

Groups are derived from the listings in the market, so they differ from market to market and can change when the report is regenerated.

## Request

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

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`). |

### Example request

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

Bedroom groups for the market.

Body (`application/json`): object

- `bedroom_groups` (array of object): The market's bedroom groups, in ascending order.
  - `bedrooms` (string, example: `6+`): Value to pass as the `bedrooms` parameter. A trailing `+` marks the top group, which holds every listing with at least that many bedrooms.
  - `listings` (integer, nullable, example: `23`): Number of listings in the group. Null where the report was generated before the counts were published.
- `updated_at` (string, example: `2026-08-30 04:17:22 UTC`): When the market's report was generated.

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

```json
{
  "bedroom_groups": [
    {
      "bedrooms": "6+",
      "listings": 23
    }
  ],
  "updated_at": "2026-08-30 04:17:22 UTC"
}
```

### 204

No report has been generated for this market yet.

### 400

Invalid market_id.

### 401

API key authorization failed.

### 404

Market not found or not accessible.

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