{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2d0965f3-fc41-48d5-8a30-0708e4adfb36","name":"Airbtics Public API","description":"Airbtics is a leading short-term rental data company founded in 2020. We provide clean, accurate, and developer-friendly short-term rental data through our API suite.\n\n## Useful Links\n\n**API dashboard:** [https://app.airbtics.com/api-dashboard](https://app.airbtics.com/api-dashboard) (Get started)\n\n**Pricing:** [https://airbtics.com/api-pricing](https://airbtics.com/api-pricing/)\n\n**OpenAPI spec**: [https://gist.github.com/jaeseokan94/b36181a1bbf692f91e4f53b41ed02b16](https://gist.github.com/jaeseokan94/b36181a1bbf692f91e4f53b41ed02b16)\n\n**Support:** [jae@airbtics.com](https://jae@airbtics.com)\n\n**Tutorial**: [https://www.youtube.com/watch?v=wDk61iKxTuw](https://www.youtube.com/watch?v=wDk61iKxTuw)\n\n**Terms & Conditions**: [https://airbtics.com/api-terms/](https://airbtics.com/api-terms/?pvs=74)\n\n**Base URL:**  \n`https://crap0y5bx5.execute-api.us-east-2.amazonaws.com/prod`\n\n**Authorization:**  \nAll requests require an API key. Get your key from the [API Dashboard](https://app.airbtics.com/api-dashboard).\n\n``` bash\nx-api-key: <YOUR_API_KEY>\n\n ```\n\n# **Quickstart**\n\n``` bash\ncurl --location 'https://crap0y5bx5.execute-api.us-east-2.amazonaws.com/prod/markets/search?query=lon&country_code=GB' \\\n--header &#x27;x-api-key: <YOUR_API_KEY>&#x27;\n\n ```\n\n# How the numbers work\n\nThese definitions apply to every market, listing, and report endpoint.\n\n**Currency.** ADR, revenue, cleaning fees, extra-guest fees, and the `adr` / `revenue` filters are USD. The currency is fixed. It does not follow the listing's country, the account, or a request parameter, and the JSON does not include a currency field.\n\n**What the money includes.** ADR is the average of stay total ÷ nights, multiplied by 0.87. The pre-0.87 rate already includes a share of the cleaning fee and extra-guest fees. The 0.87 removes the host service fee. Listing revenue is that ADR × (occupancy ÷ 100) × active days, plus the cleaning fee × the number of bookings. Occupancy taxes and a property manager's commission are not removed. These are estimates from bookings already taken, not the nightly price currently advertised. [Data accuracy](https://airbtics.notion.site/Airbtics-Data-Accuracy-1f2c154c9308802fa759f22d2556068d).\n\n**Occupancy.** The published figure is booked nights divided by active nights, multiplied by 1.2, and capped at 100. Active nights are nights the listing was available to book over the last 12 months. Owner-blocked nights are neither active nor booked. A night booked on another channel counts as booked when that block appears on the Airbnb calendar. Revenue uses this occupancy.\n\n**Coverage.** Airbnb listings only. A property that is not on Airbnb is not in this data.\n\n**Advertised prices and future dates.** Historical ADR, occupancy, and revenue are estimates. The host's asking price and which future nights are open are on `GET /listings/metrics/future/pacing`. Each day is `available` or not. Occupancy there is the share of nights in the horizon that are not open, including host-blocked nights, and it is not multiplied by 1.2. `daily` is keyed by date, so the next 30 days and days 31–60 are slices of that series. `prices` are advertised asking prices in USD. `live=true` refreshes the calendar first. `price_samples` is 0–6 and defaults to 0, which returns availability only. Market summary and market metrics stay aggregate estimates. Search each neighbourhood as its own market when you need them separately.\n\n**Volume.** Pay-as-you-go has no published per-minute cap. For a high sustained volume, email jae@airbtics.com with the expected monthly requests and peak concurrency.\n\n\n**Median.** On market summary and market metrics, the headline occupancy, ADR, and revenue are the median (p50) of the listings. `p25`, `p75`, and `p90` are the other percentiles, not a mean.\n\n**Monthly history.** There is no custom date range. On market metrics, `number_of_months` is 1–36 and defaults to 12. The window is the last N stored calendar months, ending at the latest processed month, not today minus 365 days. `GET /listings/metrics/all` does not take `number_of_months`: `granularity=yearly` is the last-twelve-month summary, and `granularity=monthly` is the last 12 calendar months. A month whose occupancy is `inactive` was owner-blocked.\n\n**Suburb, without a street address.** Search the market, then call `POST /markets/summary` or `POST /markets/metrics/all` with `filters.bedrooms`. Example for 2-bedroom homes: `{\"market_id\": 122476, \"filters\": {\"bedrooms\": [\"2\"]}}`. A `bedrooms` filter matches entire homes only. A street address is only needed for `POST /report/all`, which estimates one property. That report does not take an amenity filter and does not apply local night-cap rules.\n\n**Credits.** Each account has one API key. Calls stop with `insufficient_credits` when the balance is empty. A call is charged when the key is accepted, including when the handler later returns an error, and including `GET /listings/metrics/future/pacing` when the body is HTTP 200 with `status: \"failed\"` because the listing is missing from the latest calendar. `live`, `price_samples`, and `horizon_days` do not change that price.\n\n**Use of the data.** You can store results for your own analysis. Showing estimates on a public page is fine when Airbtics is named as the source. Reselling the raw responses, or building them into a product you charge for, needs a separate agreement. [Terms](https://airbtics.com/api-terms/).\n\n\n\n**Listing search response.** On `POST /listings/search/{market|bounds|radius}`, `message.listings` is a JSON string of `{\"message\": [...]}`, not an array. Parse it, then read `message`. Each page has 50 listings. `page` starts at 1 and the page size cannot be changed. `include_total_count` defaults to true. Set it to false and `total_count` is null. `listing_id` is a string. On a search result, `review_scores_rating` is 0–5. On `GET /listings/metrics/all` the same field is 0–100. The rating filter is 0–5 on both.\n\n**Market summary fields.** `regulations` is `strict` when at least 50% of the supply has a license, otherwise `lenient`. `market_grade` is a letter from A to E, with an optional + or −. A is exceptional, B strong, C average, D challenging, E poor. `GET /markets/lookup` returns only verified tiers T1, T2, and T3. `GET /markets/search` can return other markets and is capped at 50. `GET /markets/country` accepts `verified_only=true` to keep only T1–T3.\n\n\n# Filter\n\n**Supported endpoints**\n\nListing filters are supported on `POST /markets/summary`, `POST /markets/metrics/{metric}`, and `POST /listings/search/{market|bounds|radius}`. Send `filters` as a JSON object in the body. `{metric}` is `all`, `occupancy`, `average-daily-rate`, `revenue`, or `active-listings`.\n\n**How filters combine**\n\nWithin the same filter, values are treated as OR. Across different filters, they are treated as AND.\n\n**Important pricing note**\n\nFor market summary and market metrics, any non-empty `filters` object doubles the price. Listings search pricing does not change when filters are used.\n\n**Notes**\n\n- Do not send a top-level `bedrooms` field on POST. Put bedroom counts in `filters.bedrooms`.\n- `filters.bedrooms` accepts `\"0\"` (studio), `\"1\"` through `\"5\"`, and `\"6+\"`. The filter forces `room_type = entire_home`. Combining it with `private_room`, `shared_room`, or `hotel_room` returns no listings. `filters.property_type` is only those four room types. A cabin or treehouse is not a filter value.\n- `reviews` on market endpoints must be one of `1+`, `3+`, `10+`, `30+`. Anything else returns 400. Listings search accepts any `\"N+\"`, such as `\"5+\"`.\n- `price_tier` and `rev_bucket` are accepted and then ignored. Use `adr` and `revenue`.\n- Unknown filter keys return 400 on market endpoints. Listings search ignores unknown keys.\n- `host_id` is listings search only. Sending it to a market endpoint returns 400. Each id expands to every host in the same company, so one member host returns that company's listings inside the search area. A host with no company matches only itself. An id that does not resolve returns an empty list.\n- `amenity` values are booleans. `false` excludes listings with that amenity. Omitting the key ignores it. Only `pets` uses a dedicated column. Every other name is a text match: `pool` matches any amenity containing \"pool\", including a pool table, and `ac` searches \"air conditioning\". Unknown names, including `beachfront` and `amazing_views`, are ignored.\n- `adr`, `revenue`, and `occupancy` are last-twelve-month ranges. Money is USD and occupancy is a percent. A min of 0 or below means no lower bound. If min is greater than max, that one filter is dropped and the call still succeeds. On market endpoints the doubled price still applies, because the surcharge follows a non-empty `filters` object.\n- `prof_mgmt` is a string. `\"true\"` means the host has at least 5 listings. `\"false\"` means fewer than 5, or unknown. `\"both\"` applies no filter.\n- `guest_favorite` and `top_guest_favorite` apply only when true. `false` does not exclude those listings. If both are true, a listing matches either badge.\n\n\n```json\n{\n  \"filters\": {\n    \"property_type\": [\"entire_home\", \"private_room\", \"shared_room\", \"hotel_room\"],\n    \"bedrooms\": [\"0\", \"1\", \"2\", \"3\", \"4\", \"5\", \"6+\"],\n    \"bathrooms\": [\"0\", \"1\", \"2\", \"3\", \"4\", \"5\", \"6+\"],\n    \"sleeps\": { \"min\": 2, \"max\": 8 },\n    \"minstay\": { \"min\": 1, \"max\": 30 },\n    \"rating\": { \"min\": 4, \"max\": 5 },\n    \"reviews\": \"10+\",\n    \"adr\": { \"min\": 100, \"max\": 300 },\n    \"revenue\": { \"min\": 20000, \"max\": 100000 },\n    \"occupancy\": { \"min\": 50, \"max\": 90 },\n    \"prof_mgmt\": \"true\",\n    \"guest_favorite\": true,\n    \"top_guest_favorite\": true,\n    \"amenity\": {\n      \"pool\": true,\n      \"hot_tub\": false,\n      \"parking\": false,\n      \"ac\": false,\n      \"pets\": false,\n      \"gym\": false,\n      \"washer\": false,\n      \"dryer\": false,\n      \"kitchen\": false,\n      \"wifi\": true,\n      \"heating\": false,\n      \"tv\": false,\n      \"bbq_grill\": false,\n      \"fireplace\": false,\n      \"breakfast\": false\n    },\n    \"host_id\": [123456]\n  }\n}\n```\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"25155751","team":18266136,"collectionId":"2d0965f3-fc41-48d5-8a30-0708e4adfb36","publishedId":"2sB3QRoSvW","public":true,"publicUrl":"https://documenter-api.postman.tech/view/25155751/2sB3QRoSvW","privateUrl":"https://go.postman.co/documentation/25155751-2d0965f3-fc41-48d5-8a30-0708e4adfb36","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.12","publishDate":"2026-04-23T04:57:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://postman-image-service.postman.com/api/cloudinary-proxy/postman/image/upload/t_team_logo_pubdoc/v1/team/5b5590ec3245f11e1139370de7b5389b5fdce5fe5a26074bac622265dbc9e078","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sB3QRoSvW"}