Airbnb search (GET) — GET /api/v1/search

Keep `engine=airbnb, every existing query parameter and either the api_key` query credential or Bearer token; only replace the origin.

Request

GEThttps://api.scrapercompany.com/api/v1/search

Authenticate with your API key in the x-api-key header (see Authentication).

Parameters

enginestringdefault airbnb
Must be airbnb.
One ofairbnb
qstring | null
Destination text. Required unless bounding_box is supplied.
bounding_boxstring | null
Map bounds as [[ne_lat,ne_lng],[sw_lat,sw_lng]]; takes precedence over q.
airbnb_domainstringdefault airbnb.com
Country/language Airbnb host.
94 allowed values
airbnb.ae, airbnb.am, airbnb.at, airbnb.az, airbnb.ba, airbnb.be, airbnb.ca, airbnb.cat, airbnb.ch, airbnb.cl, airbnb.cn, airbnb.co.cr, airbnb.co.id, airbnb.co.in, airbnb.co.kr, airbnb.co.nz, airbnb.co.uk, airbnb.co.ve, airbnb.com, airbnb.com.ar, airbnb.com.au, airbnb.com.bo, airbnb.com.br, airbnb.com.bz, airbnb.com.co, airbnb.com.ec, airbnb.com.ee, airbnb.com.gt, airbnb.com.hk, airbnb.com.hn, airbnb.com.my, airbnb.com.ni, airbnb.com.pa, airbnb.com.pe, airbnb.com.ph, airbnb.com.py, airbnb.com.ro, airbnb.com.sg, airbnb.com.sv, airbnb.com.tr, airbnb.com.tw, airbnb.com.ua, airbnb.com.vn, airbnb.cz, airbnb.de, airbnb.dk, airbnb.es, airbnb.fi, airbnb.fr, airbnb.gr, airbnb.gy, airbnb.hu, airbnb.ie, airbnb.is, airbnb.it, airbnb.jp, airbnb.lt, airbnb.lu, airbnb.lv, airbnb.me, airbnb.mx, airbnb.nl, airbnb.no, airbnb.pl, airbnb.pt, airbnb.rs, airbnb.ru, airbnb.se, airbnb.si, ar.airbnb.com, bg.airbnb.com, de.airbnb.lu, es.airbnb.com, fr.airbnb.be, fr.airbnb.ca, fr.airbnb.ch, ga.airbnb.ie, he.airbnb.com, hi.airbnb.co.in, hr.airbnb.com, it.airbnb.ch, ka.airbnb.com, kn.airbnb.co.in, mk.airbnb.com, mr.airbnb.co.in, mt.airbnb.com.mt, sk.airbnb.com, sq.airbnb.com, sw.airbnb.com, th.airbnb.com, xh.airbnb.co.za, zh-t.airbnb.com, zh.airbnb.com, zu.airbnb.co.za
currencystring | null
Airbnb-supported ISO 4217 display currency.
51 allowed values
AED, AUD, BAM, BGN, BRL, CAD, CHF, CLP, CNY, COP, CRC, CZK, DKK, EGP, EUR, GBP, GHS, GTQ, HKD, HNL, HUF, IDR, ILS, INR, JPY, KES, KRW, KZT, MAD, MXN, MYR, NOK, NZD, PEN, PHP, PLN, QAR, RON, RUB, SAR, SEK, SGD, THB, TRY, TWD, UAH, UGX, USD, UYU, VND, ZAR
include_taxesbooleandefault false
Include tax-inclusive totals when Airbnb exposes a tax line.
check_in_datestring (date) | null
Exact check-in date in YYYY-MM-DD form.
check_out_datestring (date) | null
Exact check-out date; defaults to the next day.
time_periodstring | null
Flexible dates: weekend_trip, one_week, or one_month; cannot be mixed with exact dates.
One ofone_monthone_weekweekend_trip
adultsinteger | null
Adults aged 13+, from 0 through 16.
childreninteger | null
Children aged 2–12, from 0 through 15.
infantsinteger | null
Infants under 2, from 0 through 5.
petsinteger | null
Pets, from 0 through 5.
price_mininteger | null
Minimum displayed trip price.
price_maxinteger | null
Maximum displayed trip price.
type_of_placestringdefault any
any, room, or entire_home.
One ofanyentire_homeroom
property_typesstring | null
Comma-separated house, guesthouse, apartment, and/or hotel.
bedroomsinteger | null
Minimum bedrooms, from 0 through 8.
bedsinteger | null
Minimum beds, from 0 through 8.
bathroomsinteger | null
Minimum bathrooms, from 0 through 8.
amenitiesstring | null
Comma-separated SearchAPI amenity names.
next_page_tokenstring | null
Opaque cursor from pagination.next_page_token on the prior page.
zero_retentionbooleandefault false
Accepted for SearchAPI compatibility; raw search HTML and results are never persisted.

