### API Key Authentication Example Source: https://docs.sociavault.com/api-reference/facebook/post-transcript All API requests require authentication using an API key in the `X-API-Key` header. Get your API key from the SociaVault Dashboard. ```bash X-API-Key: sk_live_your_api_key_here ``` -------------------------------- ### API Key Authentication Header Example Source: https://docs.sociavault.com/api-reference/facebook/post-comments This example shows how to include the API key in the request header for authentication. The key should be prefixed with 'sk_live_'. ```http X-API-Key: sk_live_xxxxxxxxxxxxx ``` -------------------------------- ### Full Response Example Source: https://docs.sociavault.com/api-reference/instagram/posts This example demonstrates a successful response when fetching posts without any trimming. It includes pagination details, user information, and post item specifics. ```json { "success": true, "data": { "success": true, "next_max_id": "3822431353875645727_270598518", "user": { "strong_id__": "270598518", "pk": "270598518", "pk_id": "270598518", "full_name": "OPI", "profile_grid_display_type": "default", "id": "270598518", "username": "opi", "is_private": false, "is_verified": true, "profile_pic_id": "3043277643584582085_270598518", "profile_pic_url": "https://scontent-lga3-1.cdninstagram.com/v/t51.2885-19/332508693_716166386813792_8306749939985552435_n.jpg?stp=dst-jpg_s150x150_tt6&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLmRqYW5nby4xMDgwLmMyIn0&_nc_ht=scontent-lga3-1.cdninstagram.com&_nc_cat=1&_nc_oc=Q6cZ2QFBrFTrZow1bUUvH1wz1UCfsGUWh_UDGJtSsNmr9qvd1un3AwDPqWhUM-SNM3d7jwg&_nc_ohc=ymssfZtSXPQQ7kNvwFzg1aB&_nc_gid=mcpwMUePKIGd2mF3gsjBlg&edm=ACWDqb8BAAAA&ccb=7-5&oh=00_AfvuSscNaLsnt4EoalIkifOivV7dItMBUkgLp_p5iPuRCw&oe=698ECD04&_nc_sid=ee9879", "is_active_on_text_post_app": true }, "auto_load_more_enabled": false, "status": "ok", "profile_grid_items": null, "profile_grid_items_cursor": null, "pinned_profile_grid_items_ids": null, "special_empty_state": null, "num_results": 12, "more_available": true, "items": [ { "strong_id__": "3824512658796290411_270598518", "caption_is_edited": false, "device_timestamp": 1770137454680985, "filter_type": 0, "has_shared_to_fb": 0, "is_post_live_clips_media": false, "like_and_view_counts_disabled": false, "fbid": "17857289052604596", "deleted_reason": 0, "is_unified_video": false, "client_cache_key": "MzgyNDUxMjY1ODc5NjI5MDQxMQ==.3", "collaborator_edit_eligibility": false, "comment_threading_enabled": true, "commerciality_status": "not_commercial", "integrity_review_decision": "pending", "is_reshare_of_text_post_app_media_in_ig": false, "is_visual_reply_commenter_notice_enabled": true, "share_count_disabled": false, "translated_langs_for_autodub": {}, "pk": "3824512658796290411", "id": "3824512658796290411_270598518", "has_delayed_metadata": false, "mezql_token": "", "should_request_ads": false, "has_privately_liked": false, "is_quiet_post": false, "profile_grid_thumbnail_fitting_style": "UNSET", "subtype_name_for_REST__": "XDTClipsMedia" } ] } } ``` -------------------------------- ### Music Information API Response Example Source: https://docs.sociavault.com/api-reference/tiktok/music-details Example JSON response structure for a successful music information request. ```json example: '7439295283975702544' responses: '200': description: >- Successful response **Key Response Fields:** - `music_info.id_str`: Unique music/clip ID - `music_info.title`: Song title - `music_info.author`: Artist name(s) - `music_info.album`: Album name - `music_info.duration`: Clip duration in seconds - `music_info.user_count`: Number of TikTok videos using this sound - `music_info.create_time`: When the sound was added (Unix timestamp) - `music_info.is_original`: Whether it's an original sound - `music_info.is_commerce_music`: Whether it's cleared for commercial use - `music_info.artists[].nick_name`: Artist display name - `music_info.artists[].sec_uid`: Artist secure user ID - `music_info.artists[].is_verified`: Whether the artist is verified - `music_info.cover_large.url_list[0]`: Large album cover image URL - `music_info.play_url.url_list[0]`: Audio stream URL - `music_info.multi_bit_rate_play_info[].gear_name`: Quality tier (`medium`, `higher`, `highest`) - `music_info.multi_bit_rate_play_info[].bit_rate`: Audio bitrate - `music_info.multi_bit_rate_play_info[].play_addr.url_list[0]`: Audio URL for that quality - `music_info.matched_song.title`: Full song title from music catalog - `music_info.matched_song.full_duration`: Full song duration in ms - `music_info.share_info.share_url`: Shareable TikTok music link - `music_info.theme_tags[]`: Genre/mood tags (e.g., `Love`) content: application/json: example: success: true data: success: true music_info: album: GNX allow_offline_music_to_detail_page: false artists: '0': avatar: uri: tos-maliva-avt-0068/42b31651a14a0f2151814dcbace36525 url_list: '0': >- https://p19-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/42b31651a14a0f2151814dcbace36525~tplv-tiktokx-cropcenter:168:168.webp?dr=10397&refresh_token=ad859501&x-expires=1770667200&x-signature=U9FfoFZqfvjPBWknLznhgl%2BGM9g%3D&t=4d5b0474&ps=13740610&shp=544a444f&shcp=f6441914&idc=no1a '1': >- https://p16-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/42b31651a14a0f2151814dcbace36525~tplv-tiktokx-cropcenter:168:168.webp?dr=10397&refresh_token=07bd53d6&x-expires=1770667200&x-signature=GXcrDtUsOcu3Fm2Kjc5xAfJAuwY%3D&t=4d5b0474&ps=13740610&shp=544a444f&shcp=f6441914&idc=no1a '2': >- https://p19-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/42b31651a14a0f2151814dcbace36525~tplv-tiktokx-cropcenter:168:168.jpeg?dr=10397&refresh_token=fd72f9b7&x-expires=1770667200&x-signature=CfwWpSnb1OllRL2BoBblc2ffhAQ%3D&t=4d5b0474&ps=13740610&shp=544a444f&shcp=f6441914&idc=no1a url_prefix: null enter_type: 2 follow_status: 0 follower_status: 0 handle: sza is_block: false is_blocked: false is_private_account: false is_verified: true is_visible: false nick_name: SZA sec_uid: >- MS4wLjABAAAAvpZK1VKUmXciE56qu5sbLqcbmzfEMwPaisV4CKQXH7JzitoUooisLwlAWcZ5oW2W status: 1 uid: '7486547994222740523' audition_duration: 59 author: Kendrick Lamar & SZA author_deleted: false author_position: null avatar_medium: height: 720 uri: musically-maliva-obj/1594805258216454 url_list: '0': >- https://p16-common-sign.tiktokcdn-eu.com/musically-maliva-obj/1594805258216454~tplv-tiktokx-cropcenter:720:720.webp?dr=10399&refresh_token=77f5ab1b&x-expires=1770667200&x-signature=l61EvH9B31zR%2FFmwZ4xwqBXTCY0%3D&t=4d5b0474&ps=13740610&shp=544a444f&shcp=f6441914&idc=no1a '1': >- ``` -------------------------------- ### cURL Request Example Source: https://docs.sociavault.com/api-reference/introduction Use this cURL command to make a GET request to scrape a TikTok profile. Ensure you replace 'sk_live_your_api_key_here' with your actual API key. ```bash curl --request GET \ --url 'https://api.sociavault.com/v1/scrape/tiktok/profile?handle=charlidamelio' \ --header 'X-API-Key: sk_live_your_api_key_here' ``` -------------------------------- ### Python Request Example Source: https://docs.sociavault.com/api-reference/introduction This Python example shows how to use the requests library to fetch TikTok profile data. Replace 'sk_live_your_api_key_here' with your valid API key. ```python 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()) ``` -------------------------------- ### Successful API Response Example Source: https://docs.sociavault.com/api-reference/instagram/highlights Example of a successful JSON response from the instagram/highlights endpoint, including highlight reel details. ```json { "success": true, "data": { "success": true, "highlights": { "0": { "__typename": "GraphHighlightReel", "id": "18154582366360931", "cover_media": { "thumbnail_src": "https://scontent-sea5-1.cdninstagram.com/v/t51.2885-15/558885824_1037483558381763_8621842580080396216_n.jpg?stp=c0.248.640.640a_dst-jpg_e15_tt6&_nc_ht=scontent-sea5-1.cdninstagram.com&_nc_cat=103&_nc_oc=Q6cZ2QGDUXKHGmWNECPXeFhVVRz2AkKg4uiAhr7yA2DxzMlkk51GAJIQ80jHrDUJLzc07z4&_nc_ohc=D81do1QDzBoQ7kNvwHqu-H8&_nc_gid=21r4kTiAHVWEhGSRib5uBg&edm=AGW0Xe4BAAAA&ccb=7-5&oh=00_AfsWJHKHzysbhvJumkoAnG8EnSZebaswWYYDowHuXDaePw&oe=698ECEBF&_nc_sid=94fea1" }, "cover_media_cropped_thumbnail": { "url": "https://scontent-sea1-1.cdninstagram.com/v/t51.2885-15/561153419_788861093997661_8633888304726742947_n.jpg?stp=dst-jpg_s150x150_tt6&_nc_ht=scontent-sea1-1.cdninstagram.com&_nc_cat=101&_nc_oc=Q6cZ2QGDUXKHGmWNECPXeFhVVRz2AkKg4uiAhr7yA2DxzMlkk51GAJIQ80jHrDUJLzc07z4&_nc_ohc=3kEPQhWB604Q7kNvwG9dnzb&_nc_gid=21r4kTiAHVWEhGSRib5uBg&edm=AGW0Xe4BAAAA&ccb=7-5&oh=00_AfvPl3rF3eB3QW3cQSZ6qdrtr0y8NP9Ht-awjE70PxjjQQ&oe=698EE729&_nc_sid=94fea1" }, "owner": { "__typename": "GraphUser", "id": "21393171", "profile_pic_url": "https://scontent-sea5-1.cdninstagram.com/v/t51.2885-19/629783272_18551475079017172_5737125966880342474_n.jpg?stp=dst-jpg_s150x150_tt6&efg=eyJ2ZW5jb2RlX3RhZyI6InByb2ZpbGVfcGljLmRqYW5nby4xMDgwLmMyIn0&_nc_ht=scontent-sea5-1.cdninstagram.com&_nc_cat=1&_nc_oc=Q6cZ2QGDUXKHGmWNECPXeFhVVRz2AkKg4uiAhr7yA2DxzMlkk51GAJIQ80jHrDUJLzc07z4&_nc_ohc=xqKumIqBCNIQ7kNvwEmGFTN&_nc_gid=21r4kTiAHVWEhGSRib5uBg&edm=AGW0Xe4BAAAA&ccb=7-5&oh=00_AfsjMnOm5YTh8amnBwG1qc-yVhc-ds5ZU17RUCjEz6WrTg&oe=698EEC56&_nc_sid=94fea1", "username": "jane" }, "title": "BOB hairstyles💇‍♀️" } }, "credits_used": 1, "endpoint": "instagram/highlights" } } ``` -------------------------------- ### Full TikTok Video Response Example Source: https://docs.sociavault.com/api-reference/tiktok/trending This example demonstrates the structure of a full JSON response when retrieving TikTok video data. It includes comprehensive details about the video, author, and music. ```json { "success": true, "data": { "success": true, "aweme_list": [ { "aweme_id": "7604489034315861262", "desc": "Here's a play I LOVE for this year's big game!", "create_time": 1770558138, "author": { "uid": "7436873095740343338", "short_id": "0", "nickname": "Barstool Gruden", "signature": "SB XXXVII Champ currently @Barstool Sports", "avatar_thumb": { "uri": ">- tos-useast5-avt-0068-tx/ecf877580ff3196b84fda17a626f1880", "url_list": [ "> https://p16-common-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/ecf877580ff3196b84fda17a626f1880~tplv-tiktokx-cropcenter:100:100.webp?dr=9640&refresh_token=20c1bfbd&x-expires=1770667200&x-signature=%2BwQzhPxymH61a2gqLZikZAn22aI%3D&t=4d5b0474&ps=13740610&shp=d05b14bd&shcp=34ff8df6&idc=useast8", "> https://p19-common-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/ecf877580ff3196b84fda17a626f1880~tplv-tiktokx-cropcenter:100:100.webp?dr=9640&refresh_token=b7b9d9a8&x-expires=1770667200&x-signature=qn4cRMaPgEioOlwfydrQ7FggU0s%3D&t=4d5b0474&ps=13740610&shp=d05b14bd&shcp=34ff8df6&idc=useast8", "> https://p16-common-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/ecf877580ff3196b84fda17a626f1880~tplv-tiktokx-cropcenter:100:100.jpeg?dr=9640&refresh_token=03e633db&x-expires=1770667200&x-signature=BHUw%2FtUrC6K7R%2FMNpjYBgBUyk3E%3D&t=4d5b0474&ps=13740610&shp=d05b14bd&shcp=34ff8df6&idc=useast8" ], "width": 720, "height": 720, "url_prefix": null }, "avatar_medium": { "uri": ">- tos-useast5-avt-0068-tx/ecf877580ff3196b84fda17a626f1880", "url_list": [ "> https://p16-common-sign.tiktokcdn-us.com/tos-useast5-avt-0068-tx/ecf877580ff3196b84fda17a626f1880~tplv-tiktokx-cropcenter:720:720.webp?dr=9640&refresh_token=ae15ea33&x-expires=1770667200&x-signature=%2Fi3lSBb%2BX%2FqXwYRH26vzJ2CR4aU%3D&t=4d5b0474&ps=13740610&shp=d05b14bd&shcp=34ff8df6&idc=useast8" ] } } } ] } } ``` -------------------------------- ### Unauthorized API Response Example Source: https://docs.sociavault.com/api-reference/facebook/post-comments This example shows an 'Unauthorized' error response, which occurs when an invalid or missing API key is provided. It includes a link to documentation for authentication. ```json { "error": "Invalid API key", "docs": "https://docs.sociavault.com/authentication" } ``` -------------------------------- ### YouTube Channel API - Bad Request Example Source: https://docs.sociavault.com/api-reference/youtube/channel This JSON shows an example of a 'Bad Request' response, typically occurring due to invalid parameters or missing required fields. ```json { "error": "Missing required parameter: handle" } ``` -------------------------------- ### Fetch TikTok Profile Data Source: https://docs.sociavault.com/quickstart Use these examples to perform a GET request to the TikTok profile endpoint. Replace YOUR_API_KEY with your actual API key from the dashboard. ```bash curl --request GET \ --url 'https://api.sociavault.com/v1/scrape/tiktok/profile?handle=stoolpresidente' \ --header 'X-API-Key: YOUR_API_KEY' ``` ```javascript 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 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 ``` -------------------------------- ### Full API Response Example Source: https://docs.sociavault.com/api-reference/tiktok/following A sample JSON response demonstrating the structure of the user following data returned by the API. ```json { "success": true, "data": { "success": true, "extra": { "fatal_item_ids": {}, "logid": "2026020818240892EB5C0C655460834DAD", "now": 1770575049000 }, "followings": { "0": { "accept_private_policy": false, "account_labels": null, "account_region": "", "ad_cover_url": null, "advance_feature_item_order": null, "advanced_feature_info": null, "apple_account": 0, "authority_status": 0, "avatar_168x168": { "height": 720, "uri": "tos-maliva-avt-0068/ba32b40a8c022fbb727c156f8a5a140c", "url_list": { "0": "https://p16-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/ba32b40a8c022fbb727c156f8a5a140c~tplv-tiktokx-cropcenter-q:168:168:q70.heic?dr=9604&idc=no1a&ps=87d6e48a&refresh_token=6af99020&s=COMMON_RELATION_LIST&sc=avatar&shcp=65db1d19&shp=30310797&t=223449c4&x-expires=1770660000&x-signature=tFh1hjjgR3shaUpMvxkZvodeauM%3D", "1": "https://p19-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/ba32b40a8c022fbb727c156f8a5a140c~tplv-tiktokx-cropcenter-q:168:168:q70.heic?dr=9604&idc=no1a&ps=87d6e48a&refresh_token=ec068d1b&s=COMMON_RELATION_LIST&sc=avatar&shcp=65db1d19&shp=30310797&t=223449c4&x-expires=1770660000&x-signature=Xw%2ByWZqY5HjMq2DnZb1V6brydFc%3D", "2": "https://p16-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/ba32b40a8c022fbb727c156f8a5a140c~tplv-tiktokx-cropcenter-q:168:168:q70.webp?dr=9604&idc=no1a&ps=87d6e48a&refresh_token=ffbbecf3&s=COMMON_RELATION_LIST&sc=avatar&shcp=65db1d19&shp=30310797&t=223449c4&x-expires=1770660000&x-signature=zKq4if%2FdFOfqkfeIvtbjW5mWOME%3D" }, "url_prefix": null, "width": 720 }, "avatar_300x300": { "height": 720, "uri": "tos-maliva-avt-0068/ba32b40a8c022fbb727c156f8a5a140c", "url_list": { "0": "https://p16-common-sign.tiktokcdn-eu.com/tos-maliva-avt-0068/ba32b40a8c022fbb727c156f8a5a140c~tplv-tiktokx-cropcenter-q:300:300:q70.heic?dr=9605&idc=no1a&ps=87d6e48a&refresh_token=432f5620&s=COMMON_RELATION_LIST&sc=avatar&shcp=65db1d19&shp=30310797&t=223449c4&x-expires=1770660000&x-signature=2%2FgZ9nOVFFzzGy6tLJHJUm0J86U%3D", "1": "" } } } } } } ``` -------------------------------- ### PHP Request Example Source: https://docs.sociavault.com/api-reference/introduction This PHP code snippet utilizes cURL to make a GET request for scraping a TikTok profile. Ensure your API key is correctly inserted in the header. ```php "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; ?> ``` -------------------------------- ### JavaScript Request Example Source: https://docs.sociavault.com/api-reference/introduction This JavaScript snippet demonstrates how to use the axios library to make a GET request for scraping a TikTok profile. Remember to replace the placeholder API key. ```javascript 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)); ``` -------------------------------- ### Full API Response Example Source: https://docs.sociavault.com/api-reference/reddit/post-comments A sample JSON response demonstrating the structure of a successful API call, including post metadata and nested comment data. ```json { "success": true, "data": { "success": true, "post": { "approved_at_utc": null, "subreddit": "AskReddit", "selftext": "", "user_reports": {}, "saved": false, "mod_reason_title": null, "gilded": 13, "clicked": false, "title": "People who haven't pooped in 2019 yet, why are you\nstill holding on to last years shit?", "link_flair_richtext": {}, "subreddit_name_prefixed": "r/AskReddit", "hidden": false, "pwls": 6, "link_flair_css_class": null, "downs": 0, "top_awarded_type": null, "hide_score": false, "name": "t3_ablzuq", "quarantine": false, "link_flair_text_color": "dark", "upvote_ratio": 0.91, "author_flair_background_color": null, "subreddit_type": "public", "ups": 221988, "total_awards_received": 0, "media_embed": {}, "author_flair_template_id": null, "is_original_content": false, "author_fullname": "t2_2uhed5z4", "secure_media": null, "is_reddit_media_domain": false, "is_meta": false, "category": null, "secure_media_embed": {}, "link_flair_text": null, "can_mod_post": false, "score": 221988, "approved_by": null, "is_created_from_ads_ui": false, "author_premium": false, "thumbnail": "", "edited": 1546379983, "author_flair_css_class": null, "author_flair_richtext": {}, "gildings": {}, "content_categories": null, "is_self": true, "mod_note": null, "created": 1546376787, "link_flair_type": "text", "wls": 6, "removed_by_category": null, "banned_by": null, "author_flair_type": "text", "domain": "self.AskReddit", "allow_live_comments": true, "selftext_html": null, "likes": null, "suggested_sort": null, "banned_at_utc": null, "view_count": null, "archived": true, "no_follow": false, "is_crosspostable": false, "pinned": false, "over_18": false, "all_awardings": {}, "awarders": {}, "media_only": false, "can_gild": false, "spoiler": false, "locked": false, "author_flair_text": null, "treatment_tags": {} } } } ``` -------------------------------- ### GET /websites/sociavault/reels Source: https://docs.sociavault.com/api-reference/instagram/reels-by-song Retrieves a list of reels. Use the `max_id` parameter for pagination to get subsequent sets of reels. ```APIDOC ## GET /websites/sociavault/reels ### Description Retrieves a list of reels. The `max_id` query parameter can be used for pagination to fetch the next set of reels. ### Method GET ### Endpoint /websites/sociavault/reels ### Query Parameters - **max_id** (string) - Optional - Pagination cursor to retrieve the next set of reels. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **items** (array) - An array of reel objects. - **media** (object) - Contains details about the reel. - **pk** (string) - Unique reel ID. - **id** (string) - Reel ID combined with the author's user ID. - **code** (string) - Reel shortcode (used in the URL as `instagram.com/reel/{code}`). - **taken_at** (integer) - Unix timestamp of when the reel was posted. - **caption** (object) - Caption details for the reel. - **text** (string) - Reel caption text. - **user** (object) - Information about the reel creator. - **username** (string) - Username of the reel creator. - **is_verified** (boolean) - Whether the reel creator is verified. - **profile_pic_url** (string) - Creator's profile picture URL. - **max_id** (string) - Pagination cursor for fetching the next set of reels. #### Response Example ```json { "success": true, "items": [ { "media": { "pk": "3652360178415977960", "id": "3652360178415977960_4396457", "fbid": "18034424375376227", "device_timestamp": 134142505793774, "caption_is_edited": true, "strong_id__": "3652360178415977960_4396457", "deleted_reason": 0, "has_shared_to_fb": 0, "has_delayed_metadata": false, "mezql_token": "0:OZQlIevIQU+5pG5dXNMsSw==", "share_count_disabled": false, "should_request_ads": false, "is_reshare_of_text_post_app_media_in_ig": false, "integrity_review_decision": "pending", "client_cache_key": "MzY1MjM2MDE3ODQxNTk3Nzk2MA==.3", "filter_type": 0, "is_visual_reply_commenter_notice_enabled": true, "comment_threading_enabled": true, "like_and_view_counts_disabled": false, "has_privately_liked": false, "is_unified_video": false, "is_post_live_clips_media": false, "commerciality_status": "not_commercial", "is_quiet_post": false, "caption": { "text": "Example caption text.", "user": { "username": "example_user", "is_verified": true, "profile_pic_url": "https://example.com/profile.jpg" } } } } ], "max_id": "GvYhgPbWtJ...." } ``` ``` -------------------------------- ### API Authentication Source: https://docs.sociavault.com/api-reference/youtube/channel-videos Authentication is performed by passing your API key in the `X-API-Key` header. Ensure your key is prefixed with `sk_live_`. ```APIDOC ## API Authentication ### Description Authentication is performed by passing your API key in the `X-API-Key` header. Ensure your key is prefixed with `sk_live_`. ### Method All API requests require authentication. ### Endpoint N/A (Header authentication) ### Parameters #### Header Parameters - **X-API-Key** (string) - Required - API key for authentication. Format: `sk_live_xxxxxxxxxxxxx` ### Request Example ```bash curl -H "X-API-Key: sk_live_your_api_key_here" https://api.sociavault.com/v1/some/endpoint ``` ### Response #### Success Response (200) N/A (Authentication is a prerequisite for other endpoints) #### Error Response (401) - **error** (string) - Description of the authentication error. ``` -------------------------------- ### GET /product/details Source: https://docs.sociavault.com/api-reference/tiktok-shop/product-details Retrieves comprehensive product information including seller details, pricing, specifications, and reviews. ```APIDOC ## GET /product/details ### Description Retrieves detailed information for a specific product, including seller profile, SKU variants, pricing, and customer reviews. ### Method GET ### Endpoint /product/details ### Response #### Success Response (200) - **product_id** (string) - Unique product identifier - **status** (string) - Product availability status - **seller** (object) - Seller/shop information including ID, name, avatar, ratings, and performance metrics - **product_base** (object) - Core product data including title, images, specifications, pricing, and category info - **sale_props** (array) - Available sale property options (e.g., size, color) - **skus** (array) - Individual SKU variants with stock and pricing - **logistic** (object) - Shipping and delivery details - **product_detail_review** (object) - Product rating and sample reviews - **shop_review_entry** (object) - Shop-wide review statistics - **share_info** (object) - Deep link and sharing metadata - **shipping** (object) - Detailed logistics and tracking info - **button_area** (object) - Purchase button configurations #### Response Example { "product_id": "12345", "status": "available", "product_base": { "title": "Example Product", "price": { "real_price": "$19.99", "currency": "USD" } } } ``` -------------------------------- ### Get Facebook Post Transcript Source: https://docs.sociavault.com/api-reference/facebook/post-transcript Use this endpoint to get the transcript of a Facebook post or reel. Requires a valid Facebook post URL. ```yaml openapi: 3.1.0 info: title: SociaVault API version: 1.0.0 description: >- # SociaVault API Documentation The SociaVault API provides comprehensive access to social media data extraction across multiple platforms. ## Features - **Multi-Platform Support**: TikTok, Instagram, YouTube, Facebook, Twitter, Reddit, Threads, and more - **Credit-Based System**: Pay-as-you-go pricing with transparent credit costs - **High Performance**: Fast, reliable data extraction - **Comprehensive Data**: Detailed user profiles, videos, posts, comments, and analytics ## Authentication All API requests require authentication using an API key in the `X-API-Key` header: ```bash X-API-Key: sk_live_your_api_key_here ``` Get your API key from the [SociaVault Dashboard](https://sociavault.com/dashboard). ## Credits Each endpoint consumes credits based on data complexity: - Simple requests (profiles): 1 credit - Complex requests (demographics): 20+ credits - Paginated requests: Credits per page Check your credit balance in the dashboard or via the API. ## Support - **Documentation**: https://docs.sociavault.com - **Email**: support@sociavault.com - **Discord**: https://discord.gg/sociavault contact: name: SociaVault Support email: support@sociavault.com url: https://sociavault.com/support license: name: Commercial url: https://sociavault.com/terms servers: - url: https://api.sociavault.com description: Production API security: - ApiKeyAuth: [] tags: - name: account description: Account management and credit balance externalDocs: description: Learn more url: https://docs.sociavault.com/account - name: tiktok description: Scrape TikTok profiles, videos, and more externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/tiktok - name: tiktok-shop description: Everything about TikTok Shop externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/tiktok-shop - name: instagram description: Gets Instagram profiles, posts, and reels externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/instagram - name: youtube description: Scrape YouTube channels, videos, and more externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/youtube - name: linkedin description: Scrape LinkedIn externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/linkedin - name: facebook description: Get public Facebook profiles and posts externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/facebook - name: facebookAdLibrary description: Scrapes the Facebook (Meta) Ad Library externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/facebookAdLibrary - name: googleAdLibrary description: >- Scrape the Google Ad Transparency Library. *This only gets the public ads. Some ads you need to log in for and sadly we can't get those. Also, since there are so many variations, the return types might not all be 100% the same. externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/googleAdLibrary - name: linkedinAdLibrary description: Search the LinkedIn Ad Library externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/linkedinAdLibrary - name: twitter description: Get Twitter profiles, tweets, followers and more externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/twitter - name: reddit description: Scrape Reddit posts and comments externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/reddit - name: threads description: Get Threads posts externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/threads - name: google description: Scrape Google search results externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/google paths: /v1/scrape/facebook/post/transcript: get: tags: - facebook summary: Transcript description: Get the transcript of a Facebook post. Can be a post or reel. operationId: facebook_Transcript parameters: - name: url in: query description: Facebook post URL required: true schema: type: string responses: '200': description: >- Successful response **Key Response Fields:** ```