> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# TikTok Keyword Search

Structured TikTok data: send `queries`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/tiktok-keyword-search/` · 1 credit per successful call · Cursor-paginated

## Overview

Call `GET /api/v2/tiktok-keyword-search/` with `queries`. The results are in `data.videos`; send `data.next_cursor` back as `cursor` to get the next page. 5 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/tiktok-keyword-search/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "queries=funny cats" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/tiktok-keyword-search/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"queries": "funny cats"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["videos"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `queries` | string | yes | e.g. `funny cats` | Search term. Required first call. |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `date_posted` | string | no | — | today \| this-week \| this-month \| this-year. Locked in cursor. |
| `sort_by` | string | no | `relevance` | relevance \| date \| views. Locked in cursor. |
| `region` | string | no | — | 2-letter country code sent as TikTok search region (default US). Locked in cursor. |
| `fill_from_hashtag` | boolean | no | `true` | After TikTok's logged-out keyword search ends (~90-130 videos), continue with the #keyword hashtag feed (rows source=hashtag_feed). Locked in cursor. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.videos`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "queries": "funny cats",
    "page": 1,
    "page_size": 12,
    "source": "keyword_search",
    "videos": [
      {
        "aweme_id": "7667416568481074439",
        "desc": "cuty baby funny cartoons video",
        "url": "https://www.tiktok.com/@ariftedas/video/7667416568481074439",
        "search_query": "funny cats",
        "source": "keyword_search",
        "source_hashtag": null,
        "position": 1
      }
    ],
    "has_more": true,
    "next_cursor": "tks1.eNoNy0EKgCAQBdC7_LULoYXhVcJF2BCCNjEzRhDdPd_-vdjM2iO1x4K4wk0Ug"
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `queries` | string | `funny cats` |  |
| `page` | integer | `1` |  |
| `page_size` | integer | `12` |  |
| `source` | string | `keyword_search` |  |
| `videos` | array | `[1 item]` | The results. |
| `has_more` | boolean | `true` |  |
| `next_cursor` | string | `tks1.eNoNy0EKgCAQBdC7_LULoYXhVcJF2BCCNjEzRhDd…` | Pass back as `cursor` for the next page. `null` on the last page. |
| `videos[].aweme_id` | string | `7667416568481074439` |  |
| `videos[].desc` | string | `cuty baby funny cartoons video` |  |
| `videos[].url` | string | `https://www.tiktok.com/@ariftedas/video/76674…` |  |
| `videos[].search_query` | string | `funny cats` |  |
| `videos[].source` | string | `keyword_search` |  |
| `videos[].source_hashtag` | null | `null` |  |
| `videos[].position` | integer | `1` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/tiktok-keyword-search/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"queries": "funny cats"}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("videos") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- Locked into the cursor: `date_posted`, `sort_by`, `region`, `fill_from_hashtag`. Set them on the first call; later pages reuse them.

## Related

- [TikTok Ad Library Leads](https://docs.scrapier.io/api-reference/tiktok/tiktok-ad-library-leads.md): Structured TikTok data: every input is optional. Single lookup, 3 credits per successful call.
- [TikTok Ad Library](https://docs.scrapier.io/api-reference/tiktok/tiktok-ads.md): Structured TikTok data: send `urls`. Cursor-paginated, 1 credit per successful call.
- [TikTok Ads Top](https://docs.scrapier.io/api-reference/tiktok/tiktok-ads-top.md): Structured TikTok data: every input is optional. Cursor-paginated, 1 credit per successful call.
- [TikTok Collection Videos](https://docs.scrapier.io/api-reference/tiktok/tiktok-collection-videos.md): Structured TikTok data: send `urls`. Cursor-paginated, 1 credit per successful call.
