@captapi/sdk 0.1.0 → 0.3.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 +102 -23
- package/dist/generated.d.ts +1412 -672
- package/dist/generated.js +352 -304
- package/package.json +51 -51
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 — AI 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; 0 when the video has comments turned off (commentsDisabled: true). (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, 0 when a page finds nothing). (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. (~10 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,91 @@ 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, cursor-paginated, with isPinned, caption mention text and brand signals (promoCodes, brandMentions). Flat 2 credits; 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. (~7 credits (0.7/result)) */
|
|
163
|
+
searchByHashtag(params) {
|
|
164
|
+
return this.core.get("/v1/tiktok/search/hashtag", params);
|
|
165
|
+
}
|
|
166
|
+
/** TikTok Search Users — Find TikTok creators by keyword — distinct authors ranking for the query, 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; 2 via the fallback path). (1 credit (2 via fallback path)) */
|
|
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 — Related TikTok hashtags — Creative Center chart when it answers (asOf = the chart's data date, stale when over 3 days old), otherwise a disclosed niche fallback. Flat 2 credits. (2 credits) */
|
|
187
179
|
popularHashtags(params = {}) {
|
|
188
180
|
return this.core.get("/v1/tiktok/popular-hashtags", params);
|
|
189
181
|
}
|
|
190
|
-
/** TikTok Live —
|
|
182
|
+
/** TikTok Live — Check whether a TikTok creator is live right now and get the stream URLs (CMAF/DASH + FLV, HLS when TikTok exposes it) — one GET with an @handle, 1 credit. (1 credit) */
|
|
191
183
|
live(params) {
|
|
192
184
|
return this.core.get("/v1/tiktok/live", params);
|
|
193
185
|
}
|
|
194
|
-
/** TikTok Live Info —
|
|
186
|
+
/** TikTok Live Info — Identical to TikTok Live (isLive, creator.id/secUid, streamQualities hls/cmaf). (1 credit) */
|
|
195
187
|
liveInfo(params) {
|
|
196
188
|
return this.core.get("/v1/tiktok/live-info", params);
|
|
197
189
|
}
|
|
198
|
-
/** TikTok Popular Creators —
|
|
190
|
+
/** TikTok Popular Creators — Creative Center creators + createTime / bioLinkRisk / ttSeller hydrate for partnership vetting. (2 credits) */
|
|
199
191
|
popularCreators(params = {}) {
|
|
200
192
|
return this.core.get("/v1/tiktok/popular-creators", params);
|
|
201
193
|
}
|
|
@@ -205,79 +197,71 @@ export class InstagramApi {
|
|
|
205
197
|
constructor(core) {
|
|
206
198
|
this.core = core;
|
|
207
199
|
}
|
|
208
|
-
/** Instagram Transcript —
|
|
200
|
+
/** 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
201
|
transcript(params) {
|
|
210
202
|
return this.core.get("/v1/instagram/transcript", params);
|
|
211
203
|
}
|
|
212
|
-
/** Instagram Summarizer — AI summary of
|
|
204
|
+
/** Instagram Summarizer — Get an AI summary of any Instagram Reel — a short paragraph plus key points, without watching the video. (4 credits) */
|
|
213
205
|
summarize(params) {
|
|
214
206
|
return this.core.get("/v1/instagram/summarize", params);
|
|
215
207
|
}
|
|
216
|
-
/** Instagram Details —
|
|
208
|
+
/** Instagram Post & Reel Details — Get an Instagram post, Reel or carousel — caption, publish date, likes, comments, views, media URLs, author, per-slide children, and promo codes / disclosure words from the caption. (1 credit) */
|
|
217
209
|
details(params) {
|
|
218
210
|
return this.core.get("/v1/instagram/details", params);
|
|
219
211
|
}
|
|
220
|
-
/** Instagram Comments —
|
|
212
|
+
/** Instagram Post Comments — Session-paged Instagram comments — a logged-out 2-row preview of a larger thread is 503 SESSION_UNAVAILABLE at 0 credits. (~9 credits (0.9/result)) */
|
|
221
213
|
comments(params) {
|
|
222
214
|
return this.core.get("/v1/instagram/comments", params);
|
|
223
215
|
}
|
|
224
|
-
/** Instagram Channel Details —
|
|
216
|
+
/** Instagram Channel Details — Instagram profile stats — fixed key set (null fillers), fbid, bioLinks, isBusinessAccount, approx flags. (1 credit) */
|
|
225
217
|
channelDetails(params) {
|
|
226
218
|
return this.core.get("/v1/instagram/channel-details", params);
|
|
227
219
|
}
|
|
228
|
-
/** Instagram Channel Posts — Latest posts from
|
|
220
|
+
/** Instagram Channel Posts — Latest posts from a public Instagram profile — carousel children[], mediaCount, isPinned, caption promo codes, user{} in one call. (~3 credits (0.3/result)) */
|
|
229
221
|
channelPosts(params) {
|
|
230
222
|
return this.core.get("/v1/instagram/channel-posts", params);
|
|
231
223
|
}
|
|
232
|
-
/** Instagram Channel Reels — Latest Reels from
|
|
233
|
-
channelReels(params) {
|
|
224
|
+
/** Instagram Channel Reels — Latest Reels from a public Instagram profile — isPinned, optional since date filter, pass userId to skip resolve; ceil(n×0.3) credits; nextCursor + hasMore. (~3 credits (0.3/result)) */
|
|
225
|
+
channelReels(params = {}) {
|
|
234
226
|
return this.core.get("/v1/instagram/channel-reels", params);
|
|
235
227
|
}
|
|
236
|
-
/** Instagram Reels Search —
|
|
228
|
+
/** Instagram Reels Search — Native tag feed first, slower fallback paths on a miss. Max 50. Flat 2 credits. (2 credits) */
|
|
237
229
|
reelsSearch(params) {
|
|
238
230
|
return this.core.get("/v1/instagram/reels-search", params);
|
|
239
231
|
}
|
|
240
|
-
/** Instagram Trending Reels —
|
|
232
|
+
/** Instagram Trending Reels — Cache-first trending Reels. Feed outage → labelled country hashtag-clips stand-in (listing field), never a silent swap. Max 50. Flat 2 credits. (2 credits) */
|
|
241
233
|
trendingReels(params = {}) {
|
|
242
234
|
return this.core.get("/v1/instagram/trending-reels", params);
|
|
243
235
|
}
|
|
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) */
|
|
236
|
+
/** Instagram Tagged Posts — Posts that tag an Instagram account — author verified/avatar when available, staleFeed when Instagram only exposes an archive. (1 credit) */
|
|
249
237
|
taggedPosts(params) {
|
|
250
238
|
return this.core.get("/v1/instagram/tagged-posts", params);
|
|
251
239
|
}
|
|
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) */
|
|
240
|
+
/** Instagram Reels By Audio ID — Is this Instagram sound trending? Reels that use it + isTrendingInClips / trendRank / rich music{}. (~14 credits (1.4/result)) */
|
|
257
241
|
reelsByAudioId(params) {
|
|
258
242
|
return this.core.get("/v1/instagram/reels-by-audio-id", params);
|
|
259
243
|
}
|
|
260
|
-
/** Instagram Hashtag Search —
|
|
244
|
+
/** Instagram Hashtag Search — Hashtag Explore: native grid first, fallback path only on miss. Max 50. Flat 2 credits. (2 credits) */
|
|
261
245
|
hashtagSearch(params) {
|
|
262
246
|
return this.core.get("/v1/instagram/hashtag-search", params);
|
|
263
247
|
}
|
|
264
|
-
/** Instagram Profile Search —
|
|
248
|
+
/** Instagram Profile Search — Resolve a brand or @handle to one public Instagram profile — or search accounts by free text (mode=search). (1 credit) */
|
|
265
249
|
profileSearch(params) {
|
|
266
250
|
return this.core.get("/v1/instagram/profile-search", params);
|
|
267
251
|
}
|
|
268
|
-
/** Instagram
|
|
269
|
-
|
|
270
|
-
return this.core.get("/v1/instagram/
|
|
252
|
+
/** Instagram Embed HTML — Classic Instagram embed snippet — blockquote.instagram-media + embed.js. Drop html into your page. (1 credit) */
|
|
253
|
+
embed(params) {
|
|
254
|
+
return this.core.get("/v1/instagram/embed", params);
|
|
255
|
+
}
|
|
256
|
+
/** Instagram Highlights — Persistent Story Highlight albums for a public profile — id, title, cover, owner. Flat 1 credit. (1 credit) */
|
|
257
|
+
highlights(params = {}) {
|
|
258
|
+
return this.core.get("/v1/instagram/highlights", params);
|
|
271
259
|
}
|
|
272
|
-
/** Instagram Highlights Details — Items inside
|
|
260
|
+
/** Instagram Highlights Details — Items inside one Instagram Story Highlight album — media URLs, type, takenAt. Flat 1 credit. (1 credit) */
|
|
273
261
|
highlightsDetails(params) {
|
|
274
262
|
return this.core.get("/v1/instagram/highlights-details", params);
|
|
275
263
|
}
|
|
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) */
|
|
264
|
+
/** Instagram Basic Profile — Instagram profile by user ID or @handle — camelCase schema aligned with Channel Details (followers, externalUrl, businessAddress). (1 credit) */
|
|
281
265
|
basicProfile(params) {
|
|
282
266
|
return this.core.get("/v1/instagram/basic-profile", params);
|
|
283
267
|
}
|
|
@@ -287,101 +271,69 @@ export class FacebookApi {
|
|
|
287
271
|
constructor(core) {
|
|
288
272
|
this.core = core;
|
|
289
273
|
}
|
|
290
|
-
/** Facebook Details —
|
|
274
|
+
/** Facebook Post & Reel Details — Facebook post or Reel — caption, engagement, author id, video{} playback, and music when Facebook exposes them. (2 credits) */
|
|
291
275
|
details(params) {
|
|
292
276
|
return this.core.get("/v1/facebook/details", params);
|
|
293
277
|
}
|
|
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) */
|
|
278
|
+
/** Facebook Summarizer — Summarizer (4 credits) */
|
|
299
279
|
summarize(params) {
|
|
300
280
|
return this.core.get("/v1/facebook/summarize", params);
|
|
301
281
|
}
|
|
302
|
-
/** Facebook Comments —
|
|
303
|
-
comments(params) {
|
|
282
|
+
/** Facebook Comments — Facebook post comments with reactionCount, reactions.like when mixed, author.id (pfbid), and replyCount. (2 credits) */
|
|
283
|
+
comments(params = {}) {
|
|
304
284
|
return this.core.get("/v1/facebook/comments", params);
|
|
305
285
|
}
|
|
306
|
-
/** Facebook Page Details —
|
|
286
|
+
/** Facebook Page Details — Facebook page profile — likes vs followers (distinct), talkingAbout, category, website, and public email. (2 credits) */
|
|
307
287
|
pageDetails(params) {
|
|
308
288
|
return this.core.get("/v1/facebook/page-details", params);
|
|
309
289
|
}
|
|
310
|
-
/** Facebook Profile Posts — Latest posts from a Facebook
|
|
290
|
+
/** Facebook Profile Posts — Latest posts and Reels from a Facebook page — listingHits / timings.phase; 60s deadline, failures 0 credits. (2 credits) */
|
|
311
291
|
profilePosts(params) {
|
|
312
292
|
return this.core.get("/v1/facebook/profile-posts", params);
|
|
313
293
|
}
|
|
314
|
-
/** Facebook Profile Reels — Latest Reels
|
|
294
|
+
/** Facebook Profile Reels — Latest Facebook page Reels — views, likes, comments, shares; newest-first without archive padding. (2 credits) */
|
|
315
295
|
profileReels(params) {
|
|
316
296
|
return this.core.get("/v1/facebook/profile-reels", params);
|
|
317
297
|
}
|
|
318
|
-
/** Facebook Group Posts —
|
|
298
|
+
/** Facebook Group Posts — Newest posts from a public Facebook group — caption, author, engagement, sortBy; 1 credit per post. (~10 credits (1/result)) */
|
|
319
299
|
groupPosts(params) {
|
|
320
300
|
return this.core.get("/v1/facebook/group-posts", params);
|
|
321
301
|
}
|
|
322
|
-
/** Facebook Comment Replies — Replies
|
|
302
|
+
/** Facebook Comment Replies — Comment Replies (2 credits) */
|
|
323
303
|
commentReplies(params) {
|
|
324
304
|
return this.core.get("/v1/facebook/comment-replies", params);
|
|
325
305
|
}
|
|
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) */
|
|
306
|
+
/** Facebook Profile Photos — Photo grid from a Facebook Page — full image URL plus accessibilityCaption (alt-text, not a post caption). (2 credits) */
|
|
343
307
|
profilePhotos(params) {
|
|
344
308
|
return this.core.get("/v1/facebook/profile-photos", params);
|
|
345
309
|
}
|
|
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
310
|
}
|
|
355
311
|
export class TwitterApi {
|
|
356
312
|
core;
|
|
357
313
|
constructor(core) {
|
|
358
314
|
this.core = core;
|
|
359
315
|
}
|
|
360
|
-
/** Twitter/X Tweet Details —
|
|
316
|
+
/** Twitter/X Tweet Details — One tweet as JSON — text, author (followers), likes/replies/retweets/quotes, media, ISO publishedAt. (1 credit) */
|
|
361
317
|
tweetDetails(params) {
|
|
362
318
|
return this.core.get("/v1/twitter/tweet-details", params);
|
|
363
319
|
}
|
|
364
|
-
/** Twitter/X Transcript —
|
|
320
|
+
/** Twitter/X Transcript — Tweet text as a transcript — timingSource none (not speech-to-text). Flat 1 credit. (1 credit) */
|
|
365
321
|
transcript(params) {
|
|
366
322
|
return this.core.get("/v1/twitter/transcript", params);
|
|
367
323
|
}
|
|
368
|
-
/** Twitter/X Profile —
|
|
324
|
+
/** Twitter/X Profile — X profile: verified + blue/legacy/identity, displayName, avatar/banner, tipjar→contact{}, expanded website. (1 credit) */
|
|
369
325
|
profile(params) {
|
|
370
326
|
return this.core.get("/v1/twitter/profile", params);
|
|
371
327
|
}
|
|
372
|
-
/** Twitter/X User Tweets —
|
|
328
|
+
/** 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
329
|
userTweets(params) {
|
|
374
330
|
return this.core.get("/v1/twitter/user-tweets", params);
|
|
375
331
|
}
|
|
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) */
|
|
332
|
+
/** Twitter/X Community — X Community metadata — ISO createdAt, flat creator handle, isNsfw + bannerImage, rules[]. (1 credit) */
|
|
381
333
|
community(params) {
|
|
382
334
|
return this.core.get("/v1/twitter/community", params);
|
|
383
335
|
}
|
|
384
|
-
/** Twitter/X Community Tweets —
|
|
336
|
+
/** Twitter/X Community Tweets — Posts in an X Community — same 6-metric tweet shape as search. Flat 2 credits. (2 credits) */
|
|
385
337
|
communityTweets(params) {
|
|
386
338
|
return this.core.get("/v1/twitter/community-tweets", params);
|
|
387
339
|
}
|
|
@@ -391,31 +343,31 @@ export class RedditApi {
|
|
|
391
343
|
constructor(core) {
|
|
392
344
|
this.core = core;
|
|
393
345
|
}
|
|
394
|
-
/** Reddit Subreddit Posts —
|
|
346
|
+
/** Reddit Subreddit Posts — List posts from a subreddit with sort, timeframe, and cursor pagination — title, score, upvote ratio, flair, and more. (2 credits) */
|
|
395
347
|
subredditPosts(params) {
|
|
396
348
|
return this.core.get("/v1/reddit/subreddit-posts", params);
|
|
397
349
|
}
|
|
398
|
-
/** Reddit Post Details —
|
|
350
|
+
/** Reddit Post Details — Get a Reddit post — title, body, score, comments count, subreddit, and author as structured JSON. (1 credit) */
|
|
399
351
|
postDetails(params) {
|
|
400
352
|
return this.core.get("/v1/reddit/post-details", params);
|
|
401
353
|
}
|
|
402
|
-
/** Reddit Post Comments —
|
|
354
|
+
/** Reddit Post Comments — Flat Reddit comment threads with depth/parentId and the parent post in one call. (2 credits) */
|
|
403
355
|
postComments(params) {
|
|
404
356
|
return this.core.get("/v1/reddit/post-comments", params);
|
|
405
357
|
}
|
|
406
|
-
/** Reddit Post Transcript —
|
|
358
|
+
/** Reddit Post Transcript — Written post text — title, body and top comments. Not a speech transcript. Flat 2 credits. (2 credits) */
|
|
407
359
|
postTranscript(params) {
|
|
408
360
|
return this.core.get("/v1/reddit/post-transcript", params);
|
|
409
361
|
}
|
|
410
|
-
/** Reddit Search —
|
|
362
|
+
/** Reddit Search — Reddit site-wide post search — sort + timeframe + cursor, score/upvoteRatio, authorFullname. Flat 2 credits. (2 credits) */
|
|
411
363
|
search(params) {
|
|
412
364
|
return this.core.get("/v1/reddit/search", params);
|
|
413
365
|
}
|
|
414
|
-
/** Reddit Subreddit Details —
|
|
366
|
+
/** Reddit Subreddit Details — Subreddit card — id (t5_…), weekly visitors and contributions, rules[], ISO createdAt. Flat 1 credit. (1 credit) */
|
|
415
367
|
subredditDetails(params) {
|
|
416
368
|
return this.core.get("/v1/reddit/subreddit-details", params);
|
|
417
369
|
}
|
|
418
|
-
/** Reddit Subreddit Search — Search posts
|
|
370
|
+
/** 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
371
|
subredditSearch(params) {
|
|
420
372
|
return this.core.get("/v1/reddit/subreddit-search", params);
|
|
421
373
|
}
|
|
@@ -425,23 +377,23 @@ export class ThreadsApi {
|
|
|
425
377
|
constructor(core) {
|
|
426
378
|
this.core = core;
|
|
427
379
|
}
|
|
428
|
-
/** Threads Profile —
|
|
380
|
+
/** Threads Profile — Threads profile — displayName, isPrivate, bioLinks (Meta verified), isThreadsOnlyUser, transparencyLabel, bioFragments, HD avatars (1 credit). (1 credit) */
|
|
429
381
|
profile(params) {
|
|
430
382
|
return this.core.get("/v1/threads/profile", params);
|
|
431
383
|
}
|
|
432
|
-
/** Threads User Posts — Recent posts
|
|
384
|
+
/** Threads User Posts — Recent Threads posts — engagement{views,likes,replies,reposts,quotes}, threadId/isReply. Flat 2 credits. source + timings. (2 credits) */
|
|
433
385
|
userPosts(params) {
|
|
434
386
|
return this.core.get("/v1/threads/user-posts", params);
|
|
435
387
|
}
|
|
436
|
-
/** Threads Post Details —
|
|
388
|
+
/** Threads Post Details — Threads post — engagement (views when exposed), comments[], suggestedPosts[], threadId/isReply. Flat 1 credit. (1 credit) */
|
|
437
389
|
postDetails(params) {
|
|
438
390
|
return this.core.get("/v1/threads/post-details", params);
|
|
439
391
|
}
|
|
440
|
-
/** Threads Search —
|
|
392
|
+
/** Threads Post Search — Threads keyword search — posts with engagement + media. orderBy relevant | post_dated | engagement. Flat 2 credits. (2 credits) */
|
|
441
393
|
search(params) {
|
|
442
394
|
return this.core.get("/v1/threads/search", params);
|
|
443
395
|
}
|
|
444
|
-
/** Threads Search Users —
|
|
396
|
+
/** Threads Search Users — Threads user discovery from keyword search — id, handle, avatar, verified. Flat 1 credit. (1 credit) */
|
|
445
397
|
searchUsers(params) {
|
|
446
398
|
return this.core.get("/v1/threads/search-users", params);
|
|
447
399
|
}
|
|
@@ -451,15 +403,15 @@ export class BlueskyApi {
|
|
|
451
403
|
constructor(core) {
|
|
452
404
|
this.core = core;
|
|
453
405
|
}
|
|
454
|
-
/** Bluesky Profile —
|
|
406
|
+
/** Bluesky Profile — Bluesky profile — handle, did, bio, counts, banner, verification{}, labels[], and associated{} (1 credit). (1 credit) */
|
|
455
407
|
profile(params) {
|
|
456
408
|
return this.core.get("/v1/bluesky/profile", params);
|
|
457
409
|
}
|
|
458
|
-
/** Bluesky User Posts —
|
|
410
|
+
/** Bluesky User Posts — Author feed — posts and reposts (isRepost marked), quote/external/images embeds, opaque cursor. (~1 credits (0.1/result)) */
|
|
459
411
|
userPosts(params) {
|
|
460
412
|
return this.core.get("/v1/bluesky/user-posts", params);
|
|
461
413
|
}
|
|
462
|
-
/** Bluesky Post Details —
|
|
414
|
+
/** Bluesky Post Details — Post thread via getPostThread — nested replies[], facet links/mentions/hashtags, rich author (1 credit). (1 credit) */
|
|
463
415
|
postDetails(params) {
|
|
464
416
|
return this.core.get("/v1/bluesky/post-details", params);
|
|
465
417
|
}
|
|
@@ -469,23 +421,23 @@ export class PinterestApi {
|
|
|
469
421
|
constructor(core) {
|
|
470
422
|
this.core = core;
|
|
471
423
|
}
|
|
472
|
-
/** Pinterest Pin Details —
|
|
424
|
+
/** Pinterest Pin Details — Get a Pinterest pin — title, description, link, board, origin creator, and engagement as structured JSON. (1 credit) */
|
|
473
425
|
pinDetails(params) {
|
|
474
426
|
return this.core.get("/v1/pinterest/pin-details", params);
|
|
475
427
|
}
|
|
476
|
-
/** Pinterest User Pins — Pins from a Pinterest profile. (
|
|
428
|
+
/** Pinterest User Pins — Pins from a Pinterest profile — offset cursor, pidgets window ~100. (~5 credits (0.5/result)) */
|
|
477
429
|
userPins(params) {
|
|
478
430
|
return this.core.get("/v1/pinterest/user-pins", params);
|
|
479
431
|
}
|
|
480
|
-
/** Pinterest Search —
|
|
432
|
+
/** Pinterest Search — Keyword pin search — offset cursor, search window 40, flat 2 credits. (2 credits) */
|
|
481
433
|
search(params) {
|
|
482
434
|
return this.core.get("/v1/pinterest/search", params);
|
|
483
435
|
}
|
|
484
|
-
/** Pinterest Board —
|
|
436
|
+
/** Pinterest Board — Pins on a Pinterest board — saves, imageOriginal, destinationUrl, top-level author. ~0.5 credits/pin. (~5 credits (0.5/result)) */
|
|
485
437
|
board(params) {
|
|
486
438
|
return this.core.get("/v1/pinterest/board", params);
|
|
487
439
|
}
|
|
488
|
-
/** Pinterest User Boards —
|
|
440
|
+
/** Pinterest User Boards — Boards on a Pinterest profile — pinCount, coverImage (474x), privacy, sections. Board followers when scoped. (~5 credits (0.5/result)) */
|
|
489
441
|
userBoards(params) {
|
|
490
442
|
return this.core.get("/v1/pinterest/user-boards", params);
|
|
491
443
|
}
|
|
@@ -495,27 +447,27 @@ export class LinkedinApi {
|
|
|
495
447
|
constructor(core) {
|
|
496
448
|
this.core = core;
|
|
497
449
|
}
|
|
498
|
-
/** LinkedIn Profile — Public LinkedIn person profile
|
|
450
|
+
/** LinkedIn Profile — Public LinkedIn person profile — what a logged-out visitor sees: name, headline, location, about. Flat 1 credit. (1 credit) */
|
|
499
451
|
profile(params) {
|
|
500
452
|
return this.core.get("/v1/linkedin/profile", params);
|
|
501
453
|
}
|
|
502
|
-
/** LinkedIn Company —
|
|
454
|
+
/** LinkedIn Company — Company page for B2B intel — specialties, similarPages, employeeCount, founded, slogan, cover. Flat 2 credits. (2 credits) */
|
|
503
455
|
company(params) {
|
|
504
456
|
return this.core.get("/v1/linkedin/company", params);
|
|
505
457
|
}
|
|
506
|
-
/** LinkedIn Post Details —
|
|
458
|
+
/** LinkedIn Post Details — Get a LinkedIn post — text, author, reactions, and comments count as structured JSON. When LinkedIn hides the post behind its sign-in prompt the call fails with 502 at 0 credits. (1 credit) */
|
|
507
459
|
postDetails(params) {
|
|
508
460
|
return this.core.get("/v1/linkedin/post-details", params);
|
|
509
461
|
}
|
|
510
|
-
/** LinkedIn Post Transcript —
|
|
462
|
+
/** LinkedIn Post Transcript — LinkedIn post text as a transcript — paragraph segments, timingSource none. Flat 1 credit. (1 credit) */
|
|
511
463
|
postTranscript(params) {
|
|
512
464
|
return this.core.get("/v1/linkedin/post-transcript", params);
|
|
513
465
|
}
|
|
514
|
-
/** LinkedIn Company Posts —
|
|
466
|
+
/** LinkedIn Company Posts — The recent posts a company page shows logged-out visitors (about 10), with engagement{likes,comments}. Flat 1 credit. (1 credit) */
|
|
515
467
|
companyPosts(params) {
|
|
516
468
|
return this.core.get("/v1/linkedin/company-posts", params);
|
|
517
469
|
}
|
|
518
|
-
/** LinkedIn Search Posts —
|
|
470
|
+
/** LinkedIn Search Posts — Keyword search of public LinkedIn posts — offset cursor, ceiling 50. (~8 credits (0.8/result)) */
|
|
519
471
|
searchPosts(params) {
|
|
520
472
|
return this.core.get("/v1/linkedin/search-posts", params);
|
|
521
473
|
}
|
|
@@ -525,19 +477,23 @@ export class RumbleApi {
|
|
|
525
477
|
constructor(core) {
|
|
526
478
|
this.core = core;
|
|
527
479
|
}
|
|
528
|
-
/** Rumble Video Details —
|
|
480
|
+
/** Rumble Video Details — Rumble video metadata — uniform streams[] with rendition meta, captions[], audioStreams. (1 credit) */
|
|
529
481
|
videoDetails(params) {
|
|
530
482
|
return this.core.get("/v1/rumble/video-details", params);
|
|
531
483
|
}
|
|
532
|
-
/** Rumble
|
|
484
|
+
/** Rumble Video Transcript — Rumble published captions as timed segments — parses the .vtt from video-details (not speech-to-text). (1 credit) */
|
|
485
|
+
videoTranscript(params) {
|
|
486
|
+
return this.core.get("/v1/rumble/video/transcript", params);
|
|
487
|
+
}
|
|
488
|
+
/** Rumble Channel Videos — Rumble channel uploads — lean streams[{url,type}]; call video-details for rendition meta. (~6 credits (0.6/result)) */
|
|
533
489
|
channelVideos(params) {
|
|
534
490
|
return this.core.get("/v1/rumble/channel-videos", params);
|
|
535
491
|
}
|
|
536
|
-
/** Rumble Search —
|
|
492
|
+
/** Rumble Search — Rumble keyword search — same video card shape as channel-videos (type, durationSeconds + durationText, UTC publishedAt). (~6 credits (0.6/result)) */
|
|
537
493
|
search(params) {
|
|
538
494
|
return this.core.get("/v1/rumble/search", params);
|
|
539
495
|
}
|
|
540
|
-
/** Rumble Comments —
|
|
496
|
+
/** Rumble Comments — Rumble top-level comments — publishedAt ISO-8601 UTC from title= on the comment time link. (2 credits) */
|
|
541
497
|
comments(params) {
|
|
542
498
|
return this.core.get("/v1/rumble/comments", params);
|
|
543
499
|
}
|
|
@@ -547,101 +503,213 @@ export class TiktokShopApi {
|
|
|
547
503
|
constructor(core) {
|
|
548
504
|
this.core = core;
|
|
549
505
|
}
|
|
550
|
-
/** TikTok Shop Search —
|
|
506
|
+
/** TikTok Shop Search — TikTok Shop keyword search — priced products with rating/reviews, typed discount, seller id. (2 credits) */
|
|
551
507
|
search(params) {
|
|
552
508
|
return this.core.get("/v1/tiktok-shop/shop-search", params);
|
|
553
509
|
}
|
|
554
|
-
/** TikTok Shop Products —
|
|
510
|
+
/** TikTok Shop Products — Store catalog with shopInfo (sold/followers/rating) + products priced with sold, rating, typed discount. (2 credits (fallback: 2.8/product, min 2)) */
|
|
555
511
|
products(params) {
|
|
556
512
|
return this.core.get("/v1/tiktok-shop/shop-products", params);
|
|
557
513
|
}
|
|
558
|
-
/** TikTok Shop Product Details —
|
|
514
|
+
/** TikTok Shop Product Details — PDP — price (sku_min when guest min is *), sold vs stock, seller id/url, images[]. Unresolved URL is 404 at 0 credits. (2 credits) */
|
|
559
515
|
productDetails(params) {
|
|
560
516
|
return this.core.get("/v1/tiktok-shop/product-details", params);
|
|
561
517
|
}
|
|
562
|
-
/** TikTok Shop Product Reviews —
|
|
518
|
+
/** 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
519
|
productReviews(params) {
|
|
564
520
|
return this.core.get("/v1/tiktok-shop/product-reviews", params);
|
|
565
521
|
}
|
|
566
|
-
/** TikTok Shop User Showcase —
|
|
522
|
+
/** TikTok Shop User Showcase — Creator Shop showcase — affiliate shelf products with per-product sold, rating, typed discount, and seller name/url. (~23 credits (2.25/result)) */
|
|
567
523
|
userShowcase(params) {
|
|
568
524
|
return this.core.get("/v1/tiktok-shop/user-showcase", params);
|
|
569
525
|
}
|
|
570
526
|
}
|
|
527
|
+
export class FacebookMarketplaceApi {
|
|
528
|
+
core;
|
|
529
|
+
constructor(core) {
|
|
530
|
+
this.core = core;
|
|
531
|
+
}
|
|
532
|
+
/** Facebook Marketplace Search — Search Marketplace by keyword + city — filters, isLocal/shipsOutsideRadius, opaque cursor (2 credits). (2 credits) */
|
|
533
|
+
search(params) {
|
|
534
|
+
return this.core.get("/v1/facebook/marketplace-search", params);
|
|
535
|
+
}
|
|
536
|
+
/** Facebook Marketplace Location Search — Disambiguate city names into Marketplace hubs — id + lat/lng. Flat 2 credits. (2 credits) */
|
|
537
|
+
locationSearch(params) {
|
|
538
|
+
return this.core.get("/v1/facebook/marketplace-location-search", params);
|
|
539
|
+
}
|
|
540
|
+
/** Facebook Marketplace Item — Marketplace listing — title, priceAmount, status, seller{}, condition, coords (2 credits). (2 credits) */
|
|
541
|
+
item(params) {
|
|
542
|
+
return this.core.get("/v1/facebook/marketplace-item", params);
|
|
543
|
+
}
|
|
544
|
+
}
|
|
545
|
+
export class FacebookEventsApi {
|
|
546
|
+
core;
|
|
547
|
+
constructor(core) {
|
|
548
|
+
this.core = core;
|
|
549
|
+
}
|
|
550
|
+
/** Facebook Event Search — Search Facebook events by topic and city — local startDate/timezone, venue. 2 credits. (2 credits) */
|
|
551
|
+
facebookEventSearch(params) {
|
|
552
|
+
return this.core.get("/v1/facebook/event-search", params);
|
|
553
|
+
}
|
|
554
|
+
/** Facebook Event Details — Get a Facebook event — title, local start/end, timezone, place, host id, and attendance when exposed. (2 credits) */
|
|
555
|
+
facebookEventDetails(params) {
|
|
556
|
+
return this.core.get("/v1/facebook/event-details", params);
|
|
557
|
+
}
|
|
558
|
+
/** Facebook Profile Events — List a Facebook Page's events — local startDate, timezone, venue. 2 credits. (2 credits) */
|
|
559
|
+
facebookProfileEvents(params) {
|
|
560
|
+
return this.core.get("/v1/facebook/profile-events", params);
|
|
561
|
+
}
|
|
562
|
+
}
|
|
563
|
+
export class FacebookAdLibraryApi {
|
|
564
|
+
core;
|
|
565
|
+
constructor(core) {
|
|
566
|
+
this.core = core;
|
|
567
|
+
}
|
|
568
|
+
/** 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) */
|
|
569
|
+
search(params) {
|
|
570
|
+
return this.core.get("/v1/ad-library/facebook/search", params);
|
|
571
|
+
}
|
|
572
|
+
/** Facebook Company Ads — Ads for one Meta page — active by default, Meta's top-by-impressions order, sort_by and date window, same envelope as /facebook/search. (2 credits) */
|
|
573
|
+
companyAds(params) {
|
|
574
|
+
return this.core.get("/v1/ad-library/facebook/company-ads", params);
|
|
575
|
+
}
|
|
576
|
+
/** Facebook Ad Library Search Companies — Find Meta Ad Library pages by brand — name-matched, pageId for company-ads (not profileId). (2 credits) */
|
|
577
|
+
searchCompanies(params) {
|
|
578
|
+
return this.core.get("/v1/ad-library/facebook/search-companies", params);
|
|
579
|
+
}
|
|
580
|
+
/** Facebook Ad Details — One Meta ad by ID — same creative as search, plus EU transparency data for EU-delivered ads. Flat 2 credits. (2 credits) */
|
|
581
|
+
adDetails(params) {
|
|
582
|
+
return this.core.get("/v1/ad-library/facebook/ad-details", params);
|
|
583
|
+
}
|
|
584
|
+
/** Facebook Ad Transcript — Spoken transcript of a Meta video ad with timed segments — written copy as fallback. (2 credits) */
|
|
585
|
+
adTranscript(params) {
|
|
586
|
+
return this.core.get("/v1/ad-library/facebook/ad-transcript", params);
|
|
587
|
+
}
|
|
588
|
+
}
|
|
589
|
+
export class TiktokAdLibraryApi {
|
|
590
|
+
core;
|
|
591
|
+
constructor(core) {
|
|
592
|
+
this.core = core;
|
|
593
|
+
}
|
|
594
|
+
/** TikTok Ad Library Search — Search TikTok Commercial Content Library — relevance-filtered, uniform null schema (2 credits native, 5 via fallback). (2 credits (5 via fallback path)) */
|
|
595
|
+
search(params) {
|
|
596
|
+
return this.core.get("/v1/ad-library/tiktok/search", params);
|
|
597
|
+
}
|
|
598
|
+
/** TikTok Creative Center Top Ads — TikTok Creative Center Top Ads — one ~20-row leaderboard page, not a library search (flat 2; ~1/ad on the fallback path). (2 credits) */
|
|
599
|
+
topAds(params = {}) {
|
|
600
|
+
return this.core.get("/v1/ad-library/tiktok/top-ads", params);
|
|
601
|
+
}
|
|
602
|
+
/** TikTok Ad Details — One TikTok Commercial Content Library ad by ID — calendar-day dates, always 2 credits. (2 credits) */
|
|
603
|
+
adDetails(params) {
|
|
604
|
+
return this.core.get("/v1/ad-library/tiktok/ad-details", params);
|
|
605
|
+
}
|
|
606
|
+
}
|
|
607
|
+
export class GoogleAdLibraryApi {
|
|
608
|
+
core;
|
|
609
|
+
constructor(core) {
|
|
610
|
+
this.core = core;
|
|
611
|
+
}
|
|
612
|
+
/** 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) */
|
|
613
|
+
companyAds(params) {
|
|
614
|
+
return this.core.get("/v1/ad-library/google/company-ads", params);
|
|
615
|
+
}
|
|
616
|
+
/** 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) */
|
|
617
|
+
adDetails(params) {
|
|
618
|
+
return this.core.get("/v1/ad-library/google/ad-details", params);
|
|
619
|
+
}
|
|
620
|
+
/** Google Advertiser Search — Find Google Ads Transparency AR… entities — ranked multi-result (1 credit when found; empty is free). (1 credit) */
|
|
621
|
+
advertiserSearch(params) {
|
|
622
|
+
return this.core.get("/v1/ad-library/google/advertiser-search", params);
|
|
623
|
+
}
|
|
624
|
+
}
|
|
625
|
+
export class LinkedinAdLibraryApi {
|
|
626
|
+
core;
|
|
627
|
+
constructor(core) {
|
|
628
|
+
this.core = core;
|
|
629
|
+
}
|
|
630
|
+
/** 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. (2 credits) */
|
|
631
|
+
searchAds(params = {}) {
|
|
632
|
+
return this.core.get("/v1/ad-library/linkedin/search-ads", params);
|
|
633
|
+
}
|
|
634
|
+
/** 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) */
|
|
635
|
+
adDetails(params) {
|
|
636
|
+
return this.core.get("/v1/ad-library/linkedin/ad-details", params);
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
export class AmazonShopApi {
|
|
640
|
+
core;
|
|
641
|
+
constructor(core) {
|
|
642
|
+
this.core = core;
|
|
643
|
+
}
|
|
644
|
+
/** Amazon Seller Storefront — Third-party seller storefronts (/sp?seller= / /s?me=) — ASIN + canonical /dp URLs, price, badges. Not influencer /shop/{handle}. (1 credit per 16 products (default limit 20 = 2)) */
|
|
645
|
+
page(params) {
|
|
646
|
+
return this.core.get("/v1/amazon-shop/page", params);
|
|
647
|
+
}
|
|
648
|
+
}
|
|
571
649
|
export class GithubApi {
|
|
572
650
|
core;
|
|
573
651
|
constructor(core) {
|
|
574
652
|
this.core = core;
|
|
575
653
|
}
|
|
576
|
-
/** GitHub User —
|
|
654
|
+
/** GitHub User — GitHub public profile — login, type User|Organization, email when public, followers (1 credit). (1 credit) */
|
|
577
655
|
user(params) {
|
|
578
656
|
return this.core.get("/v1/github/user", params);
|
|
579
657
|
}
|
|
580
|
-
/** GitHub Repositories — List a
|
|
658
|
+
/** GitHub Repositories — List a user's repos with sort/direction/type — opaque Link cursor (~0.4/repo). (~4 credits (0.4/result)) */
|
|
581
659
|
repositories(params) {
|
|
582
660
|
return this.core.get("/v1/github/repositories", params);
|
|
583
661
|
}
|
|
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) */
|
|
662
|
+
/** GitHub Pull Requests — List repo PRs — draft, labels, author{}, head/base, opaque Link cursor (state echoed). (~4 credits (0.4/result)) */
|
|
589
663
|
pullRequests(params) {
|
|
590
664
|
return this.core.get("/v1/github/pull-requests", params);
|
|
591
665
|
}
|
|
592
|
-
/** GitHub Activity —
|
|
666
|
+
/** GitHub Activity — Public events with typed payload (Push commits/ref, PR/issue action) — 90-event ceiling. (~4 credits (0.4/result)) */
|
|
593
667
|
activity(params) {
|
|
594
668
|
return this.core.get("/v1/github/activity", params);
|
|
595
669
|
}
|
|
596
|
-
/** GitHub Followers —
|
|
670
|
+
/** 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
671
|
followers(params) {
|
|
598
672
|
return this.core.get("/v1/github/followers", params);
|
|
599
673
|
}
|
|
600
|
-
/** GitHub Following —
|
|
674
|
+
/** GitHub Following — Accounts a user follows — same card and ~0.1/row pricing as followers. (~3 credits (0.1/result)) */
|
|
601
675
|
following(params) {
|
|
602
676
|
return this.core.get("/v1/github/following", params);
|
|
603
677
|
}
|
|
604
|
-
/** GitHub Contributions —
|
|
678
|
+
/** GitHub Contributions — GitHub contribution graph — sorted days[], currentStreak (today grace), longestStreak (2 credits). (2 credits) */
|
|
605
679
|
contributions(params) {
|
|
606
680
|
return this.core.get("/v1/github/contributions", params);
|
|
607
681
|
}
|
|
608
|
-
/** GitHub
|
|
609
|
-
|
|
682
|
+
/** GitHub Repository — GitHub repo — stars, real watchers (subscribers), openIssuesAndPrs, license, parent when fork (1 credit). (1 credit) */
|
|
683
|
+
repository(params) {
|
|
684
|
+
return this.core.get("/v1/github/repository", params);
|
|
685
|
+
}
|
|
686
|
+
/** GitHub Trending Repositories — github.com/trending — repos ranked by starsGained (daily|weekly|monthly), not all-time stars (2 credits). (2 credits) */
|
|
687
|
+
trendingRepositories(params = {}) {
|
|
610
688
|
return this.core.get("/v1/github/trending-repositories", params);
|
|
611
689
|
}
|
|
612
|
-
/** GitHub Trending Developers —
|
|
613
|
-
trendingDevelopers(params) {
|
|
690
|
+
/** GitHub Trending Developers — github.com/trending/developers — windowed ranks with popularRepo + followers (2 credits). (2 credits) */
|
|
691
|
+
trendingDevelopers(params = {}) {
|
|
614
692
|
return this.core.get("/v1/github/trending-developers", params);
|
|
615
693
|
}
|
|
616
694
|
}
|
|
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
695
|
export class TwitchApi {
|
|
628
696
|
core;
|
|
629
697
|
constructor(core) {
|
|
630
698
|
this.core = core;
|
|
631
699
|
}
|
|
632
|
-
/** Twitch Profile — Twitch channel
|
|
700
|
+
/** Twitch Profile — Twitch channel — handle + displayName, socials[], topClips, schedule preview, stream only when live (1 credit). (1 credit) */
|
|
633
701
|
profile(params) {
|
|
634
702
|
return this.core.get("/v1/twitch/profile", params);
|
|
635
703
|
}
|
|
636
|
-
/** Twitch User Videos —
|
|
704
|
+
/** Twitch User Videos — Twitch channel VODs — lean rows, video-id cursor, filter/sort, top-level broadcaster{} (flat 2). (2 credits) */
|
|
637
705
|
userVideos(params) {
|
|
638
706
|
return this.core.get("/v1/twitch/user-videos", params);
|
|
639
707
|
}
|
|
640
|
-
/** Twitch User Schedule —
|
|
708
|
+
/** Twitch User Schedule — Twitch channel schedule — startAt/endAt, title, game, isRecurring (0 credits when empty). (1 credit) */
|
|
641
709
|
userSchedule(params) {
|
|
642
710
|
return this.core.get("/v1/twitch/user-schedule", params);
|
|
643
711
|
}
|
|
644
|
-
/** Twitch Clip — Twitch clip
|
|
712
|
+
/** Twitch Clip — Twitch clip — curator vs channel, signedVideoUrl, unwrapped token, relatedClips (1 credit). (1 credit) */
|
|
645
713
|
clip(params) {
|
|
646
714
|
return this.core.get("/v1/twitch/clip", params);
|
|
647
715
|
}
|
|
@@ -651,27 +719,27 @@ export class SpotifyApi {
|
|
|
651
719
|
constructor(core) {
|
|
652
720
|
this.core = core;
|
|
653
721
|
}
|
|
654
|
-
/** Spotify Artist — Spotify artist
|
|
722
|
+
/** Spotify Artist — Spotify artist — followers, monthlyListeners, worldRank, topCities, topTracks with playCount, concerts, and related artists (1 credit). (1 credit) */
|
|
655
723
|
artist(params) {
|
|
656
724
|
return this.core.get("/v1/spotify/artist", params);
|
|
657
725
|
}
|
|
658
|
-
/** Spotify Track — Spotify track
|
|
726
|
+
/** Spotify Track — Spotify track — playCount, joinable artists[]/album{}, explicit, releaseDate (1 credit). (1 credit) */
|
|
659
727
|
track(params) {
|
|
660
728
|
return this.core.get("/v1/spotify/track", params);
|
|
661
729
|
}
|
|
662
|
-
/** Spotify Album — Spotify album
|
|
730
|
+
/** Spotify Album — Spotify album — tracks[] with playCount, joinable artists[], releaseDate, explicit (1 credit). (1 credit) */
|
|
663
731
|
album(params) {
|
|
664
732
|
return this.core.get("/v1/spotify/album", params);
|
|
665
733
|
}
|
|
666
|
-
/** Spotify Search — Search Spotify
|
|
734
|
+
/** Spotify Search — Search Spotify — canonical spotify: URIs, explicit, fetchedAt (flat 2 credits). (2 credits) */
|
|
667
735
|
search(params) {
|
|
668
736
|
return this.core.get("/v1/spotify/search", params);
|
|
669
737
|
}
|
|
670
|
-
/** Spotify Podcast — Spotify podcast
|
|
738
|
+
/** Spotify Podcast — Spotify podcast show — publisher, rating, topics, explicit flag, and totalEpisodes as clean JSON. (1 credit) */
|
|
671
739
|
podcast(params) {
|
|
672
740
|
return this.core.get("/v1/spotify/podcast", params);
|
|
673
741
|
}
|
|
674
|
-
/** Spotify Podcast Episodes —
|
|
742
|
+
/** Spotify Podcast Episodes — Podcast episode archive — previewUrl, releaseDate, explicit, cursor pagination (flat 2 credits). (2 credits) */
|
|
675
743
|
podcastEpisodes(params) {
|
|
676
744
|
return this.core.get("/v1/spotify/podcast-episodes", params);
|
|
677
745
|
}
|
|
@@ -681,15 +749,15 @@ export class SoundcloudApi {
|
|
|
681
749
|
constructor(core) {
|
|
682
750
|
this.core = core;
|
|
683
751
|
}
|
|
684
|
-
/** SoundCloud Artist — SoundCloud artist
|
|
752
|
+
/** SoundCloud Artist — SoundCloud artist — handle + name, subscriptionTier, externalLinks, verified (1 credit). (1 credit) */
|
|
685
753
|
artist(params) {
|
|
686
754
|
return this.core.get("/v1/soundcloud/artist", params);
|
|
687
755
|
}
|
|
688
|
-
/** SoundCloud Artist Tracks —
|
|
756
|
+
/** SoundCloud Artist Tracks — Artist track list — opaque cursor, native-window when the api-v2 page ends (2 credits; empty is 0). (2 credits) */
|
|
689
757
|
artistTracks(params) {
|
|
690
758
|
return this.core.get("/v1/soundcloud/artist-tracks", params);
|
|
691
759
|
}
|
|
692
|
-
/** SoundCloud Track — SoundCloud track
|
|
760
|
+
/** SoundCloud Track — SoundCloud track — plays/likes/license, tags[], nested artist{}, streamUrl when streamable (1 credit). (1 credit) */
|
|
693
761
|
track(params) {
|
|
694
762
|
return this.core.get("/v1/soundcloud/track", params);
|
|
695
763
|
}
|
|
@@ -699,7 +767,7 @@ export class LinktreeApi {
|
|
|
699
767
|
constructor(core) {
|
|
700
768
|
this.core = core;
|
|
701
769
|
}
|
|
702
|
-
/** Linktree Page —
|
|
770
|
+
/** Linktree Page — Link-in-bio → creator graph: typed links, socialAccounts{} that feed TikTok/Instagram/Spotify/SoundCloud, email, verticals. Flat 1 credit. (1 credit) */
|
|
703
771
|
page(params) {
|
|
704
772
|
return this.core.get("/v1/linktree/page", params);
|
|
705
773
|
}
|
|
@@ -709,7 +777,7 @@ export class SnapchatApi {
|
|
|
709
777
|
constructor(core) {
|
|
710
778
|
this.core = core;
|
|
711
779
|
}
|
|
712
|
-
/** Snapchat User Profile —
|
|
780
|
+
/** Snapchat User Profile — Snapchat profile — stable identity card, millisecond timestamps, mediaType image/video (1 credit). (1 credit) */
|
|
713
781
|
userProfile(params) {
|
|
714
782
|
return this.core.get("/v1/snapchat/user-profile", params);
|
|
715
783
|
}
|
|
@@ -719,15 +787,15 @@ export class TruthSocialApi {
|
|
|
719
787
|
constructor(core) {
|
|
720
788
|
this.core = core;
|
|
721
789
|
}
|
|
722
|
-
/** Truth Social Profile —
|
|
790
|
+
/** Truth Social Profile — Prominent public Truth Social profiles — isPrivate/bot/group, CP-F counts, avatar/banner. Flat 1 credit. (1 credit) */
|
|
723
791
|
profile(params) {
|
|
724
792
|
return this.core.get("/v1/truth-social/profile", params);
|
|
725
793
|
}
|
|
726
|
-
/** Truth Social User Posts — Recent
|
|
794
|
+
/** Truth Social User Posts — Recent Truths — same post mapper as /post (links, card, reblog/quote, mentions). 2 credits. (2 credits) */
|
|
727
795
|
userPosts(params) {
|
|
728
796
|
return this.core.get("/v1/truth-social/user-posts", params);
|
|
729
797
|
}
|
|
730
|
-
/** Truth Social Post — Truth
|
|
798
|
+
/** Truth Social Post — One Truth — text, links[], card, reblog/quote chain, media.meta, externalVideoId. Flat 1 credit. (1 credit) */
|
|
731
799
|
post(params) {
|
|
732
800
|
return this.core.get("/v1/truth-social/post", params);
|
|
733
801
|
}
|
|
@@ -737,67 +805,69 @@ export class KickApi {
|
|
|
737
805
|
constructor(core) {
|
|
738
806
|
this.core = core;
|
|
739
807
|
}
|
|
740
|
-
/** Kick Clip — Kick clip
|
|
808
|
+
/** Kick Clip — Get a Kick clip, or a channel's recent clips — 7d clip cache. Flat 1 credit. (1 credit) */
|
|
741
809
|
clip(params) {
|
|
742
810
|
return this.core.get("/v1/kick/clip", params);
|
|
743
811
|
}
|
|
744
812
|
}
|
|
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
813
|
export class AccountApi {
|
|
766
814
|
core;
|
|
767
815
|
constructor(core) {
|
|
768
816
|
this.core = core;
|
|
769
817
|
}
|
|
770
|
-
/** Credit Balance —
|
|
818
|
+
/** Credit Balance — Plan, subscription vs top-up credits, monthly quota, and renewsAt — 0 credits. (0 credits) */
|
|
771
819
|
balance(params = {}) {
|
|
772
820
|
return this.core.get("/v1/account/balance", params);
|
|
773
821
|
}
|
|
774
|
-
/** Request History —
|
|
822
|
+
/** Request History — Recent API requests for your key — requestId, status, credits, cacheHit (0 credits). (0 credits) */
|
|
775
823
|
requestHistory(params = {}) {
|
|
776
824
|
return this.core.get("/v1/account/request-history", params);
|
|
777
825
|
}
|
|
778
|
-
/** Daily Usage —
|
|
826
|
+
/** Daily Usage — Day-by-day credit usage for spend monitoring (0 credits). (0 credits) */
|
|
779
827
|
dailyUsage(params = {}) {
|
|
780
828
|
return this.core.get("/v1/account/daily-usage", params);
|
|
781
829
|
}
|
|
782
|
-
/** Most Used Routes —
|
|
830
|
+
/** Most Used Routes — Ranked list of which Captapi routes your key calls most (0 credits). (0 credits) */
|
|
783
831
|
mostUsedRoutes(params = {}) {
|
|
784
832
|
return this.core.get("/v1/account/most-used-routes", params);
|
|
785
833
|
}
|
|
786
834
|
}
|
|
835
|
+
export class UtilitiesApi {
|
|
836
|
+
core;
|
|
837
|
+
constructor(core) {
|
|
838
|
+
this.core = core;
|
|
839
|
+
}
|
|
840
|
+
/** Post Analytics — Unified metrics for one post, video, or reel — platform auto-detected (1 credit). (1 credit) */
|
|
841
|
+
analyticsPost(params) {
|
|
842
|
+
return this.core.get("/v1/analytics/post", params);
|
|
843
|
+
}
|
|
844
|
+
/** Compare Analytics — Compare unified metrics across up to 10 URLs — each row is the analytics/post object (1 credit/resolved URL). (1 credit/url) */
|
|
845
|
+
analyticsCompare(params) {
|
|
846
|
+
return this.core.get("/v1/analytics/compare", params);
|
|
847
|
+
}
|
|
848
|
+
/** Video File Transcript — AI transcription of an uploaded file — 1 credit/min; noSpeech=true and 0 credits when there is no speech. (1 credit/min) */
|
|
849
|
+
videoTranscript(params) {
|
|
850
|
+
return this.core.postMultipart("/v1/video/transcript", params);
|
|
851
|
+
}
|
|
852
|
+
/** Video File Summarizer — AI transcription + summary of an uploaded file — transcript included; 1 credit/min + 1. (1 credit/min +1) */
|
|
853
|
+
videoSummarize(params) {
|
|
854
|
+
return this.core.postMultipart("/v1/video/summarize", params);
|
|
855
|
+
}
|
|
856
|
+
}
|
|
787
857
|
export class KwaiApi {
|
|
788
858
|
core;
|
|
789
859
|
constructor(core) {
|
|
790
860
|
this.core = core;
|
|
791
861
|
}
|
|
792
|
-
/** Kwai Profile — Kwai
|
|
862
|
+
/** Kwai Profile — Fetch Kwai profile — display name, bio, counts, and verification as structured JSON. (1 credit) */
|
|
793
863
|
profile(params) {
|
|
794
864
|
return this.core.get("/v1/kwai/profile", params);
|
|
795
865
|
}
|
|
796
|
-
/** Kwai User Posts —
|
|
866
|
+
/** Kwai User Posts — Kwai profile posts — caption ("" when none), engagement, mp4 + transcript (~1 credit/post). (~10 credits (1/result)) */
|
|
797
867
|
userPosts(params) {
|
|
798
868
|
return this.core.get("/v1/kwai/user-posts", params);
|
|
799
869
|
}
|
|
800
|
-
/** Kwai Post — Kwai
|
|
870
|
+
/** Kwai Post — Single Kwai video — caption ("" when none), hashtags[], author, mp4 (2 credits). (2 credits) */
|
|
801
871
|
post(params) {
|
|
802
872
|
return this.core.get("/v1/kwai/post", params);
|
|
803
873
|
}
|
|
@@ -807,7 +877,7 @@ export class KomiApi {
|
|
|
807
877
|
constructor(core) {
|
|
808
878
|
this.core = core;
|
|
809
879
|
}
|
|
810
|
-
/** Komi Page —
|
|
880
|
+
/** Komi Page — Komi link-in-bio → identity, socials{} (incl. website), content LINK/PRODUCT rows with price/currency. Flat 1 credit. (1 credit) */
|
|
811
881
|
page(params) {
|
|
812
882
|
return this.core.get("/v1/komi/page", params);
|
|
813
883
|
}
|
|
@@ -817,7 +887,7 @@ export class PillarApi {
|
|
|
817
887
|
constructor(core) {
|
|
818
888
|
this.core = core;
|
|
819
889
|
}
|
|
820
|
-
/** Pillar Page —
|
|
890
|
+
/** Pillar Page — Pillar link-in-bio → identity, socials{}, links[] with per-link clicks, products[]. Flat 1 credit. (1 credit) */
|
|
821
891
|
page(params) {
|
|
822
892
|
return this.core.get("/v1/pillar/page", params);
|
|
823
893
|
}
|
|
@@ -827,7 +897,7 @@ export class LinkbioApi {
|
|
|
827
897
|
constructor(core) {
|
|
828
898
|
this.core = core;
|
|
829
899
|
}
|
|
830
|
-
/** Linkbio Page —
|
|
900
|
+
/** Linkbio Page — lnk.bio → id, socials{}, titled links[], website/email/whatsapp, other[]. Flat 1 credit. (1 credit) */
|
|
831
901
|
page(params) {
|
|
832
902
|
return this.core.get("/v1/linkbio/page", params);
|
|
833
903
|
}
|
|
@@ -837,63 +907,29 @@ export class LinkmeApi {
|
|
|
837
907
|
constructor(core) {
|
|
838
908
|
this.core = core;
|
|
839
909
|
}
|
|
840
|
-
/** Linkme Profile —
|
|
910
|
+
/** Linkme Profile — Linkme profile → bio, profileVisitCount, featured links, webLinks, email/infoLinks, stripeStatus. Flat 1 credit. (1 credit) */
|
|
841
911
|
profile(params) {
|
|
842
912
|
return this.core.get("/v1/linkme/profile", params);
|
|
843
913
|
}
|
|
844
914
|
}
|
|
845
|
-
export class
|
|
915
|
+
export class GoogleMapsApi {
|
|
846
916
|
core;
|
|
847
917
|
constructor(core) {
|
|
848
918
|
this.core = core;
|
|
849
919
|
}
|
|
850
|
-
/**
|
|
851
|
-
|
|
852
|
-
return this.core.get("/v1/
|
|
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);
|
|
920
|
+
/** Google Maps Business Search — Local businesses from a Maps search — name, address, phone, website, rating, hours, place id. Flat 2 credits. No emails. (2 credits) */
|
|
921
|
+
businessSearch(params) {
|
|
922
|
+
return this.core.get("/v1/google/business-search", params);
|
|
865
923
|
}
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
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);
|
|
924
|
+
}
|
|
925
|
+
export class WebsiteApi {
|
|
926
|
+
core;
|
|
927
|
+
constructor(core) {
|
|
928
|
+
this.core = core;
|
|
889
929
|
}
|
|
890
|
-
/**
|
|
891
|
-
|
|
892
|
-
return this.core.get("/v1/
|
|
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);
|
|
930
|
+
/** Website Contacts — Business website → role emails, E.164 phones, social profiles. 1 credit when something is found, 0 when not. (1 credit) */
|
|
931
|
+
contacts(params) {
|
|
932
|
+
return this.core.get("/v1/website/contacts", params);
|
|
897
933
|
}
|
|
898
934
|
}
|
|
899
935
|
/** Captapi API client. Get your key at https://captapi.com/dashboard/api-keys */
|
|
@@ -910,8 +946,14 @@ export class Captapi {
|
|
|
910
946
|
linkedin;
|
|
911
947
|
rumble;
|
|
912
948
|
tiktokShop;
|
|
949
|
+
facebookMarketplace;
|
|
950
|
+
facebookEvents;
|
|
951
|
+
facebookAdLibrary;
|
|
952
|
+
tiktokAdLibrary;
|
|
953
|
+
googleAdLibrary;
|
|
954
|
+
linkedinAdLibrary;
|
|
955
|
+
amazonShop;
|
|
913
956
|
github;
|
|
914
|
-
google;
|
|
915
957
|
twitch;
|
|
916
958
|
spotify;
|
|
917
959
|
soundcloud;
|
|
@@ -919,15 +961,15 @@ export class Captapi {
|
|
|
919
961
|
snapchat;
|
|
920
962
|
truthSocial;
|
|
921
963
|
kick;
|
|
922
|
-
amazonShop;
|
|
923
|
-
ageGender;
|
|
924
964
|
account;
|
|
965
|
+
utilities;
|
|
925
966
|
kwai;
|
|
926
967
|
komi;
|
|
927
968
|
pillar;
|
|
928
969
|
linkbio;
|
|
929
970
|
linkme;
|
|
930
|
-
|
|
971
|
+
googleMaps;
|
|
972
|
+
website;
|
|
931
973
|
constructor(options = {}) {
|
|
932
974
|
const core = new HttpCore(options);
|
|
933
975
|
this.youtube = new YoutubeApi(core);
|
|
@@ -942,8 +984,14 @@ export class Captapi {
|
|
|
942
984
|
this.linkedin = new LinkedinApi(core);
|
|
943
985
|
this.rumble = new RumbleApi(core);
|
|
944
986
|
this.tiktokShop = new TiktokShopApi(core);
|
|
987
|
+
this.facebookMarketplace = new FacebookMarketplaceApi(core);
|
|
988
|
+
this.facebookEvents = new FacebookEventsApi(core);
|
|
989
|
+
this.facebookAdLibrary = new FacebookAdLibraryApi(core);
|
|
990
|
+
this.tiktokAdLibrary = new TiktokAdLibraryApi(core);
|
|
991
|
+
this.googleAdLibrary = new GoogleAdLibraryApi(core);
|
|
992
|
+
this.linkedinAdLibrary = new LinkedinAdLibraryApi(core);
|
|
993
|
+
this.amazonShop = new AmazonShopApi(core);
|
|
945
994
|
this.github = new GithubApi(core);
|
|
946
|
-
this.google = new GoogleApi(core);
|
|
947
995
|
this.twitch = new TwitchApi(core);
|
|
948
996
|
this.spotify = new SpotifyApi(core);
|
|
949
997
|
this.soundcloud = new SoundcloudApi(core);
|
|
@@ -951,14 +999,14 @@ export class Captapi {
|
|
|
951
999
|
this.snapchat = new SnapchatApi(core);
|
|
952
1000
|
this.truthSocial = new TruthSocialApi(core);
|
|
953
1001
|
this.kick = new KickApi(core);
|
|
954
|
-
this.amazonShop = new AmazonShopApi(core);
|
|
955
|
-
this.ageGender = new AgeGenderApi(core);
|
|
956
1002
|
this.account = new AccountApi(core);
|
|
1003
|
+
this.utilities = new UtilitiesApi(core);
|
|
957
1004
|
this.kwai = new KwaiApi(core);
|
|
958
1005
|
this.komi = new KomiApi(core);
|
|
959
1006
|
this.pillar = new PillarApi(core);
|
|
960
1007
|
this.linkbio = new LinkbioApi(core);
|
|
961
1008
|
this.linkme = new LinkmeApi(core);
|
|
962
|
-
this.
|
|
1009
|
+
this.googleMaps = new GoogleMapsApi(core);
|
|
1010
|
+
this.website = new WebsiteApi(core);
|
|
963
1011
|
}
|
|
964
1012
|
}
|