Per-date availability and stay rules for one rental API reference

Each date says whether it is available, whether a stay may start (checkin_allowed) or end (checkout_allowed) on it with Vrbo's reason when not (checkin_rule: not_available, min_prior_notification, changeover_exclusion, ...), and the minimum and maximum stay starting that day. An unavailable date is only that: Vrbo does not say whether a guest booked it or the owner blocked it.

One request. include_prices=true uses the date picker's data instead and adds its nightly figure per date, labelled indicative: those prices are not quotes and do not match POST /v1/ota/vrbo for the same stay.

Answers are cached for 3 hours (meta.cached). 3 credits (5 with include_prices or more than 12 months); a listing_id or url adds 24 the first time it is resolved. Failures are free.

Request

POSThttps://api.scrapercompany.com/v1/ota/vrbo/calendar

Authenticate with your API key in the x-api-key header (see Authentication).

Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.

Body

JSON object. Unknown fields are rejected with 422.

property_idstring | nullpattern ^\d+$
Numeric id returned by POST /v1/ota/vrbo/search (property_id on each listing). Not the id in the Vrbo URL.
listing_idstring | nullpattern ^\d+(?:ha)?$
The listing id in a Vrbo URL, e.g. 20218736ha for vrbo.com/20218736ha. Resolved to property_id with one page load.
urlstring | nullmax length 2000
A Vrbo listing URL, e.g. https://www.vrbo.com/20218736ha. Its listing id is resolved like listing_id.
start_datestring (date) | null
First date of the calendar (default today). Not in the past.
monthsintegerdefault 12min 1, max 24
Months of dates from start_date (default 12, at most 24: Vrbo's calendar reaches about 730 days ahead). More than 12 months costs more credits.
include_pricesbooleandefault false
Add Vrbo's date-picker nightly price to each date. These are indicative, not quotes: they do not match the stay price POST /v1/ota/vrbo returns. Costs more credits.
marketstringdefault US
Vrbo point-of-sale. Only US (www.vrbo.com, USD) is verified.
One ofUS

Example request

curl -X POST "https://api.scrapercompany.com/v1/ota/vrbo/calendar" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

200 — Per-date availability and stay rules (parsed from a live capture of 122942416 on 2026-10-20, trimmed to three dates). `available: false` means Vrbo will not sell the date; it does not say why. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response

{
  "property": {
    "property_id": "122942416",
    "calendar_start": "2027-01-21",
    "calendar_end": "2028-01-20",
    "available_by_default": false,
    "default_min_stay": 1,
    "default_max_stay": 999,
    "stay_increment_days": 1
  },
  "summary": {
    "days": 365,
    "available_days": 357,
    "unavailable_days": 8,
    "checkin_days": 353,
    "checkout_days": 365
  },
  "calendar": [
    {
      "date": "2027-01-21",
      "available": true,
      "checkin_allowed": false,
      "checkout_allowed": true,
      "checkin_rule": "min_prior_notification",
      "checkout_rule": "valid",
      "min_stay": 2,
      "max_stay": 357
    },
    {
      "date": "2027-01-22",
      "available": true,
      "checkin_allowed": true,
      "checkout_allowed": true,
      "checkin_rule": "valid",
      "checkout_rule": "valid",
      "min_stay": 2,
      "max_stay": 356
    }
  ],
  "search_parameters": {
    "engine": "vrbo_calendar",
    "property_id": "122942416",
    "start_date": "2027-01-21",
    "end_date": "2028-01-20",
    "months": 12,
    "include_prices": false,
    "market": "US"
  },
  "meta": {
    "source": "vrbo",
    "market": "US",
    "priced": false,
    "collection_id": "ratecol_0123456789abcdef0123456789abcdef",
    "observed_at": "2026-08-07T01:23:45.678Z",
    "upstream_elapsed_s": 0.62,
    "cached": false,
    "listing_resolved": false,
    "elapsed_s": 0.66
  }
}

Arrays are shortened to their first items.

Errors

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

Status	Meaning	Retry?
`401`Unauthorized	Missing or invalid API key. `{"detail":"missing or invalid API key"}`	No, fix the request
`402`Payment Required	Not enough credits for this request: the account's credits mode is `enforce` (`mode` in `GET /v1/billing`) and the request costs more than the available credits. Nothing is run or charged. `{"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."}`	No, fix the request
`404`Not Found	The property, stay, job or record was not found. `{"detail":"job not found"}`	No, fix the request
`422`Unprocessable Content	Request validation failed. `detail` is a list of problems for schema errors, or a string for semantic checks performed by the endpoint. `{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}`	No, fix the request
`429`Too Many Requests	Too many requests: the key's requests-per-minute limit was exceeded, or (in `enforce` credits mode) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry. `{"detail":"rate limit 60/min exceeded"}`	Yes, with backoff
`502`Bad Gateway	The upstream source failed, blocked the request or returned an unusable answer. Safe to retry later; failed requests are not charged. `{"detail":"RuntimeError"}`	Yes, with backoff
`503`Service Unavailable	Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later. `{"detail":"database unavailable: OperationalError"}`	Yes, with backoff

Try it

Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.

Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? start a free trial).
Copy the cURL example above and run it in a terminal.

Credits

3 credits per successful call. Failed, blocked and empty results are free.

Request#

Body#

Example request#

Response#

Errors#

Try it#