TikTok API endpoint
Search TikTok users
Searches TikTok users by keyword with cursor-based pagination.
/tiktok/search/userParameters
| Name | In | Type | Required | Enum | Example | Description |
|---|---|---|---|---|---|---|
| x-api-key | header | string | Yes | API key required | ||
| keyword | query | string | Yes | chatgpt | Search keyword | |
| cursor | query | integer | No | Pagination cursor |
Authentication
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Billing
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
- Credit cost
- 8 credits/request
- Charged response
- Successful 2xx responses
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
Response behavior
- Pass the returned `cursor` value from a previous response to continue pagination. Example response: ```json { "code": 200, "msg": "OK", "data": { "type": 1, "user_list": [ { "challenges": null, "effects": null, "items": null, "mix_list": null, "musics": null, "position": null } ], "challenge_list": null, "music_list": null, "cursor": 10, "has_more": 1 } } ```
Failure responses
| Status | Description | Schema |
|---|---|---|
| 400 | Invalid input | #/definitions/app.Response |
| 429 | Rate limit exceeded | #/definitions/app.Response |
| 500 | Internal server error | #/definitions/app.Response |
Example response
{
"code": 200,
"msg": "OK",
"data": {
"type": 1,
"user_list": [
{
"challenges": null,
"effects": null,
"items": null,
"mix_list": null,
"musics": null,
"position": null
}
],
"challenge_list": null,
"music_list": null,
"cursor": 10,
"has_more": 1
}
}Request schema
No body schema
Response schema
#/definitions/tiktok.searchUserResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | tiktok.SearchUserResp | No | ||||
| data.challenge_list | unknown | No | ||||
| data.cursor | integer | No | ||||
| data.extra | unknown | No | ||||
| data.feedback_type | string | No | ||||
| data.global_doodle_config | unknown | No | ||||
| data.has_more | integer | No | ||||
| data.input_keyword | string | No | ||||
| data.log_pb | object | No | ||||
| data.log_pb.impr_id | string | No | ||||
| data.music_list | unknown | No | ||||
| data.qc | string | No | ||||
| data.rid | string | No | ||||
| data.status_code | integer | No | ||||
| data.status_msg | string | No | ||||
| data.type | integer | No | ||||
| data.user_list | array | No | ||||
| msg | string | No | OK |
Example request
curl -X GET "https://api.crawlora.net/api/v1/tiktok/search/user?keyword=chatgpt" -H "x-api-key: <api-key>"
TypeScript fetch
const url = new URL("https://api.crawlora.net/api/v1/tiktok/search/user");
url.searchParams.set("keyword", "chatgpt");
const headers = new Headers();
headers.set("x-api-key", "<api-key>");
const response = await fetch(url, {
method: "GET",
headers,
});
const payload = await response.json();