# Vrbo quote: `POST /v1/ota/vrbo`

Cost: 12 credits (12 (failed requests are free)). Docs: https://scrapercompany.com/docs/reference/vrbo-quote

A Vrbo stay quote: nightly and total price, fees and payment model.

The total is Vrbo's own figure and `fees_included` repeats its "All fees
included" label; Vrbo does not itemise cleaning and service fees and
taxes there, so they are not invented here. A stay Vrbo
will not sell as asked (minimum stay, dates taken) returns
`available: false` with Vrbo's reason, billed like any other answer.

Request body (JSON):

- `property_id` (string | null; optional; pattern ^\d+$): Numeric id returned by `POST /v1/ota/vrbo/search` (`property_id` on each listing). Not the id in the Vrbo URL.
- `listing_id` (string | null; optional; pattern ^\d+(?:ha)?$): The listing id in a Vrbo URL, e.g. `20218736ha` for `vrbo.com/20218736ha`. Resolved to `property_id` with one page load.
- `check_in` (string (date); required): First night of the stay, `YYYY-MM-DD`.
- `check_out` (string (date) | null; optional): Departure date. An alternative to `nights` — if both are given, this wins.
- `nights` (integer; optional; default 1; min 1, max 28): Length of stay. Ignored when `check_out` is supplied.
- `adults` (integer; optional; default 2; min 1, max 16): Guests (adults).
- `market` (string; optional; default US; one of US): Vrbo point-of-sale. Only `US` (www.vrbo.com, USD) is verified.
- `retry_min_stay` (boolean; optional; default false): When the source answers `availability: min_stay`, price that minimum stay once more and return it as `property.min_stay_quote` (its own dates, nights and provenance). The stay you asked for is never replaced. One extra upstream call, only when a minimum stay applies.

Response fields:

- `search_parameters` (object; required)
  - `search_parameters.engine` (string; required; one of vrbo_property)
  - `search_parameters.property_id` (string; required): The property id quoted (resolved from `listing_id` when only that was sent).
  - `search_parameters.listing_id` (string; optional): Present only when `listing_id` was supplied.
  - `search_parameters.check_in_date` (string (date); required)
  - `search_parameters.check_out_date` (string (date); required)
  - `search_parameters.adults` (integer; required)
  - `search_parameters.market` (string; required): `US`.
  - `search_parameters.currency` (string; required): The market's currency (`USD`).
