# Get Credits Balance
Source: https://docs.sociavault.com/api-reference/credits

GET /v1/credits
Returns the current credit balance and subscription status for the authenticated user

<Note>
  Returns the current credit balance and subscription status for the authenticated user.
</Note>


# Ad Details
Source: https://docs.sociavault.com/api-reference/facebook-ad-library/ad-details

GET /v1/scrape/facebook-ad-library/ad-details
Get details for a specific Facebook Ad Library entry by Ad ID. For ads with multiple versions, the title should be sourced from the `cards` object in the response.

<Note>
  💳 **1 credit** per request
</Note>


# Ad Transcript
Source: https://docs.sociavault.com/api-reference/facebook-ad-library/ad-transcript

GET /v1/scrape/facebook-ad-library/ad/transcript
Get the transcript for a Facebook Ad Library video ad by ad ID or URL. Provide either `id` or `url`. Credits are only charged when a transcript is returned — if the ad has no available transcript, the request costs 0 credits.

<Note>
  💳 **1 credit** per request — but you are **only charged when a transcript is returned**. If the ad has no available transcript, the request costs 0 credits.
</Note>

Get the transcript for a Facebook Ad Library video ad. Provide either the ad `id` or the ad `url`.


# Company Ads
Source: https://docs.sociavault.com/api-reference/facebook-ad-library/company-ads

GET /v1/scrape/facebook-ad-library/company-ads
Get all the ads a company has running

<Note>
  💳 **1 credit** per request
</Note>


# Search
Source: https://docs.sociavault.com/api-reference/facebook-ad-library/search

GET /v1/scrape/facebook-ad-library/search
Search the Facebook (Meta) Ad Library by keyword. GET requests are capped at approximately 1,500 results due to cursor size limits. For larger result sets, use this endpoint as a POST request with the query parameters passed in the request body.

<Note>
  💳 **1 credit** per request
</Note>


# Search for Companies
Source: https://docs.sociavault.com/api-reference/facebook-ad-library/search-companies

GET /v1/scrape/facebook-ad-library/search-companies
Search for companies by name and get their ad library page id

<Note>
  💳 **1 credit** per request
</Note>


# Item
Source: https://docs.sociavault.com/api-reference/facebook-marketplace/item

GET /v1/scrape/facebook-marketplace/item
Fetch full details for a single Facebook Marketplace listing by its ID or URL.

<Note>💳 **1 credit** per request</Note>

<Tip>
  Pass either the listing `id` or its full Marketplace `url` — you only need
  one.
</Tip>


# Location Search
Source: https://docs.sociavault.com/api-reference/facebook-marketplace/location-search

GET /v1/scrape/facebook-marketplace/location-search
Look up cities and regions on Facebook Marketplace and get the coordinates you'll need to call the Marketplace Search endpoint.

<Note>
  💳 **1 credit** per request
</Note>


# Search
Source: https://docs.sociavault.com/api-reference/facebook-marketplace/search

GET /v1/scrape/facebook-marketplace/search
Pull Facebook Marketplace listings around any coordinate, with filters for price range, condition, delivery method, listing date, and availability. Use the Location Search endpoint first to grab the lat/lng for the city or region you want to search.

<Note>💳 **1 credit** per request</Note>

<Tip>
  Need a `lat` / `lng` for a city? Run [Location
  Search](/api-reference/facebook-marketplace/location-search) first to grab
  them.
</Tip>


# Comment Replies
Source: https://docs.sociavault.com/api-reference/facebook/comment-replies

GET /v1/scrape/facebook/comment/replies
Get replies to a specific Facebook comment. Requires the feedback_id and expansion_token from the comments endpoint response.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# Facebook Group Posts
Source: https://docs.sociavault.com/api-reference/facebook/group-posts

GET /v1/scrape/facebook/group/posts
Get posts from a public Facebook group. Returns up to 3 posts per request due to Facebook API constraints.

<Note>
  💳 **1 credit** per request
</Note>


# Post
Source: https://docs.sociavault.com/api-reference/facebook/post

GET /v1/scrape/facebook/post
Get a public Facebook post or reel by url.

<Note>
  💳 **1 credit** per request
</Note>


# Comments
Source: https://docs.sociavault.com/api-reference/facebook/post-comments

GET /v1/scrape/facebook/post/comments
Get the comments of a Facebook post (or reel)

<Note>
  💳 **1 credit** per request
</Note>


# Transcript
Source: https://docs.sociavault.com/api-reference/facebook/post-transcript

GET /v1/scrape/facebook/post/transcript
Get the transcript of a Facebook post. Can be a post or reel.

<Note>
  💳 **1 credit** per request
</Note>


# Profile
Source: https://docs.sociavault.com/api-reference/facebook/profile

GET /v1/scrape/facebook/profile
Get public Facebook profile information

<Note>
  💳 **1 credit** per request
</Note>


# Profile Posts
Source: https://docs.sociavault.com/api-reference/facebook/profile-posts

GET /v1/scrape/facebook/profile/posts
Get publicly visible posts from a Facebook profile — equivalent to what is accessible without being logged in. Accepts a profile URL or pageId (recommended for faster responses). Returns up to 3 posts per request.

<Note>
  💳 **1 credit** per request
</Note>


# Profile Reels
Source: https://docs.sociavault.com/api-reference/facebook/profile-reels

GET /v1/scrape/facebook/profile/reels
Get public reels from a Facebook page, 10 at a time. **Important:** Pagination requires passing both `next_page_id` and `cursor` from the previous response.

<Note>
  💳 **1 credit** per request
</Note>


# Ad Details
Source: https://docs.sociavault.com/api-reference/google-ad-library/ad-details

GET /v1/scrape/google-ad-library/ad-details
Get details for a specific Google ad. Ad text is extracted via OCR and may not always be 100% accurate.

<Note>
  💳 **1 credit** per request
</Note>


# Company Ads
Source: https://docs.sociavault.com/api-reference/google-ad-library/company-ads

GET /v1/scrape/google-ad-library/company-ads
Get public ads for a company from the Google Ad Transparency Library. Only publicly accessible ads are returned — login-gated ads cannot be retrieved. Ad text is extracted via OCR, so response times may be slightly longer.

<Note>
  💳 **1 credit** per request
</Note>


# Search Advertisers
Source: https://docs.sociavault.com/api-reference/google-ad-library/search-advertisers

GET /v1/scrape/google-ad-library/search-advertisers
Search the Google Ad Transparency Library for advertisers to get their advertiser id

<Note>
  💳 **1 credit** per request
</Note>


# Search
Source: https://docs.sociavault.com/api-reference/google/search

GET /v1/scrape/google/search
Search Google

<Note>
  💳 **1 credit** per request
</Note>


# Basic Profile
Source: https://docs.sociavault.com/api-reference/instagram/basic-profile

GET /v1/scrape/instagram/basic-profile
Get a basic public Instagram profile by numeric user ID. Useful as a fallback when a handle-based lookup fails (some valid accounts return "account does not exist" when queried by username).

<Note>
  💳 **1 credit** per request
</Note>


# Comment Replies
Source: https://docs.sociavault.com/api-reference/instagram/comment-replies

GET /v1/scrape/instagram/comment/replies
Get replies to a specific Instagram comment. Provide the post or reel `url` and the parent `comment_id` (obtained from the Comments endpoint). Use the `cursor` from each response to load more replies.

<Note>
  💳 **1 credit** per request
</Note>

