Airbnb

Search Airbnb stays

Search Airbnb stays in a place for your dates and guests, with prices, ratings and photos.

GET/v1/airbnb/search
x-api-keystringheader

API key (`sfk_...`)

Parameters
9
locationstringrequiredquery

Where to stay: a city, region, neighbourhood or address, as you would type it on the site, e.g. `London` or `Hay-on-Wye`. Add the country to tell places apart, e.g. `Paris, France`.

min 1 chars · max 100 chars

checkInstringoptionalquery

Check-in date, `YYYY-MM-DD`. Pass it with `checkOut`. Default: no dates, so each listing is priced for the next dates it is free (its own `checkIn` and `checkOut` say which).

checkOutstringoptionalquery

Check-out date, `YYYY-MM-DD`, after `checkIn`.

adultsintegeroptionalquery

Adults, 1 to 16. Default 1.

≥ 1 · ≤ 16

childrenintegeroptionalquery

Children aged 2 to 12, 0 to 15. Default 0.

≥ 0 · ≤ 15

infantsintegeroptionalquery

Infants under 2, 0 to 5. Default 0.

≥ 0 · ≤ 5

petsintegeroptionalquery

Pets, 0 to 5. Default 0.

≥ 0 · ≤ 5

currencystringoptionalquery

Currency for prices, a three-letter code such as `USD`, `EUR` or `GBP`. Default `USD`.

cursorstringoptionalquery

Pass `page.nextCursor` from the previous response to get the next page. It only works with the same parameters. Omit it for the first page.

min 1 chars · max 4096 chars · pattern: ^[A-Za-z0-9_.-]+$

Response fields
65

Endpoint-specific response payload.

datalookupStatus
string

`found` when the site placed the location, with an empty list when nothing is free; `not_found` when it could not place it.

one of: found, not_found

datalocation
string

The `location` searched.

dataresolvedLocation
stringnullable

The place the site matched it to, e.g. `London, United Kingdom`. Check it: a vague location can match somewhere else. Null when `lookupStatus` is `not_found`.

datacheckIn
stringnullable

Check-in date searched, if any.

datacheckOut
stringnullable

Check-out date searched, if any.

dataadults
integer

Adults searched.

datachildren
integer

Children searched.

datainfants
integer

Infants searched.

datapets
integer

Pets searched.

datacurrency
string

Currency of every price.

datatotalResults
integernullable

Matching stays the site reports, when it gives a number; null when it says only `Over 1,000`.

datatotalResultsText
stringnullable

The site's own count line, e.g. `Over 1,000 homes in London`.

A page of up to 18 listings in the site's own order. The site re-ranks between requests, so a listing an earlier page returned is left out of later pages, and a page can hold fewer rows.

datalistings[]listingId
string

Listing id. Pass it as `listingId` to the listing, reviews and availability endpoints.

datalistings[]url
string

Listing URL on airbnb.com.

datalistings[]name
stringnullable

Listing name the host gave it.

datalistings[]title
stringnullable

Card heading, e.g. `Apartment in Shoreditch` or a hotel's name.

datalistings[]subtitle
stringnullable

Card line under the heading, e.g. `Hotel in City of London`.

datalistings[]area
stringnullable

Neighbourhood or town the card names, e.g. `Camden`.

Map position as the site shows it: for most homes an approximate point near the listing, never the exact address.

datalistings[]coordinateslatitude
number

Latitude.

datalistings[]coordinateslongitude
number

Longitude.

datalistings[]rating
numbernullable

Average guest rating out of 5; null for a new listing.

datalistings[]reviewCount
integernullable

Reviews behind the rating; null for a new listing.

datalistings[]isNew
boolean

True when the card shows `New` instead of a rating.

datalistings[]isGuestFavorite
boolean

Whether the card carries the `Guest favorite` badge.

datalistings[]isSuperhost
boolean

Whether the card carries the `Superhost` badge.

Badges as shown, e.g. `Guest favorite`.

datalistings[]badges[]
stringoptional

Details the card lists, e.g. `2 king beds`, `1 bath`.

datalistings[]highlights[]
stringoptional

Booking messages the card shows, e.g. `Free cancellation`.

datalistings[]offers[]
stringoptional

Photo URLs the card shows. Links only; not hosted by Social Fetch.

datalistings[]photos[]
stringoptional
datalistings[]propertyId
stringnullable

Hotel or property id, for a room in a hotel; null for a home.

datalistings[]checkIn
stringnullable

Check-in date the price is for, `YYYY-MM-DD`: your `checkIn`, or the listing's next free dates when you passed none.

datalistings[]checkOut
stringnullable

Check-out date the price is for, `YYYY-MM-DD`.

Price for the stay; null when the card shows none.

datalistings[]pricetotal
numbernullable

Total for the stay in `currency`, as the result card shows it.

datalistings[]pricetotalText
string

Total as shown, e.g. `$1,374`.

datalistings[]priceoriginalTotal
numbernullable

Total before a discount, when the card shows one struck through.

datalistings[]priceoriginalTotalText
stringnullable

Total before a discount as shown.

datalistings[]pricecurrency
string

Currency of every amount, e.g. `USD`.

datalistings[]pricenights
integernullable

Nights the total covers.

datalistings[]priceperNight
numbernullable

Nightly rate in the breakdown, before discounts.

datalistings[]pricefeesIncluded
boolean

Always true: the site's totals include the cleaning and service fees.

one of: true

datalistings[]pricetaxesIncluded
booleannullable

Whether taxes are in the total: false when the site says `before taxes`; null when it says neither.

The price details the card opens: nights, discounts, total.

datalistings[]pricebreakdown[]label
string

Line as shown, e.g. `5 nights x $331.10` or `Early booking discount`.

datalistings[]pricebreakdown[]amount
numbernullable

Amount in `currency`; negative for a discount.

datalistings[]pricebreakdown[]amountText
stringnullable

Amount as shown, e.g. `-$281.45`.

datapagepage
integer

Page number of this response, from 1.

datapagehasMore
boolean

Whether another page is available.

datapagenextCursor
stringnullable

Pass as `cursor` to get the next page; null on the last page.

datapagelastPage
integernullable

Last page the site offers for this search, at most 15.

datapagetruncated
boolean

True when more stays match than the site's 15 pages reach: the list ends early. Narrow the search (dates, a smaller place) to reach the rest.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

metastale
booleanoptional

Present, and `true`, only when the source couldn't be reached and this is the last good answer for the same request instead, up to 24 hours old. Absent on every live answer.

one of: true

metafetchedAt
stringoptional

When a stale answer (`stale: true`) was originally fetched (ISO 8601, UTC). Absent on every live answer.

Code example

curl "https://api.socialfetch.dev/v1/airbnb/search?location=London" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Airbnb stays for a place and dates.