{ "openapi": "3.0.1", "info": { "title": "Airbnb Listings Scraper", "description": "Scrape Airbnb listings by city, search, or URL - prices, ratings, reviews, hosts, amenities, coordinates and photos. Just type a place, no dates or API key needed. Export JSON/CSV.", "version": "1.0", "x-build-id": "80vSIyQg8ouCa7Zzg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automly~airbnb-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automly-airbnb-listings-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/automly~airbnb-listings-scraper/runs": { "post": { "operationId": "runs-sync-automly-airbnb-listings-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/automly~airbnb-listings-scraper/run-sync": { "post": { "operationId": "run-sync-automly-airbnb-listings-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": { "search": { "title": "Search Airbnb", "type": "array", "description": "What to scrape. Type a place — 'Paris, France', 'New York', 'Lisbon' — and that's it. You can also paste an Airbnb search URL or a listing URL (https://www.airbnb.com/rooms/...). Add as many as you want. No dates required.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "type": "string", "description": "Optional. YYYY-MM-DD. Leave empty to scrape without dates (you still get listings, just no date-specific total price)." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "Optional. YYYY-MM-DD." }, "adults": { "title": "Adults", "minimum": 0, "type": "integer", "description": "Number of adult guests.", "default": 1 }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Number of child guests.", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "type": "integer", "description": "Number of infant guests.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "type": "integer", "description": "Number of pets.", "default": 0 }, "maxListings": { "title": "Maximum listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum listing records to save (across all searches). The scraper pages through Airbnb's results (~570 per city); add more places to go higher.", "default": 50 }, "currency": { "title": "Currency", "type": "string", "description": "Currency code for prices (e.g. USD, EUR, GBP).", "default": "USD" }, "includeListingDetails": { "title": "Include listing details", "type": "boolean", "description": "Visit each listing page for richer fields (bedrooms, beds, host, reviews).", "default": true }, "includeImages": { "title": "Include images", "type": "boolean", "description": "Include listing image URLs.", "default": true }, "includeAmenities": { "title": "Include amenities", "type": "boolean", "description": "Include amenities when available on listing pages.", "default": true }, "includeHostInfo": { "title": "Include host info", "type": "boolean", "description": "Include host name, ID, and superhost status when available.", "default": true }, "includeReviewsSummary": { "title": "Include review summary", "type": "boolean", "description": "Include rating and review-count fields when available.", "default": true }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Optional. Explicit Airbnb search-result URLs (advanced). Most users can ignore this and use the Search field above.", "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs", "type": "array", "description": "Optional. Direct Airbnb listing URLs (https://www.airbnb.com/rooms/...).", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Optional. Place queries (same as typing them in the Search field).", "items": { "type": "string" } }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Route requests through Apify Proxy. Recommended for cloud runs (Airbnb blocks datacenter IPs — use a residential group).", "default": true }, "proxyGroups": { "title": "Proxy groups", "type": "array", "description": "Optional Apify Proxy groups, e.g. RESIDENTIAL. Leave empty for the default pool.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }