SociaVault

https://docs.sociavault.com
Admin
SociaVault is a comprehensive API platform for extracting data from major social media platforms...
Tokens:740,247
Snippets:2,093
Trust Score:6.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Go example for ad details

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

Go example using net/http to GET ad details. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sociavault.com/v1/scrape/facebook-ad-library/ad-details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Ruby example for ad details

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

Ruby example using net/http to GET ad details. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sociavault.com/v1/scrape/facebook-ad-library/ad-details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Python GET request to Instagram Search API

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

Python example using the requests library to call the Instagram Search API. Requires the requests package to be installed.

```python
import requests

url = "https://api.sociavault.com/v1/scrape/instagram/search"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)
```

--------------------------------

### Go net/http example for channel-videos

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

Go example using net/http to fetch channel videos. Replace <api-key> with your API key. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sociavault.com/v1/scrape/youtube/channel-videos"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### GET /v1/scrape/facebook-marketplace/item

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

Documentation for the GET /v1/scrape/facebook-marketplace/item endpoint, including parameters, request examples, and response schemas.

```APIDOC
## [GET] /v1/scrape/facebook-marketplace/item

### Description
Retrieves details of a Facebook Marketplace item by its ID or URL. This endpoint requires an API key for authentication.

### Method
GET

### Endpoint
https://api.sociavault.com/v1/scrape/facebook-marketplace/item

### Parameters
#### Query Parameters
- **id** (string) - Optional - The Facebook Marketplace item ID. Either this or the `url` parameter is required.
- **url** (string) - Optional - The Facebook Marketplace item URL. Either this or the `id` parameter is required.

#### Headers
- **X-API-Key** (string) - Required - Your API key for authentication.

### Request Example
```
curl --request GET \
  --url https://api.sociavault.com/v1/scrape/facebook-marketplace/item \
  --header 'X-API-Key: <api-key>'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - The Marketplace item data.
  - **success** (boolean) - Indicates if the item was successfully retrieved.
  - **id** (string) - The Marketplace item ID.
  - **url** (string) - The URL of the Marketplace item.
  - **title** (string) - The title of the item.
  - **description** (string) - The description of the item.
  - **creation_time** (string) - The creation time of the listing.
  - **location_text** (string) - The location text of the item.
  - **location** (object) - The location coordinates.
    - **latitude** (number) - The latitude of the item location.
    - **longitude** (number) - The longitude of the item location.
  - **price** (object) - The price details.
    - **formatted_amount_zeros_stripped** (string) - The formatted price with zeros stripped.
    - **amount_with_offset_in_currency** (number) - The amount with offset in currency.
    - **amount** (number) - The price amount.
    - **currency** (string) - The currency code.
  - **strikethrough_price** (null) - The strikethrough price, if any.
  - **category_id** (string) - The category ID of the item.
  - **attributes** (object) - The item attributes.
  - **photos** (object) - The photos of the item.
  - **is_hidden** (boolean) - Whether the item is hidden.
  - **is_live** (boolean) - Whether the item is live.
  - **is_pending** (boolean) - Whether the item is pending.
  - **is_sold** (boolean) - Whether the item is sold.
  - **is_viewer_seller** (boolean) - Whether the viewer is the seller.
  - **is_shipping_offered** (boolean) - Whether shipping is offered.
  - **is_buy_now_enabled** (boolean) - Whether buy now is enabled.
  - **messaging_enabled** (boolean) - Whether messaging is enabled.
  - **delivery_types** (object) - The delivery types.
  - **share_uri** (string) - The share URI.
  - **seller** (null) - The seller information.
- **credits_used** (number) - The number of credits used for this request.

