{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper - Stay Listings, Prices & Ratings", "description": "Scrape Airbnb search results in bulk: stay names, nightly and total prices, ratings, review counts, Superhost and Guest favorite badges, coordinates and photos as clean JSON. Many locations or Airbnb search URLs per run, deep pagination, any currency. No login or API key needed.", "version": "0.1", "x-build-id": "9NHtkRqdaeWJj9wnu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeworks~airbnb-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeworks-airbnb-search-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/scrapeworks~airbnb-search-scraper/runs": { "post": { "operationId": "runs-sync-scrapeworks-airbnb-search-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/scrapeworks~airbnb-search-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeworks-airbnb-search-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": { "locations": { "title": "Locations", "uniqueItems": true, "type": "array", "description": "One or more places to search stays in, exactly as you would type them on airbnb.com (e.g. 'Lisbon, Portugal', 'Brooklyn, NY', 'Bali'). Each location is searched separately and paginated deep (up to ~270 listings, Airbnb's own limit per search). Add as many locations as you like in a single run.", "items": { "type": "string" } }, "searchUrls": { "title": "Airbnb search URLs (optional, power users)", "uniqueItems": true, "type": "array", "description": "Optional: paste full airbnb.com search URLs (an /s/... link with your own filters — amenities, map area, flexible dates — already applied). Each URL is scraped and paginated just like a location. Use this for filters this form doesn't expose; otherwise just use 'Locations'.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional check-in date in YYYY-MM-DD format (e.g. 2026-08-14). Set both dates to get exact availability and total stay prices; leave empty to let Airbnb use its default flexible dates." }, "checkOut": { "title": "Check-out date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional check-out date in YYYY-MM-DD format (e.g. 2026-08-21). Used together with the check-in date." }, "adults": { "title": "Adults", "minimum": 0, "maximum": 16, "type": "integer", "description": "Number of adult guests (affects pricing and which listings qualify). 0 = let Airbnb use its default.", "default": 0 }, "children": { "title": "Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Number of child guests.", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of infant guests (under 2).", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of pets — filters to pet-friendly stays.", "default": 0 }, "priceMin": { "title": "Min price per night", "minimum": 0, "type": "integer", "description": "Only return stays at or above this nightly price (in the selected currency). 0 = no minimum.", "default": 0 }, "priceMax": { "title": "Max price per night", "minimum": 0, "type": "integer", "description": "Only return stays at or below this nightly price (in the selected currency). 0 = no maximum.", "default": 0 }, "roomType": { "title": "Room type", "enum": [ "any", "entire_home", "private_room", "shared_room", "hotel_room" ], "type": "string", "description": "Restrict results to one stay type. 'Any' returns everything.", "default": "any" }, "currency": { "title": "Currency", "type": "string", "description": "3-letter ISO currency code for all returned prices (e.g. USD, EUR, GBP, AUD). The actor pins this on every request so prices are consistent no matter where the proxy exit node is.", "default": "USD" }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 300, "type": "integer", "description": "Maximum listings to return for EACH location/URL. The actor paginates automatically (18 listings per page). Airbnb itself caps one search at about 270 results — to collect more rows in a run, add more locations or narrower filtered search URLs.", "default": 270 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used to reach Airbnb. Airbnb often blocks datacenter traffic, so RESIDENTIAL Apify Proxy is recommended for reliable results.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } }, "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 } } } } } } } } } }