{ "openapi": "3.0.1", "info": { "title": "Airbnb Market Intel Scraper | Listings, Occupancy & Revenue", "description": "Scrape any Airbnb market: nightly price, rating, reviews, bedrooms + 12-month calendar turned into occupancy 30/60/90, est. monthly revenue, RevPAR, superhost & host stats, plus a free market-summary row. AirDNA-style comps for STR investors & hosts. HTTP-only, pay per result, MCP-ready.", "version": "0.0", "x-build-id": "q1XI2oZ8pzNkRMSIr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tactful_anvil~airbnb-market-intel-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tactful_anvil-airbnb-market-intel-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/tactful_anvil~airbnb-market-intel-scraper/runs": { "post": { "operationId": "runs-sync-tactful_anvil-airbnb-market-intel-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/tactful_anvil~airbnb-market-intel-scraper/run-sync": { "post": { "operationId": "run-sync-tactful_anvil-airbnb-market-intel-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": { "location": { "title": "Location", "type": "string", "description": "City, neighborhood, region or address exactly as you would type it into Airbnb search (e.g. \"Austin, TX\", \"Canggu, Bali\", \"Lisbon, Portugal\").", "default": "Austin, TX" }, "locations": { "title": "More locations (optional)", "type": "array", "description": "Scan several markets in one run — one location per line. Overrides the single Location field when filled.", "default": [], "items": { "type": "string" } }, "searchUrls": { "title": "Airbnb search URLs (advanced, optional)", "type": "array", "description": "Paste full airbnb.com/s/... search URLs with any filters applied in the Airbnb UI (map area, amenities, instant book…). Pagination and currency are handled for you.", "default": [], "items": { "type": "string" } }, "checkIn": { "title": "Check-in (YYYY-MM-DD)", "type": "string", "description": "Stay dates drive the nightly price Airbnb shows. Leave empty for a default stay 4 weeks from today (3 nights)." }, "checkOut": { "title": "Check-out (YYYY-MM-DD)", "type": "string", "description": "Must be after check-in." }, "adults": { "title": "Adults", "type": "integer", "description": "Guest count used for the search (1–16).", "default": 2 }, "children": { "title": "Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Children in the party (Airbnb `children`). Changes availability and price like on the site.", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Infants (under 2) — not counted toward capacity.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Pets — only pet-friendly listings are returned.", "default": 0 }, "roomType": { "title": "Room type", "enum": [ "any", "entire_home", "private_room" ], "type": "string", "description": "Filter to entire homes or private rooms, or take everything.", "default": "any" }, "minBedrooms": { "title": "Min bedrooms", "type": "integer", "description": "0 = no filter.", "default": 0 }, "minBeds": { "title": "Min beds", "minimum": 0, "maximum": 16, "type": "integer", "description": "0 = no filter.", "default": 0 }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "maximum": 8, "type": "integer", "description": "0 = no filter.", "default": 0 }, "priceMin": { "title": "Min nightly price", "type": "integer", "description": "In the selected currency. 0 = no filter.", "default": 0 }, "priceMax": { "title": "Max nightly price", "type": "integer", "description": "In the selected currency. 0 = no filter.", "default": 0 }, "minRating": { "title": "Min rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep only listings whose search-card rating is at least this (e.g. 4.8). Listings without a rating (new) are dropped. Dropped listings are never charged.", "default": 0 }, "minReviews": { "title": "Min reviews", "minimum": 0, "type": "integer", "description": "Keep only listings with at least this many reviews (proven demand). Never charged when dropped.", "default": 0 }, "guestFavoriteOnly": { "title": "Guest Favorite only", "type": "boolean", "description": "Keep only listings carrying Airbnb's Guest Favorite / Top Guest Favorite badge on the search card. Never charged when dropped.", "default": false }, "maxListings": { "title": "Max listings per location (charged rows)", "type": "integer", "description": "18 listings per page, Airbnb caps a search at 15 pages (270). Default 54 = 3 pages.", "default": 54 }, "enrichCalendar": { "title": "Enrich with 12-month calendar + listing details", "type": "boolean", "description": "Adds occupancy 30/60/90/365, est. revenue, RevPAR, min nights, superhost, capacity, sub-ratings, host stats per listing (2 extra requests each, $6/1k instead of $4/1k).", "default": true }, "maxEnrich": { "title": "Max listings to enrich", "type": "integer", "description": "Enrich only the first N listings (search order). Default 30. Set to 270 to enrich everything.", "default": 30 }, "currency": { "title": "Currency", "type": "string", "description": "ISO code, e.g. USD, EUR, GBP, AUD, IDR.", "default": "USD" }, "marketSummary": { "title": "Add free market-summary row", "type": "boolean", "description": "One extra (never charged) row: median/p25/p75 nightly price, avg rating, share superhost / guest favorite, median occupancy & est. revenue, breakdown by bedrooms. Also saved as key-value record MARKET_SUMMARY.", "default": 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 } } } } } } } } } }