{
  "openapi": "3.0.1",
  "info": {
    "title": "Vrbo Scraper + STR Market KPIs (ADR · Occupancy · RevPAR)",
    "description": "Vrbo scraper with built-in STR investor KPIs — ADR, occupancy, RevPAR, estimated annual revenue per listing. 5 search modes (location, coordinates, polygon, URL, propertyId). Granular per-event enrichment: availability, reviews, host. HTML market report included.",
    "version": "1.0",
    "x-build-id": "4Bhw5moF5gRjfhzr7"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~vrbo-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-vrbo-property-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/sian.agency~vrbo-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-vrbo-property-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/sian.agency~vrbo-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-vrbo-property-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": {
          "searchMode": {
            "title": "🧭 Search Mode",
            "enum": [
              "location",
              "coordinates",
              "polygon",
              "url",
              "propertyId"
            ],
            "type": "string",
            "description": "Pick how you want to search Vrbo. Each mode reads its own dedicated input fields below — fields outside the chosen mode are ignored.\n\n• **location** — text destination (default; e.g. 'Miami, Florida')\n• **coordinates** — center point (lat/lng + radius)\n• **polygon** — geo polygon (list of lat,lng vertices)\n• **url** — paste a Vrbo search or property URL\n• **propertyId** — direct lookup by Vrbo property ID",
            "default": "location"
          },
          "maxResultsPerQuery": {
            "title": "📊 Max results per query",
            "minimum": 1,
            "maximum": 300,
            "type": "integer",
            "description": "Hard cap on listings returned per query. Auto-paginates 50 listings/page until cap is reached or search is fully drained. Vrbo caps searches at 300 total results. FREE tier is always capped at 25.",
            "default": 50
          },
          "location": {
            "title": "📍 Location  (used when Search Mode = location)",
            "type": "string",
            "description": "Free-text destination, e.g. 'Miami, Florida' or 'Orlando, FL'. Use the Vrbo destination box on vrbo.com to find canonical strings.",
            "default": "Miami, Florida"
          },
          "locations": {
            "title": "📋 Bulk Locations  (PAID, location mode)",
            "uniqueItems": true,
            "type": "array",
            "description": "Array of location strings. PAID tier only.",
            "items": {
              "type": "string"
            }
          },
          "latitude": {
            "title": "🧭 Latitude  (used when Search Mode = coordinates)",
            "type": "string",
            "description": "Center-point latitude. -90 to 90."
          },
          "longitude": {
            "title": "🧭 Longitude",
            "type": "string",
            "description": "Center-point longitude. -180 to 180."
          },
          "polygon": {
            "title": "🔷 Polygon  (used when Search Mode = polygon)",
            "type": "string",
            "description": "Semicolon-separated lat,lng vertex pairs forming a closed polygon. First and last vertices should match. Example: '25.78,-80.19;25.80,-80.18;25.79,-80.16;25.77,-80.17;25.78,-80.19'."
          },
          "vrboUrl": {
            "title": "🔗 Vrbo URL  (used when Search Mode = url)",
            "pattern": "^https?://(www\\.)?vrbo\\.[a-z.]+/.+",
            "type": "string",
            "description": "Paste a Vrbo search URL or a single property URL from your browser. Auto-paginates through search results."
          },
          "vrboUrls": {
            "title": "📋 Bulk Vrbo URLs  (PAID, url mode)",
            "uniqueItems": true,
            "type": "array",
            "description": "Array of Vrbo search or property URLs. PAID tier only.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "propertyId": {
            "title": "🆔 Property ID  (used when Search Mode = propertyId)",
            "type": "string",
            "description": "Vrbo numeric property ID. Returns 1 row per ID with the full detail bundle."
          },
          "propertyIds": {
            "title": "📋 Bulk Property IDs  (PAID, propertyId mode)",
            "uniqueItems": true,
            "type": "array",
            "description": "Array of Vrbo property IDs. PAID tier only.",
            "items": {
              "type": "string"
            }
          },
          "computeAvailability": {
            "title": "📅 Compute occupancy & RevPAR  (recommended for investors)",
            "type": "boolean",
            "description": "When ON, fetches each listing's forward-looking calendar (1 extra API call per listing) and computes occupancy rate, ADR, RevPAR, and estimated annual revenue. Adds an AvailabilityEnriched charge per listing. Disabled on FREE tier.",
            "default": false
          },
          "availabilityWindowDays": {
            "title": "📅 Availability window (days)",
            "minimum": 30,
            "maximum": 365,
            "type": "integer",
            "description": "Forward-looking calendar window for occupancy/RevPAR computation. 30 = next month, 90 = next quarter (recommended), 180 = half year, 365 = full year.",
            "default": 90
          },
          "fetchReviews": {
            "title": "💬 Fetch reviews",
            "type": "boolean",
            "description": "When ON, fetches the latest reviews for each listing (1 extra API call per listing, 10 reviews per page). Adds a ReviewsEnriched charge per listing. Disabled on FREE tier.",
            "default": false
          },
          "maxReviewsPerListing": {
            "title": "💬 Max reviews per listing",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Cap on reviews returned per listing. Reviews are paginated 10/page upstream. Default 10 = first page only.",
            "default": 10
          },
          "fetchHost": {
            "title": "🧑‍💼 Fetch host details",
            "type": "boolean",
            "description": "When ON, fetches the full host profile for each listing (1 extra API call per listing). Adds a HostEnriched charge per listing. Disabled on FREE tier.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}