# Get the current account

`GET https://api.vidmoat.com/v1/me`

- Scope: `account.read`
- Cost: Free

The owner of this credential: plan, credit balance, export allowance and limits, plus the scopes this key actually carries. The first call to make when a request is failing with 403 and you are not sure why.

## Response

Returns `200`.

### Response fields

- `account` (object): The owning account.
  - `id` (string): Account id.
  - `email` (string): Account email.
  - `plan` (object): `{ id, name, features }`.
  - `credits` (object): `{ remaining, perMonth, resetsAt }`.
  - `exports` (object): `{ used, limit, resetsAt }`. `limit` is `null` when unlimited.
  - `limits` (object): `{ maxProjects, maxExportHeight, maxUploadMb, maxConcurrentRenders }`. `maxProjects` is `null` when unlimited.
- `credential` (object): The credential that made this request.
  - `type` (enum): Key or OAuth token. One of `api_key`, `oauth_token`.
  - `keyId` (string or null): `null` for an OAuth token.
  - `appId` (string or null): The app the key was minted for.
  - `environment` (enum): Test or live. One of `test`, `live`.
  - `scopes` (array of strings): The scopes it actually carries, after the app ceiling.

## Request examples

```bash curl
curl https://api.vidmoat.com/v1/me \
  -H "Authorization: Bearer $VIDMOAT_KEY"
```

```js Node
const res = await fetch('https://api.vidmoat.com/v1/me', {
  headers: {
    Authorization: `Bearer ${process.env.VIDMOAT_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error?.message ?? `HTTP ${res.status}`);
console.log(data);
```

```python Python
import os
import requests

res = requests.get(
    "https://api.vidmoat.com/v1/me",
    headers={"Authorization": f"Bearer {os.environ['VIDMOAT_KEY']}"},
    timeout=60,
)
res.raise_for_status()
print(res.json())
```

## Example response

```json
{
  "account": {
    "id": "usr_123",
    "email": "dev@example.com",
    "name": "Dev",
    "plan": { "id": "studio", "name": "Studio", "features": ["api_access"] },
    "credits": { "remaining": 4500, "perMonth": 6000, "resetsAt": "2026-11-01T00:00:00.000Z" },
    "exports": { "used": 2, "limit": null, "resetsAt": "2026-11-01T00:00:00.000Z" },
    "limits": { "maxProjects": null, "maxExportHeight": 2160, "maxUploadMb": 8192, "maxConcurrentRenders": 5 }
  },
  "credential": {
    "type": "api_key",
    "keyId": "key_abc",
    "appId": "app_xyz",
    "environment": "test",
    "scopes": ["account.read", "projects.read"]
  }
}
```

---

Source: https://developer.vidmoat.com/developer/docs/api/account/get-me
Previous: [API reference](https://developer.vidmoat.com/developer/docs/api.md)
Next: [Get usage](https://developer.vidmoat.com/developer/docs/api/account/get-usage.md)
All documentation: https://developer.vidmoat.com/llms-full.txt