- `property` (object; required)
  - `property.property_id` (string; required): Numeric Vrbo property id; store it to skip listing resolution next time.
  - `property.listing_id` (string | null; required): The `listing_id` you sent, echoed; null when you sent only `property_id`. When both are sent, `property_id` is used and the two are not cross-checked.
  - `property.total` (number | null; required): Headline stay total for all nights (Vrbo's own figure); see `basis`. Null when nothing priced.
  - `property.price_per_night` (number | null; required): Headline nightly price.
  - `property.basis` (string | null; required; one of sticky_bar, cheapest_offer): Where the headline comes from: `sticky_bar` (the page's own headline price, read by its labels) or `cheapest_offer` (the cheapest priced offer). Null when nothing priced.
  - `property.total_text` (string; required): Headline total as displayed; empty when not shown.
  - `property.nightly_text` (string; required): Headline nightly price as displayed; empty when not shown.
  - `property.taxes_and_fees_included` (boolean | null; required): True when the headline total is labelled "with taxes and fees"; null when no such label was shown.
  - `property.fees_included` (boolean | null; required): True when the headline total is labelled "All fees included"; null when no such label was shown.
  - `property.currency` (string; required): Currency the point-of-sale actually priced in.
  - `property.currency_verified` (boolean; required): Whether `currency` equals the market's currency.
  - `property.available` (boolean; required): False when Vrbo will not sell the stay as asked.
  - `property.unavailable_reason` (string | null; required): Vrbo's own message when the stay cannot be booked (minimum stay, dates taken). Null otherwise; `available` can be false with a null reason when nothing priced.
  - `property.payment_model` (string | null; required; one of PAY_NOW, PAY_LATER, PAY_LATER_WITH_DEPOSIT, ): `payment_model` of the cheapest offer; null when nothing priced.
  - `property.provenance` (object; required): Where, when and how one normalized price was observed.
- `offers` (array of object; required): Every rate plan for the rental.
  - `offers[].plan_id` (string; required): Vrbo rate-plan id.
  - `offers[].room_type_id` (string; required)
  - `offers[].total` (number | null; required): Stay total for all nights, Vrbo's own figure; `fees_included` repeats its "All fees included" label. Cleaning and service fees and taxes are not itemised.
  - `offers[].nightly` (number | null; required): Vrbo's nightly price.
  - `offers[].taxes_and_fees` (number | null; required): Derived, not read from the source: `total - nightly × nights`, set only when `taxes_and_fees_included` is true. Accurate to within `nights` currency units because `nightly` is rounded; taxes and fees are not itemised. See `taxes_and_fees_provenance`.
  - `offers[].currency` (string; required): ISO 4217 code read back from the reply.
  - `offers[].total_text` (string; required): Total as displayed, e.g. `$635 total`.
  - `offers[].nightly_text` (string; required): Nightly price as displayed, e.g. `$509 nightly`.
  - `offers[].taxes_and_fees_included` (boolean | null; required): True when the source labels the total "Total with taxes and fees". Null means no such label was shown, not that taxes are excluded.
  - `offers[].fees_included` (boolean | null; required): True when the source labels the total "All fees included". Null means no such label was shown.
  - `offers[].payment_model` (string; required; one of PAY_NOW, PAY_LATER, PAY_LATER_WITH_DEPOSIT, ): `PAY_NOW`, `PAY_LATER` or `PAY_LATER_WITH_DEPOSIT`; empty when not stated. A plan sold both ways is two offers.
  - `offers[].hotel_collect` (boolean | null; required): True when the property collects payment; null when not stated.
  - `offers[].member_only` (boolean; required): True when booking the plan requires signing in as a member.
  - `offers[].refundable` (boolean | null; required): Always null on Vrbo: refundability is not read, rather than guessed.
  - `offers[].cancellation_text` (string; required): Always empty on Vrbo.
  - `offers[].extras` (string | null; required): Always null on Vrbo.
  - `offers[].extras_text` (string; required): Always empty on Vrbo.
  - `offers[].strikeout_text` (string; required): Struck-through comparison price as displayed; empty when none.
  - `offers[].inventory_type` (string; required): Source inventory type, e.g. `MERCHANT`, `TRIPCOM`, `DIRECT_AGENCY`, `VRBO`; empty when not stated.
  - `offers[].business_model` (string; required): `EXPEDIA_COLLECT` or `HOTEL_COLLECT`; empty when not stated.
  - `offers[].messages` (array of string; required): Vrbo's highlighted messages for the plan, e.g. `Reserve now, pay deposit`, `Your dates are available`.
  - `offers[].provenance` (object; required): Where, when and how one normalized price was observed.
  - `offers[].taxes_and_fees_provenance` (object | null; required): Provenance of `taxes_and_fees` (`price_basis: taxes_and_fees_combined`, `derivation: total_minus_nightly_times_nights`); null when `taxes_and_fees` is null.
- `meta` (object; required)
  - `meta.source` (string; required; one of vrbo)
  - `meta.collection_id` (string; required)
  - `meta.observed_at` (string; required)
  - `meta.nights` (integer; required)
  - `meta.elapsed_s` (number; required)
  - `meta.listing_resolved` (boolean; required): True when `listing_id` was resolved to `property_id` in this call.

Base URL: `https://api.scrapercompany.com`. Auth: send your key in the `x-api-key` header. A failed request (4xx or 5xx) or an empty result costs 0 credits.

- [Full API reference as one Markdown file](https://scrapercompany.com/llms-full.txt)
- [OpenAPI spec](https://scrapercompany.com/openapi.json)
