Skip to content
Scrappa Get API key
Vrbo API 1 credit/request

Vrbo Filters API Documentation

GET https://scrappa.co/api/vrbo/filters

Read the live filter and sort options Vrbo offers for a search area. Each filter has an id, a label and its option values, for example property_type with house and villa. Use the option values in the search endpoint. The options can change with the destination and dates.

Vrbo Filters API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/vrbo/filters
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "data": {
        "filters": [
            {
                "id": "property_type_group",
                "type": "multi",
                "label": "Property type",
                "options": [
                    {
                        "group": "property_type_group",
                        "label": "House (901)",
                        "value": "house",
                        "description": "Entire house"
                    }
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

This endpoint has no required query parameters.

7 optional filters available.

destination string Optional

Place name. Vrbo picks the best match. Use region_id for an exact place. If you send both, take both from the same /api/vrbo/destinations result. Example: Miami.

Example value example
region_id string Optional

Numeric region_id from /api/vrbo/destinations. Example: 2297.

Example value 1234567890
map_bounds string Optional

Map area as south,west,north,east in decimal degrees. Example: 25.70,-80.30,25.80,-80.10.

Example value example
check_in string Optional

Check-in date, YYYY-MM-DD. Default: 30 days from today.

Example value example
check_out string Optional

Check-out date, YYYY-MM-DD. Default: 3 nights after check-in.

Example value example
adults integer Optional

Number of adults, 1-20. Default: 2.

Example value 10
children string Optional

Comma separated child ages, up to 8. Example: 5,9.

Example value example

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "filters": [
            {
                "id": "property_type_group",
                "type": "multi",
                "label": "Property type",
                "options": [
                    {
                        "group": "property_type_group",
                        "label": "House (901)",
                        "value": "house",
                        "description": "Entire house"
                    }
                ]
            },
            {
                "id": "bedroom_count_gt",
                "max": 50,
                "min": 0,
                "step": 1,
                "type": "step",
                "label": "Minimum bedrooms",
                "options": []
            }
        ],
        "sort_options": [
            {
                "label": "Price: low to high",
                "value": "PRICE_LOW_TO_HIGH",
                "default": false
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "filter_catalogue"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

404

Not Found

Vrbo has no property for this property_id. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested Vrbo property was not found."
    },
    "success": false
}
422

Validation Error

A parameter is missing or invalid. No upstream request is made. This response is not billable.

{
    "errors": {
        "check_in": [
            "The check in field is required."
        ]
    },
    "message": "The request validation failed"
}
503

Vrbo Temporarily Unavailable

Vrbo did not answer in time or the request was blocked. Retry after a short pause. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Vrbo is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.