{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper", "description": "Collect Airbnb listing data from room URLs or destination searches in minutes. Get structured rental data including nightly pricing, amenities, photos, host details, ratings, house rules, coordinates, and other useful property fields for rental research, travel analysis, and market monitoring.", "version": "1.0", "x-build-id": "KrFz6M8fykxhCdiUh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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": { "startUrl": { "title": "Start URL", "type": "string", "description": "Paste an Airbnb room URL or Airbnb search URL. Use this or the search fields below, not both in the same run." }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 100. Paid users: Optional, max 1,000,000." }, "location": { "title": "Location", "type": "string", "description": "Search Airbnb by destination, city, neighborhood, or address when you are not starting from a direct Airbnb URL." }, "checkIn": { "title": "Check-in Date", "type": "string", "description": "Check-in date in YYYY-MM-DD format. This helps Airbnb return more realistic pricing and availability." }, "checkOut": { "title": "Check-out Date", "type": "string", "description": "Check-out date in YYYY-MM-DD format." }, "adults": { "title": "Adults", "minimum": 1, "type": "integer", "description": "Number of adult guests." }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Number of children." }, "infants": { "title": "Infants", "minimum": 0, "type": "integer", "description": "Number of infants." }, "pets": { "title": "Pets", "minimum": 0, "type": "integer", "description": "Number of pets." }, "currency": { "title": "Currency", "type": "string", "description": "Currency code used in Airbnb pricing, for example USD, EUR, or GBP." }, "minPrice": { "title": "Min Price", "minimum": 0, "type": "integer", "description": "Minimum nightly price in the selected currency." }, "maxPrice": { "title": "Max Price", "minimum": 0, "type": "integer", "description": "Maximum nightly price in the selected currency." }, "roomType": { "title": "Room Type", "enum": [ "", "entire_home", "private_room", "shared_room" ], "type": "string", "description": "Filter Airbnb results by room type." }, "minBedrooms": { "title": "Min Bedrooms", "minimum": 1, "type": "integer", "description": "Minimum number of bedrooms required." }, "minBathrooms": { "title": "Min Bathrooms", "minimum": 1, "type": "integer", "description": "Minimum number of bathrooms required." }, "superhostOnly": { "title": "Superhost Only", "type": "boolean", "description": "Only collect Airbnb listings from Superhosts." }, "extraData": { "title": "Extra Data", "type": "boolean", "description": "Include heavier Airbnb detail sections like grouped amenities, location details, safety sections, and raw parsed sections." }, "addMoreHostInfo": { "title": "Add More Host Info", "type": "boolean", "description": "Return the richer host profile block with highlights, host details, stats, and about text." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional proxy configuration to route Airbnb requests through Apify Proxy." } } }, "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 } } } } } } } } } }