Wheelhouse Comp Set API (1.0)
Download OpenAPI specification:Download
The Comparable (Comp) Set API allows users to view existing comp sets for a listing. Additionally, this API exposes endpoints for returning all listings in a comp set, adding and removing listings from a comp set, obtaining an overview or highlight of a comp set's features, and obtaining a pricing calendar for listings in a comp set.
CompSetApiKey
All comp set integrations will be given a comp set integration API key. Contact us with a description of your use-case to get one.
| Security Scheme Type | API Key |
|---|---|
| Header parameter name: | X-Integration-Api-Key |
UserApiKey
Requests to the API must be made in a specific User's context. Specifically, the user to whom the UserApiKey belongs must be the owner of the listing/comp set being queried.
BOTH API key headers are required to make Comp Set API calls
| Security Scheme Type | API Key |
|---|---|
| Header parameter name: | X-User-API-Key |
By default, our API is limited to 20 requests / minute. This can be adjusted so please reach out to us with any questions.
This operation describes information about a comp set itself, not the listings inside of it or any information derived from those listings.
Fetch Metadata for Comp Sets
This will fetch data about the comp set itself, not the listings it contains.
Authorizations:
path Parameters
| listing_id required | string The unique identifier for the listing in Wheelhouse's system. |
Responses
Response samples
- 200
[- {
- "id": "R",
- "title": "string",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "is_default": true
}
]These operations fetch or modify data that is derived from the listings contained in a given comp set for a listing.
Get Listings
This will fetch all of the listings within the specified comp set for a listing.
Authorizations:
path Parameters
| listing_id required | string The unique identifier for the listing in Wheelhouse's system. |
Responses
Response samples
- 200
[- {
- "title": "string",
- "bedrooms": 0,
- "bathrooms": 2.5,
- "star_rating": 5,
- "sleeps": 0,
- "minimum_stay": 0,
- "extra_guest_fee": 0,
- "cleaning_fee": 0,
- "type": "apartment",
- "similarity_score": 1000,
- "distance": 0
}
]Add Listings
This will add the listings specified by the ids parameter to the specified
comp set for the specified listing.
Authorizations:
path Parameters
| listing_id required | string The unique identifier for the listing in Wheelhouse's system. |
query Parameters
| ids required | any |
Responses
Response samples
- 200
[- {
- "competitor_id": "string",
- "listing_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "title": "string"
}
]Remove Listings
This will remove the listings specified by the ids parameter from the specified
comp set for the specified listing.
Authorizations:
path Parameters
| listing_id required | string The unique identifier for the listing in Wheelhouse's system. |
query Parameters
| ids required | any |
Responses
Response samples
- 200
[- {
- "id": "string",
- "title": "string"
}
]Get Highlights/Overview
This will return the highlights/overview of a listing in the context of its comp set. It returns a month-over-month comparision of a listing to itself and to the average of the listings in its comp set. A month is specified using the date param, and is compared to the previous month.
Authorizations:
path Parameters
| listing_id required | string The unique identifier for the listing in Wheelhouse's system. |
| date required | string <date> The ISO8601 date string of the month for which you want to obtain highlights. Any valid date for a given month maps that entire month: that is, "2024-01-15" maps to January, 2024, as does "2024-01-01" and "2024-01-27", etc. In month-over-month comparisions, this month is compared with the month immediately preceeding it. |
Responses
Response samples
- 200
{- "listing_highlights": {
- "open_occupancy": {
- "avg": 0,
- "percent_change": 0
}, - "apr": {
- "avg": 0,
- "percent_change": 0
}, - "anr": {
- "avg": 0,
- "percent_change": 0
}, - "revpar_non_blocked": {
- "avg": 0,
- "percent_change": 0
}, - "openness": {
- "avg": 0,
- "percent_change": 0
}, - "lead_time": {
- "avg": 0,
- "percent_change": 0
}, - "book_length": {
- "avg": 0,
- "percent_change": 0
}
}, - "comp_set_highlights": {
- "open_occupancy": {
- "avg": 0,
- "percent_change": 0
}, - "apr": {
- "avg": 0,
- "percent_change": 0
}, - "anr": {
- "avg": 0,
- "percent_change": 0
}, - "revpar_non_blocked": {
- "avg": 0,
- "percent_change": 0
}, - "openness": {
- "avg": 0,
- "percent_change": 0
}, - "lead_time": {
- "avg": 0,
- "percent_change": 0
}, - "book_length": {
- "avg": 0,
- "percent_change": 0
}
}
}Get Calendar
This will return calendar data for the listings in the comp set, for dates within the start_date and end_date, inclusive.
Authorizations:
path Parameters
| listing_id required | string The unique identifier for the listing in Wheelhouse's system. |
| start_date required | string <date> The ISO8601 date string on which you'd like the calendar range to start. |
| end_date required | string <date> The ISO8601 date string on which you'd like the calendar range to end. |
Responses
Response samples
- 200
{- "57845": [
- {
- "listing_id": 57845,
- "stay_date": "2024-05-06",
- "price": 123.45,
- "status": "blocked"
}, - {
- "listing_id": 57845,
- "stay_date": "2024-05-07",
- "price": 123.45,
- "status": "blocked"
}
], - "74658": [
- {
- "listing_id": 74658,
- "stay_date": "2024-05-06",
- "price": 237.5,
- "status": "booked"
}, - {
- "listing_id": 74658,
- "stay_date": "2024-05-07",
- "price": 239,
- "status": "available"
}
]
}