Scrape Creators

https://docs.scrapecreators.com/
Admin
Scrape Creators offers APIs for extracting data from a wide range of social media platforms...
Tokens:7,742
Snippets:114
Trust Score:6.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Platform profile examples

Source: https://docs.scrapecreators.com/integrations/cli

Common usage examples for retrieving profile data.

```bash
# profiles
scrapecreators instagram profile --handle jane
scrapecreators tiktok profile --handle charlidamelio
scrapecreators youtube channel --handle ThePatMcAfeeShow
```

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

### Install ScrapeCreators CLI

Source: https://docs.scrapecreators.com/integrations/cli

Global installation command for the CLI package.

```bash
npm install -g @scrapecreators/cli
```

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

### Authentication examples

Source: https://docs.scrapecreators.com/integrations/cli

Various methods for providing API credentials.

```bash
scrapecreators tiktok profile --handle x --api-key YOUR_KEY
```

```bash
scrapecreators auth login
```

```bash
export SCRAPECREATORS_API_KEY=YOUR_KEY
```

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

### Run CLI without installation

Source: https://docs.scrapecreators.com/integrations/cli

Execute the CLI directly using npx.

```bash
npx @scrapecreators/cli tiktok profile --handle charlidamelio --api-key YOUR_KEY
```

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

### Launch interactive mode

Source: https://docs.scrapecreators.com/integrations/cli

Execute the CLI without arguments to trigger a guided walkthrough for platform and action selection.

```bash
scrapecreators
```

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

### GET /mpp/packs

Source: https://docs.scrapecreators.com/integrations/machine-payments

List all available credit packs and their associated pricing.

```APIDOC
## GET /mpp/packs

### Description
List available credit packs. No payment is required for this operation.

### Method
GET

### Endpoint
https://api.scrapecreators.com/mpp/packs

### Request Example
curl --request GET \
  --url https://api.scrapecreators.com/mpp/packs \
  --header "x-api-key: YOUR_API_KEY"
```

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

### Success response format

Source: https://docs.scrapecreators.com/integrations/machine-payments

Example JSON response returned upon a successful credit purchase.

```json
{
  "success": true,
  "pack": "freelance",
  "credits_added": 25000,
  "credits_remaining": 274038,
  "team_id": "..."
}
```

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

### List available credit packs

Source: https://docs.scrapecreators.com/integrations/machine-payments

Retrieve the list of available credit packs using a GET request.

```bash
curl --request GET \
  --url https://api.scrapecreators.com/mpp/packs \
  --header "x-api-key: YOUR_API_KEY"
```

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

### Install Agent Skill

Source: https://docs.scrapecreators.com/integrations/agent-skill

Use the npx command to add the ScrapeCreators social media research skills to your project.

```bash
npx skills add ScrapeCreators/social-media-research-skills
```

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

### Get daily usage

Source: https://docs.scrapecreators.com/caching

Retrieves the daily API usage statistics for the account.

```APIDOC
## GET /get-daily-usage

### Description
Retrieves the daily API usage statistics for the account.

### Method
GET

### Endpoint
/get-daily-usage
```

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

### Get credit balance

Source: https://docs.scrapecreators.com/caching

Retrieves the current credit balance for the authenticated account.

```APIDOC
## GET /get-credit-balance

### Description
Retrieves the current credit balance for the authenticated account.

### Method
GET

### Endpoint
/get-credit-balance
```

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

### CLI Data Extraction Commands

Source: https://docs.scrapecreators.com/integrations/cli

Examples of retrieving TikTok profile data using various output formats and piping options.

```bash
scrapecreators tiktok profile --handle charlidamelio
```

```bash
scrapecreators tiktok profile --handle charlidamelio --pretty
```

```bash
scrapecreators tiktok profile --handle charlidamelio | jq '.stats'
```

```bash
scrapecreators tiktok profile --handle charlidamelio --format table
```

