# Vrbo Filters API Documentation

<p>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.</p>

- **Documentation:** [https://scrappa.co/docs/vrbo-api/vrbo_filters](https://scrappa.co/docs/vrbo-api/vrbo_filters)
- **API group:** Vrbo API
- **Endpoint:** `GET https://scrappa.co/api/vrbo/filters`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `destination` | string | No | 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. |
| `region_id` | string | No | Numeric region_id from /api/vrbo/destinations. Example: 2297. |
| `map_bounds` | string | No | Map area as south,west,north,east in decimal degrees. Example: 25.70,-80.30,25.80,-80.10. |
| `check_in` | string | No | Check-in date, YYYY-MM-DD. Default: 30 days from today. |
| `check_out` | string | No | Check-out date, YYYY-MM-DD. Default: 3 nights after check-in. |
| `adults` | integer | No | Number of adults, 1-20. Default: 2. |
| `children` | string | No | Comma separated child ages, up to 8. Example: 5,9. |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | Vrbo has no property for this property_id. This response is not billable. |
| 422 | Validation Error | A parameter is missing or invalid. No upstream request is made. This response is not billable. |
| 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. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
