The Charter Desk

Find this site's yachts, read from the live inventory. Pass what the person wants as the typed filters, and from / to whenever they gave exact days. With dates it returns only the yachts free for that stay, each with its stay: status, price, list price, discount and when the source was checked (checkedAt). Without dates each has its from-price. Every row carries its page link and one photo, absolute URLs on this site; send the person there. Narrow with the typed filters (each list is any of its values; every filter must hold); priceMin / priceMax count the mandatory extras a quote states. notApplied lists what could not narrow the search. When nothing matches exactly the answer is the nearest match, and nearest says what was widened (another week, the place around, a bound let go): tell the person. Paged: total and cursor. Works without a contact (browsing: fewer rows). Use it when the person describes what they want; use best_deals when they ask what is discounted, price_range for what a stay usually costs, and get_yacht for everything about one yacht.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Optional: the person's own email, as they gave it, for more rows a call. Leave out to browse; the site keeps it to answer their enquiry."
    },
    "phone": {
      "type": "string",
      "description": "Optional: the person's own phone, international form (+ and country code), as they gave it, for more rows a call. Leave out to browse."
    },
    "session": {
      "type": "string",
      "description": "The session an earlier answer returned. Pass it instead of email or phone from then on."
    },
    "name": {
      "type": "string",
      "description": "Optional: the person's name, as they gave it."
    },
    "from": {
      "type": "string",
      "description": "Check-in day, YYYY-MM-DD."
    },
    "to": {
      "type": "string",
      "description": "Check-out day, YYYY-MM-DD."
    },
    "party": {
      "type": "number",
      "description": "How many people."
    },
    "yacht_types": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "catamarans",
          "gulets",
          "houseboats",
          "motorboats",
          "sailboats"
        ]
      },
      "minItems": 1,
      "description": "Yacht Types: any of these value ids (one or more): catamarans (Catamarans, 3193); gulets (Gulets, 201); houseboats (Houseboats, 1428); motorboats (Motorboats, 1080); sailboats (Sailboats, 4577)."
    },
    "charter_types": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "all-inclusive",
          "bareboat",
          "cabin-charter",
          "crewed",
          "day-charter",
          "flotilla",
          "regatta",
          "skippered"
        ]
      },
      "minItems": 1,
      "description": "Charter Types: any of these value ids (one or more): all-inclusive (All-inclusive, 68); bareboat (Bareboat, 8797); cabin-charter (Cabin charter, 152); crewed (Crewed, 1702); day-charter (Day charter, 374); flotilla (Flotilla, 257); regatta (Regatta, 34); skippered (Skippered, 245)."
    },
    "place": {
      "type": "string",
      "description": "Where, in words or as a place id: a region, country or area, and everything in it, e.g. Mediterranean, Worldwide, Caribbean, North America, Greece, Croatia, Italy, France, Turkey, Spain, British Virgin Islands, Netherlands, Germany, Seychelles, Poland, Ireland, Martinique, United Kingdom, Belgium, Portugal, Ecuador, French Polynesia, Sweden, St. Martin, Bahamas, Malta, Montenegro, Thailand, Canada, St. Lucia, Slovenia, Norway, Guadeloupe, Brazil, Hungary, Grenada, St. Vincent, Belize, Cuba, Maldives, Mexico, Panama, Cape Verde, United Arab Emirates, Antigua and Barbuda, India, Tanzania, Egypt, Monaco, Estonia, Mauritius, New Zealand, USA, Switzerland, Fiji. An unknown place is refused; nothing there answers the nearest place around it."
    },
    "base": {
      "type": "string",
      "description": "The exact base it leaves from, in words."
    },
    "text": {
      "type": "string",
      "description": "Words in its name or model, e.g. a builder or a model name."
    },
    "lengthMin": {
      "type": "number",
      "description": "Length at least ft (on this site 13.35 to 180.45)."
    },
    "lengthMax": {
      "type": "number",
      "description": "Length at most ft (on this site 13.35 to 180.45)."
    },
    "cabinsMin": {
      "type": "number",
      "description": "Cabins at least (on this site 0 to 20)."
    },
    "cabinsMax": {
      "type": "number",
      "description": "Cabins at most (on this site 0 to 20)."
    },
    "berthsMin": {
      "type": "number",
      "description": "Berths at least (on this site 0 to 80)."
    },
    "berthsMax": {
      "type": "number",
      "description": "Berths at most (on this site 0 to 80)."
    },
    "headsMin": {
      "type": "number",
      "description": "Heads at least (on this site 0 to 23)."
    },
    "headsMax": {
      "type": "number",
      "description": "Heads at most (on this site 0 to 23)."
    },
    "beamMin": {
      "type": "number",
      "description": "Beam at least m (on this site 0.9 to 44)."
    },
    "beamMax": {
      "type": "number",
      "description": "Beam at most m (on this site 0.9 to 44)."
    },
    "draftMin": {
      "type": "number",
      "description": "Draft at least m (on this site 0.3 to 7985)."
    },
    "draftMax": {
      "type": "number",
      "description": "Draft at most m (on this site 0.3 to 7985)."
    },
    "yearMin": {
      "type": "number",
      "description": "Year at least (on this site 0 to 2028)."
    },
    "yearMax": {
      "type": "number",
      "description": "Year at most (on this site 0 to 2028)."
    },
    "fuelMin": {
      "type": "number",
      "description": "Fuel tank at least l (on this site 1 to 65000)."
    },
    "fuelMax": {
      "type": "number",
      "description": "Fuel tank at most l (on this site 1 to 65000)."
    },
    "waterMin": {
      "type": "number",
      "description": "Water tank at least l (on this site 1 to 60000)."
    },
    "waterMax": {
      "type": "number",
      "description": "Water tank at most l (on this site 1 to 60000)."
    },
    "priceMin": {
      "type": "number",
      "description": "The least to pay, in the site currency: the price plus the mandatory extras."
    },
    "priceMax": {
      "type": "number",
      "description": "The most to pay, in the site currency: the price plus the mandatory extras."
    },
    "discountOnly": {
      "type": "boolean",
      "description": "true: only those with a discount the source states."
    },
    "sort": {
      "type": "string",
      "enum": [
        "price",
        "discount",
        "length",
        "cabins",
        "berths",
        "heads",
        "beam",
        "draft",
        "year",
        "fuel",
        "water"
      ],
      "description": "price (default, cheapest first), discount (biggest first), or length (length, biggest first), cabins (cabins, biggest first), berths (berths, biggest first), heads (heads, biggest first), beam (beam, biggest first), draft (draft, biggest first), year (year, biggest first), fuel (fuel tank, biggest first), water (water tank, biggest first)."
    },
    "cursor": {
      "type": "string",
      "description": "The cursor a previous answer returned, for its next page."
    },
    "limit": {
      "type": "number",
      "description": "Rows per page: at most 10 when browsing, 20 with the person's email or phone."
    }
  },
  "required": [],
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "description": "One page of matches.",
      "items": {
        "type": "object",
        "description": "One item.",
        "properties": {
          "name": {
            "type": "string",
            "description": "Its name."
          },
          "href": {
            "type": "string",
            "description": "Its page on this site, absolute URL."
          },
          "image": {
            "type": "object",
            "description": "One photo, an absolute URL.",
            "properties": {
              "src": {
                "type": "string",
                "description": "https URL."
              },
              "alt": {
                "type": "string",
                "description": "What it shows."
              }
            }
          },
          "kind": {
            "type": "string",
            "description": "Its type, in the site's words."
          },
          "priceFrom": {
            "type": "number",
            "description": "The stay's price with dates, else its cheapest quoted stay, in major units."
          },
          "currency": {
            "type": "string",
            "description": "ISO 4217."
          },
          "mandatoryExtras": {
            "type": "object",
            "description": "Without dates: what its cheapest quote says is payable on top.",
            "properties": {
              "amount": {
                "type": "number",
                "description": "In major units (euros, not cents)."
              },
              "currency": {
                "type": "string",
                "description": "ISO 4217."
              },
              "text": {
                "type": "string",
                "description": "The amount written out, to quote to the person."
              }
            }
          },
          "stay": {
            "type": "object",
            "description": "With dates: that stay, read live.",
            "properties": {
              "checkIn": {
                "type": "string",
                "description": "YYYY-MM-DD."
              },
              "checkOut": {
                "type": "string",
                "description": "YYYY-MM-DD."
              },
              "nights": {
                "type": "number",
                "description": "Nights."
              },
              "status": {
                "type": "string",
                "enum": [
                  "free",
                  "booked",
                  "not-a-check-in-day",
                  "not-whole-blocks",
                  "outside-calendar",
                  "not-known"
                ],
                "description": "Whether it can be booked."
              },
              "price": {
                "type": "object",
                "description": "The stay's price.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "listPrice": {
                "type": "object",
                "description": "The source's list price above price, when discounted.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "discountPct": {
                "type": "number",
                "description": "The discount the source states."
              },
              "mandatoryExtras": {
                "type": "object",
                "description": "What the source says is payable on top, whatever the person picks.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "deposit": {
                "type": "object",
                "description": "The deposit held.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "checkedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "When the source was read, ISO time."
              }
            }
          }
        }
      }
    },
    "total": {
      "type": "number",
      "description": "How many rows match in all."
    },
    "cursor": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pass as cursor for the next page; null on the last."
    },
    "checked": {
      "type": "boolean",
      "description": "true: dates were given, so every row is free for them."
    },
    "checkedAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the source was read, ISO time."
    },
    "notApplied": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "A wish."
      },
      "description": "What the person asked for that could not narrow the search."
    },
    "unchecked": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "dates or party."
      },
      "description": "What was said but could not be checked."
    },
    "leftOutUnpriced": {
      "type": "number",
      "description": "Matches left out under priceMin / priceMax because no price is known."
    },
    "nearest": {
      "type": "object",
      "description": "Only when nothing matched exactly: these rows are the nearest match.",
      "properties": {
        "widened": {
          "type": "string",
          "enum": [
            "dates",
            "base",
            "place",
            "ranges",
            "price",
            "discount"
          ],
          "description": "The one thing let go."
        },
        "note": {
          "type": "string",
          "description": "What moved, in words to tell the person."
        }
      }
    },
    "browsing": {
      "type": "boolean",
      "description": "true: answered without a contact, so fewer rows and the first pages only."
    },
    "next": {
      "type": "string",
      "description": "When browsing: how to get a quote or more rows."
    },
    "session": {
      "type": "string",
      "description": "Only on the call that created the contact: pass it from then on."
    },
    "sessionExpiresAt": {
      "type": "string",
      "description": "When that session stops working, ISO time."
    }
  },
  "required": [
    "items",
    "total"
  ]
}