#### Response Example
```
{
  "success": true,
  "data": {
    "success": true,
    "id": "1278061654412635",
    "url": "https://www.facebook.com/marketplace/item/1278061654412635/",
    "title": "Formal shoes",
    "description": "Formal shoes used only once... size UK12.",
    "creation_time": "2026-05-15T12:03:51.000Z",
    "location_text": "London, United Kingdom",
    "location": {
      "latitude": 51.512145996094,
      "longitude": -0.1043701171875
    },
    "price": {
      "formatted_amount_zeros_stripped": "£5",
      "amount_with_offset_in_currency": 664,
      "amount": 5,
      "currency": "GBP"
    },
    "strikethrough_price": null,
    "category_id": "931157863635831",
    "attributes": {
      "0": {
        "attribute_name": "Condition",
        "value": "used_good",
        "label": "Used - Good"
      }
    },
    "photos": {
      "0": {
        "id": "1889521335087397",
        "url": "https://scontent-bos5-1.xx.fbcdn.net/v/t39.84726-6/699132406_1889521345087396_1900687902739816956_n.jpg?stp=dst-jpg_s960x960_tt6&_nc_cat=100&ccb=1-7&_nc_sid=92e707&_nc_ohc=NWY0ouwhkyQQ7kNvwGUburJ&_nc_oc=AdpP5K8nFbn_rxoPMSXKdTEVvU1yrohGJKsqNDAottRhGa-cPQ6wfuJe1lCckE0lr-U&_nc_zt=14&_nc_ht=scontent-bos5-1.xx&_nc_gid=FYxxqOqNnr7L-aCsjjIJSA&_nc_ss=7e289&oh=00_Af6NoRpfi6Xah2sym375Rc5xGJN_rizevUTsMxgfhuI2Tg&oe=6A0E0F17",
        "width": 443,
        "height": 960,
        "accessibility_caption": "No photo description available."
      },
      "1": {
        "id": "1741302177009337",
        "url": "https://scontent-bos5-1.xx.fbcdn.net/v/t45.5328-4/696698524_1741302180342670_8753490698983285357_n.jpg?stp=dst-jpg_s960x960_tt6&_nc_cat=102&ccb=1-7&_nc_sid=247b10&_nc_ohc=jxxu6gpPe48Q7kNvwEl_RH6&_nc_oc=AdrbNL5_6KB9YhiGwae5FkjfSSXGSSo6ixBpvsdyCau6CsbdeeuOPMXkpAFBCbrLPho&_nc_zt=23&_nc_ht=scontent-bos5-1.xx&_nc_gid=FYxxqOqNnr7L-aCsjjIJSA&_nc_ss=7e289&oh=00_Af7MenQudv2cM5fkdLAcMNOEinrZudbev0-BhBQH0NVemA&oe=6A0E005B",
        "width": 443,
        "height": 960,
        "accessibility_caption": "No photo description available."
      },
      "2": {
        "id": "957534360394038",
        "url": "https://scontent-bos5-1.xx.fbcdn.net/v/t45.5328-4/697158330_957534363727371_710797950200649114_n.jpg?stp=dst-jpg_s960x960_tt6&_nc_cat=106&ccb=1-7&_nc_sid=247b10&_nc_ohc=so2agAzsOFAQ7kNvwFeon1g&_nc_oc=AdrE4yXI0FK8NmWDN1Vuyb83xiejDRVe7saS2GOy8mamOxS3h4-Y-GntfunxB16ERjk&_nc_zt=23&_nc_ht=scontent-bos5-1.xx&_nc_gid=FYxxqOqNnr7L-aCsjjIJSA&_nc_ss=7e289&oh=00_Af7gJvnYvAF6a6IivkKXfZpqNE4jgLZys2N3Sw7xh0ThQQ&oe=6A0E12FC",
        "width": 443,
        "height": 960,
        "accessibility_caption": "No photo description available."
      }
    },
    "is_hidden": false,
    "is_live": true,
    "is_pending": false,
    "is_sold": false,
    "is_viewer_seller": false,
    "is_shipping_offered": false,
    "is_buy_now_enabled": false,
    "messaging_enabled": true,
    "delivery_types": {
      "0": "IN_PERSON"
    },
    "share_uri": "https://www.facebook.com/marketplace/item/1278061654412635/",
    "seller": null
  },
  "credits_used": 1
}
```

#### Error Responses
- **400 Bad Request** - Either Marketplace item id or url parameter is required.
  - **error** (string) - Error message.
  - **endpoint** (string) - The endpoint that was called.
  - **credits_required** (number) - The number of credits required.

- **401 Unauthorized** - Invalid API key.
  - **error** (string) - Error message.
  - **docs** (string) - Link to authentication documentation.

- **402 Payment Required** - Insufficient credits.
  - **error** (string) - Error message.
  - **required** (number) - The number of credits required.
  - **available** (number) - The number of credits available.

- **500 Internal Server Error** - Service configuration error.
  - **error** (string) - Error message.
```

--------------------------------

### Go example

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

Uses net/http to send a GET request to the product-reviews endpoint with the X-API-Key header. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sociavault.com/v1/scrape/tiktok-shop/product-reviews"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### GET /v1/scrape/twitter/community

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

Documentation for the GET /v1/scrape/twitter/community endpoint, including authentication header and example requests in multiple languages.

```APIDOC
## GET /v1/scrape/twitter/community

