{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper", "description": "Extract Airbnb listings, prices, ratings, host data, amenities & GPS coordinates for any location. Search by city or scrape direct listing URLs. Returns CRM-ready structured JSON. Export scraped data, run via API, schedule and monitor runs, or integrate with other tools.", "version": "1.0", "x-build-id": "tJOpguYwbRj9S73zX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-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/khadinakbar~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-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/khadinakbar~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-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": { "locationQuery": { "title": "Location / Search Query", "type": "string", "description": "Use this when the user provides a city, neighborhood, region, or destination name (e.g. 'New York', 'Paris', 'Miami Beach, FL'). The actor will search Airbnb for listings at this location. Do NOT use this when you have specific listing URLs — use startUrls instead." }, "startUrls": { "title": "Direct Listing URLs", "type": "array", "description": "Use this when the user provides specific Airbnb listing URLs (e.g. 'https://www.airbnb.com/rooms/12345678'). Do NOT use this when the user describes a location or destination — use locationQuery for that.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "checkIn": { "title": "Check-in Date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Check-in date in YYYY-MM-DD format (e.g. '2026-06-15'). Used in search mode to filter available listings and get accurate pricing. Leave empty to see all listings regardless of dates." }, "checkOut": { "title": "Check-out Date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Check-out date in YYYY-MM-DD format (e.g. '2026-06-20'). Must be after checkIn if provided." }, "adults": { "title": "Number of Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests. Filters listings by guest capacity.", "default": 2 }, "children": { "title": "Number of Children", "minimum": 0, "maximum": 10, "type": "integer", "description": "Number of child guests (ages 2–12).", "default": 0 }, "pets": { "title": "Number of Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of pets. Filters results to pet-friendly listings only.", "default": 0 }, "minPrice": { "title": "Minimum Price per Night (USD)", "minimum": 0, "type": "integer", "description": "Minimum nightly price in USD. Filters out listings below this price." }, "maxPrice": { "title": "Maximum Price per Night (USD)", "minimum": 0, "type": "integer", "description": "Maximum nightly price in USD. Filters out listings above this price." }, "minBedrooms": { "title": "Minimum Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms required." }, "propertyType": { "title": "Property Type", "enum": [ "", "entire_home", "private_room", "hotel_room" ], "type": "string", "description": "Filter by property type. 'entire_home' = private home/apartment. 'private_room' = shared accommodations. 'hotel_room' = hotels/boutique hotels. Leave empty for all types.", "default": "" }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of listings to scrape. Recommended: 50–300. Airbnb typically returns up to 300 results per search.", "default": 50 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for scraping. Residential proxies recommended for Airbnb. Leave default to use Apify's proxy pool." } } }, "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 } } } } } } } } } }