Wheelhouse Comp Set API (1.0)
Download OpenAPI specification:Download
The Comparable (Comp) Set API allows users to retrieve candidate competitive sets for hypothetical listings.
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.
Fetch Comp Set Candidate Listings
Given the search params, retrieve a list of candidate listings that could be added to a comp set.
Authorizations:
path Parameters
| lat required | float Latitude of hypothetical listing. |
| long required | float Longitude of hypothetical listing. |
| radius required | integer Radius in meters to search for candidate listings. |
| limit required | integer Maximum number of candidate listings. |
| min_bedrooms | integer Minimum number of bedrooms in returned listings. |
| max_bedrooms | integer Maximum number of bedrooms in returned listings. |
| min_bathrooms | float Minimum number of bathroomss in returned listings. Includes half-baths as decimals. |
| max_bathrooms | float Maximum number of bathrooms in returned listings. Includes half-baths as decimals. |
| room_types | array Array of room types to include in results. Possible values ['castle', 'apartment', 'camper', 'bus', 'tower', 'bnb', 'island', 'boat', 'hostel', 'houseboat', 'hotel', 'house', 'holiday_home', 'cabin', 'mill', 'other', 'room', 'camping', 'shared'] |
Responses
Response samples
- 200
{- "listing_id": 0,
- "address": "string",
- "amenities": "string",
- "anr_0_365": 0,
- "anr_0_90": 0,
- "anr_365_0": 0,
- "anr_90_0": 0,
- "apr_0_365": 0,
- "apr_0_90": 0,
- "apr_365_0": 0,
- "apr_90_0": 0,
- "available_nights_0_365": 0,
- "available_nights_0_90": 0,
- "available_nights_365_0": 0,
- "available_nights_90_0": 0,
- "bathrooms": 0,
- "bedrooms": 0,
- "beds": 0,
- "blocked_nights_0_365": 0,
- "blocked_nights_0_90": 0,
- "blocked_nights_365_0": 0,
- "blocked_nights_90_0": 0,
- "bookable_nights_0_365": 0,
- "bookable_nights_0_90": 0,
- "bookable_nights_365_0": 0,
- "bookable_nights_90_0": 0,
- "booked_nights_0_365": 0,
- "booked_nights_0_90": 0,
- "booked_nights_365_0": 0,
- "booked_nights_90_0": 0,
- "calendar_nights_0_365": 0,
- "calendar_nights_0_90": 0,
- "calendar_nights_365_0": 0,
- "calendar_nights_90_0": 0,
- "cleaning_fee": 0,
- "currency": "string",
- "guests_included": 0,
- "lat": 0,
- "long": 0,
- "lead_time_0_365": 0,
- "lead_time_0_90": 0,
- "lead_time_365_0": 0,
- "lead_time_90_0": 0,
- "listing_created_at": "2019-08-24T14:15:22Z",
- "listing_last_updated": "2019-08-24T14:15:22Z",
- "los_0_365": 0,
- "los_0_90": 0,
- "los_365_0": 0,
- "los_90_0": 0,
- "market_id": 0,
- "nrevenue_0_365": 0,
- "property_type": "string",
- "review_count": 0,
- "room_type": "string",
- "sleeps": 0,
- "star_rating": 0,
- "thumb_url": "string",
- "title": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "owner_name": "string",
- "source": "string",
- "distance_meters": 0
}