Example request

curl "https://api.scrapercompany.com/api/v1/search?engine=airbnb&q=Toronto&check_in_date=2026-11-30&check_out_date=2026-12-02&adults=2" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY"

Response

200 — SearchAPI-compatible Airbnb destination results with live prices. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response

{
  "search_metadata": {
    "id": "search_2af4914e869a4a36958659ef",
    "status": "Success",
    "created_at": "2026-08-06T18:46:11+00:00",
    "request_time_taken": 1.3,
    "parsing_time_taken": 0.02,
    "total_time_taken": 1.32,
    "request_url": "https://www.airbnb.ca/s/Toronto/homes?...",
    "wire_bytes": 918246
  },
  "search_parameters": {
    "engine": "airbnb",
    "airbnb_domain": "airbnb.ca",
    "currency": "CAD",
    "q": "Toronto",
    "check_in_date": "2029-02-01",
    "check_out_date": "2029-02-03",
    "adults": "2",
    "include_taxes": "true"
  },
  "search_information": {
    "query_displayed": "Homes in Toronto, Canada",
    "results": "Over 1,000 homes in Toronto",
    "check_in_date": "2029-02-01",
    "check_out_date": "2029-02-03",
    "adults": 2,
    "guests": "2 guests"
  },
  "properties": [
    {
      "position": 1,
      "id": "734254017349424949",
      "title": "Chic Studio w Balcony Fast WiFi by Yonge-Dundas",
      "description": "Condo in Toronto",
      "link": "https://www.airbnb.ca/rooms/734254017349424949",
      "booking_link": "https://www.airbnb.ca/rooms/734254017349424949?check_in=2026-09-10&check_out=2026-09-12&adults=2&children=0&infants=0&pets=0",
      "booking_token": "eyJjaGVja19pbiI6IjIwMjYtMDktMTAiLCJwcm9wZXJ0eV9pZCI6IjczNDI1NDAxNzM0OTQyNDk0OSJ9",
      "rating": 4.96,
      "reviews": 166,
      "price": {
        "total_price": "$737 CAD",
        "extracted_total_price": 737,
        "total_with_taxes": "$737 CAD",
        "extracted_total_with_taxes": 737,
        "qualifier": "for 2 nights",
        "extracted_qualifier": 2,
        "price_per_qualifier": "2 nights x $310.00 CAD",
        "extracted_price_per_qualifier": 310,
        "breakdown": [
          {
            "description": "2 nights x $310.00 CAD",
            "price": "$620.00 CAD",
            "extracted_price": 620
          },
          {
            "description": "Taxes",
            "price": "$117.00 CAD",
            "extracted_price": 117
          }
        ]
      },
      "check_in_date": "2029-02-01",
      "check_out_date": "2029-02-03",
      "time_period": "Sep 10 – 12",
      "accommodations": [
        "1 bedroom",
        "1 queen bed"
      ],
      "gps_coordinates": {
        "latitude": 43.654,
        "longitude": -79.38
      },
      "has_free_cancellation": true,
      "badges": [
        "Guest favourite"
      ],
      "images": [
        "https://a0.muscache.com/im/pictures/example.jpeg"
      ]
    }
  ],
  "pagination": {
    "next_page_token": "eyJzZWN0aW9uX29mZnNldCI6MH0="
  }
}

Arrays are shortened to their first items.

Response fields

Fields marked required are always present; others appear when they apply.