One yacht: its facts and terms as the source states them (packages, included, required and optional extras, deposit, check-in days and times, stay limits, equipment, the operator's descriptions), and its availability: with from / to, that stay's status and price and, when it is not free, the nearest free stays; without dates, its free stays, soonest first. A field that is absent is one the source does not state. Works without a contact. Use it once the person picks one yacht from a search or best_deals.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Optional: the person's own email, as they gave it, for more rows a call. Leave out to browse; the site keeps it to answer their enquiry."
    },
    "phone": {
      "type": "string",
      "description": "Optional: the person's own phone, international form (+ and country code), as they gave it, for more rows a call. Leave out to browse."
    },
    "session": {
      "type": "string",
      "description": "The session an earlier answer returned. Pass it instead of email or phone from then on."
    },
    "name": {
      "type": "string",
      "description": "Optional: the person's name, as they gave it."
    },
    "id": {
      "type": "string",
      "description": "The yacht's page link (an absolute URL on this site), exactly as a search or best_deals returned it."
    },
    "from": {
      "type": "string",
      "description": "Check-in day, YYYY-MM-DD."
    },
    "to": {
      "type": "string",
      "description": "Check-out day, YYYY-MM-DD."
    },
    "party": {
      "type": "number",
      "description": "How many people."
    },
    "cursor": {
      "type": "string",
      "description": "The cursor a previous answer returned, for its next page."
    },
    "limit": {
      "type": "number",
      "description": "Rows per page: at most 10 when browsing, 20 with the person's email or phone."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "item": {
      "type": "string",
      "description": "Its name."
    },
    "href": {
      "type": "string",
      "description": "Its page on this site, absolute URL."
    },
    "facts": {
      "type": "array",
      "description": "The facts its page shows, labelled.",
      "items": {
        "type": "object",
        "description": "One fact.",
        "properties": {}
      }
    },
    "kind": {
      "type": "string",
      "description": "Its type."
    },
    "place": {
      "type": "string",
      "description": "Where it is."
    },
    "description": {
      "type": "string",
      "description": "Its description."
    },
    "packages": {
      "type": "array",
      "description": "The ways it is sold, the default first, each with its included, required and optional extras.",
      "items": {
        "type": "object",
        "description": "One package.",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "description": "Its name."
          },
          "default": {
            "type": "boolean",
            "description": "Sold this way unless asked."
          },
          "staffed": {
            "type": "boolean",
            "description": "Sold with staff as standard."
          },
          "included": {
            "type": "array",
            "description": "Included, nothing to pay.",
            "items": {
              "type": "object",
              "description": "An extra.",
              "properties": {}
            }
          },
          "required": {
            "type": "array",
            "description": "Must be paid.",
            "items": {
              "type": "object",
              "description": "An extra.",
              "properties": {}
            }
          },
          "optional": {
            "type": "array",
            "description": "The person's choice.",
            "items": {
              "type": "object",
              "description": "An extra.",
              "properties": {}
            }
          }
        }
      }
    },
    "terms": {
      "type": "object",
      "description": "Deposit, licence, stay limits, check-in days and times, as stated.",
      "properties": {}
    },
    "equipment": {
      "type": "array",
      "description": "Named equipment in groups.",
      "items": {
        "type": "object",
        "description": "A group.",
        "properties": {}
      }
    },
    "operatorDescriptions": {
      "type": "array",
      "description": "The operator's own texts and documents.",
      "items": {
        "type": "object",
        "description": "One.",
        "properties": {}
      }
    },
    "availability": {
      "type": "object",
      "description": "With dates: that stay and, when not free, the nearest free stays; without: its free stays, soonest first.",
      "properties": {
        "card": {
          "type": "object",
          "description": "Its card: name, link, photos (get keeps the gallery).",
          "properties": {}
        },
        "stay": {
          "type": "object",
          "description": "One stay of this item, read live.",
          "properties": {
            "checkIn": {
              "type": "string",
              "description": "YYYY-MM-DD."
            },
            "checkOut": {
              "type": "string",
              "description": "YYYY-MM-DD."
            },
            "nights": {
              "type": "number",
              "description": "Nights."
            },
            "status": {
              "type": "string",
              "enum": [
                "free",
                "booked",
                "not-a-check-in-day",
                "not-whole-blocks",
                "outside-calendar",
                "not-known"
              ],
              "description": "Whether it can be booked."
            },
            "price": {
              "type": "object",
              "description": "The stay's price.",
              "properties": {
                "amount": {
                  "type": "number",
                  "description": "In major units (euros, not cents)."
                },
                "currency": {
                  "type": "string",
                  "description": "ISO 4217."
                },
                "text": {
                  "type": "string",
                  "description": "The amount written out, to quote to the person."
                }
              }
            },
            "listPrice": {
              "type": "object",
              "description": "The source's list price above price, when discounted.",
              "properties": {
                "amount": {
                  "type": "number",
                  "description": "In major units (euros, not cents)."
                },
                "currency": {
                  "type": "string",
                  "description": "ISO 4217."
                },
                "text": {
                  "type": "string",
                  "description": "The amount written out, to quote to the person."
                }
              }
            },
            "discountPct": {
              "type": "number",
              "description": "The discount the source states."
            },
            "mandatoryExtras": {
              "type": "object",
              "description": "What the source says is payable on top, whatever the person picks.",
              "properties": {
                "amount": {
                  "type": "number",
                  "description": "In major units (euros, not cents)."
                },
                "currency": {
                  "type": "string",
                  "description": "ISO 4217."
                },
                "text": {
                  "type": "string",
                  "description": "The amount written out, to quote to the person."
                }
              }
            },
            "deposit": {
              "type": "object",
              "description": "The deposit held.",
              "properties": {
                "amount": {
                  "type": "number",
                  "description": "In major units (euros, not cents)."
                },
                "currency": {
                  "type": "string",
                  "description": "ISO 4217."
                },
                "text": {
                  "type": "string",
                  "description": "The amount written out, to quote to the person."
                }
              }
            },
            "checkedAt": {
              "type": [
                "string",
                "null"
              ],
              "description": "When the source was read, ISO time."
            }
          }
        },
        "freeStays": {
          "type": "array",
          "description": "Free stays, a page.",
          "items": {
            "type": "object",
            "description": "One stay of this item, read live.",
            "properties": {
              "checkIn": {
                "type": "string",
                "description": "YYYY-MM-DD."
              },
              "checkOut": {
                "type": "string",
                "description": "YYYY-MM-DD."
              },
              "nights": {
                "type": "number",
                "description": "Nights."
              },
              "status": {
                "type": "string",
                "enum": [
                  "free",
                  "booked",
                  "not-a-check-in-day",
                  "not-whole-blocks",
                  "outside-calendar",
                  "not-known"
                ],
                "description": "Whether it can be booked."
              },
              "price": {
                "type": "object",
                "description": "The stay's price.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "listPrice": {
                "type": "object",
                "description": "The source's list price above price, when discounted.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "discountPct": {
                "type": "number",
                "description": "The discount the source states."
              },
              "mandatoryExtras": {
                "type": "object",
                "description": "What the source says is payable on top, whatever the person picks.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "deposit": {
                "type": "object",
                "description": "The deposit held.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "checkedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "When the source was read, ISO time."
              }
            }
          }
        },
        "nearestFree": {
          "type": "array",
          "description": "The nearest free stays, a page.",
          "items": {
            "type": "object",
            "description": "One stay of this item, read live.",
            "properties": {
              "checkIn": {
                "type": "string",
                "description": "YYYY-MM-DD."
              },
              "checkOut": {
                "type": "string",
                "description": "YYYY-MM-DD."
              },
              "nights": {
                "type": "number",
                "description": "Nights."
              },
              "status": {
                "type": "string",
                "enum": [
                  "free",
                  "booked",
                  "not-a-check-in-day",
                  "not-whole-blocks",
                  "outside-calendar",
                  "not-known"
                ],
                "description": "Whether it can be booked."
              },
              "price": {
                "type": "object",
                "description": "The stay's price.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "listPrice": {
                "type": "object",
                "description": "The source's list price above price, when discounted.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "discountPct": {
                "type": "number",
                "description": "The discount the source states."
              },
              "mandatoryExtras": {
                "type": "object",
                "description": "What the source says is payable on top, whatever the person picks.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "deposit": {
                "type": "object",
                "description": "The deposit held.",
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "In major units (euros, not cents)."
                  },
                  "currency": {
                    "type": "string",
                    "description": "ISO 4217."
                  },
                  "text": {
                    "type": "string",
                    "description": "The amount written out, to quote to the person."
                  }
                }
              },
              "checkedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "When the source was read, ISO time."
              }
            }
          }
        },
        "party": {
          "type": "string",
          "enum": [
            "fits",
            "too-many",
            "not-checked"
          ],
          "description": "Whether the party fits."
        },
        "total": {
          "type": "number",
          "description": "How many rows match in all."
        },
        "cursor": {
          "type": [
            "string",
            "null"
          ],
          "description": "Pass as cursor for the next page; null on the last."
        }
      }
    },
    "checkedAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the source was read, ISO time."
    },
    "browsing": {
      "type": "boolean",
      "description": "true: answered without a contact, so fewer rows and the first pages only."
    },
    "next": {
      "type": "string",
      "description": "When browsing: how to get a quote or more rows."
    },
    "session": {
      "type": "string",
      "description": "Only on the call that created the contact: pass it from then on."
    },
    "sessionExpiresAt": {
      "type": "string",
      "description": "When that session stops working, ISO time."
    }
  },
  "required": [
    "item",
    "href"
  ]
}

