# Viewstats — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Viewstats provides 3 callable API endpoints through the Parse marketplace.

**Category:** Streaming Video | **Website:** [viewstats.com/](https://viewstats.com/) | **Docs:** [parse.bot/marketplace/96d544d5-30b7-4bfc-bbfe-183f3cc4f24d/viewstats-com-api](https://parse.bot/marketplace/96d544d5-30b7-4bfc-bbfe-183f3cc4f24d/viewstats-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/viewstats/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get channel stats

Get core statistics and rankings for a YouTube channel by its handle. Returns subscriber count, view count, video count, verification status, and global/country/category rankings. The handle may be provided with or without the leading @ symbol.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `handle` | string | Yes | Channel handle with or without leading @ (e.g. 'MrBeast' or '@MrBeast') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/viewstats/get-channel-stats \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"handle":"<string>"}'
```

### Get top channels

Get the top YouTube channels leaderboard ranked by subscribers or views over a given time interval. Returns up to 150 channels with ranking position and subscriber growth delta. Useful for discovering trending creators.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `interval` | string | No | Time interval for ranking calculations |
| `sort_by` | string | No | Sort metric for the leaderboard |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/viewstats/get-top-channels \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"interval":"<string>","sort_by":"<string>"}'
```

### Search channels

Full-text search across YouTube channels tracked by Viewstats. Returns up to 10 matching channels with subscriber count, view count, and handle. Matches against channel name and handle.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword matching channel name or handle |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/viewstats/search-channels \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.