### Description
Fetches community data from Twitter using the SociaVault API. This endpoint requires an API key for authentication.

### Method
GET

### Endpoint
https://api.sociavault.com/v1/scrape/twitter/community

### Parameters
#### Headers
- **X-API-Key** (string) - Required - API key for authentication.

### Request Example
No request body is required for this GET request.

### Response
#### Success Response (200)
The response contains the community data in JSON format.

#### Response Example
No explicit response schema is provided in the documentation.
```

--------------------------------

### Go example for profile posts

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

Uses net/http to send a GET request with the API key header and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sociavault.com/v1/scrape/facebook/profile/posts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### GET /v1/scrape/twitter/comments

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

Documentation for the GET /v1/scrape/twitter/comments endpoint, including request details, response example, and error codes.

```APIDOC
## GET /v1/scrape/twitter/comments

### Description
Fetches comments for a Twitter post. Requires an API key for authentication.

### Method
GET

### Endpoint
https://api.sociavault.com/v1/scrape/twitter/comments

### Parameters
#### Headers
- **X-API-Key** (string) - Required - API key for authentication.

### Request Example
No request body required.

### Response
#### Success Response (200)
Returns a JSON object with a `success` field and a `data` object containing the comments data.

#### Response Example
```json
{
  "success": true,
  "data": {
    "error": false,
    "cursor": {
      "bottom": "bQAAAPBeHBm2kMHa9dzmvZw4tMO9jbOev5w40ITd_f6Ovpw47oOxiav515w4-sG50Z6No5447MK8-dbqm_s31MDX3Zn315w4rIfUrdHa5Jw4zMXb-evp-pw48IPXoZzzxJw4iIG7sbLW15w4JQISFQQAAA"
    },
    "result": {
      "instructions": [
        {
          "entries": [
            {
              "content": {
                "__typename": "TimelineTimelineItem",
                "clientEventInfo": {
                  "component": "tweet",
                  "element": "tweet"
                },
                "entryType": "TimelineTimelineItem",
                "itemContent": {
                  "__typename": "TimelineTweet",
                  "hasModeratedReplies": true,
                  "itemType": "TimelineTweet",
                  "tweetDisplayType": "SelfThread",
                  "tweet_results": {
                    "result": {
                      "__typename": "Tweet",
                      "core": {
                        "user_results": {
                          "result": {
                            "__typename": "User",
                            "affiliates_highlighted_label": {},
                            "has_graduated_access": true,
                            "id": "VXNlcjoxMDk2NDM2NDUyNTc2MDQ3MTA0",
                            "is_blue_verified": true,
                            "legacy": {
                              "blocked_by": false,
                              "blocking": false,
                              "can_dm": false,
                              "can_media_tag": true,
                              "created_at": "Fri Feb 15 15:49:55 +0000 2019",
                              "default_profile": true,
                              "default_profile_image": false,
                              "description": "Chief Market Strategist @FuturumEquities | Contributor @Reuters @Bloomberg @MarketWatch @Forbes | Not investment advice",
                              "entities": {
                                "description": {
                                  "urls": []
                                },
                                "url": {
                                  "urls": [
                                    {
                                      "display_url": "savvytrader.com/StockSavvyShay…",
                                      "expanded_url": "https://savvytrader.com/StockSavvyShay/shays-growth-portfolio?s=MTY5OTM6MzgxOA==",
                                      "indices": [
                                        0,
                                        23
                                      ],
                                      "url": "https://t.co/K2h2dfkZci"
                                    }
                                  ]
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          ]
        }
      ]
    }
  }
}
```

### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **402** - Payment Required
- **500** - Internal Server Error
```

--------------------------------

### GET /v1/scrape/tiktok/profile - Request Examples

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

Example requests for the GET /v1/scrape/tiktok/profile endpoint. Each request requires an X-API-Key header with a valid API key. The endpoint returns TikTok profile data and costs 1 credit per request.

```cURL
curl --request GET \
  --url https://api.sociavault.com/v1/scrape/tiktok/profile \
  --header 'X-API-Key: <api-key>'
```

```Python
import requests

