{ "openapi": "3.0.1", "info": { "title": "Airbnb Price Scraper (Area-Based)", "description": "Scrapes Airbnb listings from a specified area URL, collects listing details, and posts the data asynchronously. Supports configurable check-in dates, stay duration, guest numbers, and number of listings.", "version": "0.0", "x-build-id": "jkpA8QaPXhyOJF5NV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moving_beacon-owner1~airbnb-listings-collector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moving_beacon-owner1-airbnb-listings-collector", "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/moving_beacon-owner1~airbnb-listings-collector/runs": { "post": { "operationId": "runs-sync-moving_beacon-owner1-airbnb-listings-collector", "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/moving_beacon-owner1~airbnb-listings-collector/run-sync": { "post": { "operationId": "run-sync-moving_beacon-owner1-airbnb-listings-collector", "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": { "searchUrl": { "title": "Search Page URL", "pattern": "^\\s*$|^https?://(www\\.)?airbnb\\.[a-z.]+/.+", "type": "string", "description": "Airbnb search results URL — Playwright opens this page and harvests listing links automatically. Apply your filters (price, rooms, dates) on Airbnb first, then copy the URL from the address bar. Leave empty if you're using Direct Listing URLs only.", "default": "" }, "numberOfLinks": { "title": "Number of Links to Collect", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many listing links Playwright should harvest from the Search URL (paginating as needed). Used only when Search URL is provided. Total API calls = (harvested + direct) listings × Number of Days.", "default": 20 }, "startUrls": { "title": "Direct Listing URLs", "uniqueItems": true, "type": "array", "description": "Specific Airbnb listing URLs to price (e.g. https://www.airbnb.com/rooms/12345). Used standalone when Search URL is empty, or merged with Playwright-harvested links when both are provided.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "checkInDate": { "title": "Check-In Date", "pattern": "^\\s*$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "First check-in date in the scrape window, in YYYY-MM-DD format. The scraper prices every listing for this date plus the next (Number of Days − 1) consecutive dates. Leave empty to use today's date.", "default": "" }, "numberOfDays": { "title": "Number of Days", "minimum": 1, "maximum": 365, "type": "integer", "description": "How many consecutive check-in dates to generate from Check-In Date. Each date is one priced API call per listing.", "default": 60 }, "Stay_Days": { "title": "Stay Nights", "minimum": 1, "maximum": 365, "type": "integer", "description": "Length of each stay in nights (check-out = check-in + this value). IMPORTANT: this changes the price Airbnb returns. Use 1 for full nightly rate, 7+ for weekly discount, 28+ for monthly discount. The previous scraper defaulted to 60, which returned monthly-discounted rates — keep this at 60 to match those numbers, or set to 1 for true nightly pricing.", "default": 60 }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Adult guests in the booking. Affects which listings return prices and may change totals when extra-guest fees apply.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "maximum": 16, "type": "integer", "description": "Child guests (ages 2–12) in the booking.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Pets in the booking. Filters out pet-unfriendly listings and may add cleaning/pet fees to totals.", "default": 0 }, "currency": { "title": "Currency", "pattern": "^[A-Z]{3}$", "type": "string", "description": "ISO 4217 currency code that prices are returned in. Examples: 'USD', 'GBP', 'EUR', 'PKR', 'AUD', 'JPY'. Airbnb converts at its current FX rate.", "default": "USD" } } }, "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 } } } } } } } } } }