```bash
scrapecreators tiktok profile --handle charlidamelio --format csv > output.csv
```

```bash
scrapecreators tiktok profile --handle charlidamelio --format csv --clean > output.csv
```

```bash
scrapecreators tiktok profile --handle charlidamelio --clean
```

```bash
scrapecreators tiktok profile-videos --handle charlidamelio --output ./data.json
```

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

### GET /v1/detect-age-gender

Source: https://docs.scrapecreators.com/llms.txt

Detects the age and gender of a creator by analyzing their profile image.

```APIDOC
## GET /v1/detect-age-gender

### Description
Detect age and gender of a creator using AI analysis of profile image.

### Method
GET

### Endpoint
/v1/detect-age-gender
```

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

### Get request history

Source: https://docs.scrapecreators.com/caching

Retrieves the history of API requests made by the account.

```APIDOC
## GET /get-request-history

### Description
Retrieves the history of API requests made by the account.

### Method
GET

### Endpoint
/get-request-history
```

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

### Get most used routes

Source: https://docs.scrapecreators.com/caching

Retrieves a list of the most frequently accessed API routes.

```APIDOC
## GET /get-most-used-routes

### Description
Retrieves a list of the most frequently accessed API routes.

### Method
GET

### Endpoint
/get-most-used-routes
```

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

### Discover CLI endpoints

Source: https://docs.scrapecreators.com/integrations/cli

List available platforms and endpoints, or view help documentation for specific commands.

```bash
# list all platforms
scrapecreators list

# list endpoints for a specific platform
scrapecreators list tiktok

# see full help for any endpoint
scrapecreators tiktok profile --help
```

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

### List available commands

Source: https://docs.scrapecreators.com/integrations/cli

Display all available API endpoints and commands.

```bash
scrapecreators list
```

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

### Authenticate with CLI

Source: https://docs.scrapecreators.com/integrations/cli

Command to authenticate and save credentials to the local configuration.

```bash
scrapecreators auth login
```

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

### Manage Tempo wallet for crypto payments

Source: https://docs.scrapecreators.com/integrations/machine-payments

Commands to create, fund, and use a Tempo wallet for USDC payments.

```bash
npx mppx account create
```

```bash
npx mppx account fund --network testnet
```

```bash
npx mppx "https://api.scrapecreators.com/mpp/buy-credits?pack=freelance" \
  -X POST \
  -H "x-api-key: YOUR_API_KEY"
```

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

### CLI usage pattern

Source: https://docs.scrapecreators.com/integrations/cli

General syntax structure for CLI commands.

```bash
scrapecreators <platform> <action> [--params]
```

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

### POST /mpp/buy-credits

Source: https://docs.scrapecreators.com/integrations/machine-payments

Initiate a purchase for a specific credit pack. This endpoint returns a 402 challenge which must be settled to grant credits.

```APIDOC
## POST /mpp/buy-credits

### Description
Returns a 402 challenge; on payment, grants the pack's credits to the team associated with the API key.

### Method
POST

### Endpoint
https://api.scrapecreators.com/mpp/buy-credits?pack=<pack>

### Parameters
#### Query Parameters
- **pack** (string) - Required - The identifier of the credit pack to purchase (e.g., 'freelance', 'business').

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the transaction was successful.
- **pack** (string) - The pack purchased.
- **credits_added** (number) - Amount of credits granted.
- **credits_remaining** (number) - New total balance.
- **team_id** (string) - The team ID associated with the credits.

### Response Example
{
  "success": true,
  "pack": "freelance",
  "credits_added": 25000,
  "credits_remaining": 274038,
  "team_id": "..."
}
```

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

### Execute API request

Source: https://docs.scrapecreators.com/integrations/cli

Perform a specific platform data retrieval request.

```bash
scrapecreators tiktok profile --handle charlidamelio
```

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

### Configure VS Code MCP Settings

Source: https://docs.scrapecreators.com/integrations/mcp

Add the server configuration to your VS Code settings.json file.

```json
{
  "mcp": {
    "servers": {
      "scrape-creators": {
        "url": "https://api.scrapecreators.com/mcp"
      }
    }
  }
}
```

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

### Add MCP Server via Claude Code CLI

Source: https://docs.scrapecreators.com/integrations/mcp

Use the Claude CLI to register the Scrape Creators MCP server.

```bash
claude mcp add --transport http scrape-creators https://api.scrapecreators.com/mcp
```

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

### Pay with Stripe Link wallet

Source: https://docs.scrapecreators.com/integrations/machine-payments

Create a spend request and pay using the Stripe Link CLI.

```bash
link-cli spend-request create \
  --amount 4700 \
  --credential-type shared_payment_token \
  --context "Buying Scrape Creators credits via MPP" \
  --request-approval
```

```bash
link-cli mpp pay "https://api.scrapecreators.com/mpp/buy-credits?pack=freelance" \
  --spend-request-id lsrq_xxx \
  --method POST \
  --header "x-api-key: YOUR_API_KEY"
```

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

### Configure Cursor MCP Server

Source: https://docs.scrapecreators.com/integrations/mcp

Add this configuration to the Cursor Tools & MCP settings to enable the Scrape Creators server.

```json
{
  "mcpServers": {
    "scrape-creators": {
      "url": "https://api.scrapecreators.com/mcp"
    }
  }
}
```

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

### Auto-configure MCP Servers

Source: https://docs.scrapecreators.com/integrations/cli

CLI commands to automatically add the MCP server configuration to specific agent environments.

```bash
scrapecreators agent add cursor    # writes .cursor/mcp.json
scrapecreators agent add claude    # writes ~/.claude/claude_desktop_config.json
scrapecreators agent add codex     # writes ~/.codex/mcp.json
```

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

### Pay with Stripe payment method

Source: https://docs.scrapecreators.com/integrations/machine-payments

Use a Stripe payment method to mint a Shared Payment Token for fiat payments.

```bash
export MPPX_STRIPE_SECRET_KEY=sk_live_...   # the payer's Stripe key

npx mppx "https://api.scrapecreators.com/mpp/buy-credits?pack=freelance" \
  -X POST \
  -H "x-api-key: YOUR_API_KEY" \
  --currency usd \
  -M paymentMethod=pm_xxx
```

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

### MCP Server Configuration

Source: https://docs.scrapecreators.com/integrations/cli

Manual configuration block for adding the ScrapeCreators MCP server to an agent's settings.

```json
{
  "mcpServers": {
    "scrapecreators": {
      "url": "https://api.scrapecreators.com/mcp",
      "headers": {
        "x-api-key": "your-key-here"
      }
    }
  }
}
```

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

### Configure API Authentication

Source: https://docs.scrapecreators.com/integrations/agent-skill

Set the SCRAPECREATORS_API_KEY environment variable to allow the agent to authenticate API requests.

```bash
export SCRAPECREATORS_API_KEY=your-api-key
```

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

### Integrate payments into agent code

Source: https://docs.scrapecreators.com/integrations/machine-payments

Use the mppx client SDK to automatically handle 402 payment challenges in your application.

```javascript
import { privateKeyToAccount } from 'viem/accounts'
import { Mppx, tempo } from 'mppx/client'

Mppx.create({
  methods: [tempo({ account: privateKeyToAccount(process.env.PRIVATE_KEY) })],
})

// global fetch now settles 402 payments on its own
const response = await fetch(
  "https://api.scrapecreators.com/mpp/buy-credits?pack=freelance",
  { method: "POST", headers: { "x-api-key": process.env.SCRAPECREATORS_API_KEY } },
)
const result = await response.json()
```

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

### Pinterest API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for searching Pinterest and retrieving pin and board data.

```APIDOC
## GET /v1/pinterest/search

### Description
Search Pinterest.

## GET /v1/pinterest/pin

### Description
Get a Pinterest pin.

## GET /v1/pinterest/user/boards

### Description
Get a user's Pinterest boards.

## GET /v1/pinterest/board

### Description
Get the pins of a Pinterest board.
```

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

### Scrape TikTok Videos to File

Source: https://docs.scrapecreators.com/integrations/cli

Extracts TikTok profile videos and saves the result to a specified JSON file path.

```bash
scrapecreators tiktok profile-videos --handle x --clean --output ./data.json
```

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

### Kick API

Source: https://docs.scrapecreators.com/llms.txt

Endpoint for accessing Kick clip data.

```APIDOC
## GET /v1/kick/clip

### Description
Get Kick clip details.
```

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

### Scrape Creators Account Management

Source: https://docs.scrapecreators.com/llms-full.txt

Endpoints for managing and monitoring your Scrape Creators account usage and credit balance.

```APIDOC
## GET /get-credit-balance

### Description
Retrieves the current credit balance for the authenticated account.

## GET /get-request-history

### Description
Retrieves the history of API requests made by the account.

## GET /get-daily-usage

### Description
Retrieves the daily API usage statistics.

## GET /get-most-used-routes

### Description
Retrieves a list of the most frequently accessed API routes.
```

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

### YouTube API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for retrieving YouTube channel details, video metadata, transcripts, and search results.

```APIDOC
## YouTube API Endpoints

- GET /v1/youtube/channel: Get comprehensive channel information including stats and metadata.
- GET /v1/youtube/channel-videos: Get all videos from a channel with detailed information.
- GET /v1/youtube/channel/shorts: Get the shorts from a channel.
- GET /v1/youtube/video: Get complete information about a video or short including transcript.
- GET /v1/youtube/video/transcript: Get transcript of a video or short.
- GET /v1/youtube/search: Search YouTube and get matching videos, channels, playlists, shorts, and lives.
- GET /v1/youtube/search/hashtag: Search YouTube by hashtag.
- GET /v1/youtube/video/comments: Get comments from a YouTube video.
- GET /v1/youtube/shorts/trending: Get trending shorts from YouTube.
- GET /v1/youtube/playlist: Get the videos of a YouTube playlist.
- GET /v1/youtube/community-post: Get the details of a YouTube community post.
```

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

### Scrape content feeds

Source: https://docs.scrapecreators.com/integrations/cli

Retrieve content feeds from TikTok, Instagram, and YouTube using platform-specific handles or search queries.

```bash
scrapecreators tiktok profile-videos --handle charlidamelio --sort-by popular
scrapecreators instagram user-posts --handle jane
scrapecreators instagram user-reels --handle jane

# single post/video
scrapecreators instagram post --url "https://www.instagram.com/reel/DOq6eV6iIgD"
scrapecreators tiktok video --url "https://www.tiktok.com/@user/video/123"

# search
scrapecreators youtube search --query "tutorials"
scrapecreators instagram reels-search --query "dogs"
scrapecreators reddit search --query "best programming languages"
```

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

### Scrape TikTok Profile with Cleaning

Source: https://docs.scrapecreators.com/integrations/cli

Extracts TikTok profile data while stripping booleans, empty values, and settings.

```bash
scrapecreators tiktok profile --handle x --clean
```

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

### Twitch API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for accessing Twitch profile and clip data.

```APIDOC
## GET /v1/twitch/profile

### Description
Get Twitch profile information.

## GET /v1/twitch/clip

### Description
Get Twitch clip details.
```

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

### Google Search API

Source: https://docs.scrapecreators.com/llms.txt

Endpoint for performing Google searches.

```APIDOC
## GET /v1/google/search

### Description
Search Google and get results.
```

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

### Bluesky API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for accessing Bluesky profile and post data.

