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

> Searching TikTok videos by keyword for captions and engagement. 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_tiktok_keyword_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      |         | Keyword to search for                                                                                                                                                                                             |
| `payload.date_posted` | `"yesterday" \| "this-week" \| "this-month" \| "last-3-months" \| "last-6-months" \| "all-time"` | No       |         | Time Frame                                                                                                                                                                                                        |
| `payload.sort_by`     | `"relevance" \| "most-liked" \| "date-posted"`                                                   | No       |         | Sort by                                                                                                                                                                                                           |
| `payload.region`      | `string`                                                                                         | No       |         | Note, this doesn't filter the tiktoks only in a specfic region, it puts the proxy there. Use it in case you want to scrape posts only available for some country. Use 2 letter country codes like US, GB, FR, etc |
| `payload.cursor`      | `number`                                                                                         | No       |         | Cursor to get more videos. Get 'cursor' from previous response.                                                                                                                                                   |
| `payload.trim`        | `boolean`                                                                                        | No       |         | Set to true to get a trimmed response                                                                                                                                                                             |

### Allowed values

| Field                 | Allowed values                                                                       |
| --------------------- | ------------------------------------------------------------------------------------ |
| `payload.date_posted` | `yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`, `all-time` |
| `payload.sort_by`     | `relevance`, `most-liked`, `date-posted`                                             |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Searches for TikTok videos by keyword or phrase — the general video search across all of TikTok. Returns `search_item_list`, an array of objects each containing `aweme_info` with `aweme_id`, `desc` (caption), `statistics` (play_count, digg_count/likes, comment_count, share_count), `video` info, and `author` details. Paginate with `cursor`. TikTok may return duplicate results.",
    "properties": {
      "query": {
        "type": "string",
        "description": "Keyword to search for"
      },
      "date_posted": {
        "type": "string",
        "description": "Time Frame",
        "enum": [
          "yesterday",
          "this-week",
          "this-month",
          "last-3-months",
          "last-6-months",
          "all-time"
        ]
      },
      "sort_by": {
        "type": "string",
        "description": "Sort by",
        "enum": [
          "relevance",
          "most-liked",
          "date-posted"
        ]
      },
      "region": {
        "type": "string",
        "description": "Note, this doesn't filter the tiktoks only in a specfic region, it puts the proxy there. Use it in case you want to scrape posts only available for some country. Use 2 letter country codes like US, GB, FR, etc"
      },
      "cursor": {
        "type": "number",
        "description": "Cursor to get more videos. Get 'cursor' from previous response."
      },
      "trim": {
        "type": "boolean",
        "description": "Set to true to get a trimmed response"
      }
    },
    "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_tiktok_keyword_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`.