# YouTube Channel (`youtube.channel`)

YouTube channel profile and stats by handle or channel id: subscribers, video and view counts, description and links.

Docs: https://primaryapi.com/docs/api-reference/youtube/channel

- Endpoint: `POST https://api.primaryapi.com/v1/run/youtube.channel`
- Category: Social · Platform: `youtube` · Kind: lookup · Status: live
- Price: 1 credit per call; up to 2 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=youtube.channel`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `handle` | string | no |  | max 200 chars | YouTube channel handle with or without the @ (e.g. "ThePatMcAfeeShow"), or a youtube.com/@handle URL. |
| `channelId` | string | no |  | pattern: ^UC[A-Za-z0-9_-]{22}$ | YouTube channel id (UC…). Pass it when you have it: some sources accept only ids and otherwise resolve the handle first. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `channelId` | string | UC… channel id |
| `handle` | string \| null | Handle without the @ |
| `title` | string \| null |  |
| `description` | string \| null |  |
| `url` | string |  |
| `avatarUrl` | string \| null |  |
| `bannerUrl` | string \| null |  |
| `subscribers` | integer \| null | Subscriber count (YouTube rounds it to 3 significant digits) |
| `videos` | integer \| null |  |
| `views` | integer \| null | Lifetime channel views |
| `links` | string[] \| null | External links from the About page (null when the serving source cannot read them) |
| `joinedAt` | string \| null | Channel creation date (YYYY-MM-DD) |
| `country` | string \| null |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/youtube.channel" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"handle":"ThePatMcAfeeShow"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "channelId": "string",
      "handle": "ThePatMcAfeeShow",
      "title": "string",
      "description": "string",
      "url": "https://example.com",
      "avatarUrl": "https://example.com",
      "bannerUrl": "https://example.com",
      "subscribers": 0,
      "videos": 0,
      "views": 0,
      "links": [
        "string"
      ],
      "joinedAt": "string",
      "country": "string"
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: up to 2 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=youtube.channel`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Vendor contact emails are intentionally not returned here. Scraping YouTube breaches its Terms of Service: vendors do the fetching, we resell logged-out public data.

## Legal

Public channel metadata obtained through third-party providers; not affiliated with YouTube. Callers are responsible for lawful use.

