{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper — Listings, Prices & Photos", "description": "Scrape Airbnb listings: prices, photos, ratings, coordinates, room details. Price split into list rate, discounts and taxes so it reconciles. Market percentiles and price changes. No host data.", "version": "0.1", "x-build-id": "DmbHO5zShTCSDLcLY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/danielmachad~airbnb-market-intel/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-danielmachad-airbnb-market-intel", "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/danielmachad~airbnb-market-intel/runs": { "post": { "operationId": "runs-sync-danielmachad-airbnb-market-intel", "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/danielmachad~airbnb-market-intel/run-sync": { "post": { "operationId": "run-sync-danielmachad-airbnb-market-intel", "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", "required": [ "location" ], "properties": { "location": { "title": "Location", "type": "string", "description": "Market to analyse, as \"City, Country\" — for example \"Lisbon, Portugal\", \"Austin, Texas\" or \"Kyoto, Japan\". A bare city name usually resolves too, but the two-part form is unambiguous. The run fails with an explanatory message if Airbnb does not recognise the place, rather than returning an empty result.", "default": "Lisbon, Portugal" }, "checkIn": { "title": "Check-in date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Date in YYYY-MM-DD format, e.g. 2026-09-15. Must be in the future. Supply this together with checkOut: without dates, Airbnb prices each listing for a different date window, so the nightly rates are not comparable to one another and the market percentiles built from them are meaningless." }, "checkOut": { "title": "Check-out date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Date in YYYY-MM-DD format, e.g. 2026-09-18. Must be after checkIn. The gap between the two dates sets the stay length used for pricing." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Guest count used for the price query.", "default": 2 }, "maxListings": { "title": "Max listings", "minimum": 1, "maximum": 270, "type": "integer", "description": "Upper bound on listings returned, and therefore on cost — billing is per listing. Airbnb serves at most 270 per search, so that is the ceiling; a narrow market may return fewer than requested. To cover a large city beyond 270, run several searches split by neighborhood or date window.", "default": 50 }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "BRL", "CAD", "AUD", "MXN", "JPY" ], "type": "string", "description": "Currency for all returned prices.", "default": "USD" }, "trackChanges": { "title": "Track changes between runs", "type": "boolean", "description": "Stores a snapshot of this market slice so a later run can report what moved. The change fields (priceChange, reviewCountChange, status) and every occupancy field stay null on the first run for a given slice — there is no history to compare against yet. A slice is the combination of location, dates, adults and currency: repeat the exact same input to build history, change any of it and comparison restarts. Occupancy additionally requires the runs to be at least 3 days apart.", "default": true }, "reviewRate": { "title": "Review rate (occupancy model)", "minimum": 0.1, "maximum": 1, "type": "number", "description": "Assumed share of stays that leave a review. Drives the occupancy estimate. Lower values imply higher occupancy for the same review count.", "default": 0.5 }, "avgStayNights": { "title": "Average nights per booking (occupancy model)", "minimum": 1, "maximum": 30, "type": "number", "description": "Assumed average length of stay, used to convert bookings into booked nights.", "default": 3.5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Leave as is — the automatic setting is what this Actor is tuned for. Residential proxy is deliberately ignored: Airbnb does not block Apify's shared addresses, so it adds cost without improving results. Supply proxyUrls if you need to route through your own infrastructure.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }