socialcrawl-mcp 1.0.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.
Files changed (51) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +135 -0
  3. package/dist/__tests__/client.test.d.ts +1 -0
  4. package/dist/__tests__/client.test.js +72 -0
  5. package/dist/__tests__/client.test.js.map +1 -0
  6. package/dist/__tests__/data-integrity.test.d.ts +1 -0
  7. package/dist/__tests__/data-integrity.test.js +107 -0
  8. package/dist/__tests__/data-integrity.test.js.map +1 -0
  9. package/dist/__tests__/preflight.test.d.ts +1 -0
  10. package/dist/__tests__/preflight.test.js +28 -0
  11. package/dist/__tests__/preflight.test.js.map +1 -0
  12. package/dist/__tests__/truncation.test.d.ts +1 -0
  13. package/dist/__tests__/truncation.test.js +36 -0
  14. package/dist/__tests__/truncation.test.js.map +1 -0
  15. package/dist/client.d.ts +7 -0
  16. package/dist/client.js +86 -0
  17. package/dist/client.js.map +1 -0
  18. package/dist/constants.d.ts +5 -0
  19. package/dist/constants.js +10 -0
  20. package/dist/constants.js.map +1 -0
  21. package/dist/data/docs.d.ts +3 -0
  22. package/dist/data/docs.js +2621 -0
  23. package/dist/data/docs.js.map +1 -0
  24. package/dist/data/endpoints.d.ts +4 -0
  25. package/dist/data/endpoints.js +1385 -0
  26. package/dist/data/endpoints.js.map +1 -0
  27. package/dist/data/platforms.d.ts +4 -0
  28. package/dist/data/platforms.js +135 -0
  29. package/dist/data/platforms.js.map +1 -0
  30. package/dist/index.d.ts +2 -0
  31. package/dist/index.js +82 -0
  32. package/dist/index.js.map +1 -0
  33. package/dist/schemas/tools.d.ts +29 -0
  34. package/dist/schemas/tools.js +30 -0
  35. package/dist/schemas/tools.js.map +1 -0
  36. package/dist/tools/get-docs.d.ts +1 -0
  37. package/dist/tools/get-docs.js +19 -0
  38. package/dist/tools/get-docs.js.map +1 -0
  39. package/dist/tools/list-endpoints.d.ts +1 -0
  40. package/dist/tools/list-endpoints.js +40 -0
  41. package/dist/tools/list-endpoints.js.map +1 -0
  42. package/dist/tools/list-platforms.d.ts +1 -0
  43. package/dist/tools/list-platforms.js +17 -0
  44. package/dist/tools/list-platforms.js.map +1 -0
  45. package/dist/tools/request.d.ts +7 -0
  46. package/dist/tools/request.js +43 -0
  47. package/dist/tools/request.js.map +1 -0
  48. package/dist/types.d.ts +45 -0
  49. package/dist/types.js +2 -0
  50. package/dist/types.js.map +1 -0
  51. package/package.json +55 -0
