{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper — Listings, Prices, Reviews & Calendars", "description": "Scrape Airbnb listings by location or search URL: prices for your dates, ratings, rooms, coordinates, hosts, amenities and house rules, plus guest reviews and availability calendars.", "version": "0.1", "x-build-id": "aJ1RjmAkJ9z0GzRfd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-airbnb-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/tortuga~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-airbnb-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/tortuga~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-airbnb-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "What to scrape", "enum": [ "listings", "reviews", "calendar" ], "type": "string", "description": "listings: one item per listing from your searches (price for the dates, rating, rooms, coordinates, badges, photos; turn on 'Include listing details' for description, amenities, house rules and host). reviews: one item per guest review of the listings. calendar: one item per listing with day-by-day availability for up to 12 months.", "default": "listings" }, "locations": { "title": "Locations", "type": "array", "description": "Places to search, as you would type them on Airbnb: a city, region, neighborhood or address, e.g. \"Lisbon, Portugal\" or \"Brooklyn, NY\".", "items": { "type": "string" } }, "startUrls": { "title": "Airbnb URLs", "type": "array", "description": "Any Airbnb search URL (https://www.airbnb.com/s/Lisbon--Portugal/homes?checkin=...&adults=2, with the site's own filters, map area or categories) or listing URL (https://www.airbnb.com/rooms/31820112). Filters set below replace the same filters in a search URL.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingIds": { "title": "Listing ids", "type": "array", "description": "Airbnb listing ids (the number in /rooms/), e.g. 31820112.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "type": "string", "description": "YYYY-MM-DD. With dates, listings carry the price for exactly that stay (per night and total). Without dates Airbnb shows a price for a sample stay of a few nights (see stayDates)." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "YYYY-MM-DD, after the check-in date." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests (prices and search results depend on it). Empty = 1." }, "children": { "title": "Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Children aged 2-12." }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Infants under 2." }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Pets (only pet-friendly listings are returned)." }, "currency": { "title": "Currency", "type": "string", "description": "Currency of all prices (ISO code such as USD, EUR, GBP).", "default": "USD" }, "priceMin": { "title": "Minimum price per night", "minimum": 0, "type": "integer", "description": "Airbnb's price filter, per night in the chosen currency." }, "priceMax": { "title": "Maximum price per night", "minimum": 1, "type": "integer", "description": "Airbnb's price filter, per night in the chosen currency." }, "roomType": { "title": "Type of place", "enum": [ "entire", "private", "shared", "hotel" ], "type": "string", "description": "Only this type of place. Empty = any type." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 1, "type": "integer", "description": "Only listings with at least this many bedrooms." }, "minBeds": { "title": "Minimum beds", "minimum": 1, "type": "integer", "description": "Only listings with at least this many beds." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 1, "type": "integer", "description": "Only listings with at least this many bathrooms." }, "amenities": { "title": "Amenities", "type": "array", "description": "Only listings that have all of these amenities.", "items": { "type": "string", "enum": [ "wifi", "kitchen", "airConditioning", "washer", "freeParking", "pool", "workspace", "heating", "dryer", "tv", "hotTub", "selfCheckIn", "evCharger", "crib", "gym", "bbqGrill", "breakfast", "fireplace", "beachfront", "waterfront" ], "enumTitles": [ "Wifi", "Kitchen", "Air conditioning", "Washer", "Free parking", "Pool", "Dedicated workspace", "Heating", "Dryer", "TV", "Hot tub", "Self check-in", "EV charger", "Crib", "Gym", "BBQ grill", "Breakfast", "Indoor fireplace", "Beachfront", "Waterfront" ] } }, "superhost": { "title": "Superhosts only", "type": "boolean", "description": "Only listings whose host is a Superhost." }, "instantBook": { "title": "Instant Book only", "type": "boolean", "description": "Only listings that can be booked without host approval." }, "guestFavorite": { "title": "Guest favorites only", "type": "boolean", "description": "Only listings with the Guest favorite badge." }, "includeDetails": { "title": "Include listing details", "type": "boolean", "description": "Listings mode: also open each listing (one extra request; two with dates) for description, all amenities, house rules, check-in/out times, safety notes, sub-ratings, host profile, license number, all photos; with dates also availability, Instant Book and the cancellation policy. Charged as 'listing with details'. Listing URLs and ids always include details.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many items in total (listings, reviews or calendars, depending on the mode).", "default": 100 }, "maxListingsPerSearch": { "title": "Max listings per search (reviews and calendar modes)", "minimum": 1, "type": "integer", "description": "Reviews and calendar modes: how many top listings of each location / search URL are processed.", "default": 20 }, "maxReviewsPerListing": { "title": "Max reviews per listing", "minimum": 1, "type": "integer", "description": "Reviews mode: cap per listing.", "default": 100 }, "reviewsSort": { "title": "Sort reviews by", "enum": [ "newest", "relevant", "highest", "lowest" ], "type": "string", "description": "Reviews mode. 'Only reviews newer than' and monitoring always use newest first.", "default": "newest" }, "reviewsNewerThan": { "title": "Only reviews newer than", "type": "string", "description": "Only reviews newer than: a date (YYYY-MM-DD) or a period such as '7 days' or '24 hours'. Reviews are read newest first and paging stops at the first page that is entirely older." }, "calendarMonths": { "title": "Calendar months", "minimum": 1, "maximum": 12, "type": "integer", "description": "Calendar mode: months to read, starting with the current month (1-12).", "default": 12 }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this search returned and output only new items or items whose price/status changed. Use with a Schedule; unchanged items are not charged. Listings: compared on the total price for your dates, the struck-through price and availability (set check-in/out dates). Reviews: only reviews not seen before. Calendars: listings whose availability changed on a day both runs cover.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy (default) works for Airbnb; no residential or Unblocker proxy is needed.", "default": { "useApifyProxy": true } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }