TikTok search suggestions API
  1. Docs
  2. TikTok
  3. TikTok search suggestions API

TikTok search suggestions API

The autocomplete suggestions TikTok shows while someone types in search.

GET /v1/tiktok/search/suggestions

GET /v1/tiktok/search/suggestions

The autocomplete suggestions TikTok shows while someone types in search.

  • Cost: 1 credit
  • Cache: Results are kept up to 1 day; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
querystringyesPartial or complete search text. Also accepted as keyword, q.

Every request also accepts:

  • cursor: the cursor from the previous page (Pagination).
  • region: two-letter country code for results that vary by country. Changing it restarts the cursor chain.
  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

1curl -G "https://api.socialscrape.dev/v1/tiktok/search/suggestions" \2  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3  --data-urlencode "query=dogs"

Example response#

This is a sample from a recorded response, lists and long text are shortened. Status 200.

200 OKSample response
1{2  "ok": true,3  "credits_charged": 1,4  "credits_remaining": 4999,5  "cached": false,6  "cached_at": null,7  "request_id": "req_892207eaf0d593d9a6f77607",8  "data": {9    "object": "list",10    "items": [11      {12        "object": "suggestion",13        "platform": "tiktok",14        "kind": "query",15        "text": "dogs hotel",16        "id": null,17        "handle": null,18        "url": null,19        "image_url": null,20        "verified": null,21        "extra": null22      },23      {24        "object": "suggestion",25        "platform": "tiktok",26        "kind": "query",27        "text": "dogs toys",28        "id": null,29        "handle": null,30        "url": null,31        "image_url": null,32        "verified": null,33        "extra": null34      }35    ],36    "cursor": null,37    "has_more": false,38    "parent": null39  },40  "cursor": null,41  "has_more": false42}

Response#

A list of Suggestion objects in data.items, with data.cursor and data.has_more.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
not_found404noThe platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.