# vimeo.user

**stable** **Standard**

Vimeo user profile: name, bio, location, video/contact counts, avatar.

`GET /v1/vimeo/user`

## What you get

One Vimeo record in Onekey's unified shape, in `data`. If the record does not exist you get a `404 not_found` and are not charged.

## What it costs

- **Standard · 1 credit** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `user` | string | yes | (required) | Vimeo username/slug, e.g. staff | max 60 chars; must match `[A-Za-z0-9_\-]{1,60}`; trimmed, leading @ removed |

## Request

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

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/vimeo/user",
    params={"user": "staff"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ user: "staff" });
const res = await fetch(`https://api.onekey.dev/v1/vimeo/user?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real Vimeo response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": {
    "author": {
      "id": "152184",
      "displayName": "Vimeo",
      "url": "https://vimeo.com/staff",
      "followers": 113,
      "contentCount": 811,
      "avatarUrl": "https://i.vimeocdn.com/portrait/121863746_100x100?subrect=0%2C0%2C344%2C344&r=cover&sig=54c2fef7b23ff87b9fbff04008bce0bee1125865ef62aa056299edb1cce3e0c4&v=1&region=us"
    },
    "content": {
      "text": "Vimeo is the world's most innovative video experience platform. We enable anyone to create high-quality video experiences to better connect and bring ideas to life. We proudly serve our community of millions of users – from creative storytellers to globally distributed teams at the world's largest companies – whose videos receive billions of views each month.",
      "createdAt": "2007-01-18T11:40:11Z"
    },
    "ext": {
      "location": ""
    }
  },
  "metadata": {
    "platform": "vimeo",
    "endpoint": "user",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `author.id` | `toString` |
| `display_name` | `author.displayName` | - |
| `bio` | `content.text` | `stripHtml` |
| `profile_url` | `author.url` | `safeUrl` |
| `created_on` | `content.createdAt` | `toIsoDate` |
| `total_contacts` | `author.followers` | `toNumber` |
| `total_videos_uploaded` | `author.contentCount` | `toNumber` |
| `portrait_large` | `author.avatarUrl` | `safeUrl` |
| `location` | `ext.location` | - |

## Caching and freshness

- Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
- Between 30 minutes and 6 hours the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
- A "not found" is remembered for 5 minutes and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | That record does not exist. Free; do not retry. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).