Getting Started

Follow these steps to start using the ProScraper API in just a few minutes.

Step 1: Create an Account

First, you'll need to create an account on our platform. Registration is free and only takes a minute.

Step 2: Purchase Credits

After registration, purchase your first credit block to activate your account. Each block costs $100 and includes 1,000 post queries.

Credits never expire
You're only charged for posts actually returned
Minimum purchase: 1 block (1,000 posts)

Step 3: Get Your API Token

Once your payment is processed, an API token will be automatically generated for you. You can view and manage your token from your dashboard.

Step 4: Make Your First Request

Use your API token to authenticate requests. Here's a quick example:

cURL

curl -X GET "http://localhost:8000/api/v1/posts/by-user/tiktok/charlidamelio" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
    

Response

{
  "success": true,
  "data": {
    "platform": "tiktok",
    "username": "charlidamelio",
    "posts_count": 50,
    "posts_charged": 50,
    "remaining_balance": 950,
    "posts": [
      {
        "id": 1,
        "platform": "tiktok",
        "platform_post_id": "7234567890123456789",
        "content": "Check out this new dance! #fyp #dance",
        "post_url": "https://www.tiktok.com/@charlidamelio/video/7234567890123456789",
        "published_at": "2024-01-15T14:30:00Z",
        "media": {
          "type": "video",
          "urls": ["https://..."]
        },
        "engagement": {
          "likes": 1500000,
          "comments": 25000,
          "shares": 50000,
          "views": 10000000,
          "total": 1575000
        },
        "author": {
          "username": "charlidamelio",
          "display_name": "Charli D'Amelio",
          "profile_url": "https://www.tiktok.com/@charlidamelio",
          "avatar_url": "https://..."
        },
        "hashtags": ["fyp", "dance"],
        "mentions": []
      }
      // ... more posts
    ]
  }
}
    