@captapi/sdk 0.1.0 → 0.2.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 +8 -0
- package/dist/core.js +90 -23
- package/dist/generated.d.ts +1381 -679
- package/dist/generated.js +340 -312
- package/package.json +2 -2
package/dist/generated.js
CHANGED
|
@@ -5,95 +5,95 @@ export class YoutubeApi {
|
|
|
5
5
|
constructor(core) {
|
|
6
6
|
this.core = core;
|
|
7
7
|
}
|
|
8
|
-
/** YouTube Transcript —
|
|
8
|
+
/** YouTube Transcript — YouTube's published captions with timestamps — not speech-to-text. Flat 1 credit; 404 is free. (1 credit) */
|
|
9
9
|
transcript(params) {
|
|
10
10
|
return this.core.get("/v1/youtube/transcript", params);
|
|
11
11
|
}
|
|
12
|
-
/** YouTube
|
|
12
|
+
/** YouTube Audio Transcript — Speech-to-text for YouTube audio. Use it when a video has no captions — or when you want a transcript of what was actually spoken rather than YouTube's published captions. Priced per started minute of audio. (2 credits/min of audio) */
|
|
13
|
+
audioTranscript(params) {
|
|
14
|
+
return this.core.get("/v1/youtube/audio-transcript", params);
|
|
15
|
+
}
|
|
16
|
+
/** YouTube Summarizer — GPT summary from YouTube's published captions — same source as /transcript. Flat 3 credits; caption-miss 404 is free. (3 credits) */
|
|
13
17
|
summarize(params) {
|
|
14
18
|
return this.core.get("/v1/youtube/summarize", params);
|
|
15
19
|
}
|
|
16
|
-
/** YouTube Video Details —
|
|
20
|
+
/** YouTube Video Details — YouTube video metadata + stats. Always includes degraded / degradedReason — retry when degraded is true. (1 credit) */
|
|
17
21
|
videoDetails(params) {
|
|
18
22
|
return this.core.get("/v1/youtube/video-details", params);
|
|
19
23
|
}
|
|
20
|
-
/** YouTube Comments —
|
|
24
|
+
/** YouTube Comments — Get comments on any YouTube video — text, author, likes, and truncated publishedTimeApprox from the relative label, with cursor pagination (nextCursor + hasMore). Flat 2 credits per call. (2 credits) */
|
|
21
25
|
comments(params) {
|
|
22
26
|
return this.core.get("/v1/youtube/comments", params);
|
|
23
27
|
}
|
|
24
|
-
/** YouTube Channel Details —
|
|
28
|
+
/** YouTube Channel Details — YouTube channel stats — ISO country, createdAt date-only, real banner or null, quote-aware SEO tags, absolute links. Flat 1 credit. (1 credit) */
|
|
25
29
|
channelDetails(params) {
|
|
26
30
|
return this.core.get("/v1/youtube/channel-details", params);
|
|
27
31
|
}
|
|
28
|
-
/** YouTube Search —
|
|
32
|
+
/** YouTube Search — YouTube search with cursor pagination — typed hits, ids, canonical URLs, filters (2 credits/page). (2 credits) */
|
|
29
33
|
search(params) {
|
|
30
34
|
return this.core.get("/v1/youtube/search", params);
|
|
31
35
|
}
|
|
32
|
-
/** YouTube Channel Videos —
|
|
36
|
+
/** YouTube Channel Videos — Channel uploads with cursor pagination — exact publishedAt from reel_item_watch (same as channel-shorts). (2 credits) */
|
|
33
37
|
channelVideos(params) {
|
|
34
38
|
return this.core.get("/v1/youtube/channel-videos", params);
|
|
35
39
|
}
|
|
36
|
-
/** YouTube Playlist Videos —
|
|
40
|
+
/** YouTube Playlist Videos — Paginated playlist contents — cursor/nextCursor/hasMore, same row shape as channel-videos. Flat 2 credits/page. (2 credits) */
|
|
37
41
|
playlistVideos(params) {
|
|
38
42
|
return this.core.get("/v1/youtube/playlist-videos", params);
|
|
39
43
|
}
|
|
40
|
-
/** YouTube Playlist — Playlist metadata
|
|
44
|
+
/** YouTube Playlist — Playlist metadata only — title, channel{}, totalVideos, thumbnailUrl. No videos[]. Flat 1 credit. (1 credit) */
|
|
41
45
|
playlist(params) {
|
|
42
46
|
return this.core.get("/v1/youtube/playlist", params);
|
|
43
47
|
}
|
|
44
|
-
/** YouTube
|
|
45
|
-
videoDownload(params) {
|
|
46
|
-
return this.core.get("/v1/youtube/video-download", params);
|
|
47
|
-
}
|
|
48
|
-
/** YouTube Shorts Transcript — Transcript of a YouTube Short. (2 credits) */
|
|
48
|
+
/** YouTube Shorts Transcript — Transcript for a YouTube Short — rejects long-form videos (≤3 min only). (1 credit) */
|
|
49
49
|
shortsTranscript(params) {
|
|
50
50
|
return this.core.get("/v1/youtube/shorts/transcript", params);
|
|
51
51
|
}
|
|
52
|
-
/** YouTube Shorts Summarizer — AI summary of a YouTube Short. (
|
|
52
|
+
/** YouTube Shorts Summarizer — AI summary of a YouTube Short — rejects long-form videos (≤3 min only). (3 credits) */
|
|
53
53
|
shortsSummarize(params) {
|
|
54
54
|
return this.core.get("/v1/youtube/shorts/summarize", params);
|
|
55
55
|
}
|
|
56
|
-
/** YouTube Shorts Stats —
|
|
56
|
+
/** YouTube Shorts Stats — YouTube Short metadata — same schema as Video Details, with isShort:true; long-form videos get HTTP 422. (1 credit) */
|
|
57
57
|
shortsDetails(params) {
|
|
58
58
|
return this.core.get("/v1/youtube/shorts/video-details", params);
|
|
59
59
|
}
|
|
60
|
-
/** YouTube Shorts Comments — Comments on a YouTube Short. (
|
|
60
|
+
/** YouTube Shorts Comments — Comments on a YouTube Short — rejects long-form videos (≤3 min only). (2 credits) */
|
|
61
61
|
shortsComments(params) {
|
|
62
62
|
return this.core.get("/v1/youtube/shorts/comments", params);
|
|
63
63
|
}
|
|
64
|
-
/** YouTube Channel Shorts —
|
|
64
|
+
/** YouTube Channel Shorts — Channel Shorts with cursor pagination — same row shape as channel-videos (exact publishedAt). (2 credits) */
|
|
65
65
|
channelShorts(params) {
|
|
66
66
|
return this.core.get("/v1/youtube/channel-shorts", params);
|
|
67
67
|
}
|
|
68
|
-
/** YouTube Trending Shorts —
|
|
68
|
+
/** YouTube Trending Shorts — YouTube Shorts recommendation sequence — fixed window per call (no cursor), not a global chart. (2 credits) */
|
|
69
69
|
trendingShorts(params = {}) {
|
|
70
70
|
return this.core.get("/v1/youtube/trending-shorts", params);
|
|
71
71
|
}
|
|
72
|
-
/** YouTube Channel Streams —
|
|
72
|
+
/** YouTube Channel Streams — Channel Live tab only — liveStatus per row; 0 credits when hasLiveTab is false. (2 credits) */
|
|
73
73
|
channelStreams(params) {
|
|
74
74
|
return this.core.get("/v1/youtube/channel-streams", params);
|
|
75
75
|
}
|
|
76
|
-
/** YouTube Hashtag Search —
|
|
76
|
+
/** YouTube Hashtag Search — Videos from youtube.com/hashtag/{name} — nested channel{}, viewCountIsApproximate. Not keyword search. (~20 credits (1/result)) */
|
|
77
77
|
hashtagSearch(params) {
|
|
78
78
|
return this.core.get("/v1/youtube/hashtag-search", params);
|
|
79
79
|
}
|
|
80
|
-
/** YouTube Comment Replies — Replies
|
|
80
|
+
/** YouTube Comment Replies — Replies under a top-level comment — parentReplyCount + cursor. Nested reply ids return 404. (2 credits) */
|
|
81
81
|
commentReplies(params) {
|
|
82
82
|
return this.core.get("/v1/youtube/comment-replies", params);
|
|
83
83
|
}
|
|
84
|
-
/** YouTube Channel Playlists —
|
|
84
|
+
/** YouTube Channel Playlists — Channel playlists with cursor pagination — id, title, totalVideos, thumbnailUrl. Flat 2 credits/page. (2 credits) */
|
|
85
85
|
channelPlaylists(params) {
|
|
86
86
|
return this.core.get("/v1/youtube/channel-playlists", params);
|
|
87
87
|
}
|
|
88
|
-
/** YouTube Community Posts —
|
|
88
|
+
/** YouTube Community Posts — Community posts — channel{}, publishedTimeApprox, likeCountIsApproximate, linkedVideos[], cursor (1 credit). (1 credit) */
|
|
89
89
|
communityPosts(params) {
|
|
90
90
|
return this.core.get("/v1/youtube/community-posts", params);
|
|
91
91
|
}
|
|
92
|
-
/** YouTube Community Post Details —
|
|
92
|
+
/** YouTube Community Post Details — One community post — list schema + commentCount trio + isEdited. (1 credit) */
|
|
93
93
|
communityPostDetails(params) {
|
|
94
94
|
return this.core.get("/v1/youtube/community-post-details", params);
|
|
95
95
|
}
|
|
96
|
-
/** YouTube Video Sponsors —
|
|
96
|
+
/** YouTube Video Sponsors — SponsorBlock community segments — free while the CC BY-NC-SA commercial-use exception is pending. (0 credits) */
|
|
97
97
|
videoSponsors(params) {
|
|
98
98
|
return this.core.get("/v1/youtube/video-sponsors", params);
|
|
99
99
|
}
|
|
@@ -103,99 +103,95 @@ export class TiktokApi {
|
|
|
103
103
|
constructor(core) {
|
|
104
104
|
this.core = core;
|
|
105
105
|
}
|
|
106
|
-
/** TikTok Transcript — Transcript
|
|
106
|
+
/** TikTok Transcript — Transcript (2 credits) */
|
|
107
107
|
transcript(params) {
|
|
108
108
|
return this.core.get("/v1/tiktok/transcript", params);
|
|
109
109
|
}
|
|
110
|
-
/** TikTok Summarizer —
|
|
110
|
+
/** TikTok Summarizer — Summarizer (4 credits) */
|
|
111
111
|
summarize(params) {
|
|
112
112
|
return this.core.get("/v1/tiktok/summarize", params);
|
|
113
113
|
}
|
|
114
|
-
/** TikTok Video Details —
|
|
114
|
+
/** TikTok Video Details — Get everything about one TikTok video from its URL — caption, view/like/comment/share/save counts, creator, sound, hashtags, and thumbnail. (1 credit) */
|
|
115
115
|
videoDetails(params) {
|
|
116
116
|
return this.core.get("/v1/tiktok/video-details", params);
|
|
117
117
|
}
|
|
118
|
-
/** TikTok Comments —
|
|
118
|
+
/** TikTok Comments — TikTok comments — clean schema plus authorName, stable authorId/authorSecUid and commentLanguage for listening loops. Unresolvable videos are 404 at 0 credits. (2 credits) */
|
|
119
119
|
comments(params) {
|
|
120
120
|
return this.core.get("/v1/tiktok/comments", params);
|
|
121
121
|
}
|
|
122
|
-
/** TikTok Channel Details —
|
|
122
|
+
/** TikTok Channel Details — Resolve a TikTok @handle to id + secUid — createTime, ttSeller, bioLink, decoded privacy flags. (1 credit) */
|
|
123
123
|
channelDetails(params) {
|
|
124
124
|
return this.core.get("/v1/tiktok/channel-details", params);
|
|
125
125
|
}
|
|
126
|
-
/** TikTok Profile Region —
|
|
126
|
+
/** TikTok Profile Region — Find out where a TikTok creator is likely based and what language they use — country, language, stable ids, and core profile stats. (2 credits) */
|
|
127
127
|
profileRegion(params) {
|
|
128
128
|
return this.core.get("/v1/tiktok/profile-region", params);
|
|
129
129
|
}
|
|
130
|
-
/** TikTok Audience Demographics — Audience
|
|
130
|
+
/** TikTok Audience Demographics — Audience country + language mix for a TikTok creator — engagement sample, not a follower census. (3 credits) */
|
|
131
131
|
audienceDemographics(params) {
|
|
132
132
|
return this.core.get("/v1/tiktok/audience-demographics", params);
|
|
133
133
|
}
|
|
134
|
-
/** TikTok Search —
|
|
135
|
-
search(params) {
|
|
136
|
-
return this.core.get("/v1/tiktok/search", params);
|
|
137
|
-
}
|
|
138
|
-
/** TikTok Search Suggestions — TikTok search/autocomplete suggestions for a seed keyword. (28 credits) */
|
|
134
|
+
/** TikTok Search Suggestions — Get the autocomplete terms TikTok suggests in its search bar for a keyword — the real phrases people search, ranked, so you can find trending queries and long-tail keyword ideas. (2 credits) */
|
|
139
135
|
searchSuggestions(params) {
|
|
140
136
|
return this.core.get("/v1/tiktok/search-suggestions", params);
|
|
141
137
|
}
|
|
142
|
-
/** TikTok
|
|
143
|
-
videoDownload(params) {
|
|
144
|
-
return this.core.get("/v1/tiktok/video-download", params);
|
|
145
|
-
}
|
|
146
|
-
/** TikTok Channel Posts — Latest posts from a TikTok profile. (14 credits) */
|
|
138
|
+
/** TikTok Channel Posts — Latest videos from a TikTok profile. May return a labelled 6h-stale snapshot (degraded + staleAgeMs) when the live list is blocked. Failures are 0 credits. (2 credits) */
|
|
147
139
|
channelPosts(params) {
|
|
148
140
|
return this.core.get("/v1/tiktok/channel-posts", params);
|
|
149
141
|
}
|
|
150
|
-
/** TikTok Comment Replies — Replies
|
|
142
|
+
/** TikTok Comment Replies — Replies under a TikTok comment — same authorId/authorSecUid/commentLanguage shape as comments. (2 credits) */
|
|
151
143
|
commentReplies(params) {
|
|
152
144
|
return this.core.get("/v1/tiktok/comment-replies", params);
|
|
153
145
|
}
|
|
154
|
-
/** TikTok User Followers — List a TikTok user's followers. (
|
|
146
|
+
/** TikTok User Followers — List a TikTok user's followers — id, secUid, createTime, region, language, cursor pagination. Flat 1 credit. (1 credit) */
|
|
155
147
|
userFollowers(params) {
|
|
156
148
|
return this.core.get("/v1/tiktok/user-followers", params);
|
|
157
149
|
}
|
|
158
|
-
/** TikTok User Followings — List who a TikTok user follows. (
|
|
150
|
+
/** TikTok User Followings — List who a TikTok user follows — id, secUid, createTime, region, language, cursor pagination. Flat 1 credit. (1 credit) */
|
|
159
151
|
userFollowings(params) {
|
|
160
152
|
return this.core.get("/v1/tiktok/user-followings", params);
|
|
161
153
|
}
|
|
162
|
-
/** TikTok Music Posts —
|
|
154
|
+
/** TikTok Music Posts — List TikTok videos that use a specific sound — caption, author, exact engagement, canonical hashtags, and mentions, with cursor pagination. (2 credits) */
|
|
163
155
|
musicPosts(params) {
|
|
164
156
|
return this.core.get("/v1/tiktok/music-posts", params);
|
|
165
157
|
}
|
|
166
|
-
/** TikTok
|
|
167
|
-
hashtagSearch(params) {
|
|
168
|
-
return this.core.get("/v1/tiktok/hashtag-search", params);
|
|
169
|
-
}
|
|
170
|
-
/** TikTok Top Search — Top mixed TikTok results for a keyword. (14 credits) */
|
|
158
|
+
/** TikTok Top Search — TikTok Top/General search — videos and photo carousels when TikTok includes them, with contentType + images[]. (2 credits) */
|
|
171
159
|
topSearch(params) {
|
|
172
160
|
return this.core.get("/v1/tiktok/top-search", params);
|
|
173
161
|
}
|
|
174
|
-
/** TikTok
|
|
175
|
-
|
|
176
|
-
return this.core.get("/v1/tiktok/
|
|
162
|
+
/** TikTok Search by Hashtag — Videos from TikTok's /tag/{name} challenge feed — not keyword or username search. Cursor + hasMore. (~14 credits (0.7/result)) */
|
|
163
|
+
searchByHashtag(params) {
|
|
164
|
+
return this.core.get("/v1/tiktok/search/hashtag", params);
|
|
165
|
+
}
|
|
166
|
+
/** TikTok Search Users — Search TikTok users — distinct creators only, id + secUid, per-counter isApproximate flags, cursor pagination. (1 credit) */
|
|
167
|
+
searchUsers(params) {
|
|
168
|
+
return this.core.get("/v1/tiktok/search/users", params);
|
|
177
169
|
}
|
|
178
|
-
/** TikTok Song Details —
|
|
170
|
+
/** TikTok Song Details — TikTok sound metadata — usageCount, artists[{id,secUid,handle}], audio{bpm,loudness,beats}, commerce rights (1 credit native). (1 credit) */
|
|
179
171
|
songDetails(params) {
|
|
180
172
|
return this.core.get("/v1/tiktok/song-details", params);
|
|
181
173
|
}
|
|
182
|
-
/** TikTok Trending Feed —
|
|
174
|
+
/** TikTok Trending Feed — For You by default; pass orderBy/period/page for Creative Center popular videos (like/hot/comment/repost) with totalCount. Flat 2 credits. (2 credits) */
|
|
183
175
|
trendingFeed(params = {}) {
|
|
184
176
|
return this.core.get("/v1/tiktok/trending-feed", params);
|
|
185
177
|
}
|
|
186
|
-
/** TikTok Popular Hashtags —
|
|
178
|
+
/** TikTok Popular Hashtags — TikTok Creative Center hashtag chart — real videoCount/totalPlays, plus rankDiff and trend[] on that path. Flat 2 credits. (2 credits) */
|
|
187
179
|
popularHashtags(params = {}) {
|
|
188
180
|
return this.core.get("/v1/tiktok/popular-hashtags", params);
|
|
189
181
|
}
|
|
190
|
-
/** TikTok
|
|
182
|
+
/** TikTok Popular Songs — Creative Center popular/surging sounds — rankDiff, trend[], commercialMusic. 110s deadline, 0 credits on 502. (2 credits) */
|
|
183
|
+
popularSongs(params = {}) {
|
|
184
|
+
return this.core.get("/v1/tiktok/popular-songs", params);
|
|
185
|
+
}
|
|
186
|
+
/** TikTok Live — Is this TikTok creator live — isLive/status, creator.id/secUid, room, streamQualities with flv/hls/cmaf/dash. (1 credit) */
|
|
191
187
|
live(params) {
|
|
192
188
|
return this.core.get("/v1/tiktok/live", params);
|
|
193
189
|
}
|
|
194
|
-
/** TikTok Live Info —
|
|
190
|
+
/** TikTok Live Info — Identical to TikTok Live (isLive, creator.id/secUid, streamQualities hls/cmaf). (7 credits) */
|
|
195
191
|
liveInfo(params) {
|
|
196
192
|
return this.core.get("/v1/tiktok/live-info", params);
|
|
197
193
|
}
|
|
198
|
-
/** TikTok Popular Creators —
|
|
194
|
+
/** TikTok Popular Creators — Creative Center creators + createTime / bioLinkRisk / ttSeller hydrate for partnership vetting. (2 credits) */
|
|
199
195
|
popularCreators(params = {}) {
|
|
200
196
|
return this.core.get("/v1/tiktok/popular-creators", params);
|
|
201
197
|
}
|
|
@@ -205,79 +201,71 @@ export class InstagramApi {
|
|
|
205
201
|
constructor(core) {
|
|
206
202
|
this.core = core;
|
|
207
203
|
}
|
|
208
|
-
/** Instagram Transcript —
|
|
204
|
+
/** Instagram Transcript — Turn any Instagram Reel's speech into text — the full transcript plus timestamped segments, ready for search, subtitles, or AI pipelines. (2 credits) */
|
|
209
205
|
transcript(params) {
|
|
210
206
|
return this.core.get("/v1/instagram/transcript", params);
|
|
211
207
|
}
|
|
212
|
-
/** Instagram Summarizer — AI summary of
|
|
208
|
+
/** Instagram Summarizer — Get an AI summary of any Instagram Reel — a short paragraph plus key points, without watching the video. (4 credits) */
|
|
213
209
|
summarize(params) {
|
|
214
210
|
return this.core.get("/v1/instagram/summarize", params);
|
|
215
211
|
}
|
|
216
|
-
/** Instagram Details —
|
|
212
|
+
/** Instagram Post Details — Get an Instagram post, Reel or carousel — caption, likes, comments, views, media URLs, author, and per-slide children on carousels. (1 credit) */
|
|
217
213
|
details(params) {
|
|
218
214
|
return this.core.get("/v1/instagram/details", params);
|
|
219
215
|
}
|
|
220
|
-
/** Instagram Comments —
|
|
216
|
+
/** Instagram Post Comments — Get the comments on any Instagram post or Reel — text, author, avatar, likes, and timestamp for each comment. (~45 credits (0.9/result)) */
|
|
221
217
|
comments(params) {
|
|
222
218
|
return this.core.get("/v1/instagram/comments", params);
|
|
223
219
|
}
|
|
224
|
-
/** Instagram Channel Details —
|
|
220
|
+
/** Instagram Channel Details — Instagram profile stats — fixed key set (null fillers), fbid, bioLinks, isBusinessAccount, approx flags. (1 credit) */
|
|
225
221
|
channelDetails(params) {
|
|
226
222
|
return this.core.get("/v1/instagram/channel-details", params);
|
|
227
223
|
}
|
|
228
|
-
/** Instagram Channel Posts — Latest posts from
|
|
224
|
+
/** Instagram Channel Posts — Latest posts from a public Instagram profile — carousel children[], mediaCount, user{} in one call. (~6 credits (0.3/result)) */
|
|
229
225
|
channelPosts(params) {
|
|
230
226
|
return this.core.get("/v1/instagram/channel-posts", params);
|
|
231
227
|
}
|
|
232
|
-
/** Instagram Channel Reels — Latest Reels from
|
|
233
|
-
channelReels(params) {
|
|
228
|
+
/** Instagram Channel Reels — Latest Reels from a public Instagram profile — pass userId to skip resolve; ceil(n×0.3) credits; nextCursor + hasMore. (~6 credits (0.3/result)) */
|
|
229
|
+
channelReels(params = {}) {
|
|
234
230
|
return this.core.get("/v1/instagram/channel-reels", params);
|
|
235
231
|
}
|
|
236
|
-
/** Instagram Reels Search —
|
|
232
|
+
/** Instagram Reels Search — Native Instagram Reels hashtag search — engagement.views + viewsSource, location, commercial flags. Flat 2 credits. (2 credits) */
|
|
237
233
|
reelsSearch(params) {
|
|
238
234
|
return this.core.get("/v1/instagram/reels-search", params);
|
|
239
235
|
}
|
|
240
|
-
/** Instagram Trending Reels —
|
|
236
|
+
/** Instagram Trending Reels — Cache-first trending Reels — flat 2 credits every call (4h TTL). (2 credits) */
|
|
241
237
|
trendingReels(params = {}) {
|
|
242
238
|
return this.core.get("/v1/instagram/trending-reels", params);
|
|
243
239
|
}
|
|
244
|
-
/** Instagram
|
|
245
|
-
videoDownload(params) {
|
|
246
|
-
return this.core.get("/v1/instagram/video-download", params);
|
|
247
|
-
}
|
|
248
|
-
/** Instagram Tagged Posts — Posts an Instagram user is tagged in. (18 credits) */
|
|
240
|
+
/** Instagram Tagged Posts — Posts that tag an Instagram account — author verified/avatar when available, staleFeed when Instagram only exposes an archive. (1 credit) */
|
|
249
241
|
taggedPosts(params) {
|
|
250
242
|
return this.core.get("/v1/instagram/tagged-posts", params);
|
|
251
243
|
}
|
|
252
|
-
/** Instagram
|
|
253
|
-
musicPosts(params) {
|
|
254
|
-
return this.core.get("/v1/instagram/music-posts", params);
|
|
255
|
-
}
|
|
256
|
-
/** Instagram Reels By Audio ID — Posts/Reels using an Instagram audio ID. (28 credits) */
|
|
244
|
+
/** Instagram Reels By Audio ID — Is this Instagram sound trending? Reels that use it + isTrendingInClips / trendRank / rich music{}. (~28 credits (1.4/result)) */
|
|
257
245
|
reelsByAudioId(params) {
|
|
258
246
|
return this.core.get("/v1/instagram/reels-by-audio-id", params);
|
|
259
247
|
}
|
|
260
|
-
/** Instagram Hashtag Search —
|
|
248
|
+
/** Instagram Hashtag Search — Native Instagram hashtag Explore — Reels-heavy top surface with real likes, views, captions, and paid flags. Flat 2 credits. (2 credits) */
|
|
261
249
|
hashtagSearch(params) {
|
|
262
250
|
return this.core.get("/v1/instagram/hashtag-search", params);
|
|
263
251
|
}
|
|
264
|
-
/** Instagram Profile Search —
|
|
252
|
+
/** Instagram Profile Search — Resolve a brand or @handle to one public Instagram profile — stable id, bio, links, and stats (not niche discovery). (1 credit) */
|
|
265
253
|
profileSearch(params) {
|
|
266
254
|
return this.core.get("/v1/instagram/profile-search", params);
|
|
267
255
|
}
|
|
268
|
-
/** Instagram
|
|
269
|
-
|
|
270
|
-
return this.core.get("/v1/instagram/
|
|
256
|
+
/** Instagram Embed HTML — Classic Instagram embed snippet — blockquote.instagram-media + embed.js. Drop html into your page. (1 credit) */
|
|
257
|
+
embed(params) {
|
|
258
|
+
return this.core.get("/v1/instagram/embed", params);
|
|
259
|
+
}
|
|
260
|
+
/** Instagram Highlights — Persistent Story Highlight albums for a public profile — id, title, cover, owner. Flat 1 credit. (1 credit) */
|
|
261
|
+
highlights(params = {}) {
|
|
262
|
+
return this.core.get("/v1/instagram/highlights", params);
|
|
271
263
|
}
|
|
272
|
-
/** Instagram Highlights Details — Items inside
|
|
264
|
+
/** Instagram Highlights Details — Items inside one Instagram Story Highlight album — media URLs, type, takenAt. Flat 1 credit. (1 credit) */
|
|
273
265
|
highlightsDetails(params) {
|
|
274
266
|
return this.core.get("/v1/instagram/highlights-details", params);
|
|
275
267
|
}
|
|
276
|
-
/** Instagram
|
|
277
|
-
embed(params) {
|
|
278
|
-
return this.core.get("/v1/instagram/embed", params);
|
|
279
|
-
}
|
|
280
|
-
/** Instagram Basic Profile — Lightweight Instagram profile lookup (core fields). (1 credit) */
|
|
268
|
+
/** Instagram Basic Profile — Instagram profile by user ID or @handle — camelCase schema aligned with Channel Details (followers, externalUrl, businessAddress). (1 credit) */
|
|
281
269
|
basicProfile(params) {
|
|
282
270
|
return this.core.get("/v1/instagram/basic-profile", params);
|
|
283
271
|
}
|
|
@@ -287,101 +275,69 @@ export class FacebookApi {
|
|
|
287
275
|
constructor(core) {
|
|
288
276
|
this.core = core;
|
|
289
277
|
}
|
|
290
|
-
/** Facebook Details —
|
|
278
|
+
/** Facebook Details — Facebook post or Reel — caption, engagement, author id, video{} playback, and music when Facebook exposes them. (2 credits) */
|
|
291
279
|
details(params) {
|
|
292
280
|
return this.core.get("/v1/facebook/details", params);
|
|
293
281
|
}
|
|
294
|
-
/** Facebook
|
|
295
|
-
transcript(params) {
|
|
296
|
-
return this.core.get("/v1/facebook/transcript", params);
|
|
297
|
-
}
|
|
298
|
-
/** Facebook Summarizer — AI summary of a Facebook video or post. (4 credits) */
|
|
282
|
+
/** Facebook Summarizer — Summarizer (4 credits) */
|
|
299
283
|
summarize(params) {
|
|
300
284
|
return this.core.get("/v1/facebook/summarize", params);
|
|
301
285
|
}
|
|
302
|
-
/** Facebook Comments —
|
|
303
|
-
comments(params) {
|
|
286
|
+
/** Facebook Comments — Facebook post comments with reactionCount, reactions.like when mixed, author.id (pfbid), and replyCount. (2 credits) */
|
|
287
|
+
comments(params = {}) {
|
|
304
288
|
return this.core.get("/v1/facebook/comments", params);
|
|
305
289
|
}
|
|
306
|
-
/** Facebook Page Details —
|
|
290
|
+
/** Facebook Page Details — Facebook page profile — likes vs followers (distinct), talkingAbout, category, website, and public email. (2 credits) */
|
|
307
291
|
pageDetails(params) {
|
|
308
292
|
return this.core.get("/v1/facebook/page-details", params);
|
|
309
293
|
}
|
|
310
|
-
/** Facebook Profile Posts — Latest posts from a Facebook
|
|
294
|
+
/** Facebook Profile Posts — Latest posts and Reels from a Facebook page — listingHits / timings.phase; 60s deadline, failures 0 credits. (2 credits) */
|
|
311
295
|
profilePosts(params) {
|
|
312
296
|
return this.core.get("/v1/facebook/profile-posts", params);
|
|
313
297
|
}
|
|
314
|
-
/** Facebook Profile Reels — Latest Reels
|
|
298
|
+
/** Facebook Profile Reels — Latest Facebook page Reels — views, likes, comments, shares; newest-first without archive padding. (2 credits) */
|
|
315
299
|
profileReels(params) {
|
|
316
300
|
return this.core.get("/v1/facebook/profile-reels", params);
|
|
317
301
|
}
|
|
318
|
-
/** Facebook Group Posts —
|
|
302
|
+
/** Facebook Group Posts — Public Facebook group posts — listingHits / hydrateFailures / hydrateSkipped, sortBy, and per-count *IsApproximate. (2 credits) */
|
|
319
303
|
groupPosts(params) {
|
|
320
304
|
return this.core.get("/v1/facebook/group-posts", params);
|
|
321
305
|
}
|
|
322
|
-
/** Facebook Comment Replies — Replies
|
|
306
|
+
/** Facebook Comment Replies — Comment Replies (2 credits) */
|
|
323
307
|
commentReplies(params) {
|
|
324
308
|
return this.core.get("/v1/facebook/comment-replies", params);
|
|
325
309
|
}
|
|
326
|
-
/** Facebook
|
|
327
|
-
marketplaceSearch(params) {
|
|
328
|
-
return this.core.get("/v1/facebook/marketplace-search", params);
|
|
329
|
-
}
|
|
330
|
-
/** Facebook Marketplace Location Search — Find Facebook Marketplace location candidates for a city or place query. (17 credits) */
|
|
331
|
-
marketplaceLocationSearch(params) {
|
|
332
|
-
return this.core.get("/v1/facebook/marketplace-location-search", params);
|
|
333
|
-
}
|
|
334
|
-
/** Facebook Event Search — Search Facebook events by topic and/or location. (40 credits) */
|
|
335
|
-
eventSearch(params) {
|
|
336
|
-
return this.core.get("/v1/facebook/event-search", params);
|
|
337
|
-
}
|
|
338
|
-
/** Facebook Event Details — Details for a Facebook event (date, location, attendees, tickets). (2 credits) */
|
|
339
|
-
eventDetails(params) {
|
|
340
|
-
return this.core.get("/v1/facebook/event-details", params);
|
|
341
|
-
}
|
|
342
|
-
/** Facebook Profile Photos — Photos from a Facebook profile or page. (12 credits) */
|
|
310
|
+
/** Facebook Profile Photos — Photo grid from a Facebook Page — full image URL plus accessibilityCaption (alt-text, not a post caption). (2 credits) */
|
|
343
311
|
profilePhotos(params) {
|
|
344
312
|
return this.core.get("/v1/facebook/profile-photos", params);
|
|
345
313
|
}
|
|
346
|
-
/** Facebook Profile Events — Events from a Facebook profile or page. (40 credits) */
|
|
347
|
-
profileEvents(params) {
|
|
348
|
-
return this.core.get("/v1/facebook/profile-events", params);
|
|
349
|
-
}
|
|
350
|
-
/** Facebook Marketplace Item — Details for a single Facebook Marketplace listing. (17 credits) */
|
|
351
|
-
marketplaceItem(params) {
|
|
352
|
-
return this.core.get("/v1/facebook/marketplace-item", params);
|
|
353
|
-
}
|
|
354
314
|
}
|
|
355
315
|
export class TwitterApi {
|
|
356
316
|
core;
|
|
357
317
|
constructor(core) {
|
|
358
318
|
this.core = core;
|
|
359
319
|
}
|
|
360
|
-
/** Twitter/X Tweet Details —
|
|
320
|
+
/** Twitter/X Tweet Details — One tweet as JSON — text, author (followers), likes/replies/retweets/quotes, media, ISO publishedAt. (1 credit) */
|
|
361
321
|
tweetDetails(params) {
|
|
362
322
|
return this.core.get("/v1/twitter/tweet-details", params);
|
|
363
323
|
}
|
|
364
|
-
/** Twitter/X Transcript —
|
|
324
|
+
/** Twitter/X Transcript — Tweet text as a transcript — timingSource none (not Whisper). Flat 1 credit. (1 credit) */
|
|
365
325
|
transcript(params) {
|
|
366
326
|
return this.core.get("/v1/twitter/transcript", params);
|
|
367
327
|
}
|
|
368
|
-
/** Twitter/X Profile —
|
|
328
|
+
/** Twitter/X Profile — X profile: verified + blue/legacy/identity, displayName, avatar/banner, tipjar→contact{}, expanded website. (1 credit) */
|
|
369
329
|
profile(params) {
|
|
370
330
|
return this.core.get("/v1/twitter/profile", params);
|
|
371
331
|
}
|
|
372
|
-
/** Twitter/X User Tweets —
|
|
332
|
+
/** Twitter/X User Tweets — Most popular public tweets from a Twitter/X profile (~100 cap) — not chronological. Text, author, engagement, hashtags, media. Flat 2 credits. (2 credits) */
|
|
373
333
|
userTweets(params) {
|
|
374
334
|
return this.core.get("/v1/twitter/user-tweets", params);
|
|
375
335
|
}
|
|
376
|
-
/** Twitter/X
|
|
377
|
-
search(params) {
|
|
378
|
-
return this.core.get("/v1/twitter/search", params);
|
|
379
|
-
}
|
|
380
|
-
/** Twitter/X Community — Details for an X (Twitter) community. (1 credit) */
|
|
336
|
+
/** Twitter/X Community — X Community metadata — ISO createdAt, flat creator handle, isNsfw + bannerImage, rules[]. (1 credit) */
|
|
381
337
|
community(params) {
|
|
382
338
|
return this.core.get("/v1/twitter/community", params);
|
|
383
339
|
}
|
|
384
|
-
/** Twitter/X Community Tweets —
|
|
340
|
+
/** Twitter/X Community Tweets — Posts in an X Community — same 6-metric tweet shape as search. Flat 2 credits. (2 credits) */
|
|
385
341
|
communityTweets(params) {
|
|
386
342
|
return this.core.get("/v1/twitter/community-tweets", params);
|
|
387
343
|
}
|
|
@@ -391,31 +347,31 @@ export class RedditApi {
|
|
|
391
347
|
constructor(core) {
|
|
392
348
|
this.core = core;
|
|
393
349
|
}
|
|
394
|
-
/** Reddit Subreddit Posts —
|
|
350
|
+
/** Reddit Subreddit Posts — List posts from a subreddit with sort, timeframe, and cursor pagination — title, score, upvote ratio, flair, and more. (2 credits) */
|
|
395
351
|
subredditPosts(params) {
|
|
396
352
|
return this.core.get("/v1/reddit/subreddit-posts", params);
|
|
397
353
|
}
|
|
398
|
-
/** Reddit Post Details —
|
|
354
|
+
/** Reddit Post Details — Get a Reddit post — title, body, score, comments count, subreddit, and author as structured JSON. (1 credit) */
|
|
399
355
|
postDetails(params) {
|
|
400
356
|
return this.core.get("/v1/reddit/post-details", params);
|
|
401
357
|
}
|
|
402
|
-
/** Reddit Post Comments —
|
|
358
|
+
/** Reddit Post Comments — Flat Reddit comment threads with depth/parentId, cursor pagination, and the parent post in one call. (2 credits) */
|
|
403
359
|
postComments(params) {
|
|
404
360
|
return this.core.get("/v1/reddit/post-comments", params);
|
|
405
361
|
}
|
|
406
|
-
/** Reddit Post Transcript —
|
|
362
|
+
/** Reddit Post Transcript — Written post text — title, body and top comments. Not a speech transcript. Flat 2 credits. (2 credits) */
|
|
407
363
|
postTranscript(params) {
|
|
408
364
|
return this.core.get("/v1/reddit/post-transcript", params);
|
|
409
365
|
}
|
|
410
|
-
/** Reddit Search —
|
|
366
|
+
/** Reddit Search — Reddit site-wide post search — sort + timeframe + cursor, score/upvoteRatio, authorFullname. Flat 2 credits. (2 credits) */
|
|
411
367
|
search(params) {
|
|
412
368
|
return this.core.get("/v1/reddit/search", params);
|
|
413
369
|
}
|
|
414
|
-
/** Reddit Subreddit Details —
|
|
370
|
+
/** Reddit Subreddit Details — Subreddit card — id (t5_…), members, activeUsers, rules[], ISO createdAt, nsfw/type. Flat 1 credit. (1 credit) */
|
|
415
371
|
subredditDetails(params) {
|
|
416
372
|
return this.core.get("/v1/reddit/subreddit-details", params);
|
|
417
373
|
}
|
|
418
|
-
/** Reddit Subreddit Search — Search posts
|
|
374
|
+
/** Reddit Subreddit Post Search — Search posts inside one subreddit — not subreddit discovery. Same sort/timeframe as site-wide Search. Flat 2 credits. (2 credits) */
|
|
419
375
|
subredditSearch(params) {
|
|
420
376
|
return this.core.get("/v1/reddit/subreddit-search", params);
|
|
421
377
|
}
|
|
@@ -425,23 +381,23 @@ export class ThreadsApi {
|
|
|
425
381
|
constructor(core) {
|
|
426
382
|
this.core = core;
|
|
427
383
|
}
|
|
428
|
-
/** Threads Profile —
|
|
384
|
+
/** Threads Profile — Threads profile — displayName, private/isPrivate, bioLinks (Meta verified), isThreadsOnlyUser, transparencyLabel, bioFragments, HD avatars (1 credit). (1 credit) */
|
|
429
385
|
profile(params) {
|
|
430
386
|
return this.core.get("/v1/threads/profile", params);
|
|
431
387
|
}
|
|
432
|
-
/** Threads User Posts — Recent posts
|
|
388
|
+
/** Threads User Posts — Recent Threads posts — engagement{views,likes,replies,reposts,quotes}, threadId/isReply. Flat 2 credits. (2 credits) */
|
|
433
389
|
userPosts(params) {
|
|
434
390
|
return this.core.get("/v1/threads/user-posts", params);
|
|
435
391
|
}
|
|
436
|
-
/** Threads Post Details —
|
|
392
|
+
/** Threads Post Details — Threads post — engagement (views when exposed), comments[], relatedPosts[], threadId/isReply. Flat 1 credit. (1 credit) */
|
|
437
393
|
postDetails(params) {
|
|
438
394
|
return this.core.get("/v1/threads/post-details", params);
|
|
439
395
|
}
|
|
440
|
-
/** Threads Search —
|
|
396
|
+
/** Threads Post Search — Threads keyword search — posts with engagement + media. Flat 2 credits. (2 credits) */
|
|
441
397
|
search(params) {
|
|
442
398
|
return this.core.get("/v1/threads/search", params);
|
|
443
399
|
}
|
|
444
|
-
/** Threads Search Users —
|
|
400
|
+
/** Threads Search Users — Threads user discovery from keyword search — id, handle, avatar, verified. Flat 1 credit. (1 credit) */
|
|
445
401
|
searchUsers(params) {
|
|
446
402
|
return this.core.get("/v1/threads/search-users", params);
|
|
447
403
|
}
|
|
@@ -451,15 +407,15 @@ export class BlueskyApi {
|
|
|
451
407
|
constructor(core) {
|
|
452
408
|
this.core = core;
|
|
453
409
|
}
|
|
454
|
-
/** Bluesky Profile —
|
|
410
|
+
/** Bluesky Profile — Bluesky profile — handle, did, bio, counts, banner, verification{}, labels[], and associated{} (1 credit). (1 credit) */
|
|
455
411
|
profile(params) {
|
|
456
412
|
return this.core.get("/v1/bluesky/profile", params);
|
|
457
413
|
}
|
|
458
|
-
/** Bluesky User Posts —
|
|
414
|
+
/** Bluesky User Posts — Author feed — posts and reposts (isRepost marked), quote/external/images embeds, opaque cursor. (~3 credits (0.1/result)) */
|
|
459
415
|
userPosts(params) {
|
|
460
416
|
return this.core.get("/v1/bluesky/user-posts", params);
|
|
461
417
|
}
|
|
462
|
-
/** Bluesky Post Details —
|
|
418
|
+
/** Bluesky Post Details — Post thread via getPostThread — nested replies[], facet links/mentions/hashtags, rich author (1 credit). (1 credit) */
|
|
463
419
|
postDetails(params) {
|
|
464
420
|
return this.core.get("/v1/bluesky/post-details", params);
|
|
465
421
|
}
|
|
@@ -469,23 +425,23 @@ export class PinterestApi {
|
|
|
469
425
|
constructor(core) {
|
|
470
426
|
this.core = core;
|
|
471
427
|
}
|
|
472
|
-
/** Pinterest Pin Details —
|
|
428
|
+
/** Pinterest Pin Details — Get a Pinterest pin — title, description, link, board, origin creator, and engagement as structured JSON. (1 credit) */
|
|
473
429
|
pinDetails(params) {
|
|
474
430
|
return this.core.get("/v1/pinterest/pin-details", params);
|
|
475
431
|
}
|
|
476
|
-
/** Pinterest User Pins — Pins from a Pinterest profile. (13 credits) */
|
|
432
|
+
/** Pinterest User Pins — Pins from a Pinterest profile — offset cursor, pidgets window ~100. (~13 credits (0.5/result)) */
|
|
477
433
|
userPins(params) {
|
|
478
434
|
return this.core.get("/v1/pinterest/user-pins", params);
|
|
479
435
|
}
|
|
480
|
-
/** Pinterest Search —
|
|
436
|
+
/** Pinterest Search — Keyword pin search — offset cursor, SERP window 40. (~13 credits (0.5/result)) */
|
|
481
437
|
search(params) {
|
|
482
438
|
return this.core.get("/v1/pinterest/search", params);
|
|
483
439
|
}
|
|
484
|
-
/** Pinterest Board —
|
|
440
|
+
/** Pinterest Board — Pins on a Pinterest board — saves, imageOriginal, destinationUrl, top-level author. ~0.5 credits/pin. (~13 credits (0.5/result)) */
|
|
485
441
|
board(params) {
|
|
486
442
|
return this.core.get("/v1/pinterest/board", params);
|
|
487
443
|
}
|
|
488
|
-
/** Pinterest User Boards —
|
|
444
|
+
/** Pinterest User Boards — Boards on a Pinterest profile — pinCount, coverImage (474x), privacy, sections. Board followers when scoped. (~13 credits (0.5/result)) */
|
|
489
445
|
userBoards(params) {
|
|
490
446
|
return this.core.get("/v1/pinterest/user-boards", params);
|
|
491
447
|
}
|
|
@@ -495,27 +451,27 @@ export class LinkedinApi {
|
|
|
495
451
|
constructor(core) {
|
|
496
452
|
this.core = core;
|
|
497
453
|
}
|
|
498
|
-
/** LinkedIn Profile —
|
|
454
|
+
/** LinkedIn Profile — LinkedIn person profile with experience[], education[], similarProfiles[] — masked guest text becomes restricted:true. (2 credits) */
|
|
499
455
|
profile(params) {
|
|
500
456
|
return this.core.get("/v1/linkedin/profile", params);
|
|
501
457
|
}
|
|
502
|
-
/** LinkedIn Company —
|
|
458
|
+
/** LinkedIn Company — Company page for B2B intel — specialties, similarPages, employeeCount, founded, slogan, cover. Native 1 / enrich 2. (2 credits) */
|
|
503
459
|
company(params) {
|
|
504
460
|
return this.core.get("/v1/linkedin/company", params);
|
|
505
461
|
}
|
|
506
|
-
/** LinkedIn Post Details —
|
|
462
|
+
/** LinkedIn Post Details — Get a LinkedIn post — text, author, reactions, and comments count as structured JSON. (1 credit) */
|
|
507
463
|
postDetails(params) {
|
|
508
464
|
return this.core.get("/v1/linkedin/post-details", params);
|
|
509
465
|
}
|
|
510
|
-
/** LinkedIn Post Transcript —
|
|
466
|
+
/** LinkedIn Post Transcript — LinkedIn post text as a transcript — paragraph segments, timingSource none. Flat 1 credit. (1 credit) */
|
|
511
467
|
postTranscript(params) {
|
|
512
468
|
return this.core.get("/v1/linkedin/post-transcript", params);
|
|
513
469
|
}
|
|
514
|
-
/** LinkedIn Company Posts —
|
|
470
|
+
/** LinkedIn Company Posts — Company posts with engagement{likes,comments} — cursor pages up to 100. Flat 1 credit on the native path. (1 credit) */
|
|
515
471
|
companyPosts(params) {
|
|
516
472
|
return this.core.get("/v1/linkedin/company-posts", params);
|
|
517
473
|
}
|
|
518
|
-
/** LinkedIn Search Posts —
|
|
474
|
+
/** LinkedIn Search Posts — Keyword search of public LinkedIn posts — offset cursor, ceiling 50. (~16 credits (0.8/result)) */
|
|
519
475
|
searchPosts(params) {
|
|
520
476
|
return this.core.get("/v1/linkedin/search-posts", params);
|
|
521
477
|
}
|
|
@@ -525,19 +481,23 @@ export class RumbleApi {
|
|
|
525
481
|
constructor(core) {
|
|
526
482
|
this.core = core;
|
|
527
483
|
}
|
|
528
|
-
/** Rumble Video Details —
|
|
484
|
+
/** Rumble Video Details — Rumble video metadata — uniform streams[] with rendition meta, captions[], audioStreams. (1 credit) */
|
|
529
485
|
videoDetails(params) {
|
|
530
486
|
return this.core.get("/v1/rumble/video-details", params);
|
|
531
487
|
}
|
|
532
|
-
/** Rumble
|
|
488
|
+
/** Rumble Video Transcript — Rumble published captions as timed segments — parses the .vtt from video-details (not speech-to-text). (1 credit) */
|
|
489
|
+
videoTranscript(params) {
|
|
490
|
+
return this.core.get("/v1/rumble/video/transcript", params);
|
|
491
|
+
}
|
|
492
|
+
/** Rumble Channel Videos — Rumble channel uploads — lean streams[{url,type}]; call video-details for rendition meta. (~12 credits (0.6/result)) */
|
|
533
493
|
channelVideos(params) {
|
|
534
494
|
return this.core.get("/v1/rumble/channel-videos", params);
|
|
535
495
|
}
|
|
536
|
-
/** Rumble Search —
|
|
496
|
+
/** Rumble Search — Rumble keyword search — same video card shape as channel-videos (type, durationSeconds + durationText, UTC publishedAt). (~12 credits (0.6/result)) */
|
|
537
497
|
search(params) {
|
|
538
498
|
return this.core.get("/v1/rumble/search", params);
|
|
539
499
|
}
|
|
540
|
-
/** Rumble Comments —
|
|
500
|
+
/** Rumble Comments — Rumble top-level comments — publishedAt ISO-8601 UTC from title= on the comment time link. (2 credits) */
|
|
541
501
|
comments(params) {
|
|
542
502
|
return this.core.get("/v1/rumble/comments", params);
|
|
543
503
|
}
|
|
@@ -547,101 +507,213 @@ export class TiktokShopApi {
|
|
|
547
507
|
constructor(core) {
|
|
548
508
|
this.core = core;
|
|
549
509
|
}
|
|
550
|
-
/** TikTok Shop Search —
|
|
510
|
+
/** TikTok Shop Search — TikTok Shop keyword search — priced products with sold, rating/reviews, typed discount, seller id. (2 credits) */
|
|
551
511
|
search(params) {
|
|
552
512
|
return this.core.get("/v1/tiktok-shop/shop-search", params);
|
|
553
513
|
}
|
|
554
|
-
/** TikTok Shop Products —
|
|
514
|
+
/** TikTok Shop Products — Store catalog with shopInfo (sold/followers/rating) + products priced with sold, rating, typed discount. (2 credits) */
|
|
555
515
|
products(params) {
|
|
556
516
|
return this.core.get("/v1/tiktok-shop/shop-products", params);
|
|
557
517
|
}
|
|
558
|
-
/** TikTok Shop Product Details —
|
|
518
|
+
/** TikTok Shop Product Details — PDP — price/originalPrice/typed discount, images[], skus[] with per-variant stock + saleProps, seller id/url, categories (2 credits). (2 credits) */
|
|
559
519
|
productDetails(params) {
|
|
560
520
|
return this.core.get("/v1/tiktok-shop/product-details", params);
|
|
561
521
|
}
|
|
562
|
-
/** TikTok Shop Product Reviews —
|
|
522
|
+
/** TikTok Shop Product Reviews — TikTok Shop product reviews — star rating, text, SKU variant, verified purchase, country, and review photos. (~45 credits (2.25/result)) */
|
|
563
523
|
productReviews(params) {
|
|
564
524
|
return this.core.get("/v1/tiktok-shop/product-reviews", params);
|
|
565
525
|
}
|
|
566
|
-
/** TikTok Shop User Showcase —
|
|
526
|
+
/** TikTok Shop User Showcase — Creator Shop showcase — affiliate shelf products with per-product sold, rating, typed discount, and seller name/url. (~45 credits (2.25/result)) */
|
|
567
527
|
userShowcase(params) {
|
|
568
528
|
return this.core.get("/v1/tiktok-shop/user-showcase", params);
|
|
569
529
|
}
|
|
570
530
|
}
|
|
531
|
+
export class FacebookMarketplaceApi {
|
|
532
|
+
core;
|
|
533
|
+
constructor(core) {
|
|
534
|
+
this.core = core;
|
|
535
|
+
}
|
|
536
|
+
/** Facebook Marketplace Search — Search Marketplace by keyword + city — filters, isLocal/shipsOutsideRadius, opaque cursor (2 credits). (2 credits) */
|
|
537
|
+
search(params) {
|
|
538
|
+
return this.core.get("/v1/facebook/marketplace-search", params);
|
|
539
|
+
}
|
|
540
|
+
/** Facebook Marketplace Location Search — Disambiguate city names into Marketplace hubs — id + lat/lng. Flat 2 credits. (2 credits) */
|
|
541
|
+
locationSearch(params) {
|
|
542
|
+
return this.core.get("/v1/facebook/marketplace-location-search", params);
|
|
543
|
+
}
|
|
544
|
+
/** Facebook Marketplace Item — Marketplace listing — title, priceAmount, status, seller{}, condition, coords (2 credits). (2 credits) */
|
|
545
|
+
item(params) {
|
|
546
|
+
return this.core.get("/v1/facebook/marketplace-item", params);
|
|
547
|
+
}
|
|
548
|
+
}
|
|
549
|
+
export class FacebookEventsApi {
|
|
550
|
+
core;
|
|
551
|
+
constructor(core) {
|
|
552
|
+
this.core = core;
|
|
553
|
+
}
|
|
554
|
+
/** Facebook Event Search — Search Facebook events by topic and city — local startDate/timezone, venue. 2 credits. (2 credits) */
|
|
555
|
+
facebookEventSearch(params) {
|
|
556
|
+
return this.core.get("/v1/facebook/event-search", params);
|
|
557
|
+
}
|
|
558
|
+
/** Facebook Event Details — Get a Facebook event — title, local start/end, timezone, place, host id, and attendance when exposed. (2 credits) */
|
|
559
|
+
facebookEventDetails(params) {
|
|
560
|
+
return this.core.get("/v1/facebook/event-details", params);
|
|
561
|
+
}
|
|
562
|
+
/** Facebook Profile Events — List a Facebook Page's events — local startDate, timezone, venue. 2 credits. (2 credits) */
|
|
563
|
+
facebookProfileEvents(params) {
|
|
564
|
+
return this.core.get("/v1/facebook/profile-events", params);
|
|
565
|
+
}
|
|
566
|
+
}
|
|
567
|
+
export class FacebookAdLibraryApi {
|
|
568
|
+
core;
|
|
569
|
+
constructor(core) {
|
|
570
|
+
this.core = core;
|
|
571
|
+
}
|
|
572
|
+
/** Facebook Ad Library Search — Search Meta Ad Library by keyword — active/inactive, media type, date range, platforms, cursor, and spend/impressions when Meta publishes them. (2 credits) */
|
|
573
|
+
search(params) {
|
|
574
|
+
return this.core.get("/v1/ad-library/facebook/search", params);
|
|
575
|
+
}
|
|
576
|
+
/** Facebook Company Ads — Company Ads (2 credits) */
|
|
577
|
+
companyAds(params) {
|
|
578
|
+
return this.core.get("/v1/ad-library/facebook/company-ads", params);
|
|
579
|
+
}
|
|
580
|
+
/** Facebook Ad Library Search Companies — Find Meta Ad Library pages by brand — name-matched, pageId for company-ads (not profileId). (2 credits) */
|
|
581
|
+
searchCompanies(params) {
|
|
582
|
+
return this.core.get("/v1/ad-library/facebook/search-companies", params);
|
|
583
|
+
}
|
|
584
|
+
/** Facebook Ad Details — One Meta ad by ID — same creative as search, plus delivery breakdowns when Meta publishes them. Flat 2 credits. (2 credits) */
|
|
585
|
+
adDetails(params) {
|
|
586
|
+
return this.core.get("/v1/ad-library/facebook/ad-details", params);
|
|
587
|
+
}
|
|
588
|
+
/** Facebook Ad Copy — Written creative copy from a Meta ad — headline, body, CTA, landing URL. Not a speech transcript. (2 credits) */
|
|
589
|
+
adTranscript(params) {
|
|
590
|
+
return this.core.get("/v1/ad-library/facebook/ad-transcript", params);
|
|
591
|
+
}
|
|
592
|
+
}
|
|
593
|
+
export class TiktokAdLibraryApi {
|
|
594
|
+
core;
|
|
595
|
+
constructor(core) {
|
|
596
|
+
this.core = core;
|
|
597
|
+
}
|
|
598
|
+
/** TikTok Ad Library Search — Search TikTok Commercial Content Library — relevance-filtered, uniform null schema (2 credits). (2 credits) */
|
|
599
|
+
search(params) {
|
|
600
|
+
return this.core.get("/v1/ad-library/tiktok/search", params);
|
|
601
|
+
}
|
|
602
|
+
/** TikTok Creative Center Top Ads — TikTok Creative Center Top Ads — one ~20-row leaderboard page, not a library search (flat 2 / ~1 Apify). (2 credits) */
|
|
603
|
+
topAds(params = {}) {
|
|
604
|
+
return this.core.get("/v1/ad-library/tiktok/top-ads", params);
|
|
605
|
+
}
|
|
606
|
+
/** TikTok Ad Details — One TikTok Commercial Content Library ad by ID — calendar-day dates, always 2 credits. (2 credits) */
|
|
607
|
+
adDetails(params) {
|
|
608
|
+
return this.core.get("/v1/ad-library/tiktok/ad-details", params);
|
|
609
|
+
}
|
|
610
|
+
}
|
|
611
|
+
export class GoogleAdLibraryApi {
|
|
612
|
+
core;
|
|
613
|
+
constructor(core) {
|
|
614
|
+
this.core = core;
|
|
615
|
+
}
|
|
616
|
+
/** Google Company Ads — Google publishes spend and impression ranges only for election ads; commercial advertisers omit both. isActive is true when lastShown is within 7 UTC days. (2 credits) */
|
|
617
|
+
companyAds(params) {
|
|
618
|
+
return this.core.get("/v1/ad-library/google/company-ads", params);
|
|
619
|
+
}
|
|
620
|
+
/** Google Ad Details — Google publishes spend and impression ranges only for election ads; commercial advertisers omit both. isActive is true when lastShown is within 7 UTC days. (2 credits) */
|
|
621
|
+
adDetails(params) {
|
|
622
|
+
return this.core.get("/v1/ad-library/google/ad-details", params);
|
|
623
|
+
}
|
|
624
|
+
/** Google Advertiser Search — Find Google Ads Transparency AR… entities — ranked multi-result (1 credit when found; empty is free). (1 credit) */
|
|
625
|
+
advertiserSearch(params) {
|
|
626
|
+
return this.core.get("/v1/ad-library/google/advertiser-search", params);
|
|
627
|
+
}
|
|
628
|
+
}
|
|
629
|
+
export class LinkedinAdLibraryApi {
|
|
630
|
+
core;
|
|
631
|
+
constructor(core) {
|
|
632
|
+
this.core = core;
|
|
633
|
+
}
|
|
634
|
+
/** LinkedIn Ad Library Search — LinkedIn publishes run dates, impressions and targeting only on a subset of creatives. Search is the SERP card; source is native|extended. (2 credits) */
|
|
635
|
+
searchAds(params = {}) {
|
|
636
|
+
return this.core.get("/v1/ad-library/linkedin/search-ads", params);
|
|
637
|
+
}
|
|
638
|
+
/** LinkedIn Ad Details — One LinkedIn Ad Library ad by ID. LinkedIn withholds Ran-from / impressions / targeting on most creatives — those keys are omitted, not 404. (2 credits) */
|
|
639
|
+
adDetails(params) {
|
|
640
|
+
return this.core.get("/v1/ad-library/linkedin/ad-details", params);
|
|
641
|
+
}
|
|
642
|
+
}
|
|
643
|
+
export class AmazonShopApi {
|
|
644
|
+
core;
|
|
645
|
+
constructor(core) {
|
|
646
|
+
this.core = core;
|
|
647
|
+
}
|
|
648
|
+
/** Amazon Seller Storefront — Third-party seller storefronts (/sp?seller= / /s?me=) — ASIN + canonical /dp URLs, price, badges. Not influencer /shop/{handle}. (1 credit) */
|
|
649
|
+
page(params) {
|
|
650
|
+
return this.core.get("/v1/amazon-shop/page", params);
|
|
651
|
+
}
|
|
652
|
+
}
|
|
571
653
|
export class GithubApi {
|
|
572
654
|
core;
|
|
573
655
|
constructor(core) {
|
|
574
656
|
this.core = core;
|
|
575
657
|
}
|
|
576
|
-
/** GitHub User —
|
|
658
|
+
/** GitHub User — GitHub public profile — login, type User|Organization, email when public, followers (1 credit). (1 credit) */
|
|
577
659
|
user(params) {
|
|
578
660
|
return this.core.get("/v1/github/user", params);
|
|
579
661
|
}
|
|
580
|
-
/** GitHub Repositories — List a
|
|
662
|
+
/** GitHub Repositories — List a user's repos with sort/direction/type — opaque Link cursor (~0.4/repo). (~12 credits (0.4/result)) */
|
|
581
663
|
repositories(params) {
|
|
582
664
|
return this.core.get("/v1/github/repositories", params);
|
|
583
665
|
}
|
|
584
|
-
/** GitHub
|
|
585
|
-
repository(params) {
|
|
586
|
-
return this.core.get("/v1/github/repository", params);
|
|
587
|
-
}
|
|
588
|
-
/** GitHub Pull Requests — List repository pull requests. (12 credits) */
|
|
666
|
+
/** GitHub Pull Requests — List repo PRs — draft, labels, author{}, head/base, opaque Link cursor (state echoed). (~12 credits (0.4/result)) */
|
|
589
667
|
pullRequests(params) {
|
|
590
668
|
return this.core.get("/v1/github/pull-requests", params);
|
|
591
669
|
}
|
|
592
|
-
/** GitHub Activity —
|
|
670
|
+
/** GitHub Activity — Public events with typed payload (Push commits/ref, PR/issue action) — 90-event ceiling. (~12 credits (0.4/result)) */
|
|
593
671
|
activity(params) {
|
|
594
672
|
return this.core.get("/v1/github/activity", params);
|
|
595
673
|
}
|
|
596
|
-
/** GitHub Followers —
|
|
674
|
+
/** GitHub Followers — Follower cards {id, login, type, url, avatar} — ~0.1/row; large accounts are expensive to page fully. (~3 credits (0.1/result)) */
|
|
597
675
|
followers(params) {
|
|
598
676
|
return this.core.get("/v1/github/followers", params);
|
|
599
677
|
}
|
|
600
|
-
/** GitHub Following —
|
|
678
|
+
/** GitHub Following — Accounts a user follows — same card and ~0.1/row pricing as followers. (~3 credits (0.1/result)) */
|
|
601
679
|
following(params) {
|
|
602
680
|
return this.core.get("/v1/github/following", params);
|
|
603
681
|
}
|
|
604
|
-
/** GitHub Contributions —
|
|
682
|
+
/** GitHub Contributions — GitHub contribution graph — sorted days[], currentStreak (today grace), longestStreak (2 credits). (2 credits) */
|
|
605
683
|
contributions(params) {
|
|
606
684
|
return this.core.get("/v1/github/contributions", params);
|
|
607
685
|
}
|
|
608
|
-
/** GitHub
|
|
609
|
-
|
|
686
|
+
/** GitHub Repository — GitHub repo — stars, real watchers (subscribers), openIssuesAndPrs, license, parent when fork (1 credit). (1 credit) */
|
|
687
|
+
repository(params) {
|
|
688
|
+
return this.core.get("/v1/github/repository", params);
|
|
689
|
+
}
|
|
690
|
+
/** GitHub Trending Repositories — github.com/trending — repos ranked by starsGained (daily|weekly|monthly), not all-time stars (2 credits). (2 credits) */
|
|
691
|
+
trendingRepositories(params = {}) {
|
|
610
692
|
return this.core.get("/v1/github/trending-repositories", params);
|
|
611
693
|
}
|
|
612
|
-
/** GitHub Trending Developers —
|
|
613
|
-
trendingDevelopers(params) {
|
|
694
|
+
/** GitHub Trending Developers — github.com/trending/developers — windowed ranks with popularRepo + followers (2 credits). (2 credits) */
|
|
695
|
+
trendingDevelopers(params = {}) {
|
|
614
696
|
return this.core.get("/v1/github/trending-developers", params);
|
|
615
697
|
}
|
|
616
698
|
}
|
|
617
|
-
export class GoogleApi {
|
|
618
|
-
core;
|
|
619
|
-
constructor(core) {
|
|
620
|
-
this.core = core;
|
|
621
|
-
}
|
|
622
|
-
/** Google Search — Google SERP organic search results by keyword, country, and language. (42 credits) */
|
|
623
|
-
search(params) {
|
|
624
|
-
return this.core.get("/v1/google/search", params);
|
|
625
|
-
}
|
|
626
|
-
}
|
|
627
699
|
export class TwitchApi {
|
|
628
700
|
core;
|
|
629
701
|
constructor(core) {
|
|
630
702
|
this.core = core;
|
|
631
703
|
}
|
|
632
|
-
/** Twitch Profile — Twitch channel
|
|
704
|
+
/** Twitch Profile — Twitch channel — handle + displayName, socials[], topClips, schedule preview, stream only when live (1 credit). (1 credit) */
|
|
633
705
|
profile(params) {
|
|
634
706
|
return this.core.get("/v1/twitch/profile", params);
|
|
635
707
|
}
|
|
636
|
-
/** Twitch User Videos —
|
|
708
|
+
/** Twitch User Videos — Twitch channel VODs — lean rows, video-id cursor, filter/sort, top-level broadcaster{} (flat 2). (2 credits) */
|
|
637
709
|
userVideos(params) {
|
|
638
710
|
return this.core.get("/v1/twitch/user-videos", params);
|
|
639
711
|
}
|
|
640
|
-
/** Twitch User Schedule —
|
|
712
|
+
/** Twitch User Schedule — Twitch channel schedule — startAt/endAt, title, game, isRecurring (0 credits when empty). (1 credit) */
|
|
641
713
|
userSchedule(params) {
|
|
642
714
|
return this.core.get("/v1/twitch/user-schedule", params);
|
|
643
715
|
}
|
|
644
|
-
/** Twitch Clip — Twitch clip
|
|
716
|
+
/** Twitch Clip — Twitch clip — curator vs channel, signedVideoUrl, unwrapped token, relatedClips (1 credit). (1 credit) */
|
|
645
717
|
clip(params) {
|
|
646
718
|
return this.core.get("/v1/twitch/clip", params);
|
|
647
719
|
}
|
|
@@ -651,27 +723,27 @@ export class SpotifyApi {
|
|
|
651
723
|
constructor(core) {
|
|
652
724
|
this.core = core;
|
|
653
725
|
}
|
|
654
|
-
/** Spotify Artist — Spotify artist
|
|
726
|
+
/** Spotify Artist — Spotify artist — followers, monthlyListeners, worldRank, topCities, topTracks with playCount, concerts, and related artists (1 credit). (1 credit) */
|
|
655
727
|
artist(params) {
|
|
656
728
|
return this.core.get("/v1/spotify/artist", params);
|
|
657
729
|
}
|
|
658
|
-
/** Spotify Track — Spotify track
|
|
730
|
+
/** Spotify Track — Spotify track — playCount, joinable artists[]/album{}, explicit, releaseDate (1 credit). (1 credit) */
|
|
659
731
|
track(params) {
|
|
660
732
|
return this.core.get("/v1/spotify/track", params);
|
|
661
733
|
}
|
|
662
|
-
/** Spotify Album — Spotify album
|
|
734
|
+
/** Spotify Album — Spotify album — tracks[] with playCount, joinable artists[], releaseDate, explicit (1 credit). (1 credit) */
|
|
663
735
|
album(params) {
|
|
664
736
|
return this.core.get("/v1/spotify/album", params);
|
|
665
737
|
}
|
|
666
|
-
/** Spotify Search — Search Spotify
|
|
738
|
+
/** Spotify Search — Search Spotify — canonical spotify: URIs, explicit, fetchedAt (flat 2 credits). (2 credits) */
|
|
667
739
|
search(params) {
|
|
668
740
|
return this.core.get("/v1/spotify/search", params);
|
|
669
741
|
}
|
|
670
|
-
/** Spotify Podcast — Spotify podcast
|
|
742
|
+
/** Spotify Podcast — Spotify podcast show — publisher, rating, topics, explicit flag, and totalEpisodes as clean JSON. (1 credit) */
|
|
671
743
|
podcast(params) {
|
|
672
744
|
return this.core.get("/v1/spotify/podcast", params);
|
|
673
745
|
}
|
|
674
|
-
/** Spotify Podcast Episodes —
|
|
746
|
+
/** Spotify Podcast Episodes — Podcast episode archive — previewUrl, releaseDate, explicit, cursor pagination (flat 2 credits). (2 credits) */
|
|
675
747
|
podcastEpisodes(params) {
|
|
676
748
|
return this.core.get("/v1/spotify/podcast-episodes", params);
|
|
677
749
|
}
|
|
@@ -681,15 +753,15 @@ export class SoundcloudApi {
|
|
|
681
753
|
constructor(core) {
|
|
682
754
|
this.core = core;
|
|
683
755
|
}
|
|
684
|
-
/** SoundCloud Artist — SoundCloud artist
|
|
756
|
+
/** SoundCloud Artist — SoundCloud artist — handle + name, subscriptionTier, externalLinks, verified (1 credit). (1 credit) */
|
|
685
757
|
artist(params) {
|
|
686
758
|
return this.core.get("/v1/soundcloud/artist", params);
|
|
687
759
|
}
|
|
688
|
-
/** SoundCloud Artist Tracks —
|
|
760
|
+
/** SoundCloud Artist Tracks — Artist track list — opaque cursor, native-window when the api-v2 page ends (2 credits; empty is 0). (2 credits) */
|
|
689
761
|
artistTracks(params) {
|
|
690
762
|
return this.core.get("/v1/soundcloud/artist-tracks", params);
|
|
691
763
|
}
|
|
692
|
-
/** SoundCloud Track — SoundCloud track
|
|
764
|
+
/** SoundCloud Track — SoundCloud track — plays/likes/license, tags[], nested artist{}, streamUrl when streamable (1 credit). (1 credit) */
|
|
693
765
|
track(params) {
|
|
694
766
|
return this.core.get("/v1/soundcloud/track", params);
|
|
695
767
|
}
|
|
@@ -699,7 +771,7 @@ export class LinktreeApi {
|
|
|
699
771
|
constructor(core) {
|
|
700
772
|
this.core = core;
|
|
701
773
|
}
|
|
702
|
-
/** Linktree Page —
|
|
774
|
+
/** Linktree Page — Link-in-bio → creator graph: typed links, socialAccounts{} that feed TikTok/Instagram/Spotify/SoundCloud, email, verticals. Flat 1 credit. (1 credit) */
|
|
703
775
|
page(params) {
|
|
704
776
|
return this.core.get("/v1/linktree/page", params);
|
|
705
777
|
}
|
|
@@ -709,7 +781,7 @@ export class SnapchatApi {
|
|
|
709
781
|
constructor(core) {
|
|
710
782
|
this.core = core;
|
|
711
783
|
}
|
|
712
|
-
/** Snapchat User Profile —
|
|
784
|
+
/** Snapchat User Profile — Snapchat profile — unwrapped highlight ids, mediaType image/video, category labels, Spotlight boosts (1 credit). (1 credit) */
|
|
713
785
|
userProfile(params) {
|
|
714
786
|
return this.core.get("/v1/snapchat/user-profile", params);
|
|
715
787
|
}
|
|
@@ -719,15 +791,15 @@ export class TruthSocialApi {
|
|
|
719
791
|
constructor(core) {
|
|
720
792
|
this.core = core;
|
|
721
793
|
}
|
|
722
|
-
/** Truth Social Profile —
|
|
794
|
+
/** Truth Social Profile — Prominent public Truth Social profiles — isPrivate/bot/group, fields[], avatar/banner. Flat 1 credit. (1 credit) */
|
|
723
795
|
profile(params) {
|
|
724
796
|
return this.core.get("/v1/truth-social/profile", params);
|
|
725
797
|
}
|
|
726
|
-
/** Truth Social User Posts — Recent
|
|
798
|
+
/** Truth Social User Posts — Recent Truths — same post mapper as /post (links, card, reblog/quote, mentions). 2 credits. (2 credits) */
|
|
727
799
|
userPosts(params) {
|
|
728
800
|
return this.core.get("/v1/truth-social/user-posts", params);
|
|
729
801
|
}
|
|
730
|
-
/** Truth Social Post — Truth
|
|
802
|
+
/** Truth Social Post — One Truth — text, links[], card, reblog/quote chain, media.meta, externalVideoId. Flat 1 credit. (1 credit) */
|
|
731
803
|
post(params) {
|
|
732
804
|
return this.core.get("/v1/truth-social/post", params);
|
|
733
805
|
}
|
|
@@ -737,67 +809,69 @@ export class KickApi {
|
|
|
737
809
|
constructor(core) {
|
|
738
810
|
this.core = core;
|
|
739
811
|
}
|
|
740
|
-
/** Kick Clip — Kick clip
|
|
812
|
+
/** Kick Clip — Get a Kick clip — creator vs channel, HLS playback, VOD deep-link, views, and duration as structured JSON. (1 credit) */
|
|
741
813
|
clip(params) {
|
|
742
814
|
return this.core.get("/v1/kick/clip", params);
|
|
743
815
|
}
|
|
744
816
|
}
|
|
745
|
-
export class AmazonShopApi {
|
|
746
|
-
core;
|
|
747
|
-
constructor(core) {
|
|
748
|
-
this.core = core;
|
|
749
|
-
}
|
|
750
|
-
/** Amazon Shop Page — Amazon seller storefront metadata and product listings. (89 credits) */
|
|
751
|
-
page(params) {
|
|
752
|
-
return this.core.get("/v1/amazon-shop/page", params);
|
|
753
|
-
}
|
|
754
|
-
}
|
|
755
|
-
export class AgeGenderApi {
|
|
756
|
-
core;
|
|
757
|
-
constructor(core) {
|
|
758
|
-
this.core = core;
|
|
759
|
-
}
|
|
760
|
-
/** Age and Gender — Predict age, gender and nationality signals from first names. (4 credits) */
|
|
761
|
-
get(params) {
|
|
762
|
-
return this.core.get("/v1/age-gender", params);
|
|
763
|
-
}
|
|
764
|
-
}
|
|
765
817
|
export class AccountApi {
|
|
766
818
|
core;
|
|
767
819
|
constructor(core) {
|
|
768
820
|
this.core = core;
|
|
769
821
|
}
|
|
770
|
-
/** Credit Balance —
|
|
822
|
+
/** Credit Balance — Plan, subscription vs top-up credits, monthly quota, and renewsAt — 0 credits. (0 credits) */
|
|
771
823
|
balance(params = {}) {
|
|
772
824
|
return this.core.get("/v1/account/balance", params);
|
|
773
825
|
}
|
|
774
|
-
/** Request History —
|
|
826
|
+
/** Request History — Recent API requests for your key — requestId, status, credits, cacheHit (0 credits). (0 credits) */
|
|
775
827
|
requestHistory(params = {}) {
|
|
776
828
|
return this.core.get("/v1/account/request-history", params);
|
|
777
829
|
}
|
|
778
|
-
/** Daily Usage —
|
|
830
|
+
/** Daily Usage — Day-by-day credit usage for spend monitoring (0 credits). (0 credits) */
|
|
779
831
|
dailyUsage(params = {}) {
|
|
780
832
|
return this.core.get("/v1/account/daily-usage", params);
|
|
781
833
|
}
|
|
782
|
-
/** Most Used Routes —
|
|
834
|
+
/** Most Used Routes — Ranked list of which Captapi routes your key calls most (0 credits). (0 credits) */
|
|
783
835
|
mostUsedRoutes(params = {}) {
|
|
784
836
|
return this.core.get("/v1/account/most-used-routes", params);
|
|
785
837
|
}
|
|
786
838
|
}
|
|
839
|
+
export class UtilitiesApi {
|
|
840
|
+
core;
|
|
841
|
+
constructor(core) {
|
|
842
|
+
this.core = core;
|
|
843
|
+
}
|
|
844
|
+
/** Post Analytics — Unified metrics for one post, video, or reel — platform auto-detected (1 credit). (1 credit) */
|
|
845
|
+
analyticsPost(params) {
|
|
846
|
+
return this.core.get("/v1/analytics/post", params);
|
|
847
|
+
}
|
|
848
|
+
/** Compare Analytics — Compare unified metrics across up to 10 URLs — each row is the analytics/post object (1 credit/resolved URL). (1 credit/url) */
|
|
849
|
+
analyticsCompare(params) {
|
|
850
|
+
return this.core.get("/v1/analytics/compare", params);
|
|
851
|
+
}
|
|
852
|
+
/** Video File Transcript — Whisper transcription of an uploaded file — 1 credit/min; noSpeech=true and 0 credits when there is no speech. (1 credit/min) */
|
|
853
|
+
videoTranscript(params) {
|
|
854
|
+
return this.core.postMultipart("/v1/video/transcript", params);
|
|
855
|
+
}
|
|
856
|
+
/** Video File Summarizer — Whisper + AI summary of an uploaded file — transcript included; 1 credit/min + 1. (1 credit/min +1) */
|
|
857
|
+
videoSummarize(params) {
|
|
858
|
+
return this.core.postMultipart("/v1/video/summarize", params);
|
|
859
|
+
}
|
|
860
|
+
}
|
|
787
861
|
export class KwaiApi {
|
|
788
862
|
core;
|
|
789
863
|
constructor(core) {
|
|
790
864
|
this.core = core;
|
|
791
865
|
}
|
|
792
|
-
/** Kwai Profile — Kwai
|
|
866
|
+
/** Kwai Profile — Fetch Kwai profile — display name, bio, counts, and verification as structured JSON. (1 credit) */
|
|
793
867
|
profile(params) {
|
|
794
868
|
return this.core.get("/v1/kwai/profile", params);
|
|
795
869
|
}
|
|
796
|
-
/** Kwai User Posts —
|
|
870
|
+
/** Kwai User Posts — Kwai profile posts — caption ("" when none), engagement, mp4 + transcript (~1 credit/post). (~20 credits (1/result)) */
|
|
797
871
|
userPosts(params) {
|
|
798
872
|
return this.core.get("/v1/kwai/user-posts", params);
|
|
799
873
|
}
|
|
800
|
-
/** Kwai Post — Kwai
|
|
874
|
+
/** Kwai Post — Single Kwai video — caption ("" when none), hashtags[], author, mp4 (2 credits). (2 credits) */
|
|
801
875
|
post(params) {
|
|
802
876
|
return this.core.get("/v1/kwai/post", params);
|
|
803
877
|
}
|
|
@@ -807,7 +881,7 @@ export class KomiApi {
|
|
|
807
881
|
constructor(core) {
|
|
808
882
|
this.core = core;
|
|
809
883
|
}
|
|
810
|
-
/** Komi Page —
|
|
884
|
+
/** Komi Page — Komi link-in-bio → identity, socials{} (incl. website), content LINK/PRODUCT rows with price/currency. Flat 1 credit. (1 credit) */
|
|
811
885
|
page(params) {
|
|
812
886
|
return this.core.get("/v1/komi/page", params);
|
|
813
887
|
}
|
|
@@ -817,7 +891,7 @@ export class PillarApi {
|
|
|
817
891
|
constructor(core) {
|
|
818
892
|
this.core = core;
|
|
819
893
|
}
|
|
820
|
-
/** Pillar Page —
|
|
894
|
+
/** Pillar Page — Pillar link-in-bio → identity, socials{}, links[] with per-link clicks, products[]. Flat 1 credit. (1 credit) */
|
|
821
895
|
page(params) {
|
|
822
896
|
return this.core.get("/v1/pillar/page", params);
|
|
823
897
|
}
|
|
@@ -827,7 +901,7 @@ export class LinkbioApi {
|
|
|
827
901
|
constructor(core) {
|
|
828
902
|
this.core = core;
|
|
829
903
|
}
|
|
830
|
-
/** Linkbio Page —
|
|
904
|
+
/** Linkbio Page — lnk.bio → id, socials{}, titled links[], website/email/whatsapp, other[]. Flat 1 credit. (1 credit) */
|
|
831
905
|
page(params) {
|
|
832
906
|
return this.core.get("/v1/linkbio/page", params);
|
|
833
907
|
}
|
|
@@ -837,65 +911,11 @@ export class LinkmeApi {
|
|
|
837
911
|
constructor(core) {
|
|
838
912
|
this.core = core;
|
|
839
913
|
}
|
|
840
|
-
/** Linkme Profile —
|
|
914
|
+
/** Linkme Profile — Linkme profile → bio, profileVisitCount, featured links, webLinks, email/infoLinks, stripeStatus. Flat 1 credit. (1 credit) */
|
|
841
915
|
profile(params) {
|
|
842
916
|
return this.core.get("/v1/linkme/profile", params);
|
|
843
917
|
}
|
|
844
918
|
}
|
|
845
|
-
export class AdLibraryApi {
|
|
846
|
-
core;
|
|
847
|
-
constructor(core) {
|
|
848
|
-
this.core = core;
|
|
849
|
-
}
|
|
850
|
-
/** Facebook Ad Library Search — Search Meta/Facebook ads by keyword. (70 credits) */
|
|
851
|
-
facebookSearch(params) {
|
|
852
|
-
return this.core.get("/v1/ad-library/facebook/search", params);
|
|
853
|
-
}
|
|
854
|
-
/** Facebook Company Ads — Ads for a Facebook page or Meta Ad Library URL. (70 credits) */
|
|
855
|
-
facebookCompanyAds(params) {
|
|
856
|
-
return this.core.get("/v1/ad-library/facebook/company-ads", params);
|
|
857
|
-
}
|
|
858
|
-
/** Facebook Ad Library Search Companies — Find advertisers/pages in the Meta Ad Library by name. (70 credits) */
|
|
859
|
-
facebookSearchCompanies(params) {
|
|
860
|
-
return this.core.get("/v1/ad-library/facebook/search-companies", params);
|
|
861
|
-
}
|
|
862
|
-
/** Facebook Ad Details — Meta/Facebook ad details. (17 credits) */
|
|
863
|
-
facebookAdDetails(params) {
|
|
864
|
-
return this.core.get("/v1/ad-library/facebook/ad-details", params);
|
|
865
|
-
}
|
|
866
|
-
/** Facebook Ad Transcript — Extract creative text from a Meta/Facebook ad as transcript text. (17 credits) */
|
|
867
|
-
facebookAdTranscript(params) {
|
|
868
|
-
return this.core.get("/v1/ad-library/facebook/ad-transcript", params);
|
|
869
|
-
}
|
|
870
|
-
/** TikTok Ad Library Search — Search TikTok Ad Library and Creative Center. (70 credits) */
|
|
871
|
-
tiktokSearch(params) {
|
|
872
|
-
return this.core.get("/v1/ad-library/tiktok/search", params);
|
|
873
|
-
}
|
|
874
|
-
/** TikTok Ad Details — TikTok ad details by ad URL or ID. (17 credits) */
|
|
875
|
-
tiktokAdDetails(params) {
|
|
876
|
-
return this.core.get("/v1/ad-library/tiktok/ad-details", params);
|
|
877
|
-
}
|
|
878
|
-
/** Google Company Ads — Google Ads Transparency Center ads for an advertiser. (67 credits) */
|
|
879
|
-
googleCompanyAds(params) {
|
|
880
|
-
return this.core.get("/v1/ad-library/google/company-ads", params);
|
|
881
|
-
}
|
|
882
|
-
/** Google Ad Details — Google ad details by Transparency Center URL. (17 credits) */
|
|
883
|
-
googleAdDetails(params) {
|
|
884
|
-
return this.core.get("/v1/ad-library/google/ad-details", params);
|
|
885
|
-
}
|
|
886
|
-
/** Google Advertiser Search — Search Google Ads advertisers. (45 credits) */
|
|
887
|
-
googleAdvertiserSearch(params) {
|
|
888
|
-
return this.core.get("/v1/ad-library/google/advertiser-search", params);
|
|
889
|
-
}
|
|
890
|
-
/** LinkedIn Ad Library Search — Search LinkedIn Ad Library ads. (70 credits) */
|
|
891
|
-
linkedinSearchAds(params) {
|
|
892
|
-
return this.core.get("/v1/ad-library/linkedin/search-ads", params);
|
|
893
|
-
}
|
|
894
|
-
/** LinkedIn Ad Details — LinkedIn ad details by URL or ID. (17 credits) */
|
|
895
|
-
linkedinAdDetails(params) {
|
|
896
|
-
return this.core.get("/v1/ad-library/linkedin/ad-details", params);
|
|
897
|
-
}
|
|
898
|
-
}
|
|
899
919
|
/** Captapi API client. Get your key at https://captapi.com/dashboard/api-keys */
|
|
900
920
|
export class Captapi {
|
|
901
921
|
youtube;
|
|
@@ -910,8 +930,14 @@ export class Captapi {
|
|
|
910
930
|
linkedin;
|
|
911
931
|
rumble;
|
|
912
932
|
tiktokShop;
|
|
933
|
+
facebookMarketplace;
|
|
934
|
+
facebookEvents;
|
|
935
|
+
facebookAdLibrary;
|
|
936
|
+
tiktokAdLibrary;
|
|
937
|
+
googleAdLibrary;
|
|
938
|
+
linkedinAdLibrary;
|
|
939
|
+
amazonShop;
|
|
913
940
|
github;
|
|
914
|
-
google;
|
|
915
941
|
twitch;
|
|
916
942
|
spotify;
|
|
917
943
|
soundcloud;
|
|
@@ -919,15 +945,13 @@ export class Captapi {
|
|
|
919
945
|
snapchat;
|
|
920
946
|
truthSocial;
|
|
921
947
|
kick;
|
|
922
|
-
amazonShop;
|
|
923
|
-
ageGender;
|
|
924
948
|
account;
|
|
949
|
+
utilities;
|
|
925
950
|
kwai;
|
|
926
951
|
komi;
|
|
927
952
|
pillar;
|
|
928
953
|
linkbio;
|
|
929
954
|
linkme;
|
|
930
|
-
adLibrary;
|
|
931
955
|
constructor(options = {}) {
|
|
932
956
|
const core = new HttpCore(options);
|
|
933
957
|
this.youtube = new YoutubeApi(core);
|
|
@@ -942,8 +966,14 @@ export class Captapi {
|
|
|
942
966
|
this.linkedin = new LinkedinApi(core);
|
|
943
967
|
this.rumble = new RumbleApi(core);
|
|
944
968
|
this.tiktokShop = new TiktokShopApi(core);
|
|
969
|
+
this.facebookMarketplace = new FacebookMarketplaceApi(core);
|
|
970
|
+
this.facebookEvents = new FacebookEventsApi(core);
|
|
971
|
+
this.facebookAdLibrary = new FacebookAdLibraryApi(core);
|
|
972
|
+
this.tiktokAdLibrary = new TiktokAdLibraryApi(core);
|
|
973
|
+
this.googleAdLibrary = new GoogleAdLibraryApi(core);
|
|
974
|
+
this.linkedinAdLibrary = new LinkedinAdLibraryApi(core);
|
|
975
|
+
this.amazonShop = new AmazonShopApi(core);
|
|
945
976
|
this.github = new GithubApi(core);
|
|
946
|
-
this.google = new GoogleApi(core);
|
|
947
977
|
this.twitch = new TwitchApi(core);
|
|
948
978
|
this.spotify = new SpotifyApi(core);
|
|
949
979
|
this.soundcloud = new SoundcloudApi(core);
|
|
@@ -951,14 +981,12 @@ export class Captapi {
|
|
|
951
981
|
this.snapchat = new SnapchatApi(core);
|
|
952
982
|
this.truthSocial = new TruthSocialApi(core);
|
|
953
983
|
this.kick = new KickApi(core);
|
|
954
|
-
this.amazonShop = new AmazonShopApi(core);
|
|
955
|
-
this.ageGender = new AgeGenderApi(core);
|
|
956
984
|
this.account = new AccountApi(core);
|
|
985
|
+
this.utilities = new UtilitiesApi(core);
|
|
957
986
|
this.kwai = new KwaiApi(core);
|
|
958
987
|
this.komi = new KomiApi(core);
|
|
959
988
|
this.pillar = new PillarApi(core);
|
|
960
989
|
this.linkbio = new LinkbioApi(core);
|
|
961
990
|
this.linkme = new LinkmeApi(core);
|
|
962
|
-
this.adLibrary = new AdLibraryApi(core);
|
|
963
991
|
}
|
|
964
992
|
}
|