BookingAdvice

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/besttimetobookhotels-com/json-schema/besttimetobookhotels-com-booking-advice-schema.json",
  "title": "BookingAdvice",
  "description": "Advice for one stay. Prices are medians of observed nightly rates in USD.",
  "x-generated": "2026-11-02",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/besttimetobookhotels-com-openapi.json#/components/schemas/BookingAdvice",
  "type": "object",
  "required": [
    "basis",
    "checkIn",
    "citySlug",
    "confidence",
    "countrySlug",
    "daysUntilCheckIn",
    "recommendation",
    "relativeToYear",
    "season",
    "targetMedianPrice",
    "yearlyMedianPrice"
  ],
  "properties": {
    "basis": {
      "type": "string",
      "description": "Which evidence the recommendation rests on."
    },
    "checkIn": {
      "$ref": "#/$defs/IsoDate"
    },
    "checkOut": {
      "$ref": "#/$defs/IsoDate"
    },
    "citySlug": {
      "type": "string"
    },
    "countrySlug": {
      "type": "string"
    },
    "confidence": {
      "type": "string",
      "enum": [
        "high",
        "medium",
        "low"
      ]
    },
    "daysUntilCheckIn": {
      "type": "integer"
    },
    "recommendation": {
      "type": "string",
      "description": "The advice verdict, e.g. `book_now` or `wait_until_window`."
    },
    "relativeToYear": {
      "type": "string",
      "description": "How the stay's median compares with the yearly median."
    },
    "season": {
      "type": "string"
    },
    "targetMedianPrice": {
      "type": "number",
      "description": "Observed median nightly price for the requested stay, USD."
    },
    "yearlyMedianPrice": {
      "type": "number",
      "description": "Observed median nightly price across the year, USD."
    },
    "history": {
      "type": "object",
      "description": "Summary of observed booking-date prices for this stay."
    },
    "historyTrend": {
      "type": "object",
      "description": "Direction and size of the recent price move."
    }
  },
  "$defs": {
    "IsoDate": {
      "type": "string",
      "format": "date",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    }
  }
}