Get replies to a specific Instagram comment. Pass the post or reel `url` and the parent `comment_id` (from the [Comments](/api-reference/instagram/comments) endpoint), then use the `cursor` from each response to page through more replies.


# Comments
Source: https://docs.sociavault.com/api-reference/instagram/comments

GET /v1/scrape/instagram/comments
Get comments from an Instagram post or reel, paginated at ~15 per page. Use the `cursor` from each response to load more. Note: Instagram's displayed comment count includes replies and hidden comments — this endpoint returns top-level visible comments only, so the total may be lower than what is shown on the post.

<Note>
  💳 **1 credit** per request — returns \~15 comments per page. Use `cursor` to paginate.
</Note>

Use the `cursor` parameter from the response to get the next page of comments.


# Highlights Details
Source: https://docs.sociavault.com/api-reference/instagram/highlight-detail

GET /v1/scrape/instagram/highlight-detail
Get details about a specific highlight

<Note>
  💳 **1 credit** per request
</Note>


# Story Highlights
Source: https://docs.sociavault.com/api-reference/instagram/highlights

GET /v1/scrape/instagram/highlights
Get story highlights from an Instagram user

<Note>
  💳 **1 credit** per request
</Note>


# Post/Reel Info
Source: https://docs.sociavault.com/api-reference/instagram/post-info

GET /v1/scrape/instagram/post-info
Get detailed public information about a specific Instagram post or reel, including likes, comments, caption, media URLs, owner, audio, and — for reels and videos — the `video_play_count` view count. Note: play counts reflect Instagram views only; when a reel is cross-posted to Facebook, the combined count is visible only to logged-in users.

<Note>
  💳 **1 credit** per request
</Note>


# Posts
Source: https://docs.sociavault.com/api-reference/instagram/posts

GET /v1/scrape/instagram/posts
Get public posts from an Instagram profile. Note: play counts reflect Instagram-only views. When a Reel is cross-posted to Facebook, the combined view count is visible to logged-in users — this API returns Instagram views only.

<Note>
  💳 **1 credit** per request
</Note>


# Profile
Source: https://docs.sociavault.com/api-reference/instagram/profile

GET /v1/scrape/instagram/profile
Gets public Instagram profile data, recent posts, and related accounts

<Note>
  💳 **1 credit** per request
</Note>


# Reels
Source: https://docs.sociavault.com/api-reference/instagram/reels

GET /v1/scrape/instagram/reels
Get public reels from an Instagram profile. Accepts either a user_id or handle — user_id is recommended for faster responses. Pinned reels are not included, and reel descriptions are not returned here; use the Post/Reel Info endpoint to get those. Note: play counts reflect Instagram-only views. When a Reel is cross-posted to Facebook, the combined count is visible to logged-in users — this API returns Instagram views only.

<Note>
  💳 **1 credit** per request
</Note>


# Reels using Song
Source: https://docs.sociavault.com/api-reference/instagram/reels-by-song

GET /v1/scrape/instagram/reels-by-song
Get reels using a song

<Note>
  💳 **1 credit** per request
</Note>


# Search
Source: https://docs.sociavault.com/api-reference/instagram/search

GET /v1/scrape/instagram/search
Instagram native search — find users, hashtags, and places. Use this for account or entity lookup. It returns one page and does not return posts.

<Note>
  💳 **1 credit** per request
</Note>

Instagram's native search for users, hashtags, and places. Use it for quick account or entity lookup. It returns a single page and does **not** return posts, for a topic's curated posts, use [Popular Search](/api-reference/instagram/search-popular).


# Search Hashtag Posts
Source: https://docs.sociavault.com/api-reference/instagram/search-hashtag

GET /v1/scrape/instagram/search/hashtag
Find public Instagram posts and reels for a hashtag. This endpoint discovers Google-indexed content and then reads the public Instagram pages, so it works without Instagram's login-gated search and relies only on publicly available data.

<Note>💳 **1 credit** per request</Note>


# Popular Search
Source: https://docs.sociavault.com/api-reference/instagram/search-popular

GET /v1/scrape/instagram/search/popular
Explore an Instagram topic and its curated posts. Use this when you want the Popular page's generated description, sources, suggested terms, media count, and paginated posts. Use the `cursor` from each response to fetch the next page.

<Note>
  💳 **1 credit** per request
</Note>

Explore an Instagram topic and its curated posts. Returns the Popular page's generated description, sources, suggested terms, media count, and paginated posts. Use the `cursor` from each response with the same `query` to fetch the next page.


# Transcript
Source: https://docs.sociavault.com/api-reference/instagram/transcript

GET /v1/scrape/instagram/transcript
Generate a transcript for an Instagram post or reel using AI. Responses typically take 10–30 seconds. Only videos under 2 minutes are supported — if no speech is detected, the transcript returns null. For carousel posts, a transcript is returned for each individual item.

<Note>
  💳 **1 credit** per request
</Note>


# API Reference
Source: https://docs.sociavault.com/api-reference/introduction

Complete guide to the SociaVault API - Extract data from multiple social media platforms

## Welcome to SociaVault API

The SociaVault API provides comprehensive access to social media data extraction across multiple platforms. Get detailed information about profiles, posts, videos, comments, and more with simple HTTP requests.

<CardGroup>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get your API key and make your first request in minutes
  </Card>

  <Card title="API Playground" icon="code" href="https://sociavault.com/playground">
    Test all endpoints interactively in your browser
  </Card>

  <Card title="Code Examples" icon="code-branch" href="#authentication">
    Ready-to-use examples in multiple languages
  </Card>

  <Card title="Pricing" icon="credit-card" href="https://sociavault.com/pricing">
    Transparent credit-based pricing
  </Card>
</CardGroup>

## Authentication

All API requests require authentication using an API key in the `X-API-Key` header.

