import {z} from 'zod' export type GetApiV1TiktokSearchVideosArgs = {query: string, region?: string | undefined, count?: number | undefined, cursor?: string | undefined}; export type GetApiV1TiktokSearchVideosOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const tikTokAuthor = z.object({id: z.string().optional(), sec_uid: z.string().optional(), unique_id: z.string().optional(), nickname: z.string().optional(), avatar_thumb: z.string().optional(), avatar_medium: z.string().optional(), avatar_larger: z.string().optional(), signature: z.string().optional(), verified: z.boolean().optional(), private_account: z.boolean().optional(), follower_count: z.number().int().optional(), following_count: z.number().int().optional(), heart_count: z.number().int().optional(), video_count: z.number().int().optional(), digg_count: z.number().int().optional(), region: z.string().optional(), verify_reason: z.string().optional(), verification_type: z.number().int().optional(), account_region: z.string().optional(), language: z.string().optional(), original_musician: z.boolean().optional(), is_star: z.boolean().optional(), ins_id: z.string().optional(), twitter_name: z.string().optional(), youtube_channel_title: z.string().optional(), room_id: z.string().optional(), commerce_user_level: z.number().int().optional(), with_shop_entry: z.boolean().optional()}); export const tikTokMusic = z.object({id: z.string().optional(), title: z.string().optional(), author_name: z.string().optional(), album: z.string().optional(), duration: z.number().int().optional(), play_url: z.string().optional(), cover_thumb: z.string().optional(), cover_medium: z.string().optional(), cover_large: z.string().optional(), original: z.boolean().optional(), is_copyrighted: z.boolean().optional(), mid: z.string().optional(), owner_id: z.string().optional(), owner_nickname: z.string().optional(), is_commerce_music: z.boolean().optional(), is_original_sound: z.boolean().optional(), video_count: z.number().int().optional(), user_count: z.number().int().optional()}); export const tikTokStats = z.object({play_count: z.number().int().optional(), digg_count: z.number().int().optional(), comment_count: z.number().int().optional(), share_count: z.number().int().optional(), collect_count: z.number().int().optional(), download_count: z.number().int().optional(), forward_count: z.number().int().optional(), whatsapp_share_count: z.number().int().optional(), repost_count: z.number().int().optional()}); export const tikTokVideoMeta = z.object({height: z.number().int().optional(), width: z.number().int().optional(), duration: z.number().int().optional(), ratio: z.string().optional(), format: z.string().optional(), definition: z.string().optional(), codec_type: z.string().optional(), encoded_type: z.string().optional(), bitrate: z.number().int().optional(), cover: z.string().optional(), origin_cover: z.string().optional(), dynamic_cover: z.string().optional(), animated_cover: z.string().optional(), ai_dynamic_cover: z.string().optional(), share_cover: z.string().optional(), play_addr: z.string().optional(), download_addr: z.string().optional(), download_no_watermark_addr: z.string().optional(), has_watermark: z.boolean().optional(), volume_loudness: z.number().optional(), volume_peak: z.number().optional()}); export const tikTokVideoStatus = z.object({is_delete: z.boolean().optional(), allow_share: z.boolean().optional(), allow_comment: z.boolean().optional(), private_status: z.number().int().optional(), in_reviewing: z.boolean().optional(), reviewed: z.boolean().optional(), is_prohibited: z.boolean().optional(), download_status: z.number().int().optional(), self_see: z.boolean().optional()}); export const tikTokVideoControl = z.object({allow_download: z.boolean().optional(), allow_duet: z.boolean().optional(), allow_stitch: z.boolean().optional(), allow_react: z.boolean().optional(), allow_comment: z.boolean().optional(), share_type: z.number().int().optional(), prevent_download: z.boolean().optional()}); export const tikTokAnchor = z.object({id: z.string().optional(), type: z.number().int().optional(), keyword: z.string().optional(), url: z.string().optional(), icon: z.string().optional()}); export const tikTokTextExtra = z.object({type: z.string().optional(), hashtag_name: z.string().optional(), user_unique_id: z.string().optional(), user_id: z.string().optional(), start: z.number().int().optional(), end: z.number().int().optional()}); export const tikTokChallenge = z.object({id: z.string().optional(), title: z.string().optional(), desc: z.string().optional(), cover: z.string().optional(), is_commerce: z.boolean().optional()}); export const tikTokEffectSticker = z.object({id: z.string().optional(), name: z.string().optional(), photo_url: z.string().optional()}); export const tikTokSubtitle = z.object({language: z.string().optional(), language_code: z.string().optional(), url: z.string().optional(), source: z.string().optional(), version: z.string().optional(), format: z.string().optional()}); export const tikTokVideo = z.object({id: z.string(), description: z.string().optional(), text_language: z.string().optional(), create_time_utc: z.number().int().optional(), create_time_at: z.string().optional(), region: z.string().optional(), url: z.string().optional(), share_url: z.string().optional(), group_id: z.string().optional(), aweme_type: z.number().int().optional(), content_type: z.string().optional(), author: tikTokAuthor.optional(), music: tikTokMusic.optional(), stats: tikTokStats.optional(), video: tikTokVideoMeta.optional(), status: tikTokVideoStatus.optional(), video_control: tikTokVideoControl.optional(), anchors: z.array(tikTokAnchor).optional(), hashtags: z.array(z.string()).optional(), mentions: z.array(z.string()).optional(), text_extra: z.array(tikTokTextExtra).optional(), challenges: z.array(tikTokChallenge).optional(), effect_stickers: z.array(tikTokEffectSticker).optional(), is_slideshow: z.boolean().optional(), image_urls: z.array(z.string()).optional(), is_ad: z.boolean().optional(), is_aigc: z.boolean().optional(), aigc_description: z.string().optional(), is_pinned: z.boolean().optional(), is_muted: z.boolean().optional(), secret: z.boolean().optional(), private_item: z.boolean().optional(), duet_enabled: z.boolean().optional(), stitch_enabled: z.boolean().optional(), share_enabled: z.boolean().optional(), comment_status: z.string().optional(), can_repost: z.boolean().optional(), is_paid_content: z.boolean().optional(), is_on_this_day: z.boolean().optional(), support_danmaku: z.boolean().optional(), subtitles: z.array(tikTokSubtitle).optional(), voice_to_text: z.string().optional(), diversification_labels: z.array(z.string()).optional(), suggested_words: z.array(z.string()).optional()}); export const tikTokCursorPage = z.object({has_more: z.boolean().optional(), cursor: z.string().optional(), count: z.number().int().optional(), search_id: z.string().optional()}); export const videoListResponse = z.object({videos: z.array(tikTokVideo).optional(), pagination: tikTokCursorPage.optional(), region: z.string()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Search Videos * * GET /v1/tiktok/search/videos */ export const getApiV1TiktokSearchVideos = async (args: GetApiV1TiktokSearchVideosArgs, options?: GetApiV1TiktokSearchVideosOptions) => { const {baseUrl = "https://scrapebadger.com", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.query != null) query.append("query", String(args.query)) if (args.region != null) query.append("region", String(args.region)) if (args.count != null) query.append("count", String(args.count)) if (args.cursor != null) query.append("cursor", String(args.cursor)) if (apiKey !== undefined) headers.set("x-api-key", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/v1/tiktok/search/videos${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(videoListResponse, await res.json()) };