What you get#
Onekey exposes Vimeo as 8 endpoints behind one API key: 4 endpoints return one record (data is an object) and 4 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Vimeo also works for the rest of the video & streaming category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
album_videos | Videos in a Vimeo album/showcase by numeric id. | album* | 5 | stable |
channel | Vimeo channel info: name, description, video and subscriber counts. | channel* | 1 | stable |
channel_videos | Videos in a Vimeo channel (latest page). | channel* | 5 | stable |
oembed | Vimeo oEmbed for a public video: title, author, thumbnail, duration, description. | id* | 1 | stable |
user | Vimeo user profile: name, bio, location, video/contact counts, avatar. | user* | 1 | stable |
user_likes | Videos a Vimeo user has liked (latest page). | user* | 5 | stable |
user_videos | Public videos uploaded by a Vimeo user (latest page). | user* | 5 | stable |
video | Vimeo video details: title, owner, plays, likes, comments, duration. | id* | 1 | stable |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls vimeo.channel (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/vimeo/channel?channel=staffpicks" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Vimeo, with the same names as on every other platform. The count is how many of its 8 mapped endpoints return the field; a field the source lacks is null, never missing. 2 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
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 |
The full schema is in Unified schema.
Pricing#
Vimeo calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.