# Get channel

Fetch metadata for a YouTube channel.

- Platform: [YouTube](https://docs.upscrape.com/docs/platforms/youtube)
- Capability ID: `youtube.channel.get`
- Cost: 1 credit per request
- Maximum runtime: 60 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "url": "@NASA"
  },
  "capability": "youtube.channel.get"
}'
```

## Input


| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | `string` | Yes | YouTube channel URL, handle, or channel ID |

### Example input

```json
{
  "url": "@NASA"
}
```

## Response

Successful output is returned in `results[0].data`.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This example shows one response. Values and optional fields vary with the data available.

```json
{
  "available_countries": [
    "SZ",
    "LK",
    "TO"
  ],
  "available_tabs": [
    "Home",
    "Videos",
    "Shorts"
  ],
  "avatar": [
    {
      "height": 72,
      "url": "https://yt3.googleusercontent.com/[redacted:token]=s72-c-k-c0x00ffffff-no-rj",
      "width": 72
    },
    {
      "height": 120,
      "url": "https://yt3.googleusercontent.com/[redacted:token]=s120-c-k-c0x00ffffff-no-rj",
      "width": 120
    },
    {
      "height": 160,
      "url": "https://yt3.googleusercontent.com/[redacted:token]=s160-c-k-c0x00ffffff-no-rj",
      "width": 160
    }
  ],
  "banner": [
    {
      "height": 175,
      "url": "https://yt3.googleusercontent.com/[redacted:token]=w1060-fcrop64=1,00005a57ffffa5a8-k-c0xffffffff-no-nd-rj",
      "width": 1060
    },
    {
      "height": 188,
      "url": "https://yt3.googleusercontent.com/[redacted:token]=w1138-fcrop64=1,00005a57ffffa5a8-k-c0xffffffff-no-nd-rj",
      "width": 1138
    },
    {
      "height": 283,
      "url": "https://yt3.googleusercontent.com/[redacted:token]=w1707-fcrop64=1,00005a57ffffa5a8-k-c0xffffffff-no-nd-rj",
      "width": 1707
    }
  ],
  "channel_handle": "@NASA",
  "channel_id": "UCLA_DiR1FfKNvjuUpBHmylQ",
  "description": "NASA's mission is to pioneer the future in space exploration, scientific discovery, and aeronautics research.\r\n\r\nTo do that, we have worked around the world—and off it—for more than 60 years, searching for answers to fundamental questions about our place in the universe. We're exploring space and discovering Earth. Join us on this exciting and important journey.\n",
  "external_id": "UCLA_DiR1FfKNvjuUpBHmylQ",
  "is_family_safe": true,
  "keywords": "nasa space iss shuttle 50th astronauts planets earth rockets hubble telescopes NASA TV galaxy apollo gemini mercury sta Moon Artemis \"solar system\"",
  "rss_url": "https://www.youtube.com/feeds/videos.xml?channel_id=UCLA_DiR1FfKNvjuUpBHmylQ",
  "subscriber_count": 15100000,
  "subscriber_count_approximate": true,
  "subscriber_count_text": "15.1M subscribers",
  "title": "NASA",
  "url": "https://www.youtube.com/channel/UCLA_DiR1FfKNvjuUpBHmylQ",
  "vanity_url": "http://www.youtube.com/@NASA",
  "video_count": 6100,
  "video_count_approximate": true,
  "video_count_text": "6.1K videos"
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `available_countries` | `array` | 3 items |
| `available_countries` | `array` | 3 items |
| `available_tabs` | `array` | 3 items |
| `available_tabs` | `array` | 3 items |
| `avatar` | `array` | 3 items |
| `avatar` | `array` | 3 items |
| `banner` | `array` | 3 items |
| `banner` | `array` | 3 items |
| `channel_handle` | `string` | @NASA |
| `channel_id` | `string` | UCLA_DiR1FfKNvjuUpBHmylQ |
| `description` | `string` | NASA's mission is to pioneer the future in space exploration, scientifi… |
| `external_id` | `string` | UCLA_DiR1FfKNvjuUpBHmylQ |
| `is_family_safe` | `boolean` | true |
| `keywords` | `string` | nasa space iss shuttle 50th astronauts planets earth rockets hubble tel… |
| `rss_url` | `string` | https://www.youtube.com/feeds/videos.xml?channel_id=UCLA_DiR1FfKNvjuUpB… |
| `subscriber_count` | `integer` | 15100000 |
| `subscriber_count_approximate` | `boolean` | true |
| `subscriber_count_text` | `string` | 15.1M subscribers |
| `title` | `string` | NASA |
| `url` | `string` | https://www.youtube.com/channel/UCLA_DiR1FfKNvjuUpBHmylQ |
| `vanity_url` | `string` | http://www.youtube.com/@NASA |
| `video_count` | `integer` | 6100 |
| `video_count_approximate` | `boolean` | true |
| `video_count_text` | `string` | 6.1K videos |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)
