Explore Plans
Mobile menu Close menu
Host Tools

Check availability

Pro plus icon This query returns which nights on a listing are free or blocked between two dates.

Developer info

API endpoint slug
hosttools.check_availability
Runtime method
performQuery("hosttools.check_availability"}

Query fields

Listing Dropdown list

Label
Listing
Helper text
The listing whose availability you want.
Slug
listing
Required
true
Can have default value
false

From date Text input > ISO 8601 date and time

Label
From date
Helper text
The first night to check, such as 2026-10-01 or today.
Slug
from_date
Required
true
Can have default value
true

To date Text input > ISO 8601 date and time

Label
To date
Helper text
The last night to check, such as 2026-10-31 or in 2 weeks.
Slug
to_date
Required
true
Can have default value
true

Ingredients

Date The night, as YYYY-MM-DD.

Slug
date
Filter code
Hosttools.checkAvailability.Date
Type
Date (ISO8601)
Example
2020-07-07

Blocked Whether the night is blocked: true or false.

Slug
blocked
Filter code
Hosttools.checkAvailability.Blocked
Type
String
Example
false

Minimum stay The minimum number of nights a guest must book to stay this night.

Slug
minimum_stay
Filter code
Hosttools.checkAvailability.MinimumStay
Type
String
Example
1

Currency The currency code for the listing's prices, such as USD.

Slug
currency
Filter code
Hosttools.checkAvailability.Currency
Type
String
Example
USD