{ "openapi": "3.0.1", "info": { "title": "Airbnb Listings Scraper", "description": "Airbnb search results with the real total price for your dates, guests and currency (full price breakdown), rating, reviews, coordinates and photos. Goes past the ~270-result limit by splitting the map. Optional details: capacity, rooms, amenities.", "version": "0.1", "x-build-id": "NFd0VeeDzRyqvZDTR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/atalaia~airbnb-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-atalaia-airbnb-listings", "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/atalaia~airbnb-listings/runs": { "post": { "operationId": "runs-sync-atalaia-airbnb-listings", "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/atalaia~airbnb-listings/run-sync": { "post": { "operationId": "run-sync-atalaia-airbnb-listings", "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", "required": [ "locations" ], "properties": { "locations": { "title": "Locations", "type": "array", "description": "Cities, regions or neighbourhoods as you would type them in Airbnb's search box. Add the country when a name is ambiguous (\"Porto, Portugal\"). Accents are fine.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "YYYY-MM-DD. Empty = 14 days from today. Prices are the real prices for these dates." }, "checkOut": { "title": "Check-out date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "YYYY-MM-DD. Empty = 2 nights after check-in." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests (13+).", "default": 2 }, "children": { "title": "Children (2-12)", "minimum": 0, "maximum": 15, "type": "integer", "description": "Number of children aged 2-12.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "With pets, only pet-friendly listings are returned.", "default": 0 }, "currency": { "title": "Currency", "type": "string", "description": "3-letter currency code for all prices (USD, EUR, BRL, GBP, JPY, MXN...).", "default": "USD" }, "locale": { "title": "Language", "type": "string", "description": "Language of names, descriptions, amenities and price labels (en, pt, pt-PT, es, fr, de, it, ja, ko...). Listing names are shown as the host wrote them or as Airbnb translates them.", "default": "en" }, "minPrice": { "title": "Minimum price per night", "minimum": 0, "type": "integer", "description": "Optional. In the chosen currency, per night (Airbnb's price filter)." }, "maxPrice": { "title": "Maximum price per night", "minimum": 0, "type": "integer", "description": "Optional. In the chosen currency, per night (Airbnb's price filter)." }, "roomType": { "title": "Type of place", "enum": [ "any", "entire_home", "private_room" ], "type": "string", "description": "Entire home or private room only; \"Any type\" also returns shared and hotel rooms.", "default": "any" }, "maxResultsPerLocation": { "title": "Max listings per location", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Airbnb shows at most ~270 listings per search. Above that, the Actor splits the map into smaller areas and searches each one (duplicates removed), so large cities can return up to 2,000.", "default": 100 }, "includeDetails": { "title": "Include listing details", "type": "boolean", "description": "Also open each listing page for guest capacity, bedrooms, beds, bathrooms, full amenity list, description and house rules. Slower, and charged as an extra event per listing.", "default": false }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many pages are fetched in parallel.", "default": 8 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is used by default (datacenter, with an automatic US residential fallback for requests that keep failing). Whether totals include taxes depends on Airbnb's rules for the locale and the visitor's country; a residential proxy in the destination's country shows prices as locals see them.", "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 } } } } } } } } } }