What a stay typically costs: the range (p25, median, p75 in minor units of the currency) of open departures for a place, month and party, optionally one type, with how many items it is from, the cheapest published one that fits and when the figures were built; seasonNote says in words how another month compares. An unknown place answers with the places that have figures. Works without a contact. Use it when the person asks what a stay costs before choosing; use search_yachts for yachts free on their days.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Optional: the person's own email, as they gave it, for more rows a call. Leave out to browse; the site keeps it to answer their enquiry."
    },
    "phone": {
      "type": "string",
      "description": "Optional: the person's own phone, international form (+ and country code), as they gave it, for more rows a call. Leave out to browse."
    },
    "session": {
      "type": "string",
      "description": "The session an earlier answer returned. Pass it instead of email or phone from then on."
    },
    "name": {
      "type": "string",
      "description": "Optional: the person's name, as they gave it."
    },
    "place": {
      "type": "string",
      "description": "A country or region in words (e.g. Croatia), or a place value (country:<name>) as an invalid_place answer lists them."
    },
    "month": {
      "type": "string",
      "description": "YYYY-MM."
    },
    "party": {
      "type": "number",
      "description": "How many people."
    },
    "type": {
      "type": "string",
      "enum": [
        "catamarans",
        "gulets",
        "houseboats",
        "motorboats",
        "sailboats"
      ],
      "description": "Optional: one Yacht Types value id, the same ids yacht_types takes. Leave out for any."
    }
  },
  "required": [
    "place",
    "month",
    "party"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "place": {
      "type": "string",
      "description": "The place value answered (a place given in words, resolved)."
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217."
    },
    "items": {
      "type": "number",
      "description": "How many items the figures are from."
    },
    "range": {
      "type": [
        "object",
        "null"
      ],
      "description": "p25, p50 (median), p75 in minor units of the currency (e.g. cents); null when too few items.",
      "properties": {
        "p25": {
          "type": "number",
          "description": "Minor units."
        },
        "p50": {
          "type": "number",
          "description": "Minor units."
        },
        "p75": {
          "type": "number",
          "description": "Minor units."
        }
      }
    },
    "thin": {
      "type": "boolean",
      "description": "true: few items, a rough figure."
    },
    "cheapest": {
      "type": [
        "object",
        "null"
      ],
      "description": "The cheapest published item that fits.",
      "properties": {
        "href": {
          "type": "string",
          "description": "Its page, absolute URL."
        },
        "name": {
          "type": "string",
          "description": "Its name."
        },
        "place": {
          "type": "string",
          "description": "Where it leaves from."
        },
        "priceMinor": {
          "type": "number",
          "description": "Minor units."
        }
      }
    },
    "extrasMedianMinor": {
      "type": [
        "number",
        "null"
      ],
      "description": "The usual mandatory extras, minor units."
    },
    "seasonHint": {
      "type": [
        "object",
        "null"
      ],
      "description": "Another month against this one: pct cheaper there (negative: dearer).",
      "properties": {
        "month": {
          "type": "string",
          "description": "YYYY-MM."
        },
        "pct": {
          "type": "number",
          "description": "Percent."
        }
      }
    },
    "seasonNote": {
      "type": "string",
      "description": "The season hint in words, to tell the person."
    },
    "lastMinuteSharePct": {
      "type": [
        "number",
        "null"
      ],
      "description": "Share of soon departures discounted."
    },
    "noneFitParty": {
      "type": "boolean",
      "description": "true: no item there takes the party."
    },
    "browsing": {
      "type": "boolean",
      "description": "true: answered without a contact, so fewer rows and the first pages only."
    },
    "next": {
      "type": "string",
      "description": "When browsing: how to get a quote or more rows."
    },
    "session": {
      "type": "string",
      "description": "Only on the call that created the contact: pass it from then on."
    },
    "sessionExpiresAt": {
      "type": "string",
      "description": "When that session stops working, ISO time."
    }
  },
  "required": [
    "currency",
    "items"
  ]
}

