{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper: listings, prices, details and reviews", "description": "Scrape Airbnb by location, search URL or listing URL: price per night and total for your dates, rating, reviews count, beds, photos, coordinates, superhost and guest favourite, with description, amenities, host and house rules, and reviews. Whole cities, past the 280 a search shows. No login.", "version": "0.1", "x-build-id": "hPcHoW1dlk6BOyGjA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pikoulas~airbnb/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pikoulas-airbnb", "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/pikoulas~airbnb/runs": { "post": { "operationId": "runs-sync-pikoulas-airbnb", "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/pikoulas~airbnb/run-sync": { "post": { "operationId": "run-sync-pikoulas-airbnb", "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", "type": "array", "description": "Cities, regions or neighbourhoods, as typed into Airbnb's search (Lisbon, Portugal; Brooklyn, NY). Each is its own search with the dates and filters below, over its whole area on the map.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in", "type": "string", "description": "The prices are for these dates, and only listings free on them are given. Without dates, Airbnb prices each listing for dates of its own choosing and leaves out beds and bedrooms." }, "checkOut": { "title": "Check-out", "type": "string", "description": "The day of leaving." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Guests aged 13 or over. Only listings that take them all are given." }, "children": { "title": "Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Guests aged 2 to 12." }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Guests under 2." }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Only listings that allow this many pets." }, "maxListings": { "title": "Max listings per search", "minimum": 1, "maximum": 100000, "type": "integer", "description": "How many listings to take from each location or search URL. A whole city can hold thousands.", "default": 100 }, "includeDetails": { "title": "Include listing details", "type": "boolean", "description": "Each listing's description, amenities, host, house rules, check-in and check-out times and the rating's sub-scores. One more request per listing, so slower. Listing URLs always come with them.", "default": false }, "maxReviewsPerListing": { "title": "Max reviews per listing", "minimum": 0, "maximum": 100000, "type": "integer", "description": "The newest reviews of each listing, each its own item. 0 for none.", "default": 0 }, "urls": { "title": "Airbnb URLs", "type": "array", "description": "Listing URLs (airbnb.com/rooms/...) or IDs, and search URLs copied from airbnb.com/s/..., with the dates, filters and map area set there.", "items": { "type": "string" } }, "minPrice": { "title": "Min price per night", "minimum": 0, "type": "integer", "description": "In the currency below, as Airbnb's price filter has it: a night, with fees and discounts but before taxes." }, "maxPrice": { "title": "Max price per night", "minimum": 0, "type": "integer", "description": "In the currency below, as Airbnb's price filter has it: a night, with fees and discounts but before taxes." }, "roomType": { "title": "Type of place", "enum": [ "any", "entire", "private", "hotel" ], "type": "string", "description": "Only entire homes, private rooms or hotel rooms.", "default": "any" }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Only listings with at least this many bedrooms." }, "minBeds": { "title": "Min beds", "minimum": 0, "type": "integer", "description": "Only listings with at least this many beds." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Only listings with at least this many bathrooms." }, "currency": { "title": "Currency", "type": "string", "description": "The currency of prices, as a code (USD, EUR, GBP).", "default": "USD" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed for most runs. On the Apify platform, a run Airbnb refuses switches to residential proxy by itself.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }