# Vimeo Video Search API Documentation

Search public Vimeo videos by query: total result count, the current page, per-page size, a has_more flag driven by the upstream paging signal, and each result with id, title, description (HTML plus plain text), duration, url and thumbnails (list of width, height and url). A valid empty result (total 0) is a successful response.

- **Documentation:** [https://scrappa.co/docs/vimeo-api/vimeo_search](https://scrappa.co/docs/vimeo-api/vimeo_search)
- **API group:** Vimeo API
- **Endpoint:** `GET https://scrappa.co/api/vimeo/search`

## 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 |
| --- | --- | --- | --- |
| `q` | string | Yes | Search query. Example: cats. |
| `page` | integer | No | 1-based page number. Defaults to 1. |
| `per_page` | integer | No | Results per page (max 100). Defaults to 10. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/vimeo/search?q=cats&page=1&per_page=10"
```

## Example response

```json
{
    "success": true,
    "data": {
        "total": 62441,
        "page": 1,
        "per_page": 10,
        "has_more": true,
        "results": [
            {
                "id": 158044944,
                "title": "Cats",
                "description": "Me feeding cats",
                "description_plain": "Me feeding cats",
                "duration": 14,
                "url": "https://vimeo.com/158044944",
                "thumbnails": [
                    {
                        "width": 100,
                        "height": 75,
                        "url": "https://i.vimeocdn.com/video/1234567890_100x75.jpg"
                    },
                    {
                        "width": 640,
                        "height": 480,
                        "url": "https://i.vimeocdn.com/video/1234567890_640x480.jpg"
                    }
                ]
            }
        ]
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | The q parameter is missing or empty. This response is not billable. |
| 503 | Upstream Unavailable | The Vimeo API is temporarily unavailable. 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)