{
  "openapi": "3.0.1",
  "info": {
    "title": "Airbnb Scraper - Data, Prices, Reviews, Availability, Occupancy",
    "description": "Scrape Airbnb by location or listing URL: listings, prices and property details, 12-month availability and price-by-date, occupancy / ADR / RevPAR revenue signals, reviews with sentiment, and a market report. No login, no API key. An AirDNA alternative.",
    "version": "1.0",
    "x-build-id": "EH8wuG5E38neyfY5c"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/factden~airbnb-data-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-factden-airbnb-data-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/factden~airbnb-data-scraper/runs": {
      "post": {
        "operationId": "runs-sync-factden-airbnb-data-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/factden~airbnb-data-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-factden-airbnb-data-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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "🎯 Mode",
            "enum": [
              "discover",
              "availability",
              "occupancy",
              "reviews",
              "market"
            ],
            "type": "string",
            "description": "Pick what to scrape. Then fill the ONE input it needs below — Location for Discover & Market, Listing URLs for Availability / Occupancy / Reviews. Only the selected mode's fields are used.",
            "default": "discover"
          },
          "location": {
            "title": "📍 Location  ·  Discover & Market",
            "type": "string",
            "description": "City / neighborhood / search term, e.g. `Paris, France`."
          },
          "startUrls": {
            "title": "🔗 Listing URLs or IDs  ·  Availability / Occupancy / Reviews",
            "maxItems": 1000,
            "type": "array",
            "description": "One `airbnb.com/rooms/…` URL or numeric listing ID per line.",
            "items": {
              "type": "string"
            }
          },
          "checkInDate": {
            "title": "📅 Check-in",
            "type": "string",
            "description": "YYYY-MM-DD. Optional live pricing for Discover; leave empty to skip."
          },
          "checkOutDate": {
            "title": "📅 Check-out",
            "type": "string",
            "description": "YYYY-MM-DD. Must be after check-in."
          },
          "adults": {
            "title": "👤 Adults",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "Guests used for price quotes.",
            "default": 2
          },
          "minPrice": {
            "title": "💲 Min price / night",
            "minimum": 0,
            "type": "integer",
            "description": "Drop listings below this nightly price."
          },
          "maxPrice": {
            "title": "💲 Max price / night",
            "minimum": 0,
            "type": "integer",
            "description": "Drop listings above this nightly price."
          },
          "roomType": {
            "title": "🏠 Room type",
            "enum": [
              "any",
              "entireHome",
              "privateRoom",
              "hotelRoom",
              "sharedRoom"
            ],
            "type": "string",
            "description": "Refine the search toward a room type.",
            "default": "any"
          },
          "maxListings": {
            "title": "🔢 Max listings",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many unique listings. 0 = no cap.",
            "default": 100
          },
          "months": {
            "title": "📆 Months forward",
            "minimum": 1,
            "maximum": 12,
            "type": "integer",
            "description": "How many months of the forward calendar to pull (1-12). Availability is billed per calendar day, so cost scales with this (≈30 days/month). Note: occupancy is most accurate for the near term - months far out are all still available (unbooked).",
            "default": 12
          },
          "includeDailyPrices": {
            "title": "💵 Price each available date  ·  Availability",
            "type": "boolean",
            "description": "Availability add-on: fetch the real nightly price for each available check-in date (capped 30/listing). Billed separately per priced date (see pricing). Off = calendar only.",
            "default": false
          },
          "maxReviews": {
            "title": "🔢 Max reviews per listing",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Cap on reviews per listing (paginated).",
            "default": 100
          },
          "reviewsSort": {
            "title": "↕️ Sort reviews by",
            "enum": [
              "recent",
              "relevant",
              "highest",
              "lowest"
            ],
            "type": "string",
            "description": "Order reviews are fetched in.",
            "default": "recent"
          },
          "fromDate": {
            "title": "📅 Reviews from",
            "type": "string",
            "description": "Only reviews on or after this date (YYYY-MM-DD)."
          },
          "toDate": {
            "title": "📅 Reviews to",
            "type": "string",
            "description": "Only reviews on or before this date (YYYY-MM-DD)."
          },
          "minRating": {
            "title": "⭐ Min rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Only reviews rated at or above this (1-5)."
          },
          "maxRating": {
            "title": "⭐ Max rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Only reviews rated at or below this (1-5)."
          },
          "sampleSize": {
            "title": "🔢 Sample size",
            "minimum": 20,
            "maximum": 240,
            "type": "integer",
            "description": "Listings sampled for the market KPIs. ~100 is statistically representative; price percentiles stabilise well before the cap. Capped at 240 - Airbnb surfaces ~240 listings per location query (15 pages), so higher values can't be reached from one search.",
            "default": 100
          },
          "marketMonths": {
            "title": "📆 Sample occupancy months",
            "minimum": 1,
            "maximum": 6,
            "type": "integer",
            "description": "Forward months read per sampled listing for the market occupancy/RevPAR (1-6). Capped at 6 on purpose: forward occupancy is a near-term booking-pace proxy - months further out are all unbooked and would understate occupancy. No extra cost (one call, bigger response).",
            "default": 3
          },
          "currency": {
            "title": "💱 Currency",
            "enum": [
              "USD",
              "EUR",
              "GBP",
              "INR",
              "JPY",
              "AUD",
              "CAD",
              "CHF",
              "SGD",
              "AED",
              "BRL",
              "CNY",
              "HKD",
              "MXN",
              "ZAR",
              "THB",
              "KRW",
              "SEK",
              "NZD",
              "PLN"
            ],
            "type": "string",
            "description": "Currency for all prices.",
            "default": "USD"
          },
          "locale": {
            "title": "🗣️ Language / locale",
            "enum": [
              "en",
              "es",
              "fr",
              "de",
              "it",
              "pt",
              "ja",
              "hi",
              "ar"
            ],
            "type": "string",
            "description": "Language for names, review text and labels.",
            "default": "en"
          },
          "proxyConfiguration": {
            "title": "🌐 Proxy",
            "type": "object",
            "description": "Apify Datacenter proxy (default) rotates IPs across the run - recommended for Airbnb. Switch to Residential only if you scale very hard and see throttling.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}