@captapi/sdk 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -0
- package/dist/core.d.ts +33 -0
- package/dist/core.js +67 -0
- package/dist/generated.d.ts +1491 -0
- package/dist/generated.js +964 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +3 -0
- package/package.json +51 -0
|
@@ -0,0 +1,1491 @@
|
|
|
1
|
+
import { HttpCore, type ApiEnvelope, type CaptapiOptions } from "./core.js";
|
|
2
|
+
export interface YoutubeTranscriptParams {
|
|
3
|
+
/** Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
4
|
+
url: string;
|
|
5
|
+
/** Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. */
|
|
6
|
+
language?: string;
|
|
7
|
+
}
|
|
8
|
+
export interface YoutubeSummarizeParams {
|
|
9
|
+
/** Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
10
|
+
url: string;
|
|
11
|
+
/** Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. */
|
|
12
|
+
language?: string;
|
|
13
|
+
}
|
|
14
|
+
export interface YoutubeVideoDetailsParams {
|
|
15
|
+
/** Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
16
|
+
url: string;
|
|
17
|
+
}
|
|
18
|
+
export interface YoutubeCommentsParams {
|
|
19
|
+
/** Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
20
|
+
url: string;
|
|
21
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
22
|
+
limit?: number;
|
|
23
|
+
}
|
|
24
|
+
export interface YoutubeChannelDetailsParams {
|
|
25
|
+
/** YouTube channel URL, e.g. https://youtube.com/@handle or /channel/UC... The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
26
|
+
url: string;
|
|
27
|
+
}
|
|
28
|
+
export interface YoutubeSearchParams {
|
|
29
|
+
/** Search query or keywords (min 2 chars). */
|
|
30
|
+
q: string;
|
|
31
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
32
|
+
limit?: number;
|
|
33
|
+
}
|
|
34
|
+
export interface YoutubeChannelVideosParams {
|
|
35
|
+
/** YouTube channel URL, e.g. https://youtube.com/@handle or /channel/UC... The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
36
|
+
url: string;
|
|
37
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
38
|
+
limit?: number;
|
|
39
|
+
/** Set true to use YouTube RSS for faster results with less detailed metadata. Leave false when viewCount/duration quality matters. */
|
|
40
|
+
fast?: boolean;
|
|
41
|
+
}
|
|
42
|
+
export interface YoutubePlaylistVideosParams {
|
|
43
|
+
/** YouTube playlist URL, e.g. https://youtube.com/playlist?list=ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
44
|
+
url: string;
|
|
45
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
46
|
+
limit?: number;
|
|
47
|
+
/** Set true to use YouTube RSS for faster results with less detailed metadata. Leave false when viewCount/duration quality matters. */
|
|
48
|
+
fast?: boolean;
|
|
49
|
+
}
|
|
50
|
+
export interface YoutubePlaylistParams {
|
|
51
|
+
/** YouTube playlist URL, e.g. https://youtube.com/playlist?list=ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
52
|
+
url: string;
|
|
53
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
54
|
+
limit?: number;
|
|
55
|
+
/** Set true to use YouTube RSS for faster results with less detailed metadata. Leave false when viewCount/duration quality matters. */
|
|
56
|
+
fast?: boolean;
|
|
57
|
+
}
|
|
58
|
+
export interface YoutubeVideoDownloadParams {
|
|
59
|
+
/** Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
60
|
+
url: string;
|
|
61
|
+
}
|
|
62
|
+
export interface YoutubeShortsTranscriptParams {
|
|
63
|
+
/** Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
64
|
+
url: string;
|
|
65
|
+
/** Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. */
|
|
66
|
+
language?: string;
|
|
67
|
+
}
|
|
68
|
+
export interface YoutubeShortsSummarizeParams {
|
|
69
|
+
/** Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
70
|
+
url: string;
|
|
71
|
+
/** Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. */
|
|
72
|
+
language?: string;
|
|
73
|
+
}
|
|
74
|
+
export interface YoutubeShortsDetailsParams {
|
|
75
|
+
/** Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
76
|
+
url: string;
|
|
77
|
+
}
|
|
78
|
+
export interface YoutubeShortsCommentsParams {
|
|
79
|
+
/** Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
80
|
+
url: string;
|
|
81
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
82
|
+
limit?: number;
|
|
83
|
+
}
|
|
84
|
+
export interface YoutubeChannelShortsParams {
|
|
85
|
+
/** YouTube channel URL, e.g. https://youtube.com/@handle or /channel/UC... The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
86
|
+
url: string;
|
|
87
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
88
|
+
limit?: number;
|
|
89
|
+
}
|
|
90
|
+
export interface YoutubeTrendingShortsParams {
|
|
91
|
+
/** Seed keyword for trending Shorts. Default trending. */
|
|
92
|
+
q?: string;
|
|
93
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
94
|
+
limit?: number;
|
|
95
|
+
}
|
|
96
|
+
export interface YoutubeChannelStreamsParams {
|
|
97
|
+
/** YouTube channel URL, e.g. https://youtube.com/@handle or /channel/UC... The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
98
|
+
url: string;
|
|
99
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
100
|
+
limit?: number;
|
|
101
|
+
}
|
|
102
|
+
export interface YoutubeHashtagSearchParams {
|
|
103
|
+
/** Hashtag with or without the # (min 2 chars). */
|
|
104
|
+
q: string;
|
|
105
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
106
|
+
limit?: number;
|
|
107
|
+
}
|
|
108
|
+
export interface YoutubeCommentRepliesParams {
|
|
109
|
+
/** Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
110
|
+
url: string;
|
|
111
|
+
/** ID of the parent comment to fetch replies for (from the comments endpoint). */
|
|
112
|
+
comment_id: string;
|
|
113
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
114
|
+
limit?: number;
|
|
115
|
+
}
|
|
116
|
+
export interface YoutubeChannelPlaylistsParams {
|
|
117
|
+
/** YouTube channel URL, e.g. https://youtube.com/@handle or /channel/UC... The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
118
|
+
url: string;
|
|
119
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
120
|
+
limit?: number;
|
|
121
|
+
}
|
|
122
|
+
export interface YoutubeCommunityPostsParams {
|
|
123
|
+
/** YouTube channel URL, e.g. https://youtube.com/@handle or /channel/UC... The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
124
|
+
url: string;
|
|
125
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
126
|
+
limit?: number;
|
|
127
|
+
}
|
|
128
|
+
export interface YoutubeCommunityPostDetailsParams {
|
|
129
|
+
/** YouTube community post URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
130
|
+
url: string;
|
|
131
|
+
}
|
|
132
|
+
export interface YoutubeVideoSponsorsParams {
|
|
133
|
+
/** Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
134
|
+
url: string;
|
|
135
|
+
}
|
|
136
|
+
export declare class YoutubeApi {
|
|
137
|
+
private readonly core;
|
|
138
|
+
constructor(core: HttpCore);
|
|
139
|
+
/** YouTube Transcript — Extract the full timestamped transcript of a YouTube video. (2 credits) */
|
|
140
|
+
transcript(params: YoutubeTranscriptParams): Promise<ApiEnvelope>;
|
|
141
|
+
/** YouTube Summarizer — AI summary (key points, topics, sentiment) of a YouTube video. (4 credits) */
|
|
142
|
+
summarize(params: YoutubeSummarizeParams): Promise<ApiEnvelope>;
|
|
143
|
+
/** YouTube Video Details — Metadata + engagement stats for a YouTube video. (1 credit) */
|
|
144
|
+
videoDetails(params: YoutubeVideoDetailsParams): Promise<ApiEnvelope>;
|
|
145
|
+
/** YouTube Comments — Comments on a YouTube video. (20 credits) */
|
|
146
|
+
comments(params: YoutubeCommentsParams): Promise<ApiEnvelope>;
|
|
147
|
+
/** YouTube Channel Details — Channel info & subscriber/stats for a YouTube channel. (1 credit) */
|
|
148
|
+
channelDetails(params: YoutubeChannelDetailsParams): Promise<ApiEnvelope>;
|
|
149
|
+
/** YouTube Search — Search YouTube videos by keyword. (20 credits) */
|
|
150
|
+
search(params: YoutubeSearchParams): Promise<ApiEnvelope>;
|
|
151
|
+
/** YouTube Channel Videos — List a channel's uploaded videos. (20 credits) */
|
|
152
|
+
channelVideos(params: YoutubeChannelVideosParams): Promise<ApiEnvelope>;
|
|
153
|
+
/** YouTube Playlist Videos — List videos in a YouTube playlist. (50 credits) */
|
|
154
|
+
playlistVideos(params: YoutubePlaylistVideosParams): Promise<ApiEnvelope>;
|
|
155
|
+
/** YouTube Playlist — Playlist metadata plus videos from a YouTube playlist. (50 credits) */
|
|
156
|
+
playlist(params: YoutubePlaylistParams): Promise<ApiEnvelope>;
|
|
157
|
+
/** YouTube Video Download — Direct download URLs for a YouTube video. (3 credits) */
|
|
158
|
+
videoDownload(params: YoutubeVideoDownloadParams): Promise<ApiEnvelope>;
|
|
159
|
+
/** YouTube Shorts Transcript — Transcript of a YouTube Short. (2 credits) */
|
|
160
|
+
shortsTranscript(params: YoutubeShortsTranscriptParams): Promise<ApiEnvelope>;
|
|
161
|
+
/** YouTube Shorts Summarizer — AI summary of a YouTube Short. (4 credits) */
|
|
162
|
+
shortsSummarize(params: YoutubeShortsSummarizeParams): Promise<ApiEnvelope>;
|
|
163
|
+
/** YouTube Shorts Stats — Metadata + stats for a YouTube Short. (1 credit) */
|
|
164
|
+
shortsDetails(params: YoutubeShortsDetailsParams): Promise<ApiEnvelope>;
|
|
165
|
+
/** YouTube Shorts Comments — Comments on a YouTube Short. (20 credits) */
|
|
166
|
+
shortsComments(params: YoutubeShortsCommentsParams): Promise<ApiEnvelope>;
|
|
167
|
+
/** YouTube Channel Shorts — List a channel's Shorts. (20 credits) */
|
|
168
|
+
channelShorts(params: YoutubeChannelShortsParams): Promise<ApiEnvelope>;
|
|
169
|
+
/** YouTube Trending Shorts — Discover trending YouTube Shorts by seed keyword. (28 credits) */
|
|
170
|
+
trendingShorts(params?: YoutubeTrendingShortsParams): Promise<ApiEnvelope>;
|
|
171
|
+
/** YouTube Channel Streams — List a channel's live/past streams. (20 credits) */
|
|
172
|
+
channelStreams(params: YoutubeChannelStreamsParams): Promise<ApiEnvelope>;
|
|
173
|
+
/** YouTube Hashtag Search — Search YouTube videos by hashtag. (20 credits) */
|
|
174
|
+
hashtagSearch(params: YoutubeHashtagSearchParams): Promise<ApiEnvelope>;
|
|
175
|
+
/** YouTube Comment Replies — Replies to a specific YouTube comment. (20 credits) */
|
|
176
|
+
commentReplies(params: YoutubeCommentRepliesParams): Promise<ApiEnvelope>;
|
|
177
|
+
/** YouTube Channel Playlists — List a channel's playlists. (20 credits) */
|
|
178
|
+
channelPlaylists(params: YoutubeChannelPlaylistsParams): Promise<ApiEnvelope>;
|
|
179
|
+
/** YouTube Community Posts — List a channel's community (posts) tab. (10 credits) */
|
|
180
|
+
communityPosts(params: YoutubeCommunityPostsParams): Promise<ApiEnvelope>;
|
|
181
|
+
/** YouTube Community Post Details — Details for a single YouTube community post. (7 credits) */
|
|
182
|
+
communityPostDetails(params: YoutubeCommunityPostDetailsParams): Promise<ApiEnvelope>;
|
|
183
|
+
/** YouTube Video Sponsors — Sponsor / self-promo / interaction segments in a YouTube video (via SponsorBlock). (1 credit) */
|
|
184
|
+
videoSponsors(params: YoutubeVideoSponsorsParams): Promise<ApiEnvelope>;
|
|
185
|
+
}
|
|
186
|
+
export interface TiktokTranscriptParams {
|
|
187
|
+
/** Public TikTok video URL, e.g. https://tiktok.com/@user/video/ID. Not a YouTube/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
188
|
+
url: string;
|
|
189
|
+
}
|
|
190
|
+
export interface TiktokSummarizeParams {
|
|
191
|
+
/** Public TikTok video URL, e.g. https://tiktok.com/@user/video/ID. Not a YouTube/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
192
|
+
url: string;
|
|
193
|
+
}
|
|
194
|
+
export interface TiktokVideoDetailsParams {
|
|
195
|
+
/** Public TikTok video URL, e.g. https://tiktok.com/@user/video/ID. Not a YouTube/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
196
|
+
url: string;
|
|
197
|
+
}
|
|
198
|
+
export interface TiktokCommentsParams {
|
|
199
|
+
/** Public TikTok video URL, e.g. https://tiktok.com/@user/video/ID. Not a YouTube/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
200
|
+
url: string;
|
|
201
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
202
|
+
limit?: number;
|
|
203
|
+
}
|
|
204
|
+
export interface TiktokChannelDetailsParams {
|
|
205
|
+
/** TikTok profile URL, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
206
|
+
url: string;
|
|
207
|
+
}
|
|
208
|
+
export interface TiktokProfileRegionParams {
|
|
209
|
+
/** TikTok profile URL, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
210
|
+
url: string;
|
|
211
|
+
}
|
|
212
|
+
export interface TiktokAudienceDemographicsParams {
|
|
213
|
+
/** TikTok profile URL, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
214
|
+
url: string;
|
|
215
|
+
}
|
|
216
|
+
export interface TiktokSearchParams {
|
|
217
|
+
/** Search query or keywords (min 2 chars). */
|
|
218
|
+
q: string;
|
|
219
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
220
|
+
limit?: number;
|
|
221
|
+
}
|
|
222
|
+
export interface TiktokSearchSuggestionsParams {
|
|
223
|
+
/** Seed keyword for autocomplete suggestions. */
|
|
224
|
+
q: string;
|
|
225
|
+
/** Two-letter ISO country code. Default US. */
|
|
226
|
+
country?: string;
|
|
227
|
+
/** Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. */
|
|
228
|
+
language?: string;
|
|
229
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
230
|
+
limit?: number;
|
|
231
|
+
}
|
|
232
|
+
export interface TiktokVideoDownloadParams {
|
|
233
|
+
/** Public TikTok video URL, e.g. https://tiktok.com/@user/video/ID. Not a YouTube/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
234
|
+
url: string;
|
|
235
|
+
}
|
|
236
|
+
export interface TiktokChannelPostsParams {
|
|
237
|
+
/** TikTok profile URL, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
238
|
+
url: string;
|
|
239
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
240
|
+
limit?: number;
|
|
241
|
+
}
|
|
242
|
+
export interface TiktokCommentRepliesParams {
|
|
243
|
+
/** Public TikTok video URL, e.g. https://tiktok.com/@user/video/ID. Not a YouTube/Instagram/Facebook URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
244
|
+
url: string;
|
|
245
|
+
/** ID of the parent comment to fetch replies for (from the comments endpoint). */
|
|
246
|
+
comment_id: string;
|
|
247
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
248
|
+
limit?: number;
|
|
249
|
+
}
|
|
250
|
+
export interface TiktokUserFollowersParams {
|
|
251
|
+
/** TikTok profile URL, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
252
|
+
url: string;
|
|
253
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
254
|
+
limit?: number;
|
|
255
|
+
}
|
|
256
|
+
export interface TiktokUserFollowingsParams {
|
|
257
|
+
/** TikTok profile URL, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
258
|
+
url: string;
|
|
259
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
260
|
+
limit?: number;
|
|
261
|
+
}
|
|
262
|
+
export interface TiktokMusicPostsParams {
|
|
263
|
+
/** TikTok music/sound URL, e.g. https://tiktok.com/music/name-ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
264
|
+
url: string;
|
|
265
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
266
|
+
limit?: number;
|
|
267
|
+
}
|
|
268
|
+
export interface TiktokHashtagSearchParams {
|
|
269
|
+
/** Hashtag with or without the # (min 2 chars). */
|
|
270
|
+
q: string;
|
|
271
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
272
|
+
limit?: number;
|
|
273
|
+
}
|
|
274
|
+
export interface TiktokTopSearchParams {
|
|
275
|
+
/** Search query or keywords (min 2 chars). */
|
|
276
|
+
q: string;
|
|
277
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
278
|
+
limit?: number;
|
|
279
|
+
}
|
|
280
|
+
export interface TiktokUserSearchParams {
|
|
281
|
+
/** Search query or keywords (min 2 chars). */
|
|
282
|
+
q: string;
|
|
283
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
284
|
+
limit?: number;
|
|
285
|
+
}
|
|
286
|
+
export interface TiktokSongDetailsParams {
|
|
287
|
+
/** TikTok music/sound URL, e.g. https://tiktok.com/music/name-ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
288
|
+
url: string;
|
|
289
|
+
}
|
|
290
|
+
export interface TiktokTrendingFeedParams {
|
|
291
|
+
/** Two-letter ISO country code, e.g. US, GB, TR. Default US. */
|
|
292
|
+
country?: string;
|
|
293
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
294
|
+
limit?: number;
|
|
295
|
+
}
|
|
296
|
+
export interface TiktokPopularHashtagsParams {
|
|
297
|
+
/** Topic or keyword to discover trending hashtags for. Default "trending". */
|
|
298
|
+
query?: string;
|
|
299
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
300
|
+
limit?: number;
|
|
301
|
+
}
|
|
302
|
+
export interface TiktokLiveParams {
|
|
303
|
+
/** TikTok profile URL, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
304
|
+
url: string;
|
|
305
|
+
}
|
|
306
|
+
export interface TiktokLiveInfoParams {
|
|
307
|
+
/** TikTok profile URL, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
308
|
+
url: string;
|
|
309
|
+
}
|
|
310
|
+
export interface TiktokPopularCreatorsParams {
|
|
311
|
+
/** Two-letter ISO country code. Default US. */
|
|
312
|
+
country?: string;
|
|
313
|
+
/** follower, engagement, or popularity. Default follower. */
|
|
314
|
+
sort?: string;
|
|
315
|
+
/** Optional range: 10k-100k, 100k-1m, 1m-10m, >10m. */
|
|
316
|
+
follower_count?: string;
|
|
317
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
318
|
+
limit?: number;
|
|
319
|
+
}
|
|
320
|
+
export declare class TiktokApi {
|
|
321
|
+
private readonly core;
|
|
322
|
+
constructor(core: HttpCore);
|
|
323
|
+
/** TikTok Transcript — Transcript of a TikTok video (via captions). (2 credits) */
|
|
324
|
+
transcript(params: TiktokTranscriptParams): Promise<ApiEnvelope>;
|
|
325
|
+
/** TikTok Summarizer — AI summary of a TikTok video. (4 credits) */
|
|
326
|
+
summarize(params: TiktokSummarizeParams): Promise<ApiEnvelope>;
|
|
327
|
+
/** TikTok Video Details — Metadata + stats for a TikTok video. (1 credit) */
|
|
328
|
+
videoDetails(params: TiktokVideoDetailsParams): Promise<ApiEnvelope>;
|
|
329
|
+
/** TikTok Comments — Comments on a TikTok video. (10 credits) */
|
|
330
|
+
comments(params: TiktokCommentsParams): Promise<ApiEnvelope>;
|
|
331
|
+
/** TikTok Channel Details — Profile info & stats for a TikTok user. (1 credit) */
|
|
332
|
+
channelDetails(params: TiktokChannelDetailsParams): Promise<ApiEnvelope>;
|
|
333
|
+
/** TikTok Profile Region — Region and language signals for a TikTok profile. (7 credits) */
|
|
334
|
+
profileRegion(params: TiktokProfileRegionParams): Promise<ApiEnvelope>;
|
|
335
|
+
/** TikTok Audience Demographics — Audience and demographic signals for a TikTok profile. (7 credits) */
|
|
336
|
+
audienceDemographics(params: TiktokAudienceDemographicsParams): Promise<ApiEnvelope>;
|
|
337
|
+
/** TikTok Search — Search TikTok videos by keyword/hashtag. (14 credits) */
|
|
338
|
+
search(params: TiktokSearchParams): Promise<ApiEnvelope>;
|
|
339
|
+
/** TikTok Search Suggestions — TikTok search/autocomplete suggestions for a seed keyword. (28 credits) */
|
|
340
|
+
searchSuggestions(params: TiktokSearchSuggestionsParams): Promise<ApiEnvelope>;
|
|
341
|
+
/** TikTok Video Download — No-watermark download URL for a TikTok video. (3 credits) */
|
|
342
|
+
videoDownload(params: TiktokVideoDownloadParams): Promise<ApiEnvelope>;
|
|
343
|
+
/** TikTok Channel Posts — Latest posts from a TikTok profile. (14 credits) */
|
|
344
|
+
channelPosts(params: TiktokChannelPostsParams): Promise<ApiEnvelope>;
|
|
345
|
+
/** TikTok Comment Replies — Replies to a specific TikTok comment. (50 credits) */
|
|
346
|
+
commentReplies(params: TiktokCommentRepliesParams): Promise<ApiEnvelope>;
|
|
347
|
+
/** TikTok User Followers — List a TikTok user's followers. (20 credits) */
|
|
348
|
+
userFollowers(params: TiktokUserFollowersParams): Promise<ApiEnvelope>;
|
|
349
|
+
/** TikTok User Followings — List who a TikTok user follows. (20 credits) */
|
|
350
|
+
userFollowings(params: TiktokUserFollowingsParams): Promise<ApiEnvelope>;
|
|
351
|
+
/** TikTok Music Posts — Posts using a specific TikTok sound/music. (32 credits) */
|
|
352
|
+
musicPosts(params: TiktokMusicPostsParams): Promise<ApiEnvelope>;
|
|
353
|
+
/** TikTok Hashtag Search — Search TikTok videos by hashtag. (14 credits) */
|
|
354
|
+
hashtagSearch(params: TiktokHashtagSearchParams): Promise<ApiEnvelope>;
|
|
355
|
+
/** TikTok Top Search — Top mixed TikTok results for a keyword. (14 credits) */
|
|
356
|
+
topSearch(params: TiktokTopSearchParams): Promise<ApiEnvelope>;
|
|
357
|
+
/** TikTok User Search — Search TikTok users/creators by keyword. (8 credits) */
|
|
358
|
+
userSearch(params: TiktokUserSearchParams): Promise<ApiEnvelope>;
|
|
359
|
+
/** TikTok Song Details — Details of a TikTok sound/song. (2 credits) */
|
|
360
|
+
songDetails(params: TiktokSongDetailsParams): Promise<ApiEnvelope>;
|
|
361
|
+
/** TikTok Trending Feed — TikTok trending (For You) videos by region. (14 credits) */
|
|
362
|
+
trendingFeed(params?: TiktokTrendingFeedParams): Promise<ApiEnvelope>;
|
|
363
|
+
/** TikTok Popular Hashtags — Trending TikTok hashtags for a topic/keyword. (14 credits) */
|
|
364
|
+
popularHashtags(params?: TiktokPopularHashtagsParams): Promise<ApiEnvelope>;
|
|
365
|
+
/** TikTok Live — Live status & room info for a TikTok creator. (1 credit) */
|
|
366
|
+
live(params: TiktokLiveParams): Promise<ApiEnvelope>;
|
|
367
|
+
/** TikTok Live Info — Live room details for a TikTok creator. (7 credits) */
|
|
368
|
+
liveInfo(params: TiktokLiveInfoParams): Promise<ApiEnvelope>;
|
|
369
|
+
/** TikTok Popular Creators — Popular TikTok creators by country and ranking mode. (28 credits) */
|
|
370
|
+
popularCreators(params?: TiktokPopularCreatorsParams): Promise<ApiEnvelope>;
|
|
371
|
+
}
|
|
372
|
+
export interface InstagramTranscriptParams {
|
|
373
|
+
/** Instagram Reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
374
|
+
url: string;
|
|
375
|
+
}
|
|
376
|
+
export interface InstagramSummarizeParams {
|
|
377
|
+
/** Instagram Reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
378
|
+
url: string;
|
|
379
|
+
}
|
|
380
|
+
export interface InstagramDetailsParams {
|
|
381
|
+
/** Instagram post or reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
382
|
+
url: string;
|
|
383
|
+
}
|
|
384
|
+
export interface InstagramCommentsParams {
|
|
385
|
+
/** Instagram post or reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
386
|
+
url: string;
|
|
387
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
388
|
+
limit?: number;
|
|
389
|
+
}
|
|
390
|
+
export interface InstagramChannelDetailsParams {
|
|
391
|
+
/** Instagram profile URL, e.g. https://instagram.com/username/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
392
|
+
url: string;
|
|
393
|
+
}
|
|
394
|
+
export interface InstagramChannelPostsParams {
|
|
395
|
+
/** Instagram profile URL, e.g. https://instagram.com/username/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
396
|
+
url: string;
|
|
397
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
398
|
+
limit?: number;
|
|
399
|
+
}
|
|
400
|
+
export interface InstagramChannelReelsParams {
|
|
401
|
+
/** Instagram profile URL, e.g. https://instagram.com/username/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
402
|
+
url: string;
|
|
403
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
404
|
+
limit?: number;
|
|
405
|
+
}
|
|
406
|
+
export interface InstagramReelsSearchParams {
|
|
407
|
+
/** Hashtag (without #) or keyword (min 2 chars). */
|
|
408
|
+
q: string;
|
|
409
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
410
|
+
limit?: number;
|
|
411
|
+
}
|
|
412
|
+
export interface InstagramTrendingReelsParams {
|
|
413
|
+
/** Country name for Explore localization. Default United States. */
|
|
414
|
+
country?: string;
|
|
415
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
416
|
+
limit?: number;
|
|
417
|
+
}
|
|
418
|
+
export interface InstagramVideoDownloadParams {
|
|
419
|
+
/** Instagram Reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
420
|
+
url: string;
|
|
421
|
+
}
|
|
422
|
+
export interface InstagramTaggedPostsParams {
|
|
423
|
+
/** Instagram profile URL, e.g. https://instagram.com/username/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
424
|
+
url: string;
|
|
425
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
426
|
+
limit?: number;
|
|
427
|
+
}
|
|
428
|
+
export interface InstagramMusicPostsParams {
|
|
429
|
+
/** Instagram audio/music page URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
430
|
+
url: string;
|
|
431
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
432
|
+
limit?: number;
|
|
433
|
+
}
|
|
434
|
+
export interface InstagramReelsByAudioIdParams {
|
|
435
|
+
/** Instagram audio/music ID or full audio URL. */
|
|
436
|
+
audio_id: string;
|
|
437
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
438
|
+
limit?: number;
|
|
439
|
+
}
|
|
440
|
+
export interface InstagramHashtagSearchParams {
|
|
441
|
+
/** Hashtag without the # (min 2 chars). */
|
|
442
|
+
q: string;
|
|
443
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
444
|
+
limit?: number;
|
|
445
|
+
}
|
|
446
|
+
export interface InstagramProfileSearchParams {
|
|
447
|
+
/** Search query or keywords (min 2 chars). */
|
|
448
|
+
q: string;
|
|
449
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
450
|
+
limit?: number;
|
|
451
|
+
}
|
|
452
|
+
export interface InstagramStoryHighlightsParams {
|
|
453
|
+
/** Instagram profile URL, e.g. https://instagram.com/username/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
454
|
+
url: string;
|
|
455
|
+
}
|
|
456
|
+
export interface InstagramHighlightsDetailsParams {
|
|
457
|
+
/** Instagram profile URL, e.g. https://instagram.com/username/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
458
|
+
url: string;
|
|
459
|
+
/** Max highlights to expand. Default 10, max 50. */
|
|
460
|
+
limit?: number;
|
|
461
|
+
}
|
|
462
|
+
export interface InstagramEmbedParams {
|
|
463
|
+
/** Instagram post or reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
464
|
+
url: string;
|
|
465
|
+
}
|
|
466
|
+
export interface InstagramBasicProfileParams {
|
|
467
|
+
/** Instagram profile URL, e.g. https://instagram.com/username/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
468
|
+
url: string;
|
|
469
|
+
}
|
|
470
|
+
export declare class InstagramApi {
|
|
471
|
+
private readonly core;
|
|
472
|
+
constructor(core: HttpCore);
|
|
473
|
+
/** Instagram Transcript — Transcript of an Instagram Reel. (2 credits) */
|
|
474
|
+
transcript(params: InstagramTranscriptParams): Promise<ApiEnvelope>;
|
|
475
|
+
/** Instagram Summarizer — AI summary of an Instagram Reel. (4 credits) */
|
|
476
|
+
summarize(params: InstagramSummarizeParams): Promise<ApiEnvelope>;
|
|
477
|
+
/** Instagram Details — Details for an Instagram post or reel. (1 credit) */
|
|
478
|
+
details(params: InstagramDetailsParams): Promise<ApiEnvelope>;
|
|
479
|
+
/** Instagram Comments — Comments on an Instagram post or reel. (45 credits) */
|
|
480
|
+
comments(params: InstagramCommentsParams): Promise<ApiEnvelope>;
|
|
481
|
+
/** Instagram Channel Details — Profile info & stats for an Instagram account. (1 credit) */
|
|
482
|
+
channelDetails(params: InstagramChannelDetailsParams): Promise<ApiEnvelope>;
|
|
483
|
+
/** Instagram Channel Posts — Latest posts from an Instagram profile. (12 credits) */
|
|
484
|
+
channelPosts(params: InstagramChannelPostsParams): Promise<ApiEnvelope>;
|
|
485
|
+
/** Instagram Channel Reels — Latest Reels from an Instagram profile. (12 credits) */
|
|
486
|
+
channelReels(params: InstagramChannelReelsParams): Promise<ApiEnvelope>;
|
|
487
|
+
/** Instagram Reels Search — Search Instagram Reels by hashtag/keyword. (12 credits) */
|
|
488
|
+
reelsSearch(params: InstagramReelsSearchParams): Promise<ApiEnvelope>;
|
|
489
|
+
/** Instagram Trending Reels — Trending Instagram Reels / Explore posts by country. (28 credits) */
|
|
490
|
+
trendingReels(params?: InstagramTrendingReelsParams): Promise<ApiEnvelope>;
|
|
491
|
+
/** Instagram Video Download — Direct video URL for an Instagram Reel. (3 credits) */
|
|
492
|
+
videoDownload(params: InstagramVideoDownloadParams): Promise<ApiEnvelope>;
|
|
493
|
+
/** Instagram Tagged Posts — Posts an Instagram user is tagged in. (18 credits) */
|
|
494
|
+
taggedPosts(params: InstagramTaggedPostsParams): Promise<ApiEnvelope>;
|
|
495
|
+
/** Instagram Music Posts — Posts/Reels using an Instagram audio. (18 credits) */
|
|
496
|
+
musicPosts(params: InstagramMusicPostsParams): Promise<ApiEnvelope>;
|
|
497
|
+
/** Instagram Reels By Audio ID — Posts/Reels using an Instagram audio ID. (28 credits) */
|
|
498
|
+
reelsByAudioId(params: InstagramReelsByAudioIdParams): Promise<ApiEnvelope>;
|
|
499
|
+
/** Instagram Hashtag Search — Search Instagram posts by hashtag. (12 credits) */
|
|
500
|
+
hashtagSearch(params: InstagramHashtagSearchParams): Promise<ApiEnvelope>;
|
|
501
|
+
/** Instagram Profile Search — Search Instagram profiles by keyword. (12 credits) */
|
|
502
|
+
profileSearch(params: InstagramProfileSearchParams): Promise<ApiEnvelope>;
|
|
503
|
+
/** Instagram Story Highlights — List a profile's story highlight covers. (5 credits) */
|
|
504
|
+
storyHighlights(params: InstagramStoryHighlightsParams): Promise<ApiEnvelope>;
|
|
505
|
+
/** Instagram Highlights Details — Items inside a profile's story highlights. (9 credits) */
|
|
506
|
+
highlightsDetails(params: InstagramHighlightsDetailsParams): Promise<ApiEnvelope>;
|
|
507
|
+
/** Instagram Embed — Embed HTML for an Instagram post/reel. (1 credit) */
|
|
508
|
+
embed(params: InstagramEmbedParams): Promise<ApiEnvelope>;
|
|
509
|
+
/** Instagram Basic Profile — Lightweight Instagram profile lookup (core fields). (1 credit) */
|
|
510
|
+
basicProfile(params: InstagramBasicProfileParams): Promise<ApiEnvelope>;
|
|
511
|
+
}
|
|
512
|
+
export interface FacebookDetailsParams {
|
|
513
|
+
/** Public Facebook video or post URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
514
|
+
url: string;
|
|
515
|
+
}
|
|
516
|
+
export interface FacebookTranscriptParams {
|
|
517
|
+
/** Public Facebook video or post URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
518
|
+
url: string;
|
|
519
|
+
}
|
|
520
|
+
export interface FacebookSummarizeParams {
|
|
521
|
+
/** Public Facebook video or post URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
522
|
+
url: string;
|
|
523
|
+
}
|
|
524
|
+
export interface FacebookCommentsParams {
|
|
525
|
+
/** Public Facebook video or post URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
526
|
+
url: string;
|
|
527
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
528
|
+
limit?: number;
|
|
529
|
+
}
|
|
530
|
+
export interface FacebookPageDetailsParams {
|
|
531
|
+
/** Facebook page URL, e.g. https://facebook.com/PageName. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
532
|
+
url: string;
|
|
533
|
+
}
|
|
534
|
+
export interface FacebookProfilePostsParams {
|
|
535
|
+
/** Facebook profile or page URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
536
|
+
url: string;
|
|
537
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
538
|
+
limit?: number;
|
|
539
|
+
}
|
|
540
|
+
export interface FacebookProfileReelsParams {
|
|
541
|
+
/** Facebook profile or page URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
542
|
+
url: string;
|
|
543
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
544
|
+
limit?: number;
|
|
545
|
+
}
|
|
546
|
+
export interface FacebookGroupPostsParams {
|
|
547
|
+
/** Public Facebook group URL, e.g. https://facebook.com/groups/ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
548
|
+
url: string;
|
|
549
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
550
|
+
limit?: number;
|
|
551
|
+
}
|
|
552
|
+
export interface FacebookCommentRepliesParams {
|
|
553
|
+
/** Facebook post URL the comment belongs to. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
554
|
+
url: string;
|
|
555
|
+
/** ID of the parent comment to fetch replies for (from the comments endpoint). */
|
|
556
|
+
comment_id: string;
|
|
557
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
558
|
+
limit?: number;
|
|
559
|
+
}
|
|
560
|
+
export interface FacebookMarketplaceSearchParams {
|
|
561
|
+
/** Product or keyword to search for (min 2 chars). */
|
|
562
|
+
q: string;
|
|
563
|
+
/** City or place name, e.g. 'Austin, TX'. */
|
|
564
|
+
location: string;
|
|
565
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
566
|
+
limit?: number;
|
|
567
|
+
/** Set true to fetch full description, photos and coordinates per listing (slower, costs more). */
|
|
568
|
+
details?: string;
|
|
569
|
+
}
|
|
570
|
+
export interface FacebookMarketplaceLocationSearchParams {
|
|
571
|
+
/** City/place search query, e.g. Austin. */
|
|
572
|
+
q: string;
|
|
573
|
+
/** Max items to return. Default 10, max 50. Billed per result. */
|
|
574
|
+
limit?: number;
|
|
575
|
+
}
|
|
576
|
+
export interface FacebookEventSearchParams {
|
|
577
|
+
/** Topic and/or place, e.g. 'comedy Chicago' (min 2 chars). */
|
|
578
|
+
q: string;
|
|
579
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
580
|
+
limit?: number;
|
|
581
|
+
}
|
|
582
|
+
export interface FacebookEventDetailsParams {
|
|
583
|
+
/** Facebook event URL, e.g. https://facebook.com/events/ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
584
|
+
url: string;
|
|
585
|
+
}
|
|
586
|
+
export interface FacebookProfilePhotosParams {
|
|
587
|
+
/** Facebook profile or page URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
588
|
+
url: string;
|
|
589
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
590
|
+
limit?: number;
|
|
591
|
+
}
|
|
592
|
+
export interface FacebookProfileEventsParams {
|
|
593
|
+
/** Facebook profile or page URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
594
|
+
url: string;
|
|
595
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
596
|
+
limit?: number;
|
|
597
|
+
}
|
|
598
|
+
export interface FacebookMarketplaceItemParams {
|
|
599
|
+
/** Facebook Marketplace item URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
600
|
+
url: string;
|
|
601
|
+
}
|
|
602
|
+
export declare class FacebookApi {
|
|
603
|
+
private readonly core;
|
|
604
|
+
constructor(core: HttpCore);
|
|
605
|
+
/** Facebook Details — Details for a Facebook video or post. (1 credit) */
|
|
606
|
+
details(params: FacebookDetailsParams): Promise<ApiEnvelope>;
|
|
607
|
+
/** Facebook Transcript — Transcript of a Facebook video. (2 credits) */
|
|
608
|
+
transcript(params: FacebookTranscriptParams): Promise<ApiEnvelope>;
|
|
609
|
+
/** Facebook Summarizer — AI summary of a Facebook video or post. (4 credits) */
|
|
610
|
+
summarize(params: FacebookSummarizeParams): Promise<ApiEnvelope>;
|
|
611
|
+
/** Facebook Comments — Comments on a Facebook post. (30 credits) */
|
|
612
|
+
comments(params: FacebookCommentsParams): Promise<ApiEnvelope>;
|
|
613
|
+
/** Facebook Page Details — Info & stats for a Facebook page. (1 credit) */
|
|
614
|
+
pageDetails(params: FacebookPageDetailsParams): Promise<ApiEnvelope>;
|
|
615
|
+
/** Facebook Profile Posts — Latest posts from a Facebook profile/page. (12 credits) */
|
|
616
|
+
profilePosts(params: FacebookProfilePostsParams): Promise<ApiEnvelope>;
|
|
617
|
+
/** Facebook Profile Reels — Latest Reels from a Facebook profile/page. (36 credits) */
|
|
618
|
+
profileReels(params: FacebookProfileReelsParams): Promise<ApiEnvelope>;
|
|
619
|
+
/** Facebook Group Posts — Posts from a public Facebook group. (12 credits) */
|
|
620
|
+
groupPosts(params: FacebookGroupPostsParams): Promise<ApiEnvelope>;
|
|
621
|
+
/** Facebook Comment Replies — Replies to a specific Facebook comment. (30 credits) */
|
|
622
|
+
commentReplies(params: FacebookCommentRepliesParams): Promise<ApiEnvelope>;
|
|
623
|
+
/** Facebook Marketplace Search — Search Facebook Marketplace listings by keyword and location. (28 credits) */
|
|
624
|
+
marketplaceSearch(params: FacebookMarketplaceSearchParams): Promise<ApiEnvelope>;
|
|
625
|
+
/** Facebook Marketplace Location Search — Find Facebook Marketplace location candidates for a city or place query. (17 credits) */
|
|
626
|
+
marketplaceLocationSearch(params: FacebookMarketplaceLocationSearchParams): Promise<ApiEnvelope>;
|
|
627
|
+
/** Facebook Event Search — Search Facebook events by topic and/or location. (40 credits) */
|
|
628
|
+
eventSearch(params: FacebookEventSearchParams): Promise<ApiEnvelope>;
|
|
629
|
+
/** Facebook Event Details — Details for a Facebook event (date, location, attendees, tickets). (2 credits) */
|
|
630
|
+
eventDetails(params: FacebookEventDetailsParams): Promise<ApiEnvelope>;
|
|
631
|
+
/** Facebook Profile Photos — Photos from a Facebook profile or page. (12 credits) */
|
|
632
|
+
profilePhotos(params: FacebookProfilePhotosParams): Promise<ApiEnvelope>;
|
|
633
|
+
/** Facebook Profile Events — Events from a Facebook profile or page. (40 credits) */
|
|
634
|
+
profileEvents(params: FacebookProfileEventsParams): Promise<ApiEnvelope>;
|
|
635
|
+
/** Facebook Marketplace Item — Details for a single Facebook Marketplace listing. (17 credits) */
|
|
636
|
+
marketplaceItem(params: FacebookMarketplaceItemParams): Promise<ApiEnvelope>;
|
|
637
|
+
}
|
|
638
|
+
export interface TwitterTweetDetailsParams {
|
|
639
|
+
/** Public tweet URL, e.g. https://x.com/user/status/ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
640
|
+
url: string;
|
|
641
|
+
}
|
|
642
|
+
export interface TwitterTranscriptParams {
|
|
643
|
+
/** Public tweet URL, e.g. https://x.com/user/status/ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
644
|
+
url: string;
|
|
645
|
+
}
|
|
646
|
+
export interface TwitterProfileParams {
|
|
647
|
+
/** Twitter/X profile URL or @handle, e.g. https://x.com/username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
648
|
+
url: string;
|
|
649
|
+
}
|
|
650
|
+
export interface TwitterUserTweetsParams {
|
|
651
|
+
/** Twitter/X profile URL or @handle, e.g. https://x.com/username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
652
|
+
url: string;
|
|
653
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
654
|
+
limit?: number;
|
|
655
|
+
}
|
|
656
|
+
export interface TwitterSearchParams {
|
|
657
|
+
/** Search query or keywords (min 2 chars). */
|
|
658
|
+
q: string;
|
|
659
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
660
|
+
limit?: number;
|
|
661
|
+
}
|
|
662
|
+
export interface TwitterCommunityParams {
|
|
663
|
+
/** X community URL (x.com/i/communities/ID) or community ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
664
|
+
url: string;
|
|
665
|
+
}
|
|
666
|
+
export interface TwitterCommunityTweetsParams {
|
|
667
|
+
/** X community URL (x.com/i/communities/ID) or community ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
668
|
+
url: string;
|
|
669
|
+
/** Max items to return. Default 25, max 200. Billed per result. */
|
|
670
|
+
limit?: number;
|
|
671
|
+
}
|
|
672
|
+
export declare class TwitterApi {
|
|
673
|
+
private readonly core;
|
|
674
|
+
constructor(core: HttpCore);
|
|
675
|
+
/** Twitter/X Tweet Details — Metadata + engagement stats for a tweet. (1 credit) */
|
|
676
|
+
tweetDetails(params: TwitterTweetDetailsParams): Promise<ApiEnvelope>;
|
|
677
|
+
/** Twitter/X Transcript — Extract tweet text as transcript text. (7 credits) */
|
|
678
|
+
transcript(params: TwitterTranscriptParams): Promise<ApiEnvelope>;
|
|
679
|
+
/** Twitter/X Profile — Profile info & stats for a Twitter/X account. (1 credit) */
|
|
680
|
+
profile(params: TwitterProfileParams): Promise<ApiEnvelope>;
|
|
681
|
+
/** Twitter/X User Tweets — Recent tweets from a Twitter/X profile. (14 credits) */
|
|
682
|
+
userTweets(params: TwitterUserTweetsParams): Promise<ApiEnvelope>;
|
|
683
|
+
/** Twitter/X Search — Search tweets by keyword. (14 credits) */
|
|
684
|
+
search(params: TwitterSearchParams): Promise<ApiEnvelope>;
|
|
685
|
+
/** Twitter/X Community — Details for an X (Twitter) community. (1 credit) */
|
|
686
|
+
community(params: TwitterCommunityParams): Promise<ApiEnvelope>;
|
|
687
|
+
/** Twitter/X Community Tweets — Tweets posted in an X community. (18 credits) */
|
|
688
|
+
communityTweets(params: TwitterCommunityTweetsParams): Promise<ApiEnvelope>;
|
|
689
|
+
}
|
|
690
|
+
export interface RedditSubredditPostsParams {
|
|
691
|
+
/** Subreddit URL, r/name, or bare name, e.g. r/technology. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
692
|
+
url: string;
|
|
693
|
+
/** Max items to return. Default 25, max 200. Billed per result. */
|
|
694
|
+
limit?: number;
|
|
695
|
+
}
|
|
696
|
+
export interface RedditPostDetailsParams {
|
|
697
|
+
/** Reddit post URL, e.g. https://reddit.com/r/sub/comments/ID/... The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
698
|
+
url: string;
|
|
699
|
+
}
|
|
700
|
+
export interface RedditPostCommentsParams {
|
|
701
|
+
/** Reddit post URL, e.g. https://reddit.com/r/sub/comments/ID/... The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
702
|
+
url: string;
|
|
703
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
704
|
+
limit?: number;
|
|
705
|
+
}
|
|
706
|
+
export interface RedditPostTranscriptParams {
|
|
707
|
+
/** Reddit post URL, e.g. https://reddit.com/r/sub/comments/ID/... The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
708
|
+
url: string;
|
|
709
|
+
/** Max items to return. Default 50, max 200. Billed per result. */
|
|
710
|
+
limit?: number;
|
|
711
|
+
}
|
|
712
|
+
export interface RedditSearchParams {
|
|
713
|
+
/** Search query or keywords (min 2 chars). */
|
|
714
|
+
q: string;
|
|
715
|
+
/** Max items to return. Default 25, max 200. Billed per result. */
|
|
716
|
+
limit?: number;
|
|
717
|
+
}
|
|
718
|
+
export interface RedditSubredditDetailsParams {
|
|
719
|
+
/** Subreddit URL, r/name, or bare name, e.g. r/technology. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
720
|
+
url: string;
|
|
721
|
+
}
|
|
722
|
+
export interface RedditSubredditSearchParams {
|
|
723
|
+
/** Subreddit URL, r/name, or bare name, e.g. r/technology. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
724
|
+
url: string;
|
|
725
|
+
/** Search query or keywords (min 2 chars). */
|
|
726
|
+
q: string;
|
|
727
|
+
/** Max items to return. Default 25, max 200. Billed per result. */
|
|
728
|
+
limit?: number;
|
|
729
|
+
}
|
|
730
|
+
export declare class RedditApi {
|
|
731
|
+
private readonly core;
|
|
732
|
+
constructor(core: HttpCore);
|
|
733
|
+
/** Reddit Subreddit Posts — Recent posts in a subreddit. (10 credits) */
|
|
734
|
+
subredditPosts(params: RedditSubredditPostsParams): Promise<ApiEnvelope>;
|
|
735
|
+
/** Reddit Post Details — Metadata + stats for a Reddit post. (1 credit) */
|
|
736
|
+
postDetails(params: RedditPostDetailsParams): Promise<ApiEnvelope>;
|
|
737
|
+
/** Reddit Post Comments — Comments on a Reddit post. (20 credits) */
|
|
738
|
+
postComments(params: RedditPostCommentsParams): Promise<ApiEnvelope>;
|
|
739
|
+
/** Reddit Post Transcript — Extract Reddit post text and top comments as a discussion transcript. (20 credits) */
|
|
740
|
+
postTranscript(params: RedditPostTranscriptParams): Promise<ApiEnvelope>;
|
|
741
|
+
/** Reddit Search — Search Reddit posts by keyword. (10 credits) */
|
|
742
|
+
search(params: RedditSearchParams): Promise<ApiEnvelope>;
|
|
743
|
+
/** Reddit Subreddit Details — Info & member stats for a subreddit. (1 credit) */
|
|
744
|
+
subredditDetails(params: RedditSubredditDetailsParams): Promise<ApiEnvelope>;
|
|
745
|
+
/** Reddit Subreddit Search — Search posts within a specific subreddit. (10 credits) */
|
|
746
|
+
subredditSearch(params: RedditSubredditSearchParams): Promise<ApiEnvelope>;
|
|
747
|
+
}
|
|
748
|
+
export interface ThreadsProfileParams {
|
|
749
|
+
/** Threads profile URL or @handle, e.g. https://threads.net/@username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
750
|
+
url: string;
|
|
751
|
+
}
|
|
752
|
+
export interface ThreadsUserPostsParams {
|
|
753
|
+
/** Threads profile URL or @handle, e.g. https://threads.net/@username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
754
|
+
url: string;
|
|
755
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
756
|
+
limit?: number;
|
|
757
|
+
}
|
|
758
|
+
export interface ThreadsPostDetailsParams {
|
|
759
|
+
/** Threads post URL, e.g. https://threads.net/@user/post/CODE. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
760
|
+
url: string;
|
|
761
|
+
}
|
|
762
|
+
export interface ThreadsSearchParams {
|
|
763
|
+
/** Search query or keywords (min 2 chars). */
|
|
764
|
+
q: string;
|
|
765
|
+
/** Max items to return. Default 25, max 200. Billed per result. */
|
|
766
|
+
limit?: number;
|
|
767
|
+
}
|
|
768
|
+
export interface ThreadsSearchUsersParams {
|
|
769
|
+
/** Search query or keywords (min 2 chars). */
|
|
770
|
+
q: string;
|
|
771
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
772
|
+
limit?: number;
|
|
773
|
+
}
|
|
774
|
+
export declare class ThreadsApi {
|
|
775
|
+
private readonly core;
|
|
776
|
+
constructor(core: HttpCore);
|
|
777
|
+
/** Threads Profile — Profile info & stats for a Threads account. (1 credit) */
|
|
778
|
+
profile(params: ThreadsProfileParams): Promise<ApiEnvelope>;
|
|
779
|
+
/** Threads User Posts — Recent posts from a Threads profile. (14 credits) */
|
|
780
|
+
userPosts(params: ThreadsUserPostsParams): Promise<ApiEnvelope>;
|
|
781
|
+
/** Threads Post Details — Metadata + engagement for a Threads post. (1 credit) */
|
|
782
|
+
postDetails(params: ThreadsPostDetailsParams): Promise<ApiEnvelope>;
|
|
783
|
+
/** Threads Search — Search Threads posts by keyword. (18 credits) */
|
|
784
|
+
search(params: ThreadsSearchParams): Promise<ApiEnvelope>;
|
|
785
|
+
/** Threads Search Users — Find Threads users matching a keyword. (14 credits) */
|
|
786
|
+
searchUsers(params: ThreadsSearchUsersParams): Promise<ApiEnvelope>;
|
|
787
|
+
}
|
|
788
|
+
export interface BlueskyProfileParams {
|
|
789
|
+
/** Bluesky profile URL, @handle, or handle, e.g. bsky.app/profile/handle. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
790
|
+
url: string;
|
|
791
|
+
}
|
|
792
|
+
export interface BlueskyUserPostsParams {
|
|
793
|
+
/** Bluesky profile URL, @handle, or handle, e.g. bsky.app/profile/handle. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
794
|
+
url: string;
|
|
795
|
+
/** Max items to return. Default 25, max 100. Billed per result. */
|
|
796
|
+
limit?: number;
|
|
797
|
+
}
|
|
798
|
+
export interface BlueskyPostDetailsParams {
|
|
799
|
+
/** Bluesky post URL, e.g. https://bsky.app/profile/handle/post/RKEY. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
800
|
+
url: string;
|
|
801
|
+
}
|
|
802
|
+
export declare class BlueskyApi {
|
|
803
|
+
private readonly core;
|
|
804
|
+
constructor(core: HttpCore);
|
|
805
|
+
/** Bluesky Profile — Profile info & stats for a Bluesky account. (1 credit) */
|
|
806
|
+
profile(params: BlueskyProfileParams): Promise<ApiEnvelope>;
|
|
807
|
+
/** Bluesky User Posts — Recent posts from a Bluesky profile. (3 credits) */
|
|
808
|
+
userPosts(params: BlueskyUserPostsParams): Promise<ApiEnvelope>;
|
|
809
|
+
/** Bluesky Post Details — Metadata + engagement for a Bluesky post. (1 credit) */
|
|
810
|
+
postDetails(params: BlueskyPostDetailsParams): Promise<ApiEnvelope>;
|
|
811
|
+
}
|
|
812
|
+
export interface PinterestPinDetailsParams {
|
|
813
|
+
/** Pinterest pin URL, e.g. https://pinterest.com/pin/ID/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
814
|
+
url: string;
|
|
815
|
+
}
|
|
816
|
+
export interface PinterestUserPinsParams {
|
|
817
|
+
/** Pinterest profile URL or username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
818
|
+
url: string;
|
|
819
|
+
/** Max items to return. Default 25, max 200. Billed per result. */
|
|
820
|
+
limit?: number;
|
|
821
|
+
}
|
|
822
|
+
export interface PinterestSearchParams {
|
|
823
|
+
/** Search query or keywords (min 2 chars). */
|
|
824
|
+
q: string;
|
|
825
|
+
/** Max items to return. Default 25, max 200. Billed per result. */
|
|
826
|
+
limit?: number;
|
|
827
|
+
}
|
|
828
|
+
export interface PinterestBoardParams {
|
|
829
|
+
/** Pinterest board URL, e.g. https://pinterest.com/username/board-name/. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
830
|
+
url: string;
|
|
831
|
+
/** Max items to return. Default 25, max 200. Billed per result. */
|
|
832
|
+
limit?: number;
|
|
833
|
+
}
|
|
834
|
+
export interface PinterestUserBoardsParams {
|
|
835
|
+
/** Pinterest profile URL or username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
836
|
+
url: string;
|
|
837
|
+
/** Max items to return. Default 25, max 200. Billed per result. */
|
|
838
|
+
limit?: number;
|
|
839
|
+
}
|
|
840
|
+
export declare class PinterestApi {
|
|
841
|
+
private readonly core;
|
|
842
|
+
constructor(core: HttpCore);
|
|
843
|
+
/** Pinterest Pin Details — Metadata + saves for a Pinterest pin. (1 credit) */
|
|
844
|
+
pinDetails(params: PinterestPinDetailsParams): Promise<ApiEnvelope>;
|
|
845
|
+
/** Pinterest User Pins — Pins from a Pinterest profile. (13 credits) */
|
|
846
|
+
userPins(params: PinterestUserPinsParams): Promise<ApiEnvelope>;
|
|
847
|
+
/** Pinterest Search — Search Pinterest pins by keyword. (13 credits) */
|
|
848
|
+
search(params: PinterestSearchParams): Promise<ApiEnvelope>;
|
|
849
|
+
/** Pinterest Board — List pins inside a Pinterest board. (13 credits) */
|
|
850
|
+
board(params: PinterestBoardParams): Promise<ApiEnvelope>;
|
|
851
|
+
/** Pinterest User Boards — List the boards on a Pinterest profile. (13 credits) */
|
|
852
|
+
userBoards(params: PinterestUserBoardsParams): Promise<ApiEnvelope>;
|
|
853
|
+
}
|
|
854
|
+
export interface LinkedinProfileParams {
|
|
855
|
+
/** LinkedIn profile URL, e.g. https://linkedin.com/in/slug. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
856
|
+
url: string;
|
|
857
|
+
}
|
|
858
|
+
export interface LinkedinCompanyParams {
|
|
859
|
+
/** LinkedIn company URL, e.g. https://linkedin.com/company/slug. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
860
|
+
url: string;
|
|
861
|
+
}
|
|
862
|
+
export interface LinkedinPostDetailsParams {
|
|
863
|
+
/** LinkedIn post or activity URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
864
|
+
url: string;
|
|
865
|
+
}
|
|
866
|
+
export interface LinkedinPostTranscriptParams {
|
|
867
|
+
/** LinkedIn post or activity URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
868
|
+
url: string;
|
|
869
|
+
}
|
|
870
|
+
export interface LinkedinCompanyPostsParams {
|
|
871
|
+
/** LinkedIn company URL, e.g. https://linkedin.com/company/slug. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
872
|
+
url: string;
|
|
873
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
874
|
+
limit?: number;
|
|
875
|
+
}
|
|
876
|
+
export interface LinkedinSearchPostsParams {
|
|
877
|
+
/** Search query or keywords (min 2 chars). */
|
|
878
|
+
q: string;
|
|
879
|
+
/** relevance or date. Default relevance. */
|
|
880
|
+
sort?: string;
|
|
881
|
+
/** Max items to return. Default 20, max 50. Billed per result. */
|
|
882
|
+
limit?: number;
|
|
883
|
+
}
|
|
884
|
+
export declare class LinkedinApi {
|
|
885
|
+
private readonly core;
|
|
886
|
+
constructor(core: HttpCore);
|
|
887
|
+
/** LinkedIn Profile — Public LinkedIn person profile details. (2 credits) */
|
|
888
|
+
profile(params: LinkedinProfileParams): Promise<ApiEnvelope>;
|
|
889
|
+
/** LinkedIn Company — Public LinkedIn company page details. (2 credits) */
|
|
890
|
+
company(params: LinkedinCompanyParams): Promise<ApiEnvelope>;
|
|
891
|
+
/** LinkedIn Post Details — Metadata + engagement for a LinkedIn post. (1 credit) */
|
|
892
|
+
postDetails(params: LinkedinPostDetailsParams): Promise<ApiEnvelope>;
|
|
893
|
+
/** LinkedIn Post Transcript — Extract post text as a transcript for a LinkedIn post. (7 credits) */
|
|
894
|
+
postTranscript(params: LinkedinPostTranscriptParams): Promise<ApiEnvelope>;
|
|
895
|
+
/** LinkedIn Company Posts — Recent public posts from a LinkedIn company page. (16 credits) */
|
|
896
|
+
companyPosts(params: LinkedinCompanyPostsParams): Promise<ApiEnvelope>;
|
|
897
|
+
/** LinkedIn Search Posts — Search public LinkedIn posts by keyword. (16 credits) */
|
|
898
|
+
searchPosts(params: LinkedinSearchPostsParams): Promise<ApiEnvelope>;
|
|
899
|
+
}
|
|
900
|
+
export interface RumbleVideoDetailsParams {
|
|
901
|
+
/** Rumble video URL, e.g. https://rumble.com/vXXXX-title.html. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
902
|
+
url: string;
|
|
903
|
+
}
|
|
904
|
+
export interface RumbleChannelVideosParams {
|
|
905
|
+
/** Rumble channel URL, e.g. https://rumble.com/c/name. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
906
|
+
url: string;
|
|
907
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
908
|
+
limit?: number;
|
|
909
|
+
}
|
|
910
|
+
export interface RumbleSearchParams {
|
|
911
|
+
/** Search query or keywords (min 2 chars). */
|
|
912
|
+
q: string;
|
|
913
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
914
|
+
limit?: number;
|
|
915
|
+
}
|
|
916
|
+
export interface RumbleCommentsParams {
|
|
917
|
+
/** Rumble video URL, e.g. https://rumble.com/vXXXX-title.html. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
918
|
+
url: string;
|
|
919
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
920
|
+
limit?: number;
|
|
921
|
+
}
|
|
922
|
+
export declare class RumbleApi {
|
|
923
|
+
private readonly core;
|
|
924
|
+
constructor(core: HttpCore);
|
|
925
|
+
/** Rumble Video Details — Metadata + stats for a Rumble video. (1 credit) */
|
|
926
|
+
videoDetails(params: RumbleVideoDetailsParams): Promise<ApiEnvelope>;
|
|
927
|
+
/** Rumble Channel Videos — List videos from a Rumble channel. (12 credits) */
|
|
928
|
+
channelVideos(params: RumbleChannelVideosParams): Promise<ApiEnvelope>;
|
|
929
|
+
/** Rumble Search — Search Rumble videos by keyword. (12 credits) */
|
|
930
|
+
search(params: RumbleSearchParams): Promise<ApiEnvelope>;
|
|
931
|
+
/** Rumble Comments — Comments on a Rumble video. (30 credits) */
|
|
932
|
+
comments(params: RumbleCommentsParams): Promise<ApiEnvelope>;
|
|
933
|
+
}
|
|
934
|
+
export interface TiktokShopSearchParams {
|
|
935
|
+
/** Product search query. */
|
|
936
|
+
q: string;
|
|
937
|
+
/** Two-letter TikTok Shop region. Default US. */
|
|
938
|
+
region?: string;
|
|
939
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
940
|
+
limit?: number;
|
|
941
|
+
}
|
|
942
|
+
export interface TiktokShopProductsParams {
|
|
943
|
+
/** TikTok Shop store URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
944
|
+
url: string;
|
|
945
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
946
|
+
limit?: number;
|
|
947
|
+
}
|
|
948
|
+
export interface TiktokShopProductDetailsParams {
|
|
949
|
+
/** TikTok Shop product URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
950
|
+
url: string;
|
|
951
|
+
}
|
|
952
|
+
export interface TiktokShopProductReviewsParams {
|
|
953
|
+
/** TikTok Shop product URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
954
|
+
url: string;
|
|
955
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
956
|
+
limit?: number;
|
|
957
|
+
}
|
|
958
|
+
export interface TiktokShopUserShowcaseParams {
|
|
959
|
+
/** TikTok username with or without @. */
|
|
960
|
+
username: string;
|
|
961
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
962
|
+
limit?: number;
|
|
963
|
+
}
|
|
964
|
+
export declare class TiktokShopApi {
|
|
965
|
+
private readonly core;
|
|
966
|
+
constructor(core: HttpCore);
|
|
967
|
+
/** TikTok Shop Search — Search TikTok Shop products by keyword. (56 credits) */
|
|
968
|
+
search(params: TiktokShopSearchParams): Promise<ApiEnvelope>;
|
|
969
|
+
/** TikTok Shop Products — List products from a TikTok Shop store. (56 credits) */
|
|
970
|
+
products(params: TiktokShopProductsParams): Promise<ApiEnvelope>;
|
|
971
|
+
/** TikTok Shop Product Details — Full TikTok Shop product details, seller and price metadata. (14 credits) */
|
|
972
|
+
productDetails(params: TiktokShopProductDetailsParams): Promise<ApiEnvelope>;
|
|
973
|
+
/** TikTok Shop Product Reviews — Customer reviews for a TikTok Shop product. (45 credits) */
|
|
974
|
+
productReviews(params: TiktokShopProductReviewsParams): Promise<ApiEnvelope>;
|
|
975
|
+
/** TikTok Shop User Showcase — Products promoted in a TikTok creator showcase. (45 credits) */
|
|
976
|
+
userShowcase(params: TiktokShopUserShowcaseParams): Promise<ApiEnvelope>;
|
|
977
|
+
}
|
|
978
|
+
export interface GithubUserParams {
|
|
979
|
+
/** GitHub username or profile URL. */
|
|
980
|
+
username: string;
|
|
981
|
+
}
|
|
982
|
+
export interface GithubRepositoriesParams {
|
|
983
|
+
/** GitHub username or profile URL. */
|
|
984
|
+
username: string;
|
|
985
|
+
/** Max items to return. Default 30, max 100. Billed per result. */
|
|
986
|
+
limit?: number;
|
|
987
|
+
}
|
|
988
|
+
export interface GithubRepositoryParams {
|
|
989
|
+
/** Repository URL or owner/name. */
|
|
990
|
+
repo: string;
|
|
991
|
+
}
|
|
992
|
+
export interface GithubPullRequestsParams {
|
|
993
|
+
/** Repository URL or owner/name. */
|
|
994
|
+
repo: string;
|
|
995
|
+
/** open, closed, or all. Default open. */
|
|
996
|
+
state?: string;
|
|
997
|
+
/** Max items to return. Default 30, max 100. Billed per result. */
|
|
998
|
+
limit?: number;
|
|
999
|
+
}
|
|
1000
|
+
export interface GithubActivityParams {
|
|
1001
|
+
/** GitHub username or profile URL. */
|
|
1002
|
+
username: string;
|
|
1003
|
+
/** Max items to return. Default 30, max 100. Billed per result. */
|
|
1004
|
+
limit?: number;
|
|
1005
|
+
}
|
|
1006
|
+
export interface GithubFollowersParams {
|
|
1007
|
+
/** GitHub username or profile URL. */
|
|
1008
|
+
username: string;
|
|
1009
|
+
/** Max items to return. Default 30, max 100. Billed per result. */
|
|
1010
|
+
limit?: number;
|
|
1011
|
+
}
|
|
1012
|
+
export interface GithubFollowingParams {
|
|
1013
|
+
/** GitHub username or profile URL. */
|
|
1014
|
+
username: string;
|
|
1015
|
+
/** Max items to return. Default 30, max 100. Billed per result. */
|
|
1016
|
+
limit?: number;
|
|
1017
|
+
}
|
|
1018
|
+
export interface GithubContributionsParams {
|
|
1019
|
+
/** GitHub username or profile URL. */
|
|
1020
|
+
username: string;
|
|
1021
|
+
}
|
|
1022
|
+
export interface GithubTrendingRepositoriesParams {
|
|
1023
|
+
/** GitHub repository search query. Default stars:>1000. */
|
|
1024
|
+
q: string;
|
|
1025
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
1026
|
+
limit?: number;
|
|
1027
|
+
}
|
|
1028
|
+
export interface GithubTrendingDevelopersParams {
|
|
1029
|
+
/** GitHub user search query. Default followers:>1000. */
|
|
1030
|
+
q: string;
|
|
1031
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
1032
|
+
limit?: number;
|
|
1033
|
+
}
|
|
1034
|
+
export declare class GithubApi {
|
|
1035
|
+
private readonly core;
|
|
1036
|
+
constructor(core: HttpCore);
|
|
1037
|
+
/** GitHub User — Public GitHub user profile details. (3 credits) */
|
|
1038
|
+
user(params: GithubUserParams): Promise<ApiEnvelope>;
|
|
1039
|
+
/** GitHub Repositories — List a GitHub user's repositories. (12 credits) */
|
|
1040
|
+
repositories(params: GithubRepositoriesParams): Promise<ApiEnvelope>;
|
|
1041
|
+
/** GitHub Repository — Repository details, stars, forks and metadata. (3 credits) */
|
|
1042
|
+
repository(params: GithubRepositoryParams): Promise<ApiEnvelope>;
|
|
1043
|
+
/** GitHub Pull Requests — List repository pull requests. (12 credits) */
|
|
1044
|
+
pullRequests(params: GithubPullRequestsParams): Promise<ApiEnvelope>;
|
|
1045
|
+
/** GitHub Activity — Recent public activity for a GitHub user. (12 credits) */
|
|
1046
|
+
activity(params: GithubActivityParams): Promise<ApiEnvelope>;
|
|
1047
|
+
/** GitHub Followers — List GitHub followers. (12 credits) */
|
|
1048
|
+
followers(params: GithubFollowersParams): Promise<ApiEnvelope>;
|
|
1049
|
+
/** GitHub Following — List accounts a GitHub user follows. (12 credits) */
|
|
1050
|
+
following(params: GithubFollowingParams): Promise<ApiEnvelope>;
|
|
1051
|
+
/** GitHub Contributions — Summary of recent public GitHub contributions. (3 credits) */
|
|
1052
|
+
contributions(params: GithubContributionsParams): Promise<ApiEnvelope>;
|
|
1053
|
+
/** GitHub Trending Repositories — Search trending repositories by stars or query. (12 credits) */
|
|
1054
|
+
trendingRepositories(params: GithubTrendingRepositoriesParams): Promise<ApiEnvelope>;
|
|
1055
|
+
/** GitHub Trending Developers — Search popular GitHub developers. (12 credits) */
|
|
1056
|
+
trendingDevelopers(params: GithubTrendingDevelopersParams): Promise<ApiEnvelope>;
|
|
1057
|
+
}
|
|
1058
|
+
export interface GoogleSearchParams {
|
|
1059
|
+
/** Search query or keywords (min 2 chars). */
|
|
1060
|
+
q: string;
|
|
1061
|
+
/** Two-letter country code. Default us. */
|
|
1062
|
+
country?: string;
|
|
1063
|
+
/** Google language code. Default en. */
|
|
1064
|
+
language?: string;
|
|
1065
|
+
/** Max items to return. Default 10, max 100. Billed per result. */
|
|
1066
|
+
limit?: number;
|
|
1067
|
+
}
|
|
1068
|
+
export declare class GoogleApi {
|
|
1069
|
+
private readonly core;
|
|
1070
|
+
constructor(core: HttpCore);
|
|
1071
|
+
/** Google Search — Google SERP organic search results by keyword, country, and language. (42 credits) */
|
|
1072
|
+
search(params: GoogleSearchParams): Promise<ApiEnvelope>;
|
|
1073
|
+
}
|
|
1074
|
+
export interface TwitchProfileParams {
|
|
1075
|
+
/** Twitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1076
|
+
url: string;
|
|
1077
|
+
}
|
|
1078
|
+
export interface TwitchUserVideosParams {
|
|
1079
|
+
/** Twitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1080
|
+
url: string;
|
|
1081
|
+
/** Max items to return. Default 20, max 30. Billed per result. */
|
|
1082
|
+
limit?: number;
|
|
1083
|
+
}
|
|
1084
|
+
export interface TwitchUserScheduleParams {
|
|
1085
|
+
/** Twitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1086
|
+
url: string;
|
|
1087
|
+
}
|
|
1088
|
+
export interface TwitchClipParams {
|
|
1089
|
+
/** Twitch clip URL, channel URL, or username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1090
|
+
url: string;
|
|
1091
|
+
}
|
|
1092
|
+
export declare class TwitchApi {
|
|
1093
|
+
private readonly core;
|
|
1094
|
+
constructor(core: HttpCore);
|
|
1095
|
+
/** Twitch Profile — Twitch channel profile, followers, live status and recent metadata. (9 credits) */
|
|
1096
|
+
profile(params: TwitchProfileParams): Promise<ApiEnvelope>;
|
|
1097
|
+
/** Twitch User Videos — Recent Twitch VODs for a channel. (34 credits) */
|
|
1098
|
+
userVideos(params: TwitchUserVideosParams): Promise<ApiEnvelope>;
|
|
1099
|
+
/** Twitch User Schedule — Upcoming Twitch schedule data when exposed on the public channel. (34 credits) */
|
|
1100
|
+
userSchedule(params: TwitchUserScheduleParams): Promise<ApiEnvelope>;
|
|
1101
|
+
/** Twitch Clip — Twitch clip metadata from a clip URL or channel fallback. (9 credits) */
|
|
1102
|
+
clip(params: TwitchClipParams): Promise<ApiEnvelope>;
|
|
1103
|
+
}
|
|
1104
|
+
export interface SpotifyArtistParams {
|
|
1105
|
+
/** Spotify URL, URI, or ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1106
|
+
url: string;
|
|
1107
|
+
}
|
|
1108
|
+
export interface SpotifyTrackParams {
|
|
1109
|
+
/** Spotify URL, URI, or ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1110
|
+
url: string;
|
|
1111
|
+
}
|
|
1112
|
+
export interface SpotifyAlbumParams {
|
|
1113
|
+
/** Spotify URL, URI, or ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1114
|
+
url: string;
|
|
1115
|
+
}
|
|
1116
|
+
export interface SpotifySearchParams {
|
|
1117
|
+
/** Search query or keywords (min 2 chars). */
|
|
1118
|
+
q: string;
|
|
1119
|
+
/** tracks, albums, artists, podcasts, or episodes. Default tracks. */
|
|
1120
|
+
type?: string;
|
|
1121
|
+
/** Max items to return. Default 20, max 50. Billed per result. */
|
|
1122
|
+
limit?: number;
|
|
1123
|
+
}
|
|
1124
|
+
export interface SpotifyPodcastParams {
|
|
1125
|
+
/** Spotify URL, URI, or ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1126
|
+
url: string;
|
|
1127
|
+
/** Max items to return. Default 20, max 50. Billed per result. */
|
|
1128
|
+
limit?: number;
|
|
1129
|
+
}
|
|
1130
|
+
export interface SpotifyPodcastEpisodesParams {
|
|
1131
|
+
/** Spotify URL, URI, or ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1132
|
+
url: string;
|
|
1133
|
+
/** Max items to return. Default 20, max 50. Billed per result. */
|
|
1134
|
+
limit?: number;
|
|
1135
|
+
}
|
|
1136
|
+
export declare class SpotifyApi {
|
|
1137
|
+
private readonly core;
|
|
1138
|
+
constructor(core: HttpCore);
|
|
1139
|
+
/** Spotify Artist — Spotify artist details, followers and listener metadata. (6 credits) */
|
|
1140
|
+
artist(params: SpotifyArtistParams): Promise<ApiEnvelope>;
|
|
1141
|
+
/** Spotify Track — Spotify track metadata, artists, album and play count when available. (6 credits) */
|
|
1142
|
+
track(params: SpotifyTrackParams): Promise<ApiEnvelope>;
|
|
1143
|
+
/** Spotify Album — Spotify album metadata and track count. (6 credits) */
|
|
1144
|
+
album(params: SpotifyAlbumParams): Promise<ApiEnvelope>;
|
|
1145
|
+
/** Spotify Search — Search Spotify tracks, albums, artists, podcasts or episodes. (23 credits) */
|
|
1146
|
+
search(params: SpotifySearchParams): Promise<ApiEnvelope>;
|
|
1147
|
+
/** Spotify Podcast — Spotify podcast/show details and episode summary metadata. (6 credits) */
|
|
1148
|
+
podcast(params: SpotifyPodcastParams): Promise<ApiEnvelope>;
|
|
1149
|
+
/** Spotify Podcast Episodes — List episodes for a Spotify podcast/show. (23 credits) */
|
|
1150
|
+
podcastEpisodes(params: SpotifyPodcastEpisodesParams): Promise<ApiEnvelope>;
|
|
1151
|
+
}
|
|
1152
|
+
export interface SoundcloudArtistParams {
|
|
1153
|
+
/** SoundCloud artist profile URL or username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1154
|
+
url: string;
|
|
1155
|
+
}
|
|
1156
|
+
export interface SoundcloudArtistTracksParams {
|
|
1157
|
+
/** SoundCloud artist profile URL or username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1158
|
+
url: string;
|
|
1159
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
1160
|
+
limit?: number;
|
|
1161
|
+
}
|
|
1162
|
+
export interface SoundcloudTrackParams {
|
|
1163
|
+
/** SoundCloud track URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1164
|
+
url: string;
|
|
1165
|
+
}
|
|
1166
|
+
export declare class SoundcloudApi {
|
|
1167
|
+
private readonly core;
|
|
1168
|
+
constructor(core: HttpCore);
|
|
1169
|
+
/** SoundCloud Artist — SoundCloud artist profile metadata. (7 credits) */
|
|
1170
|
+
artist(params: SoundcloudArtistParams): Promise<ApiEnvelope>;
|
|
1171
|
+
/** SoundCloud Artist Tracks — Tracks from a SoundCloud artist profile. (28 credits) */
|
|
1172
|
+
artistTracks(params: SoundcloudArtistTracksParams): Promise<ApiEnvelope>;
|
|
1173
|
+
/** SoundCloud Track — SoundCloud track metadata and engagement stats. (7 credits) */
|
|
1174
|
+
track(params: SoundcloudTrackParams): Promise<ApiEnvelope>;
|
|
1175
|
+
}
|
|
1176
|
+
export interface LinktreePageParams {
|
|
1177
|
+
/** Linktree profile URL or username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1178
|
+
url: string;
|
|
1179
|
+
}
|
|
1180
|
+
export declare class LinktreeApi {
|
|
1181
|
+
private readonly core;
|
|
1182
|
+
constructor(core: HttpCore);
|
|
1183
|
+
/** Linktree Page — Public Linktree profile links, socials and profile metadata. (4 credits) */
|
|
1184
|
+
page(params: LinktreePageParams): Promise<ApiEnvelope>;
|
|
1185
|
+
}
|
|
1186
|
+
export interface SnapchatUserProfileParams {
|
|
1187
|
+
/** Snapchat username or profile URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1188
|
+
url: string;
|
|
1189
|
+
}
|
|
1190
|
+
export declare class SnapchatApi {
|
|
1191
|
+
private readonly core;
|
|
1192
|
+
constructor(core: HttpCore);
|
|
1193
|
+
/** Snapchat User Profile — Public Snapchat profile metadata, subscriber count, avatar and highlights. (11 credits) */
|
|
1194
|
+
userProfile(params: SnapchatUserProfileParams): Promise<ApiEnvelope>;
|
|
1195
|
+
}
|
|
1196
|
+
export interface TruthSocialProfileParams {
|
|
1197
|
+
/** Truth Social profile URL or @username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1198
|
+
url: string;
|
|
1199
|
+
}
|
|
1200
|
+
export interface TruthSocialUserPostsParams {
|
|
1201
|
+
/** Truth Social profile URL or @username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1202
|
+
url: string;
|
|
1203
|
+
/** Max items to return. Default 20, max 80. Billed per result. */
|
|
1204
|
+
limit?: number;
|
|
1205
|
+
}
|
|
1206
|
+
export interface TruthSocialPostParams {
|
|
1207
|
+
/** Truth Social post URL or post ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1208
|
+
url: string;
|
|
1209
|
+
}
|
|
1210
|
+
export declare class TruthSocialApi {
|
|
1211
|
+
private readonly core;
|
|
1212
|
+
constructor(core: HttpCore);
|
|
1213
|
+
/** Truth Social Profile — Public Truth Social profile metadata and stats. (5 credits) */
|
|
1214
|
+
profile(params: TruthSocialProfileParams): Promise<ApiEnvelope>;
|
|
1215
|
+
/** Truth Social User Posts — Recent public posts from a Truth Social profile. (17 credits) */
|
|
1216
|
+
userPosts(params: TruthSocialUserPostsParams): Promise<ApiEnvelope>;
|
|
1217
|
+
/** Truth Social Post — Truth Social post metadata, text, media and engagement. (5 credits) */
|
|
1218
|
+
post(params: TruthSocialPostParams): Promise<ApiEnvelope>;
|
|
1219
|
+
}
|
|
1220
|
+
export interface KickClipParams {
|
|
1221
|
+
/** Kick clip URL, channel URL, or channel username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1222
|
+
url: string;
|
|
1223
|
+
/** Max items to return. Default 30, max 100. Billed per result. */
|
|
1224
|
+
limit?: number;
|
|
1225
|
+
}
|
|
1226
|
+
export declare class KickApi {
|
|
1227
|
+
private readonly core;
|
|
1228
|
+
constructor(core: HttpCore);
|
|
1229
|
+
/** Kick Clip — Kick clip metadata from a clip URL or recent channel clips. (34 credits) */
|
|
1230
|
+
clip(params: KickClipParams): Promise<ApiEnvelope>;
|
|
1231
|
+
}
|
|
1232
|
+
export interface AmazonShopPageParams {
|
|
1233
|
+
/** Amazon seller storefront URL, seller profile URL, or seller ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1234
|
+
url: string;
|
|
1235
|
+
/** Amazon marketplace code. Default US. */
|
|
1236
|
+
marketplace?: string;
|
|
1237
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
1238
|
+
limit?: number;
|
|
1239
|
+
}
|
|
1240
|
+
export declare class AmazonShopApi {
|
|
1241
|
+
private readonly core;
|
|
1242
|
+
constructor(core: HttpCore);
|
|
1243
|
+
/** Amazon Shop Page — Amazon seller storefront metadata and product listings. (89 credits) */
|
|
1244
|
+
page(params: AmazonShopPageParams): Promise<ApiEnvelope>;
|
|
1245
|
+
}
|
|
1246
|
+
export interface AgeGenderGetParams {
|
|
1247
|
+
/** First name, or fallback when names is omitted. */
|
|
1248
|
+
name: string;
|
|
1249
|
+
/** Optional comma-separated list of names. */
|
|
1250
|
+
names?: string;
|
|
1251
|
+
}
|
|
1252
|
+
export declare class AgeGenderApi {
|
|
1253
|
+
private readonly core;
|
|
1254
|
+
constructor(core: HttpCore);
|
|
1255
|
+
/** Age and Gender — Predict age, gender and nationality signals from first names. (4 credits) */
|
|
1256
|
+
get(params: AgeGenderGetParams): Promise<ApiEnvelope>;
|
|
1257
|
+
}
|
|
1258
|
+
export interface AccountBalanceParams {
|
|
1259
|
+
}
|
|
1260
|
+
export interface AccountRequestHistoryParams {
|
|
1261
|
+
/** Max items to return. Default 50, max 500. Billed per result. */
|
|
1262
|
+
limit?: number;
|
|
1263
|
+
}
|
|
1264
|
+
export interface AccountDailyUsageParams {
|
|
1265
|
+
/** Number of days to include. Default 30, max 365. */
|
|
1266
|
+
days?: number;
|
|
1267
|
+
}
|
|
1268
|
+
export interface AccountMostUsedRoutesParams {
|
|
1269
|
+
/** Number of days to include. Default 30, max 365. */
|
|
1270
|
+
days?: number;
|
|
1271
|
+
/** Max items to return. Default 20, max 100. Billed per result. */
|
|
1272
|
+
limit?: number;
|
|
1273
|
+
}
|
|
1274
|
+
export declare class AccountApi {
|
|
1275
|
+
private readonly core;
|
|
1276
|
+
constructor(core: HttpCore);
|
|
1277
|
+
/** Credit Balance — Get current Captapi credit balance and plan limits. (0 credits) */
|
|
1278
|
+
balance(params?: Record<string, never>): Promise<ApiEnvelope>;
|
|
1279
|
+
/** Request History — List recent Captapi API requests for the current key owner. (0 credits) */
|
|
1280
|
+
requestHistory(params?: AccountRequestHistoryParams): Promise<ApiEnvelope>;
|
|
1281
|
+
/** Daily Usage — Daily request and credit usage summary. (0 credits) */
|
|
1282
|
+
dailyUsage(params?: AccountDailyUsageParams): Promise<ApiEnvelope>;
|
|
1283
|
+
/** Most Used Routes — Most used API routes by request count and credits. (0 credits) */
|
|
1284
|
+
mostUsedRoutes(params?: AccountMostUsedRoutesParams): Promise<ApiEnvelope>;
|
|
1285
|
+
}
|
|
1286
|
+
export interface KwaiProfileParams {
|
|
1287
|
+
/** Kwai/Kuaishou profile URL or user ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1288
|
+
url: string;
|
|
1289
|
+
}
|
|
1290
|
+
export interface KwaiUserPostsParams {
|
|
1291
|
+
/** Kwai/Kuaishou profile URL or user ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1292
|
+
url: string;
|
|
1293
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
1294
|
+
limit?: number;
|
|
1295
|
+
}
|
|
1296
|
+
export interface KwaiPostParams {
|
|
1297
|
+
/** Kwai/Kuaishou post URL or video/photo ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1298
|
+
url: string;
|
|
1299
|
+
}
|
|
1300
|
+
export declare class KwaiApi {
|
|
1301
|
+
private readonly core;
|
|
1302
|
+
constructor(core: HttpCore);
|
|
1303
|
+
/** Kwai Profile — Kwai/Kuaishou public profile details and stats. (17 credits) */
|
|
1304
|
+
profile(params: KwaiProfileParams): Promise<ApiEnvelope>;
|
|
1305
|
+
/** Kwai User Posts — Recent Kwai/Kuaishou videos from a profile. (45 credits) */
|
|
1306
|
+
userPosts(params: KwaiUserPostsParams): Promise<ApiEnvelope>;
|
|
1307
|
+
/** Kwai Post — Kwai/Kuaishou post metadata and engagement. (17 credits) */
|
|
1308
|
+
post(params: KwaiPostParams): Promise<ApiEnvelope>;
|
|
1309
|
+
}
|
|
1310
|
+
export interface KomiPageParams {
|
|
1311
|
+
/** Komi page URL or username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1312
|
+
url: string;
|
|
1313
|
+
}
|
|
1314
|
+
export declare class KomiApi {
|
|
1315
|
+
private readonly core;
|
|
1316
|
+
constructor(core: HttpCore);
|
|
1317
|
+
/** Komi Page — Public Komi page links and profile metadata. (4 credits) */
|
|
1318
|
+
page(params: KomiPageParams): Promise<ApiEnvelope>;
|
|
1319
|
+
}
|
|
1320
|
+
export interface PillarPageParams {
|
|
1321
|
+
/** Pillar page URL or username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1322
|
+
url: string;
|
|
1323
|
+
}
|
|
1324
|
+
export declare class PillarApi {
|
|
1325
|
+
private readonly core;
|
|
1326
|
+
constructor(core: HttpCore);
|
|
1327
|
+
/** Pillar Page — Public Pillar page links and profile metadata. (4 credits) */
|
|
1328
|
+
page(params: PillarPageParams): Promise<ApiEnvelope>;
|
|
1329
|
+
}
|
|
1330
|
+
export interface LinkbioPageParams {
|
|
1331
|
+
/** Linkbio page URL or username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1332
|
+
url: string;
|
|
1333
|
+
}
|
|
1334
|
+
export declare class LinkbioApi {
|
|
1335
|
+
private readonly core;
|
|
1336
|
+
constructor(core: HttpCore);
|
|
1337
|
+
/** Linkbio Page — Public Linkbio page links and profile metadata. (4 credits) */
|
|
1338
|
+
page(params: LinkbioPageParams): Promise<ApiEnvelope>;
|
|
1339
|
+
}
|
|
1340
|
+
export interface LinkmeProfileParams {
|
|
1341
|
+
/** Linkme profile URL or username. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1342
|
+
url: string;
|
|
1343
|
+
}
|
|
1344
|
+
export declare class LinkmeApi {
|
|
1345
|
+
private readonly core;
|
|
1346
|
+
constructor(core: HttpCore);
|
|
1347
|
+
/** Linkme Profile — Public Linkme profile links and metadata. (4 credits) */
|
|
1348
|
+
profile(params: LinkmeProfileParams): Promise<ApiEnvelope>;
|
|
1349
|
+
}
|
|
1350
|
+
export interface FacebookAdLibrarySearchParams {
|
|
1351
|
+
/** Search query or keywords (min 2 chars). */
|
|
1352
|
+
q: string;
|
|
1353
|
+
/** ISO country code. Default US. */
|
|
1354
|
+
country?: string;
|
|
1355
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
1356
|
+
limit?: number;
|
|
1357
|
+
}
|
|
1358
|
+
export interface FacebookAdLibraryCompanyAdsParams {
|
|
1359
|
+
/** Facebook page URL or Meta Ad Library URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1360
|
+
url: string;
|
|
1361
|
+
/** ISO country code. Default US. */
|
|
1362
|
+
country?: string;
|
|
1363
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
1364
|
+
limit?: number;
|
|
1365
|
+
}
|
|
1366
|
+
export interface FacebookAdLibrarySearchCompaniesParams {
|
|
1367
|
+
/** Search query or keywords (min 2 chars). */
|
|
1368
|
+
q: string;
|
|
1369
|
+
/** ISO country code. Default US. */
|
|
1370
|
+
country?: string;
|
|
1371
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
1372
|
+
limit?: number;
|
|
1373
|
+
}
|
|
1374
|
+
export interface FacebookAdLibraryAdDetailsParams {
|
|
1375
|
+
/** Meta Ad Library ad URL. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1376
|
+
url: string;
|
|
1377
|
+
}
|
|
1378
|
+
export interface FacebookAdLibraryAdTranscriptParams {
|
|
1379
|
+
/** Meta Ad Library ad URL or ad ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1380
|
+
url: string;
|
|
1381
|
+
}
|
|
1382
|
+
export interface TiktokAdLibrarySearchParams {
|
|
1383
|
+
/** Search query or keywords (min 2 chars). */
|
|
1384
|
+
q: string;
|
|
1385
|
+
/** ISO country code. Default DE. */
|
|
1386
|
+
country?: string;
|
|
1387
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
1388
|
+
limit?: number;
|
|
1389
|
+
}
|
|
1390
|
+
export interface TiktokAdLibraryAdDetailsParams {
|
|
1391
|
+
/** TikTok Ad Library URL or ad ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1392
|
+
url: string;
|
|
1393
|
+
/** ISO country code. Default DE. */
|
|
1394
|
+
country?: string;
|
|
1395
|
+
}
|
|
1396
|
+
export interface GoogleAdLibraryCompanyAdsParams {
|
|
1397
|
+
/** Advertiser name, domain, or Google advertiser ID. */
|
|
1398
|
+
advertiser: string;
|
|
1399
|
+
/** ISO country code. Default US. */
|
|
1400
|
+
country?: string;
|
|
1401
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
1402
|
+
limit?: number;
|
|
1403
|
+
}
|
|
1404
|
+
export interface GoogleAdLibraryAdDetailsParams {
|
|
1405
|
+
/** Google Ads Transparency Center URL containing AR advertiser ID and CR creative ID. */
|
|
1406
|
+
creative_id: string;
|
|
1407
|
+
/** ISO country code. Default US. */
|
|
1408
|
+
country?: string;
|
|
1409
|
+
}
|
|
1410
|
+
export interface GoogleAdLibraryAdvertiserSearchParams {
|
|
1411
|
+
/** Search query or keywords (min 2 chars). */
|
|
1412
|
+
q: string;
|
|
1413
|
+
/** ISO country code. Default US. */
|
|
1414
|
+
country?: string;
|
|
1415
|
+
/** Max items to return. Default 10, max 50. Billed per result. */
|
|
1416
|
+
limit?: number;
|
|
1417
|
+
}
|
|
1418
|
+
export interface LinkedinAdLibrarySearchAdsParams {
|
|
1419
|
+
/** Search query or keywords (min 2 chars). */
|
|
1420
|
+
q: string;
|
|
1421
|
+
/** ISO country code. Default US. */
|
|
1422
|
+
country?: string;
|
|
1423
|
+
/** Max items to return. Default 20, max 200. Billed per result. */
|
|
1424
|
+
limit?: number;
|
|
1425
|
+
}
|
|
1426
|
+
export interface LinkedinAdLibraryAdDetailsParams {
|
|
1427
|
+
/** LinkedIn Ad Library URL or ad ID. The URL platform must match this tool's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. */
|
|
1428
|
+
url: string;
|
|
1429
|
+
}
|
|
1430
|
+
export declare class AdLibraryApi {
|
|
1431
|
+
private readonly core;
|
|
1432
|
+
constructor(core: HttpCore);
|
|
1433
|
+
/** Facebook Ad Library Search — Search Meta/Facebook ads by keyword. (70 credits) */
|
|
1434
|
+
facebookSearch(params: FacebookAdLibrarySearchParams): Promise<ApiEnvelope>;
|
|
1435
|
+
/** Facebook Company Ads — Ads for a Facebook page or Meta Ad Library URL. (70 credits) */
|
|
1436
|
+
facebookCompanyAds(params: FacebookAdLibraryCompanyAdsParams): Promise<ApiEnvelope>;
|
|
1437
|
+
/** Facebook Ad Library Search Companies — Find advertisers/pages in the Meta Ad Library by name. (70 credits) */
|
|
1438
|
+
facebookSearchCompanies(params: FacebookAdLibrarySearchCompaniesParams): Promise<ApiEnvelope>;
|
|
1439
|
+
/** Facebook Ad Details — Meta/Facebook ad details. (17 credits) */
|
|
1440
|
+
facebookAdDetails(params: FacebookAdLibraryAdDetailsParams): Promise<ApiEnvelope>;
|
|
1441
|
+
/** Facebook Ad Transcript — Extract creative text from a Meta/Facebook ad as transcript text. (17 credits) */
|
|
1442
|
+
facebookAdTranscript(params: FacebookAdLibraryAdTranscriptParams): Promise<ApiEnvelope>;
|
|
1443
|
+
/** TikTok Ad Library Search — Search TikTok Ad Library and Creative Center. (70 credits) */
|
|
1444
|
+
tiktokSearch(params: TiktokAdLibrarySearchParams): Promise<ApiEnvelope>;
|
|
1445
|
+
/** TikTok Ad Details — TikTok ad details by ad URL or ID. (17 credits) */
|
|
1446
|
+
tiktokAdDetails(params: TiktokAdLibraryAdDetailsParams): Promise<ApiEnvelope>;
|
|
1447
|
+
/** Google Company Ads — Google Ads Transparency Center ads for an advertiser. (67 credits) */
|
|
1448
|
+
googleCompanyAds(params: GoogleAdLibraryCompanyAdsParams): Promise<ApiEnvelope>;
|
|
1449
|
+
/** Google Ad Details — Google ad details by Transparency Center URL. (17 credits) */
|
|
1450
|
+
googleAdDetails(params: GoogleAdLibraryAdDetailsParams): Promise<ApiEnvelope>;
|
|
1451
|
+
/** Google Advertiser Search — Search Google Ads advertisers. (45 credits) */
|
|
1452
|
+
googleAdvertiserSearch(params: GoogleAdLibraryAdvertiserSearchParams): Promise<ApiEnvelope>;
|
|
1453
|
+
/** LinkedIn Ad Library Search — Search LinkedIn Ad Library ads. (70 credits) */
|
|
1454
|
+
linkedinSearchAds(params: LinkedinAdLibrarySearchAdsParams): Promise<ApiEnvelope>;
|
|
1455
|
+
/** LinkedIn Ad Details — LinkedIn ad details by URL or ID. (17 credits) */
|
|
1456
|
+
linkedinAdDetails(params: LinkedinAdLibraryAdDetailsParams): Promise<ApiEnvelope>;
|
|
1457
|
+
}
|
|
1458
|
+
/** Captapi API client. Get your key at https://captapi.com/dashboard/api-keys */
|
|
1459
|
+
export declare class Captapi {
|
|
1460
|
+
readonly youtube: YoutubeApi;
|
|
1461
|
+
readonly tiktok: TiktokApi;
|
|
1462
|
+
readonly instagram: InstagramApi;
|
|
1463
|
+
readonly facebook: FacebookApi;
|
|
1464
|
+
readonly twitter: TwitterApi;
|
|
1465
|
+
readonly reddit: RedditApi;
|
|
1466
|
+
readonly threads: ThreadsApi;
|
|
1467
|
+
readonly bluesky: BlueskyApi;
|
|
1468
|
+
readonly pinterest: PinterestApi;
|
|
1469
|
+
readonly linkedin: LinkedinApi;
|
|
1470
|
+
readonly rumble: RumbleApi;
|
|
1471
|
+
readonly tiktokShop: TiktokShopApi;
|
|
1472
|
+
readonly github: GithubApi;
|
|
1473
|
+
readonly google: GoogleApi;
|
|
1474
|
+
readonly twitch: TwitchApi;
|
|
1475
|
+
readonly spotify: SpotifyApi;
|
|
1476
|
+
readonly soundcloud: SoundcloudApi;
|
|
1477
|
+
readonly linktree: LinktreeApi;
|
|
1478
|
+
readonly snapchat: SnapchatApi;
|
|
1479
|
+
readonly truthSocial: TruthSocialApi;
|
|
1480
|
+
readonly kick: KickApi;
|
|
1481
|
+
readonly amazonShop: AmazonShopApi;
|
|
1482
|
+
readonly ageGender: AgeGenderApi;
|
|
1483
|
+
readonly account: AccountApi;
|
|
1484
|
+
readonly kwai: KwaiApi;
|
|
1485
|
+
readonly komi: KomiApi;
|
|
1486
|
+
readonly pillar: PillarApi;
|
|
1487
|
+
readonly linkbio: LinkbioApi;
|
|
1488
|
+
readonly linkme: LinkmeApi;
|
|
1489
|
+
readonly adLibrary: AdLibraryApi;
|
|
1490
|
+
constructor(options?: CaptapiOptions);
|
|
1491
|
+
}
|