{ "openapi": "3.0.1", "info": { "title": "Airbnb Listing Details Scraper", "description": "Paste any Airbnb /rooms/ URL and get every PDP field: photos, amenities, host info, ratings, house rules, location, pricing, and more. Fast Cheerio scraper, no browser, undercuts the market.", "version": "0.2", "x-build-id": "iCH4alBnbATWYDH0y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~airbnb-details-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-airbnb-details-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/cirkit~airbnb-details-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-airbnb-details-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/cirkit~airbnb-details-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-airbnb-details-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": { "startUrls": { "title": "Listing URLs", "type": "array", "description": "One or more Airbnb listing URLs (e.g. https://www.airbnb.com/rooms/12937). Mix freely with listingIds below. Each URL is processed independently.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingIds": { "title": "Listing IDs", "type": "array", "description": "Convenience input — pass just the numeric listing IDs and we'll build the URLs for you. Mix with startUrls above.", "default": [], "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "type": "string", "description": "YYYY-MM-DD. Supply check-in AND check-out to get real pricing for those dates: priceAmount, pricePerNightAmount, the full price breakdown, availability and instant-book. Without dates Airbnb returns no quote at all, and every price field will be empty." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "YYYY-MM-DD. Must be after check-in." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Guest count used for the price quote. Defaults to 1.", "default": 1 }, "children": { "title": "Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Children (ages 2-12) included in the quote." }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Infants (under 2) included in the quote." }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Pets included in the quote. Affects pet fees in the price breakdown." }, "includeCalendar": { "title": "Include availability calendar", "type": "boolean", "description": "Fetch day-by-day availability (bookable, min/max nights, check-in eligibility) plus an occupancy summary. Costs one extra request per listing.", "default": false }, "calendarMonths": { "title": "Calendar months", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many months of availability to pull (1-12). Ignored when the calendar is off.", "default": 6 }, "includePricing": { "title": "Include pricing", "type": "boolean", "description": "Fetch the price quote when check-in/check-out are set. Turn off to skip the extra request if you only need static listing facts.", "default": true }, "includeInlineReviews": { "title": "Include inline review preview", "type": "boolean", "description": "Fetch the first few reviews per listing (via the same GraphQL backend) so you get a ready-to-use preview alongside the rating/category data. Disable to skip the extra request.", "default": true }, "inlineReviewsCount": { "title": "Inline review count", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many inline reviews to attach per listing (max 50). Ignored when includeInlineReviews is off.", "default": 6 }, "currency": { "title": "Currency", "type": "string", "description": "Currency for all prices (USD, EUR, GBP, CAD, AUD, ...). Verified 2026-08-30: this is honoured regardless of your proxy country — you do NOT need to change proxyConfiguration to match. The output reports both `currency` (detected from the price Airbnb actually returned) and `currencyRequested`, so you can always confirm.", "default": "USD" }, "locale": { "title": "Locale", "type": "string", "description": "Locale for human-readable text in the response (e.g. en-US, en-GB, de, fr, es). Affects amenity labels, review snippets, house rules, etc. Does not affect numeric data.", "default": "en-US" }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Hard cap on the total number of listings to push. Leave empty for no limit." }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many listings to fetch in parallel. The GraphQL transport handles 15+ comfortably; lower this only if your proxy pool throttles.", "default": 10 }, "includeRawPayload": { "title": "Include raw PDP payload (debug)", "type": "boolean", "description": "Set true to attach the raw parsed Airbnb sections and pdpPresentation to each item. Adds ~150KB per item — leave off unless you're debugging the extractor.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy configuration for Airbnb requests. Keep the default US country: Airbnb's edge serves the most complete payloads to US exits, and prices come back in whatever `currency` you asked for regardless of proxy country. Non-US country codes are supported but can be slower or unavailable on some proxy plans.", "default": { "useApifyProxy": true, "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }