--- title: "Airbnb Search" method: POST path: "/v1/airbnb/search" tags: ["Video and property search"] --- # Airbnb Search `POST /v1/airbnb/search` ## Request - Base URL: `https://api.prismcrawl.com` - URL: `https://api.prismcrawl.com/v1/airbnb/search` - Auth: API key in header `x-api-key` Search Airbnb stays with dates, guests, map bounds, property filters, prices, and pagination. ## Request body - union - object: Search Airbnb stays with dates, guests, map bounds, property filters, prices, and pagination. - `query` string, required: Text to search for on the selected service. At most 8,192 UTF-8 bytes. - `map_bounds` string: Map bounds as north,east,south,west. - `check_in_date` string: Check-in date in YYYY-MM-DD format. - `check_out_date` string: Check-out date in YYYY-MM-DD format. - `airbnb_domain` 'airbnb.com' | 'sq.airbnb.com' | 'ar.airbnb.com' | 'hy.airbnb.com' | 'az.airbnb.com' | 'bs.airbnb.com' | 'bg.airbnb.com' | 'airbnb.cn' | 'zh.airbnb.com' | 'airbnb.com.hk' | 'airbnb.com.tw' | 'zh-t.airbnb.com' | 'hr.airbnb.com' | 'airbnb.cz' | 'cs.airbnb.com' | 'airbnb.dk' | 'da.airbnb.com' | 'airbnb.be' | 'airbnb.nl' | 'nl.airbnb.com' | 'airbnb.com.au' | 'airbnb.ca' | 'airbnb.gy' | 'airbnb.co.in' | 'airbnb.ie' | 'airbnb.com.mt' | 'airbnb.co.nz' | 'airbnb.com.sg' | 'airbnb.co.za' | 'airbnb.ae' | 'airbnb.co.uk' | 'airbnb.com.ee' | 'et.airbnb.com' | 'airbnb.fi' | 'fi.airbnb.com' | 'fr.airbnb.be' | 'fr.airbnb.ca' | 'airbnb.fr' | 'airbnb.lu' | 'fr.airbnb.ch' | 'fr.airbnb.com' | 'ka.airbnb.com' | 'airbnb.at' | 'airbnb.de' | 'airbnb.ch' | 'de.airbnb.com' | 'airbnb.gr' | 'el.airbnb.com' | 'he.airbnb.com' | 'hi.airbnb.com' | 'airbnb.hu' | 'hu.airbnb.com' | 'airbnb.is' | 'is.airbnb.com' | 'airbnb.co.id' | 'id.airbnb.com' | 'ga.airbnb.com' | 'airbnb.it' | 'it.airbnb.ch' | 'it.airbnb.com' | 'airbnb.jp' | 'ja.airbnb.com' | 'kn.airbnb.com' | 'airbnb.co.kr' | 'ko.airbnb.com' | 'lv.airbnb.com' | 'lt.airbnb.com' | 'mk.airbnb.com' | 'airbnb.com.my' | 'ms.airbnb.com' | 'mt.airbnb.com' | 'airbnb.no' | 'no.airbnb.com' | 'airbnb.pl' | 'pl.airbnb.com' | 'airbnb.com.br' | 'airbnb.pt' | 'pt.airbnb.com' | 'ro.airbnb.com' | 'airbnb.ru' | 'ru.airbnb.com' | 'sr.airbnb.com' | 'sk.airbnb.com' | 'sl.airbnb.com' | 'airbnb.com.ar' | 'airbnb.com.bz' | 'airbnb.com.bo' | 'airbnb.cl' | 'airbnb.com.co' | 'airbnb.co.cr' | 'airbnb.com.ec' | 'airbnb.com.sv' | 'airbnb.com.gt' | 'airbnb.com.hn' | 'airbnb.mx' | 'airbnb.com.ni' | 'airbnb.com.pa' | 'airbnb.com.py' | 'airbnb.com.pe' | 'airbnb.es' | 'es.airbnb.com' | 'airbnb.co.ve' | 'es-l.airbnb.com' | 'sw.airbnb.com' | 'airbnb.se' | 'sv.airbnb.com' | 'airbnb.com.ph' | 'tl.airbnb.com' | 'th.airbnb.com' | 'airbnb.com.tr' | 'tr.airbnb.com' | 'uk.airbnb.com' | 'vi.airbnb.com' | 'airbnb.com.vn' | 'xh.airbnb.com' | 'zu.airbnb.com': Airbnb domain and locale. - `currency` 'AED' | 'ARS' | 'AUD' | 'AWG' | 'BAM' | 'BBD' | 'BGN' | 'BHD' | 'BND' | 'BRL' | 'BTN' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'FJD' | 'GBP' | 'GHS' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KRW' | 'KZT' | 'LAK' | 'LKR' | 'MAD' | 'MOP' | 'MXN' | 'MYR' | 'NOK' | 'NZD' | 'OMR' | 'PEN' | 'PGK' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TTD' | 'TWD' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR': Airbnb price currency. - `adults` integer: Number of adults. - `children` integer: Number of children. - `infants` integer: Number of infants. - `pets` integer: Number of pets. - `bedrooms` integer: Number of bedrooms required, at minimum. - `beds` integer: Number of beds required, at minimum. - `bathrooms` number: Minimum number of bathrooms. - `min_price` integer: Minimum total trip price. - `max_price` integer: Maximum total trip price. - `room_type` 'entire_home' | 'private_room': Type of place. - `property_types` string: Comma-separated property types. - `amenities` string: Comma-separated amenities. - `accessibility_features` string: Comma-separated accessibility features. - `host_languages` string: Comma-separated host languages. - `instant_book` boolean: Only include instant book stays when true. - `self_check_in` boolean: Only include self check in stays when true. - `guest_favorite` boolean: Only include guest favorite stays when true. - `luxe` boolean: Only include luxe stays when true. - `page` integer: One-based page number. - `html` boolean: Return the encoded original response rather than parsed JSON. - `zero_trace` boolean: Do not archive source or parsed response artifacts. - `output` 'json' | 'html' | 'md' | 'null', nullable: Response content format. md returns Markdown in data.content with data.format=md; the JSON success/request envelope remains. Accept: text/markdown also selects Markdown unless output or html=true is explicit. html is an alias for html=true and retains the existing Brotli/Base64 source format. - `json_restrictor` string, nullable: Select fields within data.content for JSON or Markdown. Supports comma-separated paths, non-negative array indices, half-open slices [0:3] (either bound may be omitted), [] and .{nested,subqueries}. Up to128 selections and16 levels. Missing fields are omitted; selected declared fields retain their zero defaults. The request envelope and credit headers remain. Include next_page_token when pagination is needed. Incompatible with HTML output. This changes response presentation only; tracing-enabled history retains the complete JSON result. - `no_cache` boolean, nullable: Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies. - object: Search Airbnb stays with dates, guests, map bounds, property filters, prices, and pagination. - `query` string: Text to search for on the selected service. At most 8,192 UTF-8 bytes. - `map_bounds` string, required: Map bounds as north,east,south,west. - `check_in_date` string: Check-in date in YYYY-MM-DD format. - `check_out_date` string: Check-out date in YYYY-MM-DD format. - `airbnb_domain` 'airbnb.com' | 'sq.airbnb.com' | 'ar.airbnb.com' | 'hy.airbnb.com' | 'az.airbnb.com' | 'bs.airbnb.com' | 'bg.airbnb.com' | 'airbnb.cn' | 'zh.airbnb.com' | 'airbnb.com.hk' | 'airbnb.com.tw' | 'zh-t.airbnb.com' | 'hr.airbnb.com' | 'airbnb.cz' | 'cs.airbnb.com' | 'airbnb.dk' | 'da.airbnb.com' | 'airbnb.be' | 'airbnb.nl' | 'nl.airbnb.com' | 'airbnb.com.au' | 'airbnb.ca' | 'airbnb.gy' | 'airbnb.co.in' | 'airbnb.ie' | 'airbnb.com.mt' | 'airbnb.co.nz' | 'airbnb.com.sg' | 'airbnb.co.za' | 'airbnb.ae' | 'airbnb.co.uk' | 'airbnb.com.ee' | 'et.airbnb.com' | 'airbnb.fi' | 'fi.airbnb.com' | 'fr.airbnb.be' | 'fr.airbnb.ca' | 'airbnb.fr' | 'airbnb.lu' | 'fr.airbnb.ch' | 'fr.airbnb.com' | 'ka.airbnb.com' | 'airbnb.at' | 'airbnb.de' | 'airbnb.ch' | 'de.airbnb.com' | 'airbnb.gr' | 'el.airbnb.com' | 'he.airbnb.com' | 'hi.airbnb.com' | 'airbnb.hu' | 'hu.airbnb.com' | 'airbnb.is' | 'is.airbnb.com' | 'airbnb.co.id' | 'id.airbnb.com' | 'ga.airbnb.com' | 'airbnb.it' | 'it.airbnb.ch' | 'it.airbnb.com' | 'airbnb.jp' | 'ja.airbnb.com' | 'kn.airbnb.com' | 'airbnb.co.kr' | 'ko.airbnb.com' | 'lv.airbnb.com' | 'lt.airbnb.com' | 'mk.airbnb.com' | 'airbnb.com.my' | 'ms.airbnb.com' | 'mt.airbnb.com' | 'airbnb.no' | 'no.airbnb.com' | 'airbnb.pl' | 'pl.airbnb.com' | 'airbnb.com.br' | 'airbnb.pt' | 'pt.airbnb.com' | 'ro.airbnb.com' | 'airbnb.ru' | 'ru.airbnb.com' | 'sr.airbnb.com' | 'sk.airbnb.com' | 'sl.airbnb.com' | 'airbnb.com.ar' | 'airbnb.com.bz' | 'airbnb.com.bo' | 'airbnb.cl' | 'airbnb.com.co' | 'airbnb.co.cr' | 'airbnb.com.ec' | 'airbnb.com.sv' | 'airbnb.com.gt' | 'airbnb.com.hn' | 'airbnb.mx' | 'airbnb.com.ni' | 'airbnb.com.pa' | 'airbnb.com.py' | 'airbnb.com.pe' | 'airbnb.es' | 'es.airbnb.com' | 'airbnb.co.ve' | 'es-l.airbnb.com' | 'sw.airbnb.com' | 'airbnb.se' | 'sv.airbnb.com' | 'airbnb.com.ph' | 'tl.airbnb.com' | 'th.airbnb.com' | 'airbnb.com.tr' | 'tr.airbnb.com' | 'uk.airbnb.com' | 'vi.airbnb.com' | 'airbnb.com.vn' | 'xh.airbnb.com' | 'zu.airbnb.com': Airbnb domain and locale. - `currency` 'AED' | 'ARS' | 'AUD' | 'AWG' | 'BAM' | 'BBD' | 'BGN' | 'BHD' | 'BND' | 'BRL' | 'BTN' | 'BZD' | 'CAD' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'EGP' | 'EUR' | 'FJD' | 'GBP' | 'GHS' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KRW' | 'KZT' | 'LAK' | 'LKR' | 'MAD' | 'MOP' | 'MXN' | 'MYR' | 'NOK' | 'NZD' | 'OMR' | 'PEN' | 'PGK' | 'PHP' | 'PLN' | 'QAR' | 'RON' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TTD' | 'TWD' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR': Airbnb price currency. - `adults` integer: Number of adults. - `children` integer: Number of children. - `infants` integer: Number of infants. - `pets` integer: Number of pets. - `bedrooms` integer: Number of bedrooms required, at minimum. - `beds` integer: Number of beds required, at minimum. - `bathrooms` number: Minimum number of bathrooms. - `min_price` integer: Minimum total trip price. - `max_price` integer: Maximum total trip price. - `room_type` 'entire_home' | 'private_room': Type of place. - `property_types` string: Comma-separated property types. - `amenities` string: Comma-separated amenities. - `accessibility_features` string: Comma-separated accessibility features. - `host_languages` string: Comma-separated host languages. - `instant_book` boolean: Only include instant book stays when true. - `self_check_in` boolean: Only include self check in stays when true. - `guest_favorite` boolean: Only include guest favorite stays when true. - `luxe` boolean: Only include luxe stays when true. - `page` integer: One-based page number. - `html` boolean: Return the encoded original response rather than parsed JSON. - `zero_trace` boolean: Do not archive source or parsed response artifacts. - `output` 'json' | 'html' | 'md' | 'null', nullable: Response content format. md returns Markdown in data.content with data.format=md; the JSON success/request envelope remains. Accept: text/markdown also selects Markdown unless output or html=true is explicit. html is an alias for html=true and retains the existing Brotli/Base64 source format. - `json_restrictor` string, nullable: Select fields within data.content for JSON or Markdown. Supports comma-separated paths, non-negative array indices, half-open slices [0:3] (either bound may be omitted), [] and .{nested,subqueries}. Up to128 selections and16 levels. Missing fields are omitted; selected declared fields retain their zero defaults. The request envelope and credit headers remain. Include next_page_token when pagination is needed. Incompatible with HTML output. This changes response presentation only; tracing-enabled history retains the complete JSON result. - `no_cache` boolean, nullable: Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies. ## Response `200` Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors. - CatalogAirbnbResponse - `success` true, required - `request_id` string, uuid, required - `data` union, required - MarkdownSearchData - `format` union, required - '' - 'md' - `content` string, required: Markdown derived from the parsed result, after any json_restrictor selection. - ProjectedSearchData - `format` union, required - '' - 'json' - `content` object, required: Only fields selected by json_restrictor. Selected fields retain their declared types and zero defaults. - object - `format` 'json', required - `content` object, required - `has_next_page` boolean, required - `next_page_token` string, required: Opaque continuation token valid for one hour and the same account. Retain search parameters, device, and result limit. Restart pagination if the token is expired or rejected; tokens from before the authenticated-token rollout cannot be reused. - `results` object[], required - `address` union, required - string - object - string[] - `badges` string[], required - `bathrooms` number, required - `bedrooms` number, required - `beds` number, required - `category` string, required - `check_in_date` string, required - `check_out_date` string, required - `coordinates` object, required - `latitude` number, required - `longitude` number, required - `description` string, required - `details` string[], required - `free_cancellation` boolean, required - `gps_coordinates` object, required - `__typename` string, required - `latitude` number, required - `longitude` number, required - `highlights` string[], required - `id` string, required - `images` string[], required - `latitude` number, required - `link` string, required - `listing_id` string, required - `longitude` number, required - `name` string, required - `old_price` string, required - `phone` string, required - `position` integer, required - `price` string, required - `price_breakdown` object[], required - `__typename` string, required - `collapsable` string, required - `content` string, required - `items` object[], required - … - `renderBorderTop` boolean, required - `price_qualifier` string, required - `rank` integer, required - `rating` union, required - number - string - `rating_max` number, required - `rating_source` string, required - `rating_text` string, required - `review_count` union, required - number - string - `reviews` number, required - `snippet` string, required - `thumbnail` string, required - `title` string, required - `type` string, required - `url` string, required - `website` string, required - `search_parameters` object, required - `accessibility_features` string, required - `adults` integer, required - `airbnb_domain` string, required - `amenities` string, required - `bathrooms` number, required - `bedrooms` integer, required - `beds` integer, required - `check_in_date` string, required - `check_out_date` string, required - `children` integer, required - `currency` string, required - `device` string, required - `engine` string, required - `guest_favorite` boolean, required - `host_languages` string, required - `infants` integer, required - `instant_book` boolean, required - `luxe` boolean, required - `map_bounds` string, required - `max_price` integer, required - `min_price` integer, required - `operation` string, required - `page` integer, required - `pagination_limited` boolean, required: True when further pagination is unavailable. A completed source-stale request can contain verified results or an empty array; next_page_token is an empty string. - `pagination_reason` string, required: stale_cursor means a valid continuation was fetched but its source inventory changed. The HTTP 200 response is billable; keep any verified results and restart pagination. - `pets` integer, required - `property_types` string, required - `query` string, required - `query_displayed` string, required - `room_type` string, required - `self_check_in` boolean, required - `total_results` number, required - `type` string, required - `serp_features` object[], required - `confidence` number, required - `engine` string, required - `extracted_at` string, required - `id` string, required - `items` object[], required - `link` string, required - `product_id` string, required - `text` string, required - `thumbnail` string, required - `title` string, required - `links` object[], required - `title` string, required - `url` string, required - `position` object, required - `absolute` integer, required - `source_result_ids` string[], required - `text` string, required - `title` string, required - `type` string, required - GoogleHtmlSearchData - `format` union, required - '' - 'html+br+base64' - `content` string, byte, required: Base64-encoded bytes. Decode Base64 first, then decompress the result with Brotli. Available deferred or lazy-loaded thumbnail sources are placed in image src attributes, within size limits; image and video files are not downloaded. When rewrite_links is true, already-resolved opaque Google anchor links use their destination URLs. Unresolved links are preserved. ## Other responses - `400`: The JSON body, source selection, or continuation is invalid. Locally malformed, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. A source may also reject an otherwise well-formed selector after acquisition. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead. - `401`: The API token is missing, invalid, expired, or revoked. - `402`: No credits remain. - `429`: Account rate limit exceeded. - `500`: The request could not be completed. --- [API](https://skmtc.dev/prismcrawl/apis/prismcrawl-api.md) · [All operations](https://skmtc.dev/prismcrawl/apis/prismcrawl-api/llms.txt) · [OpenAPI document](https://skmtc.dev/prismcrawl/apis/prismcrawl-api/revisions/eef17f6c02a5?raw)