search_metadataobjectrequired
Show 10 child fieldsHide child fields
- search_metadata.idstringrequired
- search_metadata.statusstringrequired
- search_metadata.created_atstringrequired
- search_metadata.collection_idstringrequired
- search_metadata.observed_atstringrequired
- search_metadata.request_time_takennumberrequired
- search_metadata.parsing_time_takennumberrequired
- search_metadata.total_time_takennumberrequired
- search_metadata.request_urlstringrequired
- search_metadata.wire_bytesintegerrequired
search_parametersobjectrequired
Echo of the effective request. Every value is a string; parameters that were not set are omitted.
Show 2 child fieldsHide child fields
- search_parameters.enginestringrequired
  One ofairbnb
- search_parameters.airbnb_domainstringrequired
search_informationobjectrequired
Show 10 child fieldsHide child fields
- search_information.query_displayedstringrequired
- search_information.resultsstringrequired
- search_information.check_in_datestring
- search_information.check_out_datestring
- search_information.time_periodstring
- search_information.adultsinteger
- search_information.childreninteger
- search_information.infantsinteger
- search_information.petsinteger
- search_information.guestsstringrequired
  e.g. 2 guests or Add guests.
propertiesarray of objectrequired
Show 20 child fieldsHide child fields
- properties[].positionintegerrequired
- properties[].idstringrequired
- properties[].titlestring
- properties[].descriptionstring
- properties[].linkstringrequired
- properties[].booking_linkstringrequired
- properties[].booking_tokenstringrequired
- properties[].ratingnumber
- properties[].reviewsinteger
- properties[].priceobject
  Show 14 child fieldsHide child fields
  - properties[].price.total_pricestringrequired
    As displayed.
  - properties[].price.extracted_total_pricenumber | nullrequired
  - properties[].price.qualifierstring
    e.g. for 2 nights
  - properties[].price.extracted_qualifierinteger
  - properties[].price.price_per_qualifierstring
  - properties[].price.extracted_price_per_qualifiernumber | null
  - properties[].price.original_pricestring
  - properties[].price.extracted_original_pricenumber
  - properties[].price.discountstring
  - properties[].price.extracted_discountnumber
  - properties[].price.breakdownarray of object
  - properties[].price.total_with_taxesstring
    Only with include_taxes and a tax line.
  - properties[].price.extracted_total_with_taxesnumber | null
  - properties[].price.provenanceobjectrequired
    Where, when and how one normalized price was observed.
- properties[].check_in_datestring
- properties[].check_out_datestring
- properties[].time_periodstring
- properties[].accommodationsarray of string
- properties[].gps_coordinatesobject
  Show 2 child fieldsHide child fields
  - properties[].gps_coordinates.latitudenumberrequired
  - properties[].gps_coordinates.longitudenumberrequired
- properties[].has_free_cancellationboolean
  Only present (as true) when advertised.
- properties[].badgesarray of string
- properties[].imagesarray of string
- properties[].distancestring
- properties[].extracted_distancenumber
paginationobject
Present only when another page exists.
Show 1 child fieldHide child fields
- pagination.next_page_tokenstringrequired

Errors

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

Status	Meaning	Retry?
`401`Unauthorized	Missing or invalid API key. `{"detail":"missing or invalid API key"}`	No, fix the request
`402`Payment Required	Not enough credits for this request. Only returned once credit enforcement is switched on; during the beta metering runs in shadow mode and never blocks. `{"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."}`	No, fix the request
`422`Unprocessable Content	Request validation failed. `detail` is a list of problems for schema errors, or a string for semantic checks performed by the endpoint. `{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}`	No, fix the request
`429`Too Many Requests	Too many requests: the key's requests-per-minute limit was exceeded, or (once credit enforcement is on) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry. `{"detail":"rate limit 60/min exceeded"}`	Yes, with backoff
`502`Bad Gateway	The upstream source failed, blocked the request or returned an unusable answer. Safe to retry later; failed requests are not charged. `{"detail":"RuntimeError"}`	Yes, with backoff
`503`Service Unavailable	Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later. `{"detail":"database unavailable: OperationalError"}`	Yes, with backoff

Try it

Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? request access).
Copy the cURL example above and run it in a terminal.
Or open the interactive playground on api.scrapercompany.com, paste your key and pick this endpoint.

Credits

8 credits per successful call. Failed, blocked and empty results are free. Credit metering is in beta and does not block requests yet.

Request#

Parameters#

Example request#

Response#

Response fields#

Errors#

Try it#