> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scraperize.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Search suggestions
> Returns TikTok’s autocomplete suggestions for a `query` — what the search box suggests as you type — in a `region` (default NG). Suggestions differ by region: the same query gives different suggestions in, say, the UK and the US. Each suggestion comes with its rank, the characters that match the query, its language and its tokens. Suggestions are not personalised. `servedRegion` is the region the results are for.
**Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.
Paste this into ChatGPT, Claude or your coding assistant to generate working code for this endpoint (use the copy button).
```text Prompt
I want to make an API call to /v1/tiktok/search/suggestions. Here are the details:
Endpoint: GET https://api.scraperize.com/v1/tiktok/search/suggestions
Description: Returns TikTok’s autocomplete suggestions for a `query` — what the search box suggests as you type — in a `region` (default NG). Suggestions differ by region: the same query gives different suggestions in, say, the UK and the US. Each suggestion comes with its rank, the characters that match the query, its language and its tokens. Suggestions are not personalised. `servedRegion` is the region the results are for.
Required Headers:
- x-api-key: Your API key
Parameters:
- query (string) [required]: The text typed so far (1–100 characters).
- region (select): The region (country) to get results for, as a two-letter code (ISO 3166-1). Defaults to NG (Nigeria).
- cache_max_age (select): Optional. Return a cached result if one this age or newer exists — served for **0 credits** with `meta.cached=true` and `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and refreshes the cache. Omit to always scrape fresh.
Example Response:
{
"data": {
"query": "paul",
"region": "NG",
"regionName": "Nigeria",
"servedRegion": "NG",
"suggestions": [
{
"text": "Paul McCartney",
"position": 0,
"matches": [
{
"start": 0,
"end": 4
}
],
"language": "en",
"tokens": [
"Paul"
],
"groupId": "8725309374589977462"
}
],
"count": 8,
"fetchedAt": "2026-10-05T14:45:28.574Z"
},
"meta": {
"requestId": "req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f",
"creditsCharged": 1,
"creditsRemaining": 4999,
"cached": false
}
}
Please help me write code in my preferred programming language to make this API call and handle the response appropriately. Include error handling and best practices.
```
## OpenAPI
````yaml /api-reference/openapi.json get /v1/tiktok/search/suggestions
openapi: 3.0.3
info:
title: Scraperize API
version: 1.0.0
description: >-
Extract public data from social media platforms as clean JSON. Endpoints are
split by platform and by what they return, e.g. `GET /v1/twitter/tweet`.
## Authentication
Send your API key in the `x-api-key` header (or `Authorization: Bearer
`). Create keys in your dashboard.
## Credits
Each successful live scrape costs **1 credit**. Credits are prepaid and
never expire.
## Caching
Every endpoint accepts an optional `cache_max_age`
(`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for
**0 credits**.
## Responses
Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return
`{ "error": { "code", "message", "requestId" } }` with a matching HTTP
status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`,
`cached`, and (on a hit) `cachedAt`.
## Rate limits
Requests are limited per team per minute; over the limit returns `429` with
a `Retry-After` header.
servers:
- url: https://api.scraperize.com
description: Production
security:
- ApiKeyAuth: []
tags:
- name: Twitter
description: Twitter / X scraping endpoints
- name: Facebook
description: Facebook scraping endpoints
- name: Linkme
description: Linkme (link.me) scraping endpoints
- name: Amazon
description: Amazon (creator shop / storefront) scraping endpoints
- name: Linkbio
description: Linkbio (lnk.bio) scraping endpoints
- name: Pillar
description: Pillar (pillar.io) scraping endpoints
- name: Komi
description: Komi (komi.io) scraping endpoints
- name: Linktree
description: Linktree (linktr.ee) scraping endpoints
- name: Kick
description: Kick (kick.com) scraping endpoints
- name: Snapchat
description: Snapchat (snapchat.com) scraping endpoints
- name: Telegram
description: Telegram (t.me) scraping endpoints
- name: LinkedIn
description: LinkedIn scraping endpoints
- name: Twitch
description: Twitch scraping endpoints
- name: TikTok
description: TikTok (tiktok.com) scraping endpoints
paths:
/v1/tiktok/search/suggestions:
get:
tags:
- TikTok
summary: Search suggestions
description: >-
Returns TikTok’s autocomplete suggestions for a `query` — what the
search box suggests as you type — in a `region` (default NG).
Suggestions differ by region: the same query gives different suggestions
in, say, the UK and the US. Each suggestion comes with its rank, the
characters that match the query, its language and its tokens.
Suggestions are not personalised. `servedRegion` is the region the
results are for.
parameters:
- name: query
in: query
required: true
description: The text typed so far (1–100 characters).
schema:
type: string
minLength: 1
maxLength: 100
example: paul
- name: region
in: query
required: false
description: >-
The region (country) to get results for, as a two-letter code (ISO
3166-1). Defaults to NG (Nigeria).
schema:
type: string
enum:
- AL
- DZ
- AR
- AU
- AT
- AZ
- BY
- BE
- BO
- BR
- KH
- CM
- CA
- CL
- CO
- CR
- CZ
- EG
- FR
- DE
- GH
- GR
- HK
- IS
- IE
- IL
- IT
- JM
- JP
- KZ
- KE
- KW
- LI
- LT
- LU
- MX
- MA
- MZ
- NA
- NL
- NG
- MK
- 'NO'
- PA
- PE
- PH
- PT
- PR
- RO
- SA
- SG
- ZA
- KR
- ES
- SE
- CH
- TW
- TH
- TT
- TN
- TR
- UG
- UA
- AE
- GB
- US
- UY
- UZ
- VE
x-enumNames:
- Albania (AL)
- Algeria (DZ)
- Argentina (AR)
- Australia (AU)
- Austria (AT)
- Azerbaijan (AZ)
- Belarus (BY)
- Belgium (BE)
- Bolivia (BO)
- Brazil (BR)
- Cambodia (KH)
- Cameroon (CM)
- Canada (CA)
- Chile (CL)
- Colombia (CO)
- Costa Rica (CR)
- Czechia (CZ)
- Egypt (EG)
- France (FR)
- Germany (DE)
- Ghana (GH)
- Greece (GR)
- Hong Kong (HK)
- Iceland (IS)
- Ireland (IE)
- Israel (IL)
- Italy (IT)
- Jamaica (JM)
- Japan (JP)
- Kazakhstan (KZ)
- Kenya (KE)
- Kuwait (KW)
- Liechtenstein (LI)
- Lithuania (LT)
- Luxembourg (LU)
- Mexico (MX)
- Morocco (MA)
- Mozambique (MZ)
- Namibia (NA)
- Netherlands (NL)
- Nigeria (NG)
- North Macedonia (MK)
- Norway (NO)
- Panama (PA)
- Peru (PE)
- Philippines (PH)
- Portugal (PT)
- Puerto Rico (PR)
- Romania (RO)
- Saudi Arabia (SA)
- Singapore (SG)
- South Africa (ZA)
- South Korea (KR)
- Spain (ES)
- Sweden (SE)
- Switzerland (CH)
- Taiwan (TW)
- Thailand (TH)
- Trinidad and Tobago (TT)
- Tunisia (TN)
- Türkiye (TR)
- Uganda (UG)
- Ukraine (UA)
- United Arab Emirates (AE)
- United Kingdom (GB)
- United States (US)
- Uruguay (UY)
- Uzbekistan (UZ)
- Venezuela (VE)
default: NG
example: NG
- name: cache_max_age
in: query
required: false
description: >-
Optional. Return a cached result if one this age or newer exists —
served for **0 credits** with `meta.cached=true` and
`meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and
refreshes the cache. Omit to always scrape fresh.
schema:
type: string
enum:
- 1d
- 3d
- 7d
- 14d
- 30d
example: 7d
responses:
'200':
description: The suggestions, in TikTok’s order.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
query:
type: string
region:
type: string
regionName:
type: string
servedRegion:
type: string
nullable: true
suggestions:
type: array
items:
type: object
properties:
text:
type: string
position:
type: integer
matches:
type: array
items:
type: object
properties:
start:
type: integer
end:
type: integer
language:
type: string
nullable: true
tokens:
type: array
items:
type: string
groupId:
type: string
nullable: true
count:
type: integer
fetchedAt:
type: string
format: date-time
meta:
type: object
description: >-
requestId + credit/caching metadata (creditsCharged,
creditsRemaining, cached, cachedAt).
required:
- data
- meta
example:
data:
query: paul
region: NG
regionName: Nigeria
servedRegion: NG
suggestions:
- text: Paul McCartney
position: 0
matches:
- start: 0
end: 4
language: en
tokens:
- Paul
- McCartney
groupId: '8725309374589977462'
- text: Paul Wesley
position: 1
matches:
- start: 0
end: 4
language: en
tokens:
- Paul
- Wesley
groupId: '8255082880382300015'
- text: Paul walker
position: 2
matches:
- start: 0
end: 4
language: en
tokens:
- Paul
- walker
groupId: '6145155812352459478'
count: 8
fetchedAt: '2026-10-05T14:45:28.574Z'
meta:
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
creditsCharged: 1
creditsRemaining: 4999
cached: false
'401':
description: Missing, invalid, or revoked API key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UNAUTHORIZED
message: API key required — pass it in the `x-api-key` header.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'402':
description: Not enough credits for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: INSUFFICIENT_CREDITS
message: >-
This request costs 1 credit, but your balance is 0. Top up
to continue.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'422':
description: >-
Invalid query parameters (missing / empty / too-long query, or an
unsupported region).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: VALIDATION_ERROR
message: Request validation failed
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
- path: url
message: Required
'429':
description: Over the per-minute rate limit — honour `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: RATE_LIMITED
message: >-
Rate limit exceeded — max 100 requests per 60s. Retry in
~30s.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'503':
description: >-
Temporarily unavailable — retry after `Retry-After`. `error.code`
tells you why: `UPSTREAM_BLOCKED` (the source blocked this request),
`EXTRACTION_FAILED` (the source returned unexpected data),
`PLATFORM_UNAVAILABLE` (the source is down), or
`SERVICE_UNAVAILABLE` (we are at capacity).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UPSTREAM_BLOCKED
message: >-
The source is temporarily unavailable. Please try again
shortly.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: NOT_FOUND
message:
type: string
example: The requested content was not found.
requestId:
type: string
example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
type: array
items:
type: object
description: Present on validation errors.
required:
- code
- message
- requestId
required:
- error
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
Your API key. Send it in the `x-api-key` header (or `Authorization:
Bearer `). Create and manage keys from your dashboard.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.