Datasets

Search the Airbnb markets dataset

Returns aggregate Airbnb short-term-rental market rollups from the dataset id enum value airbnb-markets. Aggregate-only: each row is a market cell, never an individual listing. Thin cells are suppressed. group_by enum: country, market, 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). Enrichment-derived groupings include a coverage object with the number and share of filtered listings carrying that dimension; the 20% minimum gate is not a completeness guarantee, and counts still describe classified rows only. Each cell also carries median_price_usd, the median nightly price converted to USD via an approximate dated FX snapshot, for cross-country comparison (combine with group_by=room_type for median price by room type); guest_favorite_pct, the share of listings carrying the Guest Favorite badge (an observed lower bound, like superhost_pct); and avg_person_capacity, the average guests a listing sleeps over the detail-page-enriched sample. Sort enum: listings_desc, superhost_pct_desc, rating_desc, key_asc. Billing: this search costs 1 credit per record returned, with a minimum of 2 (an empty result costs 2, a full page of 100 costs 100).

get/datasets/airbnb-markets/search

Request

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

Query parameters

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, e.g. Paris, 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); only listings last seen on or after it are counted

min_listingsinteger

Minimum listings per cell; raises the small-cell suppression floor (never lowered below the built-in minimum)

sort'listings_desc' | 'superhost_pct_desc' | 'rating_desc' | 'key_asc'

Sort enum: listings_desc, superhost_pct_desc, rating_desc, key_asc

pageinteger

Page number, defaults to 1

page_sizeinteger

Page size, defaults to 20 and maxes at 100; page * page_size must be <= 10000

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.