/v1/tiktok/song/videos
TikToks using Song
Get the TikToks using a song
| 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 |
|---|---|---|
clipIdTikTok sound clip ID: the trailing number in a /music/ URL, such as 7370375686554782506. | query / optional |
|
cursorThe cursor to get the next page of results. | 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/song/videos' \
--header 'x-api-key: YOUR_API_KEY'JavaScript
const response = await fetch("https://api.fetchproof.com/v1/tiktok/song/videos", {
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/song/videos",
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
added_sound_music_inforequired
object
albumrequired
string
allow_offline_music_to_detail_pagerequired
boolean
artistsrequired
array
audition_durationrequired
integer
authorrequired
string
author_deletedrequired
boolean
author_positionrequired
null
binded_challenge_idrequired
integer
can_be_stitchedrequired
boolean
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
cover_mediumrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
cover_thumbrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
create_timerequired
integer
dmv_auto_showrequired
boolean
durationrequired
integer
duration_high_precisionrequired
object
audition_duration_precisionrequired
number
duration_precisionrequired
number
shoot_duration_precisionrequired
number
video_duration_precisionrequired
integer
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
languagerequired
string
log_extrarequired
string
lyric_short_positionrequired
null
matched_songrequired
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
meme_song_inforequired
object
midrequired
string
multi_bit_rate_play_inforequired
null
music_release_inforequired
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
number
recommend_statusrequired
integer
search_highlightrequired
null
shoot_durationrequired
integer
source_platformrequired
integer
statusrequired
integer
strong_beat_urlrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
style_valuerequired
array
Array items
integer
tag_listrequired
null
theme_valuerequired
array
Array items
integer
titlerequired
string
tt_to_dsp_song_infosrequired
null
uncert_artistsrequired
null
user_countrequired
integer
video_durationrequired
integer
aigc_inforequired
object
aigc_label_typerequired
integer
created_by_airequired
boolean
allow_giftrequired
boolean
anchorsrequired
array
Array items
object
actionsrequired
array
anchor_strongrequired
null
captionrequired
string
component_keyrequired
string
descriptionrequired
string
general_typerequired
integer
iconrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
idrequired
string
keywordrequired
string
log_extrarequired
string
schemarequired
string
thumbnailrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
typerequired
integer
anchors_extrasrequired
string
animated_image_inforequired
object
effectrequired
integer
typerequired
integer
authorrequired
object
ad_cover_urlrequired
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
cha_listrequired
null
comment_filter_statusrequired
integer
comment_settingrequired
integer
commerce_user_levelrequired
integer
cover_urlrequired
array
custom_verifyrequired
string
download_settingrequired
integer
duet_settingrequired
integer
enabled_filter_all_commentsrequired
boolean
enterprise_verify_reasonrequired
string
follow_statusrequired
integer
follower_statusrequired
integer
followers_detailrequired
null
friends_statusrequired
integer
is_ad_fakerequired
boolean
is_blockrequired
boolean
is_discipline_memberrequired
boolean
is_starrequired
boolean
languagerequired
string
nicknamerequired
string
prevent_downloadrequired
boolean
regionrequired
string
relative_usersrequired
null
room_idrequired
integer
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
short_idrequired
string
signaturerequired
string
stitch_settingrequired
integer
uidrequired
string
unique_idrequired
string
user_now_pack_inforequired
object
verification_typerequired
integer
verify_inforequired
string
video_iconrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
url_prefixrequired
null
widthrequired
integer
with_commerce_entryrequired
boolean
author_user_idrequired
integer
aweme_aclrequired
object
download_generalrequired
object
coderequired
integer
extrarequired
string
muterequired
boolean
show_typerequired
integer
transcoderequired
integer
download_mask_panelrequired
object
coderequired
integer
extrarequired
string
muterequired
boolean
show_typerequired
integer
transcoderequired
integer
platform_listrequired
null
press_action_listrequired
null
share_action_listrequired
null
share_generalrequired
object
coderequired
integer
extrarequired
string
muterequired
boolean
show_typerequired
integer
toast_msgrequired
string
transcoderequired
integer
share_list_statusrequired
integer
aweme_idrequired
string
aweme_typerequired
integer
bannersrequired
null
behind_the_song_music_idsrequired
null
behind_the_song_video_music_idsrequired
null
bodydance_scorerequired
integer
branded_content_accountsrequired
null
cc_template_inforequired
object
author_namerequired
string
clip_countrequired
integer
descrequired
string
duration_millisecondsrequired
integer
match_typerequired
string
music_copyrightrequired
boolean
onelinkrequired
string
related_music_idrequired
string
schema_extrarequired
string
style_typerequired
integer
template_idrequired
string
cha_listrequired
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_positionrequired
null
cmt_swtrequired
boolean
collect_statrequired
integer
comment_configrequired
object
comment_panel_show_tab_configrequired
null
emoji_recommend_listrequired
null
long_press_recommend_listrequired
null
preloadrequired
object
predsrequired
string
quick_commentrequired
object
enabledrequired
boolean
quick_comment_emoji_recommend_listrequired
null
commerce_config_datarequired
null
commerce_inforequired
object
adv_promotablerequired
boolean
auction_ad_invitedrequired
boolean
branded_content_typerequired
integer
with_comment_filter_wordsrequired
boolean
content_descrequired
string
content_desc_extrarequired
array
content_modelrequired
object
custom_bizrequired
object
aweme_tracerequired
string
standard_bizrequired
object
e_commercerequired
object
ttec_content_tagrequired
object
recommendation_tag_consumer_strrequired
string
recommendation_tag_creator_strrequired
string
tts_voice_inforequired
object
tts_voice_attrrequired
string
tts_voice_reuse_paramsrequired
string
vc_filter_inforequired
object
vc_filter_attrrequired
string
content_original_typerequired
integer
content_size_typerequired
integer
content_typerequired
string
cover_labelsrequired
null
create_timerequired
integer
creation_inforequired
object
creation_used_functionsrequired
array
Array items
string
descrequired
string
desc_languagerequired
string
distancerequired
string
distribute_typerequired
integer
follow_up_publish_from_idrequired
integer
geofencingrequired
null
geofencing_regionsrequired
null
green_screen_materialsrequired
null
group_idrequired
string
has_danmakurequired
boolean
has_promote_entryrequired
integer
has_vs_entryrequired
boolean
have_dashboardrequired
boolean
hybrid_labelrequired
null
image_infosrequired
null
interact_permissionrequired
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
duetrequired
integer
duet_privacy_settingrequired
integer
stitchrequired
integer
stitch_privacy_settingrequired
integer
upvoterequired
integer
interaction_stickersrequired
null
is_adsrequired
boolean
is_description_translatablerequired
boolean
is_hash_tagrequired
integer
is_nff_or_nrrequired
boolean
is_pgcshowrequired
boolean
is_previewrequired
integer
is_relieverequired
boolean
is_text_sticker_translatablerequired
boolean
is_title_translatablerequired
boolean
is_toprequired
integer
is_vrrequired
boolean
item_comment_settingsrequired
integer
item_duetrequired
integer
item_reactrequired
integer
item_stitchrequired
integer
label_music_starter_textrequired
string
label_toprequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
label_top_textrequired
null
long_videorequired
null
main_arch_commonrequired
string
mask_infosrequired
array
misc_inforequired
string
musicrequired
object
albumrequired
string
allow_offline_music_to_detail_pagerequired
boolean
artistsrequired
array
audition_durationrequired
integer
authorrequired
string
author_deletedrequired
boolean
author_positionrequired
null
binded_challenge_idrequired
integer
can_be_stitchedrequired
boolean
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
cover_mediumrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
cover_thumbrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
create_timerequired
integer
dmv_auto_showrequired
boolean
durationrequired
integer
duration_high_precisionrequired
object
audition_duration_precisionrequired
number
duration_precisionrequired
number
shoot_duration_precisionrequired
number
video_duration_precisionrequired
integer
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
languagerequired
string
log_extrarequired
string
lyric_short_positionrequired
null
matched_songrequired
object
authorrequired
string
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
meme_song_inforequired
object
midrequired
string
multi_bit_rate_play_inforequired
null
music_release_inforequired
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
number
recommend_statusrequired
integer
search_highlightrequired
null
shoot_durationrequired
integer
source_platformrequired
integer
statusrequired
integer
strong_beat_urlrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
style_valuerequired
array
Array items
integer
tag_listrequired
null
theme_valuerequired
array
Array items
integer
titlerequired
string
tt_to_dsp_song_infosrequired
null
uncert_artistsrequired
null
user_countrequired
integer
video_durationrequired
integer
music_begin_time_in_msrequired
integer
music_end_time_in_msrequired
integer
music_selected_fromrequired
string
music_title_stylerequired
integer
music_volumerequired
string
need_trim_steprequired
boolean
need_vs_entryrequired
boolean
nickname_positionrequired
null
origin_comment_idsrequired
null
origin_volumerequired
string
original_client_textrequired
object
markup_textrequired
string
text_extrarequired
array
Array items
object
hashtag_idrequired
string
hashtag_namerequired
string
is_commercerequired
boolean
sec_uidrequired
string
tag_idrequired
string
typerequired
integer
user_idrequired
string
picked_usersrequired
array
playlist_blockedrequired
boolean
positionrequired
null
prevent_downloadrequired
boolean
promote_capcut_togglerequired
integer
promote_icon_textrequired
string
promote_toastrequired
string
promote_toast_keyrequired
string
question_listrequired
null
quick_reply_emojisrequired
array
Array items
string
raterequired
integer
reference_tts_voice_idsrequired
null
reference_voice_filter_idsrequired
null
regionrequired
string
retry_typerequired
integer
risk_infosrequired
object
contentrequired
string
risk_sinkrequired
boolean
typerequired
integer
voterequired
boolean
warnrequired
boolean
share_inforequired
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_urlrequired
string
shoot_tab_namerequired
string
social_interaction_blobrequired
object
auxiliary_model_contentrequired
string
solaria_profilerequired
object
profilerequired
string
sort_labelrequired
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
statusrequired
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
support_danmakurequired
boolean
text_extrarequired
array
Array items
object
endrequired
integer
hashtag_idrequired
string
hashtag_namerequired
string
is_commercerequired
boolean
sec_uidrequired
string
startrequired
integer
typerequired
integer
user_idrequired
string
text_sticker_major_langrequired
string
title_languagerequired
string
ttec_suggest_wordsrequired
object
ttec_suggest_wordsrequired
null
tts_voice_idsrequired
null
ttt_product_recall_typerequired
integer
uniqid_positionrequired
null
upvote_inforequired
object
friends_recall_inforequired
string
repost_initiate_scorerequired
integer
user_upvotedrequired
boolean
upvote_preloadrequired
object
need_pull_upvote_inforequired
boolean
used_full_songrequired
boolean
user_diggedrequired
integer
videorequired
object
CoverTsprequired
number
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
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
bit_rate_audiorequired
array
cdn_url_expiredrequired
integer
cla_inforequired
object
caption_infosrequired
null
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
coverrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
cover_is_customrequired
boolean
durationrequired
integer
dynamic_coverrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
integer
has_watermarkrequired
boolean
heightrequired
integer
is_bytevc1required
integer
is_callbackrequired
boolean
metarequired
string
need_set_tokenrequired
boolean
origin_coverrequired
object
heightrequired
integer
urirequired
string
url_listrequired
array
Array items
string
url_prefixrequired
null
widthrequired
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
video_controlrequired
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_labelsrequired
array
video_textrequired
array
visual_search_inforequired
object
voice_filter_idsrequired
null
with_promotional_musicrequired
boolean
without_watermarkrequired
boolean
can_pin_videorequired
boolean
cursorrequired
integer
extrarequired
object
fatal_item_idsrequired
array
logidrequired
string
nowrequired
integer
has_morerequired
integer
log_pbrequired
object
impr_idrequired
string
need_lazy_loadingrequired
boolean
status_coderequired
integer
status_msgrequired
string