/v1/tiktok/search/hashtag

GET

Search by Hashtag

Search TikTok videos by hashtag. TikTok may return duplicate results.

Credit cost	Default: 1 credit How charges are determined Cost 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
`hashtag` Hashtag to search for (without #)	query / required	`string`
`region` Proxy country, not a filter for where posts were created.	query / optional	`string`
`trim` Set to true to get a trimmed response	query / optional	`boolean`
`cursor` Cursor to get more videos. Get 'cursor' from previous response.	query / optional	`number`

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/hashtag?hashtag=YOUR_HASHTAG' \
  --header 'x-api-key: YOUR_API_KEY'

JavaScript

const response = await fetch("https://api.fetchproof.com/v1/tiktok/search/hashtag?hashtag=YOUR_HASHTAG", {
  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/hashtag?hashtag=YOUR_HASHTAG",
    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

aweme_listrequired

array

Array items

object

add_yours_infooptional

object

video_sourcerequired

integer

added_sound_music_infooptional

object

albumrequired

string

artistsrequired

array

Array items

object

avatarrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

enter_typerequired

integer

follow_statusrequired

integer

follower_statusrequired

integer

handlerequired

string

is_blockrequired

boolean

is_blockedrequired

boolean

is_private_accountrequired

boolean

is_verifiedrequired

boolean

is_visiblerequired

boolean

nick_namerequired

string

sec_uidrequired

string

statusrequired

integer

uidrequired

string

audition_durationrequired

integer

authorrequired

string

author_deletedrequired

boolean

author_positionrequired

null

avatar_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

binded_challenge_idrequired

integer

can_not_reuserequired

boolean

collect_statrequired

integer

commercial_right_typerequired

integer

cover_largerequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

cover_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

cover_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

dmv_auto_showrequired

boolean

durationrequired

integer

duration_high_precisionrequired

object

audition_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

number

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

shoot_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

video_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

external_song_inforequired

array

extrarequired

string

has_commerce_rightrequired

boolean

idrequired

integer

id_strrequired

string

is_audio_url_with_cookierequired

boolean

is_author_artistrequired

boolean

is_commerce_musicrequired

boolean

is_matched_metadatarequired

boolean

is_originalrequired

boolean

is_original_soundrequired

boolean

is_pgcrequired

boolean

is_play_musicrequired

boolean

is_shooting_allowrequired

boolean

languageoptional

string

log_extrarequired

string

lyric_short_positionrequired

null

matched_songoptional

object

authorrequired

string

chorus_inforequired

object

duration_msrequired

integer

start_msrequired

integer

cover_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

full_durationrequired

integer

h5_urlrequired

string

idrequired

string

performersrequired

null

titlerequired

string

chorusesoptional

null

versesoptional

null

meme_song_inforequired

object

midrequired

string

multi_bit_rate_play_inforequired

null

music_release_infooptional

object

group_release_daterequired

integer

is_new_release_songrequired

boolean

mute_sharerequired

boolean

offline_descrequired

string

owner_handlerequired

string

owner_nicknamerequired

string

play_urlrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

positionrequired

null

prevent_downloadrequired

boolean

preview_end_timerequired

integer

preview_start_timerequired

schema

anyOf

number

anyOf

integer

recommend_statusrequired

integer

search_highlightrequired

null

shoot_durationrequired

integer

source_platformrequired

integer

statusrequired

integer

strong_beat_urloptional

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

style_valueoptional

array

Array items

integer

tag_listrequired

null

theme_valueoptional

array

Array items

integer

titlerequired

string

tt_to_dsp_song_infosrequired

null

uncert_artistsrequired

null

user_countrequired

integer

video_durationrequired

integer

allow_offline_music_to_detail_pageoptional

boolean

can_be_stitchedoptional

boolean

create_timeoptional

integer

has_commerce_right_strictoptional

boolean

has_human_voiceoptional

boolean

is_commerce_music_strictoptional

boolean

music_group_use_countoptional

integer

music_group_v3_idsoptional

array

Array items

integer

music_ugidoptional

integer

music_ugid_use_countoptional

integer

same_group_id_v3optional

integer

sim_group_id_v3optional

integer

tag_list_v2optional

null

theme_tagsoptional

array

Array items

string

matched_pgc_soundoptional

object

artist_infosrequired

array

Array items

object

avatarrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

enter_typerequired

integer

follow_statusrequired

integer

follower_statusrequired

integer

handlerequired

string

is_blockrequired

boolean

is_blockedrequired

boolean

is_private_accountrequired

boolean

is_verifiedrequired

boolean

is_visiblerequired

boolean

nick_namerequired

string

sec_uidrequired

string

statusrequired

integer

uidrequired

string

authorrequired

string

cover_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

mixed_authorrequired

string

mixed_titlerequired

string

music_release_inforequired

object

group_release_daterequired

integer

is_new_release_songrequired

boolean

titlerequired

string

uncert_artistsrequired

null

owner_idoptional

string

sec_uidoptional

string

aigc_infooptional

object

aigc_label_typerequired

integer

created_by_airequired

boolean

anchorsoptional

array

Array items

object

actionsrequired

array

Array items

object

action_typerequired

integer

iconrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

schemarequired

string

anchor_strongrequired

null

component_keyrequired

string

descriptionrequired

string

extrarequired

schema

anyOf

string

anyOf

object

effect_sourceoptional

integer

is_commerceoptional

integer

resource_idoptional

integer

Nameoptional

string

poi_idoptional

string

city_codeoptional

string

region_codeoptional

string

poi_backend_typeoptional

string

poi_info_sourceoptional

string

video_countoptional

integer

collect_infooptional

string

poi_mapkit_collectoptional

boolean

locationoptional

object

latrequired

string

lngrequired

string

geohashrequired

string

fallback_addressoptional

string

type_leveloptional

string

have_region_discoveryoptional

boolean

fav_cntoptional

integer

is_tt_key_categoryoptional

integer

is_ls_key_categoryoptional

integer

category_nameoptional

string

formatted_addressoptional

string

iconrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

idrequired

string

keywordrequired

string

log_extrarequired

string

thumbnailrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

typerequired

integer

general_typeoptional

integer

schemaoptional

string

anchors_extrasoptional

string

animated_image_infooptional

object

effectrequired

integer

typerequired

integer

authorrequired

object

accept_private_policyrequired

boolean

account_labelsrequired

null

account_regionrequired

string

ad_cover_urlrequired

null

advance_feature_item_orderrequired

null

advanced_feature_inforequired

null

apple_accountrequired

integer

authority_statusrequired

integer

avatar_168x168required

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_300x300required

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_largerrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_urirequired

string

aweme_countrequired

integer

bind_phonerequired

string

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

array

create_timerequired

integer

custom_verifyrequired

string

cv_levelrequired

string

download_prompt_tsrequired

integer

download_settingrequired

integer

duet_settingrequired

integer

enabled_filter_all_commentsrequired

boolean

enterprise_verify_reasonrequired

string

eventsrequired

null

fake_data_inforequired

object

favoriting_countrequired

integer

fb_expire_timerequired

integer

follow_statusrequired

integer

follower_countrequired

integer

follower_statusrequired

integer

followers_detailrequired

null

following_countrequired

integer

friends_statusrequired

integer

genderrequired

integer

geofencingrequired

null

google_accountrequired

string

has_emailrequired

boolean

has_facebook_tokenrequired

boolean

has_insightsrequired

boolean

has_ordersrequired

boolean

has_twitter_tokenrequired

boolean

has_youtube_tokenrequired

boolean

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_phone_bindedrequired

boolean

is_starrequired

boolean

item_listrequired

null

languagerequired

string

live_agreementrequired

integer

live_commercerequired

boolean

live_verifyrequired

integer

mention_statusrequired

integer

mutual_relation_avatarsrequired

null

need_pointsrequired

null

need_recommendrequired

integer

nicknamerequired

string

platform_sync_inforequired

null

prevent_downloadrequired

boolean

react_settingrequired

integer

regionrequired

string

relative_usersrequired

null

reply_with_video_flagrequired

integer

room_idrequired

integer

search_highlightrequired

null

sec_uidrequired

string

secretrequired

integer

share_inforequired

object

now_invitation_card_image_urlsrequired

null

share_descrequired

string

share_desc_inforequired

string

share_qrcode_urlrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

url_prefixrequired

null

widthrequired

integer

share_titlerequired

string

share_title_myselfrequired

string

share_title_otherrequired

string

share_urlrequired

string

share_qrcode_urirequired

string

shield_comment_noticerequired

integer

shield_digg_noticerequired

integer

shield_edit_field_inforequired

null

shield_follow_noticerequired

integer

short_idrequired

string

show_image_bubblerequired

boolean

signaturerequired

string

special_accountrequired

object

special_account_listrequired

null

special_lockrequired

integer

statusrequired

integer

stitch_settingrequired

integer

total_favoritedrequired

integer

tw_expire_timerequired

integer

twitter_idrequired

string

twitter_namerequired

string

type_labelrequired

null

uidrequired

string

unique_idrequired

string

unique_id_modify_timerequired

integer

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

with_shop_entryrequired

boolean

youtube_channel_idrequired

string

youtube_channel_titlerequired

string

youtube_expire_timerequired

integer

is_mute_livesoptional

integer

is_mute_non_story_postoptional

integer

is_mute_storyoptional

integer

author_user_idoptional

integer

aweme_acloptional

object

download_generalrequired

object

coderequired

integer

muterequired

boolean

show_typerequired

integer

transcoderequired

integer

extraoptional

string

download_mask_panelrequired

object

coderequired

integer

muterequired

boolean

show_typerequired

integer

transcoderequired

integer

extraoptional

string

platform_listrequired

null

press_action_listrequired

null

share_action_listrequired

null

share_generalrequired

object

coderequired

integer

muterequired

boolean

show_typerequired

integer

transcoderequired

integer

extraoptional

string

toast_msgoptional

string

share_list_statusrequired

integer

aweme_idrequired

string

aweme_typeoptional

integer

bannersoptional

array

Array items

object

keyrequired

object

component_keyrequired

string

behind_the_song_music_idsoptional

null

behind_the_song_video_music_idsoptional

null

bodydance_scoreoptional

integer

branded_content_accountsoptional

null

cc_template_infooptional

object

author_namerequired

string

clip_countrequired

integer

descrequired

string

duration_millisecondsrequired

integer

related_music_idrequired

string

template_idrequired

string

cha_listoptional

array

Array items

object

authorrequired

object

account_labelsrequired

null

ad_cover_urlrequired

null

advance_feature_item_orderrequired

null

advanced_feature_inforequired

null

bold_fieldsrequired

null

can_message_follow_status_listrequired

null

can_set_geofencingrequired

null

cha_listrequired

null

cover_urlrequired

null

eventsrequired

null

followers_detailrequired

null

geofencingrequired

null

homepage_bottom_toastrequired

null

item_listrequired

null

mutual_relation_avatarsrequired

null

need_pointsrequired

null

platform_sync_inforequired

null

relative_usersrequired

null

search_highlightrequired

null

shield_edit_field_inforequired

null

type_labelrequired

null

user_profile_guiderequired

null

user_tagsrequired

null

white_cover_urlrequired

null

banner_listrequired

null

cha_attrsrequired

null

cha_namerequired

string

cidrequired

string

collect_statrequired

integer

connect_musicrequired

array

descrequired

string

extra_attrrequired

object

is_liverequired

boolean

hashtag_profilerequired

string

is_challengerequired

integer

is_commercerequired

boolean

is_pgcshowrequired

boolean

schemarequired

string

search_highlightrequired

null

share_inforequired

object

bool_persistrequired

integer

now_invitation_card_image_urlsrequired

null

share_descrequired

string

share_desc_inforequired

string

share_quoterequired

string

share_signature_descrequired

string

share_signature_urlrequired

string

share_titlerequired

string

share_title_myselfrequired

string

share_title_otherrequired

string

share_urlrequired

string

show_itemsrequired

null

sub_typerequired

integer

typerequired

integer

use_countrequired

integer

user_countrequired

integer

view_countrequired

integer

challenge_positionoptional

null

cmt_swtoptional

boolean

collect_statoptional

integer

comment_configoptional

object

emoji_recommend_listrequired

array

Array items

object

emojirequired

string

scorerequired

integer

long_press_recommend_listrequired

null

preloadrequired

object

predsrequired

string

typeoptional

integer

quick_commentrequired

object

enabledrequired

boolean

rec_leveloptional

integer

quick_comment_emoji_recommend_listrequired

null

comment_panel_show_tab_configoptional

object

comment_tab_info_configrequired

array

Array items

object

priorityrequired

integer

tab_idrequired

integer

tab_namerequired

string

max_tab_countrequired

integer

has_author_commentoptional

boolean

has_visual_commentoptional

boolean

social_quick_commentoptional

object

enabledrequired

boolean

rec_metricsrequired

object

non_social_enabledrequired

string

p_commentrequired

string

p_skiprequired

string

p_stay_timerequired

string

comment_top_bar_componentoptional

array

Array items

object

actionoptional

object

click_hot_area_typerequired

integer

schemarequired

string

biz_idrequired

string

biz_typerequired

integer

desc_prefixoptional

object

contentrequired

string

desc_suffixoptional

object

contentrequired

string

extrarequired

string

namerequired

string

tail_iconoptional

object

is_localrequired

boolean

local_typerequired

integer

template_typerequired

integer

tracer_inforequired

string

comment_topbar_infooptional

null

commerce_config_dataoptional

null

commerce_infooptional

object

adv_promotablerequired

boolean

auction_ad_invitedrequired

boolean

branded_content_typerequired

integer

with_comment_filter_wordsrequired

boolean

is_diversion_adoptional

integer

organic_log_extraoptional

string

content_descoptional

string

content_desc_extraoptional

array

Array items

object

endrequired

integer

hashtag_idrequired

string

hashtag_namerequired

string

is_commercerequired

boolean

line_idxrequired

integer

startrequired

integer

tag_idrequired

string

typerequired

integer

content_modeloptional

object

custom_bizrequired

object

aweme_tracerequired

string

high_quality_boost_infooptional

object

descriptionrequired

string

is_high_quality_postrequired

boolean

linkrequired

string

high_quality_boost_info_v2optional

object

standard_bizrequired

object

ai_comment_photooptional

object

enable_commentrequired

boolean

e_commerceoptional

object

ttec_content_tagrequired

object

recommendation_tag_consumer_strrequired

string

recommendation_tag_creator_strrequired

string

local_alliance_infooptional

object

alliance_item_label_textrequired

string

alliance_item_label_typerequired

integer

tts_voice_infooptional

object

tts_voice_attrrequired

string

tts_voice_reuse_paramsrequired

string

vc_filter_infooptional

object

vc_filter_attrrequired

string

cover_labelsoptional

null

create_timeoptional

integer

creation_infooptional

object

creation_used_functionsrequired

array

Array items

string

descrequired

string

desc_languagerequired

string

disable_search_trending_baroptional

boolean

distanceoptional

string

distribute_typeoptional

integer

follow_up_publish_from_idoptional

integer

geofencingoptional

null

geofencing_regionsoptional

null

green_screen_materialsoptional

null

group_idoptional

string

group_id_listoptional

object

GroupdIdList0required

array

Array items

integer

GroupdIdList1required

array

Array items

integer

has_danmakuoptional

boolean

has_promote_entryoptional

integer

has_vs_entryoptional

boolean

have_dashboardoptional

boolean

hybrid_labeloptional

null

image_infosoptional

null

interact_permissionoptional

object

allow_adding_as_postrequired

object

statusrequired

integer

allow_adding_to_storyrequired

integer

allow_create_stickerrequired

object

statusrequired

integer

allow_story_switch_to_postrequired

object

statusoptional

integer

duetrequired

integer

duet_privacy_settingrequired

integer

stitchrequired

integer

stitch_privacy_settingrequired

integer

upvoterequired

integer

interaction_stickersoptional

array

Array items

object

attrrequired

string

indexrequired

integer

is_non_globalrequired

boolean

is_non_global_v2required

boolean

material_indexrequired

integer

text_inforequired

string

text_sticker_inforequired

object

alignmentrequired

integer

bg_colorrequired

string

source_heightrequired

number

source_widthrequired

number

text_colorrequired

string

text_languagerequired

string

text_sizerequired

integer

track_inforequired

string

typerequired

integer

is_adsoptional

boolean

is_description_translatableoptional

boolean

is_hash_tagoptional

integer

is_nff_or_nroptional

boolean

is_on_this_dayoptional

integer

is_pgcshowoptional

boolean

is_previewoptional

integer

is_relieveoptional

boolean

is_text_sticker_translatableoptional

boolean

is_title_translatableoptional

boolean

is_topoptional

integer

is_vroptional

boolean

item_comment_settingsoptional

integer

item_duetoptional

integer

item_reactoptional

integer

item_stitchoptional

integer

label_topoptional

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

label_top_textoptional

null

long_videooptional

null

main_arch_commonoptional

string

mask_infosoptional

array

misc_infooptional

string

muf_comment_info_v2optional

null

musicoptional

object

albumrequired

string

artistsrequired

array

Array items

object

avatarrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

enter_typerequired

integer

follow_statusrequired

integer

follower_statusrequired

integer

handlerequired

string

is_blockrequired

boolean

is_blockedrequired

boolean

is_private_accountrequired

boolean

is_verifiedrequired

boolean

is_visiblerequired

boolean

nick_namerequired

string

sec_uidrequired

string

statusrequired

integer

uidrequired

string

audition_durationrequired

integer

authorrequired

string

author_deletedrequired

boolean

author_positionrequired

null

avatar_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

binded_challenge_idrequired

integer

can_not_reuserequired

boolean

collect_statrequired

integer

commercial_right_typerequired

integer

cover_largerequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

cover_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

cover_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

dmv_auto_showrequired

boolean

durationrequired

integer

duration_high_precisionrequired

object

audition_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

number

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

shoot_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

video_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

external_song_inforequired

array

extrarequired

string

has_commerce_rightrequired

boolean

idrequired

integer

id_strrequired

string

is_audio_url_with_cookierequired

boolean

is_author_artistrequired

boolean

is_commerce_musicrequired

boolean

is_matched_metadatarequired

boolean

is_originalrequired

boolean

is_original_soundrequired

boolean

is_pgcrequired

boolean

is_play_musicrequired

boolean

is_shooting_allowrequired

boolean

languageoptional

string

log_extrarequired

string

lyric_short_positionrequired

null

matched_songoptional

object

authorrequired

string

chorus_inforequired

object

duration_msrequired

integer

start_msrequired

integer

cover_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

full_durationrequired

integer

h5_urlrequired

string

idrequired

string

performersrequired

null

titlerequired

string

chorusesoptional

null

versesoptional

null

meme_song_inforequired

object

midrequired

string

multi_bit_rate_play_inforequired

null

music_release_infooptional

object

group_release_daterequired

integer

is_new_release_songrequired

boolean

mute_sharerequired

boolean

offline_descrequired

string

owner_handlerequired

string

owner_nicknamerequired

string

play_urlrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

positionrequired

null

prevent_downloadrequired

boolean

preview_end_timerequired

integer

preview_start_timerequired

schema

anyOf

number

anyOf

integer

recommend_statusrequired

integer

search_highlightrequired

null

shoot_durationrequired

integer

source_platformrequired

integer

statusrequired

integer

strong_beat_urloptional

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

style_valueoptional

array

Array items

integer

tag_listrequired

null

theme_valueoptional

array

Array items

integer

titlerequired

string

tt_to_dsp_song_infosrequired

null

uncert_artistsrequired

null

user_countrequired

integer

video_durationrequired

integer

allow_offline_music_to_detail_pageoptional

boolean

can_be_stitchedoptional

boolean

create_timeoptional

integer

has_commerce_right_strictoptional

boolean

has_human_voiceoptional

boolean

is_commerce_music_strictoptional

boolean

music_group_use_countoptional

integer

music_group_v3_idsoptional

array

Array items

integer

music_ugidoptional

integer

music_ugid_use_countoptional

integer

mute_typeoptional

integer

same_group_id_v3optional

integer

sim_group_id_v3optional

integer

tag_list_v2optional

null

theme_tagsoptional

array

Array items

string

matched_pgc_soundoptional

object

artist_infosrequired

array

Array items

object

avatarrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

enter_typerequired

integer

follow_statusrequired

integer

follower_statusrequired

integer

handlerequired

string

is_blockrequired

boolean

is_blockedrequired

boolean

is_private_accountrequired

boolean

is_verifiedrequired

boolean

is_visiblerequired

boolean

nick_namerequired

string

sec_uidrequired

string

statusrequired

integer

uidrequired

string

authorrequired

string

cover_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

mixed_authorrequired

string

mixed_titlerequired

string

music_release_inforequired

object

group_release_daterequired

integer

is_new_release_songrequired

boolean

titlerequired

string

uncert_artistsrequired

null

owner_idoptional

string

sec_uidoptional

string

music_begin_time_in_msoptional

integer

music_selected_fromoptional

string

music_title_styleoptional

integer

music_volumeoptional

string

need_trim_stepoptional

boolean

need_vs_entryoptional

boolean

nickname_positionoptional

null

no_selected_musicoptional

boolean

operator_boost_infooptional

null

origin_comment_idsoptional

null

origin_volumeoptional

string

original_client_textoptional

object

markup_textrequired

string

text_extrarequired

array

Array items

object

hashtag_idoptional

string

hashtag_nameoptional

string

is_commerceoptional

boolean

sec_uidoptional

string

tag_idrequired

string

typerequired

integer

user_idoptional

string

picked_usersoptional

array

playlist_blockedoptional

boolean

poi_re_tag_signaloptional

integer

positionoptional

null

prevent_downloadoptional

boolean

products_infooptional

null

promote_capcut_toggleoptional

integer

promote_icon_textoptional

string

promote_toastoptional

string

promote_toast_keyoptional

string

question_listoptional

null

quick_reply_emojisoptional

array

Array items

string

rateoptional

integer

reference_tts_voice_idsoptional

null

reference_voice_filter_idsoptional

null

regionrequired

string

risk_infosoptional

object

contentrequired

string

risk_sinkrequired

boolean

typerequired

integer

voterequired

boolean

warnrequired

boolean

search_highlightoptional

null

share_infooptional

object

bool_persistrequired

integer

now_invitation_card_image_urlsrequired

null

share_descrequired

string

share_desc_inforequired

string

share_link_descrequired

string

share_quoterequired

string

share_signature_descrequired

string

share_signature_urlrequired

string

share_titlerequired

string

share_title_myselfrequired

string

share_title_otherrequired

string

share_urlrequired

string

whatsapp_descrequired

string

share_urloptional

string

sort_labeloptional

string

statisticsrequired

object

aweme_idrequired

string

collect_countrequired

integer

comment_countrequired

integer

digg_countrequired

integer

download_countrequired

integer

forward_countrequired

integer

lose_comment_countrequired

integer

lose_countrequired

integer

play_countrequired

integer

repost_countrequired

integer

share_countrequired

integer

whatsapp_share_countrequired

integer

statusoptional

object

allow_commentrequired

boolean

allow_sharerequired

boolean

aweme_idrequired

string

download_statusrequired

integer

in_reviewingrequired

boolean

is_deleterequired

boolean

is_prohibitedrequired

boolean

private_statusrequired

integer

review_resultrequired

object

review_statusrequired

integer

reviewedrequired

integer

self_seerequired

boolean

violation_display_statusoptional

integer

sticker_detailoptional

object

attributionsrequired

null

childrenrequired

null

icon_urlrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

idrequired

string

linked_anchorsrequired

null

namerequired

string

owner_idrequired

string

sec_uidrequired

string

tagsrequired

null

stickersoptional

string

suggest_wordsoptional

object

suggest_wordsrequired

array

Array items

object

hint_textrequired

string

qrec_virtual_enablerequired

string

scenerequired

string

wordsrequired

array

Array items

object

penetrate_inforequired

string

wordrequired

string

word_idrequired

string

rich_sug_infooptional

object

sug_icon_typerequired

string

sug_icon_urirequired

string

sug_reasonrequired

string

sug_reason_typerequired

string

word_recordoptional

object

is_personalizedrequired

boolean

qrec_json_inforequired

string

words_labelrequired

string

words_langrequired

string

feed_query_enable_videosugoptional

boolean

support_danmakuoptional

boolean

text_extraoptional

array

Array items

object

endrequired

integer

hashtag_idoptional

string

hashtag_nameoptional

string

is_commerceoptional

boolean

sec_uidoptional

string

startrequired

integer

typerequired

integer

user_idoptional

string

tag_idoptional

string

text_sticker_major_langoptional

string

title_languageoptional

string

ttec_suggest_wordsoptional

object

ttec_suggest_wordsrequired

null

tts_voice_idsoptional

null

ttt_product_recall_typeoptional

integer

uniqid_positionoptional

null

used_full_songoptional

boolean

user_diggedoptional

integer

videorequired

object

CoverTsprequired

schema

anyOf

number

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

integer

anyOf

integer

anyOf

integer

anyOf

integer

ai_dynamic_coverrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

ai_dynamic_cover_bakrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

animated_coverrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

big_thumbsrequired

array

Array items

object

durationrequired

number

fextrequired

string

img_numrequired

integer

img_urisrequired

array

Array items

string

img_urlrequired

string

img_urlsrequired

array

Array items

string

img_x_lenrequired

integer

img_x_sizerequired

integer

img_y_lenrequired

integer

img_y_sizerequired

integer

intervalrequired

integer

urirequired

string

bit_raterequired

array

Array items

object

HDR_bitrequired

string

HDR_typerequired

string

bit_raterequired

integer

dub_infosrequired

null

fpsrequired

integer

gear_namerequired

string

is_bytevc1required

integer

play_addrrequired

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

quality_typerequired

integer

video_extrarequired

string

fid_profile_labelsoptional

string

bit_rate_audiorequired

array

cdn_url_expiredrequired

integer

cla_inforequired

object

caption_infosrequired

array

Array items

object

caption_formatrequired

string

caption_lengthrequired

integer

cla_subtitle_idrequired

integer

complaint_idrequired

integer

expirerequired

integer

is_auto_generatedrequired

boolean

is_original_captionrequired

boolean

langrequired

string

language_coderequired

string

language_idrequired

integer

source_tagrequired

string

sub_idrequired

integer

sub_versionrequired

string

subtitle_typerequired

integer

translation_typerequired

integer

translator_idrequired

integer

urlrequired

string

url_listrequired

array

Array items

string

variantrequired

string

captions_typerequired

integer

creator_edited_caption_idrequired

integer

enable_auto_captionrequired

integer

has_original_audiorequired

integer

hide_original_captionrequired

boolean

no_caption_reasonrequired

integer

vertical_positionsrequired

null

is_author_dubbing_qualifiedoptional

boolean

no_caption_reason_v2optional

integer

original_language_infooptional

object

can_translate_realtimerequired

boolean

can_translate_realtime_skip_translation_lang_checkrequired

boolean

first_subtitle_timerequired

integer

is_burnin_captionrequired

boolean

langrequired

string

language_coderequired

string

language_idrequired

integer

original_caption_typerequired

integer

coverrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

cover_is_customoptional

boolean

download_addroptional

object

data_sizerequired

integer

file_csrequired

string

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

durationrequired

integer

dynamic_coverrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

has_watermarkrequired

boolean

heightrequired

integer

is_bytevc1required

integer

is_callbackrequired

boolean

metarequired

string

misc_download_addrsoptional

string

need_set_tokenrequired

boolean

origin_coverrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

play_addrrequired

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

play_addr_bytevc1required

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

play_addr_h264required

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

ratiorequired

string

source_HDR_typerequired

integer

tagsrequired

null

widthrequired

integer

did_profile_labelsoptional

string

download_no_watermark_addroptional

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

vid_profile_labelsoptional

string

is_long_videooptional

integer

video_modeloptional

string

video_controloptional

object

allow_downloadrequired

boolean

allow_duetrequired

boolean

allow_dynamic_wallpaperrequired

boolean

allow_musicrequired

boolean

allow_reactrequired

boolean

allow_stitchrequired

boolean

draft_progress_barrequired

integer

prevent_download_typerequired

integer

share_typerequired

integer

show_progress_barrequired

integer

timer_statusrequired

integer

video_labelsoptional

array

video_textoptional

array

voice_filter_idsoptional

null

with_promotional_musicoptional

boolean

without_watermarkoptional

boolean

is_eligible_for_commissionrequired

boolean

is_paid_partnershiprequired

boolean

create_time_utcrequired

string

{
  "format": "date-time"
}

urlrequired

string

shop_product_urlrequired

string

ai_remix_infooptional

object

has_entrancerequired

boolean

bottom_productsoptional

null

c2pa_infooptional

object

aigc_srcrequired

string

c2pa_extra_datarequired

string

dedup_errrequired

string

dedup_srcrequired

string

first_aigc_srcrequired

string

first_srcrequired

string

is_capcutrequired

boolean

is_tiktokrequired

boolean

last_aigc_srcrequired

string

last_srcrequired

string

total_audiorequired

integer

total_errrequired

integer

total_imgrequired

integer

total_srcrequired

integer

total_vidrequired

integer

upload_durrequired

integer

comment_at_tako_infooptional

object

show_tako_accountrequired

integer

content_leveloptional

integer

content_original_typeoptional

integer

content_size_typeoptional

integer

content_typeoptional

string

creator_ai_commentoptional

object

eligible_videorequired

boolean

has_ai_topicrequired

boolean

not_eligible_reasonrequired

integer

ecosystem_perception_enhancementoptional

null

is_paid_contentoptional

boolean

item_allow_ai_remixoptional

integer

meme_reg_infooptional

object

music_end_time_in_msoptional

integer

paid_content_infooptional

object

paid_collection_idrequired

integer

promoteoptional

object

extrarequired

string

is_show_video_viewrequired

boolean

promote_traffic_tagrequired

object

need_trackrequired

boolean

traffic_levelrequired

integer

versionrequired

string

video_view_countrequired

integer

video_view_schemarequired

string

right_productsoptional

null

shoot_tab_nameoptional

string

smart_search_infooptional

object

ai_overview_intent_typerequired

integer

ask_tako_intent_typerequired

integer

find_similar_intent_typerequired

integer

related_videos_intent_typerequired

integer

title_smart_search_panel_typerequired

integer

social_interaction_bloboptional

object

auxiliary_model_contentrequired

string

solaria_profileoptional

object

profilerequired

string

standard_component_infooptional

object

buttonrequired

object

buttonsrequired

array

Array items

object

keyrequired

object

component_keyrequired

string

signalrequired

object

auto_displayrequired

boolean

coderequired

integer

releasablerequired

boolean

uirequired

object

templaterequired

object

actionsrequired

array

Array items

object

eventsrequired

array

Array items

object

typerequired

string

nextoptional

array

Array items

object

nextrequired

array

Array items

object

paramsrequired

string

typerequired

string

typerequired

string

paramsoptional

string

keyrequired

string

fieldsrequired

string

typerequired

integer

ui_typerequired

integer

enable_standard_buttonrequired

boolean

banner_enabledoptional

boolean

survey_infooptional

null

tako_bubble_infooptional

object

tako_bubble_enablerequired

boolean

visual_search_infooptional

object

fallback_vtag_enablerequired

boolean

fallback_vtag_enable_typerequired

integer

long_press_entrance_enablerequired

boolean

long_press_entrance_enable_typerequired

integer

screenshot_entrance_enablerequired

integer

visual_search_intent_levelrequired

integer

vtag_enablerequired

boolean

vtag_enable_typerequired

integer

is_adoptional

boolean

retry_typeoptional

integer

poi_dataoptional

object

address_inforequired

object

addressrequired

string

city_coderequired

string

city_namerequired

string

geohashrequired

string

l0_geoname_idrequired

string

latrequired

string

lngrequired

string

region_coderequired

string

collect_inforequired

string

comment_anchorrequired

object

has_sub_arrowrequired

boolean

hide_listrequired

null

schemarequired

string

sub_tag_exp_timerequired

integer

sub_tag_exp_typerequired

integer

sub_tagsrequired

array

Array items

object

namerequired

string

priorityrequired

integer

typerequired

integer

track_inforequired

string

iconrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

info_sourcerequired

string

is_collectedrequired

boolean

location_descrequired

string

poi_idrequired

string

poi_mapkit_collectrequired

boolean

poi_namerequired

string

poi_request_extra_paramsrequired

string

poi_review_configrequired

object

poi_typerequired

string

real_time_fav_cntrequired

integer

thumbnailrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

type_levelrequired

string

video_anchorrequired

object

has_sub_arrowrequired

boolean

hide_listrequired

null

schemarequired

string

sub_tag_exp_timerequired

integer

sub_tag_exp_typerequired

integer

sub_tagsrequired

array

Array items

object

namerequired

string

priorityrequired

integer

typerequired

integer

suffixrequired

string

track_inforequired

string

video_countrequired

integer

poi_traceoptional

object

event_inforequired

string

poi_idrequired

integer

unavailable_reasonrequired

string

allow_giftoptional

boolean

playlist_infooptional

object

indexrequired

integer

item_totalrequired

integer

mix_idrequired

string

namerequired

string

cursorrequired

integer

extraoptional

object

fatal_item_idsrequired

array

logidrequired

string

nowrequired

integer

has_moreoptional

integer

log_pboptional

object

impr_idrequired

string

status_codeoptional

integer

status_msgoptional

string

401Invalid or missing x-api-key

402No credits remaining

403Upstream denied (age gate, audience controls)

404Resource or endpoint not found

429Rate limited