socialtap 1.559.31 → 1.571.31
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 +17 -3
- package/dist/client.d.ts +15 -15
- package/dist/client.js +15 -15
- package/dist/commands.js +169 -0
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/dist/models.d.ts +295 -90
- package/dist/resources.d.ts +676 -4
- package/dist/resources.js +151 -3
- package/dist/tooldefs.d.ts +1 -1
- package/dist/tooldefs.js +277 -39
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
SocialTap is the social media scraper API for developers and AI agents. Send a public link, a handle or a search and get live data back in one schema. Failed requests are free.
|
|
6
6
|
|
|
7
7
|
The TypeScript SDK for the SocialTap API: a method for every endpoint, typed models and errors, retries and pagination.
|
|
8
|
-
Generated from the SocialTap catalog (version 1.
|
|
8
|
+
Generated from the SocialTap catalog (version 1.571.31). Docs: https://socialtap.dev/docs.
|
|
9
9
|
|
|
10
10
|
## Install
|
|
11
11
|
|
|
@@ -337,13 +337,23 @@ Every result also carries the envelope `meta` (request ID, source, cache status,
|
|
|
337
337
|
| `twitch.transcript` | `client.twitch.transcript.get()` | 2 credits + 2 per started minute of media |
|
|
338
338
|
| `twitch.video` | `client.twitch.video.get()` | 1 credit |
|
|
339
339
|
| `twitch.videos` | `client.twitch.videos.list()` | 1 credit |
|
|
340
|
+
| `x.comments` | `client.x.comments.list()` | 1 credit |
|
|
340
341
|
| `x.community` | `client.x.community.get()` | 1 credit |
|
|
342
|
+
| `x.community_posts` | `client.x.communityPosts.list()` | 1 credit |
|
|
343
|
+
| `x.engagement` | `client.x.engagement.get()` | 1 credit |
|
|
344
|
+
| `x.friendship` | `client.x.friendship.get()` | 1 credit |
|
|
345
|
+
| `x.list` | `client.x.list.get()` | 1 credit |
|
|
346
|
+
| `x.list_followers` | `client.x.listFollowers.list()` | 1 credit |
|
|
341
347
|
| `x.post` | `client.x.post.get()` | 1 credit |
|
|
348
|
+
| `x.posts` | `client.x.posts.list()` | 1 credit |
|
|
342
349
|
| `x.profile` | `client.x.profile.get()` | 1 credit |
|
|
350
|
+
| `x.profile_mentions` | `client.x.profileMentions.list()` | 1 credit |
|
|
343
351
|
| `x.search_communities` | `client.x.searchCommunities.list()` | 1 credit + 1 per result filled in |
|
|
344
352
|
| `x.search_hashtags` | `client.x.searchHashtags.list()` | 1 credit |
|
|
345
353
|
| `x.search_posts` | `client.x.searchPosts.list()` | 1 credit + 1 per result filled in |
|
|
346
354
|
| `x.search_profiles` | `client.x.searchProfiles.list()` | 1 credit + 1 per result filled in |
|
|
355
|
+
| `x.space` | `client.x.space.get()` | 1 credit |
|
|
356
|
+
| `x.transcript` | `client.x.transcript.get()` | 1 credit (captions) or 2 credits + 2 per started minute of media (speech-to-text) |
|
|
347
357
|
| `youtube.comments` | `client.youtube.comments.list()` | 1 credit |
|
|
348
358
|
| `youtube.engagement` | `client.youtube.engagement.get()` | 1 credit |
|
|
349
359
|
| `youtube.post` | `client.youtube.post.get()` | 1 credit |
|
|
@@ -415,7 +425,7 @@ try {
|
|
|
415
425
|
Retryable failures (the codes above, connection errors, timeouts) are retried 2 times by default with
|
|
416
426
|
exponential backoff and jitter, honoring `retry-after`. A GET retry sends `max_age` set to the seconds since the first
|
|
417
427
|
attempt: if the first response was lost in transit, the retry is served free from the cache. Timeouts are per
|
|
418
|
-
attempt: 60 s by default, and 300 s for endpoints that may transcribe audio (`facebook.ad_transcript`, `facebook.transcript`, `instagram.transcript`, `kick.transcript`, `linkedin.transcript`, `reddit.transcript`, `rumble.transcript`, `tiktok.transcript`, `twitch.transcript`, `youtube.transcript`), because speech-to-text on long
|
|
428
|
+
attempt: 60 s by default, and 300 s for endpoints that may transcribe audio (`facebook.ad_transcript`, `facebook.transcript`, `instagram.transcript`, `kick.transcript`, `linkedin.transcript`, `reddit.transcript`, `rumble.transcript`, `tiktok.transcript`, `twitch.transcript`, `x.transcript`, `youtube.transcript`), because speech-to-text on long
|
|
419
429
|
media takes minutes, and for create-and-wait's long-polls. Most requests answer in a few seconds. A timeout you set, on the client or on one request,
|
|
420
430
|
applies to every endpoint, and so does `maxRetries`.
|
|
421
431
|
|
|
@@ -560,6 +570,7 @@ console.log(r.isError, r.output);
|
|
|
560
570
|
| `list_playlist_tracks` | Playlist tracks |
|
|
561
571
|
| `list_podcast_episodes` | Podcast episodes |
|
|
562
572
|
| `list_post_reposts` | Post reposts |
|
|
573
|
+
| `list_profile_mentions` | Profile mentions |
|
|
563
574
|
| `list_shop_posts` | Shop posts of a profile |
|
|
564
575
|
| `list_tracks` | Tracks of a profile |
|
|
565
576
|
| `list_videos` | Videos of a profile |
|
|
@@ -568,6 +579,7 @@ console.log(r.isError, r.output);
|
|
|
568
579
|
| `list_following` | Following of a profile |
|
|
569
580
|
| `list_followers` | Followers of a profile |
|
|
570
581
|
| `list_employees` | Employees of a profile |
|
|
582
|
+
| `list_playlist_followers` | Playlist followers |
|
|
571
583
|
| `list_post_reactions` | Post reactions |
|
|
572
584
|
| `list_repository_contributors` | Repository contributors |
|
|
573
585
|
| `list_similar_profiles` | Similar profiles of a profile |
|
|
@@ -583,9 +595,9 @@ console.log(r.isError, r.output);
|
|
|
583
595
|
| `get_hashtag` | Hashtag by link |
|
|
584
596
|
| `list_trending_hashtags` | Trending hashtags |
|
|
585
597
|
| `get_community` | Community by link |
|
|
598
|
+
| `get_playlist` | Playlist by link |
|
|
586
599
|
| `get_product` | Product by link |
|
|
587
600
|
| `get_album` | Album by link |
|
|
588
|
-
| `get_playlist` | Playlist by link |
|
|
589
601
|
| `get_sound` | Sound by link |
|
|
590
602
|
| `get_topic` | Topic by link |
|
|
591
603
|
| `get_contributions` | Contributions by handle |
|
|
@@ -599,7 +611,9 @@ console.log(r.isError, r.output);
|
|
|
599
611
|
| `get_place` | Place by link |
|
|
600
612
|
| `get_podcast` | Podcast by link |
|
|
601
613
|
| `get_readme` | Readme by link |
|
|
614
|
+
| `get_relationship` | Relationship by handle |
|
|
602
615
|
| `get_repository` | Repository by link |
|
|
616
|
+
| `get_space` | Space by link |
|
|
603
617
|
| `get_username` | Username by handle |
|
|
604
618
|
| `get_web_page` | Web page by link |
|
|
605
619
|
| `list_reviews` | Reviews of a product |
|
package/dist/client.d.ts
CHANGED
|
@@ -7,21 +7,21 @@ import { Webhooks } from "./webhooks.ts";
|
|
|
7
7
|
* SocialTap is the social media scraper API for developers and AI agents. Send a public link, a handle or a
|
|
8
8
|
* search and get live data back in one schema. Failed requests are free. Available now: activity on GitHub; ads
|
|
9
9
|
* on Facebook, Google, LinkedIn and TikTok; albums on Apple Music and Spotify; comments on Bluesky, Facebook,
|
|
10
|
-
* GitHub, Instagram, LinkedIn, Reddit, Rumble, Snapchat, Threads, TikTok and YouTube; communities on
|
|
11
|
-
* LinkedIn, Reddit and X; contribution calendars on GitHub; downloads on TikTok; effects on TikTok;
|
|
12
|
-
* Instagram; engagement stats on Facebook, Instagram, LinkedIn, Reddit, Rumble, TikTok and YouTube;
|
|
13
|
-
* Facebook; hashtags on Instagram and TikTok; issues on GitHub; jobs on LinkedIn; livestreams on
|
|
14
|
-
* Twitch; offers on Amazon; places on Facebook and Instagram; playlists on Amazon, Apple Music,
|
|
15
|
-
* Pinterest, Spotify and
|
|
16
|
-
* Instagram, Kick, Kwai, LinkedIn, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram,
|
|
17
|
-
* TikTok, Truth Social, Twitch, X and YouTube; products on Amazon, Facebook and TikTok Shop; profiles
|
|
18
|
-
* Apple Music, Bluesky, Facebook, GitHub, Google, Instagram, Komi, Kwai, LinkedIn, Linkme, Linktree,
|
|
19
|
-
* Pillar, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth
|
|
20
|
-
* Twitch, X and YouTube; readmes on GitHub;
|
|
21
|
-
*
|
|
22
|
-
* and Pinterest; transcripts on Facebook, Instagram, Kick, LinkedIn, Reddit,
|
|
23
|
-
* trends on Pinterest; usernames on Instagram; web pages on Pinterest;
|
|
24
|
-
* LinkedIn, Telegram, TikTok and X.
|
|
10
|
+
* GitHub, Instagram, LinkedIn, Reddit, Rumble, Snapchat, Threads, TikTok, X and YouTube; communities on
|
|
11
|
+
* Facebook, LinkedIn, Reddit and X; contribution calendars on GitHub; downloads on TikTok; effects on TikTok;
|
|
12
|
+
* embeds on Instagram; engagement stats on Facebook, Instagram, LinkedIn, Reddit, Rumble, TikTok, X and YouTube;
|
|
13
|
+
* events on Facebook; hashtags on Instagram and TikTok; issues on GitHub; jobs on LinkedIn; livestreams on
|
|
14
|
+
* TikTok, Twitch and X; offers on Amazon; places on Facebook and Instagram; playlists on Amazon, Apple Music,
|
|
15
|
+
* Instagram, Pinterest, Spotify, TikTok and X; podcasts on Spotify; posts on Amazon, Apple Music, Bluesky,
|
|
16
|
+
* Facebook, Instagram, Kick, Kwai, LinkedIn, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram,
|
|
17
|
+
* Threads, TikTok, Truth Social, Twitch, X and YouTube; products on Amazon, Facebook and TikTok Shop; profiles
|
|
18
|
+
* on Amazon, Apple Music, Bluesky, Facebook, GitHub, Google, Instagram, Komi, Kwai, LinkedIn, Linkme, Linktree,
|
|
19
|
+
* Lnk.Bio, Pillar, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth
|
|
20
|
+
* Social, Twitch, X and YouTube; readmes on GitHub; relationships on X; releases on GitHub; repositories on
|
|
21
|
+
* GitHub; reviews on Amazon and TikTok Shop; sounds on Instagram and TikTok; suggestions on Google, Instagram
|
|
22
|
+
* and TikTok; topics on Instagram and Pinterest; transcripts on Facebook, Instagram, Kick, LinkedIn, Reddit,
|
|
23
|
+
* Rumble, TikTok, Twitch, X and YouTube; trends on Pinterest; usernames on Instagram; web pages on Pinterest;
|
|
24
|
+
* web results on Facebook, Instagram, LinkedIn, Telegram, TikTok and X.
|
|
25
25
|
*/
|
|
26
26
|
export declare class SocialTap extends Core {
|
|
27
27
|
/** Amazon endpoints. */
|
package/dist/client.js
CHANGED
|
@@ -8,21 +8,21 @@ import { Webhooks } from "./webhooks.js";
|
|
|
8
8
|
* SocialTap is the social media scraper API for developers and AI agents. Send a public link, a handle or a
|
|
9
9
|
* search and get live data back in one schema. Failed requests are free. Available now: activity on GitHub; ads
|
|
10
10
|
* on Facebook, Google, LinkedIn and TikTok; albums on Apple Music and Spotify; comments on Bluesky, Facebook,
|
|
11
|
-
* GitHub, Instagram, LinkedIn, Reddit, Rumble, Snapchat, Threads, TikTok and YouTube; communities on
|
|
12
|
-
* LinkedIn, Reddit and X; contribution calendars on GitHub; downloads on TikTok; effects on TikTok;
|
|
13
|
-
* Instagram; engagement stats on Facebook, Instagram, LinkedIn, Reddit, Rumble, TikTok and YouTube;
|
|
14
|
-
* Facebook; hashtags on Instagram and TikTok; issues on GitHub; jobs on LinkedIn; livestreams on
|
|
15
|
-
* Twitch; offers on Amazon; places on Facebook and Instagram; playlists on Amazon, Apple Music,
|
|
16
|
-
* Pinterest, Spotify and
|
|
17
|
-
* Instagram, Kick, Kwai, LinkedIn, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram,
|
|
18
|
-
* TikTok, Truth Social, Twitch, X and YouTube; products on Amazon, Facebook and TikTok Shop; profiles
|
|
19
|
-
* Apple Music, Bluesky, Facebook, GitHub, Google, Instagram, Komi, Kwai, LinkedIn, Linkme, Linktree,
|
|
20
|
-
* Pillar, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth
|
|
21
|
-
* Twitch, X and YouTube; readmes on GitHub;
|
|
22
|
-
*
|
|
23
|
-
* and Pinterest; transcripts on Facebook, Instagram, Kick, LinkedIn, Reddit,
|
|
24
|
-
* trends on Pinterest; usernames on Instagram; web pages on Pinterest;
|
|
25
|
-
* LinkedIn, Telegram, TikTok and X.
|
|
11
|
+
* GitHub, Instagram, LinkedIn, Reddit, Rumble, Snapchat, Threads, TikTok, X and YouTube; communities on
|
|
12
|
+
* Facebook, LinkedIn, Reddit and X; contribution calendars on GitHub; downloads on TikTok; effects on TikTok;
|
|
13
|
+
* embeds on Instagram; engagement stats on Facebook, Instagram, LinkedIn, Reddit, Rumble, TikTok, X and YouTube;
|
|
14
|
+
* events on Facebook; hashtags on Instagram and TikTok; issues on GitHub; jobs on LinkedIn; livestreams on
|
|
15
|
+
* TikTok, Twitch and X; offers on Amazon; places on Facebook and Instagram; playlists on Amazon, Apple Music,
|
|
16
|
+
* Instagram, Pinterest, Spotify, TikTok and X; podcasts on Spotify; posts on Amazon, Apple Music, Bluesky,
|
|
17
|
+
* Facebook, Instagram, Kick, Kwai, LinkedIn, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram,
|
|
18
|
+
* Threads, TikTok, Truth Social, Twitch, X and YouTube; products on Amazon, Facebook and TikTok Shop; profiles
|
|
19
|
+
* on Amazon, Apple Music, Bluesky, Facebook, GitHub, Google, Instagram, Komi, Kwai, LinkedIn, Linkme, Linktree,
|
|
20
|
+
* Lnk.Bio, Pillar, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth
|
|
21
|
+
* Social, Twitch, X and YouTube; readmes on GitHub; relationships on X; releases on GitHub; repositories on
|
|
22
|
+
* GitHub; reviews on Amazon and TikTok Shop; sounds on Instagram and TikTok; suggestions on Google, Instagram
|
|
23
|
+
* and TikTok; topics on Instagram and Pinterest; transcripts on Facebook, Instagram, Kick, LinkedIn, Reddit,
|
|
24
|
+
* Rumble, TikTok, Twitch, X and YouTube; trends on Pinterest; usernames on Instagram; web pages on Pinterest;
|
|
25
|
+
* web results on Facebook, Instagram, LinkedIn, Telegram, TikTok and X.
|
|
26
26
|
*/
|
|
27
27
|
export class SocialTap extends Core {
|
|
28
28
|
/** Amazon endpoints. */
|
package/dist/commands.js
CHANGED
|
@@ -4173,6 +4173,25 @@ export const COMMANDS = [
|
|
|
4173
4173
|
list: (c, p, o) => c.twitch.videos.list(p, o),
|
|
4174
4174
|
iterate: (c, p, o) => c.twitch.videos.iterate(p, o),
|
|
4175
4175
|
},
|
|
4176
|
+
{
|
|
4177
|
+
kind: "list",
|
|
4178
|
+
platform: "x",
|
|
4179
|
+
name: "comments",
|
|
4180
|
+
endpoint: "x.comments",
|
|
4181
|
+
summary: "Top replies to a post, with exact counts",
|
|
4182
|
+
price: "1 credit",
|
|
4183
|
+
params: [
|
|
4184
|
+
{ name: "url", type: "string", required: true, description: "X post: a link (x.com or twitter.com, /<username>/status/<id> with or without a view such as /photo/1 or a query such as ?s=20, /i/web/status/<id>, /i/status/<id>, /<username>/article/<id>, old /statuses/ and #! links, mobile.twitter.com, fxtwitter.com and vxtwitter.com) or a bare numeric post ID. At most 2048 characters. Example: https://x.com/WhiteHouse/status/2119797490375606752" },
|
|
4185
|
+
{ name: "since", type: "string", required: false, description: "Only items at or after this time: RFC 3339 (2026-10-01T12:00:00Z) or a date (2026-10-01, midnight UTC). On newest-first lists, paging stops when it is reached, so later pages are not fetched or charged. Example: 2026-10-01" },
|
|
4186
|
+
{ name: "until", type: "string", required: false, description: "Only items before this time (exclusive): RFC 3339 or a date (midnight UTC). Example: 2026-10-08" },
|
|
4187
|
+
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
|
4188
|
+
{ name: "fields", type: "string", required: false, description: "Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole." },
|
|
4189
|
+
{ name: "limit", type: "integer", required: false, description: "Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for. Range: 1 to 20. Default: 20." },
|
|
4190
|
+
{ name: "cursor", type: "string", required: false, description: "page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page." },
|
|
4191
|
+
],
|
|
4192
|
+
list: (c, p, o) => c.x.comments.list(p, o),
|
|
4193
|
+
iterate: (c, p, o) => c.x.comments.iterate(p, o),
|
|
4194
|
+
},
|
|
4176
4195
|
{
|
|
4177
4196
|
kind: "get",
|
|
4178
4197
|
platform: "x",
|
|
@@ -4187,6 +4206,86 @@ export const COMMANDS = [
|
|
|
4187
4206
|
],
|
|
4188
4207
|
get: (c, p, o) => c.x.community.get(p, o),
|
|
4189
4208
|
},
|
|
4209
|
+
{
|
|
4210
|
+
kind: "list",
|
|
4211
|
+
platform: "x",
|
|
4212
|
+
name: "community_posts",
|
|
4213
|
+
endpoint: "x.community_posts",
|
|
4214
|
+
summary: "Top posts and media with exact counts",
|
|
4215
|
+
price: "1 credit",
|
|
4216
|
+
params: [
|
|
4217
|
+
{ name: "url", type: "string", required: true, description: "The community: its link on x.com or twitter.com (x.com/i/communities/<id>, any of its views such as /about, /latest or /media included, mobile hosts and any query too) or its numeric ID. At most 2048 characters. Example: https://x.com/i/communities/1493446837214187523" },
|
|
4218
|
+
{ name: "media", type: "string", required: false, description: "Read the community's Media tab instead of Top: its recent posts with media. any keeps every one, image those with one or more photos, video those with a video or GIF. Top's posts when omitted. One of: any, image, video. Example: video", enum: ["any", "image", "video"] },
|
|
4219
|
+
{ name: "since", type: "string", required: false, description: "Only items at or after this time: RFC 3339 (2026-10-01T12:00:00Z) or a date (2026-10-01, midnight UTC). On newest-first lists, paging stops when it is reached, so later pages are not fetched or charged. Compared with published_at, filtering the page: neither tab is in time order. Example: 2026-10-01" },
|
|
4220
|
+
{ name: "until", type: "string", required: false, description: "Only items before this time (exclusive): RFC 3339 or a date (midnight UTC). Compared with published_at, filtering the page. Example: 2026-10-08" },
|
|
4221
|
+
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
|
4222
|
+
{ name: "fields", type: "string", required: false, description: "Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole." },
|
|
4223
|
+
{ name: "limit", type: "integer", required: false, description: "Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for. Range: 1 to 30. Default: 30." },
|
|
4224
|
+
{ name: "cursor", type: "string", required: false, description: "page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page." },
|
|
4225
|
+
],
|
|
4226
|
+
list: (c, p, o) => c.x.communityPosts.list(p, o),
|
|
4227
|
+
iterate: (c, p, o) => c.x.communityPosts.iterate(p, o),
|
|
4228
|
+
},
|
|
4229
|
+
{
|
|
4230
|
+
kind: "get",
|
|
4231
|
+
platform: "x",
|
|
4232
|
+
name: "engagement",
|
|
4233
|
+
endpoint: "x.engagement",
|
|
4234
|
+
summary: "Engagement rate, views per post and posting cadence",
|
|
4235
|
+
price: "1 credit",
|
|
4236
|
+
params: [
|
|
4237
|
+
{ name: "handle", type: "string", required: true, description: "X account: a username with or without the @ (NASA, @NASA), a numeric user ID (11348282), or a profile link (x.com/NASA or twitter.com/NASA, with or without a tab such as /media or /with_replies, mobile.twitter.com, x.com/i/user/11348282, a Follow-button or intent link such as x.com/intent/user?screen_name=NASA or ?user_id=11348282, with any query such as ?s=20). Usernames are case-insensitive. A bare number is a user ID; a number no account has as its ID is looked up as a username, and @ before digits (@123) always means the username. At most 2048 characters. Example: NASA" },
|
|
4238
|
+
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
|
4239
|
+
{ name: "fields", type: "string", required: false, description: "Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole." },
|
|
4240
|
+
],
|
|
4241
|
+
get: (c, p, o) => c.x.engagement.get(p, o),
|
|
4242
|
+
},
|
|
4243
|
+
{
|
|
4244
|
+
kind: "get",
|
|
4245
|
+
platform: "x",
|
|
4246
|
+
name: "friendship",
|
|
4247
|
+
endpoint: "x.friendship",
|
|
4248
|
+
summary: "Does one account follow another, and back",
|
|
4249
|
+
price: "1 credit",
|
|
4250
|
+
params: [
|
|
4251
|
+
{ name: "handle", type: "string", required: true, description: "The account whose follow is checked (the source): a username with or without the @ (NASA, @NASA), a numeric user ID (11348282), or a profile link (x.com/NASA, twitter.com/NASA, x.com/i/user/11348282, an intent link with ?screen_name= or ?user_id=). Usernames are case-insensitive. A bare number is a user ID; a number no account has as its ID is looked up as a username, and @ before digits (@123) always means the username. At most 2048 characters. Example: elonmusk" },
|
|
4252
|
+
{ name: "target", type: "string", required: true, description: "The other account (the target): is the source following it, and is it following the source? Any form handle takes. At most 2048 characters. Example: SpaceX" },
|
|
4253
|
+
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
|
4254
|
+
{ name: "fields", type: "string", required: false, description: "Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole." },
|
|
4255
|
+
],
|
|
4256
|
+
get: (c, p, o) => c.x.friendship.get(p, o),
|
|
4257
|
+
},
|
|
4258
|
+
{
|
|
4259
|
+
kind: "get",
|
|
4260
|
+
platform: "x",
|
|
4261
|
+
name: "list",
|
|
4262
|
+
endpoint: "x.list",
|
|
4263
|
+
summary: "List name, owner, exact member and follower counts",
|
|
4264
|
+
price: "1 credit",
|
|
4265
|
+
params: [
|
|
4266
|
+
{ name: "url", type: "string", required: true, description: "The List: its link on x.com or twitter.com (x.com/i/lists/<id>, any of its views such as /members or /followers, the older x.com/<owner>/lists/<name>, mobile hosts, old #! links and any query too) or its numeric ID. At most 2048 characters. Example: https://x.com/i/lists/84839422" },
|
|
4267
|
+
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
|
4268
|
+
{ name: "fields", type: "string", required: false, description: "Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole." },
|
|
4269
|
+
],
|
|
4270
|
+
get: (c, p, o) => c.x.list.get(p, o),
|
|
4271
|
+
},
|
|
4272
|
+
{
|
|
4273
|
+
kind: "list",
|
|
4274
|
+
platform: "x",
|
|
4275
|
+
name: "list_followers",
|
|
4276
|
+
endpoint: "x.list_followers",
|
|
4277
|
+
summary: "Accounts that follow an X List, as full profiles",
|
|
4278
|
+
price: "1 credit",
|
|
4279
|
+
params: [
|
|
4280
|
+
{ name: "url", type: "string", required: true, description: "The List: its link on x.com or twitter.com (x.com/i/lists/<id>, any of its views such as /followers or /members, the older x.com/<owner>/lists/<name>, mobile hosts, old #! links and any query too) or its numeric ID. At most 2048 characters. Example: https://x.com/i/lists/84839422" },
|
|
4281
|
+
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
|
4282
|
+
{ name: "fields", type: "string", required: false, description: "Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole." },
|
|
4283
|
+
{ name: "limit", type: "integer", required: false, description: "Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for. Range: 1 to 200. Default: 200." },
|
|
4284
|
+
{ name: "cursor", type: "string", required: false, description: "page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page." },
|
|
4285
|
+
],
|
|
4286
|
+
list: (c, p, o) => c.x.listFollowers.list(p, o),
|
|
4287
|
+
iterate: (c, p, o) => c.x.listFollowers.iterate(p, o),
|
|
4288
|
+
},
|
|
4190
4289
|
{
|
|
4191
4290
|
kind: "get",
|
|
4192
4291
|
platform: "x",
|
|
@@ -4201,6 +4300,27 @@ export const COMMANDS = [
|
|
|
4201
4300
|
],
|
|
4202
4301
|
get: (c, p, o) => c.x.post.get(p, o),
|
|
4203
4302
|
},
|
|
4303
|
+
{
|
|
4304
|
+
kind: "list",
|
|
4305
|
+
platform: "x",
|
|
4306
|
+
name: "posts",
|
|
4307
|
+
endpoint: "x.posts",
|
|
4308
|
+
summary: "Latest or most liked posts with exact counts",
|
|
4309
|
+
price: "1 credit",
|
|
4310
|
+
params: [
|
|
4311
|
+
{ name: "handle", type: "string", required: true, description: "X account: a username with or without the @ (NASA, @NASA), a numeric user ID (11348282), or a profile link (x.com/NASA or twitter.com/NASA, with or without a tab such as /media, mobile.twitter.com, x.com/i/user/11348282, a Follow-button or intent link such as x.com/intent/user?screen_name=NASA). Usernames are case-insensitive. A bare number is a user ID; a number no account has as its ID is looked up as a username, and @ before digits (@123) always means the username. At most 2048 characters. Example: NASA" },
|
|
4312
|
+
{ name: "sort", type: "string", required: false, description: "Order of the results. newest (default): the latest posts first. popular: X's selection of the account's most liked posts, about a hundred in one page, roughly most liked first. X shows a logged-out visitor one of the two for each account (see the notes), and the other is answered as closely as it can be. One of: newest, popular. Default: newest.", enum: ["newest", "popular"] },
|
|
4313
|
+
{ name: "media", type: "string", required: false, description: "Only the account's own posts (no reposts) with media: any (a photo, video or GIF), image (one or more photos) or video (a video or GIF). All posts and reposts when omitted. A page keeps only those, so it can hold fewer items than limit. One of: any, image, video. Example: video", enum: ["any", "image", "video"] },
|
|
4314
|
+
{ name: "since", type: "string", required: false, description: "Only items at or after this time: RFC 3339 (2026-10-01T12:00:00Z) or a date (2026-10-01, midnight UTC). On newest-first lists, paging stops when it is reached, so later pages are not fetched or charged. Compared with published_at. With sort=newest the walk stops once the list is older than this. Example: 2026-10-01" },
|
|
4315
|
+
{ name: "until", type: "string", required: false, description: "Only items before this time (exclusive): RFC 3339 or a date (midnight UTC). Compared with published_at, filtering every page. Example: 2026-10-08" },
|
|
4316
|
+
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
|
4317
|
+
{ name: "fields", type: "string", required: false, description: "Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole." },
|
|
4318
|
+
{ name: "limit", type: "integer", required: false, description: "Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for. Range: 1 to 100. Default: 100." },
|
|
4319
|
+
{ name: "cursor", type: "string", required: false, description: "page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page." },
|
|
4320
|
+
],
|
|
4321
|
+
list: (c, p, o) => c.x.posts.list(p, o),
|
|
4322
|
+
iterate: (c, p, o) => c.x.posts.iterate(p, o),
|
|
4323
|
+
},
|
|
4204
4324
|
{
|
|
4205
4325
|
kind: "get",
|
|
4206
4326
|
platform: "x",
|
|
@@ -4215,6 +4335,25 @@ export const COMMANDS = [
|
|
|
4215
4335
|
],
|
|
4216
4336
|
get: (c, p, o) => c.x.profile.get(p, o),
|
|
4217
4337
|
},
|
|
4338
|
+
{
|
|
4339
|
+
kind: "list",
|
|
4340
|
+
platform: "x",
|
|
4341
|
+
name: "profile_mentions",
|
|
4342
|
+
endpoint: "x.profile_mentions",
|
|
4343
|
+
summary: "Posts by others that @mention an account",
|
|
4344
|
+
price: "1 credit",
|
|
4345
|
+
params: [
|
|
4346
|
+
{ name: "handle", type: "string", required: true, description: "X account whose mentions to find: a username with or without the @ (NASA, @NASA), a numeric user ID (11348282), or a profile link (x.com/NASA or twitter.com/NASA, with or without a tab such as /media, mobile.twitter.com, x.com/i/user/11348282, an intent link such as x.com/intent/user?screen_name=NASA). Usernames are case-insensitive. A bare number is a user ID; a number no account has as its ID is read as a username. At most 2048 characters. Example: NASA" },
|
|
4347
|
+
{ name: "since", type: "string", required: false, description: "Only items at or after this time: RFC 3339 (2026-10-01T12:00:00Z) or a date (2026-10-01, midnight UTC). On newest-first lists, paging stops when it is reached, so later pages are not fetched or charged. By the post's exact time; the search engine is asked for the same dates, so this also finds recent posts the plain ranking leaves out. A date filter narrows a ranking, not an order: results are still by relevance. Example: 2026-10-01" },
|
|
4348
|
+
{ name: "until", type: "string", required: false, description: "Only items before this time (exclusive): RFC 3339 or a date (midnight UTC). By the post's exact time. Example: 2026-10-08" },
|
|
4349
|
+
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
|
4350
|
+
{ name: "fields", type: "string", required: false, description: "Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole." },
|
|
4351
|
+
{ name: "limit", type: "integer", required: false, description: "Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for. Range: 1 to 20. Default: 20." },
|
|
4352
|
+
{ name: "cursor", type: "string", required: false, description: "page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page." },
|
|
4353
|
+
],
|
|
4354
|
+
list: (c, p, o) => c.x.profileMentions.list(p, o),
|
|
4355
|
+
iterate: (c, p, o) => c.x.profileMentions.iterate(p, o),
|
|
4356
|
+
},
|
|
4218
4357
|
{
|
|
4219
4358
|
kind: "list",
|
|
4220
4359
|
platform: "x",
|
|
@@ -4292,6 +4431,36 @@ export const COMMANDS = [
|
|
|
4292
4431
|
list: (c, p, o) => c.x.searchProfiles.list(p, o),
|
|
4293
4432
|
iterate: (c, p, o) => c.x.searchProfiles.iterate(p, o),
|
|
4294
4433
|
},
|
|
4434
|
+
{
|
|
4435
|
+
kind: "get",
|
|
4436
|
+
platform: "x",
|
|
4437
|
+
name: "space",
|
|
4438
|
+
endpoint: "x.space",
|
|
4439
|
+
summary: "Live audio room with host, listeners and replay",
|
|
4440
|
+
price: "1 credit",
|
|
4441
|
+
params: [
|
|
4442
|
+
{ name: "url", type: "string", required: true, description: "The Space: its link on x.com or twitter.com (x.com/i/spaces/<id>, its /peek view, mobile hosts and any query too) or its ID. At most 2048 characters. Example: https://x.com/i/spaces/1MnxnMDeQLeJO" },
|
|
4443
|
+
{ name: "streams", type: "boolean", required: false, description: "Also return the Space's HLS playlist: in streams while it is live, in platform_specific.x.replay_url once it is over and X keeps the recording. One more upstream request, at the same price." },
|
|
4444
|
+
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
|
4445
|
+
{ name: "fields", type: "string", required: false, description: "Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole." },
|
|
4446
|
+
],
|
|
4447
|
+
get: (c, p, o) => c.x.space.get(p, o),
|
|
4448
|
+
},
|
|
4449
|
+
{
|
|
4450
|
+
kind: "get",
|
|
4451
|
+
platform: "x",
|
|
4452
|
+
name: "transcript",
|
|
4453
|
+
endpoint: "x.transcript",
|
|
4454
|
+
summary: "Video post transcript, from captions or audio",
|
|
4455
|
+
price: "1 credit (captions) or 2 credits + 2 per started minute of media (speech-to-text)",
|
|
4456
|
+
params: [
|
|
4457
|
+
{ name: "url", type: "string", required: true, description: "X video post: a link (x.com or twitter.com, /<username>/status/<id> with or without /video/<n>, which picks the post's nth attachment, /i/web/status/<id>, /i/status/<id>, old /statuses/ and #! links, mobile.twitter.com, fxtwitter.com and vxtwitter.com) or a bare numeric post ID. A repost transcribes the reposted video, and a quote post without a video of its own the video of the post it quotes. At most 2048 characters. Example: https://x.com/TheoVon/status/1916982720317821050" },
|
|
4458
|
+
{ name: "lang", type: "string", required: false, description: "Preferred language: a BCP-47 tag such as en or pt-BR (case-insensitive; _ is read as -). Picks X's caption track in that language when the video has one. X captions a video in its spoken language only, so for another language you get that track, and language says which. For a video X has no captions for, it is the language speech-to-text listens for (detected without it). Example: en" },
|
|
4459
|
+
{ name: "max_age", type: "integer", required: false, description: "Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. Minimum: 0." },
|
|
4460
|
+
{ name: "fields", type: "string", required: false, description: "Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole." },
|
|
4461
|
+
],
|
|
4462
|
+
get: (c, p, o) => c.x.transcript.get(p, o),
|
|
4463
|
+
},
|
|
4295
4464
|
{
|
|
4296
4465
|
kind: "list",
|
|
4297
4466
|
platform: "youtube",
|
package/dist/constants.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** SDK version: 1.<contract facts>.<generator revision> (sdk/README.md). */
|
|
2
|
-
export declare const VERSION = "1.
|
|
2
|
+
export declare const VERSION = "1.571.31";
|
|
3
3
|
/** The production API origin. */
|
|
4
4
|
export declare const DEFAULT_BASE_URL = "https://socialtap.dev";
|
|
5
5
|
/** Environment variable the API key is read from. */
|
package/dist/constants.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Code generated by engine/cmd/gensdk (make gen) from catalog/catalog.gen.json; DO NOT EDIT.
|
|
2
2
|
/** SDK version: 1.<contract facts>.<generator revision> (sdk/README.md). */
|
|
3
|
-
export const VERSION = "1.
|
|
3
|
+
export const VERSION = "1.571.31";
|
|
4
4
|
/** The production API origin. */
|
|
5
5
|
export const DEFAULT_BASE_URL = "https://socialtap.dev";
|
|
6
6
|
/** Environment variable the API key is read from. */
|