Getting Started

Get up and running with the Omniscrape API in under 5 minutes.

1. Get an API Key

Sign up at the Omniscrape Dashboard  and create an API key from the API Keys page.

Your key will look like: sk_oms_xxxxxxxxxxxx

2. Make Your First Request

pip install omniscrape

from omniscrape import Omniscrape
 
client = Omniscrape(api_key="YOUR_API_KEY")
user = client.threads.get_user("zuck")
print(user.data.username, user.data.follower_count)

curl -H "x-api-key: YOUR_API_KEY" \
  https://api.omniscrape.dev/threads/users/zuck

import requests
 
url = "https://api.omniscrape.dev/threads/users/zuck"
headers = {"x-api-key": "YOUR_API_KEY"}
 
response = requests.get(url, headers=headers, timeout=30)
print(response.json())

const response = await fetch("https://api.omniscrape.dev/threads/users/zuck", {
  headers: {
    "x-api-key": "YOUR_API_KEY",
  },
});
 
const data = await response.json();
console.log(data);

Response:

{
  "id": "314216",
  "username": "zuck",
  "fullName": "Mark Zuckerberg",
  "profilePic": "https://...",
  "bio": "Building the future...",
  "isVerified": true,
  "followerCount": 3200000,
  "followingCount": 450
}

3. Explore the API

Each platform follows the same URL pattern:

GET /{platform}/users/{username}          # User profile
GET /{platform}/users/{id}/posts          # User's posts
GET /{platform}/posts/{id}                # Single post
GET /{platform}/posts/search?q=keyword    # Search posts

Supported platforms: threads, facebook, instagram, x, reddit, tiktok, linkedin, youtube, google, gmaps, hackernews, producthunt, trustpilot, luma, dcard, ptt, job104, rent591, web

Tip: Finding the correct username

The username parameter must be the account’s handle on that platform, not the display name or brand name in any language.

To find it, go to the profile page on the platform — the username is the last segment of the URL:

• facebook.com/CTfans → username is CTfans
• instagram.com/kanpo_yamamoto.tw → username is kanpo_yamamoto.tw
• threads.net/@zuck → username is zuck

Common mistakes: using Chinese/Japanese brand names, guessing the username, or mixing up dots and underscores.

Response Format

All responses return the data directly as JSON — no wrapper object.

Success

{
  "id": "314216",
  "username": "zuck",
  ...
}

Error

{
  "detail": "Error message"
}

Rate Limits

API usage is tracked per API key. Check your current usage on the Billing page .

Next Steps

• Install the Python SDK for a typed, Pythonic experience
• Browse the API Reference for detailed endpoint docs
• Learn about platform-specific features
• Review error codes for troubleshooting