```APIDOC
## GET /bluesky/profile

### Description
Get Bluesky profile info.

## GET /bluesky/user/posts

### Description
Get Bluesky user posts.

## GET /bluesky/post

### Description
Get a Bluesky post.
```

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

### Snapchat API

Source: https://docs.scrapecreators.com/llms.txt

Endpoint for accessing Snapchat user profile data.

```APIDOC
## GET /v1/snapchat/profile

### Description
Get Snapchat user profile information.
```

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

### Structured Error Response

Source: https://docs.scrapecreators.com/integrations/cli

The format returned by the CLI when an error occurs, useful for programmatic handling by agents.

```json
{
  "error": true,
  "code": "HTTP_401",
  "message": "...",
  "suggestion": "Run 'scrapecreators auth login'..."
}
```

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

### Google Ad Transparency API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for accessing Google Ad Transparency Library data.

```APIDOC
## GET /v1/google/company/ads

### Description
Get the public ads for a company from Google Ad Transparency Library.

## GET /v1/google/ad

### Description
Get the details for a Google ad.

## GET /v1/google/adLibrary/advertisers/search

### Description
Search the Google Ad Transparency Library for advertisers.
```

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

### Request cached data with cURL

Source: https://docs.scrapecreators.com/caching

Use the cache_max_age query parameter to specify the maximum age of a cached response you are willing to accept.

```bash
curl --request GET \
  --url 'https://api.scrapecreators.com/v1/tiktok/profile?handle=stoolpresidente&cache_max_age=7d' \
  --header 'x-api-key: YOUR_API_KEY'
```

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

### Amazon Shop API

Source: https://docs.scrapecreators.com/llms.txt

Endpoint for accessing Amazon Shop page data.

```APIDOC
## GET /v1/amazon/shop

### Description
Get products and details from a creator's Amazon Shop page.
```

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

### Threads API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for accessing Threads profile, post, and user search data.

```APIDOC
## GET /v1/threads/profile

### Description
Get Threads profile info.

## GET /v1/threads/user/posts

### Description
Get Threads posts by user.

## GET /v1/threads/post

### Description
Get a Threads post by URL with comments and related posts.

## GET /v1/threads/search/users

### Description
Search for Threads users by username.
```

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

### Facebook API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for retrieving public Facebook profile, group, and post data.

```APIDOC
## Facebook API Endpoints

- GET /v1/facebook/profile: Get public Facebook profile information.
- GET /v1/facebook/profile/reels: Get a public Facebook page's reels.
- GET /v1/facebook/profile/photos: Get a public Facebook page's photos.
- GET /v1/facebook/profile/posts: Get public Facebook profile posts.
- GET /v1/facebook/group/posts: Get a public Facebook group's posts.
- GET /v1/facebook/post: Get a public Facebook post or reel by URL.
- GET /v1/facebook/post/transcript: Get the transcript of a Facebook post or reel.
- GET /v1/facebook/post/comments: Get the comments of a Facebook post or reel.
```

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

### LinkedIn Ad Library API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for searching and retrieving LinkedIn ad data.

```APIDOC
## GET /v1/linkedin/ads/search

### Description
Search the LinkedIn Ad Library.

## GET /v1/linkedin/ad

### Description
Get the details for a LinkedIn ad.
```

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

### Link-in-Bio APIs

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for scraping various link-in-bio service pages.

```APIDOC
## GET /v1/linktree

### Description
Scrape a Linktree page.

## GET /v1/komi

### Description
Scrape a Komi page.

## GET /v1/pillar

### Description
Scrape a Pillar page.

## GET /v1/linkbio

### Description
Scrape a Linkbio (lnk.bio) page.

## GET /v1/linkme

### Description
Get Linkme profile info by URL.
```

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

### Reddit API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for accessing Reddit posts, comments, search, and ad library data.

