# SociaVault API

## Docs

- [Get Credits Balance](https://docs.sociavault.com/api-reference/credits.md): Returns the current credit balance and subscription status for the authenticated user
- [Ad Details](https://docs.sociavault.com/api-reference/facebook-ad-library/ad-details.md): Pass the Ad ID and get back details about the ad. Be careful that if an ad has multiple versions, you're actually going to want to get the title from the 'cards' object.
- [Company Ads](https://docs.sociavault.com/api-reference/facebook-ad-library/company-ads.md): Get all the ads a company has running
- [Search](https://docs.sociavault.com/api-reference/facebook-ad-library/search.md): Search the Facebook (Meta) Ad Library By Keyword. This endpoint will tap out around 1,500 results, beacuse the cursor becomes too big for a GET request. If you need more results, call this endpoint as a POST, and pass the query params in the body.
- [Search for Companies](https://docs.sociavault.com/api-reference/facebook-ad-library/search-companies.md): Search for companies by name and get their ad library page id
- [Facebook Group Posts](https://docs.sociavault.com/api-reference/facebook/group-posts.md): Get a public Facebook groups posts. Only can get 3 posts at a time :( (Facebook API limit)
- [Post](https://docs.sociavault.com/api-reference/facebook/post.md): Get a public Facebook post or reel by url.
- [Comments](https://docs.sociavault.com/api-reference/facebook/post-comments.md): Get the comments of a Facebook post (or reel)
- [Transcript](https://docs.sociavault.com/api-reference/facebook/post-transcript.md): Get the transcript of a Facebook post. Can be a post or reel.
- [Profile](https://docs.sociavault.com/api-reference/facebook/profile.md): Get public Facebook profile information
- [Profile Posts](https://docs.sociavault.com/api-reference/facebook/profile-posts.md): Get public Facebook profile posts. This only returns the posts you would see from an incognito browser session. You can pass a url or a pageId. pageId is faster. pageId is the id of the profile page. Only returns 3 posts at a time.
- [Profile Reels](https://docs.sociavault.com/api-reference/facebook/profile-reels.md): Get a public Facebook page's reels. Returns 10 reels at a time. **Important:** To paginate, you must pass BOTH 'next_page_id' AND 'cursor' together from the previous response.
- [Ad Details](https://docs.sociavault.com/api-reference/google-ad-library/ad-details.md): Get the details for an ad. I'm using an OCR to get the text from the ad, so it might not be 100% accurate.
- [Company Ads](https://docs.sociavault.com/api-reference/google-ad-library/company-ads.md): Get the ads for a company. *This only gets the public ads. Some ads you need to log in for and sadly we can't get those. This might be a bit slow since we are OCRing all the ads to get the text.
- [Search Advertisers](https://docs.sociavault.com/api-reference/google-ad-library/search-advertisers.md): Search the Google Ad Transparency Library for advertisers to get their advertiser id
- [Search](https://docs.sociavault.com/api-reference/google/search.md): Search Google
- [Comments](https://docs.sociavault.com/api-reference/instagram/comments.md): Get comments from an Instagram post or reel (~15 per page). Use the `cursor` from each response to paginate. Note: Instagram's displayed comment count includes replies and hidden comments — the API returns top-level visible comments only, so total results will typically be lower than the count shown…
- [Highlights Details](https://docs.sociavault.com/api-reference/instagram/highlight-detail.md): Get details about a specific highlight
- [Story Highlights](https://docs.sociavault.com/api-reference/instagram/highlights.md): Get story highlights from an Instagram user
- [Post/Reel Info](https://docs.sociavault.com/api-reference/instagram/post-info.md): Get the public detailed information about a specific post or reel. *Play counts can sometimes be inaccurate* Play counts are Instagram-only. When a Reel is also cross-posted to Facebook, Instagram (behind login) shows you the combined IG + FB views. But this API will only return the Instagram views.
- [Posts](https://docs.sociavault.com/api-reference/instagram/posts.md): Get a public profile's public posts. *Play counts can sometimes be inaccurate* Play counts are Instagram-only. When a Reel is also cross-posted to Facebook, Instagram (behind login) shows you the combined IG + FB views. But this API will only return the Instagram views.
- [Profile](https://docs.sociavault.com/api-reference/instagram/profile.md): Gets public Instagram profile data, recent posts, and related accounts
- [Reels](https://docs.sociavault.com/api-reference/instagram/reels.md): Get all public reels from a profile. Can provide a user_id or handle, but for faster response times, use user_id. This won't include pinned reels right now. And I'm not sure why, but it looks like IG doesn't return the description of the reel on this endpoint :( You'll have to use the post detail en…
- [Reels using Song](https://docs.sociavault.com/api-reference/instagram/reels-by-song.md): Get reels using a song
- [Transcript](https://docs.sociavault.com/api-reference/instagram/transcript.md): Get the transcript of an Instagram post or reel. This is a little slow since I run it through an AI. You can only get a transcript if the video is under 2 minutes. You should get results in 10-30 seconds. If no one is spreaking it should return null. Since some posts are carousel, it will return a t…
- [API Reference](https://docs.sociavault.com/api-reference/introduction.md): Complete guide to the SociaVault API - Extract data from multiple social media platforms
- [Ad Details](https://docs.sociavault.com/api-reference/linkedin-ad-library/ad-details.md): Get the details for an ad
- [Search Ads](https://docs.sociavault.com/api-reference/linkedin-ad-library/search.md): Search the LinkedIn Ad Library
- [Company Page](https://docs.sociavault.com/api-reference/linkedin/company.md): Get a LinkedIn company page
- [Post](https://docs.sociavault.com/api-reference/linkedin/post.md): Get a Linkedin post. This can be a post or an article.
- [Person's Profile](https://docs.sociavault.com/api-reference/linkedin/profile.md): Get a person's public profile (including recent posts) *Note this is for a persons public profile. This only returns what's publicly available, ie what you see in an incognito browser. So unfortunately LinkedIn doesn't return work history or job title publicly anymore :(
- [Board](https://docs.sociavault.com/api-reference/pinterest/board.md): Get the pins of a Pinterest board
- [Pin](https://docs.sociavault.com/api-reference/pinterest/pin.md): Get Pinterest pin details
- [Search](https://docs.sociavault.com/api-reference/pinterest/search.md): Search Pinterest for pins
- [User Boards](https://docs.sociavault.com/api-reference/pinterest/user-boards.md): Get a user's boards
- [Get Ad](https://docs.sociavault.com/api-reference/reddit/ad.md): Get a specific ad by id
- [Search Ads](https://docs.sociavault.com/api-reference/reddit/ads-search.md): Search the Reddit Ad Library. Can only get a max of 30 ads.
- [Post Comments](https://docs.sociavault.com/api-reference/reddit/post-comments.md): Get comments + post information from a Reddit post
- [Search](https://docs.sociavault.com/api-reference/reddit/search.md): Search Reddit for posts
- [Subreddit Posts](https://docs.sociavault.com/api-reference/reddit/subreddit.md): Get recent posts from a subreddit with engagement metrics
- [Subreddit Details](https://docs.sociavault.com/api-reference/reddit/subreddit-details.md): Get details about a subreddit. Pass a subreddit name or URL to the subreddit.
- [Subreddit Search](https://docs.sociavault.com/api-reference/reddit/subreddit-search.md): Search within a subreddit for posts, comments, or media matching a query
- [Post](https://docs.sociavault.com/api-reference/threads/post.md): Get a post by url. Also returns comments and related posts.
- [Profile](https://docs.sociavault.com/api-reference/threads/profile.md): Get Threads profile info
- [Search Users](https://docs.sociavault.com/api-reference/threads/search-users.md): Search for users by username
- [Posts](https://docs.sociavault.com/api-reference/threads/user-posts.md): Get Threads posts by user. Sadly, Threads only allows you to see the last 20-30ish posts of the user :(
- [Product Details](https://docs.sociavault.com/api-reference/tiktok-shop/product-details.md): Get the details of a TikTok Shop Product! Get the exact amount of stock the product has, related tiktok videos promoting the product, and more!
- [Product Reviews](https://docs.sociavault.com/api-reference/tiktok-shop/product-reviews.md): Get a product's reviews (100 reviews per page).
- [Shop Products](https://docs.sociavault.com/api-reference/tiktok-shop/products.md): Get the products from a TikTok Shop. Use the cursor from the response to paginate through results.
- [Shop Search](https://docs.sociavault.com/api-reference/tiktok-shop/search.md): Scrape TikTok Shop Products from a search! Use the page parameter to retrieve specific pages. NOTE: This costs 1 credit per request! TikTok returns 30 products per page.
- [Comment Replies](https://docs.sociavault.com/api-reference/tiktok/comment-replies.md): Scrapes replies to a TikTok comment
- [Comments](https://docs.sociavault.com/api-reference/tiktok/comments.md): Scrapes comments from a TikTok video
- [User's Audience Demographics](https://docs.sociavault.com/api-reference/tiktok/demographics.md): Get the audience demographics of a TikTok user. Right now you can only get the audience countries. 🚨 Costs 26 credits per request.
- [Followers](https://docs.sociavault.com/api-reference/tiktok/followers.md): Scrapes followers of a TikTok account
- [Following](https://docs.sociavault.com/api-reference/tiktok/following.md): Scrapes accounts that a TikTok user follows
- [TikTok Live](https://docs.sociavault.com/api-reference/tiktok/live.md): Scrapes a TikTok user's live stream
- [Get Song Details](https://docs.sociavault.com/api-reference/tiktok/music-details.md): Scraping details from the song detail
- [Get popular songs](https://docs.sociavault.com/api-reference/tiktok/music-popular.md): This endpoint can take up to 30 seconds. Get popular songs from TikTok. If you want to check out the page this is actually scraping, check out: https://ads.tiktok.com/business/creativecenter/inspiration/popular/music/pc/en
- [TikToks using Song](https://docs.sociavault.com/api-reference/tiktok/music-videos.md): Get the TikToks using a song
- [Get Popular Creators](https://docs.sociavault.com/api-reference/tiktok/popular-creators.md): Get popular creators from TikTok. Filter by follower count, creator country, audience country, and sort by engagement, follower count, or average views.
- [Get Popular Hashtags](https://docs.sociavault.com/api-reference/tiktok/popular-hashtags.md): Get popular hashtags from TikTok. Filter by time period, country, and show newly trending hashtags.
- [Get Popular Videos](https://docs.sociavault.com/api-reference/tiktok/popular-videos.md): Get popular videos from TikTok. Filter by time period, country, and sort by likes, views (hot), comments, or reposts.
- [Profile](https://docs.sociavault.com/api-reference/tiktok/profile.md): Scrapes a public TikTok profile
- [Search by Hashtag](https://docs.sociavault.com/api-reference/tiktok/search-hashtag.md): Scrapes TikTok videos by hashtag
- [Search by Keyword](https://docs.sociavault.com/api-reference/tiktok/search-keyword.md): Scrapes TikTok videos matching a keyword
- [Search Music](https://docs.sociavault.com/api-reference/tiktok/search-music.md): Search TikTok sounds and music by keyword. Returns 10 results per request. Use the `offset` parameter (set to the `cursor` value from the response) to paginate through more results.
- [Top Search](https://docs.sociavault.com/api-reference/tiktok/search-top.md): There is a 'Top' Search in TikTok and this is that. You can get Photo Carousels and Videos. Whereas with just the Keyword Search, you can only get Videos.
- [Search Users](https://docs.sociavault.com/api-reference/tiktok/search-users.md): Scrapes TikTok users matching a search query
- [Transcript](https://docs.sociavault.com/api-reference/tiktok/transcript.md): Scrapes transcript from a TikTok video. You can optionally enable AI as a fallback if the transcript is not found (costs 10 credits instead of 1).
- [Trending Feed](https://docs.sociavault.com/api-reference/tiktok/trending.md): Get the trending feed from TikTok.
- [Video Info](https://docs.sociavault.com/api-reference/tiktok/video-info.md): Scrapes data from a TikTok video
- [Profile Videos](https://docs.sociavault.com/api-reference/tiktok/videos.md): Scrapes videos from a TikTok profile. Pass cursor to get more videos.
- [Community](https://docs.sociavault.com/api-reference/twitter/community.md): Get the details of a Twitter(X) Community
- [Community Tweets](https://docs.sociavault.com/api-reference/twitter/community-tweets.md): Get the tweets from a Twitter(X) Community
- [Profile](https://docs.sociavault.com/api-reference/twitter/profile.md): Get Twitter profile information including stats and metadata
- [Search](https://docs.sociavault.com/api-reference/twitter/search.md): Search Twitter for tweets, users, photos, media, and more. Results are paginated — use the cursor parameter to fetch additional pages.
- [Tweet Details](https://docs.sociavault.com/api-reference/twitter/tweet.md): Get detailed information about a specific tweet including engagement
- [Transcript](https://docs.sociavault.com/api-reference/twitter/tweet-transcript.md): Get the transcript of a video tweet. Unfortunately this is a little slow because I'm using AI to get the transcript
- [User Tweets](https://docs.sociavault.com/api-reference/twitter/user-tweets.md): Get tweets from a user's profile. *These aren't the users latest tweets. Sadly, Twitter publicly only returns 100 of the users most popular tweets.
- [User Tweets (All)](https://docs.sociavault.com/api-reference/twitter/user-tweets-all.md): Get a user's latest tweets in chronological order using their numeric rest_id. This endpoint returns paginated results of the user's actual timeline. Use the cursor parameter to paginate through results. The number of tweets to return per request (max is 20).
- [Channel Details](https://docs.sociavault.com/api-reference/youtube/channel.md): Get comprehensive channel information including stats and metadata. Can pass channelId, handle, or url.
- [Channel Shorts](https://docs.sociavault.com/api-reference/youtube/channel-shorts.md): Get the shorts from a channel. If you need more details about the short like description, publish date, etc, you'll need to use the 'Video/Short Details' endpoint.
- [Channel Videos](https://docs.sociavault.com/api-reference/youtube/channel-videos.md): Get all videos from a channel with detailed information. Can pass channelId or handle.
- [Search](https://docs.sociavault.com/api-reference/youtube/search.md): Search YouTube and get matching videos, channels, playlists, shorts, lives, etc.
- [Search by Hashtag](https://docs.sociavault.com/api-reference/youtube/search-hashtag.md): Search YouTube and get matching videos, channels, and playlists
- [Trending Shorts](https://docs.sociavault.com/api-reference/youtube/shorts-trending.md): Get about 48 trending shorts
- [Video/Short Details](https://docs.sociavault.com/api-reference/youtube/video.md): Get complete information about a video or short. To get transcripts, use the dedicated /v1/scrape/youtube/video/transcript endpoint.
- [Comment Replies](https://docs.sociavault.com/api-reference/youtube/video-comment-replies.md): Get replies to a specific comment on a YouTube video.
- [Comments](https://docs.sociavault.com/api-reference/youtube/video-comments.md): Get comments from a video (~20 per page). Use the `continuationToken` from each response to paginate. Maximum retrievable: ~1k comments with order=top, ~7k with order=newest. YouTube's displayed count includes reply threads — the API returns top-level comments only, so actual results may be lower th…
- [Transcript](https://docs.sociavault.com/api-reference/youtube/video-transcript.md): Get transcript of a video or short
- [Authentication](https://docs.sociavault.com/development.md): How to authenticate with the SociaVault API
- [Welcome to SociaVault](https://docs.sociavault.com/index.md): Extract social media data from multiple platforms with our powerful API
- [Quickstart](https://docs.sociavault.com/quickstart.md): Make your first API call in under 5 minutes

## OpenAPI Specs

- [openapi](https://docs.sociavault.com/api-reference/openapi.json)

## Optional

- [API Playground](https://sociavault.com/playground)
- [Pricing](https://sociavault.com/pricing)