{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper - Listings, Prices, Ratings & Hosts", "description": "Scrape Airbnb search results by location or search URL: listing name, type, total and nightly price, discounts, rating, review count, beds, badges, coordinates and photos. Optional full details: description, amenities, rating breakdown, host, Superhost, house rules. $1.50 per 1,000 listings.", "version": "1.0", "x-build-id": "VQYFIjmf6IOjcXpBr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/atesen-software~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-atesen-software-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/atesen-software~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-atesen-software-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/atesen-software~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-atesen-software-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": { "locations": { "title": "Locations", "type": "array", "description": "City, area or address as you would type it on Airbnb, e.g. \"Istanbul\", \"Lisbon, Portugal\", \"Brooklyn, NY\".", "items": { "type": "string" } }, "startUrls": { "title": "Airbnb URLs (optional)", "type": "array", "description": "Airbnb search URLs (https://www.airbnb.com/s/...) with any filters set on the website, or listing URLs (/rooms/123...). Listing IDs also work.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "type": "string", "description": "Optional. With dates you get the exact total price for the stay. Without dates Airbnb picks flexible dates." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "Optional, use together with check-in." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests.", "default": 1 }, "minPrice": { "title": "Minimum price per night", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional, in the chosen currency.", "default": 0 }, "maxPrice": { "title": "Maximum price per night", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional, in the chosen currency. 0 = no limit.", "default": 0 }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Optional. 0 = any.", "default": 0 }, "roomType": { "title": "Type of place", "enum": [ "any", "entire", "private" ], "type": "string", "description": "", "default": "any" }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter currency code for prices, e.g. \"USD\", \"EUR\", \"TRY\", \"GBP\". Default USD." }, "maxListingsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Airbnb shows up to about 270 listings per search (15 pages). Split by price or area for more.", "default": 50 }, "includeDetails": { "title": "Include full details", "type": "boolean", "description": "Open every listing: full description, all amenities, 6 rating categories, host name and Superhost, response rate, house rules, all photos. No extra charge (see Pricing).", "default": false }, "maxConcurrency": { "title": "Searches in parallel", "minimum": 1, "maximum": 6, "type": "integer", "description": "", "default": 3 } } }, "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 } } } } } } } } } }