Skip to main content
POST
Search Airbnb stays by place and dates
  • Endpoint: airbnb.search
  • Returns: data has listings.
  • Cost: 2 credits per 18 items, at least 2 credits. Failed calls cost nothing.
  • Paging: Yes. Send the cursor from the response to get the next page. See Paging.

Example

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
location
string
required
Required string length: 2 - 200
checkIn
string<date>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
checkOut
string<date>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
adults
integer
default:1
Required range: 1 <= x <= 16
children
integer
default:0
Required range: 0 <= x <= 15
infants
integer
default:0
Required range: 0 <= x <= 5
pets
integer
default:0
Required range: 0 <= x <= 5
price
object
currency
string
Pattern: ^[A-Za-z]{3}$
roomType
enum<string>
Available options:
entireHome,
privateRoom,
sharedRoom,
hotelRoom
bedrooms
object
bathrooms
object
amenities
enum<string>[]
Minimum array length: 1
Available options:
wifi,
kitchen,
washer,
dryer,
airConditioning,
heating,
workspace,
tv,
hairDryer,
iron,
pool,
hotTub,
freeParking,
evCharger,
crib,
gym,
bbqGrill,
breakfast,
fireplace,
smokingAllowed,
smokeAlarm,
carbonMonoxideAlarm,
selfCheckIn
superhost
boolean
instantBook
boolean
guestFavorite
boolean
limit
integer
default:18
Required range: 1 <= x <= 270
cursor
string
Pattern: ^(?:\d{1,4}~(?:\d{1,7})?|(?:\d{1,7}))$

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required