{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper — Sub-Ratings, Review Topics & Sleeping Plans", "description": "Airbnb listings with the fields nobody else extracts: Airbnb's own review-topic counts, the 5-to-1 star distribution, all six sub-ratings, per-room sleeping plans, co-hosts, host response rate and time, and a 12-month availability calendar. No browser. JSON, CSV, Excel.", "version": "0.1", "x-build-id": "xklckhKNvbtn8jKS2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/signalbench~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-signalbench-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/signalbench~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-signalbench-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/signalbench~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-signalbench-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": { "mode": { "title": "What to scrape", "enum": [ "search", "urls" ], "type": "string", "description": "\"Search a location\" walks Airbnb search results for a place. \"Specific listings\" scrapes only the listing URLs or IDs you supply.", "default": "search" }, "location": { "title": "Location", "type": "string", "description": "Where to search — a city, region or country, e.g. \"Austin, TX\", \"Barcelona\", \"Lake Tahoe\". Ignored when you supply a search URL or use \"Specific listings\".", "default": "Austin, TX" }, "searchUrl": { "title": "Search URL (advanced)", "type": "string", "description": "Paste a full Airbnb search URL to reuse filters you set on the site (price, rooms, amenities, property type). When set, it overrides the Location field." }, "checkIn": { "title": "Check-in date", "type": "string", "description": "Optional YYYY-MM-DD. Adding dates makes search results carry real prices for that stay instead of no price at all." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "Optional YYYY-MM-DD." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Guest count used for the search. Affects which listings match and what they cost." }, "startUrls": { "title": "Listing URLs or IDs", "type": "array", "description": "Airbnb listing URLs (https://www.airbnb.com/rooms/12345) or bare numeric IDs. Used when mode is \"Specific listings\".", "items": { "type": "string" } }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on how many listings this run scrapes and bills for.", "default": 20 }, "includeReviews": { "title": "Reviews per listing", "minimum": 0, "maximum": 500, "type": "integer", "description": "How many individual reviews to fetch per listing, with their host replies. Set to 0 to skip them — the review-topic counts, star distribution and six sub-ratings are collected either way, because they come from the main request at no extra cost.", "default": 10 }, "includeCalendar": { "title": "Availability calendar", "type": "boolean", "description": "Fetch each listing's night-by-night availability and minimum-stay rules, plus a summary. Note that a blocked night can mean either a booking or a host-blocked date — Airbnb does not say which — so treat it as an occupancy proxy, never as a booking rate.", "default": true }, "calendarMonths": { "title": "Calendar months", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many months of availability to pull, starting this month.", "default": 6 }, "excludePersonalData": { "title": "Exclude personal data (GDPR/CCPA)", "type": "boolean", "description": "Drop host names, profile IDs, profile text and reviewer names from the output, keeping only aggregate host metrics. Useful when your legal basis for processing does not cover personal data.", "default": false }, "currency": { "title": "Currency", "type": "string", "description": "ISO currency code used for any prices, e.g. USD, EUR, GBP.", "default": "USD" }, "locale": { "title": "Locale", "type": "string", "description": "Language for titles, descriptions and labels, e.g. en, es, fr, de.", "default": "en" }, "politenessDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Randomised pause between requests. Lower is faster; raise it if you see blocks on large runs.", "default": 1200 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a blocked or failed request, rotating the proxy session each time.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Airbnb serves this data without a bot-detection stack, so a direct connection normally works and is fastest. Turn a proxy on for very large runs or if you start seeing 429s." } } }, "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 } } } } } } } } } }