/v1/tiktok/search/users
Search Users
Scrapes TikTok users matching a search query
| Credit cost | Default: 1 credit How charges are determinedCost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns. A call that fails costs 0 credits. A result served from cache costs 0 credits. `default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins. A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true). A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute. |
|---|---|
| Cache support | Not specified in the published contract. |
| Pagination | No explicit pagination metadata in the published contract. Consult the parameters and response fields below. |
Parameters
| Name | Location / required | Schema |
|---|---|---|
querySearch query for users | query / required |
|
trimSet to true to get a trimmed response | query / optional |
|
cursorCursor to get more users. Get 'cursor' from previous response. | query / optional |
|
Request examples
Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.
cURL
curl --request GET 'https://api.fetchproof.com/v1/tiktok/search/users?query=YOUR_QUERY' \
--header 'x-api-key: YOUR_API_KEY'JavaScript
const response = await fetch("https://api.fetchproof.com/v1/tiktok/search/users?query=YOUR_QUERY", {
method: 'GET',
headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());Python
import os
import requests
response = requests.get("https://api.fetchproof.com/v1/tiktok/search/users?query=YOUR_QUERY",
headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)Responses
200Success. Envelope: success / credits_remaining / credits_charged.
application/json
object
successrequired
boolean
credits_remainingrequired
integer
credits_chargedrequired
integer
cursorrequired
integer
usersoptional
array
Array items
object
challengesoptional
null
effectsoptional
null
itemsoptional
null
mix_listoptional
null
musicsoptional
null
positionoptional
null
uniqid_positionoptional
null
user_infooptional
object
accept_private_policyrequired
boolean
account_labelsrequired
null
ad_cover_urlrequired
null
advance_feature_item_orderrequired
null
advanced_feature_inforequired
null
authority_statusrequired
integer
avatar_168x168required
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
avatar_300x300required
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
avatar_largerrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
avatar_mediumrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
avatar_thumbrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
avatar_urirequired
string
aweme_countrequired
integer
block_statusrequired
integer
bold_fieldsrequired
null
can_message_follow_status_listrequired
array
Array items
integer
can_set_geofencingrequired
null
cha_listrequired
null
comment_filter_statusrequired
integer
comment_settingrequired
integer
commerce_user_levelrequired
integer
cover_urlrequired
null
custom_verifyrequired
string
cv_levelrequired
string
download_prompt_tsrequired
integer
enable_direct_messagerequired
boolean
enabled_filter_all_commentsrequired
boolean
enterprise_verify_reasonrequired
string
eventsrequired
null
fake_data_inforequired
object
fb_expire_timerequired
integer
follow_statusrequired
integer
follower_countrequired
integer
follower_statusrequired
integer
followers_detailrequired
null
following_countrequired
integer
friends_statusrequired
integer
geofencingrequired
null
hide_searchrequired
boolean
homepage_bottom_toastrequired
null
ins_idrequired
string
is_ad_fakerequired
boolean
is_blockrequired
boolean
is_discipline_memberrequired
boolean
is_muterequired
integer
is_mute_livesrequired
integer
is_mute_non_story_postrequired
integer
is_mute_storyrequired
integer
is_private_accountrequired
integer
is_starrequired
boolean
item_listrequired
null
live_agreementrequired
integer
live_commercerequired
boolean
live_verifyrequired
integer
mention_statusrequired
integer
mutual_relation_avatarsrequired
null
name_fieldrequired
string
need_pointsrequired
null
need_recommendrequired
integer
nicknamerequired
string
original_musicianrequired
object
digg_countrequired
integer
music_countrequired
integer
music_used_countrequired
integer
new_release_clip_idsrequired
null
platform_sync_inforequired
null
prevent_downloadrequired
boolean
relative_usersrequired
null
reply_with_video_flagrequired
integer
room_idrequired
integer
room_id_strrequired
string
search_highlightrequired
null
search_user_descrequired
string
search_user_namerequired
string
sec_uidrequired
string
secretrequired
integer
shield_comment_noticerequired
integer
shield_digg_noticerequired
integer
shield_edit_field_inforequired
null
shield_follow_noticerequired
integer
short_idrequired
string
show_image_bubblerequired
boolean
special_accountrequired
object
special_account_listrequired
null
special_lockrequired
integer
statusrequired
integer
stitch_settingrequired
integer
story_statusrequired
integer
total_favoritedrequired
integer
type_labelrequired
null
uidrequired
string
unique_idrequired
string
user_canceledrequired
boolean
user_moderequired
integer
user_now_pack_inforequired
object
user_periodrequired
integer
user_profile_guiderequired
null
user_raterequired
integer
user_spark_inforequired
object
user_tagsrequired
null
verification_typerequired
integer
verify_inforequired
string
video_iconrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
url_prefixrequired
null
widthrequired
integer
white_cover_urlrequired
null
with_commerce_entryrequired
boolean
follower_countoptional
integer
following_countoptional
integer
nicknameoptional
string
sec_uidoptional
string
uidoptional
string
unique_idoptional
string
avatar_mediumoptional
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
challenge_listoptional
null
extraoptional
object
api_debug_inforequired
null
fatal_item_idsrequired
array
logidrequired
string
nowrequired
integer
search_request_idrequired
string
server_stream_timerequired
integer
feedback_typeoptional
string
global_doodle_configoptional
object
ab_paramsrequired
object
user_relation_shiprequired
string
display_filter_barrequired
integer
feedback_surveyrequired
array
Array items
object
feedback_typerequired
string
long_stress_inforequired
null
multiple_choicesrequired
array
Array items
object
keyrequired
string
valuerequired
string
send_us_multiple_choicesrequired
null
hide_resultsrequired
boolean
hit_dolphinrequired
boolean
hit_sharkrequired
boolean
keywordrequired
string
new_sourcerequired
string
search_channelrequired
string
tns_search_resultrequired
string
has_moreoptional
integer
input_keywordoptional
string
log_pboptional
object
impr_idrequired
string
music_listoptional
null
qcoptional
string
ridoptional
string
status_codeoptional
integer
typeoptional
integer
user_listoptional
array
Array items
object
challengesrequired
null
effectsrequired
null
itemsrequired
null
mix_listrequired
null
musicsrequired
null
positionrequired
null
uniqid_positionrequired
null
user_inforequired
object
accept_private_policyrequired
boolean
account_labelsrequired
null
ad_cover_urlrequired
null
advance_feature_item_orderrequired
null
advanced_feature_inforequired
null
authority_statusrequired
integer
avatar_168x168required
object
data_sizerequired
integer
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
avatar_300x300required
object
data_sizerequired
integer
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
avatar_largerrequired
object
data_sizerequired
integer
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
avatar_mediumrequired
object
data_sizerequired
integer
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
avatar_thumbrequired
object
data_sizerequired
integer
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
avatar_urirequired
string
aweme_countrequired
integer
block_statusrequired
integer
bold_fieldsrequired
null
can_message_follow_status_listrequired
array
Array items
integer
can_set_geofencingrequired
null
cha_listrequired
null
comment_filter_statusrequired
integer
comment_settingrequired
integer
commerce_user_levelrequired
integer
cover_urlrequired
null
custom_verifyrequired
string
cv_levelrequired
string
download_prompt_tsrequired
integer
enable_direct_messagerequired
boolean
enabled_filter_all_commentsrequired
boolean
enterprise_verify_reasonrequired
string
eventsrequired
null
fake_data_inforequired
object
fb_expire_timerequired
integer
follow_statusrequired
integer
follower_countrequired
integer
follower_statusrequired
integer
followers_detailrequired
null
following_countrequired
integer
friends_statusrequired
integer
geofencingrequired
null
hide_searchrequired
boolean
homepage_bottom_toastrequired
null
ins_idrequired
string
is_ad_fakerequired
boolean
is_blockrequired
boolean
is_discipline_memberrequired
boolean
is_muterequired
integer
is_mute_livesrequired
integer
is_mute_non_story_postrequired
integer
is_mute_storyrequired
integer
is_mute_thoughtrequired
integer
is_private_accountrequired
integer
is_starrequired
boolean
item_listrequired
null
live_agreementrequired
integer
live_commercerequired
boolean
live_verifyrequired
integer
mention_statusrequired
integer
mutual_relation_avatarsrequired
null
name_fieldrequired
string
need_pointsrequired
null
need_recommendrequired
integer
nicknamerequired
string
original_musicianrequired
object
digg_countrequired
integer
music_countrequired
integer
music_used_countrequired
integer
new_release_clip_idsrequired
null
platform_sync_inforequired
null
prevent_downloadrequired
boolean
relative_usersrequired
null
reply_with_video_flagrequired
integer
room_idrequired
integer
room_id_strrequired
string
search_highlightrequired
null
search_user_descrequired
string
search_user_namerequired
string
sec_uidrequired
string
secretrequired
integer
shield_comment_noticerequired
integer
shield_digg_noticerequired
integer
shield_edit_field_inforequired
null
shield_follow_noticerequired
integer
short_idrequired
string
show_image_bubblerequired
boolean
special_accountrequired
object
special_account_listrequired
null
special_lockrequired
integer
statusrequired
integer
stitch_settingrequired
integer
story_statusrequired
integer
total_favoritedrequired
integer
type_labelrequired
null
uidrequired
string
unique_idrequired
string
user_canceledrequired
boolean
user_moderequired
integer
user_now_pack_inforequired
object
user_periodrequired
integer
user_profile_guiderequired
null
user_raterequired
integer
user_spark_inforequired
object
user_tagsrequired
null
verification_typerequired
integer
verify_inforequired
string
video_iconrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
url_prefixrequired
null
widthrequired
integer
white_cover_urlrequired
null
with_commerce_entryrequired
boolean
user_all_story_metadataoptional
object
post_type_to_countsrequired
array
Array items
object
countrequired
integer
post_typerequired
integer
story_lite_metadatarequired
array
Array items
object
audience_scoperequired
integer
expire_atrequired
integer
item_idrequired
integer
post_typerequired
integer
viewedrequired
boolean
user_story_change_timerequired
integer