```APIDOC
## GET /v1/reddit/subreddit/details

### Description
Get details about a subreddit.

## GET /v1/reddit/subreddit

### Description
Get recent posts from a subreddit with engagement metrics.

## GET /v1/reddit/subreddit/search

### Description
Search within a subreddit for posts, comments, or media.

## GET /v1/reddit/post/comments

### Description
Get comments and post information from a Reddit post.

## POST /v1/reddit/post/comments/post

### Description
Get comments and post information from a Reddit post using a JSON request body.

## GET /v1/reddit/search

### Description
Search Reddit for posts.

## GET /v1/reddit/ads/search

### Description
Search the Reddit Ad Library.

## GET /v1/reddit/ad

### Description
Get a specific Reddit ad by id.
```

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

### Twitter API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for retrieving Twitter profile, tweet, and community data.

```APIDOC
## GET /v1/twitter/profile

### Description
Get Twitter profile information including stats and metadata.

## GET /v1/twitter/user-tweets

### Description
Get tweets from a user's profile.

## GET /v1/twitter/tweet

### Description
Get detailed information about a specific tweet including engagement.

## GET /v1/twitter/tweet/transcript

### Description
Get the transcript of a video tweet.

## GET /v1/twitter/community

### Description
Get the details of a Twitter (X) Community.

## GET /v1/twitter/community/tweets

### Description
Get the tweets from a Twitter (X) Community.
```

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

### Instagram API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for retrieving Instagram profile data, posts, reels, transcripts, and comments.

```APIDOC
## Instagram API Endpoints

- GET /v1/instagram/profile: Gets public Instagram profile data, recent posts, and related accounts.
- GET /v1/instagram/basic-profile: Get a basic profile by user id.
- GET /v2/instagram/user/posts: Get a public profile's public posts.
- GET /v1/instagram/post: Retrieve public post or reel details.
- GET /v2/instagram/media/transcript: Get the transcript of an Instagram post or reel using AI.
- GET /v2/instagram/reels/search: Search for reels by keyword.
- GET /v2/instagram/post/comments: Get comments from an Instagram post or reel.
- GET /v1/instagram/user/reels: Get all public reels from a profile.
- GET /v1/instagram/user/highlights: Get story highlights from an Instagram user.
- GET /v1/instagram/user/highlight/detail: Get details about a specific highlight.
- GET /v1/instagram/song/reels: Get reels using a song.
- GET /v1/instagram/user/embed: Get the HTML embed for a user's profile.
```

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

### LinkedIn API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for retrieving public LinkedIn profile and company page information.

```APIDOC
## LinkedIn API Endpoints

- GET /v1/linkedin/profile: Get a person's public LinkedIn profile including recent posts.
- GET /v1/linkedin/company: Get a LinkedIn company page.
- GET /v1/linkedin/post: Get a LinkedIn post or article.
```

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

### Facebook Ad Library API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for searching and retrieving data from the Facebook Ad Library.

```APIDOC
## Facebook Ad Library API Endpoints

- GET /v1/facebook/adLibrary/ad: Get details about a Facebook ad.
- GET /v1/facebook/adLibrary/search/ads: Search the Facebook (Meta) Ad Library by keyword.
- POST /v1/facebook/adLibrary/search/ads/post: Search the Facebook (Meta) Ad Library by keyword using a JSON request body.
- GET /v1/facebook/adLibrary/company/ads: Get all the ads a company has running.
- POST /v1/facebook/adLibrary/company/ads/post: Get all the ads a company has running using a JSON request body.
- GET /v1/facebook/adLibrary/search/companies: Search for companies by name and get their ad library page id.
```

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

### Truth Social API

Source: https://docs.scrapecreators.com/llms.txt

Endpoints for accessing Truth Social profile and post data.

```APIDOC
## GET /v1/truthsocial/profile

### Description
Get Truth Social profile info.

## GET /v1/truthsocial/user/posts

### Description
Get Truth Social user posts.

## GET /v1/truthsocial/post

### Description
Get a Truth Social post.
```
Tokens:
Raw