> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ScrapeCreators: Youtube Channel

> Retrieves comprehensive YouTube channel profile data including name, avatar images, subscriber count (subscribers), total video and view counts, join date.

Retrieves comprehensive YouTube channel profile data including name, avatar images, subscriber count (subscribers), total video and view counts, join date.

> [!NOTE]
>
> Tool ID: `scrapecreators_youtube_channel`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'scrapecreators_youtube_channel',
  {
    "channelId": "channel_123",
    "handle": "example",
    "url": "https://example.com"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute scrapecreators_youtube_channel --input '{
  "channelId": "channel_123",
  "handle": "example",
  "url": "https://example.com"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe scrapecreators_youtube_channel --json` for the complete live contract.

## Input reference

Retrieves comprehensive YouTube channel profile data including name, avatar images, subscriber count (subscribers), total video and view counts, join date, tags, and linked social accounts like Twitter and Instagram. Accepts a channelId, handle, or full channel URL as input. Returns channel metadata such as country, email, and external store links when available. Contact fields come from the submitted public profile. To request removal of your own information from Scrape Creators results, email [support@scrapecreators.com](mailto:support@scrapecreators.com) with the profile URL.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.channelId` | `string` | No | — | YouTube channel ID. Can pass a channelId, handle or url |
| `payload.handle` | `string` | No | — | YouTube channel handle. Can pass a channelId, handle or url |
| `payload.url` | `string` | No | — | YouTube channel URL. Can pass a channelId, handle or url |
| `payload.cache_max_age` | `"1d" \| "3d" \| "7d" \| "14d" \| "30d"` | No | — | If we have a response in the cache that is this many days old or newer, return the cached response. Otherwise, scrape a live result. [See the Caching page for details.](https://docs.scrapecreators.com/caching) Allowed: `1d`, `3d`, `7d`, `14d`, `30d`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves comprehensive YouTube channel profile data including name, avatar images, subscriber count (subscribers), total video and view counts, join date, tags, and linked social accounts like Twitter and Instagram. Accepts a channelId, handle, or full channel URL as input. Returns channel metadata such as country, email, and external store links when available. Contact fields come from the submitted public profile. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL.",
    "properties": {
      "channelId": {
        "type": "string",
        "description": "YouTube channel ID. Can pass a channelId, handle or url"
      },
      "handle": {
        "type": "string",
        "description": "YouTube channel handle. Can pass a channelId, handle or url"
      },
      "url": {
        "type": "string",
        "description": "YouTube channel URL. Can pass a channelId, handle or url"
      },
      "cache_max_age": {
        "type": "string",
        "description": "If we have a response in the cache that is this many days old or newer, return the cached response. Otherwise, scrape a live result. [See the Caching page for details.](https://docs.scrapecreators.com/caching)",
        "enum": [
          "1d",
          "3d",
          "7d",
          "14d",
          "30d"
        ]
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `unknown` | Yes | — | Provider response payload. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "description": "Provider response payload."
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.02` per pricing unit.

## Related documentation

* [ScrapeCreators provider guide](https://deepline.com/docs/providers/scrapecreators/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.