<Steps>
  <Step title="Get Your API Key">
    Sign up at [sociavault.com](https://sociavault.com) and get your API key from the [Dashboard](https://sociavault.com/dashboard).
  </Step>

  <Step title="Add to Request Header">
    Include your API key in the `X-API-Key` header of every request.
  </Step>

  <Step title="Start Making Requests">
    You're ready to extract social media data!
  </Step>
</Steps>

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.sociavault.com/v1/scrape/tiktok/profile?handle=charlidamelio' \
    --header 'X-API-Key: sk_live_your_api_key_here'
  ```

  ```javascript JavaScript theme={null}
  const axios = require('axios');

  const options = {
    method: 'GET',
    url: 'https://api.sociavault.com/v1/scrape/tiktok/profile',
    params: { handle: 'charlidamelio' },
    headers: {
      'X-API-Key': 'sk_live_your_api_key_here'
    }
  };

  axios.request(options)
    .then(response => console.log(response.data))
    .catch(error => console.error(error));
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.sociavault.com/v1/scrape/tiktok/profile"
  headers = {
      "X-API-Key": "sk_live_your_api_key_here"
  }
  params = {
      "handle": "charlidamelio"
  }

  response = requests.get(url, headers=headers, params=params)
  print(response.json())
  ```

  ```php PHP theme={null}
  <?php
  $curl = curl_init();

  curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.sociavault.com/v1/scrape/tiktok/profile?handle=charlidamelio",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
      "X-API-Key: sk_live_your_api_key_here"
    ],
  ]);

  $response = curl_exec($curl);
  curl_close($curl);

  echo $response;
  ?>
  ```
</CodeGroup>

## Base URL

```
https://api.sociavault.com
```

## Supported Platforms

<CardGroup>
  <Card title="TikTok" icon="tiktok" href="/api-reference/tiktok/profile">
    Profiles, videos, analytics & more
  </Card>

  <Card title="Instagram" icon="instagram" href="/api-reference/instagram/profile">
    Posts, reels, stories & highlights
  </Card>

  <Card title="YouTube" icon="youtube" href="/api-reference/youtube/channel">
    Channels, videos, shorts & comments
  </Card>

  <Card title="Facebook" icon="facebook" href="/api-reference/facebook/profile">
    Profiles, posts & groups
  </Card>

  <Card title="Twitter/X" icon="x-twitter" href="/api-reference/twitter/profile">
    Profiles, tweets & communities
  </Card>

  <Card title="LinkedIn" icon="linkedin" href="/api-reference/linkedin/profile">
    Profiles, companies & posts
  </Card>

  <Card title="Reddit" icon="reddit" href="/api-reference/reddit/subreddit">
    Subreddits, posts & comments
  </Card>

  <Card title="Threads" icon="threads" href="/api-reference/threads/profile">
    Profiles, posts & search
  </Card>

  <Card title="TikTok Shop" icon="shopping-cart" href="/api-reference/tiktok-shop/products">
    Products & shop search
  </Card>

  <Card title="Facebook Ad Library" icon="rectangle-ad" href="/api-reference/facebook-ad-library/ad-details">
    Meta ad intelligence
  </Card>

  <Card title="Google Ad Library" icon="rectangle-ad" href="/api-reference/google-ad-library/company-ads">
    Google ad transparency
  </Card>

  <Card title="LinkedIn Ad Library" icon="rectangle-ad" href="/api-reference/linkedin-ad-library/search">
    LinkedIn ad insights
  </Card>

  <Card title="Google Search" icon="google" href="/api-reference/google/search">
    Search & SERP data
  </Card>
</CardGroup>

## Credits & Pricing

SociaVault uses a credit-based system. **Most endpoints cost just 1 credit per request**.

<Info>
  **Standard Pricing:** Most endpoints = 1 credit\
  **Exception:** Some advanced endpoints like demographics and audience analytics may cost more (20+ credits)
</Info>

* **Standard requests** (profiles, videos, posts, etc.): **1 credit**
* **Advanced analytics** (demographics, insights): 20+ credits
* **Paginated requests**: Credits per page

<CardGroup>
  <Card title="API Playground" icon="code" href="https://sociavault.com/playground">
    See detailed credit costs for all endpoints
  </Card>

  <Card title="Pricing Plans" icon="credit-card" href="https://sociavault.com/pricing">
    View subscription options and packages
  </Card>
</CardGroup>

## Scalable Infrastructure

Our API automatically scales to handle your request volume. No rate limits - send as many requests as you need.

<CardGroup>
  <Card title="Auto-Scaling" icon="arrows-up-down">
    Infrastructure scales with your needs
  </Card>

  <Card title="99.9% Uptime" icon="server">
    Enterprise-grade reliability
  </Card>
</CardGroup>

## Need Help?

<CardGroup>
  <Card title="Support" icon="life-ring" href="mailto:support@sociavault.com">
    Email support
  </Card>
</CardGroup>


# Ad Details
Source: https://docs.sociavault.com/api-reference/linkedin-ad-library/ad-details

GET /v1/scrape/linkedin-ad-library/ad-details
Get the details for an ad

<Note>
  💳 **1 credit** per request
</Note>


# Search Ads
Source: https://docs.sociavault.com/api-reference/linkedin-ad-library/search

GET /v1/scrape/linkedin-ad-library/search
Search the LinkedIn Ad Library

<Note>
  💳 **1 credit** per request
</Note>


# Company Page
Source: https://docs.sociavault.com/api-reference/linkedin/company

GET /v1/scrape/linkedin/company
Get a LinkedIn company page

<Note>
  💳 **1 credit** per request
</Note>


# Post
Source: https://docs.sociavault.com/api-reference/linkedin/post

GET /v1/scrape/linkedin/post
Get a Linkedin post. This can be a post or an article.

<Note>
  💳 **1 credit** per request
</Note>


# Post Transcript
Source: https://docs.sociavault.com/api-reference/linkedin/post-transcript

GET /v1/scrape/linkedin/post/transcript
Get the transcript from a LinkedIn post video, when LinkedIn exposes one. Returns the transcript text for the video attached to the given post.

<Note>
  💳 **1 credit** per request
</Note>

Get the transcript from a LinkedIn post video, when LinkedIn exposes one. Pass the post `url` and, if a transcript is available, it's returned in the response.


# Person's Profile
Source: https://docs.sociavault.com/api-reference/linkedin/profile

GET /v1/scrape/linkedin/profile
Get a person's public LinkedIn profile including their recent posts. Returns only publicly available data — equivalent to what is visible in an incognito browser. Note: LinkedIn no longer exposes work history or job title publicly.

<Note>
  💳 **1 credit** per request
</Note>


# Board
Source: https://docs.sociavault.com/api-reference/pinterest/board

GET /v1/scrape/pinterest/board
Get the pins of a Pinterest board

<Note>
  💳 **1 credit** per request
</Note>


# Pin
Source: https://docs.sociavault.com/api-reference/pinterest/pin

GET /v1/scrape/pinterest/pin
Get Pinterest pin details

<Note>
  💳 **1 credit** per request
</Note>


# Search
Source: https://docs.sociavault.com/api-reference/pinterest/search

GET /v1/scrape/pinterest/search
Search Pinterest for pins

<Note>
  💳 **1 credit** per request
</Note>


# User Boards
Source: https://docs.sociavault.com/api-reference/pinterest/user-boards

GET /v1/scrape/pinterest/user/boards
Get a user's boards

<Note>
  💳 **1 credit** per request
</Note>


# Post Comments
Source: https://docs.sociavault.com/api-reference/reddit/post-comments

GET /v1/scrape/reddit/post/comments
Get comments and post information from a Reddit post

<Note>
  💳 **1 credit** per request
</Note>


# Post Transcript
Source: https://docs.sociavault.com/api-reference/reddit/post-transcript

GET /v1/scrape/reddit/post/transcript
Get the transcript from a Reddit video post.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# Search
Source: https://docs.sociavault.com/api-reference/reddit/search

GET /v1/scrape/reddit/search
Search Reddit for posts

<Note>
  💳 **1 credit** per request
</Note>


# Subreddit Posts
Source: https://docs.sociavault.com/api-reference/reddit/subreddit

GET /v1/scrape/reddit/subreddit
Get recent posts from a subreddit with engagement metrics

<Note>
  💳 **1 credit** per request
</Note>


# Subreddit Details
Source: https://docs.sociavault.com/api-reference/reddit/subreddit-details

GET /v1/scrape/reddit/subreddit/details
Get details about a subreddit. Pass a subreddit name or URL to the subreddit.

**Credit Cost:** 1 credit per request

<Note>
  💳 **1 credit** per request
</Note>


# Subreddit Search
Source: https://docs.sociavault.com/api-reference/reddit/subreddit-search

GET /v1/scrape/reddit/subreddit/search
Search within a subreddit for posts, comments, or media matching a query

<Note>
  💳 **1 credit** per request
</Note>


# Post
Source: https://docs.sociavault.com/api-reference/threads/post

GET /v1/scrape/threads/post
Get a post by url. Also returns comments and related posts.

<Note>
  💳 **1 credit** per request
</Note>


# Profile
Source: https://docs.sociavault.com/api-reference/threads/profile

GET /v1/scrape/threads/profile
Get Threads profile info

<Note>
  💳 **1 credit** per request
</Note>


# Search Users
Source: https://docs.sociavault.com/api-reference/threads/search-users

GET /v1/scrape/threads/search-users
Search for users by username

<Note>
  💳 **1 credit** per request
</Note>


# Posts
Source: https://docs.sociavault.com/api-reference/threads/user-posts

GET /v1/scrape/threads/user-posts
Get recent posts from a Threads user. Note: Threads limits public access to approximately the last 20–30 posts per user.

<Note>
  💳 **1 credit** per request
</Note>


# Get Ad Details
Source: https://docs.sociavault.com/api-reference/tiktok-ad-library/ad

GET /v1/scrape/tiktok-ad-library/ad
Retrieve the full details for a single TikTok Creative Center Top Ad by its ad ID, including creative assets, metrics, and metadata.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# Search Top Ads
Source: https://docs.sociavault.com/api-reference/tiktok-ad-library/search

GET /v1/scrape/tiktok-ad-library/search
Discover the best-performing TikTok Creative Center ads across regions, industries, and time windows. Filter by keyword, objective, format, and engagement metrics to study what's working in any market.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# Product Details
Source: https://docs.sociavault.com/api-reference/tiktok-shop/product-details

GET /v1/scrape/tiktok-shop/product-details
Get detailed information about a specific TikTok Shop product, including current stock levels, related TikTok videos promoting the product, and additional metadata. This endpoint currently supports US TikTok Shop products only.

<Note>
  💳 **1 credit** per request
</Note>


# Product Reviews
Source: https://docs.sociavault.com/api-reference/tiktok-shop/product-reviews

GET /v1/scrape/tiktok-shop/product-reviews
Get a product's reviews (100 reviews per page).

**Credit Cost:** 1 credit per request

<Note>
  💳 **1 credit** per request
</Note>


# Shop Products
Source: https://docs.sociavault.com/api-reference/tiktok-shop/products

GET /v1/scrape/tiktok-shop/products
Get all products listed in a TikTok Shop. Use the cursor from each response to paginate through results.

**Credit Cost:** 1 credit per request

**Note:** Non-US shop catalog coverage depends on TikTok exposing that shop in the selected region.

<Note>
  💳 **1 credit per request**
</Note>


# Shop Search
Source: https://docs.sociavault.com/api-reference/tiktok-shop/search

GET /v1/scrape/tiktok-shop/search
Search TikTok Shop for products by keyword. Returns 30 products per page — use the page parameter to navigate through results.

**Credit Cost:** 1 credit per request

<Note>
  💳 **1 credit per request**
</Note>


# Comment Replies
Source: https://docs.sociavault.com/api-reference/tiktok/comment-replies

GET /v1/scrape/tiktok/comment-replies
Scrapes replies to a TikTok comment

<Note>
  💳 **1 credit** per request
</Note>


# Comments
Source: https://docs.sociavault.com/api-reference/tiktok/comments

GET /v1/scrape/tiktok/comments
Scrapes comments from a TikTok video

<Note>
  💳 **1 credit** per request
</Note>


# User's Audience Demographics
Source: https://docs.sociavault.com/api-reference/tiktok/demographics

GET /v1/scrape/tiktok/demographics
Returns audience demographic data for a TikTok user. Currently includes audience country distribution.

**Credit Cost:** 26 credits per request

<Note>
  💳 **26 credits** per request
</Note>


# Followers
Source: https://docs.sociavault.com/api-reference/tiktok/followers

GET /v1/scrape/tiktok/followers
Scrapes followers of a TikTok account

<Note>
  💳 **1 credit** per request
</Note>


# Following
Source: https://docs.sociavault.com/api-reference/tiktok/following

GET /v1/scrape/tiktok/following
Scrapes accounts that a TikTok user follows

<Note>
  💳 **1 credit** per request
</Note>


# TikTok Live
Source: https://docs.sociavault.com/api-reference/tiktok/live

GET /v1/scrape/tiktok/live
Scrapes a TikTok user's live stream

<Note>
  💳 **1 credit** per request
</Note>


# Get Song Details
Source: https://docs.sociavault.com/api-reference/tiktok/music-details

GET /v1/scrape/tiktok/music/details
Get detailed metadata for a specific TikTok song.

<Note>
  💳 **1 credit** per request
</Note>


# TikToks using Song
Source: https://docs.sociavault.com/api-reference/tiktok/music-videos

GET /v1/scrape/tiktok/music/videos
Get the TikToks using a song

<Note>
  💳 **1 credit** per request
</Note>


# Profile
Source: https://docs.sociavault.com/api-reference/tiktok/profile

GET /v1/scrape/tiktok/profile
Scrapes a public TikTok profile

<Note>
  💳 **1 credit** per request
</Note>


# Search by Hashtag
Source: https://docs.sociavault.com/api-reference/tiktok/search-hashtag

GET /v1/scrape/tiktok/search/hashtag
Scrapes TikTok videos by hashtag

<Note>
  💳 **1 credit** per request
</Note>


# Search by Keyword
Source: https://docs.sociavault.com/api-reference/tiktok/search-keyword

GET /v1/scrape/tiktok/search/keyword
Scrapes TikTok videos matching a keyword

<Note>
  💳 **1 credit** per request
</Note>


# Search Music
Source: https://docs.sociavault.com/api-reference/tiktok/search-music

GET /v1/scrape/tiktok/search/music
Search TikTok sounds and music by keyword. Returns 10 results per page — use the `offset` parameter with the `cursor` value from the previous response to load more.

<Note>
  💳 **1 credit** per request — returns 10 results. Use `offset` to paginate.
</Note>


# Top Search
Source: https://docs.sociavault.com/api-reference/tiktok/search-top

GET /v1/scrape/tiktok/search/top
Access TikTok's 'Top' search results, which include both Photo Carousels and Videos. Unlike the Keyword Search endpoint, this returns mixed content types.

<Note>
  💳 **1 credit** per request
</Note>


# Search Users
Source: https://docs.sociavault.com/api-reference/tiktok/search-users

GET /v1/scrape/tiktok/search/users
Scrapes TikTok users matching a search query

<Note>
  💳 **1 credit** per request
</Note>


# Transcript
Source: https://docs.sociavault.com/api-reference/tiktok/transcript

GET /v1/scrape/tiktok/transcript
Returns the transcript from a TikTok video. Enable the AI fallback option to generate a transcript when one is not natively available — note this costs 10 credits instead of 1.

**Credit Cost:** 1 credit (or 10 credits with AI fallback)

<Note>
  💳 **1 credit** per request
</Note>


# Trending Feed
Source: https://docs.sociavault.com/api-reference/tiktok/trending

GET /v1/scrape/tiktok/trending
Get the trending feed from TikTok.

<Note>
  💳 **1 credit** per request
</Note>


# Video Info
Source: https://docs.sociavault.com/api-reference/tiktok/video-info

GET /v1/scrape/tiktok/video-info
Scrapes data from a TikTok video

<Note>
  💳 **1 credit** per request
</Note>


# Profile Videos
Source: https://docs.sociavault.com/api-reference/tiktok/videos

GET /v1/scrape/tiktok/videos
Scrapes videos from a TikTok profile. Pass cursor to get more videos.

<Note>
  💳 **1 credit** per request
</Note>


# Clip
Source: https://docs.sociavault.com/api-reference/twitch/clip

GET /v1/scrape/twitch/clip
Get details of a Twitch clip.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# Profile
Source: https://docs.sociavault.com/api-reference/twitch/profile

GET /v1/scrape/twitch/profile
Get a Twitch user's public profile information.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# User Schedule
Source: https://docs.sociavault.com/api-reference/twitch/user-schedule

GET /v1/scrape/twitch/user/schedule
Get a Twitch user's streaming schedule.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# User Videos
Source: https://docs.sociavault.com/api-reference/twitch/user-videos

GET /v1/scrape/twitch/user/videos
Get videos from a Twitch user.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# Tweet Comments
Source: https://docs.sociavault.com/api-reference/twitter/comments

GET /v1/scrape/twitter/comments
Get comments (replies) on a specific tweet. Results are paginated. Use the cursor parameter to fetch additional pages.

<Note>
  💳 **1 credit** per request
</Note>


# Community
Source: https://docs.sociavault.com/api-reference/twitter/community

GET /v1/scrape/twitter/community
Get the details of a Twitter(X) Community

<Note>
  💳 **1 credit** per request
</Note>


# Community Tweets
Source: https://docs.sociavault.com/api-reference/twitter/community-tweets

GET /v1/scrape/twitter/community/tweets
Get the tweets from a Twitter(X) Community

<Note>
  💳 **1 credit** per request
</Note>


# Profile
Source: https://docs.sociavault.com/api-reference/twitter/profile

GET /v1/scrape/twitter/profile
Get Twitter profile information including stats and metadata

<Note>
  💳 **1 credit** per request
</Note>


# Search
Source: https://docs.sociavault.com/api-reference/twitter/search

GET /v1/scrape/twitter/search
Search Twitter for tweets, users, photos, media, and more. Results are paginated — use the cursor parameter to fetch additional pages.

<Note>
  💳 **1 credit** per request
</Note>


# Tweet Details
Source: https://docs.sociavault.com/api-reference/twitter/tweet

GET /v1/scrape/twitter/tweet
Get detailed information about a specific tweet including engagement

<Note>
  💳 **1 credit** per request
</Note>


# Transcript
Source: https://docs.sociavault.com/api-reference/twitter/tweet-transcript

GET /v1/scrape/twitter/tweet/transcript
Generate an AI-powered transcript for a video tweet. Response times may be slower than other endpoints due to AI processing.

<Note>
  💳 **1 credit** per request
</Note>


# User Tweets
Source: https://docs.sociavault.com/api-reference/twitter/user-tweets

GET /v1/scrape/twitter/user-tweets
Get tweets from a user's public profile. Note: Twitter's public API surfaces the user's ~100 most popular tweets, not their most recent ones.

<Note>
  💳 **1 credit** per request
</Note>


# User Tweets (All)
Source: https://docs.sociavault.com/api-reference/twitter/user-tweets-all

GET /v1/scrape/twitter/user-tweets-all
Get a user's latest tweets in chronological order using their numeric `rest_id`. Returns paginated timeline results — use the cursor parameter to load more. Maximum of 20 tweets per request.

<Note>
  💳 **1 credit** per request
</Note>


# Channel Details
Source: https://docs.sociavault.com/api-reference/youtube/channel

GET /v1/scrape/youtube/channel
Get comprehensive channel information including stats and metadata. Can pass channelId, handle, or url.

<Note>
  💳 **1 credit** per request
</Note>


# Channel Community Posts
Source: https://docs.sociavault.com/api-reference/youtube/channel-community-posts

GET /v1/scrape/youtube/channel/community-posts
Get community posts from a YouTube channel. Can pass channelId or handle.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# Channel Lives
Source: https://docs.sociavault.com/api-reference/youtube/channel-lives

GET /v1/scrape/youtube/channel/lives
Get live streams and past streams from a YouTube channel. Can pass channelId or handle.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# Channel Playlists
Source: https://docs.sociavault.com/api-reference/youtube/channel-playlists

GET /v1/scrape/youtube/channel/playlists
Get playlists from a YouTube channel. Can pass channelId or handle.

**Credit Cost:** 1 credit per request

<Note>💳 **1 credit per request**</Note>


# Channel Shorts
Source: https://docs.sociavault.com/api-reference/youtube/channel-shorts

GET /v1/scrape/youtube/channel/shorts
Get shorts from a YouTube channel. For additional details such as description or publish date, use the 'Video/Short Details' endpoint.

<Note>
  💳 **1 credit** per request
</Note>


# Channel Videos
Source: https://docs.sociavault.com/api-reference/youtube/channel-videos

GET /v1/scrape/youtube/channel-videos
Get all videos from a channel with detailed information. Can pass channelId or handle.

<Note>
  💳 **1 credit** per request
</Note>


# Search
Source: https://docs.sociavault.com/api-reference/youtube/search

GET /v1/scrape/youtube/search
Search YouTube and get matching videos, channels, playlists, shorts, lives, etc.

<Note>
  💳 **1 credit** per request
</Note>


# Search by Hashtag
Source: https://docs.sociavault.com/api-reference/youtube/search-hashtag

GET /v1/scrape/youtube/search/hashtag
Search YouTube and get matching videos, channels, and playlists

<Note>
  💳 **1 credit** per request
</Note>


# Trending Shorts
Source: https://docs.sociavault.com/api-reference/youtube/shorts-trending

GET /v1/scrape/youtube/shorts/trending
Get about 48 trending shorts

<Note>
  💳 **1 credit** per request
</Note>


# Video/Short Details
Source: https://docs.sociavault.com/api-reference/youtube/video

GET /v1/scrape/youtube/video
Get complete information about a video or short. To get transcripts, use the dedicated /v1/scrape/youtube/video/transcript endpoint.

<Note>
  💳 **1 credit** per request
</Note>


# Comment Replies
Source: https://docs.sociavault.com/api-reference/youtube/video-comment-replies

GET /v1/scrape/youtube/video/comment-replies
Get replies to a specific comment on a YouTube video.

**Credit Cost:** 1 credit per request

<Note>
  💳 **1 credit** per request — use `repliesContinuationToken` from the Comments endpoint to get replies.
</Note>


# Comments
Source: https://docs.sociavault.com/api-reference/youtube/video-comments

GET /v1/scrape/youtube/video/comments
Get top-level comments from a YouTube video, paginated at ~20 per page. Use the `continuationToken` from each response to load more. Maximum retrievable: ~1,000 comments with `order=top` or ~7,000 with `order=newest`. Note: YouTube's displayed comment count includes reply threads, so the total returned may be lower.

<Note>
  💳 **1 credit** per request — returns \~20 comments per page. Use `continuationToken` to paginate.
</Note>


# Transcript
Source: https://docs.sociavault.com/api-reference/youtube/video-transcript

GET /v1/scrape/youtube/video/transcript
Get transcript of a video or short

<Note>
  💳 **1 credit** per request
</Note>


# Authentication
Source: https://docs.sociavault.com/development

How to authenticate with the SociaVault API

## Authentication

All API requests require authentication using your API key in the `X-API-Key` header.

### Getting Your API Key

1. Sign up at [sociavault.com](https://sociavault.com)
2. Navigate to your [Dashboard](https://sociavault.com/dashboard)
3. Copy your API key (starts with `sk_live_`)

### Using Your API Key

Include your API key in every request using the `X-API-Key` header:

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://api.sociavault.com/v1/scrape/tiktok/profile?handle=stoolpresidente' \
    --header 'X-API-Key: sk_live_your_api_key_here'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(url, {
    headers: {
      'X-API-Key': 'sk_live_your_api_key_here'
    }
  });
  ```

  ```python Python theme={null}
  import requests

  headers = {
      'X-API-Key': 'sk_live_your_api_key_here'
  }

  response = requests.get(url, headers=headers)
  ```

  ```php PHP theme={null}
  $headers = [
      'X-API-Key: sk_live_your_api_key_here'
  ];

  curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  ```
