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).
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
Aggregate cell dimension enum: country, market, admin1, locality, room_type, property_type. Defaults to country
Exact ISO-3166-1 alpha-2 country filter, e.g. FR
Exact metro-market filter, e.g. Paris, max 128 characters
Count only Superhost listings
Count only Guest Favorite listings (an observed lower bound; the badge under-counts)
Minimum listing rating, from 0 through 5
Minimum listing review count, 0 or greater
Freshness filter, an ISO-8601 date (YYYY-MM-DD); only listings last seen on or after it are counted
Minimum listings per cell; raises the small-cell suppression floor (never lowered below the built-in minimum)
Sort enum: listings_desc, superhost_pct_desc, rating_desc, key_asc
Page number, defaults to 1
Page size, defaults to 20 and maxes at 100; page * page_size must be <= 10000
Headers
API key required
Response
OK
Example response
{
"code": 200,
"msg": "OK"
}Changes
No recorded changes to this operation across all 2 revisions of this API.