> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sociavault.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> 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 cols={2}>
  <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 cols={3}>
  <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 cols={2}>
  <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 cols={2}>
  <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 cols={2}>
  <Card title="Support" icon="life-ring" href="mailto:support@sociavault.com">
    Email support
  </Card>
</CardGroup>