> ## 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 Search: Inputs, Cost & CLI Example

> Searching YouTube videos through ScrapeCreators. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=scrapecreators_youtube_search:{"query":"{{query}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                        | Type                                                       | Required | Default | Description                                                                                                                                                                            |
| --------------------------- | ---------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.query`             | `string`                                                   | Yes      |         | Search query                                                                                                                                                                           |
| `payload.uploadDate`        | `"today" \| "this_week" \| "this_month" \| "this_year"`    | No       |         | Upload date                                                                                                                                                                            |
| `payload.sortBy`            | `"relevance" \| "popular"`                                 | No       |         | Sort by                                                                                                                                                                                |
| `payload.type`              | `"videos" \| "shorts" \| "channels" \| "playlists"`        | No       |         | Type of content to search for                                                                                                                                                          |
| `payload.duration`          | `"under_3_min" \| "between_3_and_20_min" \| "over_20_min"` | No       |         | Duration of the video. Only applies to videos (not shorts).                                                                                                                            |
| `payload.region`            | `string`                                                   | No       |         | 2 letter country code of the country to put the proxy in.                                                                                                                              |
| `payload.continuationToken` | `string`                                                   | No       |         | Continuation token to get more videos. Get 'continuationToken' from previous response.                                                                                                 |
| `payload.includeExtras`     | `string`                                                   | No       |         | This will get you the like + comment count and the description. To get the full details of the video, use the /v1/youtube/video endpoint. *This will slow down the response slightly.* |
| `payload.cursor`            | `string`                                                   | No       |         | Deprecated alias for ScrapeCreators continuationToken. Prefer continuationToken.                                                                                                       |

### Allowed values

| Field                | Allowed values                                       |
| -------------------- | ---------------------------------------------------- |
| `payload.uploadDate` | `today`, `this_week`, `this_month`, `this_year`      |
| `payload.sortBy`     | `relevance`, `popular`                               |
| `payload.type`       | `videos`, `shorts`, `channels`, `playlists`          |
| `payload.duration`   | `under_3_min`, `between_3_and_20_min`, `over_20_min` |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Searches YouTube by keyword query and returns matching videos, channels, playlists, shorts, shelves, and live streams. Each video result includes title, URL, thumbnail, view count (views), publish date, duration, channel info, and badges. Supports filtering by upload date, sorting by relevance or popularity, and paginating with continuationToken. Set is_paid_promotions=true to search YouTube videos with the paid product placement / sponsorship disclosure.",
    "properties": {
      "query": {
        "type": "string",
        "description": "Search query"
      },
      "uploadDate": {
        "type": "string",
        "description": "Upload date",
        "enum": [
          "today",
          "this_week",
          "this_month",
          "this_year"
        ]
      },
      "sortBy": {
        "type": "string",
        "description": "Sort by",
        "enum": [
          "relevance",
          "popular"
        ]
      },
      "type": {
        "type": "string",
        "description": "Type of content to search for",
        "enum": [
          "videos",
          "shorts",
          "channels",
          "playlists"
        ]
      },
      "duration": {
        "type": "string",
        "description": "Duration of the video. Only applies to videos (not shorts).",
        "enum": [
          "under_3_min",
          "between_3_and_20_min",
          "over_20_min"
        ]
      },
      "region": {
        "type": "string",
        "description": "2 letter country code of the country to put the proxy in."
      },
      "continuationToken": {
        "type": "string",
        "description": "Continuation token to get more videos. Get 'continuationToken' from previous response."
      },
      "includeExtras": {
        "type": "string",
        "description": "This will get you the like + comment count and the description. To get the full details of the video, use the /v1/youtube/video endpoint. *This will slow down the response slightly.*"
      },
      "cursor": {
        "type": "string",
        "description": "Deprecated alias for ScrapeCreators continuationToken. Prefer continuationToken."
      }
    },
    "required": [
      "query"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type      | Required | Default | Description                                    |
| ------------- | --------- | -------- | ------- | ---------------------------------------------- |
| `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={null}
  {
    "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute scrapecreators_youtube_search --payload '{
  "query": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0.02` per pricing unit.
* Billing mode: `post_deduct`.