# Vimeo Video Downloader (`epctex/vimeo-video-downloader`) Actor

Download videos from Vimeo without any limits!

- **URL**: https://apify.com/epctex/vimeo-video-downloader.md
- **Developed by:** [epctex](https://apify.com/epctex) (community)
- **Categories:** Videos, Social media
- **Stats:** 207 total users, 15 monthly users, 99.0% runs succeeded, 10 bookmarks
- **User rating**: 5.00 out of 5 stars

## Pricing

from $2.50 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Actor - Vimeo Video Downloader

### Vimeo Video Downloader

Since Vimeo doesn't provide a good and free API, this actor should help you to download videos from Vimeo.com

The Vimeo Video Downloader supports the following features:

- Download Video - If you want to get videos on a certain URL, just type the URL.

### Bugs, fixes, updates, and changelog

This scraper is under active development. If you have any feature requests you can create an issue from [here](https://github.com/epctex-support/vimeo-video-downloader/issues).

### Input Parameters

The input of this scraper should be JSON containing the list of pages on Vimeo.com that should be visited. Required fields are:

- `startUrls`: (Optional) (Array) List of Vimeo URLs. You should only provide post URLs.

- `quality`: (Optional) (String) Select the video quality. You can use `highest`, `medium`, and `lowest`.

- `useProxyForDownload`: (Optional) (Boolean) Enable or disable proxy usage for video downloads. When set to `true`, the downloader will use a proxy server for downloading videos. Default is `true`.

- `proxy`: (Required) (Proxy Object) Proxy configuration.

- `extendOutputFunction`: (Optional) (String) Function that takes a JQuery handle ($) as an argument and returns an object with data.

- `customMapFunction`: (Optional) (String) Function that takes each object's handle as an argument and returns the object with executing the function.

This solution requires using **Residential Proxy servers**, either your own proxy servers or you can use [Apify Proxy](https://www.apify.com/docs/proxy).

#### Tips

- You must use a residential proxy to fetch videos.

- When you want to scrape over a specific list URL, just copy and paste the link as one of the **startUrl**.

#### Compute Unit Consumption

The actor is optimized to run blazing fast and scrape as many items as possible. Therefore, it forefronts all the detailed requests. If the actor doesn't block very often it'll scrape 1 video under 45 seconds with ~0.01-0.02 compute units.

#### Vimeo Video Downloader Input example

```json
{
  "startUrls": [
    "https://vimeo.com/693117164"
  ],
  "quality": "medium",
  "proxy": {
    "useApifyProxy": true
  }
}
```

### During the Run

During the run, the actor will output messages letting you know what is going on. Each message always contains a short label specifying which page from the provided list is currently specified.
When items are loaded from the page, you should see a message about this event with a loaded item count and total item count for each page.

If you provide incorrect input to the actor, it will immediately stop with a failure state and output an explanation of what is wrong.

### Vimeo Video Downloader Export

During the run, the actor stores results into a dataset. Each item is a separate item in the dataset.

You can manage the results in any language (Python, PHP, Node JS/NPM). See the FAQ or <a href="https://www.apify.com/docs/api" target="blank">our API reference</a> to learn more about getting results from Vimeo Video Downloader.

The structure of each item in Vimeo looks like this:

#### Item Detail

```json
{
	"sourceUrl": "https://player.vimeo.com/video/731185961",
	"downloadUrl": "https://api.apify.com/v2/key-value-stores/d6179b2c-fd6d-4be0-8fa8-3b421044f2af/records/bac2c55506fe79014c959f0ba41d0aa4"
}
```

### Contact

Please visit us through [epctex.com](https://epctex.com) to see all the products that are available for you. If you are looking for any custom integration or so, please reach out to us through the chat box in [epctex.com](https://epctex.com). In need of support? <business@epctex.com> is at your service.

# Actor input Schema

## `startUrls` (type: `array`):

URLs to start with. They should be list or detail URL

## `startUrlsWithPassword` (type: `array`):

URLs that are behind a password. They should be video URLs.

## `quality` (type: `string`):

Select the quality

## `useProxyForDownload` (type: `boolean`):

Use a proxy when downloading videos.

## `proxy` (type: `object`):

Select proxies to be used by your crawler.

## Actor input object example

```json
{
  "startUrls": [
    "https://vimeo.com/693117164"
  ],
  "startUrlsWithPassword": [
    {
      "url": "https://vimeo.com/693117164",
      "password": ""
    }
  ],
  "quality": "medium",
  "useProxyForDownload": true,
  "proxy": {
    "useApifyProxy": true
  }
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "startUrls": [
        "https://vimeo.com/693117164"
    ],
    "startUrlsWithPassword": [
        {
            "url": "https://vimeo.com/693117164",
            "password": ""
        }
    ],
    "quality": "medium",
    "proxy": {
        "useApifyProxy": true
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("epctex/vimeo-video-downloader").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "startUrls": ["https://vimeo.com/693117164"],
    "startUrlsWithPassword": [{
            "url": "https://vimeo.com/693117164",
            "password": "",
        }],
    "quality": "medium",
    "proxy": { "useApifyProxy": True },
}

# Run the Actor and wait for it to finish
run = client.actor("epctex/vimeo-video-downloader").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "startUrls": [
    "https://vimeo.com/693117164"
  ],
  "startUrlsWithPassword": [
    {
      "url": "https://vimeo.com/693117164",
      "password": ""
    }
  ],
  "quality": "medium",
  "proxy": {
    "useApifyProxy": true
  }
}' |
apify call epctex/vimeo-video-downloader --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,epctex/vimeo-video-downloader"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/OjqxdbcTZmjv4F7yf/builds/vd1yQBhGpiUP6C7i2/openapi.json