Quick Start

This guide will help you make your first API request in just a few minutes.

Prerequisites

An API key (get one here)
A tool to make HTTP requests (curl, Postman, or your preferred programming language)

Step 1: Set Up Your API Key

Store your API key as an environment variable:

export SOCIAL_SCRAPER_API_KEY="your_api_key_here"

Step 2: Make Your First Request

Let's fetch a TikTok profile as an example:

curl -X GET "https://api.your-domain.com/tiktok/profile/username" \
  -H "Authorization: Bearer $SOCIAL_SCRAPER_API_KEY"

const apiKey = process.env.SOCIAL_SCRAPER_API_KEY;

const response = await fetch(
  'https://api.your-domain.com/tiktok/profile/username',
  {
    headers: {
      'Authorization': `Bearer ${apiKey}`
    }
  }
);

const profile = await response.json();
console.log(profile);

import os
import requests

api_key = os.environ.get('SOCIAL_SCRAPER_API_KEY')

response = requests.get(
    'https://api.your-domain.com/tiktok/profile/username',
    headers={'Authorization': f'Bearer {api_key}'}
)

profile = response.json()
print(profile)

Step 3: Handle the Response

A successful response returns profile data in JSON format:

{
  "username": "example_user",
  "displayName": "Example User",
  "bio": "Content creator",
  "followers": 150000,
  "following": 500,
  "likes": 2500000,
  "verified": true
}