</CodeGroup>

<Warning>
  **Keep your API key secure!** Never expose it in client-side code, public repositories, or share it publicly.
</Warning>

## API Performance

The SociaVault API is built to scale automatically with your needs.

<CardGroup>
  <Card title="Auto-Scaling" icon="arrows-up-down">
    Our infrastructure automatically scales to handle your request volume
  </Card>

  <Card title="High Availability" icon="server">
    99.9% uptime with redundant systems and automatic failover
  </Card>

  <Card title="Global CDN" icon="globe">
    Fast response times from anywhere in the world
  </Card>

  <Card title="No Rate Limits" icon="infinity">
    Send as many requests as you need - we scale with you
  </Card>
</CardGroup>

<Info>
  **Enterprise-grade infrastructure** ensures your requests are handled quickly and reliably, no matter the volume.
</Info>

## Credit System

Each API endpoint consumes credits based on data complexity:

| Complexity | Credit Cost  | Examples                    |
| ---------- | ------------ | --------------------------- |
| Simple     | 1 credit     | Profile lookups, basic info |
| Moderate   | 5-10 credits | Posts, videos, comments     |
| Complex    | 20+ credits  | Demographics, analytics     |

<Info>
  Check individual endpoint documentation for specific credit costs.
</Info>

### Checking Your Balance

