Wheelhouse Lite API (v1.0)

Download OpenAPI specification:Download

The Wheelhouse Lite API allows users to fetch price recommendations for a listing on demand without having to create a unit in Wheelhouse or upload any calendar or booking data. The recommendations will be less specific than from our full Wheelhouse Pro API but can be integrated more easily and with less development time.

Note: The API is still in beta testing and maybe subject to changes!

Authentication

LiteApiKey

All integrations will be given a Lite API key. Contact us with a description of your use-case to get one.

Security Scheme Type API Key
Query parameter name: token

Recommendations

Fetch recommendations for a listing

This will fetch recommendations for the listing specified in the parameters.

Authorizations:
query Parameters
latitude
required
number

Latitude in decimal form.

longitude
required
number

Longitude in decimal form.

bedrooms
required
number

Number of bedrooms in the property.

baths
required
number

Number of bathrooms in the property.

sleeps
required
number

Number of guests the property can accommodate.

country_code
string

The ISO-3166 2 letter country code.

num_photos
number

Number of photos shown on the property's listing.

room_type
string

Room type of the property. One of apartment, bnb, boat, bus, cabin, holiday_home, camping, camper, castle, hostel, hotel, house, houseboat, island, tower, mill, room, shared.

cleaning_fee
number

Cleaning fee charged per stay.

security_deposit
number

Security deposit required per stay.

guests_included
number

Number of guests included in the base rent.

amenities
string

Comma-separated list of amenities. Any of 24_hour_check_in, air_conditioning, baby_bath, baby_monitor, babysitter_recommendations, balcony, bathroom_essentials, bathtub, bbq, beachfront, beach_essentials, bed_linens, bedroom_comforts, bicycles, breakfast, building_staff, cable_or_satellite_tv, carbon_monoxide_detector, ceiling_fans, changing_table, childrens_books_and_toys, childrens_dinnerware, cleaning_before_checkout, coffee_maker, cooking_basics, deck, dishes_and_silverware, dishwasher, dryer, elevator, elderly_accessible, essentials, ev_charger, extra_pillows_and_blankets, family_kid_friendly, fire_extinguisher ,fireplace, fireplace_guards, first_aid_kit, freezer, fresh_linens, fridge, game_console, garage, gym, hair_dryer, hangers, heating, high_chair, host_greets_you, hot_tub, hot_water, internet, iron, jacuzzi, kettle, keypad, kitchen, lake_access, laptop_friendly_workspace, lockbox, lock_on_bedroom_door, long_term_stays_allowed, luggage_dropoff, microwave, outlet_covers, oven, parking, parking_paid, parking_free_street, patio, pets_allowed, pool, shared_pool, pool_cover, pool_toys, private_yard, private_entrance, private_living_room, refrigerator, room_darkening_shades, sauna, self_check_in, shampoo, single_level_home, ski_in_out, smart_lock, smoke_detector, smoking_allowed, step_free_access, stereo, stove, streaming, suitable_for_events, table_corner_guards, towel, travel_crib, tv, washing_machine, waterfront, water_views, window_guards.

currency
string

The ISO-4217 currency code of the currency the results should be in. Defaults to the local market currency.

no_temporality
boolean

Turn on/off temporality adjustments for lead-time independent forecasts. Defaults to on.

min_price
number

Minimum price limiting recommendation to ensure no recommended price is lower than this value. Defaults to zero.

avg_booking_price
number

Average nightly price the listing has been booked at in the past. Given in the requested currency.

booking_price_certainty
number [ 0 .. 1 ]

Certainty of the average booking price being a good representation of the listings worth. 0.0 means no certainty at all, 1.0 means full certainty that the price is representative. This can for example be derived from the number of nights booked or from host feedback.

Responses

Response samples

Content type
application/json
{
  • "daily_recommendation": [
    ],
  • "currency": "USD"
}

Market Coverage

Market Coverage

Test if a location is covered by a Wheelhouse market.

Authorizations:
query Parameters
latitude
required
number

Latitude in decimal form.

longitude
required
number

Longitude in decimal form.

country
string

The ISO-3166 2 letter country code.

postal_code
string

A regional postal code for within the given country.

Responses

Response samples

Content type
application/json
{
  • "in_market": true,
  • "market_name": "string"
}