{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper", "description": "Scrape Airbnb listings by location or room URL — nightly price, amenities, host profile, guest reviews, availability calendar, ratings, photos and GPS as clean JSON. Powered by Airbnb's official GraphQL API for reliable, cookieless data. Pay only for the results you get.", "version": "1.0", "x-build-id": "xws9QZsfEdzmhYSMJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-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/axlymxp~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-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/axlymxp~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-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": { "location": { "title": "Location / search query", "type": "string", "description": "A place name Airbnb resolves, e.g. 'Austin, Texas' or 'Rome, Italy'. Leave empty if you provide listing URLs instead." }, "listingUrls": { "title": "Listing URLs", "type": "array", "description": "Optional. One or more direct Airbnb room links (https://www.airbnb.com/rooms/) to scrape specific listings instead of searching.", "items": { "type": "string" } }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Stop after collecting this many listings.", "default": 100 }, "scrapeMode": { "title": "Scrape mode", "enum": [ "full", "fast" ], "type": "string", "description": "'full' fetches each listing's detail page (amenities, description, host, coordinates). 'fast' returns only search-result fields (price, rating, image) — cheaper and quicker.", "default": "full" }, "checkIn": { "title": "Check-in date", "type": "string", "description": "Optional ISO date (YYYY-MM-DD) for price and availability context." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "Optional ISO date (YYYY-MM-DD)." }, "adults": { "title": "Adults", "minimum": 1, "type": "integer", "description": "Number of adults for pricing.", "default": 1 }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Number of children (ages 2-12) for pricing.", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "type": "integer", "description": "Number of infants (under 2) for pricing.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "type": "integer", "description": "Number of pets for pricing.", "default": 0 }, "minPrice": { "title": "Minimum price", "type": "integer", "description": "Optional minimum nightly price filter (in the chosen currency)." }, "maxPrice": { "title": "Maximum price", "type": "integer", "description": "Optional maximum nightly price filter." }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Attach guest reviews to each listing.", "default": false }, "maxReviews": { "title": "Max reviews per listing", "minimum": 0, "type": "integer", "description": "Cap the reviews attached per listing when 'Include reviews' is on.", "default": 10 }, "includeAvailability": { "title": "Include availability calendar", "type": "boolean", "description": "Attach a month-by-month availability calendar to each listing.", "default": false }, "availabilityMonths": { "title": "Availability months", "minimum": 1, "type": "integer", "description": "How many months of availability to fetch when enabled.", "default": 3 }, "currency": { "title": "Currency", "type": "string", "description": "ISO currency code for prices, e.g. USD, EUR, GBP.", "default": "USD" }, "locale": { "title": "Locale", "type": "string", "description": "Language code for localized text, e.g. en, es, fr.", "default": "en" } } }, "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 } } } } } } } } } }