@@ -0,0 +1,2621 @@
1
+ export const DOCS = {
2
+ overview: `# SocialCrawl API
3
+
4
+ Unified social media data API. One API key, one response format, 24+ platforms.
5
+
6
+ ## Base URL
7
+
8
+ https://socialcrawl.com/v1
9
+
10
+ ## Authentication
11
+
12
+ Pass your API key in the \`x-api-key\` header with every request.
13
+
14
+ ## Platforms
15
+
16
+ - amazon (1 endpoint)
17
+ - facebook (12 endpoints)
18
+ - google (4 endpoints)
19
+ - instagram (12 endpoints)
20
+ - kick (1 endpoint)
21
+ - komi (1 endpoint)
22
+ - linkbio (1 endpoint)
23
+ - linkedin (6 endpoints)
24
+ - linkme (1 endpoint)
25
+ - linktree (1 endpoint)
26
+ - pillar (1 endpoint)
27
+ - pinterest (4 endpoints)
28
+ - reddit (7 endpoints)
29
+ - snapchat (1 endpoint)
30
+ - threads (5 endpoints)
31
+ - tiktok (24 endpoints)
32
+ - truthsocial (3 endpoints)
33
+ - twitch (2 endpoints)
34
+ - twitter (6 endpoints)
35
+ - utility (1 endpoint)
36
+ - youtube (11 endpoints)
37
+
38
+ ## Credits
39
+
40
+ - Standard: 1 credit per request
41
+ - Advanced: 5 credits per request
42
+ - Premium: 10 credits per request
43
+
44
+ All endpoints currently cost 1 credit (standard tier).
45
+
46
+ ## Full Reference
47
+
48
+ For complete endpoint documentation with parameters, examples, and response schemas:
49
+ https://socialcrawl.com/llms-full.txt
50
+
51
+ ## OpenAPI Spec
52
+
53
+ https://socialcrawl.com/v1/openapi.json`,
54
+ full: `# SocialCrawl API — Full Reference
55
+
56
+ ## Base URL: https://socialcrawl.com/v1
57
+
58
+ ## Authentication
59
+
60
+ Every request requires an \`x-api-key\` header:
61
+
62
+ \`\`\`
63
+ curl https://socialcrawl.com/v1/tiktok/profile?handle=charlidamelio \\
64
+ -H "x-api-key: sc_your_api_key_here"
65
+ \`\`\`
66
+
67
+ ## Response Format
68
+
69
+ All responses follow this envelope:
70
+
71
+ \`\`\`json
72
+ {
73
+ "success": true,
74
+ "platform": "tiktok",
75
+ "endpoint": "/v1/tiktok/profile",
76
+ "data": { ... },
77
+ "credits_used": 1,
78
+ "credits_remaining": 4999,
79
+ "request_id": "req-XXXXX",
80
+ "cached": false
81
+ }
82
+ \`\`\`
83
+
84
+ ---
85
+
86
+ ## Amazon
87
+
88
+ ### GET /amazon/shop
89
+
90
+ Get Amazon shop page
91
+
92
+ Credit cost: 1 (standard)
93
+
94
+ Parameters:
95
+ - \`url\` (required): Full URL of the Amazon shop or storefront page. Example: \`https://www.amazon.com/shop/influencer123\`
96
+
97
+ \`\`\`
98
+ curl "https://socialcrawl.com/v1/amazon/shop?url=https://www.amazon.com/shop/influencer123" \\
99
+ -H "x-api-key: sc_your_api_key_here"
100
+ \`\`\`
101
+
102
+ ---
103
+
104
+ ## Facebook
105
+
106
+ ### GET /facebook/profile
107
+
108
+ Get Facebook page profile
109
+
110
+ Credit cost: 1 (standard)
111
+
112
+ Parameters:
113
+ - \`url\` (required): Full URL of the Facebook page or profile. Example: \`https://www.facebook.com/Meta\`
114
+
115
+ \`\`\`
116
+ curl "https://socialcrawl.com/v1/facebook/profile?url=https://www.facebook.com/Meta" \\
117
+ -H "x-api-key: sc_your_api_key_here"
118
+ \`\`\`
119
+
120
+ ### GET /facebook/profile/posts
121
+
122
+ List Facebook page posts
123
+
124
+ Credit cost: 1 (standard)
125
+
126
+ Parameters:
127
+ - \`url\` (required): Full URL of the Facebook page or profile to fetch posts for. Example: \`https://www.facebook.com/Meta\`
128
+
129
+ \`\`\`
130
+ curl "https://socialcrawl.com/v1/facebook/profile/posts?url=https://www.facebook.com/Meta" \\
131
+ -H "x-api-key: sc_your_api_key_here"
132
+ \`\`\`
133
+
134
+ ### GET /facebook/post
135
+
136
+ Get Facebook post details
137
+
138
+ Credit cost: 1 (standard)
139
+
140
+ Parameters:
141
+ - \`url\` (required): Full URL of the Facebook post. Example: \`https://www.facebook.com/Meta/posts/1234567890\`
142
+
143
+ \`\`\`
144
+ curl "https://socialcrawl.com/v1/facebook/post?url=https://www.facebook.com/Meta/posts/1234567890" \\
145
+ -H "x-api-key: sc_your_api_key_here"
146
+ \`\`\`
147
+
148
+ ### GET /facebook/post/comments
149
+
150
+ List Facebook post comments
151
+
152
+ Credit cost: 1 (standard)
153
+
154
+ Parameters:
155
+ - \`url\` (required): Full URL of the Facebook post to fetch comments for. Example: \`https://www.facebook.com/Meta/posts/1234567890\`
156
+
157
+ \`\`\`
158
+ curl "https://socialcrawl.com/v1/facebook/post/comments?url=https://www.facebook.com/Meta/posts/1234567890" \\
159
+ -H "x-api-key: sc_your_api_key_here"
160
+ \`\`\`
161
+
162
+ ### GET /facebook/group/posts
163
+
164
+ List Facebook group posts
165
+
166
+ Credit cost: 1 (standard)
167
+
168
+ Parameters:
169
+ - \`url\` (required): Full URL of the Facebook group. Example: \`https://www.facebook.com/groups/reactjs/\`
170
+
171
+ \`\`\`
172
+ curl "https://socialcrawl.com/v1/facebook/group/posts?url=https://www.facebook.com/groups/reactjs/" \\
173
+ -H "x-api-key: sc_your_api_key_here"
174
+ \`\`\`
175
+
176
+ ### GET /facebook/post/transcript
177
+
178
+ Get Facebook video transcript
179
+
180
+ Credit cost: 10 (premium)
181
+
182
+ Parameters:
183
+ - \`url\` (required): Full URL of the Facebook video post. Example: \`https://www.facebook.com/Meta/videos/1234567890\`
184
+
185
+ \`\`\`
186
+ curl "https://socialcrawl.com/v1/facebook/post/transcript?url=https://www.facebook.com/Meta/videos/1234567890" \\
187
+ -H "x-api-key: sc_your_api_key_here"
188
+ \`\`\`
189
+
190
+ ### GET /facebook/profile/photos
191
+
192
+ List Facebook profile photos
193
+
194
+ Credit cost: 1 (standard)
195
+
196
+ Parameters:
197
+ - \`url\` (required): Full URL of the Facebook page or profile. Example: \`https://www.facebook.com/Meta\`
198
+
199
+ \`\`\`
200
+ curl "https://socialcrawl.com/v1/facebook/profile/photos?url=https://www.facebook.com/Meta" \\
201
+ -H "x-api-key: sc_your_api_key_here"
202
+ \`\`\`
203
+
204
+ ### GET /facebook/profile/reels
205
+
206
+ List Facebook profile reels
207
+
208
+ Credit cost: 1 (standard)
209
+
210
+ Parameters:
211
+ - \`url\` (required): Full URL of the Facebook page or profile. Example: \`https://www.facebook.com/Meta\`
212
+
213
+ \`\`\`
214
+ curl "https://socialcrawl.com/v1/facebook/profile/reels?url=https://www.facebook.com/Meta" \\
215
+ -H "x-api-key: sc_your_api_key_here"
216
+ \`\`\`
217
+
218
+ ### GET /facebook/adlibrary/ad
219
+
220
+ Get Facebook Ad Library ad details
221
+
222
+ Credit cost: 5 (advanced)
223
+
224
+ Parameters:
225
+ - \`id\` (required): Facebook Ad Library ad ID. Example: \`23851234567890123\`
226
+
227
+ \`\`\`
228
+ curl "https://socialcrawl.com/v1/facebook/adlibrary/ad?id=23851234567890123" \\
229
+ -H "x-api-key: sc_your_api_key_here"
230
+ \`\`\`
231
+
232
+ ### GET /facebook/adlibrary/company/ads
233
+
234
+ List Facebook Ad Library company ads
235
+
236
+ Credit cost: 5 (advanced)
237
+
238
+ Parameters:
239
+ - \`pageId\` (required): Facebook page ID of the advertiser. Example: \`20531316728\`
240
+
241
+ \`\`\`
242
+ curl "https://socialcrawl.com/v1/facebook/adlibrary/company/ads?pageId=20531316728" \\
243
+ -H "x-api-key: sc_your_api_key_here"
244
+ \`\`\`
245
+
246
+ ### GET /facebook/adlibrary/search/ads
247
+
248
+ Search Facebook Ad Library
249
+
250
+ Credit cost: 5 (advanced)
251
+
252
+ Parameters:
253
+ - \`query\` (required): Search keyword or phrase to find ads in the Facebook Ad Library. Example: \`artificial intelligence\`
254
+
255
+ \`\`\`
256
+ curl "https://socialcrawl.com/v1/facebook/adlibrary/search/ads?query=artificial intelligence" \\
257
+ -H "x-api-key: sc_your_api_key_here"
258
+ \`\`\`
259
+
260
+ ### GET /facebook/adlibrary/search/companies
261
+
262
+ Search Facebook Ad Library companies
263
+
264
+ Credit cost: 5 (advanced)
265
+
266
+ Parameters:
267
+ - \`query\` (required): Search keyword or phrase to find companies in the Facebook Ad Library. Example: \`Nike\`
268
+
269
+ \`\`\`
270
+ curl "https://socialcrawl.com/v1/facebook/adlibrary/search/companies?query=Nike" \\
271
+ -H "x-api-key: sc_your_api_key_here"
272
+ \`\`\`
273
+
274
+ ---
275
+
276
+ ## Google
277
+
278
+ ### GET /google/search
279
+
280
+ Google web search
281
+
282
+ Credit cost: 1 (standard)
283
+
284
+ Parameters:
285
+ - \`query\` (required): Search keyword or phrase. Example: \`best restaurants in London\`
286
+
287
+ \`\`\`
288
+ curl "https://socialcrawl.com/v1/google/search?query=best restaurants in London" \\
289
+ -H "x-api-key: sc_your_api_key_here"
290
+ \`\`\`
291
+
292
+ ### GET /google/ad
293
+
294
+ Get Google ad details
295
+
296
+ Credit cost: 5 (advanced)
297
+
298
+ Parameters:
299
+ - \`url\` (required): Full URL of the Google ad or Ads Transparency Center page. Example: \`https://adstransparency.google.com/advertiser/AR12345678901234567\`
300
+
301
+ \`\`\`
302
+ curl "https://socialcrawl.com/v1/google/ad?url=https://adstransparency.google.com/advertiser/AR12345678901234567" \\
303
+ -H "x-api-key: sc_your_api_key_here"
304
+ \`\`\`
305
+
306
+ ### GET /google/adlibrary/advertisers/search
307
+
308
+ Search Google Ad Library advertisers
309
+
310
+ Credit cost: 5 (advanced)
311
+
312
+ Parameters:
313
+ - \`query\` (required): Search keyword or phrase to find advertisers in the Google Ads Transparency Center. Example: \`Nike\`
314
+
315
+ \`\`\`
316
+ curl "https://socialcrawl.com/v1/google/adlibrary/advertisers/search?query=Nike" \\
317
+ -H "x-api-key: sc_your_api_key_here"
318
+ \`\`\`
319
+
320
+ ### GET /google/company/ads
321
+
322
+ List Google ads by company
323
+
324
+ Credit cost: 5 (advanced)
325
+
326
+ Parameters:
327
+ - \`domain\` (required): Company domain name to look up ads for. Example: \`nike.com\`
328
+
329
+ \`\`\`
330
+ curl "https://socialcrawl.com/v1/google/company/ads?domain=nike.com" \\
331
+ -H "x-api-key: sc_your_api_key_here"
332
+ \`\`\`
333
+
334
+ ---
335
+
336
+ ## Instagram
337
+
338
+ ### GET /instagram/profile
339
+
340
+ Get Instagram user profile
341
+
342
+ Credit cost: 1 (standard)
343
+
344
+ Parameters:
345
+ - \`handle\` (required): Instagram username without the @ symbol. Example: \`instagram\`
346
+
347
+ \`\`\`
348
+ curl "https://socialcrawl.com/v1/instagram/profile?handle=instagram" \\
349
+ -H "x-api-key: sc_your_api_key_here"
350
+ \`\`\`
351
+
352
+ ### GET /instagram/profile/posts
353
+
354
+ List Instagram user posts
355
+
356
+ Credit cost: 1 (standard)
357
+
358
+ Parameters:
359
+ - \`handle\` (required): Instagram username without the @ symbol. Example: \`instagram\`
360
+
361
+ \`\`\`
362
+ curl "https://socialcrawl.com/v1/instagram/profile/posts?handle=instagram" \\
363
+ -H "x-api-key: sc_your_api_key_here"
364
+ \`\`\`
365
+
366
+ ### GET /instagram/post
367
+
368
+ Get Instagram post details
369
+
370
+ Credit cost: 1 (standard)
371
+
372
+ Parameters:
373
+ - \`url\` (required): Full URL of the Instagram post. Example: \`https://www.instagram.com/p/CwA1234abcd/\`
374
+
375
+ \`\`\`
376
+ curl "https://socialcrawl.com/v1/instagram/post?url=https://www.instagram.com/p/CwA1234abcd/" \\
377
+ -H "x-api-key: sc_your_api_key_here"
378
+ \`\`\`
379
+
380
+ ### GET /instagram/post/comments
381
+
382
+ List Instagram post comments
383
+
384
+ Credit cost: 1 (standard)
385
+
386
+ Parameters:
387
+ - \`url\` (required): Full URL of the Instagram post to fetch comments for. Example: \`https://www.instagram.com/p/CwA1234abcd/\`
388
+
389
+ \`\`\`
390
+ curl "https://socialcrawl.com/v1/instagram/post/comments?url=https://www.instagram.com/p/CwA1234abcd/" \\
391
+ -H "x-api-key: sc_your_api_key_here"
392
+ \`\`\`
393
+
394
+ ### GET /instagram/basic-profile
395
+
396
+ Get Instagram basic profile
397
+
398
+ Credit cost: 1 (standard)
399
+
400
+ Parameters:
401
+ - \`userId\` (required): Instagram numeric user ID. Example: \`25025320\`
402
+
403
+ \`\`\`
404
+ curl "https://socialcrawl.com/v1/instagram/basic-profile?userId=25025320" \\
405
+ -H "x-api-key: sc_your_api_key_here"
406
+ \`\`\`
407
+
408
+ ### GET /instagram/profile/reels
409
+
410
+ List Instagram user reels
411
+
412
+ Credit cost: 1 (standard)
413
+
414
+ Parameters:
415
+ - \`handle\` (required): Instagram username without the @ symbol. Example: \`instagram\`
416
+
417
+ \`\`\`
418
+ curl "https://socialcrawl.com/v1/instagram/profile/reels?handle=instagram" \\
419
+ -H "x-api-key: sc_your_api_key_here"
420
+ \`\`\`
421
+
422
+ ### GET /instagram/highlights
423
+
424
+ List Instagram story highlights
425
+
426
+ Credit cost: 1 (standard)
427
+
428
+ Parameters:
429
+ - \`handle\` (required): Instagram username without the @ symbol. Example: \`instagram\`
430
+
431
+ \`\`\`
432
+ curl "https://socialcrawl.com/v1/instagram/highlights?handle=instagram" \\
433
+ -H "x-api-key: sc_your_api_key_here"
434
+ \`\`\`
435
+
436
+ ### GET /instagram/highlight/detail
437
+
438
+ Get Instagram highlight detail
439
+
440
+ Credit cost: 1 (standard)
441
+
442
+ Parameters:
443
+ - \`id\` (required): Instagram highlight ID. Example: \`17854360229135492\`
444
+
445
+ \`\`\`
446
+ curl "https://socialcrawl.com/v1/instagram/highlight/detail?id=17854360229135492" \\
447
+ -H "x-api-key: sc_your_api_key_here"
448
+ \`\`\`
449
+
450
+ ### GET /instagram/search/reels
451
+
452
+ Search Instagram reels
453
+
454
+ Credit cost: 1 (standard)
455
+
456
+ Parameters:
457
+ - \`query\` (required): Search keyword or phrase to find Instagram reels. Example: \`workout routine\`
458
+
459
+ \`\`\`
460
+ curl "https://socialcrawl.com/v1/instagram/search/reels?query=workout routine" \\
461
+ -H "x-api-key: sc_your_api_key_here"
462
+ \`\`\`
463
+
464
+ ### GET /instagram/media/transcript
465
+
466
+ Get Instagram media transcript
467
+
468
+ Credit cost: 10 (premium)
469
+
470
+ Parameters:
471
+ - \`url\` (required): Full URL of the Instagram video or reel. Example: \`https://www.instagram.com/reel/CwA1234abcd/\`
472
+
473
+ \`\`\`
474
+ curl "https://socialcrawl.com/v1/instagram/media/transcript?url=https://www.instagram.com/reel/CwA1234abcd/" \\
475
+ -H "x-api-key: sc_your_api_key_here"
476
+ \`\`\`
477
+
478
+ ### GET /instagram/user/embed
479
+
480
+ Get Instagram user embed HTML
481
+
482
+ Credit cost: 1 (standard)
483
+
484
+ Parameters:
485
+ - \`handle\` (required): Instagram username without the @ symbol. Example: \`instagram\`
486
+
487
+ \`\`\`
488
+ curl "https://socialcrawl.com/v1/instagram/user/embed?handle=instagram" \\
489
+ -H "x-api-key: sc_your_api_key_here"
490
+ \`\`\`
491
+
492
+ ### GET /instagram/song/reels
493
+
494
+ List Instagram reels using a song
495
+
496
+ Credit cost: 1 (standard)
497
+
498
+ Parameters:
499
+ - \`audio_id\` (required): Instagram audio/song ID. Example: \`243313786724210\`
500
+
501
+ \`\`\`
502
+ curl "https://socialcrawl.com/v1/instagram/song/reels?audio_id=243313786724210" \\
503
+ -H "x-api-key: sc_your_api_key_here"
504
+ \`\`\`
505
+
506
+ ---
507
+
508
+ ## Kick
509
+
510
+ ### GET /kick/clip
511
+
512
+ Get Kick clip details
513
+
514
+ Credit cost: 1 (standard)
515
+
516
+ Parameters:
517
+ - \`url\` (required): Full URL of the Kick clip. Example: \`https://kick.com/xqc/clips/clip_abc123\`
518
+
519
+ \`\`\`
520
+ curl "https://socialcrawl.com/v1/kick/clip?url=https://kick.com/xqc/clips/clip_abc123" \\
521
+ -H "x-api-key: sc_your_api_key_here"
522
+ \`\`\`
523
+
524
+ ---
525
+
526
+ ## Komi
527
+
528
+ ### GET /komi/page
529
+
530
+ Get Komi page
531
+
532
+ Credit cost: 1 (standard)
533
+
534
+ Parameters:
535
+ - \`url\` (required): Full URL of the Komi page. Example: \`https://komi.io/example\`
536
+
537
+ \`\`\`
538
+ curl "https://socialcrawl.com/v1/komi/page?url=https://komi.io/example" \\
539
+ -H "x-api-key: sc_your_api_key_here"
540
+ \`\`\`
541
+
542
+ ---
543
+
544
+ ## Linkbio
545
+
546
+ ### GET /linkbio/page
547
+
548
+ Get Linkbio page
549
+
550
+ Credit cost: 1 (standard)
551
+
552
+ Parameters:
553
+ - \`url\` (required): Full URL of the Linkbio page. Example: \`https://lnk.bio/example\`
554
+
555
+ \`\`\`
556
+ curl "https://socialcrawl.com/v1/linkbio/page?url=https://lnk.bio/example" \\
557
+ -H "x-api-key: sc_your_api_key_here"
558
+ \`\`\`
559
+
560
+ ---
561
+
562
+ ## Linkedin
563
+
564
+ ### GET /linkedin/profile
565
+
566
+ Get LinkedIn user profile
567
+
568
+ Credit cost: 1 (standard)
569
+
570
+ Parameters:
571
+ - \`url\` (required): Full URL of the LinkedIn profile page. Example: \`https://www.linkedin.com/in/williamhgates/\`
572
+
573
+ \`\`\`
574
+ curl "https://socialcrawl.com/v1/linkedin/profile?url=https://www.linkedin.com/in/williamhgates/" \\
575
+ -H "x-api-key: sc_your_api_key_here"
576
+ \`\`\`
577
+
578
+ ### GET /linkedin/company
579
+
580
+ Get LinkedIn company page
581
+
582
+ Credit cost: 1 (standard)
583
+
584
+ Parameters:
585
+ - \`url\` (required): Full URL of the LinkedIn company page. Example: \`https://www.linkedin.com/company/microsoft/\`
586
+
587
+ \`\`\`
588
+ curl "https://socialcrawl.com/v1/linkedin/company?url=https://www.linkedin.com/company/microsoft/" \\
589
+ -H "x-api-key: sc_your_api_key_here"
590
+ \`\`\`
591
+
592
+ ### GET /linkedin/post
593
+
594
+ Get LinkedIn post details
595
+
596
+ Credit cost: 1 (standard)
597
+
598
+ Parameters:
599
+ - \`url\` (required): Full URL of the LinkedIn post. Example: \`https://www.linkedin.com/posts/williamhgates_example-activity-1234567890\`
600
+
601
+ \`\`\`
602
+ curl "https://socialcrawl.com/v1/linkedin/post?url=https://www.linkedin.com/posts/williamhgates_example-activity-1234567890" \\
603
+ -H "x-api-key: sc_your_api_key_here"
604
+ \`\`\`
605
+
606
+ ### GET /linkedin/company/posts
607
+
608
+ List LinkedIn company posts
609
+
610
+ Credit cost: 1 (standard)
611
+
612
+ Parameters:
613
+ - \`url\` (required): Full URL of the LinkedIn company page. Example: \`https://www.linkedin.com/company/microsoft/\`
614
+
615
+ \`\`\`
616
+ curl "https://socialcrawl.com/v1/linkedin/company/posts?url=https://www.linkedin.com/company/microsoft/" \\
617
+ -H "x-api-key: sc_your_api_key_here"
618
+ \`\`\`
619
+
620
+ ### GET /linkedin/ad
621
+
622
+ Get LinkedIn ad details
623
+
624
+ Credit cost: 5 (advanced)
625
+
626
+ Parameters:
627
+ - \`url\` (required): Full URL of the LinkedIn ad. Example: \`https://www.linkedin.com/ad/library/detail/12345\`
628
+
629
+ \`\`\`
630
+ curl "https://socialcrawl.com/v1/linkedin/ad?url=https://www.linkedin.com/ad/library/detail/12345" \\
631
+ -H "x-api-key: sc_your_api_key_here"
632
+ \`\`\`
633
+
634
+ ### GET /linkedin/ads/search
635
+
636
+ Search LinkedIn ads
637
+
638
+ Credit cost: 5 (advanced)
639
+
640
+ Parameters:
641
+ - \`company\` (required): Company name or LinkedIn company page URL to search ads for. Example: \`Microsoft\`
642
+
643
+ \`\`\`
644
+ curl "https://socialcrawl.com/v1/linkedin/ads/search?company=Microsoft" \\
645
+ -H "x-api-key: sc_your_api_key_here"
646
+ \`\`\`
647
+
648
+ ---
649
+
650
+ ## Linkme
651
+
652
+ ### GET /linkme/page
653
+
654
+ Get Linkme profile
655
+
656
+ Credit cost: 1 (standard)
657
+
658
+ Parameters:
659
+ - \`url\` (required): Full URL of the Linkme page. Example: \`https://linkme.bio/example\`
660
+
661
+ \`\`\`
662
+ curl "https://socialcrawl.com/v1/linkme/page?url=https://linkme.bio/example" \\
663
+ -H "x-api-key: sc_your_api_key_here"
664
+ \`\`\`
665
+
666
+ ---
667
+
668
+ ## Linktree
669
+
670
+ ### GET /linktree/page
671
+
672
+ Get Linktree page
673
+
674
+ Credit cost: 1 (standard)
675
+
676
+ Parameters:
677
+ - \`url\` (required): Full URL of the Linktree page. Example: \`https://linktr.ee/charlidamelio\`
678
+
679
+ \`\`\`
680
+ curl "https://socialcrawl.com/v1/linktree/page?url=https://linktr.ee/charlidamelio" \\
681
+ -H "x-api-key: sc_your_api_key_here"
682
+ \`\`\`
683
+
684
+ ---
685
+
686
+ ## Pillar
687
+
688
+ ### GET /pillar/page
689
+
690
+ Get Pillar page
691
+
692
+ Credit cost: 1 (standard)
693
+
694
+ Parameters:
695
+ - \`url\` (required): Full URL of the Pillar page. Example: \`https://pillar.io/example\`
696
+
697
+ \`\`\`
698
+ curl "https://socialcrawl.com/v1/pillar/page?url=https://pillar.io/example" \\
699
+ -H "x-api-key: sc_your_api_key_here"
700
+ \`\`\`
701
+
702
+ ---
703
+
704
+ ## Pinterest
705
+
706
+ ### GET /pinterest/search
707
+
708
+ Search Pinterest pins
709
+
710
+ Credit cost: 1 (standard)
711
+
712
+ Parameters:
713
+ - \`query\` (required): Search keyword or phrase to find Pinterest pins. Example: \`home decor ideas\`
714
+
715
+ \`\`\`
716
+ curl "https://socialcrawl.com/v1/pinterest/search?query=home decor ideas" \\
717
+ -H "x-api-key: sc_your_api_key_here"
718
+ \`\`\`
719
+
720
+ ### GET /pinterest/pin
721
+
722
+ Get Pinterest pin details
723
+
724
+ Credit cost: 1 (standard)
725
+
726
+ Parameters:
727
+ - \`url\` (required): Full URL of the Pinterest pin. Example: \`https://www.pinterest.com/pin/1234567890/\`
728
+
729
+ \`\`\`
730
+ curl "https://socialcrawl.com/v1/pinterest/pin?url=https://www.pinterest.com/pin/1234567890/" \\
731
+ -H "x-api-key: sc_your_api_key_here"
732
+ \`\`\`
733
+
734
+ ### GET /pinterest/board
735
+
736
+ Get Pinterest board
737
+
738
+ Credit cost: 1 (standard)
739
+
740
+ Parameters:
741
+ - \`url\` (required): Full URL of the Pinterest board. Example: \`https://www.pinterest.com/pinterest/official-pinterest-pins/\`
742
+
743
+ \`\`\`
744
+ curl "https://socialcrawl.com/v1/pinterest/board?url=https://www.pinterest.com/pinterest/official-pinterest-pins/" \\
745
+ -H "x-api-key: sc_your_api_key_here"
746
+ \`\`\`
747
+
748
+ ### GET /pinterest/user/boards
749
+
750
+ List Pinterest user boards
751
+
752
+ Credit cost: 1 (standard)
753
+
754
+ Parameters:
755
+ - \`handle\` (required): Pinterest username. Example: \`pinterest\`
756
+
757
+ \`\`\`
758
+ curl "https://socialcrawl.com/v1/pinterest/user/boards?handle=pinterest" \\
759
+ -H "x-api-key: sc_your_api_key_here"
760
+ \`\`\`
761
+
762
+ ---
763
+
764
+ ## Reddit
765
+
766
+ ### GET /reddit/subreddit
767
+
768
+ List Reddit subreddit posts
769
+
770
+ Credit cost: 1 (standard)
771
+
772
+ Parameters:
773
+ - \`subreddit\` (required): Subreddit name without the r/ prefix. Example: \`technology\`
774
+
775
+ \`\`\`
776
+ curl "https://socialcrawl.com/v1/reddit/subreddit?subreddit=technology" \\
777
+ -H "x-api-key: sc_your_api_key_here"
778
+ \`\`\`
779
+
780
+ ### GET /reddit/subreddit/details
781
+
782
+ Get Reddit subreddit details
783
+
784
+ Credit cost: 1 (standard)
785
+
786
+ Parameters:
787
+ - \`subreddit\` (required): Subreddit name without the r/ prefix. Example: \`technology\`
788
+
789
+ \`\`\`
790
+ curl "https://socialcrawl.com/v1/reddit/subreddit/details?subreddit=technology" \\
791
+ -H "x-api-key: sc_your_api_key_here"
792
+ \`\`\`
793
+
794
+ ### GET /reddit/search
795
+
796
+ Search Reddit posts
797
+
798
+ Credit cost: 1 (standard)
799
+
800
+ Parameters:
801
+ - \`query\` (required): Search keyword or phrase to find Reddit posts. Example: \`best programming languages 2024\`
802
+
803
+ \`\`\`
804
+ curl "https://socialcrawl.com/v1/reddit/search?query=best programming languages 2024" \\
805
+ -H "x-api-key: sc_your_api_key_here"
806
+ \`\`\`
807
+
808
+ ### GET /reddit/post/comments
809
+
810
+ List Reddit post comments
811
+
812
+ Credit cost: 1 (standard)
813
+
814
+ Parameters:
815
+ - \`url\` (required): Full URL of the Reddit post to fetch comments for. Example: \`https://www.reddit.com/r/technology/comments/abc123/example_post/\`
816
+
817
+ \`\`\`
818
+ curl "https://socialcrawl.com/v1/reddit/post/comments?url=https://www.reddit.com/r/technology/comments/abc123/example_post/" \\
819
+ -H "x-api-key: sc_your_api_key_here"
820
+ \`\`\`
821
+
822
+ ### GET /reddit/ad
823
+
824
+ Get Reddit ad details
825
+
826
+ Credit cost: 5 (advanced)
827
+
828
+ Parameters:
829
+ - \`id\` (required): Reddit ad ID. Example: \`t3_abc123\`
830
+
831
+ \`\`\`
832
+ curl "https://socialcrawl.com/v1/reddit/ad?id=t3_abc123" \\
833
+ -H "x-api-key: sc_your_api_key_here"
834
+ \`\`\`
835
+
836
+ ### GET /reddit/ads/search
837
+
838
+ Search Reddit ads
839
+
840
+ Credit cost: 5 (advanced)
841
+
842
+ Parameters:
843
+ - \`query\` (required): Search keyword or phrase to find Reddit ads. Example: \`gaming\`
844
+
845
+ \`\`\`
846
+ curl "https://socialcrawl.com/v1/reddit/ads/search?query=gaming" \\
847
+ -H "x-api-key: sc_your_api_key_here"
848
+ \`\`\`
849
+
850
+ ### GET /reddit/subreddit/search
851
+
852
+ Search within a subreddit
853
+
854
+ Credit cost: 1 (standard)
855
+
856
+ Parameters:
857
+ - \`subreddit\` (required): Subreddit name without the r/ prefix. Example: \`technology\`
858
+
859
+ \`\`\`
860
+ curl "https://socialcrawl.com/v1/reddit/subreddit/search?subreddit=technology" \\
861
+ -H "x-api-key: sc_your_api_key_here"
862
+ \`\`\`
863
+
864
+ ---
865
+
866
+ ## Snapchat
867
+
868
+ ### GET /snapchat/profile
869
+
870
+ Get Snapchat user profile
871
+
872
+ Credit cost: 1 (standard)
873
+
874
+ Parameters:
875
+ - \`handle\` (required): Snapchat username. Example: \`djkhaled305\`
876
+
877
+ \`\`\`
878
+ curl "https://socialcrawl.com/v1/snapchat/profile?handle=djkhaled305" \\
879
+ -H "x-api-key: sc_your_api_key_here"
880
+ \`\`\`
881
+
882
+ ---
883
+
884
+ ## Threads
885
+
886
+ ### GET /threads/profile
887
+
888
+ Get Threads user profile
889
+
890
+ Credit cost: 1 (standard)
891
+
892
+ Parameters:
893
+ - \`handle\` (required): Threads username without the @ symbol. Example: \`zuck\`
894
+
895
+ \`\`\`
896
+ curl "https://socialcrawl.com/v1/threads/profile?handle=zuck" \\
897
+ -H "x-api-key: sc_your_api_key_here"
898
+ \`\`\`
899
+
900
+ ### GET /threads/user/posts
901
+
902
+ List Threads user posts
903
+
904
+ Credit cost: 1 (standard)
905
+
906
+ Parameters:
907
+ - \`handle\` (required): Threads username without the @ symbol. Example: \`zuck\`
908
+
909
+ \`\`\`
910
+ curl "https://socialcrawl.com/v1/threads/user/posts?handle=zuck" \\
911
+ -H "x-api-key: sc_your_api_key_here"
912
+ \`\`\`
913
+
914
+ ### GET /threads/post
915
+
916
+ Get Threads post details
917
+
918
+ Credit cost: 1 (standard)
919
+
920
+ Parameters:
921
+ - \`url\` (required): Full URL of the Threads post. Example: \`https://www.threads.net/@zuck/post/CwABCDEFGHI\`
922
+
923
+ \`\`\`
924
+ curl "https://socialcrawl.com/v1/threads/post?url=https://www.threads.net/@zuck/post/CwABCDEFGHI" \\
925
+ -H "x-api-key: sc_your_api_key_here"
926
+ \`\`\`
927
+
928
+ ### GET /threads/search
929
+
930
+ Search Threads posts
931
+
932
+ Credit cost: 1 (standard)
933
+
934
+ Parameters:
935
+ - \`query\` (required): Search keyword or phrase to find Threads posts. Example: \`artificial intelligence\`
936
+
937
+ \`\`\`
938
+ curl "https://socialcrawl.com/v1/threads/search?query=artificial intelligence" \\
939
+ -H "x-api-key: sc_your_api_key_here"
940
+ \`\`\`
941
+
942
+ ### GET /threads/search/users
943
+
944
+ Search Threads users
945
+
946
+ Credit cost: 1 (standard)
947
+
948
+ Parameters:
949
+ - \`query\` (required): Search keyword or phrase to find Threads users. Example: \`tech\`
950
+
951
+ \`\`\`
952
+ curl "https://socialcrawl.com/v1/threads/search/users?query=tech" \\
953
+ -H "x-api-key: sc_your_api_key_here"
954
+ \`\`\`
955
+
956
+ ---
957
+
958
+ ## Tiktok
959
+
960
+ ### GET /tiktok/profile
961
+
962
+ Get TikTok user profile
963
+
964
+ Credit cost: 1 (standard)
965
+
966
+ Parameters:
967
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
968
+
969
+ \`\`\`
970
+ curl "https://socialcrawl.com/v1/tiktok/profile?handle=charlidamelio" \\
971
+ -H "x-api-key: sc_your_api_key_here"
972
+ \`\`\`
973
+
974
+ ### GET /tiktok/profile/videos
975
+
976
+ List TikTok user videos
977
+
978
+ Credit cost: 1 (standard)
979
+
980
+ Parameters:
981
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
982
+
983
+ \`\`\`
984
+ curl "https://socialcrawl.com/v1/tiktok/profile/videos?handle=charlidamelio" \\
985
+ -H "x-api-key: sc_your_api_key_here"
986
+ \`\`\`
987
+
988
+ ### GET /tiktok/post
989
+
990
+ Get TikTok post details
991
+
992
+ Credit cost: 1 (standard)
993
+
994
+ Parameters:
995
+ - \`url\` (required): Full URL of the TikTok video. Example: \`https://www.tiktok.com/@charlidamelio/video/7321485815660738859\`
996
+
997
+ \`\`\`
998
+ curl "https://socialcrawl.com/v1/tiktok/post?url=https://www.tiktok.com/@charlidamelio/video/7321485815660738859" \\
999
+ -H "x-api-key: sc_your_api_key_here"
1000
+ \`\`\`
1001
+
1002
+ ### GET /tiktok/post/comments
1003
+
1004
+ List TikTok post comments
1005
+
1006
+ Credit cost: 1 (standard)
1007
+
1008
+ Parameters:
1009
+ - \`url\` (required): Full URL of the TikTok video to fetch comments for. Example: \`https://www.tiktok.com/@charlidamelio/video/7321485815660738859\`
1010
+
1011
+ \`\`\`
1012
+ curl "https://socialcrawl.com/v1/tiktok/post/comments?url=https://www.tiktok.com/@charlidamelio/video/7321485815660738859" \\
1013
+ -H "x-api-key: sc_your_api_key_here"
1014
+ \`\`\`
1015
+
1016
+ ### GET /tiktok/search
1017
+
1018
+ Search TikTok videos by keyword
1019
+
1020
+ Credit cost: 1 (standard)
1021
+
1022
+ Parameters:
1023
+ - \`query\` (required): Search keyword or phrase to find TikTok videos. Example: \`cooking recipes\`
1024
+
1025
+ \`\`\`
1026
+ curl "https://socialcrawl.com/v1/tiktok/search?query=cooking recipes" \\
1027
+ -H "x-api-key: sc_your_api_key_here"
1028
+ \`\`\`
1029
+
1030
+ ### GET /tiktok/trending
1031
+
1032
+ Get TikTok trending feed
1033
+
1034
+ Credit cost: 5 (advanced)
1035
+
1036
+ Parameters:
1037
+ - \`region\` (required): ISO 3166-1 alpha-2 country code (e.g., US, GB, KR). Example: \`US\`
1038
+
1039
+ \`\`\`
1040
+ curl "https://socialcrawl.com/v1/tiktok/trending?region=US" \\
1041
+ -H "x-api-key: sc_your_api_key_here"
1042
+ \`\`\`
1043
+
1044
+ ### GET /tiktok/search/hashtag
1045
+
1046
+ Search TikTok by hashtag
1047
+
1048
+ Credit cost: 1 (standard)
1049
+
1050
+ Parameters:
1051
+ - \`hashtag\` (required): Hashtag to search for without the # symbol. Example: \`fyp\`
1052
+
1053
+ \`\`\`
1054
+ curl "https://socialcrawl.com/v1/tiktok/search/hashtag?hashtag=fyp" \\
1055
+ -H "x-api-key: sc_your_api_key_here"
1056
+ \`\`\`
1057
+
1058
+ ### GET /tiktok/search/top
1059
+
1060
+ TikTok top search results
1061
+
1062
+ Credit cost: 1 (standard)
1063
+
1064
+ Parameters:
1065
+ - \`query\` (required): Search keyword or phrase. Example: \`dance challenge\`
1066
+
1067
+ \`\`\`
1068
+ curl "https://socialcrawl.com/v1/tiktok/search/top?query=dance challenge" \\
1069
+ -H "x-api-key: sc_your_api_key_here"
1070
+ \`\`\`
1071
+
1072
+ ### GET /tiktok/search/users
1073
+
1074
+ Search TikTok users
1075
+
1076
+ Credit cost: 1 (standard)
1077
+
1078
+ Parameters:
1079
+ - \`query\` (required): Search keyword or phrase to find TikTok users. Example: \`cooking\`
1080
+
1081
+ \`\`\`
1082
+ curl "https://socialcrawl.com/v1/tiktok/search/users?query=cooking" \\
1083
+ -H "x-api-key: sc_your_api_key_here"
1084
+ \`\`\`
1085
+
1086
+ ### GET /tiktok/user/audience
1087
+
1088
+ Get TikTok user audience demographics
1089
+
1090
+ Credit cost: 5 (advanced)
1091
+
1092
+ Parameters:
1093
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
1094
+
1095
+ \`\`\`
1096
+ curl "https://socialcrawl.com/v1/tiktok/user/audience?handle=charlidamelio" \\
1097
+ -H "x-api-key: sc_your_api_key_here"
1098
+ \`\`\`
1099
+
1100
+ ### GET /tiktok/user/followers
1101
+
1102
+ List TikTok user followers
1103
+
1104
+ Credit cost: 1 (standard)
1105
+
1106
+ Parameters:
1107
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
1108
+
1109
+ \`\`\`
1110
+ curl "https://socialcrawl.com/v1/tiktok/user/followers?handle=charlidamelio" \\
1111
+ -H "x-api-key: sc_your_api_key_here"
1112
+ \`\`\`
1113
+
1114
+ ### GET /tiktok/user/following
1115
+
1116
+ List TikTok user following
1117
+
1118
+ Credit cost: 1 (standard)
1119
+
1120
+ Parameters:
1121
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
1122
+
1123
+ \`\`\`
1124
+ curl "https://socialcrawl.com/v1/tiktok/user/following?handle=charlidamelio" \\
1125
+ -H "x-api-key: sc_your_api_key_here"
1126
+ \`\`\`
1127
+
1128
+ ### GET /tiktok/user/live
1129
+
1130
+ Get TikTok user live stream
1131
+
1132
+ Credit cost: 1 (standard)
1133
+
1134
+ Parameters:
1135
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
1136
+
1137
+ \`\`\`
1138
+ curl "https://socialcrawl.com/v1/tiktok/user/live?handle=charlidamelio" \\
1139
+ -H "x-api-key: sc_your_api_key_here"
1140
+ \`\`\`
1141
+
1142
+ ### GET /tiktok/post/transcript
1143
+
1144
+ Get TikTok video transcript
1145
+
1146
+ Credit cost: 10 (premium)
1147
+
1148
+ Parameters:
1149
+ - \`url\` (required): Full URL of the TikTok video. Example: \`https://www.tiktok.com/@charlidamelio/video/7321485815660738859\`
1150
+
1151
+ \`\`\`
1152
+ curl "https://socialcrawl.com/v1/tiktok/post/transcript?url=https://www.tiktok.com/@charlidamelio/video/7321485815660738859" \\
1153
+ -H "x-api-key: sc_your_api_key_here"
1154
+ \`\`\`
1155
+
1156
+ ### GET /tiktok/song
1157
+
1158
+ Get TikTok song details
1159
+
1160
+ Credit cost: 1 (standard)
1161
+
1162
+ Parameters:
1163
+ - \`clipId\` (required): TikTok sound/song clip ID. Example: \`7252403792087040774\`
1164
+
1165
+ \`\`\`
1166
+ curl "https://socialcrawl.com/v1/tiktok/song?clipId=7252403792087040774" \\
1167
+ -H "x-api-key: sc_your_api_key_here"
1168
+ \`\`\`
1169
+
1170
+ ### GET /tiktok/song/videos
1171
+
1172
+ List TikTok videos using a song
1173
+
1174
+ Credit cost: 1 (standard)
1175
+
1176
+ Parameters:
1177
+ - \`clipId\` (required): TikTok sound/song clip ID. Example: \`7252403792087040774\`
1178
+
1179
+ \`\`\`
1180
+ curl "https://socialcrawl.com/v1/tiktok/song/videos?clipId=7252403792087040774" \\
1181
+ -H "x-api-key: sc_your_api_key_here"
1182
+ \`\`\`
1183
+
1184
+ ### GET /tiktok/songs/popular
1185
+
1186
+ Get popular TikTok songs
1187
+
1188
+ Credit cost: 5 (advanced)
1189
+
1190
+ \`\`\`
1191
+ curl "https://socialcrawl.com/v1/tiktok/songs/popular?" \\
1192
+ -H "x-api-key: sc_your_api_key_here"
1193
+ \`\`\`
1194
+
1195
+ ### GET /tiktok/creators/popular
1196
+
1197
+ Get popular TikTok creators
1198
+
1199
+ Credit cost: 5 (advanced)
1200
+
1201
+ \`\`\`
1202
+ curl "https://socialcrawl.com/v1/tiktok/creators/popular?" \\
1203
+ -H "x-api-key: sc_your_api_key_here"
1204
+ \`\`\`
1205
+
1206
+ ### GET /tiktok/hashtags/popular
1207
+
1208
+ Get popular TikTok hashtags
1209
+
1210
+ Credit cost: 5 (advanced)
1211
+
1212
+ \`\`\`
1213
+ curl "https://socialcrawl.com/v1/tiktok/hashtags/popular?" \\
1214
+ -H "x-api-key: sc_your_api_key_here"
1215
+ \`\`\`
1216
+
1217
+ ### GET /tiktok/videos/popular
1218
+
1219
+ Get popular TikTok videos
1220
+
1221
+ Credit cost: 5 (advanced)
1222
+
1223
+ \`\`\`
1224
+ curl "https://socialcrawl.com/v1/tiktok/videos/popular?" \\
1225
+ -H "x-api-key: sc_your_api_key_here"
1226
+ \`\`\`
1227
+
1228
+ ### GET /tiktok/shop/product
1229
+
1230
+ Get TikTok Shop product details
1231
+
1232
+ Credit cost: 1 (standard)
1233
+
1234
+ Parameters:
1235
+ - \`url\` (required): Full URL of the TikTok Shop product page. Example: \`https://www.tiktok.com/@shop/product/1234567890\`
1236
+
1237
+ \`\`\`
1238
+ curl "https://socialcrawl.com/v1/tiktok/shop/product?url=https://www.tiktok.com/@shop/product/1234567890" \\
1239
+ -H "x-api-key: sc_your_api_key_here"
1240
+ \`\`\`
1241
+
1242
+ ### GET /tiktok/shop/product/reviews
1243
+
1244
+ List TikTok Shop product reviews
1245
+
1246
+ Credit cost: 1 (standard)
1247
+
1248
+ Parameters:
1249
+ - \`url\` (required): Full URL of the TikTok Shop product page. Example: \`https://www.tiktok.com/@shop/product/1234567890\`
1250
+
1251
+ \`\`\`
1252
+ curl "https://socialcrawl.com/v1/tiktok/shop/product/reviews?url=https://www.tiktok.com/@shop/product/1234567890" \\
1253
+ -H "x-api-key: sc_your_api_key_here"
1254
+ \`\`\`
1255
+
1256
+ ### GET /tiktok/shop/products
1257
+
1258
+ List TikTok Shop products
1259
+
1260
+ Credit cost: 1 (standard)
1261
+
1262
+ Parameters:
1263
+ - \`url\` (required): Full URL of the TikTok Shop page. Example: \`https://www.tiktok.com/@shop/1234567890\`
1264
+
1265
+ \`\`\`
1266
+ curl "https://socialcrawl.com/v1/tiktok/shop/products?url=https://www.tiktok.com/@shop/1234567890" \\
1267
+ -H "x-api-key: sc_your_api_key_here"
1268
+ \`\`\`
1269
+
1270
+ ### GET /tiktok/shop/search
1271
+
1272
+ Search TikTok Shop products
1273
+
1274
+ Credit cost: 1 (standard)
1275
+
1276
+ Parameters:
1277
+ - \`query\` (required): Search keyword or phrase to find TikTok Shop products. Example: \`phone case\`
1278
+
1279
+ \`\`\`
1280
+ curl "https://socialcrawl.com/v1/tiktok/shop/search?query=phone case" \\
1281
+ -H "x-api-key: sc_your_api_key_here"
1282
+ \`\`\`
1283
+
1284
+ ---
1285
+
1286
+ ## Truthsocial
1287
+
1288
+ ### GET /truthsocial/profile
1289
+
1290
+ Get Truth Social user profile
1291
+
1292
+ Credit cost: 1 (standard)
1293
+
1294
+ Parameters:
1295
+ - \`handle\` (required): Truth Social username without the @ symbol. Example: \`realDonaldTrump\`
1296
+
1297
+ \`\`\`
1298
+ curl "https://socialcrawl.com/v1/truthsocial/profile?handle=realDonaldTrump" \\
1299
+ -H "x-api-key: sc_your_api_key_here"
1300
+ \`\`\`
1301
+
1302
+ ### GET /truthsocial/user/posts
1303
+
1304
+ List Truth Social user posts
1305
+
1306
+ Credit cost: 1 (standard)
1307
+
1308
+ Parameters:
1309
+ - \`handle\` (required): Truth Social username without the @ symbol. Example: \`realDonaldTrump\`
1310
+
1311
+ \`\`\`
1312
+ curl "https://socialcrawl.com/v1/truthsocial/user/posts?handle=realDonaldTrump" \\
1313
+ -H "x-api-key: sc_your_api_key_here"
1314
+ \`\`\`
1315
+
1316
+ ### GET /truthsocial/post
1317
+
1318
+ Get Truth Social post details
1319
+
1320
+ Credit cost: 1 (standard)
1321
+
1322
+ Parameters:
1323
+ - \`url\` (required): Full URL of the Truth Social post. Example: \`https://truthsocial.com/@realDonaldTrump/posts/123456789\`
1324
+
1325
+ \`\`\`
1326
+ curl "https://socialcrawl.com/v1/truthsocial/post?url=https://truthsocial.com/@realDonaldTrump/posts/123456789" \\
1327
+ -H "x-api-key: sc_your_api_key_here"
1328
+ \`\`\`
1329
+
1330
+ ---
1331
+
1332
+ ## Twitch
1333
+
1334
+ ### GET /twitch/profile
1335
+
1336
+ Get Twitch streamer profile
1337
+
1338
+ Credit cost: 1 (standard)
1339
+
1340
+ Parameters:
1341
+ - \`handle\` (required): Twitch username. Example: \`ninja\`
1342
+
1343
+ \`\`\`
1344
+ curl "https://socialcrawl.com/v1/twitch/profile?handle=ninja" \\
1345
+ -H "x-api-key: sc_your_api_key_here"
1346
+ \`\`\`
1347
+
1348
+ ### GET /twitch/clip
1349
+
1350
+ Get Twitch clip details
1351
+
1352
+ Credit cost: 1 (standard)
1353
+
1354
+ Parameters:
1355
+ - \`url\` (required): Full URL of the Twitch clip. Example: \`https://www.twitch.tv/ninja/clip/ExampleClipSlug\`
1356
+
1357
+ \`\`\`
1358
+ curl "https://socialcrawl.com/v1/twitch/clip?url=https://www.twitch.tv/ninja/clip/ExampleClipSlug" \\
1359
+ -H "x-api-key: sc_your_api_key_here"
1360
+ \`\`\`
1361
+
1362
+ ---
1363
+
1364
+ ## Twitter
1365
+
1366
+ ### GET /twitter/profile
1367
+
1368
+ Get Twitter user profile
1369
+
1370
+ Credit cost: 1 (standard)
1371
+
1372
+ Parameters:
1373
+ - \`handle\` (required): Twitter username without the @ symbol. Example: \`elonmusk\`
1374
+
1375
+ \`\`\`
1376
+ curl "https://socialcrawl.com/v1/twitter/profile?handle=elonmusk" \\
1377
+ -H "x-api-key: sc_your_api_key_here"
1378
+ \`\`\`
1379
+
1380
+ ### GET /twitter/user/tweets
1381
+
1382
+ List Twitter user tweets
1383
+
1384
+ Credit cost: 1 (standard)
1385
+
1386
+ Parameters:
1387
+ - \`handle\` (required): Twitter username without the @ symbol. Example: \`elonmusk\`
1388
+
1389
+ \`\`\`
1390
+ curl "https://socialcrawl.com/v1/twitter/user/tweets?handle=elonmusk" \\
1391
+ -H "x-api-key: sc_your_api_key_here"
1392
+ \`\`\`
1393
+
1394
+ ### GET /twitter/tweet
1395
+
1396
+ Get Twitter tweet details
1397
+
1398
+ Credit cost: 1 (standard)
1399
+
1400
+ Parameters:
1401
+ - \`url\` (required): Full URL of the tweet. Example: \`https://x.com/elonmusk/status/1234567890\`
1402
+
1403
+ \`\`\`
1404
+ curl "https://socialcrawl.com/v1/twitter/tweet?url=https://x.com/elonmusk/status/1234567890" \\
1405
+ -H "x-api-key: sc_your_api_key_here"
1406
+ \`\`\`
1407
+
1408
+ ### GET /twitter/community
1409
+
1410
+ Get Twitter community details
1411
+
1412
+ Credit cost: 1 (standard)
1413
+
1414
+ Parameters:
1415
+ - \`url\` (required): Full URL of the Twitter/X community. Example: \`https://x.com/i/communities/1234567890\`
1416
+
1417
+ \`\`\`
1418
+ curl "https://socialcrawl.com/v1/twitter/community?url=https://x.com/i/communities/1234567890" \\
1419
+ -H "x-api-key: sc_your_api_key_here"
1420
+ \`\`\`
1421
+
1422
+ ### GET /twitter/community/tweets
1423
+
1424
+ List Twitter community tweets
1425
+
1426
+ Credit cost: 1 (standard)
1427
+
1428
+ Parameters:
1429
+ - \`url\` (required): Full URL of the Twitter/X community. Example: \`https://x.com/i/communities/1234567890\`
1430
+
1431
+ \`\`\`
1432
+ curl "https://socialcrawl.com/v1/twitter/community/tweets?url=https://x.com/i/communities/1234567890" \\
1433
+ -H "x-api-key: sc_your_api_key_here"
1434
+ \`\`\`
1435
+
1436
+ ### GET /twitter/tweet/transcript
1437
+
1438
+ Get Twitter video transcript
1439
+
1440
+ Credit cost: 10 (premium)
1441
+
1442
+ Parameters:
1443
+ - \`url\` (required): Full URL of the tweet containing a video. Example: \`https://x.com/elonmusk/status/1234567890\`
1444
+
1445
+ \`\`\`
1446
+ curl "https://socialcrawl.com/v1/twitter/tweet/transcript?url=https://x.com/elonmusk/status/1234567890" \\
1447
+ -H "x-api-key: sc_your_api_key_here"
1448
+ \`\`\`
1449
+
1450
+ ---
1451
+
1452
+ ## Utility
1453
+
1454
+ ### GET /utility/age-gender
1455
+
1456
+ Detect age and gender
1457
+
1458
+ Credit cost: 10 (premium)
1459
+
1460
+ Parameters:
1461
+ - \`url\` (required): Direct URL of the image to analyze. Example: \`https://example.com/photo.jpg\`
1462
+
1463
+ \`\`\`
1464
+ curl "https://socialcrawl.com/v1/utility/age-gender?url=https://example.com/photo.jpg" \\
1465
+ -H "x-api-key: sc_your_api_key_here"
1466
+ \`\`\`
1467
+
1468
+ ---
1469
+
1470
+ ## Youtube
1471
+
1472
+ ### GET /youtube/channel
1473
+
1474
+ Get YouTube channel info
1475
+
1476
+ Credit cost: 1 (standard)
1477
+
1478
+ Parameters:
1479
+ - \`handle\` (required): YouTube channel handle without the @ symbol. Example: \`MrBeast\`
1480
+
1481
+ \`\`\`
1482
+ curl "https://socialcrawl.com/v1/youtube/channel?handle=MrBeast" \\
1483
+ -H "x-api-key: sc_your_api_key_here"
1484
+ \`\`\`
1485
+
1486
+ ### GET /youtube/channel/videos
1487
+
1488
+ List YouTube channel videos
1489
+
1490
+ Credit cost: 1 (standard)
1491
+
1492
+ Parameters:
1493
+ - \`handle\` (required): YouTube channel handle without the @ symbol. Example: \`MrBeast\`
1494
+
1495
+ \`\`\`
1496
+ curl "https://socialcrawl.com/v1/youtube/channel/videos?handle=MrBeast" \\
1497
+ -H "x-api-key: sc_your_api_key_here"
1498
+ \`\`\`
1499
+
1500
+ ### GET /youtube/video
1501
+
1502
+ Get YouTube video details
1503
+
1504
+ Credit cost: 1 (standard)
1505
+
1506
+ Parameters:
1507
+ - \`url\` (required): Full URL of the YouTube video. Example: \`https://www.youtube.com/watch?v=dQw4w9WgXcQ\`
1508
+
1509
+ \`\`\`
1510
+ curl "https://socialcrawl.com/v1/youtube/video?url=https://www.youtube.com/watch?v=dQw4w9WgXcQ" \\
1511
+ -H "x-api-key: sc_your_api_key_here"
1512
+ \`\`\`
1513
+
1514
+ ### GET /youtube/video/comments
1515
+
1516
+ List YouTube video comments
1517
+
1518
+ Credit cost: 1 (standard)
1519
+
1520
+ Parameters:
1521
+ - \`url\` (required): Full URL of the YouTube video to fetch comments for. Example: \`https://www.youtube.com/watch?v=dQw4w9WgXcQ\`
1522
+
1523
+ \`\`\`
1524
+ curl "https://socialcrawl.com/v1/youtube/video/comments?url=https://www.youtube.com/watch?v=dQw4w9WgXcQ" \\
1525
+ -H "x-api-key: sc_your_api_key_here"
1526
+ \`\`\`
1527
+
1528
+ ### GET /youtube/search
1529
+
1530
+ Search YouTube videos
1531
+
1532
+ Credit cost: 1 (standard)
1533
+
1534
+ Parameters:
1535
+ - \`query\` (required): Search keyword or phrase to find YouTube videos. Example: \`javascript tutorial\`
1536
+
1537
+ \`\`\`
1538
+ curl "https://socialcrawl.com/v1/youtube/search?query=javascript tutorial" \\
1539
+ -H "x-api-key: sc_your_api_key_here"
1540
+ \`\`\`
1541
+
1542
+ ### GET /youtube/channel/shorts
1543
+
1544
+ List YouTube channel shorts
1545
+
1546
+ Credit cost: 1 (standard)
1547
+
1548
+ Parameters:
1549
+ - \`handle\` (required): YouTube channel handle without the @ symbol. Example: \`MrBeast\`
1550
+
1551
+ \`\`\`
1552
+ curl "https://socialcrawl.com/v1/youtube/channel/shorts?handle=MrBeast" \\
1553
+ -H "x-api-key: sc_your_api_key_here"
1554
+ \`\`\`
1555
+
1556
+ ### GET /youtube/community-post
1557
+
1558
+ Get YouTube community post
1559
+
1560
+ Credit cost: 1 (standard)
1561
+
1562
+ Parameters:
1563
+ - \`url\` (required): Full URL of the YouTube community post. Example: \`https://www.youtube.com/post/UgkxCWeKpIOHLknREsNOF9M_aqz4fKkCERjP\`
1564
+
1565
+ \`\`\`
1566
+ curl "https://socialcrawl.com/v1/youtube/community-post?url=https://www.youtube.com/post/UgkxCWeKpIOHLknREsNOF9M_aqz4fKkCERjP" \\
1567
+ -H "x-api-key: sc_your_api_key_here"
1568
+ \`\`\`
1569
+
1570
+ ### GET /youtube/playlist
1571
+
1572
+ Get YouTube playlist
1573
+
1574
+ Credit cost: 1 (standard)
1575
+
1576
+ Parameters:
1577
+ - \`playlist_id\` (required): YouTube playlist ID. Example: \`PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf\`
1578
+
1579
+ \`\`\`
1580
+ curl "https://socialcrawl.com/v1/youtube/playlist?playlist_id=PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf" \\
1581
+ -H "x-api-key: sc_your_api_key_here"
1582
+ \`\`\`
1583
+
1584
+ ### GET /youtube/search/hashtag
1585
+
1586
+ Search YouTube by hashtag
1587
+
1588
+ Credit cost: 1 (standard)
1589
+
1590
+ Parameters:
1591
+ - \`hashtag\` (required): Hashtag to search for without the # symbol. Example: \`shorts\`
1592
+
1593
+ \`\`\`
1594
+ curl "https://socialcrawl.com/v1/youtube/search/hashtag?hashtag=shorts" \\
1595
+ -H "x-api-key: sc_your_api_key_here"
1596
+ \`\`\`
1597
+
1598
+ ### GET /youtube/shorts/trending
1599
+
1600
+ Get trending YouTube shorts
1601
+
1602
+ Credit cost: 5 (advanced)
1603
+
1604
+ \`\`\`
1605
+ curl "https://socialcrawl.com/v1/youtube/shorts/trending?" \\
1606
+ -H "x-api-key: sc_your_api_key_here"
1607
+ \`\`\`
1608
+
1609
+ ### GET /youtube/video/transcript
1610
+
1611
+ Get YouTube video transcript
1612
+
1613
+ Credit cost: 10 (premium)
1614
+
1615
+ Parameters:
1616
+ - \`url\` (required): Full URL of the YouTube video. Example: \`https://www.youtube.com/watch?v=dQw4w9WgXcQ\`
1617
+
1618
+ \`\`\`
1619
+ curl "https://socialcrawl.com/v1/youtube/video/transcript?url=https://www.youtube.com/watch?v=dQw4w9WgXcQ" \\
1620
+ -H "x-api-key: sc_your_api_key_here"
1621
+ \`\`\`
1622
+
1623
+ ---
1624
+
1625
+ ## Error Codes
1626
+
1627
+ | Code | Status | Description |
1628
+ |---|---|---|
1629
+ | MISSING_API_KEY | 401 | No x-api-key header provided |
1630
+ | INVALID_API_KEY | 401 | API key is malformed or not found |
1631
+ | INSUFFICIENT_CREDITS | 402 | Not enough credits — purchase more at socialcrawl.com |
1632
+ | INVALID_REQUEST | 400 | Missing required parameters |
1633
+ | ENDPOINT_NOT_FOUND | 404 | Unknown platform or resource |
1634
+ | RESOURCE_NOT_FOUND | 404 | The requested item was not found on the platform |
1635
+ | CONCURRENCY_LIMIT | 429 | Too many simultaneous requests (max 50 per key) |
1636
+ | UPSTREAM_ERROR | 502 | Platform returned an error — credits refunded |
1637
+ | SERVICE_UNAVAILABLE | 503 | Circuit breaker open — try again shortly, credits refunded |
1638
+ | INTERNAL_ERROR | 500 | Unexpected error — credits refunded |`,
1639
+ authentication: `# Authentication
1640
+
1641
+ Pass your API key in the \`x-api-key\` header with every request.
1642
+
1643
+ \`\`\`bash
1644
+ curl "https://api.socialcrawl.com/v1/tiktok/profile?handle=charlidamelio" \\
1645
+ -H "x-api-key: sc_your_api_key_here"
1646
+ \`\`\`
1647
+
1648
+ Get your free API key at https://socialcrawl.com (100 credits, no credit card required).`,
1649
+ credits: `# Credit System
1650
+
1651
+ SocialCrawl uses a simple credit system:
1652
+
1653
+ | Tier | Cost | Description |
1654
+ |------|------|-------------|
1655
+ | Standard | 1 credit | Profiles, posts, comments, search (~90% of endpoints) |
1656
+ | Advanced | 5 credits | Trending feeds, audience data, ad libraries |
1657
+ | Premium | 10 credits | AI transcripts, age/gender detection |
1658
+
1659
+ Credits are deducted per request. If a request fails due to an upstream error, credits are automatically refunded.
1660
+
1661
+ ## Pricing
1662
+
1663
+ | Plan | Price | Credits |
1664
+ |------|-------|---------|
1665
+ | Free | £0 | 100 (one-time signup bonus) |
1666
+ | Starter | £14 | 5,000 |
1667
+ | Growth | £49 | 25,000 |
1668
+ | Pro | £299 | 180,000 |
1669
+ | Enterprise | Contact | Custom |
1670
+
1671
+ Credits never expire. No rate limits.`,
1672
+ errors: `# Error Handling
1673
+
1674
+ All errors follow the same envelope format:
1675
+
1676
+ \`\`\`json
1677
+ {
1678
+ "success": false,
1679
+ "error": {
1680
+ "type": "ERROR_CODE",
1681
+ "message": "Human-readable description",
1682
+ "status": 400
1683
+ },
1684
+ "request_id": "req-XXXXX"
1685
+ }
1686
+ \`\`\`
1687
+
1688
+ ## Error Codes
1689
+
1690
+ | Code | Status | Description |
1691
+ |------|--------|-------------|
1692
+ | INVALID_API_KEY | 401 | API key is missing or invalid |
1693
+ | INSUFFICIENT_CREDITS | 402 | Not enough credits for this request |
1694
+ | MISSING_PARAMETER | 400 | Required query parameter missing |
1695
+ | ENDPOINT_NOT_FOUND | 404 | Platform or resource does not exist |
1696
+ | PLATFORM_UNAVAILABLE | 503 | Platform temporarily unavailable (circuit breaker open) |
1697
+ | UPSTREAM_ERROR | 502 | Upstream data provider error (credits auto-refunded) |
1698
+ | RATE_LIMIT_EXCEEDED | 429 | Too many concurrent requests |
1699
+ | INTERNAL_ERROR | 500 | Unexpected server error`,
1700
+ tiktok: `# SocialCrawl API — tiktok endpoints
1701
+ # Base URL: https://socialcrawl.com
1702
+ # Auth: x-api-key header
1703
+ # Full docs: https://socialcrawl.com/docs/tiktok
1704
+
1705
+ ## GET /v1/tiktok/profile
1706
+ Get TikTok user profile
1707
+ Credit cost: 1 (standard)
1708
+ Parameters:
1709
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
1710
+ curl "https://socialcrawl.com/v1/tiktok/profile?handle=charlidamelio" \\
1711
+ -H "x-api-key: sc_your_api_key_here"
1712
+
1713
+ ## GET /v1/tiktok/profile/videos
1714
+ List TikTok user videos
1715
+ Credit cost: 1 (standard)
1716
+ Parameters:
1717
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
1718
+ curl "https://socialcrawl.com/v1/tiktok/profile/videos?handle=charlidamelio" \\
1719
+ -H "x-api-key: sc_your_api_key_here"
1720
+
1721
+ ## GET /v1/tiktok/post
1722
+ Get TikTok post details
1723
+ Credit cost: 1 (standard)
1724
+ Parameters:
1725
+ - \`url\` (required): Full URL of the TikTok video. Example: \`https://www.tiktok.com/@charlidamelio/video/7321485815660738859\`
1726
+ curl "https://socialcrawl.com/v1/tiktok/post?url=https://www.tiktok.com/@charlidamelio/video/7321485815660738859" \\
1727
+ -H "x-api-key: sc_your_api_key_here"
1728
+
1729
+ ## GET /v1/tiktok/post/comments
1730
+ List TikTok post comments
1731
+ Credit cost: 1 (standard)
1732
+ Parameters:
1733
+ - \`url\` (required): Full URL of the TikTok video to fetch comments for. Example: \`https://www.tiktok.com/@charlidamelio/video/7321485815660738859\`
1734
+ curl "https://socialcrawl.com/v1/tiktok/post/comments?url=https://www.tiktok.com/@charlidamelio/video/7321485815660738859" \\
1735
+ -H "x-api-key: sc_your_api_key_here"
1736
+
1737
+ ## GET /v1/tiktok/search
1738
+ Search TikTok videos by keyword
1739
+ Credit cost: 1 (standard)
1740
+ Parameters:
1741
+ - \`query\` (required): Search keyword or phrase to find TikTok videos. Example: \`cooking recipes\`
1742
+ curl "https://socialcrawl.com/v1/tiktok/search?query=cooking recipes" \\
1743
+ -H "x-api-key: sc_your_api_key_here"
1744
+
1745
+ ## GET /v1/tiktok/trending
1746
+ Get TikTok trending feed
1747
+ Credit cost: 5 (advanced)
1748
+ Parameters:
1749
+ - \`region\` (required): ISO 3166-1 alpha-2 country code (e.g., US, GB, KR). Example: \`US\`
1750
+ curl "https://socialcrawl.com/v1/tiktok/trending?region=US" \\
1751
+ -H "x-api-key: sc_your_api_key_here"
1752
+
1753
+ ## GET /v1/tiktok/search/hashtag
1754
+ Search TikTok by hashtag
1755
+ Credit cost: 1 (standard)
1756
+ Parameters:
1757
+ - \`hashtag\` (required): Hashtag to search for without the # symbol. Example: \`fyp\`
1758
+ curl "https://socialcrawl.com/v1/tiktok/search/hashtag?hashtag=fyp" \\
1759
+ -H "x-api-key: sc_your_api_key_here"
1760
+
1761
+ ## GET /v1/tiktok/search/top
1762
+ TikTok top search results
1763
+ Credit cost: 1 (standard)
1764
+ Parameters:
1765
+ - \`query\` (required): Search keyword or phrase. Example: \`dance challenge\`
1766
+ curl "https://socialcrawl.com/v1/tiktok/search/top?query=dance challenge" \\
1767
+ -H "x-api-key: sc_your_api_key_here"
1768
+
1769
+ ## GET /v1/tiktok/search/users
1770
+ Search TikTok users
1771
+ Credit cost: 1 (standard)
1772
+ Parameters:
1773
+ - \`query\` (required): Search keyword or phrase to find TikTok users. Example: \`cooking\`
1774
+ curl "https://socialcrawl.com/v1/tiktok/search/users?query=cooking" \\
1775
+ -H "x-api-key: sc_your_api_key_here"
1776
+
1777
+ ## GET /v1/tiktok/user/audience
1778
+ Get TikTok user audience demographics
1779
+ Credit cost: 5 (advanced)
1780
+ Parameters:
1781
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
1782
+ curl "https://socialcrawl.com/v1/tiktok/user/audience?handle=charlidamelio" \\
1783
+ -H "x-api-key: sc_your_api_key_here"
1784
+
1785
+ ## GET /v1/tiktok/user/followers
1786
+ List TikTok user followers
1787
+ Credit cost: 1 (standard)
1788
+ Parameters:
1789
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
1790
+ curl "https://socialcrawl.com/v1/tiktok/user/followers?handle=charlidamelio" \\
1791
+ -H "x-api-key: sc_your_api_key_here"
1792
+
1793
+ ## GET /v1/tiktok/user/following
1794
+ List TikTok user following
1795
+ Credit cost: 1 (standard)
1796
+ Parameters:
1797
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
1798
+ curl "https://socialcrawl.com/v1/tiktok/user/following?handle=charlidamelio" \\
1799
+ -H "x-api-key: sc_your_api_key_here"
1800
+
1801
+ ## GET /v1/tiktok/user/live
1802
+ Get TikTok user live stream
1803
+ Credit cost: 1 (standard)
1804
+ Parameters:
1805
+ - \`handle\` (required): TikTok username without the @ symbol. Example: \`charlidamelio\`
1806
+ curl "https://socialcrawl.com/v1/tiktok/user/live?handle=charlidamelio" \\
1807
+ -H "x-api-key: sc_your_api_key_here"
1808
+
1809
+ ## GET /v1/tiktok/post/transcript
1810
+ Get TikTok video transcript
1811
+ Credit cost: 10 (premium)
1812
+ Parameters:
1813
+ - \`url\` (required): Full URL of the TikTok video. Example: \`https://www.tiktok.com/@charlidamelio/video/7321485815660738859\`
1814
+ curl "https://socialcrawl.com/v1/tiktok/post/transcript?url=https://www.tiktok.com/@charlidamelio/video/7321485815660738859" \\
1815
+ -H "x-api-key: sc_your_api_key_here"
1816
+
1817
+ ## GET /v1/tiktok/song
1818
+ Get TikTok song details
1819
+ Credit cost: 1 (standard)
1820
+ Parameters:
1821
+ - \`clipId\` (required): TikTok sound/song clip ID. Example: \`7252403792087040774\`
1822
+ curl "https://socialcrawl.com/v1/tiktok/song?clipId=7252403792087040774" \\
1823
+ -H "x-api-key: sc_your_api_key_here"
1824
+
1825
+ ## GET /v1/tiktok/song/videos
1826
+ List TikTok videos using a song
1827
+ Credit cost: 1 (standard)
1828
+ Parameters:
1829
+ - \`clipId\` (required): TikTok sound/song clip ID. Example: \`7252403792087040774\`
1830
+ curl "https://socialcrawl.com/v1/tiktok/song/videos?clipId=7252403792087040774" \\
1831
+ -H "x-api-key: sc_your_api_key_here"
1832
+
1833
+ ## GET /v1/tiktok/songs/popular
1834
+ Get popular TikTok songs
1835
+ Credit cost: 5 (advanced)
1836
+ curl "https://socialcrawl.com/v1/tiktok/songs/popular" \\
1837
+ -H "x-api-key: sc_your_api_key_here"
1838
+
1839
+ ## GET /v1/tiktok/creators/popular
1840
+ Get popular TikTok creators
1841
+ Credit cost: 5 (advanced)
1842
+ curl "https://socialcrawl.com/v1/tiktok/creators/popular" \\
1843
+ -H "x-api-key: sc_your_api_key_here"
1844
+
1845
+ ## GET /v1/tiktok/hashtags/popular
1846
+ Get popular TikTok hashtags
1847
+ Credit cost: 5 (advanced)
1848
+ curl "https://socialcrawl.com/v1/tiktok/hashtags/popular" \\
1849
+ -H "x-api-key: sc_your_api_key_here"
1850
+
1851
+ ## GET /v1/tiktok/videos/popular
1852
+ Get popular TikTok videos
1853
+ Credit cost: 5 (advanced)
1854
+ curl "https://socialcrawl.com/v1/tiktok/videos/popular" \\
1855
+ -H "x-api-key: sc_your_api_key_here"
1856
+
1857
+ ## GET /v1/tiktok/shop/product
1858
+ Get TikTok Shop product details
1859
+ Credit cost: 1 (standard)
1860
+ Parameters:
1861
+ - \`url\` (required): Full URL of the TikTok Shop product page. Example: \`https://www.tiktok.com/@shop/product/1234567890\`
1862
+ curl "https://socialcrawl.com/v1/tiktok/shop/product?url=https://www.tiktok.com/@shop/product/1234567890" \\
1863
+ -H "x-api-key: sc_your_api_key_here"
1864
+
1865
+ ## GET /v1/tiktok/shop/product/reviews
1866
+ List TikTok Shop product reviews
1867
+ Credit cost: 1 (standard)
1868
+ Parameters:
1869
+ - \`url\` (required): Full URL of the TikTok Shop product page. Example: \`https://www.tiktok.com/@shop/product/1234567890\`
1870
+ curl "https://socialcrawl.com/v1/tiktok/shop/product/reviews?url=https://www.tiktok.com/@shop/product/1234567890" \\
1871
+ -H "x-api-key: sc_your_api_key_here"
1872
+
1873
+ ## GET /v1/tiktok/shop/products
1874
+ List TikTok Shop products
1875
+ Credit cost: 1 (standard)
1876
+ Parameters:
1877
+ - \`url\` (required): Full URL of the TikTok Shop page. Example: \`https://www.tiktok.com/@shop/1234567890\`
1878
+ curl "https://socialcrawl.com/v1/tiktok/shop/products?url=https://www.tiktok.com/@shop/1234567890" \\
1879
+ -H "x-api-key: sc_your_api_key_here"
1880
+
1881
+ ## GET /v1/tiktok/shop/search
1882
+ Search TikTok Shop products
1883
+ Credit cost: 1 (standard)
1884
+ Parameters:
1885
+ - \`query\` (required): Search keyword or phrase to find TikTok Shop products. Example: \`phone case\`
1886
+ curl "https://socialcrawl.com/v1/tiktok/shop/search?query=phone case" \\
1887
+ -H "x-api-key: sc_your_api_key_here"`,
1888
+ instagram: `# SocialCrawl API — instagram endpoints
1889
+ # Base URL: https://socialcrawl.com
1890
+ # Auth: x-api-key header
1891
+ # Full docs: https://socialcrawl.com/docs/instagram
1892
+
1893
+ ## GET /v1/instagram/profile
1894
+ Get Instagram user profile
1895
+ Credit cost: 1 (standard)
1896
+ Parameters:
1897
+ - \`handle\` (required): Instagram username without the @ symbol. Example: \`instagram\`
1898
+ curl "https://socialcrawl.com/v1/instagram/profile?handle=instagram" \\
1899
+ -H "x-api-key: sc_your_api_key_here"
1900
+
1901
+ ## GET /v1/instagram/profile/posts
1902
+ List Instagram user posts
1903
+ Credit cost: 1 (standard)
1904
+ Parameters:
1905
+ - \`handle\` (required): Instagram username without the @ symbol. Example: \`instagram\`
1906
+ curl "https://socialcrawl.com/v1/instagram/profile/posts?handle=instagram" \\
1907
+ -H "x-api-key: sc_your_api_key_here"
1908
+
1909
+ ## GET /v1/instagram/post
1910
+ Get Instagram post details
1911
+ Credit cost: 1 (standard)
1912
+ Parameters:
1913
+ - \`url\` (required): Full URL of the Instagram post. Example: \`https://www.instagram.com/p/CwA1234abcd/\`
1914
+ curl "https://socialcrawl.com/v1/instagram/post?url=https://www.instagram.com/p/CwA1234abcd/" \\
1915
+ -H "x-api-key: sc_your_api_key_here"
1916
+
1917
+ ## GET /v1/instagram/post/comments
1918
+ List Instagram post comments
1919
+ Credit cost: 1 (standard)
1920
+ Parameters:
1921
+ - \`url\` (required): Full URL of the Instagram post to fetch comments for. Example: \`https://www.instagram.com/p/CwA1234abcd/\`
1922
+ curl "https://socialcrawl.com/v1/instagram/post/comments?url=https://www.instagram.com/p/CwA1234abcd/" \\
1923
+ -H "x-api-key: sc_your_api_key_here"
1924
+
1925
+ ## GET /v1/instagram/basic-profile
1926
+ Get Instagram basic profile
1927
+ Credit cost: 1 (standard)
1928
+ Parameters:
1929
+ - \`userId\` (required): Instagram numeric user ID. Example: \`25025320\`
1930
+ curl "https://socialcrawl.com/v1/instagram/basic-profile?userId=25025320" \\
1931
+ -H "x-api-key: sc_your_api_key_here"
1932
+
1933
+ ## GET /v1/instagram/profile/reels
1934
+ List Instagram user reels
1935
+ Credit cost: 1 (standard)
1936
+ Parameters:
1937
+ - \`handle\` (required): Instagram username without the @ symbol. Example: \`instagram\`
1938
+ curl "https://socialcrawl.com/v1/instagram/profile/reels?handle=instagram" \\
1939
+ -H "x-api-key: sc_your_api_key_here"
1940
+
1941
+ ## GET /v1/instagram/highlights
1942
+ List Instagram story highlights
1943
+ Credit cost: 1 (standard)
1944
+ Parameters:
1945
+ - \`handle\` (required): Instagram username without the @ symbol. Example: \`instagram\`
1946
+ curl "https://socialcrawl.com/v1/instagram/highlights?handle=instagram" \\
1947
+ -H "x-api-key: sc_your_api_key_here"
1948
+
1949
+ ## GET /v1/instagram/highlight/detail
1950
+ Get Instagram highlight detail
1951
+ Credit cost: 1 (standard)
1952
+ Parameters:
1953
+ - \`id\` (required): Instagram highlight ID. Example: \`17854360229135492\`
1954
+ curl "https://socialcrawl.com/v1/instagram/highlight/detail?id=17854360229135492" \\
1955
+ -H "x-api-key: sc_your_api_key_here"
1956
+
1957
+ ## GET /v1/instagram/search/reels
1958
+ Search Instagram reels
1959
+ Credit cost: 1 (standard)
1960
+ Parameters:
1961
+ - \`query\` (required): Search keyword or phrase to find Instagram reels. Example: \`workout routine\`
1962
+ curl "https://socialcrawl.com/v1/instagram/search/reels?query=workout routine" \\
1963
+ -H "x-api-key: sc_your_api_key_here"
1964
+
1965
+ ## GET /v1/instagram/media/transcript
1966
+ Get Instagram media transcript
1967
+ Credit cost: 10 (premium)
1968
+ Parameters:
1969
+ - \`url\` (required): Full URL of the Instagram video or reel. Example: \`https://www.instagram.com/reel/CwA1234abcd/\`
1970
+ curl "https://socialcrawl.com/v1/instagram/media/transcript?url=https://www.instagram.com/reel/CwA1234abcd/" \\
1971
+ -H "x-api-key: sc_your_api_key_here"
1972
+
1973
+ ## GET /v1/instagram/user/embed
1974
+ Get Instagram user embed HTML
1975
+ Credit cost: 1 (standard)
1976
+ Parameters:
1977
+ - \`handle\` (required): Instagram username without the @ symbol. Example: \`instagram\`
1978
+ curl "https://socialcrawl.com/v1/instagram/user/embed?handle=instagram" \\
1979
+ -H "x-api-key: sc_your_api_key_here"
1980
+
1981
+ ## GET /v1/instagram/song/reels
1982
+ List Instagram reels using a song
1983
+ Credit cost: 1 (standard)
1984
+ Parameters:
1985
+ - \`audio_id\` (required): Instagram audio/song ID. Example: \`243313786724210\`
1986
+ curl "https://socialcrawl.com/v1/instagram/song/reels?audio_id=243313786724210" \\
1987
+ -H "x-api-key: sc_your_api_key_here"`,
1988
+ youtube: `# SocialCrawl API — youtube endpoints
1989
+ # Base URL: https://socialcrawl.com
1990
+ # Auth: x-api-key header
1991
+ # Full docs: https://socialcrawl.com/docs/youtube
1992
+
1993
+ ## GET /v1/youtube/channel
1994
+ Get YouTube channel info
1995
+ Credit cost: 1 (standard)
1996
+ Parameters:
1997
+ - \`handle\` (required): YouTube channel handle without the @ symbol. Example: \`MrBeast\`
1998
+ curl "https://socialcrawl.com/v1/youtube/channel?handle=MrBeast" \\
1999
+ -H "x-api-key: sc_your_api_key_here"
2000
+
2001
+ ## GET /v1/youtube/channel/videos
2002
+ List YouTube channel videos
2003
+ Credit cost: 1 (standard)
2004
+ Parameters:
2005
+ - \`handle\` (required): YouTube channel handle without the @ symbol. Example: \`MrBeast\`
2006
+ curl "https://socialcrawl.com/v1/youtube/channel/videos?handle=MrBeast" \\
2007
+ -H "x-api-key: sc_your_api_key_here"
2008
+
2009
+ ## GET /v1/youtube/video
2010
+ Get YouTube video details
2011
+ Credit cost: 1 (standard)
2012
+ Parameters:
2013
+ - \`url\` (required): Full URL of the YouTube video. Example: \`https://www.youtube.com/watch?v=dQw4w9WgXcQ\`
2014
+ curl "https://socialcrawl.com/v1/youtube/video?url=https://www.youtube.com/watch?v=dQw4w9WgXcQ" \\
2015
+ -H "x-api-key: sc_your_api_key_here"
2016
+
2017
+ ## GET /v1/youtube/video/comments
2018
+ List YouTube video comments
2019
+ Credit cost: 1 (standard)
2020
+ Parameters:
2021
+ - \`url\` (required): Full URL of the YouTube video to fetch comments for. Example: \`https://www.youtube.com/watch?v=dQw4w9WgXcQ\`
2022
+ curl "https://socialcrawl.com/v1/youtube/video/comments?url=https://www.youtube.com/watch?v=dQw4w9WgXcQ" \\
2023
+ -H "x-api-key: sc_your_api_key_here"
2024
+
2025
+ ## GET /v1/youtube/search
2026
+ Search YouTube videos
2027
+ Credit cost: 1 (standard)
2028
+ Parameters:
2029
+ - \`query\` (required): Search keyword or phrase to find YouTube videos. Example: \`javascript tutorial\`
2030
+ curl "https://socialcrawl.com/v1/youtube/search?query=javascript tutorial" \\
2031
+ -H "x-api-key: sc_your_api_key_here"
2032
+
2033
+ ## GET /v1/youtube/channel/shorts
2034
+ List YouTube channel shorts
2035
+ Credit cost: 1 (standard)
2036
+ Parameters:
2037
+ - \`handle\` (required): YouTube channel handle without the @ symbol. Example: \`MrBeast\`
2038
+ curl "https://socialcrawl.com/v1/youtube/channel/shorts?handle=MrBeast" \\
2039
+ -H "x-api-key: sc_your_api_key_here"
2040
+
2041
+ ## GET /v1/youtube/community-post
2042
+ Get YouTube community post
2043
+ Credit cost: 1 (standard)
2044
+ Parameters:
2045
+ - \`url\` (required): Full URL of the YouTube community post. Example: \`https://www.youtube.com/post/UgkxCWeKpIOHLknREsNOF9M_aqz4fKkCERjP\`
2046
+ curl "https://socialcrawl.com/v1/youtube/community-post?url=https://www.youtube.com/post/UgkxCWeKpIOHLknREsNOF9M_aqz4fKkCERjP" \\
2047
+ -H "x-api-key: sc_your_api_key_here"
2048
+
2049
+ ## GET /v1/youtube/playlist
2050
+ Get YouTube playlist
2051
+ Credit cost: 1 (standard)
2052
+ Parameters:
2053
+ - \`playlist_id\` (required): YouTube playlist ID. Example: \`PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf\`
2054
+ curl "https://socialcrawl.com/v1/youtube/playlist?playlist_id=PLrAXtmErZgOeiKm4sgNOknGvNjby9efdf" \\
2055
+ -H "x-api-key: sc_your_api_key_here"
2056
+
2057
+ ## GET /v1/youtube/search/hashtag
2058
+ Search YouTube by hashtag
2059
+ Credit cost: 1 (standard)
2060
+ Parameters:
2061
+ - \`hashtag\` (required): Hashtag to search for without the # symbol. Example: \`shorts\`
2062
+ curl "https://socialcrawl.com/v1/youtube/search/hashtag?hashtag=shorts" \\
2063
+ -H "x-api-key: sc_your_api_key_here"
2064
+
2065
+ ## GET /v1/youtube/shorts/trending
2066
+ Get trending YouTube shorts
2067
+ Credit cost: 5 (advanced)
2068
+ curl "https://socialcrawl.com/v1/youtube/shorts/trending" \\
2069
+ -H "x-api-key: sc_your_api_key_here"
2070
+
2071
+ ## GET /v1/youtube/video/transcript
2072
+ Get YouTube video transcript
2073
+ Credit cost: 10 (premium)
2074
+ Parameters:
2075
+ - \`url\` (required): Full URL of the YouTube video. Example: \`https://www.youtube.com/watch?v=dQw4w9WgXcQ\`
2076
+ curl "https://socialcrawl.com/v1/youtube/video/transcript?url=https://www.youtube.com/watch?v=dQw4w9WgXcQ" \\
2077
+ -H "x-api-key: sc_your_api_key_here"`,
2078
+ facebook: `# SocialCrawl API — facebook endpoints
2079
+ # Base URL: https://socialcrawl.com
2080
+ # Auth: x-api-key header
2081
+ # Full docs: https://socialcrawl.com/docs/facebook
2082
+
2083
+ ## GET /v1/facebook/profile
2084
+ Get Facebook page profile
2085
+ Credit cost: 1 (standard)
2086
+ Parameters:
2087
+ - \`url\` (required): Full URL of the Facebook page or profile. Example: \`https://www.facebook.com/Meta\`
2088
+ curl "https://socialcrawl.com/v1/facebook/profile?url=https://www.facebook.com/Meta" \\
2089
+ -H "x-api-key: sc_your_api_key_here"
2090
+
2091
+ ## GET /v1/facebook/profile/posts
2092
+ List Facebook page posts
2093
+ Credit cost: 1 (standard)
2094
+ Parameters:
2095
+ - \`url\` (required): Full URL of the Facebook page or profile to fetch posts for. Example: \`https://www.facebook.com/Meta\`
2096
+ curl "https://socialcrawl.com/v1/facebook/profile/posts?url=https://www.facebook.com/Meta" \\
2097
+ -H "x-api-key: sc_your_api_key_here"
2098
+
2099
+ ## GET /v1/facebook/post
2100
+ Get Facebook post details
2101
+ Credit cost: 1 (standard)
2102
+ Parameters:
2103
+ - \`url\` (required): Full URL of the Facebook post. Example: \`https://www.facebook.com/Meta/posts/1234567890\`
2104
+ curl "https://socialcrawl.com/v1/facebook/post?url=https://www.facebook.com/Meta/posts/1234567890" \\
2105
+ -H "x-api-key: sc_your_api_key_here"
2106
+
2107
+ ## GET /v1/facebook/post/comments
2108
+ List Facebook post comments
2109
+ Credit cost: 1 (standard)
2110
+ Parameters:
2111
+ - \`url\` (required): Full URL of the Facebook post to fetch comments for. Example: \`https://www.facebook.com/Meta/posts/1234567890\`
2112
+ curl "https://socialcrawl.com/v1/facebook/post/comments?url=https://www.facebook.com/Meta/posts/1234567890" \\
2113
+ -H "x-api-key: sc_your_api_key_here"
2114
+
2115
+ ## GET /v1/facebook/group/posts
2116
+ List Facebook group posts
2117
+ Credit cost: 1 (standard)
2118
+ Parameters:
2119
+ - \`url\` (required): Full URL of the Facebook group. Example: \`https://www.facebook.com/groups/reactjs/\`
2120
+ curl "https://socialcrawl.com/v1/facebook/group/posts?url=https://www.facebook.com/groups/reactjs/" \\
2121
+ -H "x-api-key: sc_your_api_key_here"
2122
+
2123
+ ## GET /v1/facebook/post/transcript
2124
+ Get Facebook video transcript
2125
+ Credit cost: 10 (premium)
2126
+ Parameters:
2127
+ - \`url\` (required): Full URL of the Facebook video post. Example: \`https://www.facebook.com/Meta/videos/1234567890\`
2128
+ curl "https://socialcrawl.com/v1/facebook/post/transcript?url=https://www.facebook.com/Meta/videos/1234567890" \\
2129
+ -H "x-api-key: sc_your_api_key_here"
2130
+
2131
+ ## GET /v1/facebook/profile/photos
2132
+ List Facebook profile photos
2133
+ Credit cost: 1 (standard)
2134
+ Parameters:
2135
+ - \`url\` (required): Full URL of the Facebook page or profile. Example: \`https://www.facebook.com/Meta\`
2136
+ curl "https://socialcrawl.com/v1/facebook/profile/photos?url=https://www.facebook.com/Meta" \\
2137
+ -H "x-api-key: sc_your_api_key_here"
2138
+
2139
+ ## GET /v1/facebook/profile/reels
2140
+ List Facebook profile reels
2141
+ Credit cost: 1 (standard)
2142
+ Parameters:
2143
+ - \`url\` (required): Full URL of the Facebook page or profile. Example: \`https://www.facebook.com/Meta\`
2144
+ curl "https://socialcrawl.com/v1/facebook/profile/reels?url=https://www.facebook.com/Meta" \\
2145
+ -H "x-api-key: sc_your_api_key_here"
2146
+
2147
+ ## GET /v1/facebook/adlibrary/ad
2148
+ Get Facebook Ad Library ad details
2149
+ Credit cost: 5 (advanced)
2150
+ Parameters:
2151
+ - \`id\` (required): Facebook Ad Library ad ID. Example: \`23851234567890123\`
2152
+ curl "https://socialcrawl.com/v1/facebook/adlibrary/ad?id=23851234567890123" \\
2153
+ -H "x-api-key: sc_your_api_key_here"
2154
+
2155
+ ## GET /v1/facebook/adlibrary/company/ads
2156
+ List Facebook Ad Library company ads
2157
+ Credit cost: 5 (advanced)
2158
+ Parameters:
2159
+ - \`pageId\` (required): Facebook page ID of the advertiser. Example: \`20531316728\`
2160
+ curl "https://socialcrawl.com/v1/facebook/adlibrary/company/ads?pageId=20531316728" \\
2161
+ -H "x-api-key: sc_your_api_key_here"
2162
+
2163
+ ## GET /v1/facebook/adlibrary/search/ads
2164
+ Search Facebook Ad Library
2165
+ Credit cost: 5 (advanced)
2166
+ Parameters:
2167
+ - \`query\` (required): Search keyword or phrase to find ads in the Facebook Ad Library. Example: \`artificial intelligence\`
2168
+ curl "https://socialcrawl.com/v1/facebook/adlibrary/search/ads?query=artificial intelligence" \\
2169
+ -H "x-api-key: sc_your_api_key_here"
2170
+
2171
+ ## GET /v1/facebook/adlibrary/search/companies
2172
+ Search Facebook Ad Library companies
2173
+ Credit cost: 5 (advanced)
2174
+ Parameters:
2175
+ - \`query\` (required): Search keyword or phrase to find companies in the Facebook Ad Library. Example: \`Nike\`
2176
+ curl "https://socialcrawl.com/v1/facebook/adlibrary/search/companies?query=Nike" \\
2177
+ -H "x-api-key: sc_your_api_key_here"`,
2178
+ twitter: `# SocialCrawl API — twitter endpoints
2179
+ # Base URL: https://socialcrawl.com
2180
+ # Auth: x-api-key header
2181
+ # Full docs: https://socialcrawl.com/docs/twitter
2182
+
2183
+ ## GET /v1/twitter/profile
2184
+ Get Twitter user profile
2185
+ Credit cost: 1 (standard)
2186
+ Parameters:
2187
+ - \`handle\` (required): Twitter username without the @ symbol. Example: \`elonmusk\`
2188
+ curl "https://socialcrawl.com/v1/twitter/profile?handle=elonmusk" \\
2189
+ -H "x-api-key: sc_your_api_key_here"
2190
+
2191
+ ## GET /v1/twitter/user/tweets
2192
+ List Twitter user tweets
2193
+ Credit cost: 1 (standard)
2194
+ Parameters:
2195
+ - \`handle\` (required): Twitter username without the @ symbol. Example: \`elonmusk\`
2196
+ curl "https://socialcrawl.com/v1/twitter/user/tweets?handle=elonmusk" \\
2197
+ -H "x-api-key: sc_your_api_key_here"
2198
+
2199
+ ## GET /v1/twitter/tweet
2200
+ Get Twitter tweet details
2201
+ Credit cost: 1 (standard)
2202
+ Parameters:
2203
+ - \`url\` (required): Full URL of the tweet. Example: \`https://x.com/elonmusk/status/1234567890\`
2204
+ curl "https://socialcrawl.com/v1/twitter/tweet?url=https://x.com/elonmusk/status/1234567890" \\
2205
+ -H "x-api-key: sc_your_api_key_here"
2206
+
2207
+ ## GET /v1/twitter/community
2208
+ Get Twitter community details
2209
+ Credit cost: 1 (standard)
2210
+ Parameters:
2211
+ - \`url\` (required): Full URL of the Twitter/X community. Example: \`https://x.com/i/communities/1234567890\`
2212
+ curl "https://socialcrawl.com/v1/twitter/community?url=https://x.com/i/communities/1234567890" \\
2213
+ -H "x-api-key: sc_your_api_key_here"
2214
+
2215
+ ## GET /v1/twitter/community/tweets
2216
+ List Twitter community tweets
2217
+ Credit cost: 1 (standard)
2218
+ Parameters:
2219
+ - \`url\` (required): Full URL of the Twitter/X community. Example: \`https://x.com/i/communities/1234567890\`
2220
+ curl "https://socialcrawl.com/v1/twitter/community/tweets?url=https://x.com/i/communities/1234567890" \\
2221
+ -H "x-api-key: sc_your_api_key_here"
2222
+
2223
+ ## GET /v1/twitter/tweet/transcript
2224
+ Get Twitter video transcript
2225
+ Credit cost: 10 (premium)
2226
+ Parameters:
2227
+ - \`url\` (required): Full URL of the tweet containing a video. Example: \`https://x.com/elonmusk/status/1234567890\`
2228
+ curl "https://socialcrawl.com/v1/twitter/tweet/transcript?url=https://x.com/elonmusk/status/1234567890" \\
2229
+ -H "x-api-key: sc_your_api_key_here"`,
2230
+ linkedin: `# SocialCrawl API — linkedin endpoints
2231
+ # Base URL: https://socialcrawl.com
2232
+ # Auth: x-api-key header
2233
+ # Full docs: https://socialcrawl.com/docs/linkedin
2234
+
2235
+ ## GET /v1/linkedin/profile
2236
+ Get LinkedIn user profile
2237
+ Credit cost: 1 (standard)
2238
+ Parameters:
2239
+ - \`url\` (required): Full URL of the LinkedIn profile page. Example: \`https://www.linkedin.com/in/williamhgates/\`
2240
+ curl "https://socialcrawl.com/v1/linkedin/profile?url=https://www.linkedin.com/in/williamhgates/" \\
2241
+ -H "x-api-key: sc_your_api_key_here"
2242
+
2243
+ ## GET /v1/linkedin/company
2244
+ Get LinkedIn company page
2245
+ Credit cost: 1 (standard)
2246
+ Parameters:
2247
+ - \`url\` (required): Full URL of the LinkedIn company page. Example: \`https://www.linkedin.com/company/microsoft/\`
2248
+ curl "https://socialcrawl.com/v1/linkedin/company?url=https://www.linkedin.com/company/microsoft/" \\
2249
+ -H "x-api-key: sc_your_api_key_here"
2250
+
2251
+ ## GET /v1/linkedin/post
2252
+ Get LinkedIn post details
2253
+ Credit cost: 1 (standard)
2254
+ Parameters:
2255
+ - \`url\` (required): Full URL of the LinkedIn post. Example: \`https://www.linkedin.com/posts/williamhgates_example-activity-1234567890\`
2256
+ curl "https://socialcrawl.com/v1/linkedin/post?url=https://www.linkedin.com/posts/williamhgates_example-activity-1234567890" \\
2257
+ -H "x-api-key: sc_your_api_key_here"
2258
+
2259
+ ## GET /v1/linkedin/company/posts
2260
+ List LinkedIn company posts
2261
+ Credit cost: 1 (standard)
2262
+ Parameters:
2263
+ - \`url\` (required): Full URL of the LinkedIn company page. Example: \`https://www.linkedin.com/company/microsoft/\`
2264
+ curl "https://socialcrawl.com/v1/linkedin/company/posts?url=https://www.linkedin.com/company/microsoft/" \\
2265
+ -H "x-api-key: sc_your_api_key_here"
2266
+
2267
+ ## GET /v1/linkedin/ad
2268
+ Get LinkedIn ad details
2269
+ Credit cost: 5 (advanced)
2270
+ Parameters:
2271
+ - \`url\` (required): Full URL of the LinkedIn ad. Example: \`https://www.linkedin.com/ad/library/detail/12345\`
2272
+ curl "https://socialcrawl.com/v1/linkedin/ad?url=https://www.linkedin.com/ad/library/detail/12345" \\
2273
+ -H "x-api-key: sc_your_api_key_here"
2274
+
2275
+ ## GET /v1/linkedin/ads/search
2276
+ Search LinkedIn ads
2277
+ Credit cost: 5 (advanced)
2278
+ Parameters:
2279
+ - \`company\` (required): Company name or LinkedIn company page URL to search ads for. Example: \`Microsoft\`
2280
+ curl "https://socialcrawl.com/v1/linkedin/ads/search?company=Microsoft" \\
2281
+ -H "x-api-key: sc_your_api_key_here"`,
2282
+ reddit: `# SocialCrawl API — reddit endpoints
2283
+ # Base URL: https://socialcrawl.com
2284
+ # Auth: x-api-key header
2285
+ # Full docs: https://socialcrawl.com/docs/reddit
2286
+
2287
+ ## GET /v1/reddit/subreddit
2288
+ List Reddit subreddit posts
2289
+ Credit cost: 1 (standard)
2290
+ Parameters:
2291
+ - \`subreddit\` (required): Subreddit name without the r/ prefix. Example: \`technology\`
2292
+ curl "https://socialcrawl.com/v1/reddit/subreddit?subreddit=technology" \\
2293
+ -H "x-api-key: sc_your_api_key_here"
2294
+
2295
+ ## GET /v1/reddit/subreddit/details
2296
+ Get Reddit subreddit details
2297
+ Credit cost: 1 (standard)
2298
+ Parameters:
2299
+ - \`subreddit\` (required): Subreddit name without the r/ prefix. Example: \`technology\`
2300
+ curl "https://socialcrawl.com/v1/reddit/subreddit/details?subreddit=technology" \\
2301
+ -H "x-api-key: sc_your_api_key_here"
2302
+
2303
+ ## GET /v1/reddit/search
2304
+ Search Reddit posts
2305
+ Credit cost: 1 (standard)
2306
+ Parameters:
2307
+ - \`query\` (required): Search keyword or phrase to find Reddit posts. Example: \`best programming languages 2024\`
2308
+ curl "https://socialcrawl.com/v1/reddit/search?query=best programming languages 2024" \\
2309
+ -H "x-api-key: sc_your_api_key_here"
2310
+
2311
+ ## GET /v1/reddit/post/comments
2312
+ List Reddit post comments
2313
+ Credit cost: 1 (standard)
2314
+ Parameters:
2315
+ - \`url\` (required): Full URL of the Reddit post to fetch comments for. Example: \`https://www.reddit.com/r/technology/comments/abc123/example_post/\`
2316
+ curl "https://socialcrawl.com/v1/reddit/post/comments?url=https://www.reddit.com/r/technology/comments/abc123/example_post/" \\
2317
+ -H "x-api-key: sc_your_api_key_here"
2318
+
2319
+ ## GET /v1/reddit/ad
2320
+ Get Reddit ad details
2321
+ Credit cost: 5 (advanced)
2322
+ Parameters:
2323
+ - \`id\` (required): Reddit ad ID. Example: \`t3_abc123\`
2324
+ curl "https://socialcrawl.com/v1/reddit/ad?id=t3_abc123" \\
2325
+ -H "x-api-key: sc_your_api_key_here"
2326
+
2327
+ ## GET /v1/reddit/ads/search
2328
+ Search Reddit ads
2329
+ Credit cost: 5 (advanced)
2330
+ Parameters:
2331
+ - \`query\` (required): Search keyword or phrase to find Reddit ads. Example: \`gaming\`
2332
+ curl "https://socialcrawl.com/v1/reddit/ads/search?query=gaming" \\
2333
+ -H "x-api-key: sc_your_api_key_here"
2334
+
2335
+ ## GET /v1/reddit/subreddit/search
2336
+ Search within a subreddit
2337
+ Credit cost: 1 (standard)
2338
+ Parameters:
2339
+ - \`subreddit\` (required): Subreddit name without the r/ prefix. Example: \`technology\`
2340
+ curl "https://socialcrawl.com/v1/reddit/subreddit/search?subreddit=technology" \\
2341
+ -H "x-api-key: sc_your_api_key_here"`,
2342
+ threads: `# SocialCrawl API — threads endpoints
2343
+ # Base URL: https://socialcrawl.com
2344
+ # Auth: x-api-key header
2345
+ # Full docs: https://socialcrawl.com/docs/threads
2346
+
2347
+ ## GET /v1/threads/profile
2348
+ Get Threads user profile
2349
+ Credit cost: 1 (standard)
2350
+ Parameters:
2351
+ - \`handle\` (required): Threads username without the @ symbol. Example: \`zuck\`
2352
+ curl "https://socialcrawl.com/v1/threads/profile?handle=zuck" \\
2353
+ -H "x-api-key: sc_your_api_key_here"
2354
+
2355
+ ## GET /v1/threads/user/posts
2356
+ List Threads user posts
2357
+ Credit cost: 1 (standard)
2358
+ Parameters:
2359
+ - \`handle\` (required): Threads username without the @ symbol. Example: \`zuck\`
2360
+ curl "https://socialcrawl.com/v1/threads/user/posts?handle=zuck" \\
2361
+ -H "x-api-key: sc_your_api_key_here"
2362
+
2363
+ ## GET /v1/threads/post
2364
+ Get Threads post details
2365
+ Credit cost: 1 (standard)
2366
+ Parameters:
2367
+ - \`url\` (required): Full URL of the Threads post. Example: \`https://www.threads.net/@zuck/post/CwABCDEFGHI\`
2368
+ curl "https://socialcrawl.com/v1/threads/post?url=https://www.threads.net/@zuck/post/CwABCDEFGHI" \\
2369
+ -H "x-api-key: sc_your_api_key_here"
2370
+
2371
+ ## GET /v1/threads/search
2372
+ Search Threads posts
2373
+ Credit cost: 1 (standard)
2374
+ Parameters:
2375
+ - \`query\` (required): Search keyword or phrase to find Threads posts. Example: \`artificial intelligence\`
2376
+ curl "https://socialcrawl.com/v1/threads/search?query=artificial intelligence" \\
2377
+ -H "x-api-key: sc_your_api_key_here"
2378
+
2379
+ ## GET /v1/threads/search/users
2380
+ Search Threads users
2381
+ Credit cost: 1 (standard)
2382
+ Parameters:
2383
+ - \`query\` (required): Search keyword or phrase to find Threads users. Example: \`tech\`
2384
+ curl "https://socialcrawl.com/v1/threads/search/users?query=tech" \\
2385
+ -H "x-api-key: sc_your_api_key_here"`,
2386
+ pinterest: `# SocialCrawl API — pinterest endpoints
2387
+ # Base URL: https://socialcrawl.com
2388
+ # Auth: x-api-key header
2389
+ # Full docs: https://socialcrawl.com/docs/pinterest
2390
+
2391
+ ## GET /v1/pinterest/search
2392
+ Search Pinterest pins
2393
+ Credit cost: 1 (standard)
2394
+ Parameters:
2395
+ - \`query\` (required): Search keyword or phrase to find Pinterest pins. Example: \`home decor ideas\`
2396
+ curl "https://socialcrawl.com/v1/pinterest/search?query=home decor ideas" \\
2397
+ -H "x-api-key: sc_your_api_key_here"
2398
+
2399
+ ## GET /v1/pinterest/pin
2400
+ Get Pinterest pin details
2401
+ Credit cost: 1 (standard)
2402
+ Parameters:
2403
+ - \`url\` (required): Full URL of the Pinterest pin. Example: \`https://www.pinterest.com/pin/1234567890/\`
2404
+ curl "https://socialcrawl.com/v1/pinterest/pin?url=https://www.pinterest.com/pin/1234567890/" \\
2405
+ -H "x-api-key: sc_your_api_key_here"
2406
+
2407
+ ## GET /v1/pinterest/board
2408
+ Get Pinterest board
2409
+ Credit cost: 1 (standard)
2410
+ Parameters:
2411
+ - \`url\` (required): Full URL of the Pinterest board. Example: \`https://www.pinterest.com/pinterest/official-pinterest-pins/\`
2412
+ curl "https://socialcrawl.com/v1/pinterest/board?url=https://www.pinterest.com/pinterest/official-pinterest-pins/" \\
2413
+ -H "x-api-key: sc_your_api_key_here"
2414
+
2415
+ ## GET /v1/pinterest/user/boards
2416
+ List Pinterest user boards
2417
+ Credit cost: 1 (standard)
2418
+ Parameters:
2419
+ - \`handle\` (required): Pinterest username. Example: \`pinterest\`
2420
+ curl "https://socialcrawl.com/v1/pinterest/user/boards?handle=pinterest" \\
2421
+ -H "x-api-key: sc_your_api_key_here"`,
2422
+ google: `# SocialCrawl API — google endpoints
2423
+ # Base URL: https://socialcrawl.com
2424
+ # Auth: x-api-key header
2425
+ # Full docs: https://socialcrawl.com/docs/google
2426
+
2427
+ ## GET /v1/google/search
2428
+ Google web search
2429
+ Credit cost: 1 (standard)
2430
+ Parameters:
2431
+ - \`query\` (required): Search keyword or phrase. Example: \`best restaurants in London\`
2432
+ curl "https://socialcrawl.com/v1/google/search?query=best restaurants in London" \\
2433
+ -H "x-api-key: sc_your_api_key_here"
2434
+
2435
+ ## GET /v1/google/ad
2436
+ Get Google ad details
2437
+ Credit cost: 5 (advanced)
2438
+ Parameters:
2439
+ - \`url\` (required): Full URL of the Google ad or Ads Transparency Center page. Example: \`https://adstransparency.google.com/advertiser/AR12345678901234567\`
2440
+ curl "https://socialcrawl.com/v1/google/ad?url=https://adstransparency.google.com/advertiser/AR12345678901234567" \\
2441
+ -H "x-api-key: sc_your_api_key_here"
2442
+
2443
+ ## GET /v1/google/adlibrary/advertisers/search
2444
+ Search Google Ad Library advertisers
2445
+ Credit cost: 5 (advanced)
2446
+ Parameters:
2447
+ - \`query\` (required): Search keyword or phrase to find advertisers in the Google Ads Transparency Center. Example: \`Nike\`
2448
+ curl "https://socialcrawl.com/v1/google/adlibrary/advertisers/search?query=Nike" \\
2449
+ -H "x-api-key: sc_your_api_key_here"
2450
+
2451
+ ## GET /v1/google/company/ads
2452
+ List Google ads by company
2453
+ Credit cost: 5 (advanced)
2454
+ Parameters:
2455
+ - \`domain\` (required): Company domain name to look up ads for. Example: \`nike.com\`
2456
+ curl "https://socialcrawl.com/v1/google/company/ads?domain=nike.com" \\
2457
+ -H "x-api-key: sc_your_api_key_here"`,
2458
+ twitch: `# SocialCrawl API — twitch endpoints
2459
+ # Base URL: https://socialcrawl.com
2460
+ # Auth: x-api-key header
2461
+ # Full docs: https://socialcrawl.com/docs/twitch
2462
+
2463
+ ## GET /v1/twitch/profile
2464
+ Get Twitch streamer profile
2465
+ Credit cost: 1 (standard)
2466
+ Parameters:
2467
+ - \`handle\` (required): Twitch username. Example: \`ninja\`
2468
+ curl "https://socialcrawl.com/v1/twitch/profile?handle=ninja" \\
2469
+ -H "x-api-key: sc_your_api_key_here"
2470
+
2471
+ ## GET /v1/twitch/clip
2472
+ Get Twitch clip details
2473
+ Credit cost: 1 (standard)
2474
+ Parameters:
2475
+ - \`url\` (required): Full URL of the Twitch clip. Example: \`https://www.twitch.tv/ninja/clip/ExampleClipSlug\`
2476
+ curl "https://socialcrawl.com/v1/twitch/clip?url=https://www.twitch.tv/ninja/clip/ExampleClipSlug" \\
2477
+ -H "x-api-key: sc_your_api_key_here"`,
2478
+ truthsocial: `# SocialCrawl API — truthsocial endpoints
2479
+ # Base URL: https://socialcrawl.com
2480
+ # Auth: x-api-key header
2481
+ # Full docs: https://socialcrawl.com/docs/truthsocial
2482
+
2483
+ ## GET /v1/truthsocial/profile
2484
+ Get Truth Social user profile
2485
+ Credit cost: 1 (standard)
2486
+ Parameters:
2487
+ - \`handle\` (required): Truth Social username without the @ symbol. Example: \`realDonaldTrump\`
2488
+ curl "https://socialcrawl.com/v1/truthsocial/profile?handle=realDonaldTrump" \\
2489
+ -H "x-api-key: sc_your_api_key_here"
2490
+
2491
+ ## GET /v1/truthsocial/user/posts
2492
+ List Truth Social user posts
2493
+ Credit cost: 1 (standard)
2494
+ Parameters:
2495
+ - \`handle\` (required): Truth Social username without the @ symbol. Example: \`realDonaldTrump\`
2496
+ curl "https://socialcrawl.com/v1/truthsocial/user/posts?handle=realDonaldTrump" \\
2497
+ -H "x-api-key: sc_your_api_key_here"
2498
+
2499
+ ## GET /v1/truthsocial/post
2500
+ Get Truth Social post details
2501
+ Credit cost: 1 (standard)
2502
+ Parameters:
2503
+ - \`url\` (required): Full URL of the Truth Social post. Example: \`https://truthsocial.com/@realDonaldTrump/posts/123456789\`
2504
+ curl "https://socialcrawl.com/v1/truthsocial/post?url=https://truthsocial.com/@realDonaldTrump/posts/123456789" \\
2505
+ -H "x-api-key: sc_your_api_key_here"`,
2506
+ snapchat: `# SocialCrawl API — snapchat endpoints
2507
+ # Base URL: https://socialcrawl.com
2508
+ # Auth: x-api-key header
2509
+ # Full docs: https://socialcrawl.com/docs/snapchat
2510
+
2511
+ ## GET /v1/snapchat/profile
2512
+ Get Snapchat user profile
2513
+ Credit cost: 1 (standard)
2514
+ Parameters:
2515
+ - \`handle\` (required): Snapchat username. Example: \`djkhaled305\`
2516
+ curl "https://socialcrawl.com/v1/snapchat/profile?handle=djkhaled305" \\
2517
+ -H "x-api-key: sc_your_api_key_here"`,
2518
+ kick: `# SocialCrawl API — kick endpoints
2519
+ # Base URL: https://socialcrawl.com
2520
+ # Auth: x-api-key header
2521
+ # Full docs: https://socialcrawl.com/docs/kick
2522
+
2523
+ ## GET /v1/kick/clip
2524
+ Get Kick clip details
2525
+ Credit cost: 1 (standard)
2526
+ Parameters:
2527
+ - \`url\` (required): Full URL of the Kick clip. Example: \`https://kick.com/xqc/clips/clip_abc123\`
2528
+ curl "https://socialcrawl.com/v1/kick/clip?url=https://kick.com/xqc/clips/clip_abc123" \\
2529
+ -H "x-api-key: sc_your_api_key_here"`,
2530
+ amazon: `# SocialCrawl API — amazon endpoints
2531
+ # Base URL: https://socialcrawl.com
2532
+ # Auth: x-api-key header
2533
+ # Full docs: https://socialcrawl.com/docs/amazon
2534
+
2535
+ ## GET /v1/amazon/shop
2536
+ Get Amazon shop page
2537
+ Credit cost: 1 (standard)
2538
+ Parameters:
2539
+ - \`url\` (required): Full URL of the Amazon shop or storefront page. Example: \`https://www.amazon.com/shop/influencer123\`
2540
+ curl "https://socialcrawl.com/v1/amazon/shop?url=https://www.amazon.com/shop/influencer123" \\
2541
+ -H "x-api-key: sc_your_api_key_here"`,
2542
+ linktree: `# SocialCrawl API — linktree endpoints
2543
+ # Base URL: https://socialcrawl.com
2544
+ # Auth: x-api-key header
2545
+ # Full docs: https://socialcrawl.com/docs/linktree
2546
+
2547
+ ## GET /v1/linktree/page
2548
+ Get Linktree page
2549
+ Credit cost: 1 (standard)
2550
+ Parameters:
2551
+ - \`url\` (required): Full URL of the Linktree page. Example: \`https://linktr.ee/charlidamelio\`
2552
+ curl "https://socialcrawl.com/v1/linktree/page?url=https://linktr.ee/charlidamelio" \\
2553
+ -H "x-api-key: sc_your_api_key_here"`,
2554
+ linkbio: `# SocialCrawl API — linkbio endpoints
2555
+ # Base URL: https://socialcrawl.com
2556
+ # Auth: x-api-key header
2557
+ # Full docs: https://socialcrawl.com/docs/linkbio
2558
+
2559
+ ## GET /v1/linkbio/page
2560
+ Get Linkbio page
2561
+ Credit cost: 1 (standard)
2562
+ Parameters:
2563
+ - \`url\` (required): Full URL of the Linkbio page. Example: \`https://lnk.bio/example\`
2564
+ curl "https://socialcrawl.com/v1/linkbio/page?url=https://lnk.bio/example" \\
2565
+ -H "x-api-key: sc_your_api_key_here"`,
2566
+ linkme: `# SocialCrawl API — linkme endpoints
2567
+ # Base URL: https://socialcrawl.com
2568
+ # Auth: x-api-key header
2569
+ # Full docs: https://socialcrawl.com/docs/linkme
2570
+
2571
+ ## GET /v1/linkme/page
2572
+ Get Linkme profile
2573
+ Credit cost: 1 (standard)
2574
+ Parameters:
2575
+ - \`url\` (required): Full URL of the Linkme page. Example: \`https://linkme.bio/example\`
2576
+ curl "https://socialcrawl.com/v1/linkme/page?url=https://linkme.bio/example" \\
2577
+ -H "x-api-key: sc_your_api_key_here"`,
2578
+ komi: `# SocialCrawl API — komi endpoints
2579
+ # Base URL: https://socialcrawl.com
2580
+ # Auth: x-api-key header
2581
+ # Full docs: https://socialcrawl.com/docs/komi
2582
+
2583
+ ## GET /v1/komi/page
2584
+ Get Komi page
2585
+ Credit cost: 1 (standard)
2586
+ Parameters:
2587
+ - \`url\` (required): Full URL of the Komi page. Example: \`https://komi.io/example\`
2588
+ curl "https://socialcrawl.com/v1/komi/page?url=https://komi.io/example" \\
2589
+ -H "x-api-key: sc_your_api_key_here"`,
2590
+ pillar: `# SocialCrawl API — pillar endpoints
2591
+ # Base URL: https://socialcrawl.com
2592
+ # Auth: x-api-key header
2593
+ # Full docs: https://socialcrawl.com/docs/pillar
2594
+
2595
+ ## GET /v1/pillar/page
2596
+ Get Pillar page
2597
+ Credit cost: 1 (standard)
2598
+ Parameters:
2599
+ - \`url\` (required): Full URL of the Pillar page. Example: \`https://pillar.io/example\`
2600
+ curl "https://socialcrawl.com/v1/pillar/page?url=https://pillar.io/example" \\
2601
+ -H "x-api-key: sc_your_api_key_here"`,
2602
+ utility: `# SocialCrawl API — utility endpoints
2603
+ # Base URL: https://socialcrawl.com
2604
+ # Auth: x-api-key header
2605
+ # Full docs: https://socialcrawl.com/docs/utility
2606
+
2607
+ ## GET /v1/utility/age-gender
2608
+ Detect age and gender
2609
+ Credit cost: 10 (premium)
2610
+ Parameters:
2611
+ - \`url\` (required): Direct URL of the image to analyze. Example: \`https://example.com/photo.jpg\`
2612
+ curl "https://socialcrawl.com/v1/utility/age-gender?url=https://example.com/photo.jpg" \\
2613
+ -H "x-api-key: sc_your_api_key_here"`,
2614
+ };
2615
+ export function getDoc(topic) {
2616
+ return DOCS[topic];
2617
+ }
2618
+ export function getAvailableTopics() {
2619
+ return Object.keys(DOCS);
2620
+ }
2621
+ //# sourceMappingURL=docs.js.map