Monitor your credit balance in real-time via the [Dashboard](https://sociavault.com/dashboard).

<Tip>
  Each API response includes your remaining credits in the response headers for easy tracking.
</Tip>

## Error Responses

The API uses standard HTTP status codes and returns detailed error messages:

| Status Code | Description                               |
| ----------- | ----------------------------------------- |
| 200         | Success                                   |
| 400         | Bad Request - Invalid parameters          |
| 401         | Unauthorized - Invalid or missing API key |
| 403         | Forbidden - Insufficient credits          |
| 500         | Internal Server Error                     |

### Error Response Format

```json theme={null}
{
  "error": "Unauthorized",
  "message": "Invalid API key provided",
  "statusCode": 401
}
```

## Best Practices

<AccordionGroup>
  <Accordion title="Secure Your API Key" icon="lock">
    * Store API keys in environment variables
    * Never commit API keys to version control
    * Use different keys for development and production
    * Rotate keys regularly for security
  </Accordion>

  <Accordion title="Optimize Credit Usage" icon="coins">
    * Cache frequently accessed data
    * Use pagination for large datasets
    * Only request the data you need
    * Monitor your usage in the dashboard
  </Accordion>

  <Accordion title="Error Handling" icon="triangle-exclamation">
    * Always check response status codes
    * Implement proper error handling
    * Log errors for debugging
    * Retry failed requests with exponential backoff
  </Accordion>

  <Accordion title="Performance Optimization" icon="bolt">
    * Implement caching strategies
    * Use batch requests when possible
    * Monitor response times in your logs
    * Contact support for optimization advice
  </Accordion>
</AccordionGroup>

## Need Help?

<CardGroup>
  <Card title="View Pricing" icon="credit-card" href="https://sociavault.com/pricing">
    See credit costs for each endpoint
  </Card>

  <Card title="Contact Support" icon="envelope" href="mailto:support@sociavault.com">
    Get help with authentication or API usage
  </Card>
</CardGroup>


# Welcome to SociaVault
Source: https://docs.sociavault.com/index

Extract social media data from multiple platforms with our powerful API

## Get Started in Minutes

Start extracting social media data with just a few lines of code.

<CardGroup>
  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Browse all available endpoints and platforms
  </Card>

  <Card title="Quickstart Guide" icon="rocket" href="/quickstart">
    Make your first API call in under 5 minutes
  </Card>

  <Card title="API Playground" icon="play" href="https://sociavault.com/playground">
    Test API endpoints in your browser
  </Card>

  <Card title="View Pricing" icon="credit-card" href="https://sociavault.com/pricing">
    Simple credit-based pricing
  </Card>
</CardGroup>

## Supported Platforms

Extract comprehensive data from all major social media platforms.

<CardGroup>
  <Card title="TikTok" icon="tiktok" href="/api-reference/tiktok/profile">
    Profiles, videos, analytics, demographics & more
  </Card>

  <Card title="Instagram" icon="instagram" href="/api-reference/instagram/profile">
    Posts, reels, stories, highlights & engagement
  </Card>

  <Card title="YouTube" icon="youtube" href="/api-reference/youtube/channel">
    Channels, videos, shorts, comments & transcripts
  </Card>

  <Card title="Facebook" icon="facebook" href="/api-reference/facebook/profile">
    Profiles, posts, groups & engagement data
  </Card>

  <Card title="Twitter" icon="x-twitter" href="/api-reference/twitter/profile">
    Profiles, tweets, communities & threads
  </Card>

  <Card title="Reddit" icon="reddit" href="/api-reference/reddit/subreddit">
    Subreddits, posts & comments
  </Card>

  <Card title="LinkedIn" icon="linkedin" href="/api-reference/linkedin/profile">
    Profiles, companies, posts & professional data
  </Card>

  <Card title="Threads" icon="threads" href="/api-reference/threads/profile">
    Profiles, posts, search & engagement
  </Card>

  <Card title="Pinterest" icon="pinterest" href="/api-reference/pinterest/search">
    Search pins, pin details, boards & user content
  </Card>

  <Card title="TikTok Shop" icon="shop" href="/api-reference/tiktok-shop/products">
    Products, details & shop search
  </Card>

  <Card title="Facebook Ad Library" icon="rectangle-ad" href="/api-reference/facebook-ad-library/ad-details">
    Meta ad intelligence & competitor research
  </Card>

  <Card title="Google Ad Library" icon="rectangle-ad" href="/api-reference/google-ad-library/company-ads">
    Google ad transparency & insights
  </Card>

  <Card title="LinkedIn Ad Library" icon="rectangle-ad" href="/api-reference/linkedin-ad-library/search">
    LinkedIn ad intelligence & analysis
  </Card>

  <Card title="Google Search" icon="google" href="/api-reference/google/search">
    Search results & SERP data extraction
  </Card>
</CardGroup>

## Why Choose SociaVault?

<CardGroup>
  <Card title="Affordable Pricing" icon="coins">
    Most endpoints cost just 1 credit. Pay only for what you use.
  </Card>

  <Card title="High Performance" icon="bolt">
    Fast, reliable data extraction with 99.9% uptime.
  </Card>

  <Card title="Comprehensive Data" icon="database">
    Get detailed profiles, analytics, engagement metrics & more.
  </Card>

  <Card title="Developer Friendly" icon="code">
    Simple REST API with detailed documentation & code examples.
  </Card>
</CardGroup>

## Ready to Start?

<Card title="Get Your API Key" icon="key" href="https://sociavault.com/dashboard">
  Sign up for free and get your API key to start building.
</Card>


# MCP Server
Source: https://docs.sociavault.com/mcp-server

Use SociaVault from Claude, Cursor, VS Code, ChatGPT, and any AI agent with the official MCP server

## Give your AI assistant live social data

The **SociaVault MCP server** connects your AI assistant directly to the SociaVault API using the [Model Context Protocol](https://modelcontextprotocol.io) — an open standard for plugging tools into AI clients. Claude, Cursor, VS Code, Cline, ChatGPT, and any other MCP-compatible client can pull real-time data from **11 platforms** and reason over it, in plain English.

It exposes **107 tools** covering profiles, posts, comments, transcripts, search, trends, and ad libraries — every one mapped to a documented SociaVault endpoint.

There are two ways to connect, and they expose the exact same tools:

* **Local** — runs on your machine via `npx`. Best for Claude Desktop, Cursor, VS Code, and Cline.
* **Remote (hosted)** — our hosted server at `https://mcp.sociavault.net/mcp`. Nothing to install. Required for **ChatGPT** and handy for any client that connects to a remote MCP URL.

<CardGroup>
  <Card title="npm package" icon="npm" href="https://www.npmjs.com/package/sociavault-mcp">
    sociavault-mcp on npm
  </Card>

  <Card title="MCP Registry" icon="server" href="https://registry.modelcontextprotocol.io">
    Listed on the official registry
  </Card>

  <Card title="Smithery" icon="package" href="https://smithery.ai/server/olaniyanolamide42/sociavault-mcp">
    Install via Smithery
  </Card>

  <Card title="Full guide" icon="book" href="https://sociavault.com/blog/social-media-mcp-server">
    Read the complete walkthrough
  </Card>
</CardGroup>

## Local install (Claude, Cursor, VS Code, Cline)

The server runs through `npx`, so there's nothing to install globally — your client fetches the latest version automatically.

<Steps>
  <Step title="Get your API key">
    Sign up at [sociavault.com](https://sociavault.com/signup) and copy your API key (format `sk_live_...`) from the [Dashboard](https://sociavault.com/dashboard).
  </Step>

  <Step title="Add the server to your client">
    Pick your client below and add the configuration with your API key.

    <CodeGroup>
      ```json Claude Desktop theme={null}
      {
        "mcpServers": {
          "sociavault": {
            "command": "npx",
            "args": ["-y", "sociavault-mcp"],
            "env": {
              "SOCIAVAULT_API_KEY": "sk_live_your_key_here"
            }
          }
        }
      }
      ```

      ```json Cursor theme={null}
      {
        "mcpServers": {
          "sociavault": {
            "command": "npx",
            "args": ["-y", "sociavault-mcp"],
            "env": { "SOCIAVAULT_API_KEY": "sk_live_your_key_here" }
          }
        }
      }
      ```

      ```json VS Code theme={null}
      {
        "servers": {
          "sociavault": {
            "command": "npx",
            "args": ["-y", "sociavault-mcp"],
            "env": { "SOCIAVAULT_API_KEY": "sk_live_your_key_here" }
          }
        }
      }
      ```
    </CodeGroup>

    <Info>
      **Claude Desktop config location** — macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` · Windows: `%APPDATA%\Claude\claude_desktop_config.json`. **Cursor**: `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (per-project). **VS Code**: `.vscode/mcp.json`.
    </Info>
  </Step>

  <Step title="Restart and ask a question">
    Restart your client and try: *"Get the TikTok profile for @nike."* If you get back follower counts and bio details, you're live.

    <Check>
      Your AI assistant now has live access to social media data across 11 platforms.
    </Check>
  </Step>
</Steps>

## Remote server (ChatGPT & other hosted clients)

Prefer not to install anything, or connecting from ChatGPT? Use our hosted server. It runs the same 107 tools and requires no local setup — you just point your client at a URL and supply your API key.

```
https://mcp.sociavault.net/mcp
```

### Authentication

The hosted server bills usage to **your** account, so every request must carry your SociaVault API key. Provide it either way:

* **URL query** — append `?apiKey=sk_live_your_key_here` to the endpoint. Works with every client, including ones that can't set custom headers.
* **Header** — send `x-api-key: sk_live_your_key_here` (or `Authorization: Bearer sk_live_...`).

<Warning>
  A key placed in the URL can show up in server logs and browser history. If
  your client supports custom headers, prefer the `x-api-key` header. Treat the
  URL as a secret either way, and rotate the key from your
  [Dashboard](https://sociavault.com/dashboard) if it leaks.
</Warning>

### Connect from ChatGPT

<Info>
  ChatGPT's custom MCP connectors require **Developer Mode**, available on paid
  ChatGPT plans (Pro, Business, Enterprise, Edu). This is an OpenAI setting, not
  a SociaVault one.
</Info>

<Steps>
  <Step title="Enable Developer Mode">
    In ChatGPT, open **Settings → Connectors → Advanced** and turn on
    **Developer mode**.
  </Step>

  <Step title="Add a custom connector">
    Go to **Settings → Connectors → Create**, and enter:

    * **Name:** `SociaVault`
    * **MCP Server URL:** `https://mcp.sociavault.net/mcp?apiKey=sk_live_your_key_here`
    * **Authentication:** No authentication (your key is already in the URL)
  </Step>

  <Step title="Use it in a chat">
    Enable the SociaVault connector for your conversation, then ask something
    like *"Get the TikTok profile for @nike."*

    <Check>
      ChatGPT now pulls live social data through the hosted SociaVault server.
    </Check>
  </Step>
</Steps>

### Connect from other clients

Any client that supports remote MCP servers (Claude, Cursor, and others) can use the hosted URL instead of the local `npx` setup — point it at `https://mcp.sociavault.net/mcp?apiKey=sk_live_your_key_here`.

## Configuration

<ParamField type="string">
  Your SociaVault API key (`sk_live_...`). Get one at the
  [Dashboard](https://sociavault.com/dashboard).
</ParamField>

<ParamField type="string">
  Optional override for the API base URL. Defaults to
  `https://api.sociavault.com`.
</ParamField>

## Example prompts

The model picks the right tool automatically — you just describe what you want:

<AccordionGroup>
  <Accordion title="Creator research" icon="user">
    "Compare the follower counts and engagement of @cristiano on Instagram vs.
    his YouTube channel."
  </Accordion>

  <Accordion title="Competitor ad intelligence" icon="rectangle-ad">
    "Search the Meta Ad Library for active Nike ads in the US and summarize
    their angles."
  </Accordion>

  <Accordion title="Content repurposing" icon="closed-captioning">
    "Get the transcript of this YouTube video and turn it into a LinkedIn post:
    \<url>"
  </Accordion>

  <Accordion title="Social listening" icon="magnifying-glass">
    "Pull the last 30 posts from r/webscraping and tell me the recurring pain
    points."
  </Accordion>

  <Accordion title="Trend monitoring" icon="arrow-trend-up">
    "What's trending on TikTok in the US right now, and which sounds are
    surging?"
  </Accordion>
</AccordionGroup>

## What's included

All tools are read-only. Most accept a `trim` option (on by default) that returns a smaller, AI-friendly payload to conserve context-window tokens. List endpoints support cursor pagination.

<CardGroup>
  <Card title="TikTok" icon="tiktok">
    Profiles, videos, comments, transcripts, search, music, trending
  </Card>

  <Card title="Instagram" icon="instagram">
    Profiles, posts, reels, comments, transcripts, highlights
  </Card>

  <Card title="YouTube" icon="youtube">
    Channels, videos, shorts, transcripts, search, comments
  </Card>

  <Card title="Twitter / X" icon="x-twitter">
    Profiles, tweets, replies, quotes, retweets, search
  </Card>

  <Card title="LinkedIn" icon="linkedin">
    Profiles, companies, posts
  </Card>

  <Card title="Facebook" icon="facebook">
    Profiles, posts, reels, groups, comments, transcripts
  </Card>

  <Card title="Reddit" icon="reddit">
    Subreddits, posts, comments, transcripts, search
  </Card>

  <Card title="Threads, Pinterest, Twitch" icon="layer-group">
    Profiles, posts, pins, boards, clips, schedules
  </Card>

  <Card title="Ad libraries" icon="rectangle-ad">
    TikTok, Meta, Google, and LinkedIn ad libraries
  </Card>
</CardGroup>

## Pricing

The MCP server is free and open source. You only pay for the SociaVault API usage it makes, billed in **credits** — the same [credit-based pricing](https://sociavault.com/pricing) as the REST API. New accounts start with free credits, and you can check your balance any time by asking your assistant to run the `check_credits` tool.

## FAQ

<AccordionGroup>
  <Accordion title="Which clients are supported?">
    Any MCP-compatible client. For local install (Claude Desktop, Cursor, VS
    Code Copilot, Cline), run `npx -y sociavault-mcp` with your API key in the
    environment. For ChatGPT — and any client that connects to a remote MCP URL
    — use the hosted server at `https://mcp.sociavault.net/mcp` instead.
  </Accordion>

  <Accordion title="Is my API key safe?">
    With the local install, your key stays in your own client's config and is
    sent only to the SociaVault API. With the hosted server, your key is passed
    through our server to the API to authenticate the request — it isn't stored.
    Either way the server is read-only: it never posts or changes anything. If
    you use the URL query method, prefer the `x-api-key` header where your
    client supports it, and rotate the key from your Dashboard if it leaks.
  </Accordion>

  <Accordion title="Do I need Node.js?">
    Only for the local install — Node.js 18 or newer, since it runs via `npx`.
    Most developer machines already have it. The hosted server
    (`https://mcp.sociavault.net/mcp`) needs nothing installed.
  </Accordion>

  <Accordion title="How do I update it?">
    Because it runs with `npx -y sociavault-mcp`, your client always fetches the
    latest published version. There's nothing to update manually.
  </Accordion>
</AccordionGroup>

## Need help?

<CardGroup>
  <Card title="Email Support" icon="envelope" href="mailto:support@sociavault.com">
    Get help from our team
  </Card>

  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Prefer raw REST? Start here
  </Card>
</CardGroup>


# Quickstart
Source: https://docs.sociavault.com/quickstart

Make your first API call in under 5 minutes

## Get Started in 3 Steps

Follow this guide to make your first successful API call to SociaVault.

<Steps>
  <Step title="Get Your API Key">
    Sign up for a free account and get your API key from the [SociaVault Dashboard](https://sociavault.com/dashboard).

    <Warning>
      Keep your API key secure! Never expose it in client-side code or public repositories.
    </Warning>
  </Step>

  <Step title="Make Your First Request">
    Try fetching a TikTok profile. Replace `YOUR_API_KEY` with your actual API key:

    <CodeGroup>
      ```bash cURL theme={null}
      curl --request GET \
        --url 'https://api.sociavault.com/v1/scrape/tiktok/profile?handle=stoolpresidente' \
        --header 'X-API-Key: YOUR_API_KEY'
      ```

      ```javascript JavaScript theme={null}
      const response = await fetch(
        'https://api.sociavault.com/v1/scrape/tiktok/profile?handle=stoolpresidente',
        {
          headers: {
            'X-API-Key': 'YOUR_API_KEY'
          }
        }
      );
      const data = await response.json();
      console.log(data);
      ```

      ```python Python theme={null}
      import requests

      url = "https://api.sociavault.com/v1/scrape/tiktok/profile"
      params = {"handle": "stoolpresidente"}
      headers = {"X-API-Key": "YOUR_API_KEY"}

      response = requests.get(url, params=params, headers=headers)
      data = response.json()
      print(data)
      ```

      ```php PHP theme={null}
      <?php
      $url = 'https://api.sociavault.com/v1/scrape/tiktok/profile?handle=stoolpresidente';
      $headers = [
          'X-API-Key: YOUR_API_KEY'
      ];

      $ch = curl_init();
      curl_setopt($ch, CURLOPT_URL, $url);
      curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

      $response = curl_exec($ch);
      curl_close($ch);

      $data = json_decode($response, true);
      print_r($data);
      ?>
      ```
    </CodeGroup>

    <Tip>
      This endpoint costs **1 credit** per request. Free tier includes 100 credits.
    </Tip>
  </Step>

  <Step title="Check the Response">
    You should receive a JSON response with the TikTok profile data:

    ```json theme={null}
    {
      "user": {
        "id": "6828452746644210694",
        "uniqueId": "stoolpresidente",
        "nickname": "Dave Portnoy",
        "avatarLarger": "https://...",
        "signature": "Founder of Barstool Sports",
        "verified": true,
        "stats": {
          "followerCount": 3800000,
          "followingCount": 723,
          "heartCount": 56700000,
          "videoCount": 1245
        }
      }
    }
    ```

    <Check>
      **Success!** You've made your first API call. Now explore all 77 endpoints.
    </Check>
  </Step>
</Steps>

## What's Next?

<CardGroup>
  <Card title="Browse All Endpoints" icon="list" href="/api-reference/introduction">
    Explore all available endpoints and platforms
  </Card>

  <Card title="Try the Playground" icon="play" href="https://sociavault.com/playground">
    Test endpoints in your browser
  </Card>

  <Card title="View Pricing" icon="credit-card" href="https://sociavault.com/pricing">
    See credit costs for each endpoint
  </Card>

  <Card title="Check Your Credits" icon="coins" href="https://sociavault.com/dashboard">
    Monitor your usage in the dashboard
  </Card>
</CardGroup>

## Common Use Cases

<AccordionGroup>
  <Accordion title="Influencer Analytics" icon="chart-line">
    Extract follower counts, engagement rates, and audience demographics across platforms to track influencer performance.

    **Endpoints**: TikTok Demographics, Instagram Profile, YouTube Channel
  </Accordion>

  <Accordion title="Content Discovery" icon="magnifying-glass">
    Search for trending content, hashtags, and viral videos to inform your content strategy.

    **Endpoints**: TikTok Trending, Instagram Reels, YouTube Search
  </Accordion>

  <Accordion title="Competitor Analysis" icon="shield-halved">
    Monitor competitor profiles, posts, and engagement to stay ahead of the competition.

    **Endpoints**: All Profile endpoints, Posts endpoints, Video endpoints
  </Accordion>

  <Accordion title="Ad Intelligence" icon="rectangle-ad">
    Track competitor ads across Facebook, Google, and LinkedIn ad libraries.

    **Endpoints**: Facebook Ad Library, Google Ad Library, LinkedIn Ad Library
  </Accordion>
</AccordionGroup>

## Need Help?

<CardGroup>
  <Card title="Email Support" icon="envelope" href="mailto:support@sociavault.com">
    Get help from our support team
  </Card>

  <Card title="Join Discord" icon="discord" href="https://discord.gg/sociavault">
    Chat with our community
  </Card>
</CardGroup>