api.md

Shared

Types:

• CreatorBasic
• ProfileSummary
• RawScraperError

Health

Types:

• HealthCheckResponse

Methods:

• client.health.check() -> HealthCheckResponse

Creators

Types:

• CreatorRetrieveResponse
• CreatorAutocompleteResponse
• CreatorLookalikeResponse
• CreatorMatchResponse

Methods:

• client.creators.retrieve(id, { ...params }) -> CreatorRetrieveResponse
• client.creators.autocomplete({ ...params }) -> CreatorAutocompleteResponse
• client.creators.lookalike({ ...params }) -> CreatorLookalikeResponsesBodyCursor
• client.creators.match({ ...params }) -> CreatorMatchResponse

Search

Types:

• MatchInfo
• SearchCreateResponse
• SearchRetrieveResponse

Methods:

• client.search.create({ ...params }) -> SearchCreateResponse
• client.search.retrieve(id, { ...params }) -> SearchRetrieveResponsesQueryCursor

Profiles

Types:

• ProfileActivity
• ProfileGrowth
• ProfileMetrics
• ProfileResponseData
• ProfileGetResponse
• ProfileLookupResponse

Methods:

• client.profiles.get(username, { ...params }) -> ProfileGetResponse
• client.profiles.lookup({ ...params }) -> ProfileLookupResponse

CreatorEmails

Types:

• CreatorEmailLookupResponse

Methods:

• client.creatorEmails.lookup({ ...params }) -> CreatorEmailLookupResponse

Posts

Types:

• PostListResponse

Methods:

• client.posts.list({ ...params }) -> PostListResponsesQueryCursor

Raw

Instagram

Types:

• InstagramSinglePostResponse
• InstagramTranscriptResponse
• InstagramGetPostResponse
• InstagramGetPostsResponse
• InstagramGetProfileResponse
• InstagramGetTranscriptResponse
• InstagramGetTranscriptsResponse

Methods:

• client.raw.instagram.getPost(shortcode) -> InstagramGetPostResponse
• client.raw.instagram.getPosts({ ...params }) -> InstagramGetPostsResponse
• client.raw.instagram.getProfile(username, { ...params }) -> InstagramGetProfileResponse
• client.raw.instagram.getTranscript(shortcode, { ...params }) -> InstagramGetTranscriptResponse
• client.raw.instagram.getTranscripts({ ...params }) -> InstagramGetTranscriptsResponse

Youtube

Types:

• TranscriptSegment
• YoutubeGetChannelResponse
• YoutubeGetChannelTranscriptsResponse
• YoutubeGetTranscriptResponse
• YoutubeGetVideoResponse
• YoutubeSearchResponse
• YoutubeTypeaheadResponse

Methods:

• client.raw.youtube.getChannel(handle, { ...params }) -> YoutubeGetChannelResponse
• client.raw.youtube.getChannelTranscripts(handle, { ...params }) -> YoutubeGetChannelTranscriptsResponse
• client.raw.youtube.getTranscript(videoID, { ...params }) -> YoutubeGetTranscriptResponse
• client.raw.youtube.getVideo(videoID) -> YoutubeGetVideoResponse
• client.raw.youtube.search({ ...params }) -> YoutubeSearchResponse
• client.raw.youtube.typeahead({ ...params }) -> YoutubeTypeaheadResponse

Tiktok

Types:

• BatchFailure
• Profile
• Transcript
• TranscriptBatchSuccess
• Video
• VideoBatchSuccess
• VideoResponse
• TiktokGetMusicResponse
• TiktokGetProfileResponse
• TiktokGetVideoResponse
• TiktokGetVideoCaptionsResponse
• TiktokGetVideoTranscriptResponse
• TiktokGetVideoTranscriptsResponse
• TiktokGetVideosResponse
• TiktokListCommentRepliesResponse
• TiktokListHashtagVideosResponse
• TiktokListMusicVideosResponse
• TiktokListProfileVideosResponse
• TiktokListVideoCommentsResponse
• TiktokSearchUsersResponse
• TiktokSearchVideosResponse

Methods:

• client.raw.tiktok.getMusic({ ...params }) -> TiktokGetMusicResponse
• client.raw.tiktok.getProfile(username) -> TiktokGetProfileResponse
• client.raw.tiktok.getVideo({ ...params }) -> TiktokGetVideoResponse
• client.raw.tiktok.getVideoCaptions({ ...params }) -> TiktokGetVideoCaptionsResponse
• client.raw.tiktok.getVideoTranscript({ ...params }) -> TiktokGetVideoTranscriptResponse
• client.raw.tiktok.getVideoTranscripts({ ...params }) -> TiktokGetVideoTranscriptsResponse
• client.raw.tiktok.getVideos({ ...params }) -> TiktokGetVideosResponse
• client.raw.tiktok.listCommentReplies({ ...params }) -> TiktokListCommentRepliesResponse
• client.raw.tiktok.listHashtagVideos({ ...params }) -> TiktokListHashtagVideosResponse
• client.raw.tiktok.listMusicVideos({ ...params }) -> TiktokListMusicVideosResponse
• client.raw.tiktok.listProfileVideos(username, { ...params }) -> TiktokListProfileVideosResponse
• client.raw.tiktok.listVideoComments({ ...params }) -> TiktokListVideoCommentsResponse
• client.raw.tiktok.searchUsers({ ...params }) -> TiktokSearchUsersResponse
• client.raw.tiktok.searchVideos({ ...params }) -> TiktokSearchVideosResponse