> ## 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

> Searching TikTok videos by keyword for captions and engagement. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Searching TikTok videos by keyword for captions and engagement.

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

## 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_tiktok_keyword_search',
  {
    "query": "software companies hiring engineers"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute scrapecreators_tiktok_keyword_search --input '{
  "query": "software companies hiring engineers"
}' --json
```

## Example response

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

## Input reference

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.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `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 Allowed: `yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`, `all-time`. |
| `payload.sort_by` | `"relevance" \| "most-liked" \| "date-posted"` | No | — | Sort by Allowed: `relevance`, `most-liked`, `date-posted`. |
| `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 |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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 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: `fixed` (per call).
* 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.