Discounted departures of this site's yachts, read from the live inventory: only a discount the source itself states (a special, or a price under its list price), never a computed gap. By default from tomorrow to 30 days ahead; a departure the yacht's calendar shows taken is left out. One row per yacht: its page link (the id get and request_quote take) and photo (absolute URLs) and its departures, each with its dates, every route it leaves on, nights, price, list price, mandatory extras and saving, in the order asked. Narrow with the same typed filters as search. When none match, the answer is the nearest deals (the window after, the place around, a bound let go) and nearest says what was widened. Paged: total and cursor. Works without a contact (browsing: fewer rows). Use it when the person asks for deals, specials or last-minute offers; use search_yachts for given days whatever the price.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Optional: the person's own email, as they gave it, for more rows a call. Leave out to browse; the site keeps it to answer their enquiry."
    },
    "phone": {
      "type": "string",
      "description": "Optional: the person's own phone, international form (+ and country code), as they gave it, for more rows a call. Leave out to browse."
    },
    "session": {
      "type": "string",
      "description": "The session an earlier answer returned. Pass it instead of email or phone from then on."
    },
    "name": {
      "type": "string",
      "description": "Optional: the person's name, as they gave it."
    },
    "from": {
      "type": "string",
      "description": "Earliest departure, YYYY-MM-DD."
    },
    "to": {
      "type": "string",
      "description": "Latest departure, YYYY-MM-DD."
    },
    "party": {
      "type": "number",
      "description": "How many people."
    },
    "yacht_types": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "catamarans",
          "gulets",
          "houseboats",
          "motorboats",
          "sailboats"
        ]
      },
      "minItems": 1,
      "description": "Yacht Types: any of these value ids (one or more): catamarans (Catamarans, 3193); gulets (Gulets, 201); houseboats (Houseboats, 1428); motorboats (Motorboats, 1080); sailboats (Sailboats, 4577)."
    },
    "charter_types": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "all-inclusive",
          "bareboat",
          "cabin-charter",
          "crewed",
          "day-charter",
          "flotilla",
          "regatta",
          "skippered"
        ]
      },
      "minItems": 1,
      "description": "Charter Types: any of these value ids (one or more): all-inclusive (All-inclusive, 68); bareboat (Bareboat, 8797); cabin-charter (Cabin charter, 152); crewed (Crewed, 1702); day-charter (Day charter, 374); flotilla (Flotilla, 257); regatta (Regatta, 34); skippered (Skippered, 245)."
    },
    "place": {
      "type": "string",
      "description": "Where, in words or as a place id: a region, country or area, and everything in it, e.g. Mediterranean, Worldwide, Caribbean, North America, Greece, Croatia, Italy, France, Turkey, Spain, British Virgin Islands, Netherlands, Germany, Seychelles, Poland, Ireland, Martinique, United Kingdom, Belgium, Portugal, Ecuador, French Polynesia, Sweden, St. Martin, Bahamas, Malta, Montenegro, Thailand, Canada, St. Lucia, Slovenia, Norway, Guadeloupe, Brazil, Hungary, Grenada, St. Vincent, Belize, Cuba, Maldives, Mexico, Panama, Cape Verde, United Arab Emirates, Antigua and Barbuda, India, Tanzania, Egypt, Monaco, Estonia, Mauritius, New Zealand, USA, Switzerland, Fiji. An unknown place is refused; nothing there answers the nearest place around it."
    },
    "base": {
      "type": "string",
      "description": "The exact base it leaves from, in words."
    },
    "text": {
      "type": "string",
      "description": "Words in its name or model, e.g. a builder or a model name."
    },
    "lengthMin": {
      "type": "number",
      "description": "Length at least ft (on this site 13.35 to 180.45)."
    },
    "lengthMax": {
      "type": "number",
      "description": "Length at most ft (on this site 13.35 to 180.45)."
    },
    "cabinsMin": {
      "type": "number",
      "description": "Cabins at least (on this site 0 to 20)."
    },
    "cabinsMax": {
      "type": "number",
      "description": "Cabins at most (on this site 0 to 20)."
    },
    "berthsMin": {
      "type": "number",
      "description": "Berths at least (on this site 0 to 80)."
    },
    "berthsMax": {
      "type": "number",
      "description": "Berths at most (on this site 0 to 80)."
    },
    "headsMin": {
      "type": "number",
      "description": "Heads at least (on this site 0 to 23)."
    },
    "headsMax": {
      "type": "number",
      "description": "Heads at most (on this site 0 to 23)."
    },
    "beamMin": {
      "type": "number",
      "description": "Beam at least m (on this site 0.9 to 44)."
    },
    "beamMax": {
      "type": "number",
      "description": "Beam at most m (on this site 0.9 to 44)."
    },
    "draftMin": {
      "type": "number",
      "description": "Draft at least m (on this site 0.3 to 7985)."
    },
    "draftMax": {
      "type": "number",
      "description": "Draft at most m (on this site 0.3 to 7985)."
    },
    "yearMin": {
      "type": "number",
      "description": "Year at least (on this site 0 to 2028)."
    },
    "yearMax": {
      "type": "number",
      "description": "Year at most (on this site 0 to 2028)."
    },
    "fuelMin": {
      "type": "number",
      "description": "Fuel tank at least l (on this site 1 to 65000)."
    },
    "fuelMax": {
      "type": "number",
      "description": "Fuel tank at most l (on this site 1 to 65000)."
    },
    "waterMin": {
      "type": "number",
      "description": "Water tank at least l (on this site 1 to 60000)."
    },
    "waterMax": {
      "type": "number",
      "description": "Water tank at most l (on this site 1 to 60000)."
    },
    "priceMin": {
      "type": "number",
      "description": "The least to pay, in the site currency: the price plus the mandatory extras."
    },
    "priceMax": {
      "type": "number",
      "description": "The most to pay, in the site currency: the price plus the mandatory extras."
    },
    "sort": {
      "type": "string",
      "enum": [
        "saving",
        "departure",
        "price",
        "length",
        "cabins",
        "berths",
        "heads",
        "beam",
        "draft",
        "year",
        "fuel",
        "water"
      ],
      "description": "saving (default, biggest first), departure (soonest first), price (cheapest first), or length (length, biggest first), cabins (cabins, biggest first), berths (berths, biggest first), heads (heads, biggest first), beam (beam, biggest first), draft (draft, biggest first), year (year, biggest first), fuel (fuel tank, biggest first), water (water tank, biggest first)."
    },
    "cursor": {
      "type": "string",
      "description": "The cursor a previous answer returned, for its next page."
    },
    "limit": {
      "type": "number",
      "description": "Rows per page: at most 10 when browsing, 20 with the person's email or phone."
    }
  },
  "required": [],
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "rows": {
      "type": "array",
      "description": "One page of deals, one row per item with its departures.",
      "items": {
        "type": "object",
        "description": "One item.",
        "properties": {
          "item": {
            "type": "string",
            "description": "Its name."
          },
          "type": {
            "type": [
              "string",
              "null"
            ],
            "description": "Its type."
          },
          "base": {
            "type": [
              "string",
              "null"
            ],
            "description": "Its home base."
          },
          "guests": {
            "type": [
              "number",
              "null"
            ],
            "description": "How many it takes."
          },
          "link": {
            "type": "string",
            "description": "Its page, absolute URL: the id get and request_quote take."
          },
          "photo": {
            "type": [
              "string",
              "null"
            ],
            "description": "One photo, absolute URL."
          },
          "departures": {
            "type": "array",
            "description": "Its discounted departures in the window, in the order asked.",
            "items": {
              "type": "object",
              "description": "One departure at one price.",
              "properties": {
                "routes": {
                  "type": "array",
                  "description": "Every route it leaves on at this price.",
                  "items": {
                    "type": "object",
                    "description": "A route.",
                    "properties": {
                      "from": {
                        "type": "string",
                        "description": "Leaves from."
                      },
                      "to": {
                        "type": "string",
                        "description": "Ends at."
                      }
                    }
                  }
                },
                "departFrom": {
                  "type": "string",
                  "description": "YYYY-MM-DD."
                },
                "departTo": {
                  "type": "string",
                  "description": "YYYY-MM-DD."
                },
                "nights": {
                  "type": "number",
                  "description": "Nights."
                },
                "price": {
                  "type": "object",
                  "description": "An amount in the site currency.",
                  "properties": {
                    "amount": {
                      "type": "number",
                      "description": "In major units (euros, not cents)."
                    },
                    "currency": {
                      "type": "string",
                      "description": "ISO 4217."
                    },
                    "text": {
                      "type": "string",
                      "description": "The amount written out, to quote to the person."
                    }
                  }
                },
                "listPrice": {
                  "type": "object",
                  "description": "An amount in the site currency.",
                  "properties": {
                    "amount": {
                      "type": "number",
                      "description": "In major units (euros, not cents)."
                    },
                    "currency": {
                      "type": "string",
                      "description": "ISO 4217."
                    },
                    "text": {
                      "type": "string",
                      "description": "The amount written out, to quote to the person."
                    }
                  }
                },
                "mandatoryExtras": {
                  "type": "object",
                  "description": "What the departure states is payable on top.",
                  "properties": {
                    "amount": {
                      "type": "number",
                      "description": "In major units (euros, not cents)."
                    },
                    "currency": {
                      "type": "string",
                      "description": "ISO 4217."
                    },
                    "text": {
                      "type": "string",
                      "description": "The amount written out, to quote to the person."
                    }
                  }
                },
                "savingPct": {
                  "type": "number",
                  "description": "The discount the source states."
                },
                "kind": {
                  "type": "string",
                  "description": "special or offer."
                }
              }
            }
          }
        }
      }
    },
    "total": {
      "type": "number",
      "description": "How many rows match in all."
    },
    "cursor": {
      "type": [
        "string",
        "null"
      ],
      "description": "Pass as cursor for the next page; null on the last."
    },
    "from": {
      "type": "string",
      "description": "The window's first day."
    },
    "through": {
      "type": "string",
      "description": "Its last day."
    },
    "checkedAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the offers were read, ISO time."
    },
    "notApplied": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "A wish."
      },
      "description": "What could not narrow the deals."
    },
    "nearest": {
      "type": "object",
      "description": "Only when nothing matched exactly: these rows are the nearest match.",
      "properties": {
        "widened": {
          "type": "string",
          "enum": [
            "dates",
            "base",
            "place",
            "ranges",
            "price",
            "discount"
          ],
          "description": "The one thing let go."
        },
        "note": {
          "type": "string",
          "description": "What moved, in words to tell the person."
        }
      }
    },
    "browsing": {
      "type": "boolean",
      "description": "true: answered without a contact, so fewer rows and the first pages only."
    },
    "next": {
      "type": "string",
      "description": "When browsing: how to get a quote or more rows."
    },
    "session": {
      "type": "string",
      "description": "Only on the call that created the contact: pass it from then on."
    },
    "sessionExpiresAt": {
      "type": "string",
      "description": "When that session stops working, ISO time."
    }
  },
  "required": [
    "rows",
    "total"
  ]
}

