Datasets

Facet the Airbnb markets dataset

Returns suppressed distribution counts over the Airbnb markets dataset, honoring the same filters as search. Facet enum: country, market, currency, superhost, guest_favorite, rating_band, review_band, admin1 (top subdivision), locality (settlement), room_type (entire_place/private_room/hotel/shared_room), property_type (Airbnb's canonical listing type from the detail page), amenities (each amenity with the count of listings offering it). Enrichment-derived facets include a coverage object with the number and share of filtered listings carrying that dimension; buckets stay empty below the 20% minimum visibility gate. Coverage above the gate may still be partial. group_by enum: country, market, admin1, locality, room_type, property_type.

get/datasets/airbnb-markets/facets

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/datasets/airbnb-markets/facets
  • Auth: API key in header x-api-key

Query parameters

facet'country' | 'market' | 'currency' | 'superhost' | 'guest_favorite' | 'rating_band' | 'review_band' | 'admin1' | 'locality' | 'room_type' | 'property_type' | 'amenities' required

Facet enum: country, market, currency, superhost, guest_favorite, rating_band, review_band, admin1, locality, room_type, property_type, amenities

group_by'country' | 'market' | 'admin1' | 'locality' | 'room_type' | 'property_type'

Aggregate cell dimension enum: country, market, admin1, locality, room_type, property_type. Defaults to country

countrystring

Exact ISO-3166-1 alpha-2 country filter, e.g. FR

marketstring

Exact metro-market filter, max 128 characters

superhostboolean

Count only Superhost listings

guest_favoriteboolean

Count only Guest Favorite listings (an observed lower bound; the badge under-counts)

min_ratingnumber

Minimum listing rating, from 0 through 5

min_review_countinteger

Minimum listing review count, 0 or greater

active_sincestring

Freshness filter, an ISO-8601 date (YYYY-MM-DD)

min_listingsinteger

Minimum listings per bucket; raises the small-cell suppression floor

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.