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.