# Vimeo on Onekey

> 8 endpoints for Vimeo (8 stable, 0 beta), 1 to 5 credits each. Category: Video & streaming. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/vimeo
Reference (Markdown): https://onekey.dev/docs/api/vimeo.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 8 mapped Vimeo endpoints return each:

- `author.displayName` (string): 7
- `author.url` (URL): 7
- `content.createdAt` (ISO 8601 date): 7
- `content.text` (string): 7
- `author.id` (string): 6
- `content.id` (string): 6
- `content.title` (string): 6
- `media.durationSeconds` (number): 6
- `media.thumbnailUrl` (URL): 6
- `content.url` (URL): 5
- `author.avatarUrl` (URL): 1
- `author.contentCount` (integer): 1
- `author.followers` (integer): 1
- `entity.createdAt` (ISO 8601 date): 1
- `entity.description` (string): 1
- `entity.id` (string): 1
- `entity.name` (string): 1
- `entity.stats.itemCount` (integer): 1
- `entity.url` (URL): 1
- plus 2 platform-specific fields under `ext.`

## Endpoints

### vimeo.album_videos

Videos in a Vimeo album/showcase by numeric id.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/vimeo/album_videos?album=1` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `album` (string, required): Vimeo album id
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.id`, `author.displayName`, `author.url`, `media.durationSeconds`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/vimeo/album_videos.md

### vimeo.channel

Vimeo channel info: name, description, video and subscriber counts.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/vimeo/channel?channel=staffpicks` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `channel` (string, required): Vimeo channel slug, e.g. staffpicks
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.url`, `entity.stats.itemCount`, `entity.createdAt`, `ext.subscribers`
- Reference: https://onekey.dev/docs/api/vimeo/channel.md

### vimeo.channel_videos

Videos in a Vimeo channel (latest page).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/vimeo/channel_videos?channel=staffpicks` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `channel` (string, required): Vimeo channel slug
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.id`, `author.displayName`, `author.url`, `media.durationSeconds`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/vimeo/channel_videos.md

### vimeo.oembed

Vimeo oEmbed for a public video: title, author, thumbnail, duration, description.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/vimeo/oembed?id=22439234` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Vimeo video id
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `author.displayName`, `author.url`, `media.durationSeconds`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/vimeo/oembed.md

### vimeo.user

Vimeo user profile: name, bio, location, video/contact counts, avatar.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/vimeo/user?user=staff` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `user` (string, required): Vimeo username/slug, e.g. staff
- Fields returned: `author.id`, `author.displayName`, `content.text`, `author.url`, `content.createdAt`, `author.followers`, `author.contentCount`, `author.avatarUrl`, `ext.location`
- Reference: https://onekey.dev/docs/api/vimeo/user.md

### vimeo.user_likes

Videos a Vimeo user has liked (latest page).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/vimeo/user_likes?user=staff` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `user` (string, required): Vimeo username/slug, e.g. staff
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.id`, `author.displayName`, `author.url`, `media.durationSeconds`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/vimeo/user_likes.md

### vimeo.user_videos

Public videos uploaded by a Vimeo user (latest page).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/vimeo/user_videos?user=staff` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `user` (string, required): Vimeo username/slug, e.g. staff
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.id`, `author.displayName`, `author.url`, `media.durationSeconds`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/vimeo/user_videos.md

### vimeo.video

Vimeo video details: title, owner, plays, likes, comments, duration.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/vimeo/video?id=76979871` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Vimeo video id
- Fields returned: `content.id`, `content.title`, `content.text`, `content.url`, `content.createdAt`, `author.id`, `author.displayName`, `author.url`, `media.durationSeconds`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/vimeo/video.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/vimeo/channel?channel=staffpicks" \
  -H "x-api-key: YOUR_API_KEY"
```