{
  "openapi": "3.0.1",
  "info": {
    "title": "Airbnb Occupancy Rate Scraper — Nightly Rate, ADR & Market Data",
    "description": "Airbnb occupancy rate per listing and month from the availability calendar, by place or listing id. One row per listing and month: days available, days blocked or booked, occupancy %, minimum stay, nightly rate. Short term rental data, vacation rental comps, competitors. Free: filtered months.",
    "version": "1.0",
    "x-build-id": "mC5TwQAYpHgGwnZrx"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/kestrel~airbnb-occupancy-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-kestrel-airbnb-occupancy-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/kestrel~airbnb-occupancy-scraper/runs": {
      "post": {
        "operationId": "runs-sync-kestrel-airbnb-occupancy-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/kestrel~airbnb-occupancy-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-kestrel-airbnb-occupancy-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": {
          "locationQueries": {
            "title": "Places",
            "uniqueItems": true,
            "type": "array",
            "description": "Places as typed on Airbnb, e.g. [\"Lisbon, Portugal\"], [\"Alfama, Lisbon\"], [\"Brooklyn, NY\"]. Every listing Airbnb returns for the place (up to maxListingsPerQuery) gets one occupancy row per month. A place Airbnb does not recognise is reported as an unknown_area status row and costs nothing: write it as Airbnb spells it, with the country when ambiguous. Use for \"Airbnb occupancy rate in <city>\" and market runs; for exact listings use listingIds.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Airbnb URLs",
            "uniqueItems": true,
            "type": "array",
            "description": "Airbnb search URLs (https://www.airbnb.com/s/Porto--Portugal/homes?room_types[]=Entire home/apt&min_bedrooms=2) or listing URLs (https://www.airbnb.com/rooms/12345678). A search URL keeps its filters: room type, price band, bedrooms, amenities, map bounds. Use for \"occupancy of the listings in this search\". A URL from another site is rejected before anything is charged. Default empty.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "listingIds": {
            "title": "Listing ids",
            "uniqueItems": true,
            "type": "array",
            "description": "Numeric Airbnb listing ids, e.g. [\"17088279\", \"34832567\"] (the number in /rooms/<id>): your portfolio or a competitive set. One occupancy row per id and month, no search needed; name, location and rating are read from the listing page at no charge. maxListingsPerQuery does not apply. Default empty.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "months": {
            "title": "Months",
            "minimum": 1,
            "maximum": 12,
            "type": "integer",
            "description": "Calendar months to read per listing, 1 to 12, starting with the current month, e.g. 6 (default 3). One row per listing and month, so the bill is listings × months × $0.002 through 2026-10-26; $0.003 from 2026-10-27. The current month counts only the days from today; the calendar covers 12 months ahead, so 12 is the maximum.",
            "default": 3
          },
          "maxListingsPerQuery": {
            "title": "Max listings per place",
            "minimum": 1,
            "maximum": 280,
            "type": "integer",
            "description": "Listings per place or search URL, 1 to 280, e.g. 100 (default 40). The main cost control for a market run: at most maxListingsPerQuery × months rows per place. Airbnb caps one search at about 280; split a big city into neighbourhoods for more. Ignored for listingIds.",
            "default": 40
          },
          "includeRates": {
            "title": "Sample a nightly rate per month",
            "type": "boolean",
            "description": "true (DEFAULT) = price the first bookable stay of each month (check-in on the first available day, the listing's minimum nights, at most 7) for `adults` guests and put rate_nightly, rate_total and the sampled dates on the row: an ADR sample. One extra request per listing and month, no extra charge. false = availability only, about half the requests: rate fields null, rate_status \"skipped\". A month with no bookable stay keeps its occupancy and says rate_status \"no_stay\".",
            "default": true
          },
          "adults": {
            "title": "Adults (for the rate sample)",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "Guests the sampled stay is priced for, 1 to 16, e.g. 2 (default 2). Airbnb prices depend on the guest count; a listing that cannot sleep the party answers rate_status \"unavailable\" and its occupancy row is still delivered.",
            "default": 2
          },
          "minOccupancyPct": {
            "title": "Min occupancy % (filter)",
            "minimum": 0,
            "maximum": 100,
            "type": "number",
            "description": "0 (default) = deliver every month. N = deliver only months whose occupancy is at or above N %, e.g. 80 for \"listings that are nearly full\". Months under the line are dropped BEFORE billing and before the rate sample, so a run that finds nothing costs nothing; the status row counts them in `filtered`.",
            "default": 0
          },
          "includeListingRow": {
            "title": "Listing rows",
            "type": "boolean",
            "description": "true = also emit one free listing row per listing (name, room type, location, rating, reviews count, bedrooms) for sheets that want one line per property. Default false. Never charged.",
            "default": false
          },
          "currency": {
            "title": "Currency",
            "pattern": "^[A-Z]{3}$",
            "minLength": 3,
            "maxLength": 3,
            "type": "string",
            "description": "ISO 4217 code for the sampled rates, e.g. \"EUR\" (default \"USD\"). Echoed on every occupancy row. When the user names no currency, pass the destination's (\"EUR\" for Lisbon).",
            "default": "USD"
          },
          "locale": {
            "title": "Language",
            "type": "string",
            "description": "Airbnb locale for listing names, e.g. \"en\" (default), \"fr\", \"de\", \"es\", \"pt\", \"ja\". Occupancy and rates are not affected.",
            "default": "en"
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify Proxy settings. Airbnb accepts datacenter proxies for these calls: keep the default {\"useApifyProxy\": true}.",
            "default": {
              "useApifyProxy": true
            }
          },
          "sessions": {
            "title": "Parallel proxy sessions",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "Parallel proxy sessions (egress IPs), 1 to 16, e.g. 4 (default 4). Each is paced at perIp requests per second; more sessions = a faster run at the same cost.",
            "default": 4
          },
          "perIp": {
            "title": "Requests per second per IP",
            "minimum": 0.1,
            "maximum": 3,
            "type": "number",
            "description": "Requests per second per session, 0.1 to 3, e.g. 1 (default 1). Airbnb tolerated 1 per second in tests; raise it only when a run is slow and not being throttled.",
            "default": 1
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}