url = "https://api.sociavault.com/v1/scrape/tiktok/profile"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)
```

```JavaScript
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.sociavault.com/v1/scrape/tiktok/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sociavault.com/v1/scrape/tiktok/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```Go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sociavault.com/v1/scrape/tiktok/profile"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```Java
HttpResponse<String> response = Unirest.get("https://api.sociavault.com/v1/scrape/tiktok/profile")
  .header("X-API-Key", "<api-key>")
  .asString();
```

```Ruby
require 'uri'
require 'net/http'

url = URI("https://api.sociavault.com/v1/scrape/tiktok/profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Go example

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

Use this Go snippet to call the Search Advertisers endpoint using the net/http package. It sets the X-API-Key header and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sociavault.com/v1/scrape/google-ad-library/search-advertisers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go HTTP example for YouTube video details

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

Go example using net/http to fetch YouTube video details. Reads the response body and prints it.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sociavault.com/v1/scrape/youtube/video"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go net/http example for channel community posts

Source: https://docs.sociavault.com/api-reference/youtube/channel-community-posts

Go example using net/http to fetch channel community posts. Replace <api-key> with your API key.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sociavault.com/v1/scrape/youtube/channel/community-posts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go HTTP example

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

Go example using the net/http package to call the ad details endpoint. Replace <api-key> with your API key.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sociavault.com/v1/scrape/linkedin-ad-library/ad-details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### GET /v1/scrape/twitter/community/tweets

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

Documentation for the GET /v1/scrape/twitter/community/tweets endpoint, including parameters, request example, response structure, and error responses.

```APIDOC
## GET /v1/scrape/twitter/community/tweets

### Description
Retrieves community tweets from Twitter. This endpoint requires a handle parameter to specify the Twitter user whose community tweets are to be fetched.

### Method
GET

### Endpoint
https://api.sociavault.com/v1/scrape/twitter/community/tweets

### Parameters
#### Query Parameters
- **handle** (string) - Required - The Twitter handle of the user whose community tweets are to be retrieved.

### Request Example
```
curl --request GET \
  --url https://api.sociavault.com/v1/scrape/twitter/community/tweets \
  --header 'X-API-Key: <api-key>'
```

### Response
#### Success Response (200)
- **credits_used** (integer) - Number of credits used for the request.
- **endpoint** (string) - The endpoint that was called.
- **data** (object) - Contains the tweet data, including full_text, user details, and engagement metrics.

#### Response Example
```
{
  "data": {
    "full_text": "600+ followers, lets go 🚀\n\nIf you’re into AI, or tech  \n\nsay hi! \n\nFollow = follow back https://t.co/S7tOAlo8XO",
    "is_quote_status": false,
    "lang": "en",
    "possibly_sensitive": false,
    "possibly_sensitive_editable": true,
    "quote_count": 1,
    "reply_count": 389,
    "retweet_count": 5,
    "retweeted": false,
    "user_id_str": "1945203992142696448",
    "id_str": "2013630474271498525",
    "user": {
      "__typename": "User",
      "id": "VXNlcjoxOTQ1MjAzOTkyMTQyNjk2NDQ4",
      "rest_id": "1945203992142696448",
      "affiliates_highlighted_label": {},
      "avatar": {
        "image_url": "https://pbs.twimg.com/profile_images/1987845640953778176/IniN-KfM_normal.jpg"
      },
      "core": {
        "created_at": "Tue Jul 15 19:29:29 +0000 2025",
        "name": "vibe",
        "screen_name": "vybhavbhadri"
      },
      "dm_permissions": {},
      "is_blue_verified": true,
      "legacy": {
        "default_profile": true,
        "default_profile_image": false,
        "description": "ai engineer → indie developer 🧑🏻‍💻 \nbuilding → https://t.co/zLj3dimylV \nI build MVPs in weeks 🚀\nCredit card optimiser → https://t.co/R8raN5tuAh",
        "entities": {
          "description": {
            "urls": {
              "0": {
                "display_url": "kcetlabs.com",
                "expanded_url": "https://kcetlabs.com",
                "url": "https://t.co/zLj3dimylV",
                "indices": {
                  "0": 47,
                  "1": 70
                }
              },
              "1": {
                "display_url": "smartwaytoswipe.online",
                "expanded_url": "https://smartwaytoswipe.online",
                "url": "https://t.co/R8raN5tuAh",
                "indices": {
                  "0": 120,
                  "1": 143
                }
              }
            }
          }
        },
        "fast_followers_count": 0,
        "favourites_count": 7484,
        "followers_count": 1603,
        "friends_count": 815,
        "has_custom_timelines": false,
        "is_translator": false,
        "listed_count": 7,
        "media_count": 152,
        "normal_followers_count": 1603,
        "pinned_tweet_ids_str": {
          "0": "2020394306264338770"
        },
        "possibly_sensitive": false,
        "profile_banner_url": "https://pbs.twimg.com/profile_banners/1945203992142696448/1762882872",
        "profile_interstitial_type": "",
        "statuses_count": 3771,
        "translator_type": "none",
        "withheld_in_countries": {}
      },
      "location": {
        "location": "india"
      },
      "media_permissions": {},
      "parody_commentary_fan_label": "None",
      "profile_image_shape": "Circle",
      "professional": {
        "rest_id": "1978440721121292600",
        "professional_type": "Creator",
        "category": {
          "0": {
            "id": 1059,
            "name": "Engineer",
            "icon_name": "IconBriefcaseStroke"
          }
        }
      },
      "privacy": {
        "protected": false
      },
      "relationship_perspectives": {},
      "tipjar_settings": {
        "is_enabled": false,
        "bandcamp_handle": "",
        "bitcoin_handle": "",
        "cash_app_handle": "",
        "ethereum_handle": "",
        "gofundme_handle": "",
        "patreon_handle": "",
        "pay_pal_handle": "",
        "venmo_handle": ""
      },
      "verification": {
        "verified": false
      }
    }
  },
  "credits_used": 1,
  "endpoint": "twitter/community/tweets"
}
```

### Error Responses
#### Missing Required Parameter (400)
- **error** (string) - Error message.
- **endpoint** (string) - The endpoint that was called.
- **credits_required** (integer) - Number of credits required for the request.

#### Invalid API Key (401)
- **error** (string) - Error message.
- **docs** (string) - URL to authentication documentation.

#### Insufficient Credits (402)
- **error** (string) - Error message.
- **required** (integer) - Number of credits required.
- **available** (integer) - Number of credits available.

#### Service Configuration Error (500)
- **error** (string) - Error message.

```

--------------------------------

### GET /v1/scrape/tiktok-ad-library/ad

Source: https://docs.sociavault.com/api-reference/tiktok-ad-library/ad

Documentation for the Get Ad Details endpoint, including request examples in multiple languages and the response schema.

```APIDOC
## GET /v1/scrape/tiktok-ad-library/ad

### Description
Retrieves details for a specific TikTok ad from the TikTok Ad Library. This endpoint returns comprehensive ad information including creative content, performance metrics, and targeting data.

### Method
GET

### Endpoint
https://api.sociavault.com/v1/scrape/tiktok-ad-library/ad

### Parameters
#### Headers
- **X-API-Key** (string) - Required - API key for authentication

### Request Example
```
curl --request GET \
  --url https://api.sociavault.com/v1/scrape/tiktok-ad-library/ad \
  --header 'X-API-Key: <api-key>'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **data** (object) - Contains the ad details
  - **success** (boolean) - Indicates if the ad data was retrieved successfully
  - **ad_title** (string) - The title of the ad
  - **brand_name** (string) - The brand name associated with the ad
  - **comment** (integer) - Number of comments on the ad
  - **cost** (integer) - Cost metric for the ad
  - **country_code** (object) - Object containing country codes where the ad is shown
  - **ctr** (number) - Click-through rate as a percentage
  - **favorite** (boolean) - Whether the ad is marked as favorite
  - **has_summary** (boolean) - Whether the ad has a summary
  - **highlight_text** (string) - Highlight text for the ad
  - **id** (string) - Unique identifier for the ad
  - **industry_key** (string) - Industry classification key
  - **is_search** (boolean) - Whether the ad is a search ad
  - **keyword_list** (null) - List of keywords associated with the ad
  - **landing_page** (string) - URL of the landing page
  - **like** (integer) - Number of likes on the ad
  - **objective_key** (string) - Campaign objective key
  - **objectives** (object) - Object containing campaign objectives with labels and values
  - **pattern_label** (object) - Pattern labels for the ad
  - **share** (integer) - Number of shares
  - **source** (string) - Source of the ad
  - **source_key** (integer) - Source identifier key
  - **video_info** (object) - Video information including duration, cover, video URLs, width, and height
  - **voice_over** (boolean) - Whether the ad has a voice-over
  - **creative_center_url** (string) - URL to the ad in TikTok Creative Center
  - **detail_analysis** (null) - Detailed analysis data
  - **interactive_time_analysis** (object) - Interactive time analysis data including CTR metrics

#### Response Example
```
{
  "success": true,
  "data": {
    "success": true,
    "ad_title": "HR would like to remind you that what happens at the premiere, stays at the premiere. Office Romance June 5 on @Netflix ",
    "brand_name": "",
    "comment": 5,
    "cost": 1,
    "country_code": {
      "0": "IT",
      "1": "US"
    },
    "ctr": 0.34,
    "favorite": false,
    "has_summary": false,
    "highlight_text": "",
    "id": "7645249124891607041",
    "industry_key": "label_23108000000",
    "is_search": false,
    "keyword_list": null,
    "landing_page": "https://www.tiktok.com/music/On-The-Floor-6917324503026501634",
    "like": 1294,
    "objective_key": "campaign_objective_traffic",
    "objectives": {
      "0": {
        "label": "campaign_objective_traffic",
        "value": 1
      },
      "1": {
        "label": "campaign_objective_video_view",
        "value": 4
      }
    },
    "pattern_label": {},
    "share": 7,
    "source": "Others",
    "source_key": 73,
    "video_info": {
      "vid": "v15044gf0000d8blg3vog65m7i2j3320",
      "duration": 55.843,
      "cover": "https://p16-common-sign.tiktokcdn.com/tos-maliva-p-0068c799-us/owWoFXnfIfGLjgWAuAYQXIeqGAQpGQGYReBQGU~tplv-noop.image?dr=18692&refresh_token=a401619e&x-expires=1781236924&x-signature=0q9GnoMTxEoF759h1QvLdjpRsuU%3D&t=9276707c&ps=14f1eb3e&shp=9e36835a&shcp=317596d8&idc=my&VideoID=v15044gf0000d8blg3vog65m7i2j3320",
      "video_url": {
        "540p": "https://v16m-default.tiktokcdn.com/d53a2e8ebaf61e24b6ed926c6320d98d/6a2b84bc/video/tos/maliva/tos-maliva-ve-0068c799-us/osXAIFIWHpGGG8AGAefjLRXQeYUgUoIRWpQfQ3/?a=0&bti=NTU4QDM1NGA%3D&&bt=511&ft=cApXJCz7ThWH8o59LGZmo0P&mime_type=video_mp4&rc=M2Q7ZDVpODY8NjhpOjk4ZkBpMzZtbHA5cjZvOzMzaTczNEBeLl9fYl4tXzUxNDNiMC40YSMvMC80MmRzZF9hLS1kMTJzcw%3D%3D&vvpl=1&l=20260612060109989AA740FBB80D56854A&btag=e00088000",
        "720p": "https://v16m-default.tiktokcdn.com/1f68163dfffabe98b7dce396d7775f67/6a2b84bc/video/tos/maliva/tos-maliva-ve-0068c799-us/ocf1SxIUCtBCUXsiEWiwHIRIiEJIEAA26jQqPA/?a=0&bti=NTU4QDM1NGA%3D&&bt=1360&ft=cApXJCz7ThWH8o59LGZmo0P&mime_type=video_mp4&rc=Z2U2OWRlOzw8aTY4aGY5ZUBpMzZtbHA5cjZvOzMzaTczNEAyMi80YzQ1XzAxX2AyYTA1YSMvMC80MmRzZF9hLS1kMTJzcw%3D%3D&vvpl=1&l=20260612060109989AA740FBB80D56854A&btag=e00088000"
      },
      "width": 720,
      "height": 1280
    },
    "voice_over": false,
    "creative_center_url": "https://ads.tiktok.com/business/creativecenter/topads/7645249124891607041/pc/en",
    "detail_analysis": null,
    "interactive_time_analysis": {
      "ctr": {
        "metric": "retain_ctr",
        "analysis": {
          "0": {
            "second": 0,
            "value": 0.05587075347678683
          },
          "1": {
            "second": 1,
            "value": 1
          },
          "2": {
            "second": 2
          }
        }
      }
    }
  }
}
```

### Error Handling
- **400** - Bad request
- **401** - Unauthorized (invalid or missing API key)
- **402** - Payment required
```

--------------------------------

### Get Ad Details with Go

Source: https://docs.sociavault.com/api-reference/tiktok-ad-library/ad

Go example using the standard library to fetch ad details. Replace <api-key> with your API key.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sociavault.com/v1/scrape/tiktok-ad-library/ad"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```
Tokens:
Raw