socialtap 1.485.28 → 1.506.28
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 +38 -7
- package/dist/client.d.ts +16 -10
- package/dist/client.js +18 -10
- package/dist/commands.js +340 -0
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/dist/models.d.ts +822 -41
- package/dist/resources.d.ts +4770 -3381
- package/dist/resources.js +323 -0
- package/dist/tooldefs.d.ts +1 -1
- package/dist/tooldefs.js +863 -130
- 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.506.28). Docs: https://socialtap.dev/docs.
|
|
9
9
|
|
|
10
10
|
## Install
|
|
11
11
|
|
|
@@ -97,6 +97,16 @@ Every result also carries the envelope `meta` (request ID, source, cache status,
|
|
|
97
97
|
|
|
98
98
|
| endpoint | method | cost |
|
|
99
99
|
|---|---|---|
|
|
100
|
+
| `amazon.deal_products` | `client.amazon.dealProducts.list()` | 1 credit |
|
|
101
|
+
| `amazon.offers` | `client.amazon.offers.list()` | 1 credit |
|
|
102
|
+
| `amazon.product` | `client.amazon.product.get()` | 1 credit |
|
|
103
|
+
| `amazon.reviews` | `client.amazon.reviews.list()` | 1 credit |
|
|
104
|
+
| `amazon.search_products` | `client.amazon.searchProducts.list()` | 1 credit |
|
|
105
|
+
| `amazon.seller` | `client.amazon.seller.get()` | 1 credit |
|
|
106
|
+
| `amazon.shop` | `client.amazon.shop.get()` | 1 credit |
|
|
107
|
+
| `amazon.shop_lists` | `client.amazon.shopLists.list()` | 1 credit |
|
|
108
|
+
| `amazon.shop_posts` | `client.amazon.shopPosts.list()` | 1 credit |
|
|
109
|
+
| `amazon.top_products` | `client.amazon.topProducts.list()` | 1 credit |
|
|
100
110
|
| `applemusic.album` | `client.applemusic.album.get()` | 1 credit |
|
|
101
111
|
| `applemusic.artist` | `client.applemusic.artist.get()` | 1 credit |
|
|
102
112
|
| `applemusic.search_albums` | `client.applemusic.searchAlbums.list()` | 1 credit |
|
|
@@ -188,6 +198,16 @@ Every result also carries the envelope `meta` (request ID, source, cache status,
|
|
|
188
198
|
| `linkme.profile` | `client.linkme.profile.get()` | 1 credit |
|
|
189
199
|
| `linktree.profile` | `client.linktree.profile.get()` | 1 credit |
|
|
190
200
|
| `pillar.page` | `client.pillar.page.get()` | 1 credit |
|
|
201
|
+
| `pinterest.board` | `client.pinterest.board.get()` | 1 credit |
|
|
202
|
+
| `pinterest.board_pins` | `client.pinterest.boardPins.list()` | 1 credit |
|
|
203
|
+
| `pinterest.boards` | `client.pinterest.boards.list()` | 1 credit |
|
|
204
|
+
| `pinterest.pin` | `client.pinterest.pin.get()` | 1 credit |
|
|
205
|
+
| `pinterest.pins` | `client.pinterest.pins.list()` | 1 credit |
|
|
206
|
+
| `pinterest.profile` | `client.pinterest.profile.get()` | 1 credit |
|
|
207
|
+
| `pinterest.search_pins` | `client.pinterest.searchPins.list()` | 1 credit |
|
|
208
|
+
| `pinterest.top_trends` | `client.pinterest.topTrends.list()` | 1 credit |
|
|
209
|
+
| `pinterest.topic` | `client.pinterest.topic.get()` | 1 credit |
|
|
210
|
+
| `pinterest.web_page` | `client.pinterest.webPage.get()` | 1 credit |
|
|
191
211
|
| `reddit.comments` | `client.reddit.comments.list()` | 1 credit |
|
|
192
212
|
| `reddit.engagement` | `client.reddit.engagement.get()` | 1 credit |
|
|
193
213
|
| `reddit.post` | `client.reddit.post.get()` | 1 credit |
|
|
@@ -370,7 +390,7 @@ stopped it) and `endReason` (the API's `page.end_reason`) say what happened.
|
|
|
370
390
|
Each page is checked against its catalog price before it is fetched, and an empty page with `has_more` is not the end.
|
|
371
391
|
|
|
372
392
|
```ts
|
|
373
|
-
const items = client.
|
|
393
|
+
const items = client.amazon.dealProducts.iterate({}, { maxPages: 10, maxCredits: 100 });
|
|
374
394
|
for await (const item of items) {
|
|
375
395
|
console.log(item);
|
|
376
396
|
}
|
|
@@ -489,6 +509,7 @@ console.log(r.isError, r.output);
|
|
|
489
509
|
| `list_community_posts` | Community posts |
|
|
490
510
|
| `list_hashtag_posts` | Hashtag posts |
|
|
491
511
|
| `list_place_posts` | Place posts |
|
|
512
|
+
| `list_playlist_posts` | Playlist posts |
|
|
492
513
|
| `list_reels` | Reels of a profile |
|
|
493
514
|
| `list_sound_posts` | Sound posts |
|
|
494
515
|
| `list_top_posts` | Top posts |
|
|
@@ -497,12 +518,15 @@ console.log(r.isError, r.output);
|
|
|
497
518
|
| `list_effect_posts` | Effect posts |
|
|
498
519
|
| `list_liked_posts` | Liked posts of a profile |
|
|
499
520
|
| `list_photos` | Photos of a profile |
|
|
500
|
-
| `
|
|
521
|
+
| `list_pins` | Pins of a profile |
|
|
501
522
|
| `list_playlist_stories` | Playlist stories |
|
|
502
523
|
| `list_playlist_tracks` | Playlist tracks |
|
|
503
524
|
| `list_podcast_episodes` | Podcast episodes |
|
|
525
|
+
| `list_shop_posts` | Shop posts of a profile |
|
|
504
526
|
| `list_tracks` | Tracks of a profile |
|
|
505
527
|
| `list_videos` | Videos of a profile |
|
|
528
|
+
| `get_seller` | Seller by handle |
|
|
529
|
+
| `get_shop` | Shop by handle |
|
|
506
530
|
| `list_followers` | Followers of a profile |
|
|
507
531
|
| `list_following` | Following of a profile |
|
|
508
532
|
| `list_similar_profiles` | Similar profiles of a profile |
|
|
@@ -516,28 +540,35 @@ console.log(r.isError, r.output);
|
|
|
516
540
|
| `get_hashtag` | Hashtag by link |
|
|
517
541
|
| `list_trending_hashtags` | Trending hashtags |
|
|
518
542
|
| `get_community` | Community by link |
|
|
519
|
-
| `get_album` | Album by link |
|
|
520
543
|
| `get_product` | Product by link |
|
|
544
|
+
| `get_album` | Album by link |
|
|
545
|
+
| `get_playlist` | Playlist by link |
|
|
521
546
|
| `get_sound` | Sound by link |
|
|
547
|
+
| `get_topic` | Topic by link |
|
|
522
548
|
| `get_download` | Download by link |
|
|
523
549
|
| `get_effect` | Effect by link |
|
|
524
550
|
| `get_embed` | Embed by link |
|
|
525
551
|
| `get_event` | Event by link |
|
|
526
552
|
| `get_live` | Live by handle |
|
|
527
553
|
| `get_place` | Place by link |
|
|
528
|
-
| `get_playlist` | Playlist by link |
|
|
529
554
|
| `get_podcast` | Podcast by link |
|
|
530
|
-
| `get_topic` | Topic by link |
|
|
531
555
|
| `get_username` | Username by handle |
|
|
556
|
+
| `get_web_page` | Web page by link |
|
|
557
|
+
| `list_reviews` | Reviews of a product |
|
|
558
|
+
| `list_boards` | Boards of a profile |
|
|
559
|
+
| `list_deal_products` | Deal products |
|
|
532
560
|
| `list_events` | Events of a profile |
|
|
533
561
|
| `list_highlights` | Highlights of a profile |
|
|
562
|
+
| `list_offers` | Offers of a product |
|
|
534
563
|
| `list_place_events` | Place events |
|
|
535
564
|
| `list_playlists` | Playlists of a profile |
|
|
536
565
|
| `list_products` | Products of a profile |
|
|
537
|
-
| `list_reviews` | Reviews of a product |
|
|
538
566
|
| `list_schedule` | Schedule of a profile |
|
|
567
|
+
| `list_shop_lists` | Shop lists of a profile |
|
|
539
568
|
| `list_top_albums` | Top albums |
|
|
540
569
|
| `list_top_playlists` | Top playlists |
|
|
570
|
+
| `list_top_products` | Top products |
|
|
571
|
+
| `list_top_trends` | Top trends |
|
|
541
572
|
| `create_job` | Create a background job |
|
|
542
573
|
| `get_job` | Get a background job |
|
|
543
574
|
| `list_job_results` | List a job's results |
|
package/dist/client.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type ClientOptions, Core } from "./core.ts";
|
|
2
|
-
import { AppleMusic, Bluesky, Facebook, Google, Instagram, Kick, Komi, Kwai, LnkBio, LinkedIn, Linkme, Linktree, Pillar, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, TikTokShop, TruthSocial, Twitch, X, YouTube, AccountResource, UsageResource, CreditTransactionsResource, BillingResource, RequestsResource, ApiKeysResource, JobsResource, WebhookEndpointsResource, EventsResource, NotificationPreferencesResource } from "./resources.ts";
|
|
2
|
+
import { Amazon, AppleMusic, Bluesky, Facebook, Google, Instagram, Kick, Komi, Kwai, LnkBio, LinkedIn, Linkme, Linktree, Pillar, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, TikTokShop, TruthSocial, Twitch, X, YouTube, AccountResource, UsageResource, CreditTransactionsResource, BillingResource, RequestsResource, ApiKeysResource, JobsResource, WebhookEndpointsResource, EventsResource, NotificationPreferencesResource } from "./resources.ts";
|
|
3
3
|
import { Webhooks } from "./webhooks.ts";
|
|
4
4
|
/**
|
|
5
5
|
* The SocialTap API client: `new SocialTap({ apiKey })` (default: the SOCIALTAP_API_KEY environment variable).
|
|
@@ -9,17 +9,21 @@ import { Webhooks } from "./webhooks.ts";
|
|
|
9
9
|
* LinkedIn and TikTok; albums on Apple Music and Spotify; comments on Bluesky, Facebook, Instagram, Reddit,
|
|
10
10
|
* Rumble, Snapchat, Threads, TikTok and YouTube; communities on Facebook, Reddit and X; downloads on TikTok;
|
|
11
11
|
* effects on TikTok; embeds on Instagram; engagement stats on Facebook, Instagram, Reddit, Rumble, TikTok and
|
|
12
|
-
* YouTube; events on Facebook; hashtags on Instagram and TikTok; livestreams on TikTok and Twitch;
|
|
13
|
-
* Facebook and Instagram; playlists on Apple Music, Instagram, Spotify and
|
|
14
|
-
* Apple Music, Bluesky, Facebook, Instagram, Kick, Kwai, LinkedIn,
|
|
15
|
-
* Spotify, Telegram, Threads, TikTok, Truth Social, Twitch, X
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
12
|
+
* YouTube; events on Facebook; hashtags on Instagram and TikTok; livestreams on TikTok and Twitch; offers on
|
|
13
|
+
* Amazon; places on Facebook and Instagram; playlists on Amazon, Apple Music, Instagram, Pinterest, Spotify and
|
|
14
|
+
* TikTok; podcasts on Spotify; posts on Amazon, Apple Music, Bluesky, Facebook, Instagram, Kick, Kwai, LinkedIn,
|
|
15
|
+
* Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth Social, Twitch, X
|
|
16
|
+
* and YouTube; products on Amazon, Facebook and TikTok Shop; profiles on Amazon, Apple Music, Bluesky, Facebook,
|
|
17
|
+
* Google, Instagram, Komi, Kwai, LinkedIn, Linkme, Linktree, Lnk.Bio, Pillar, Pinterest, Reddit, Rumble,
|
|
18
|
+
* Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth Social, Twitch, X and YouTube; reviews on
|
|
19
|
+
* Amazon and TikTok Shop; sounds on Instagram and TikTok; suggestions on Google and Instagram; topics on
|
|
20
|
+
* Instagram and Pinterest; transcripts on Facebook, Instagram, Kick, Reddit, Rumble, TikTok, Twitch and YouTube;
|
|
21
|
+
* trends on Pinterest; usernames on Instagram; web pages on Pinterest; web results on Facebook, Instagram,
|
|
22
|
+
* LinkedIn, Telegram, TikTok and X.
|
|
21
23
|
*/
|
|
22
24
|
export declare class SocialTap extends Core {
|
|
25
|
+
/** Amazon endpoints. */
|
|
26
|
+
readonly amazon: Amazon;
|
|
23
27
|
/** Apple Music endpoints. */
|
|
24
28
|
readonly applemusic: AppleMusic;
|
|
25
29
|
/** Bluesky endpoints. */
|
|
@@ -46,6 +50,8 @@ export declare class SocialTap extends Core {
|
|
|
46
50
|
readonly linktree: Linktree;
|
|
47
51
|
/** Pillar endpoints. */
|
|
48
52
|
readonly pillar: Pillar;
|
|
53
|
+
/** Pinterest endpoints. */
|
|
54
|
+
readonly pinterest: Pinterest;
|
|
49
55
|
/** Reddit endpoints. */
|
|
50
56
|
readonly reddit: Reddit;
|
|
51
57
|
/** Rumble endpoints. */
|
package/dist/client.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
|
import { Core } from "./core.js";
|
|
3
|
-
import { AppleMusic, Bluesky, Facebook, Google, Instagram, Kick, Komi, Kwai, LnkBio, LinkedIn, Linkme, Linktree, Pillar, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, TikTokShop, TruthSocial, Twitch, X, YouTube, AccountResource, UsageResource, CreditTransactionsResource, BillingResource, RequestsResource, ApiKeysResource, JobsResource, WebhookEndpointsResource, EventsResource, NotificationPreferencesResource } from "./resources.js";
|
|
3
|
+
import { Amazon, AppleMusic, Bluesky, Facebook, Google, Instagram, Kick, Komi, Kwai, LnkBio, LinkedIn, Linkme, Linktree, Pillar, Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, TikTokShop, TruthSocial, Twitch, X, YouTube, AccountResource, UsageResource, CreditTransactionsResource, BillingResource, RequestsResource, ApiKeysResource, JobsResource, WebhookEndpointsResource, EventsResource, NotificationPreferencesResource } from "./resources.js";
|
|
4
4
|
import { Webhooks } from "./webhooks.js";
|
|
5
5
|
/**
|
|
6
6
|
* The SocialTap API client: `new SocialTap({ apiKey })` (default: the SOCIALTAP_API_KEY environment variable).
|
|
@@ -10,17 +10,21 @@ import { Webhooks } from "./webhooks.js";
|
|
|
10
10
|
* LinkedIn and TikTok; albums on Apple Music and Spotify; comments on Bluesky, Facebook, Instagram, Reddit,
|
|
11
11
|
* Rumble, Snapchat, Threads, TikTok and YouTube; communities on Facebook, Reddit and X; downloads on TikTok;
|
|
12
12
|
* effects on TikTok; embeds on Instagram; engagement stats on Facebook, Instagram, Reddit, Rumble, TikTok and
|
|
13
|
-
* YouTube; events on Facebook; hashtags on Instagram and TikTok; livestreams on TikTok and Twitch;
|
|
14
|
-
* Facebook and Instagram; playlists on Apple Music, Instagram, Spotify and
|
|
15
|
-
* Apple Music, Bluesky, Facebook, Instagram, Kick, Kwai, LinkedIn,
|
|
16
|
-
* Spotify, Telegram, Threads, TikTok, Truth Social, Twitch, X
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
13
|
+
* YouTube; events on Facebook; hashtags on Instagram and TikTok; livestreams on TikTok and Twitch; offers on
|
|
14
|
+
* Amazon; places on Facebook and Instagram; playlists on Amazon, Apple Music, Instagram, Pinterest, Spotify and
|
|
15
|
+
* TikTok; podcasts on Spotify; posts on Amazon, Apple Music, Bluesky, Facebook, Instagram, Kick, Kwai, LinkedIn,
|
|
16
|
+
* Pinterest, Reddit, Rumble, Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth Social, Twitch, X
|
|
17
|
+
* and YouTube; products on Amazon, Facebook and TikTok Shop; profiles on Amazon, Apple Music, Bluesky, Facebook,
|
|
18
|
+
* Google, Instagram, Komi, Kwai, LinkedIn, Linkme, Linktree, Lnk.Bio, Pillar, Pinterest, Reddit, Rumble,
|
|
19
|
+
* Snapchat, SoundCloud, Spotify, Telegram, Threads, TikTok, Truth Social, Twitch, X and YouTube; reviews on
|
|
20
|
+
* Amazon and TikTok Shop; sounds on Instagram and TikTok; suggestions on Google and Instagram; topics on
|
|
21
|
+
* Instagram and Pinterest; transcripts on Facebook, Instagram, Kick, Reddit, Rumble, TikTok, Twitch and YouTube;
|
|
22
|
+
* trends on Pinterest; usernames on Instagram; web pages on Pinterest; web results on Facebook, Instagram,
|
|
23
|
+
* LinkedIn, Telegram, TikTok and X.
|
|
22
24
|
*/
|
|
23
25
|
export class SocialTap extends Core {
|
|
26
|
+
/** Amazon endpoints. */
|
|
27
|
+
amazon;
|
|
24
28
|
/** Apple Music endpoints. */
|
|
25
29
|
applemusic;
|
|
26
30
|
/** Bluesky endpoints. */
|
|
@@ -47,6 +51,8 @@ export class SocialTap extends Core {
|
|
|
47
51
|
linktree;
|
|
48
52
|
/** Pillar endpoints. */
|
|
49
53
|
pillar;
|
|
54
|
+
/** Pinterest endpoints. */
|
|
55
|
+
pinterest;
|
|
50
56
|
/** Reddit endpoints. */
|
|
51
57
|
reddit;
|
|
52
58
|
/** Rumble endpoints. */
|
|
@@ -103,6 +109,7 @@ export class SocialTap extends Core {
|
|
|
103
109
|
webhooks = new Webhooks();
|
|
104
110
|
constructor(options = {}) {
|
|
105
111
|
super(options);
|
|
112
|
+
this.amazon = new Amazon(this);
|
|
106
113
|
this.applemusic = new AppleMusic(this);
|
|
107
114
|
this.bluesky = new Bluesky(this);
|
|
108
115
|
this.facebook = new Facebook(this);
|
|
@@ -116,6 +123,7 @@ export class SocialTap extends Core {
|
|
|
116
123
|
this.linkme = new Linkme(this);
|
|
117
124
|
this.linktree = new Linktree(this);
|
|
118
125
|
this.pillar = new Pillar(this);
|
|
126
|
+
this.pinterest = new Pinterest(this);
|
|
119
127
|
this.reddit = new Reddit(this);
|
|
120
128
|
this.rumble = new Rumble(this);
|
|
121
129
|
this.snapchat = new Snapchat(this);
|