Ask this site's desk for a formal quote on one or more yachts, for the person. Pass the page links a search, best_deals or get returned, the days and the party, and anything the person wants the desk to know. The desk answers with a written quote to the person's own email or phone, with every cost on it; this answer only says it was received and where the quote goes. Nothing is booked or paid: the person confirms the booking with the desk. Ask the person before calling it.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The person's own email, as they gave it: the quote is sent there. This, phone or session is needed."
    },
    "phone": {
      "type": "string",
      "description": "The person's own phone, international form (+ and country code), as they gave it. This, email or session is needed."
    },
    "session": {
      "type": "string",
      "description": "The session an earlier answer returned. Pass it instead of email or phone."
    },
    "name": {
      "type": "string",
      "description": "Optional: the person's name, as they gave it."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 20,
      "description": "The yacht page links to quote (absolute URLs on this site), exactly as a search, best_deals or get returned them. At most 20."
    },
    "from": {
      "type": "string",
      "description": "Check-in day, YYYY-MM-DD."
    },
    "to": {
      "type": "string",
      "description": "Check-out day, YYYY-MM-DD."
    },
    "party": {
      "type": "number",
      "description": "How many people."
    },
    "notes": {
      "type": "string",
      "description": "What the person wants the desk to know, in their words (at most 2000 characters)."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "received",
        "already_received"
      ],
      "description": "received: the desk has the request; already_received: this session asked the same in the last day."
    },
    "enquiryRef": {
      "type": "string",
      "description": "The request's reference, returned once."
    },
    "nextStep": {
      "type": "string",
      "description": "Where the written quote goes, in words to tell the person."
    },
    "session": {
      "type": "string",
      "description": "Only on the call that created the contact: pass it from then on."
    },
    "sessionExpiresAt": {
      "type": "string",
      "description": "When that session stops working, ISO time."
    }
  },
  "required": [
    "status",
    "nextStep"
  ]
}