--- title: "Explore Listings Within a Given Radius" method: POST path: "/listing/comps/area" tags: ["listing_data"] --- # Explore Listings Within a Given Radius `POST /listing/comps/area` This endpoint will return a list of comparable listings within a radius of a given address or location. Use [**Listing Filters**](/#tag/listing_filters) to specify details for listings you want to search for. This request will return details about the listings such as: * **Number of bedrooms and bathrooms** * **Overall Rating** * **Review Count** * **Metrics such as ADR, Revenue, and Occupancy** * **Amenities** Supports **Currency Conversion** for **non-USD** currencies. * By **default**, all currency data is in **USD**. ## Request body - union - ListingCompsInAreaRequestAddressSchema — Schema representing the base request for retrieving comps within a radius of an address or lat, lng point. - `address` string, required — String representing an address. Can include state, country, zipcode/postal code. - `radius` integer, required — Distance in meters to search from location. - `pagination` PaginationRequestSchema, required — Use this object to request a specific page of data. - `offset` number, required — The number of results to skip. (e.g. for the third page where `page_size=10`, you can set `offset=20`) - `page_size` number, required — The number of results to return per page. - `filters` union[] — Array of filters that can be used to refine your search results. - union - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'accommodates', required — Field to filter on (i.e. "accommodates"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'accommodates', required — Field to filter on (i.e. "accommodates"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'accommodates', required — Field to filter on (i.e. "accommodates"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - object — Use this filter to include results where the Listings match the requested amenity filters. - `field` 'amenities', required — Field to filter on (i.e. "amenities"). - `type` 'jsonb_boolean', required — Type of filter (i.e. "jsonb_boolean"). - `value` object, required — Key-value pairs of Amenity filters. - A value of `true` means the Amenity **must** be present. - A value of `false` means the Amenity **must not** be present. - `has_aircon` boolean — Whether the listing has Air Conditioning. - `has_breakfast` boolean — Whether the listing offers Breakfast. - `has_cable_tv` boolean — Whether the listing has Cable Television. - `has_dryer` boolean — Whether the listing has a Dryer. - `has_elevator` boolean — Whether the listing has an Elevator. - `has_gym` boolean — Whether the listing has a Gym. - `has_heating` boolean — Whether the listing has Heating. - `has_hottub` boolean — Whether the listing has a Hot tub. - `has_kitchen` boolean — Whether the listing has a Kitchen. - `has_parking` boolean — Whether the listing has onsite Parking. - `has_pets_allowed` boolean — Whether the listing allows Pets. - `has_pool` boolean — Whether the listing has a Pool. - `has_smoking` boolean — Whether the listing permits Smoking. - `has_tv` boolean — Whether the listing has a TV. - `has_washer` boolean — Whether the listing has a Washer. - `has_wireless_internet` boolean — Whether the listing has Wireless Internet. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'bathrooms', required — Field to filter on (i.e. "bathrooms"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'bathrooms', required — Field to filter on (i.e. "bathrooms"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'bathrooms', required — Field to filter on (i.e. "bathrooms"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'bedrooms', required — Field to filter on (i.e. "bedrooms"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'bedrooms', required — Field to filter on (i.e. "bedrooms"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'bedrooms', required — Field to filter on (i.e. "bedrooms"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - union - object — Listing is hosted on **at least one** of the selected channels (set overlap). The Listing may also be present on channels you did not select. - `field` 'channels', required — Field to filter on (i.e. "channels"). - `type` 'jsonb_array', required — Filter type for the overlap matching mode. - `value` ChannelOption[], required — Non-empty array of channels to match. A Listing matches if it is on at least one of these. - object — Listing's channel set is a **non-empty subset** of the selected channels — it is on at least one selected channel and on none of the unselected ones. - `field` 'channels', required — Field to filter on (i.e. "channels"). - `type` 'jsonb_array_subset', required — Filter type for the non-empty-subset matching mode. - `value` ChannelOption[], required — Non-empty array of channels. A Listing matches if its channel set is a non-empty subset of this list. - object — Listing is hosted on **exactly** the selected channels — no more, no fewer (set-equality). - `field` 'channels', required — Field to filter on (i.e. "channels"). - `type` 'jsonb_array_exact', required — Filter type for the exact set-equality matching mode. - `value` ChannelOption[], required — Non-empty array of channels. A Listing matches if its channel set equals this list exactly. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'days_available_ltm', required — Field to filter on (i.e. "days_available_ltm"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'days_available_ltm', required — Field to filter on (i.e. "days_available_ltm"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'days_available_ltm', required — Field to filter on (i.e. "days_available_ltm"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - object — Filter the `field` by a boolean value. - `field` 'instant_book', required — Field to filter on (i.e. "instant_book"). - `type` 'select', required — Filter type (i.e. "select"). - `value` boolean, required — Filter value. Must be `true` or `false`. - union - object — Filter the `field` to a specific single value. Used for `==` operations. - `field` 'listing_type', required — Field to filter on (i.e. "listing_type"). - `type` 'select', required — Filter type (i.e. "select"). - `value` 'entire_place' | 'private_room' | 'shared_room', required — The room type of the Listing. - object — Filter the `field` by multiple values. Each option in the `value` array will be treated like an "IN/OR" operation. - `field` 'listing_type', required — Field to filter on (i.e. "listing_type"). - `type` 'multi_select', required — Filter type (i.e. "multi_select"). - `value` ListingType[], required — Filter value. Must be an array of values. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'occupancy_rate_ltm', required — Field to filter on (i.e. "occupancy_rate_ltm"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'occupancy_rate_ltm', required — Field to filter on (i.e. "occupancy_rate_ltm"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'occupancy_rate_ltm', required — Field to filter on (i.e. "occupancy_rate_ltm"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - union - object — Filter the `field` to a specific single value. Used for `==` operations. - `field` 'price_tier', required — Field to filter on (i.e. "price_tier"). - `type` 'select', required — Filter type (i.e. "select"). - `value` 'budget' | 'economy' | 'midscale' | 'upscale' | 'luxury', required — The price category of the Listing. - object — Filter the `field` by multiple values. Each option in the `value` array will be treated like an "IN/OR" operation. - `field` 'price_tier', required — Field to filter on (i.e. "price_tier"). - `type` 'multi_select', required — Filter type (i.e. "multi_select"). - `value` PriceTier[], required — Filter value. Must be an array of values. - object — Filter the `field` by a boolean value. - `field` 'professionally_managed', required — Field to filter on (i.e. "professionally_managed"). - `type` 'select', required — Filter type (i.e. "select"). - `value` boolean, required — Filter value. Must be `true` or `false`. - union - object — Filter the `field` to a specific single value. Used for `==` operations. - `field` 'property_type', required — Field to filter on (i.e. "property_type"). - `type` 'select', required — Filter type (i.e. "select"). - `value` 'apartment' | 'barn' | 'bed_and_breakfast' | 'boat' | 'building' | 'bungalow' | 'bus' | 'cabin' | 'camper_rv' | 'campsite' | 'caravan' | 'casa_particular' | 'castle' | 'cave' | 'chalet' | 'condominium' | 'corporate_apartment' | 'cottage' | 'country_house' | 'cycladic_house' | 'dammuso' | 'dome_house' | 'earth_house' | 'estate' | 'farm_stay' | 'farmhouse' | 'guest_house' | 'guest_suite' | 'holiday_park' | 'house' | 'house_boat' | 'hut' | 'igloo' | 'island' | 'kezhan' | 'lighthouse' | 'loft' | 'mas' | 'mobile_home' | 'nature_lodge' | 'other' | 'place' | 'ranch' | 'riad' | 'serviced_apartment' | 'shepherds_hut' | 'shipping_container' | 'studio' | 'tent' | 'tiny_house' | 'tipi' | 'tower' | 'townhouse' | 'train' | 'treehouse' | 'vacation_home' | 'villa' | 'windmill' | 'yacht' | 'yurt', nullable, required — The property type of the Listing. - object — Filter the `field` by multiple values. Each option in the `value` array will be treated like an "IN/OR" operation. - `field` 'property_type', required — Field to filter on (i.e. "property_type"). - `type` 'multi_select', required — Filter type (i.e. "multi_select"). - `value` PropertyType[], required — Filter value. Must be an array of values. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'ratings', required — Field to filter on (i.e. "ratings"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'ratings', required — Field to filter on (i.e. "ratings"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'ratings', required — Field to filter on (i.e. "ratings"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - union - object — Filter the `field` to a specific single value. Used for `==` operations. - `field` 'real_estate_type', required — Field to filter on (i.e. "real_estate_type"). - `type` 'select', required — Filter type (i.e. "select"). - `value` 'apartment' | 'bed_and_breakfast' | 'house' | 'unique', required — The real estate type of the Listing. - object — Filter the `field` by multiple values. Each option in the `value` array will be treated like an "IN/OR" operation. - `field` 'real_estate_type', required — Field to filter on (i.e. "real_estate_type"). - `type` 'multi_select', required — Filter type (i.e. "multi_select"). - `value` RealEstateType[], required — Filter value. Must be an array of values. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'reviews_count', required — Field to filter on (i.e. "reviews_count"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'reviews_count', required — Field to filter on (i.e. "reviews_count"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'reviews_count', required — Field to filter on (i.e. "reviews_count"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - object — Filter the `field` by a boolean value. - `field` 'superhost', required — Field to filter on (i.e. "superhost"). - `type` 'select', required — Filter type (i.e. "select"). - `value` boolean, required — Filter value. Must be `true` or `false`. - `currency` 'afn' | 'all' | 'dzd' | 'usd' | 'eur' | 'aoa' | 'xcd' | 'ars' | 'amd' | 'awg' | 'aud' | 'azn' | 'bsd' | 'bhd' | 'bdt' | 'bbd' | 'byn' | 'bzd' | 'xof' | 'bmd' | 'btn' | 'inr' | 'bob' | 'bov' | 'bam' | 'bwp' | 'nok' | 'brl' | 'bnd' | 'bgn' | 'bif' | 'cve' | 'khr' | 'xaf' | 'cad' | 'kyd' | 'clf' | 'clp' | 'cny' | 'cop' | 'cou' | 'kmf' | 'cdf' | 'nzd' | 'crc' | 'hrk' | 'cuc' | 'cup' | 'ang' | 'czk' | 'dkk' | 'djf' | 'dop' | 'egp' | 'svc' | 'ern' | 'etb' | 'fkp' | 'fjd' | 'xpf' | 'gmd' | 'gel' | 'ghs' | 'gip' | 'gtq' | 'gbp' | 'gnf' | 'gyd' | 'htg' | 'hnl' | 'hkd' | 'huf' | 'isk' | 'idr' | 'xdr' | 'irr' | 'iqd' | 'ils' | 'jmd' | 'jpy' | 'jod' | 'kzt' | 'kes' | 'kpw' | 'krw' | 'kwd' | 'kgs' | 'lak' | 'lbp' | 'lsl' | 'zar' | 'lrd' | 'lyd' | 'chf' | 'mop' | 'mga' | 'mwk' | 'myr' | 'mvr' | 'mru' | 'mur' | 'xua' | 'mxn' | 'mxv' | 'mdl' | 'mnt' | 'mad' | 'mzn' | 'mmk' | 'nad' | 'npr' | 'nio' | 'ngn' | 'omr' | 'pkr' | 'pab' | 'pgk' | 'pyg' | 'pen' | 'php' | 'pln' | 'qar' | 'mkd' | 'ron' | 'rub' | 'rwf' | 'shp' | 'wst' | 'stn' | 'sar' | 'rsd' | 'scr' | 'sle' | 'sgd' | 'xsu' | 'sbd' | 'sos' | 'ssp' | 'lkr' | 'sdg' | 'srd' | 'szl' | 'sek' | 'che' | 'chw' | 'syp' | 'twd' | 'tjs' | 'tzs' | 'thb' | 'top' | 'ttd' | 'tnd' | 'try' | 'tmt' | 'ugx' | 'uah' | 'aed' | 'usn' | 'uyi' | 'uyu' | 'uzs' | 'vuv' | 'vef' | 'ved' | 'vnd' | 'yer' | 'zmw' | 'zwl' — ISO 4217 Currency Codes. - `sort_order` 'proximity' | 'revenue' | 'adr' | 'review_count' — The attribute by which to Sort the retrieved Listings. - `sort_direction` 'ascending' | 'descending' — The direction by which to Sort the retrieved data. - ListingCompsInAreaRequestLatLngSchema — Schema representing the base request for retrieving comps within a radius of an address or lat, lng point. - `lat` number, required — ISO 6709 Latitude coordinate. Must be used with `lng`. - `lng` number, required — ISO 6709 Longitude coordinate point. Must be used with `lat`. - `radius` integer, required — Distance in meters to search from location. - `pagination` PaginationRequestSchema, required — Use this object to request a specific page of data. - `offset` number, required — The number of results to skip. (e.g. for the third page where `page_size=10`, you can set `offset=20`) - `page_size` number, required — The number of results to return per page. - `filters` union[] — Array of filters that can be used to refine your search results. - union - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'accommodates', required — Field to filter on (i.e. "accommodates"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'accommodates', required — Field to filter on (i.e. "accommodates"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'accommodates', required — Field to filter on (i.e. "accommodates"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - object — Use this filter to include results where the Listings match the requested amenity filters. - `field` 'amenities', required — Field to filter on (i.e. "amenities"). - `type` 'jsonb_boolean', required — Type of filter (i.e. "jsonb_boolean"). - `value` object, required — Key-value pairs of Amenity filters. - A value of `true` means the Amenity **must** be present. - A value of `false` means the Amenity **must not** be present. - `has_aircon` boolean — Whether the listing has Air Conditioning. - `has_breakfast` boolean — Whether the listing offers Breakfast. - `has_cable_tv` boolean — Whether the listing has Cable Television. - `has_dryer` boolean — Whether the listing has a Dryer. - `has_elevator` boolean — Whether the listing has an Elevator. - `has_gym` boolean — Whether the listing has a Gym. - `has_heating` boolean — Whether the listing has Heating. - `has_hottub` boolean — Whether the listing has a Hot tub. - `has_kitchen` boolean — Whether the listing has a Kitchen. - `has_parking` boolean — Whether the listing has onsite Parking. - `has_pets_allowed` boolean — Whether the listing allows Pets. - `has_pool` boolean — Whether the listing has a Pool. - `has_smoking` boolean — Whether the listing permits Smoking. - `has_tv` boolean — Whether the listing has a TV. - `has_washer` boolean — Whether the listing has a Washer. - `has_wireless_internet` boolean — Whether the listing has Wireless Internet. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'bathrooms', required — Field to filter on (i.e. "bathrooms"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'bathrooms', required — Field to filter on (i.e. "bathrooms"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'bathrooms', required — Field to filter on (i.e. "bathrooms"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'bedrooms', required — Field to filter on (i.e. "bedrooms"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'bedrooms', required — Field to filter on (i.e. "bedrooms"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'bedrooms', required — Field to filter on (i.e. "bedrooms"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - union - object — Listing is hosted on **at least one** of the selected channels (set overlap). The Listing may also be present on channels you did not select. - `field` 'channels', required — Field to filter on (i.e. "channels"). - `type` 'jsonb_array', required — Filter type for the overlap matching mode. - `value` ChannelOption[], required — Non-empty array of channels to match. A Listing matches if it is on at least one of these. - object — Listing's channel set is a **non-empty subset** of the selected channels — it is on at least one selected channel and on none of the unselected ones. - `field` 'channels', required — Field to filter on (i.e. "channels"). - `type` 'jsonb_array_subset', required — Filter type for the non-empty-subset matching mode. - `value` ChannelOption[], required — Non-empty array of channels. A Listing matches if its channel set is a non-empty subset of this list. - object — Listing is hosted on **exactly** the selected channels — no more, no fewer (set-equality). - `field` 'channels', required — Field to filter on (i.e. "channels"). - `type` 'jsonb_array_exact', required — Filter type for the exact set-equality matching mode. - `value` ChannelOption[], required — Non-empty array of channels. A Listing matches if its channel set equals this list exactly. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'days_available_ltm', required — Field to filter on (i.e. "days_available_ltm"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'days_available_ltm', required — Field to filter on (i.e. "days_available_ltm"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'days_available_ltm', required — Field to filter on (i.e. "days_available_ltm"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - object — Filter the `field` by a boolean value. - `field` 'instant_book', required — Field to filter on (i.e. "instant_book"). - `type` 'select', required — Filter type (i.e. "select"). - `value` boolean, required — Filter value. Must be `true` or `false`. - union - object — Filter the `field` to a specific single value. Used for `==` operations. - `field` 'listing_type', required — Field to filter on (i.e. "listing_type"). - `type` 'select', required — Filter type (i.e. "select"). - `value` 'entire_place' | 'private_room' | 'shared_room', required — The room type of the Listing. - object — Filter the `field` by multiple values. Each option in the `value` array will be treated like an "IN/OR" operation. - `field` 'listing_type', required — Field to filter on (i.e. "listing_type"). - `type` 'multi_select', required — Filter type (i.e. "multi_select"). - `value` ListingType[], required — Filter value. Must be an array of values. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'occupancy_rate_ltm', required — Field to filter on (i.e. "occupancy_rate_ltm"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'occupancy_rate_ltm', required — Field to filter on (i.e. "occupancy_rate_ltm"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'occupancy_rate_ltm', required — Field to filter on (i.e. "occupancy_rate_ltm"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - union - object — Filter the `field` to a specific single value. Used for `==` operations. - `field` 'price_tier', required — Field to filter on (i.e. "price_tier"). - `type` 'select', required — Filter type (i.e. "select"). - `value` 'budget' | 'economy' | 'midscale' | 'upscale' | 'luxury', required — The price category of the Listing. - object — Filter the `field` by multiple values. Each option in the `value` array will be treated like an "IN/OR" operation. - `field` 'price_tier', required — Field to filter on (i.e. "price_tier"). - `type` 'multi_select', required — Filter type (i.e. "multi_select"). - `value` PriceTier[], required — Filter value. Must be an array of values. - object — Filter the `field` by a boolean value. - `field` 'professionally_managed', required — Field to filter on (i.e. "professionally_managed"). - `type` 'select', required — Filter type (i.e. "select"). - `value` boolean, required — Filter value. Must be `true` or `false`. - union - object — Filter the `field` to a specific single value. Used for `==` operations. - `field` 'property_type', required — Field to filter on (i.e. "property_type"). - `type` 'select', required — Filter type (i.e. "select"). - `value` 'apartment' | 'barn' | 'bed_and_breakfast' | 'boat' | 'building' | 'bungalow' | 'bus' | 'cabin' | 'camper_rv' | 'campsite' | 'caravan' | 'casa_particular' | 'castle' | 'cave' | 'chalet' | 'condominium' | 'corporate_apartment' | 'cottage' | 'country_house' | 'cycladic_house' | 'dammuso' | 'dome_house' | 'earth_house' | 'estate' | 'farm_stay' | 'farmhouse' | 'guest_house' | 'guest_suite' | 'holiday_park' | 'house' | 'house_boat' | 'hut' | 'igloo' | 'island' | 'kezhan' | 'lighthouse' | 'loft' | 'mas' | 'mobile_home' | 'nature_lodge' | 'other' | 'place' | 'ranch' | 'riad' | 'serviced_apartment' | 'shepherds_hut' | 'shipping_container' | 'studio' | 'tent' | 'tiny_house' | 'tipi' | 'tower' | 'townhouse' | 'train' | 'treehouse' | 'vacation_home' | 'villa' | 'windmill' | 'yacht' | 'yurt', nullable, required — The property type of the Listing. - object — Filter the `field` by multiple values. Each option in the `value` array will be treated like an "IN/OR" operation. - `field` 'property_type', required — Field to filter on (i.e. "property_type"). - `type` 'multi_select', required — Filter type (i.e. "multi_select"). - `value` PropertyType[], required — Filter value. Must be an array of values. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'ratings', required — Field to filter on (i.e. "ratings"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'ratings', required — Field to filter on (i.e. "ratings"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'ratings', required — Field to filter on (i.e. "ratings"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - union - object — Filter the `field` to a specific single value. Used for `==` operations. - `field` 'real_estate_type', required — Field to filter on (i.e. "real_estate_type"). - `type` 'select', required — Filter type (i.e. "select"). - `value` 'apartment' | 'bed_and_breakfast' | 'house' | 'unique', required — The real estate type of the Listing. - object — Filter the `field` by multiple values. Each option in the `value` array will be treated like an "IN/OR" operation. - `field` 'real_estate_type', required — Field to filter on (i.e. "real_estate_type"). - `type` 'multi_select', required — Filter type (i.e. "multi_select"). - `value` RealEstateType[], required — Filter value. Must be an array of values. - union - object — Filter the `field` by numerical data. Used for numeric comparison operations. - `field` 'reviews_count', required — Field to filter on (i.e. "reviews_count"). - `type` 'gt' | 'gte' | 'lt' | 'lte', required — Numeric Equality Filter type | enum | operator | description | | ---- | ------ | ----------- | | `"gt"` | `>` | Greater Than | | `"gte"` | `>=` | Greater Than or Equal | | `"lt"` | `<` | Less Than | | `"lte"` | `<=` | Less Than or Equal | - `value` number, required — Filter value. Must be a single `number`. - object — Filter the `field` by numeric data. Used for `==` operations. - `field` 'reviews_count', required — Field to filter on (i.e. "reviews_count"). - `type` 'select', required — Filter type (i.e. "select"). - `value` number, required — Filter value. Must be a `number`. - object — Filter the `field` by a numeric minimum and maximum range. - `field` 'reviews_count', required — Field to filter on (i.e. "reviews_count"). - `type` 'range', required — Filter type (i.e. "range"). - `value` number[], required — An `array` of two `number` values representing the minimum and maximum. * e.g. `[minimum, maximum]`. - object — Filter the `field` by a boolean value. - `field` 'superhost', required — Field to filter on (i.e. "superhost"). - `type` 'select', required — Filter type (i.e. "select"). - `value` boolean, required — Filter value. Must be `true` or `false`. - `currency` 'afn' | 'all' | 'dzd' | 'usd' | 'eur' | 'aoa' | 'xcd' | 'ars' | 'amd' | 'awg' | 'aud' | 'azn' | 'bsd' | 'bhd' | 'bdt' | 'bbd' | 'byn' | 'bzd' | 'xof' | 'bmd' | 'btn' | 'inr' | 'bob' | 'bov' | 'bam' | 'bwp' | 'nok' | 'brl' | 'bnd' | 'bgn' | 'bif' | 'cve' | 'khr' | 'xaf' | 'cad' | 'kyd' | 'clf' | 'clp' | 'cny' | 'cop' | 'cou' | 'kmf' | 'cdf' | 'nzd' | 'crc' | 'hrk' | 'cuc' | 'cup' | 'ang' | 'czk' | 'dkk' | 'djf' | 'dop' | 'egp' | 'svc' | 'ern' | 'etb' | 'fkp' | 'fjd' | 'xpf' | 'gmd' | 'gel' | 'ghs' | 'gip' | 'gtq' | 'gbp' | 'gnf' | 'gyd' | 'htg' | 'hnl' | 'hkd' | 'huf' | 'isk' | 'idr' | 'xdr' | 'irr' | 'iqd' | 'ils' | 'jmd' | 'jpy' | 'jod' | 'kzt' | 'kes' | 'kpw' | 'krw' | 'kwd' | 'kgs' | 'lak' | 'lbp' | 'lsl' | 'zar' | 'lrd' | 'lyd' | 'chf' | 'mop' | 'mga' | 'mwk' | 'myr' | 'mvr' | 'mru' | 'mur' | 'xua' | 'mxn' | 'mxv' | 'mdl' | 'mnt' | 'mad' | 'mzn' | 'mmk' | 'nad' | 'npr' | 'nio' | 'ngn' | 'omr' | 'pkr' | 'pab' | 'pgk' | 'pyg' | 'pen' | 'php' | 'pln' | 'qar' | 'mkd' | 'ron' | 'rub' | 'rwf' | 'shp' | 'wst' | 'stn' | 'sar' | 'rsd' | 'scr' | 'sle' | 'sgd' | 'xsu' | 'sbd' | 'sos' | 'ssp' | 'lkr' | 'sdg' | 'srd' | 'szl' | 'sek' | 'che' | 'chw' | 'syp' | 'twd' | 'tjs' | 'tzs' | 'thb' | 'top' | 'ttd' | 'tnd' | 'try' | 'tmt' | 'ugx' | 'uah' | 'aed' | 'usn' | 'uyi' | 'uyu' | 'uzs' | 'vuv' | 'vef' | 'ved' | 'vnd' | 'yer' | 'zmw' | 'zwl' — ISO 4217 Currency Codes. - `sort_order` 'proximity' | 'revenue' | 'adr' | 'review_count' — The attribute by which to Sort the retrieved Listings. - `sort_direction` 'ascending' | 'descending' — The direction by which to Sort the retrieved data. ## Response `200` Successfully retrieved Listings within a given Area. - object - `payload` ListingCompsInAreaResponseSchema, required — Schema representing the response for retrieving comps within a radius of an address or lat, lng point. - `page_info` PaginationResponseSchema, required — Describes the page information for the results. - `total_count` number, required — The number of total results available. - `offset` number, required — The number of results that were skipped. - `page_size` number, required — The number of results actually returned. - `sort_order` 'revenue' | 'occupancy' | 'adr' | 'review_count', required — The attribute by which to Sort the retrieved Listings. - `sort_direction` 'ascending' | 'descending', required — The direction by which to Sort the retrieved data. - `listings` object[], required — A collection of Listings that match the requested parameters. - `property_id` string, required — The AirDNA ID for the Listing. - `airbnb_host_id` string, nullable, required — ID for the Host on Airbnb. - `airbnb_property_id` string, required — ID for the Listing on Airbnb. - `airbnb_property_url` string, nullable, required — URL for the Listing on Airbnb. - `vrbo_property_id` string, required — ID for the Listing on Vrbo. - `vrbo_property_url` string, nullable, required — URL for the Listing on Vrbo. - `booking_property_id` string, nullable, required — ID for the Listing on Booking.com. - `booking_property_url` string, nullable, required — URL for the Listing on Booking.com. - `market_id` string, required — AirDNA ID for the Market that the Listing belongs to. - `market_name` string, required — The name of the Market that the Listing belongs to. - `country_name` string, required — The name of the Country that the Listing belongs to. - `city_name` string, required — The name of the City that the Listing belongs to. - `state_name` string, nullable, required — The name of the State that the Listing belongs to. - `zipcode` string, nullable, required — The zipcode that the Listing belongs to (US-only). - `msa_name` string, nullable, required — The metropolitan statistical area that the listing is located in (US only). - `location` GeomPoint, required — ISO 6709 Coordinates. - `lat` number, required — ISO 6709 Latitude coordinate. - `lng` number, required — ISO 6709 Longitude coordinate. - `exact_location` boolean, nullable, required — A boolean value indicating if the location value is exact or not. - `true` indicates that the latitude and longitude are the exact coordinates of the Listing. - `false` indicates that the latitude and longitude are scrambled coordinates within a 500 meter radius of the Listing. - `title` string, required — Title of the Listing. - `bedrooms` integer, required — Number of bedrooms the Listing has. - `bathrooms` number, required — Number of bathrooms the Listing has. - `accommodates` integer, required — Number of guests the Listing accommodates. - `rating` number, nullable, required — Rating of the Listing from a scale of 0 to 5. - `ratings` ListingRatings, required — The ratings for the Listing. - `overall_rating` number, nullable, required — Overall rating of the Listing from a scale of 0 to 5. - `airbnb_accuracy_rating` number, nullable, required — Average accuracy rating of the Listing on a scale of 0 to 5. - `airbnb_cleanliness_rating` number, nullable, required — Average cleanliness rating of the Listing on a scale of 0 to 5. - `airbnb_checkin_rating` number, nullable, required — Average checkin rating for the Listing on a scale of 0 to 5. - `airbnb_communication_rating` number, nullable, required — Average communication rating for the Listing on a scale of 0 to 5. - `airbnb_location_rating` number, nullable, required — Average location rating of the Listing on a scale of 0 to 5. - `airbnb_value_rating` number, nullable, required — Average value rating of the Listing on a scale of 0 to 5. - `listing_type` 'entire_place' | 'private_room' | 'shared_room', required — The room type of the Listing. - `property_type` 'apartment' | 'barn' | 'bed_and_breakfast' | 'boat' | 'building' | 'bungalow' | 'bus' | 'cabin' | 'camper_rv' | 'campsite' | 'caravan' | 'casa_particular' | 'castle' | 'cave' | 'chalet' | 'condominium' | 'corporate_apartment' | 'cottage' | 'country_house' | 'cycladic_house' | 'dammuso' | 'dome_house' | 'earth_house' | 'estate' | 'farm_stay' | 'farmhouse' | 'guest_house' | 'guest_suite' | 'holiday_park' | 'house' | 'house_boat' | 'hut' | 'igloo' | 'island' | 'kezhan' | 'lighthouse' | 'loft' | 'mas' | 'mobile_home' | 'nature_lodge' | 'other' | 'place' | 'ranch' | 'riad' | 'serviced_apartment' | 'shepherds_hut' | 'shipping_container' | 'studio' | 'tent' | 'tiny_house' | 'tipi' | 'tower' | 'townhouse' | 'train' | 'treehouse' | 'vacation_home' | 'villa' | 'windmill' | 'yacht' | 'yurt', nullable, required — The property type of the Listing. - `instant_book` boolean, required — Whether the Listing supports Instant Book. - `superhost` boolean, required — Whether the Listing is a Superhost. - `cancellation_policy` 'flexible' | 'moderate' | 'strict' | 'super_strict' | 'no refund', nullable, required — The type of cancellation policy for the Listing. - `amenities` Amenities, required — The amenities that the Listing claims are available. - `has_aircon` boolean, required — Whether the listing has Air Conditioning. - `has_breakfast` boolean, required — Whether the listing offers Breakfast. - `has_cable_tv` boolean, required — Whether the listing has Cable Television. - `has_doorman` boolean, required — Whether the listing has a Doorman. - `has_dryer` boolean, required — Whether the listing has a Dryer. - `has_elevator` boolean, required — Whether the listing has an Elevator. - `has_family_friendly` boolean, required — Whether the listing is considered Family Friendly. - `has_guidebook` boolean, required — Whether the listing provides a Guidebook. - `has_gym` boolean, required — Whether the listing has a Gym. - `has_handicap_access` boolean, required — Whether the listing has Handicap Access. - `has_heating` boolean, required — Whether the listing has Heating. - `has_hottub` boolean, required — Whether the listing has a Hot tub. - `has_indoor_fireplace` boolean, required — Whether the listing has an Indoor Fireplace. - `has_intercom` boolean, required — Whether the listing has an Intercom. - `has_internet` boolean, required — Whether the listing has Internet. - `has_kitchen` boolean, required — Whether the listing has a Kitchen. - `has_parking` boolean, required — Whether the listing has onsite Parking. - `has_pets_allowed` boolean, required — Whether the listing allows Pets. - `has_pool` boolean, required — Whether the listing has a Pool. - `has_smoking` boolean, required — Whether the listing permits Smoking. - `has_suitable_for_events` boolean, required — Whether the listing is suitable for Events. - `has_tv` boolean, required — Whether the listing has a TV. - `has_washer` boolean, required — Whether the listing has a Washer. - `has_wireless_internet` boolean, required — Whether the listing has Wireless Internet. - `host_size` '1' | '2-5' | '6-20' | '21+', required — The numeric range of Listings that the Host manages. - `property_manager_name` string, required — The name of the Property Manager. - `professionally_managed` boolean, required — Whether the Listing is professionally managed. - `reviews` integer, nullable, required — Number of reviews the Listing has. - `revenue_ltm` integer, required — The total revenue generated by the Listing in the last 12 months. - `revenue_potential_ltm` integer, required — The revenue potential of the Listing in the last 12 months. - `occupancy_rate_ltm` number, required — The occupancy rate of the Listing in the last 12 months. - `average_daily_rate_ltm` number, required — The average daily rate of the Listing in the last 12 months. - `days_available_ltm` integer, required — The number of days the Listing was available in the last 12 months. This includes days reserved/booked. - `days_blocked_ltm` integer, required — The number of days the Listing was blocked in the last 12 months. - `days_reserved_ltm` integer, required — The number of days the Listing was reserved/booked in the last 12 months. - `num_reservations_ltm` integer, required — The number of reservations/bookings made at the Listing in the last 12 months. - `cleaning_fee` number, nullable, required — The cost of the cleaning fee per reservation for the Listing in the requested currency. - `created_date` string, date, required — The date that the Listing was created in `YYYY-MM-DD` format. - `last_calendar_update` string, date, required — The date that the Listing's calendar was last scraped in `YYYY-MM-DD` format. - `last_scraped_date` string, date, required — The date that the Listing was last scraped in `YYYY-MM-DD` format. - `license` string, nullable, required — The Airbnb or Vrbo license number. - `minimum_stay` integer, required — The minimum stay required to reserve the Listing. - `response_rate` number, nullable, required — The percentage of new inquiries and reservation requests a host responds to within 24 hours. - `response_time` number, nullable, required — The average host response rate in minutes for new inquiries and reservation requests from a guest. - `currency` 'afn' | 'all' | 'dzd' | 'usd' | 'eur' | 'aoa' | 'xcd' | 'ars' | 'amd' | 'awg' | 'aud' | 'azn' | 'bsd' | 'bhd' | 'bdt' | 'bbd' | 'byn' | 'bzd' | 'xof' | 'bmd' | 'btn' | 'inr' | 'bob' | 'bov' | 'bam' | 'bwp' | 'nok' | 'brl' | 'bnd' | 'bgn' | 'bif' | 'cve' | 'khr' | 'xaf' | 'cad' | 'kyd' | 'clf' | 'clp' | 'cny' | 'cop' | 'cou' | 'kmf' | 'cdf' | 'nzd' | 'crc' | 'hrk' | 'cuc' | 'cup' | 'ang' | 'czk' | 'dkk' | 'djf' | 'dop' | 'egp' | 'svc' | 'ern' | 'etb' | 'fkp' | 'fjd' | 'xpf' | 'gmd' | 'gel' | 'ghs' | 'gip' | 'gtq' | 'gbp' | 'gnf' | 'gyd' | 'htg' | 'hnl' | 'hkd' | 'huf' | 'isk' | 'idr' | 'xdr' | 'irr' | 'iqd' | 'ils' | 'jmd' | 'jpy' | 'jod' | 'kzt' | 'kes' | 'kpw' | 'krw' | 'kwd' | 'kgs' | 'lak' | 'lbp' | 'lsl' | 'zar' | 'lrd' | 'lyd' | 'chf' | 'mop' | 'mga' | 'mwk' | 'myr' | 'mvr' | 'mru' | 'mur' | 'xua' | 'mxn' | 'mxv' | 'mdl' | 'mnt' | 'mad' | 'mzn' | 'mmk' | 'nad' | 'npr' | 'nio' | 'ngn' | 'omr' | 'pkr' | 'pab' | 'pgk' | 'pyg' | 'pen' | 'php' | 'pln' | 'qar' | 'mkd' | 'ron' | 'rub' | 'rwf' | 'shp' | 'wst' | 'stn' | 'sar' | 'rsd' | 'scr' | 'sle' | 'sgd' | 'xsu' | 'sbd' | 'sos' | 'ssp' | 'lkr' | 'sdg' | 'srd' | 'szl' | 'sek' | 'che' | 'chw' | 'syp' | 'twd' | 'tjs' | 'tzs' | 'thb' | 'top' | 'ttd' | 'tnd' | 'try' | 'tmt' | 'ugx' | 'uah' | 'aed' | 'usn' | 'uyi' | 'uyu' | 'uzs' | 'vuv' | 'vef' | 'ved' | 'vnd' | 'yer' | 'zmw' | 'zwl', required — ISO 4217 Currency Codes. - `distance` number, nullable, required — The distance (in meters) of the Listing from the given address or location. - `status` Status, required — The Status object on the response envelope - `type` 'success' | 'error', required — The type of response provided by the server. - `response_id` string, required — A unique response code that can be used as a reference for support requests. - `message` string, required — A human-readable message that can provide more detail about the status of the request. ## Other responses - `400` — The request was invalid. - `404` — Failed to find data matching your request. - `500` — An internal server error occurred. --- [API](https://skmtc.net/airdna/apis/airdna-enterprise-api.md) · [All operations](https://skmtc.net/airdna/apis/airdna-enterprise-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/airdna/airdna-enterprise-api/versions/aeed3678926f/schema)