An open source ScrapeCreators MCP and shared CLI with 190 tools, private accounts and approved bounded research.
Rate this tool
key_takeaways.md
TL;DRKey takeaways
One shared implementation supplies local MCP, CLI and a desktop bundle.
Potentially paid research always needs approval, including GET.
Batches validate first, cap 20 calls and stop on failure.
Official MCP, CLI and research skills already exist and are compared here.
This free ScrapeCreators MCP server and CLI gives your AI real access to public social research, transcripts, comments, ad libraries and private account usage.
Inspect the selected public resources, check account credit metadata and run explicitly approved bounded research.
It's one install with 2 ways in.
Claude, Codex, Cursor or any other MCP app calls its 190 tools for you, and the same tools work as a CLI that agents like Claude Code, Codex and OpenCode run, or that you type yourself.
Here's what the ScrapeCreators MCP server and CLI is, how to set it up in each app, and every tool it has.
What is the ScrapeCreators MCP server & CLI?
The ScrapeCreators MCP server & CLI is a free, open source program that lets AI agents research public profiles, posts, transcripts, comments and ads with paid-call approval for you, in 2 ways.
The MCP server is what an AI app like Claude, Codex or Cursor connects to, through MCP (Model Context Protocol), the open standard AI apps use to call outside tools.
You ask in plain language.
Your AI picks the right tool, and the server makes the call directly to the ScrapeCreators API.
The CLI is the same program as commands.
scrapecreators-cli scrapecreators-get-credit-balance runs the same code your AI runs when you ask to inspect your selected account balance, whether an agent like Claude Code runs it or you do.
What can you ask it?
Once it's set up, you ask the way you'd ask an assistant.
These are real prompts it handles:
Try askingCheck my intended account and available credits.
Show the exact public-profile lookup before I approve it.
Retrieve the transcript for the video and language I choose.
Research ads for the approved topic, country and status.
Run this exact two-call research batch, then stop.
Inspect account history before repeating the failed request.
ScrapeCreators has an official hosted MCP, CLI and research skills.
This owned package adds mandatory approval for potentially paid research, private named accounts and prevalidated sequential batches capped at 20 calls.
No broader API coverage or measured token savings is claimed.
How to install the ScrapeCreators MCP server
Choose your client in the install box. npm supplies MCP and CLI; GitHub Releases supplies the versioned desktop bundle.
Configure private access before any account request.
Before you start0/3
Use Node 22+ for manual CLI/MCP setup.
Configure the intended private ScrapeCreators API key.
Check endpoint costs, balance, public-data availability and caching.
Watch out: Installation grants no account access. Never put actual credentials into a repository, issue, guide, screenshot or model conversation.
Set up ScrapeCreators access
Private API key
- Sign in to the intended account at app.scrapecreators.com and open its API Keys area.
- Retrieve or create the key for the intended account/team. API access uses your ScrapeCreators key, not social-platform passwords, cookies or a GitHub CLI token.
- Save the key in a private token-only file outside repositories, then set
SCRAPECREATORS_TOKEN_FILEto its absolute path.SCRAPECREATORS_API_KEYin private local client/shell settings is the alternative. - Run
scrapecreators-cli doctor, thenscrapecreators-cli doctor --network. Network doctor reads current account credit metadata and prints no account details. - Check the required endpoint, available balance and approved task before any potentially paid research call.
Requests use x-api-key, with the fixed origin https://api.scrapecreators.com.
Routes retain their current v1/v2/v3 prefixes.
There is no invented dated-version header.
login prints instructions; it does not sign up, save credentials or complete OAuth.
The official hosted MCP supports its own OAuth/API-key flow, and the official CLI provides interactive key setup and GitHub device signup.
Those are separate products, not hidden features of this wrapper.
On macOS/Linux, use an owner-only key file (0600) in a private directory (0700).
On Windows, restrict its ACL to your user.
Files must be regular, not symlinks, and no larger than 64 KB.
A file overrides the environment key and is cached until restart.
GUI client settings and terminal environments are separate.
Never place actual credentials in chat, command arguments, project config, issues or examples.
This package does not automatically load .env files or use an OS keychain.
Access, pricing and quotas
A ScrapeCreators account with API access and enough credits is required; installing this free AGPL wrapper does not purchase data.
The provider pricing page, checked October 2, 2026, lists 100 starting credits, $47 for 25,000 credits and $497 for 500,000 credits, with no mandatory subscription and nonexpiring purchased credits.
Bonus/device-signup allowances have different conditions; check your actual dashboard.
No universal social-platform admin role or OAuth scope list is imposed by this API-key wrapper.
Most live research requests cost one credit, but current endpoint exceptions include TikTok audience demographics (26) and Find Social Profiles (10).
A supported cache hit costs zero; a miss can use the normal endpoint charge.
Do not treat max_calls as a credit or money limit.
Check response credits_charged, cached and cached_at where supplied, and the account request history.
Provider pricing can change.
The provider advertises no account-level rate/concurrency cap.
Local pacing defaults to 150 ms between calls per account/process as a reliability choice, not a provider quota rule or reservation.
Sequential batches cap at 20 explicit calls.
Research GET and POST requests never retry automatically; a lost response can still have consumed credits.
Only account-metadata GET 429 responses can retry, at most two by default, for Retry-After waits of ten seconds or less.
Longer waits return exit 7.
No failed-call billing guarantee is invented.
Provider caching and public-data limits
Only endpoints whose schema includes cache_max_age accept that option here: 1d, 3d, 7d, 14d or 30d.
A cache hit is older data, so retain its timestamp.
Team owners can disable provider caching on the API Keys page; then the option does not guarantee a hit or zero credits.
See the cache documentation.
This is public-data research, not social-platform publishing or a bypass for private profiles.
Availability, geographic results, transcript tracks, cursor validity and upstream platform changes affect results.
Account metadata/history can reveal private usage.
Choose only the requested public resources and keep returned personal or business data out of public logs.
Check that it works
Start with local configuration checks, then opt into one account credit-metadata read.
scrapecreators-cli --version
scrapecreators-cli doctor
scrapecreators-cli doctor --network
scrapecreators-cli list-accounts --agent
scrapecreators-cli scrapecreators-get-credit-balance --agentscrapecreators-cli --version
scrapecreators-cli doctor
scrapecreators-cli doctor --network
scrapecreators-cli list-accounts --agent
scrapecreators-cli scrapecreators-get-credit-balance --agentNetwork doctor performs GET /v1/account/credit-balance and reports authentication without account content.
A successful account read proves that request, not every public-data endpoint.
Full discovery exposes 190 tools, read-only exposes five.
Missing configuration exits 10; invalid arguments and refused paid research exit 2.
For an approved first research request, use a public handle you selected and an acceptable cache age:
scrapecreators-cli instagram-profile --handle PUBLIC_HANDLE --cache-max-age 7d --confirm --agentUse the ScrapeCreators CLI
The CLI is the same 190 tools as commands.
AI agents that run commands, like Claude Code, Codex and OpenCode, use it on their own, and you can type the same commands in a terminal or a script.
Every tool name becomes a command with dashes, so instagram_profile runs as scrapecreators-cli instagram-profile.
scrapecreators-cli
scrapecreators-cli instagram-profile --help
scrapecreators-cli schema research-batch
scrapecreators-cli scrapecreators-get-credit-balance --agent
scrapecreators-cli instagram-profile --handle PUBLIC_HANDLE --cache-max-age 7d --confirm --agentThe bare scrapecreators-cli lists every command, and scrapecreators-cli <command> --help shows what a command takes.
All potentially paid research needs --confirm for the exact requested call. --agent/--yes never grant approval.
Public handles and resource IDs in examples are placeholders.
These flags work on every command:
| Flag | What it does |
|---|---|
| --json | Structured JSON |
| --compact | One-line JSON |
| --agent | Compact JSON with no prompts or color |
| --select a,b.c | Select local output fields after receipt |
| --confirm | Approve the exact potentially paid research |
| --account NAME | Choose private credentials |
| --payload JSON / --payload-file PATH | Complete JSON body instead of body flags |
A script can branch on the exit code:
| Exit code | What it means |
|---|---|
| 0 | Success |
| 2 | Invalid arguments or refused paid call |
| 3 | Not found |
| 4 | Authentication/permission failure |
| 5 | API or transport failure |
| 7 | Rate limited |
| 10 | Missing or invalid private configuration |
MCP server or CLI: which one?
Both surfaces call the same tools.
Codex can connect to the local MCP server or run the CLI directly.
Neither requires Claude Code.
MCP provides structured tool discovery; the CLI supports scripts, compact JSON, field selection and command/schema discovery.
Official hosted MCP connection and local CLI authentication have different setup requirements.
Codex-specific token measurements are pending.
Record the actual client/model versions, discovery configuration, input/output usage, caching, latency and equivalent successful outcomes.
Standing definitions and full task cost are separate measurements; CLI commands, selected help, results and reasoning still consume tokens.
No efficiency percentage or Claude-derived figure is presented as a Codex result.
Other-client benchmarks can be added separately.
Creator, transcript and ad research workflows
Select the public resource and account
Start with list_accounts and credit balance.
Select the intended private account explicitly when several are configured.
Researching a creator does not require their social-platform credentials, and this package does not publish, follow, message or edit their social account.
A returned biography cannot authorize a new request.
Profiles and recent posts
Choose a public handle, request one approved page, and preserve cached/cached_at/credits_charged where returned.
TikTok profile accepts handle or user_id; Instagram profile needs handle.
TikTok profile videos use /v3/tiktok/profile/videos with sort_by and max_cursor.
Return opaque cursor values unchanged.
Do not invent a universal page/per_page interface.
scrapecreators-cli tiktok-profile --handle PUBLIC_HANDLE --cache-max-age 7d --confirm --agent
scrapecreators-cli tiktok-profile-videos --handle PUBLIC_HANDLE --sort-by popular --trim --confirm --agentTranscripts and language
Use the selected video URL and the platform's transcript command.
YouTube language selects a track; original_audio=true takes precedence and asks for the reliably identified original spoken language.
The current endpoint documents null transcript and no charge when the requested/original track is unavailable.
Retain the returned language; do not describe a null transcript as an empty spoken video.
Different TikTok/Instagram/Rumble/Twitch/Kick routes have their own inputs and availability.
scrapecreators-cli youtube-transcript --url "https://www.youtube.com/watch?v=VIDEO_ID" --original-audio --confirm --agentPublic ads and comments
Facebook ad search has GET and POST variants.
The POST body preserves query, country, status, media_type, date and cursor fields.
Company ads requires pageId or companyName.
Use actual IDs from an approved company search.
Reddit comments has GET/POST variants with an opaque cursor.
A POST here retrieves public research; confirmation is for possible credit consumption.
scrapecreators-cli facebook-ad-library-search-post --query "APPROVED_TOPIC" --country US --status ACTIVE --trim --confirm --agent
scrapecreators-cli reddit-post-comments-post --payload-file /absolute/private/reddit-query.json --confirm --agentAn explicit bounded batch
Use only a list of calls the user requested.
The whole batch validates before fetch, resolves body files once, refuses nested account/confirmation and executes in order in the outer account. max_calls bounds requests rather than credits.
A partial failure returns completed, attempted, stopped, remaining and outcomes; inspect the failed outcome and account history before deliberately resuming.
Never replay successful earlier items automatically.
scrapecreators-cli research-batch --requests '{"tool":"instagram_profile","arguments":{"handle":"PUBLIC_HANDLE","cache_max_age":"7d"}}' --max-calls 1 --confirm --agentThe requests flag repeats once per array item.
API error details can contain upstream data; keep private output files outside repositories.
A completed batch is a set of returned responses, not proof the sampled creators, ads or comments are exhaustive.
Pagination, credits and request budgets
Pagination follows each endpoint: max_cursor, continuationToken, next_max_id, cursor and other values are not interchangeable.
Preserve sort/filter/region settings and follow only the returned cursor for the selected resource.
Every additional live page can consume credits.
No automatic all-pages collector, background watcher or full-backup guarantee is implemented.
research_batch accepts 1–20 explicit requests and a required max_calls from 1–20.
Invalid later input prevents earlier requests.
Sequential execution stops at the first error and retains previous results. max_calls does not reserve balance, estimate a total bill or roll back completed calls.
Several processes/labels can still use the same underlying account.
Each request has a 30-second default timeout, 5 MiB local JSON-body cap and 10 MiB response cap.
A response-cap failure can happen after the provider charged the call.
Twenty bounded responses can still be substantial data: choose output fields and small endpoint queries deliberately. --select is post-receipt output selection, not a provider charge reduction.
Only account-metadata GET 429 handling retries automatically, for short bounded Retry-After waits.
Paid research never retries, regardless of HTTP method or network failure.
Inspect account history after an uncertain outcome.
Cache policy is an upstream feature shared with official tools, not an efficiency invention of this wrapper.
Every ScrapeCreators tool
Actual discovery gives 190 tools: 5 local/account reads and 185 potentially paid calls.
All potentially paid calls ask first.
The same 188 provider endpoint variants exist in the reviewed official CLI; our two local helpers add workflows rather than API coverage.
Tiktok
tiktok_profile- What it does
- Fetches public profile data for a TikTok user by their handle or user_id — useful for looking up a creator's identity, bio, and account stats.
- Kind
- Paid call; asks first
tiktok_profile_region- What it does
- Returns the TikTok region code for a public profile, like
USfor United States orMXfor Mexico. - Kind
- Paid call; asks first
tiktok_audience_demographics- What it does
- Retrieves audience demographic data for a TikTok user, showing where their followers are located by country.
- Kind
- Paid call; asks first
tiktok_collection_videos- What it does
- Fetches the videos saved in a public TikTok collection, which TikTok also calls a playlist.
- Kind
- Paid call; asks first
tiktok_profile_videos- What it does
- Fetches videos posted by a TikTok user, sortable by latest or most popular — use this to get a creator's video feed or TikToks.
- Kind
- Paid call; asks first
tiktok_video_info- What it does
- Fetches detailed data for a single TikTok video by URL, including its metadata, engagement stats, and optionally its transcript/captions.
- Kind
- Paid call; asks first
tiktok_transcript- What it does
- Extracts existing transcripts, captions, or subtitles from a TikTok video by URL.
- Kind
- Paid call; asks first
tiktok_live- What it does
- Checks if a TikTok user is currently live streaming and retrieves their live room details.
- Kind
- Paid call; asks first
tiktok_live_info- What it does
- Gets curated room-level info for a TikTok live using TokAPI's live info endpoint.
- Kind
- Paid call; asks first
tiktok_comments- What it does
- Fetches comments on a TikTok video by URL — useful for reading audience reactions, replies, and engagement.
- Kind
- Paid call; asks first
tiktok_comment_replies- What it does
- Fetches replies to a specific TikTok comment by its ID.
- Kind
- Paid call; asks first
tiktok_following- What it does
- Retrieves the following list — accounts that a TikTok user follows — by their handle.
- Kind
- Paid call; asks first
tiktok_followers- What it does
- Retrieves the follower list of a TikTok account by handle or user_id — useful for seeing who follows a creator or getting subscriber data.
- Kind
- Paid call; asks first
tiktok_search_users- What it does
- Searches for TikTok users by keyword or name — useful for finding creators or accounts matching a query.
- Kind
- Paid call; asks first
tiktok_search_suggestions- What it does
- Gets the autocomplete suggestions TikTok shows while someone is typing in search.
- Kind
- Paid call; asks first
tiktok_search_by_hashtag- What it does
- Searches for TikTok videos under a specific hashtag — useful for finding content by topic or trend.
- Kind
- Paid call; asks first
tiktok_search_by_keyword- What it does
- Searches for TikTok videos by keyword or phrase — the general video search across all of TikTok.
- Kind
- Paid call; asks first
tiktok_top_search- What it does
- Searches TikTok's 'Top' results by query — returns both videos and photo carousels, unlike keyword search which only returns videos.
- Kind
- Paid call; asks first
tiktok_get_popular_creators- What it does
- Discovers trending and popular TikTok creators, filterable by follower count range, creator country, and audience country.
- Kind
- Paid call; asks first
tiktok_get_song_details- What it does
- Fetches detailed metadata for a specific TikTok sound or song by its clipId.
- Kind
- Paid call; asks first
tiktok_tiktoks_using_song- What it does
- Fetches TikTok videos that use a specific sound or song, identified by its clipId.
- Kind
- Paid call; asks first
tiktok_trending_feed- What it does
- Fetches TikTok's trending/For You feed for a given region — useful for discovering viral content and what's currently popular.
- Kind
- Paid call; asks first
Tiktok Shop
tiktok_shop_shop_search- What it does
- Searches TikTok Shop for products matching a keyword query.
- Kind
- Paid call; asks first
tiktok_shop_shop_products- What it does
- Lists all products from a specific TikTok Shop store by its URL.
- Kind
- Paid call; asks first
tiktok_shop_product_details- What it does
- Fetches full details for a specific US TikTok Shop product by its URL, including stock levels and affiliate videos.
- Kind
- Paid call; asks first
tiktok_shop_product_reviews- What it does
- Fetches customer reviews for a TikTok Shop product by URL or product_id.
- Kind
- Paid call; asks first
tiktok_shop_user_showcase- What it does
- Fetches products featured in a TikTok user's public showcase — the products a creator promotes on their profile.
- Kind
- Paid call; asks first
instagram_profile- What it does
- Retrieves comprehensive public Instagram profile information including biography, bio links, follower and following counts, verification status, and profile picture URLs.
- Kind
- Paid call; asks first
instagram_basic_profile- What it does
- Fetches a lightweight Instagram profile summary by user ID, returning username, full name, biography, profile picture URL, verification status, follower count, following count, media count, and account privacy and type.
- Kind
- Paid call; asks first
instagram_posts- What it does
- Returns a paginated feed of a user's public Instagram posts, including reels, photos, videos, and carousels.
- Kind
- Paid call; asks first
instagram_user_tagged_posts- What it does
- Returns up to 10 public posts per page from an Instagram user's Tagged tab.
- Kind
- Paid call; asks first
instagram_reels- What it does
- Returns a paginated list of a user's public Instagram reels (short-form videos).
- Kind
- Paid call; asks first
instagram_post_reel_info- What it does
- Fetches detailed metadata for a single Instagram post or reel by shortcode or URL.
- Kind
- Paid call; asks first
instagram_transcript- What it does
- Generates an AI-powered speech-to-text transcription for an Instagram video post or reel.
- Kind
- Paid call; asks first
instagram_search_instagram- What it does
- Use this for Instagram-native account, hashtag, or place lookup.
- Kind
- Paid call; asks first
instagram_popular_search- What it does
- Use this to explore an Instagram topic and the posts Instagram curates for it.
- Kind
- Paid call; asks first
instagram_search_hashtag_posts- What it does
- Use this when you know the exact hashtag and want Google-indexed public Instagram posts or reels, optional date filters, and pagination.
- Kind
- Paid call; asks first
instagram_search_instagram_profiles- What it does
- Use this for Instagram-native profile lookup.
- Kind
- Paid call; asks first
instagram_search_reels- What it does
- Use this when you only want Google-indexed Instagram reels matching a keyword or phrase, with optional date filters and pagination.
- Kind
- Paid call; asks first
instagram_get_reels_by_audio_id- What it does
- Fetches the reels Instagram exposes for an audio page like instagram.com/reels/audio/{audio_id}/.
- Kind
- Paid call; asks first
instagram_trending_reels- What it does
- Fetches trending reels from Instagram's public instagram.com/reels page.
- Kind
- Paid call; asks first
instagram_comments- What it does
- Retrieves comments on a public Instagram post or reel.
- Kind
- Paid call; asks first
instagram_comment_replies- What it does
- Retrieves the public replies to a specific Instagram comment.
- Kind
- Paid call; asks first
instagram_story_highlights- What it does
- Lists all story highlight albums for an Instagram user.
- Kind
- Paid call; asks first
instagram_highlights_details- What it does
- Fetches the full contents of a specific Instagram story highlight album by its ID.
- Kind
- Paid call; asks first
instagram_profile_post_count- What it does
- Returns the post count shown on a public Instagram profile.
- Kind
- Paid call; asks first
instagram_embed_html- What it does
- Returns the raw HTML embed snippet for an Instagram user's profile widget.
- Kind
- Paid call; asks first
Telegram
telegram_channel_details- What it does
- Retrieves public Telegram channel or group metadata including its name, description, avatar, verification status, subscriber or member count, and public media counters.
- Kind
- Paid call; asks first
telegram_channel_posts- What it does
- Retrieves one public web-preview page of Telegram posts with text, publish date, views, reactions when exposed, forwards, media previews, and link previews.
- Kind
- Paid call; asks first
telegram_post_details- What it does
- Retrieves one public Telegram post with its text, publish date, views, reactions when exposed, forward source, media previews, and link preview.
- Kind
- Paid call; asks first
Youtube
youtube_channel_details- What it does
- Retrieves comprehensive YouTube channel profile data including name, avatar images, subscriber count (subscribers), total video and view counts, join date, tags, and linked social accounts like Twitter and Instagram.
- Kind
- Paid call; asks first
youtube_channel_videos- What it does
- Fetches a paginated list of videos uploaded by a YouTube channel, including each video's title, URL, thumbnail, view count (views), publish date, duration, and description.
- Kind
- Paid call; asks first
youtube_channel_playlists- What it does
- Fetches playlists from a YouTube channel's Playlists tab, including playlist ID, title, thumbnail, video count, channel info, playlist URL, and a continuationToken when YouTube has more results.
- Kind
- Paid call; asks first
youtube_channel_lives- What it does
- Fetches live streams and past streams from a YouTube channel's Live tab, including title, URL, thumbnail, view count, publish time, duration, and a continuationToken when YouTube has more results.
- Kind
- Paid call; asks first
youtube_channel_community_posts- What it does
- Fetches community posts from a YouTube channel's Posts tab, including post ID, URL, content, images, attached video, like count, publish time, channel info, and a continuationToken when YouTube has more results.
- Kind
- Paid call; asks first
youtube_channel_shorts- What it does
- Retrieves a paginated list of short-form videos (Shorts) from a YouTube channel, including each short's title, URL, view count (views), likes, comments, description, and publish date.
- Kind
- Paid call; asks first
youtube_video_short_details- What it does
- Fetches full details for a YouTube video or short, including title, description, thumbnail, view count (views), like count (likes), comment count, publish date, duration, genre, keywords, chapters, collaborators, and available caption tracks (subtitles/captions).
- Kind
- Paid call; asks first
youtube_transcript- What it does
- Retrieves publicly available captions, subtitles, or transcripts from a YouTube video or Short.
- Kind
- Paid call; asks first
youtube_video_sponsors- What it does
- Experimental endpoint.
- Kind
- Paid call; asks first
youtube_search- What it does
- Searches YouTube by keyword query and returns matching videos, channels, playlists, shorts, shelves, and live streams.
- Kind
- Paid call; asks first
youtube_search_typeahead- What it does
- Returns the live search suggestions YouTube displays while a user types.
- Kind
- Paid call; asks first
youtube_search_by_hashtag- What it does
- Searches YouTube for content matching a specific hashtag and returns matching videos with title, URL, thumbnail, view count (views), publish date, duration, and channel info.
- Kind
- Paid call; asks first
youtube_comments- What it does
- Fetches comments and replies from a YouTube video, including each comment's text content, author details, like count, reply count, and publish date.
- Kind
- Paid call; asks first
youtube_comment_replies- What it does
- Fetches replies to a specific comment on a YouTube video, including each reply's text content, author details (name, channel ID, avatar, verified/creator status), like count, and publish date.
- Kind
- Paid call; asks first
youtube_trending_shorts- What it does
- Fetches approximately 48 currently trending YouTube Shorts (viral/popular short-form videos) per call, returning each short's title, URL, thumbnail, view count (views), like count (likes), comment count, publish date, channel info, keywords, and duration.
- Kind
- Paid call; asks first
youtube_playlist- What it does
- Retrieves all videos in a YouTube playlist, including the playlist title, owner info, total video count, and each video's title, URL, thumbnail, duration, and channel.
- Kind
- Paid call; asks first
youtube_community_post_details- What it does
- Retrieves the full details of a YouTube community post, including its text content, attached images, like count, publish date, and associated channel info.
- Kind
- Paid call; asks first
Rumble
rumble_search- What it does
- Searches Rumble videos by keyword.
- Kind
- Paid call; asks first
rumble_channel_videos- What it does
- Gets videos from a Rumble channel by handle or URL.
- Kind
- Paid call; asks first
rumble_video- What it does
- Gets Rumble video details by URL.
- Kind
- Paid call; asks first
rumble_transcript- What it does
- Gets a Rumble video's transcript when captions are available.
- Kind
- Paid call; asks first
rumble_comments- What it does
- Gets all top level comments for a Rumble video by URL.
- Kind
- Paid call; asks first
linkedin_person_profile- What it does
- Retrieves a person's public LinkedIn profile data, including their name, photo, location, follower count (followers), about/bio summary, recent posts, work experience, education, articles, activity feed, publications, projects, recommendations, and similar profiles.
- Kind
- Paid call; asks first
linkedin_company_page- What it does
- Fetches a LinkedIn company page with details including name, description, logo, cover image, slogan, location, headquarters, employee count (headcount/staff size), website, industry, company type, founded year, specialties, funding rounds with investors, featured employees, recent posts, and similar company pages.
- Kind
- Paid call; asks first
linkedin_company_posts- What it does
- Retrieves paginated posts from a LinkedIn company page, including each post's URL, ID, publication date, and full text content.
- Kind
- Paid call; asks first
linkedin_search_posts- What it does
- Finds public LinkedIn posts, feed updates, and Pulse articles by keyword using Google Search, then returns post details such as description, author, media, images, like count, comment count, and published date when LinkedIn exposes them publicly.
- Kind
- Paid call; asks first
linkedin_post- What it does
- Fetches a single LinkedIn post or article, returning the title, headline, full description text, author info with follower count, publication date, like count (reactions), comment count, and individual comments.
- Kind
- Paid call; asks first
linkedin_post_transcript- What it does
- Fetches the transcript from a LinkedIn post video when LinkedIn exposes one publicly.
- Kind
- Paid call; asks first
facebook_profile- What it does
- Retrieves public Facebook page details including category, address, email, phone, website, services, priceRange, rating, likeCount, talkingAboutCount, and followerCount.
- Kind
- Paid call; asks first
facebook_profile_reels- What it does
- Fetches up to 10 reels per request from a public Facebook page.
- Kind
- Paid call; asks first
facebook_profile_photos- What it does
- Fetches photos from a public Facebook page with pagination support.
- Kind
- Paid call; asks first
facebook_profile_posts- What it does
- Returns publicly visible Facebook profile posts, limited to 3 posts per page due to API limitations.
- Kind
- Paid call; asks first
facebook_profile_events- What it does
- Get the events of a public Facebook page Potentially consumes paid API credits; requires confirm=true.
- Kind
- Paid call; asks first
facebook_post- What it does
- Retrieves a single public Facebook post or reel by URL.
- Kind
- Paid call; asks first
facebook_transcript- What it does
- Extracts the transcript text from a Facebook video post or reel.
- Kind
- Paid call; asks first
facebook_comments- What it does
- Fetches comments from a Facebook post or reel with cursor-based pagination.
- Kind
- Paid call; asks first
facebook_comment_replies- What it does
- Get the replies to a comment.
- Kind
- Paid call; asks first
facebook_facebook_group_info- What it does
- Fetches the public information shown on a Facebook group's About page, including its description, privacy and visibility, member and activity counts, categories, administrators and moderators when Facebook exposes them, group history, and rules.
- Kind
- Paid call; asks first
facebook_facebook_group_posts- What it does
- Fetches posts from a public Facebook group, limited to 3 posts per page due to API limitations.
- Kind
- Paid call; asks first
Github
github_user- What it does
- Retrieves public GitHub user details including name, bio, avatar, company, location, blog, follower counts, public repo counts, and account timestamps.
- Kind
- Paid call; asks first
github_repositories- What it does
- Retrieves a user's public repositories with repo metadata like description, language, stars, forks, topics, license, visibility, default branch, and timestamps.
- Kind
- Paid call; asks first
github_pull_requests- What it does
- Searches public GitHub pull requests authored by a user using GitHub's public search index.
- Kind
- Paid call; asks first
github_activity- What it does
- Retrieves GitHub profile contribution activity for a user from the public profile activity timeline.
- Kind
- Paid call; asks first
github_followers- What it does
- Retrieves public GitHub followers for a user.
- Kind
- Paid call; asks first
github_following- What it does
- Retrieves public accounts followed by a GitHub user.
- Kind
- Paid call; asks first
github_contributions- What it does
- Retrieves the public GitHub contribution graph for a user and year, including total contributions and daily contribution counts/intensity.
- Kind
- Paid call; asks first
github_repository- What it does
- Retrieves public metadata for one GitHub repository, including owner, description, language, stars, forks, topics, license, visibility, default branch, open issues, and timestamps.
- Kind
- Paid call; asks first
github_trending_repositories- What it does
- Scrapes GitHub's public Trending repositories page.
- Kind
- Paid call; asks first
github_trending_developers- What it does
- Scrapes GitHub's public Trending developers page.
- Kind
- Paid call; asks first
Facebook Marketplace
facebook_marketplace_marketplace_location_search- What it does
- Searches Facebook Marketplace locations/cities and returns coordinates you can use with the Marketplace Search endpoint.
- Kind
- Paid call; asks first
facebook_marketplace_marketplace_search- What it does
- Searches Facebook Marketplace listings by keyword and lat/lng.
- Kind
- Paid call; asks first
facebook_marketplace_marketplace_item- What it does
- Fetches details for a Facebook Marketplace item by item id or Marketplace item URL, including title, description, price, location, condition, photos, seller, and availability flags.
- Kind
- Paid call; asks first
Facebook Events
facebook_events_search_events- What it does
- Search for events by name.
- Kind
- Paid call; asks first
facebook_events_events- What it does
- Get the events of a city.
- Kind
- Paid call; asks first
facebook_events_event_details- What it does
- Get a specific event by its URL or id Potentially consumes paid API credits; requires confirm=true.
- Kind
- Paid call; asks first
Facebook Ad Library
facebook_ad_library_ad_details- What it does
- Retrieves detailed information about a specific Facebook ad by its ID or URL.
- Kind
- Paid call; asks first
facebook_ad_library_ad_transcript- What it does
- Retrieves a transcript for a single Facebook Ad Library video ad by ID or URL.
- Kind
- Paid call; asks first
facebook_ad_library_search- What it does
- Searches the Meta Ad Library by keyword and returns matching ads.
- Kind
- Paid call; asks first
facebook_ad_library_search_post- What it does
- Searches the Meta Ad Library by keyword and returns matching ads.
- Kind
- Paid call; asks first
facebook_ad_library_company_ads- What it does
- Fetches all ads currently running for a specific company from the Meta Ad Library.
- Kind
- Paid call; asks first
facebook_ad_library_company_ads_post- What it does
- Fetches all ads currently running for a specific company from the Meta Ad Library.
- Kind
- Paid call; asks first
facebook_ad_library_search_for_companies- What it does
- Searches for companies by name in the Meta Ad Library and returns their page IDs for use with other ad library endpoints.
- Kind
- Paid call; asks first
Tiktok Ad Library
tiktok_ad_library_ad_library_search- What it does
- Searches TikTok's public Ads Library using either query for a general search or advertiser_name for advertiser-specific results.
- Kind
- Paid call; asks first
tiktok_ad_library_ad_library_ad- What it does
- Fetches one TikTok ad by ID or URL.
- Kind
- Paid call; asks first
Google Ad Library
google_ad_library_company_ads- What it does
- Fetches public ads for a company from the Google Ad Transparency Library by domain or advertiser_id.
- Kind
- Paid call; asks first
google_ad_library_ad_details- What it does
- Retrieves detailed information about a specific Google ad including advertiserId, creativeId, format, firstShown, lastShown, and overallImpressions.
- Kind
- Paid call; asks first
google_ad_library_advertiser_search- What it does
- Searches the Google Ad Transparency Library for advertisers by name.
- Kind
- Paid call; asks first
Linkedin Ad Library
linkedin_ad_library_search_ads- What it does
- Searches the LinkedIn Ad Library by company name, keyword, or companyId with optional country and date filters.
- Kind
- Paid call; asks first
linkedin_ad_library_ad_details- What it does
- Retrieves detailed information about a specific LinkedIn ad by URL.
- Kind
- Paid call; asks first
twitter_profile- What it does
- Retrieves a Twitter user's profile by handle, including account metadata and statistics.
- Kind
- Paid call; asks first
twitter_user_tweets- What it does
- Fetches tweets from a Twitter user's profile by handle.
- Kind
- Paid call; asks first
twitter_tweet_details- What it does
- Retrieves detailed information about a specific tweet by URL, including the author's profile and engagement metrics.
- Kind
- Paid call; asks first
twitter_transcript- What it does
- Extracts the transcript from a Twitter video tweet using AI-powered transcription.
- Kind
- Paid call; asks first
twitter_community- What it does
- Retrieves details about a Twitter/X Community by URL.
- Kind
- Paid call; asks first
twitter_community_tweets- What it does
- Fetches tweets posted within a Twitter/X Community by URL.
- Kind
- Paid call; asks first
reddit_subreddit_details- What it does
- Retrieves metadata about a subreddit by name or URL.
- Kind
- Paid call; asks first
reddit_subreddit_posts- What it does
- Fetches posts from a subreddit with sorting and filtering options.
- Kind
- Paid call; asks first
reddit_subreddit_search- What it does
- Searches within a specific subreddit for posts, comments, and media matching a query.
- Kind
- Paid call; asks first
reddit_post- What it does
- Retrieves public Reddit post details by URL without fetching or returning comments.
- Kind
- Paid call; asks first
reddit_post_comments- What it does
- Retrieves comments and post details from a Reddit post by URL.
- Kind
- Paid call; asks first
reddit_post_comments_post- What it does
- Retrieves comments and post details from a Reddit post by URL.
- Kind
- Paid call; asks first
reddit_post_transcript- What it does
- Gets the transcript from a Reddit video post or direct v.redd.it URL when Reddit exposes a VTT caption file.
- Kind
- Paid call; asks first
reddit_search- What it does
- Searches across all of Reddit for posts or comments matching a query.
- Kind
- Paid call; asks first
Truth Social
truth_social_profile- What it does
- Retrieves a Truth Social user's public profile including display_name, username, avatar, header, followers_count, following_count, statuses_count, verified status, website, and created_at.
- Kind
- Paid call; asks first
truth_social_user_posts- What it does
- Fetches a paginated list of posts from a Truth Social user, returning text, id, created_at, url, content, account info, media_attachments, card link previews, replies_count, reblogs_count, and favourites_count.
- Kind
- Paid call; asks first
truth_social_post- What it does
- Fetches a single Truth Social post by URL, returning text, id, created_at, url, content, account details, media_attachments, card link previews, replies_count, reblogs_count, and favourites_count.
- Kind
- Paid call; asks first
Threads
threads_profile- What it does
- Retrieves a Threads user's public profile including username, full_name, biography, profile_pic_url, follower_count, is_verified, bio_links, and hd_profile_pic_versions.
- Kind
- Paid call; asks first
threads_posts- What it does
- Fetches the most recent posts from a Threads user, returning id, caption text, code, like_count, reshare_count, direct_reply_count, repost_count, image_versions2, video_versions, and taken_at.
- Kind
- Paid call; asks first
threads_post- What it does
- Fetches a single Threads post by URL, returning the post's caption, like_count, view_counts, reshare_count, direct_reply_count, image_versions2, text_post_app_info, and taken_at.
- Kind
- Paid call; asks first
threads_search_by_keyword- What it does
- Searches Threads for posts matching a keyword, returning up to 10 results with caption text, like_count, reshare_count, direct_reply_count, user info, and image_versions2.
- Kind
- Paid call; asks first
threads_search_users- What it does
- Searches for Threads users by username, returning matching profiles with username, full_name, profile_pic_url, is_verified, and pk.
- Kind
- Paid call; asks first
Bluesky
bluesky_profile- What it does
- Retrieves a Bluesky user's public profile including handle, displayName, avatar, description, followersCount, followsCount, postsCount, createdAt, and verification status.
- Kind
- Paid call; asks first
bluesky_posts- What it does
- Fetches a paginated feed of posts from a Bluesky user, returning each post's uri, record text, author info, embed content, replyCount, repostCount, likeCount, quoteCount, and indexedAt.
- Kind
- Paid call; asks first
bluesky_post- What it does
- Fetches a single Bluesky post by URL, returning the post's record text, author info, embed content, replyCount, repostCount, likeCount, and quoteCount.
- Kind
- Paid call; asks first
pinterest_search- What it does
- Searches Pinterest for pins matching a query, returning results with id, url, title, description, images, link, domain, board info, and pinner details.
- Kind
- Paid call; asks first
pinterest_pin- What it does
- Fetches detailed information about a single Pinterest pin by URL, returning title, description, link, dominantColor, originPinner, pinner, images at multiple resolutions (imageSpec_236x through imageSpec_orig), and pinJoin with visual annotations.
- Kind
- Paid call; asks first
pinterest_user_boards- What it does
- Fetches a paginated list of boards for a Pinterest user, returning each board's name, url, description, pin_count, follower_count, owner info, cover_images, and created_at.
- Kind
- Paid call; asks first
pinterest_board- What it does
- Fetches a paginated list of pins from a Pinterest board by URL, returning each pin's id, description, title, images, board info, pin_join annotations, and aggregated_pin_data.
- Kind
- Paid call; asks first
google_search- What it does
- Performs a Google search and returns organic results with url, title, and description for each result.
- Kind
- Paid call; asks first
Twitch
twitch_profile- What it does
- Retrieves a Twitch user's public profile by handle, including identity, social links, and content.
- Kind
- Paid call; asks first
twitch_user_videos- What it does
- Fetches a list of videos (100 max) for a Twitch user, returning each video's id, slug, url, embedURL, title, viewCount, language, durationSeconds, game info, broadcaster details with follower count, thumbnailURL, and videoQualities at multiple resolutions with a signed videoURL for playback.
- Kind
- Paid call; asks first
twitch_user_schedule- What it does
- Fetches a user's schedule by handle, returning a list of scheduled events with start time, end time, title, description, and thumbnail URL.
- Kind
- Paid call; asks first
twitch_clip_transcript- What it does
- Gets a transcript from a public Twitch clip.
- Kind
- Paid call; asks first
twitch_clip- What it does
- Fetches detailed data for a Twitch clip by URL, including metadata and direct video URLs.
- Kind
- Paid call; asks first
Apple Music
apple_music_artist- What it does
- Retrieves public Apple Music artist details, including artwork, editorial notes, top songs, albums, music videos, playlists, and related sections.
- Kind
- Paid call; asks first
apple_music_album- What it does
- Retrieves public Apple Music album details, including title, artist, artwork, release info, tracks, and more by the artist.
- Kind
- Paid call; asks first
apple_music_track- What it does
- Retrieves public Apple Music song details by id or URL.
- Kind
- Paid call; asks first
apple_music_search- What it does
- Searches Apple Music and returns public result sections for artists, albums, songs, playlists, stations, and music videos.
- Kind
- Paid call; asks first
Spotify
spotify_artist- What it does
- Retrieves detailed information about a Spotify artist by their handle, including name, followers count, genres, and related artists.
- Kind
- Paid call; asks first
spotify_track- What it does
- Retrieves detailed information about a Spotify track by its id or URL, including track metadata, artists, album info, duration, playability, and sharing details.
- Kind
- Paid call; asks first
spotify_album- What it does
- Retrieves detailed information about a Spotify album by its id or URL, including album metadata, artists, release date, cover art, copyright info, tracks, and sharing details.
- Kind
- Paid call; asks first
spotify_playlist- What it does
- Retrieves public Spotify playlist metadata and up to 50 tracks by playlist id or URL.
- Kind
- Paid call; asks first
spotify_search- What it does
- Search Spotify for tracks, artists, albums, episodes, podcasts, and audiobooks.
- Kind
- Paid call; asks first
spotify_podcast- What it does
- Retrieves detailed information about a Spotify podcast by its id or URL.
- Kind
- Paid call; asks first
spotify_podcast_episodes- What it does
- Returns episodes for a Spotify podcast.
- Kind
- Paid call; asks first
Soundcloud
soundcloud_artist- What it does
- Fetches detailed information about a SoundCloud artist by its handle or URL.
- Kind
- Paid call; asks first
soundcloud_artist_tracks- What it does
- Fetches tracks/songs for a SoundCloud artist by handle or URL.
- Kind
- Paid call; asks first
soundcloud_track- What it does
- Fetches detailed information about a SoundCloud track/song by URL.
- Kind
- Paid call; asks first
Kwai
kwai_profile- What it does
- Fetches public Kwai profile data including username, bio, avatar, verification status, gender, and public counts.
- Kind
- Paid call; asks first
kwai_user_posts- What it does
- Fetches a paginated list of public Kwai posts for a user, including captions, media URLs, covers, counts, author info, and the next cursor when more results are available.
- Kind
- Paid call; asks first
kwai_post- What it does
- Fetches public Kwai post details including caption, media URLs, cover images, counts, author info, and music metadata.
- Kind
- Paid call; asks first
Kick
kick_clip_transcript- What it does
- Gets a transcript from a public Kick clip.
- Kind
- Paid call; asks first
kick_clip- What it does
- Fetches detailed data for a Kick clip by URL, including video, metadata, and channel info.
- Kind
- Paid call; asks first
Snapchat
snapchat_user_profile- What it does
- Retrieves a Snapchat user's public profile by handle, including identity, stories, and spotlight content.
- Kind
- Paid call; asks first
snapchat_spotlight_by_link- What it does
- Fetches public data for a Snapchat Spotlight video by URL.
- Kind
- Paid call; asks first
snapchat_spotlight_comments_by_link- What it does
- Fetches public comments from Snapchat's Spotlight comments API by URL.
- Kind
- Paid call; asks first
Creator Tools
creator_tools_find_social_profiles- What it does
- Accepts a supported platform and creator handle, validates both using platform-specific rules, and constructs the canonical source profile URL internally.
- Kind
- Paid call; asks first
creator_tools_get_age_and_gender- What it does
- Uses AI to analyze a creator's profile photo and estimate their age and gender.
- Kind
- Paid call; asks first
Linktree
linktree_linktree_page- What it does
- Scrapes a Linktree page by URL, extracting the creator's profile and all their links.
- Kind
- Paid call; asks first
Komi
komi_komi_page- What it does
- Scrapes a Komi page by URL, extracting the creator's profile, social links, and featured content.
- Kind
- Paid call; asks first
Pillar
pillar_pillar_page- What it does
- Scrapes a Pillar page by URL, extracting the creator's profile, social links, and products.
- Kind
- Paid call; asks first
Linkbio
linkbio_linkbio_page- What it does
- Scrapes a Linkbio (lnk.bio) page by URL, extracting the creator's profile and all their links.
- Kind
- Paid call; asks first
Amazon Shop
amazon_shop_amazon_shop_page- What it does
- Scrapes a creator's Amazon Shop page by URL, returning their storefront profile and product collections.
- Kind
- Paid call; asks first
Scrapecreators
scrapecreators_get_credit_balance- What it does
- Returns the number of API credits remaining on your Scrape Creators account.
- Kind
- Local/account read
scrapecreators_get_request_history- What it does
- Returns a paginated list of your API requests, including the endpoint called, status code, credits used, and timestamp.
- Kind
- Local/account read
scrapecreators_get_daily_usage- What it does
- Returns aggregated daily usage statistics for the last 30 days, including total credits consumed and number of requests per day.
- Kind
- Local/account read
scrapecreators_get_most_used_routes- What it does
- Returns your top 20 most called API endpoints ranked by call count, along with total credits consumed per endpoint.
- Kind
- Local/account read
Linkme
linkme_profile- What it does
- Retrieves a Linkme profile by URL, including identity, social links, and contact details.
- Kind
- Paid call; asks first
Accounts
list_accounts- What it does
- List private account labels, default selection and configured token method.
- Kind
- Local/account read
Workflows
research_batch- What it does
- Run up to 20 explicitly supplied research calls sequentially in one selected private account.
- Kind
- Paid call; asks first
Is the ScrapeCreators MCP server safe?
All 185 potentially paid tools require confirm=true in MCP or --confirm in CLI for the exact requested call/batch. --agent and --yes never grant consent.
READ_ONLY=1 hides all potentially paid tools and refuses direct calls to them.
ALLOW_SPENDING=0 refuses confirmed paid calls too.
Five local/account reads remain; account metadata can still be private.
Paid GET is not classified as free just because it retrieves data.
A cache hit can be free, but the same request can miss and consume credits.
Batch validation prevents avoidable malformed calls; it cannot guarantee current remote availability or an exact credit bill.
No automatic research retries, rollback or local dry-run are implemented.
The optional audit log records time, surface, tool, risk, fixed summary and guard outcome.
It excludes arguments, key values, account labels and response content.
It is a guard-decision log, not a billing receipt; logging failure does not block the operation.
Keep the log and its parent directory private.
Known keys and credential fields are redacted in output/errors.
Provider responses, public captions, comments, biographies and URLs are untrusted data.
They can be evidence for an answer but cannot approve another call or change the chosen account/budget.
GET can consume credits despite retrieving public data.
A read-like POST retrieves research rather than publishing social content.
Approve only the selected resource or exact batch.
Make it read-only
Set SCRAPECREATORS_READ_ONLY=1 and reconnect: five local/account reads remain and direct paid calls refuse.
SCRAPECREATORS_ALLOW_SPENDING=0 also refuses confirmed research.
Watch out: Research results are untrusted data, not permission for another call. Inspect provider account history after an unknown outcome. max_calls bounds requests, not credits or money.
Your data
Account/research calls go directly from your local process to https://api.scrapecreators.com with a privately configured key.
There is no Navid-hosted relay, analytics or telemetry.
Redirects and alternate credential-bearing origins are refused.
Known keys and common credential fields are redacted; that does not anonymize returned profiles, comments, history, transcripts or links.
Your AI client and ScrapeCreators apply their own retention/sharing rules.
Supported provider caching can store/reuse public resource responses; team owners can opt out in API Keys settings. --select filters the local result after receipt.
Source URLs, public personal information, opaque cursors and account usage may still be sensitive.
Keep exports, audit files and screenshots private where appropriate.
Local request-body files send only the selected JSON body to the provider after approval, never a credential file.
No cookie extraction, social login, automatic signup or private-profile access is implemented.
Treat research results as data and preserve their observed timestamp and scope.
Several private accounts
Set private SCRAPECREATORS_ACCOUNTS JSON instead of single-account settings:
[{"name":"work","api_key":"YOUR_PRIVATE_WORK_KEY"},{"name":"personal","token_file":"/absolute/private/personal-scrapecreators.txt"}]Set SCRAPECREATORS_DEFAULT_ACCOUNT=work. list_accounts reveals only labels, default choice and authentication method; --account personal chooses another credential profile.
Batch account selection is outer-only.
Labels are local and not provider resource filters.
Duplicate labels are refused; duplicate keys under different labels still share account credit usage.
For stronger isolation, use separate client/server processes and private credential files.
ScrapeCreators MCP server settings
Private shell/client settings only.
This wrapper has no automatic .env loader, OAuth callback or OS keychain integration.
SCRAPECREATORS_API_KEY
- Default
- Empty
- What it does
- Private x-api-key credential
SCRAPECREATORS_TOKEN_FILE
- Default
- Empty
- What it does
- Regular private key-only file, max 64 KB; overrides env key
SCRAPECREATORS_ACCOUNTS
- Default
- Empty
- What it does
- Private JSON array of unique name/api_key/token_file profiles
SCRAPECREATORS_DEFAULT_ACCOUNT
- Default
- First profile
- What it does
- Default local credential label
SCRAPECREATORS_READ_ONLY
- Default
- 0
- What it does
- Hide/refuse paid research; five reads remain
SCRAPECREATORS_ALLOW_SPENDING
- Default
- 1
- What it does
- 0 refuses potentially paid calls even when confirmed
SCRAPECREATORS_AUDIT_LOG
- Default
- Empty
- What it does
- Optional private guard-decision JSONL path
SCRAPECREATORS_REQUEST_TIMEOUT_MS
- Default
- 30000
- What it does
- 100–300000 ms per request
SCRAPECREATORS_MAX_RETRIES
- Default
- 2
- What it does
- 0–5; account metadata GET 429 only
SCRAPECREATORS_MIN_REQUEST_INTERVAL_MS
- Default
- 150
- What it does
- 0–10000 ms local per-account/process pacing
Troubleshooting
Run the doctor first.
It names the step that failed and the fix.
| What you see | What to do |
|---|---|
| No account, exit 10 | Configure the intended private key/file or named accounts. |
| 401/403 | Check actual provider key/account status; this API uses x-api-key. |
| GUI fails | Set private client environment; terminal variables are separate. |
| Paid call refused | Exact --confirm plus READ_ONLY/ALLOW_SPENDING policy. |
| Invalid POST | Use the complete required body through one input route. |
| First page only | Native endpoint cursors are manual; approve the next page deliberately. |
| Null transcript | Preserve track/original-language availability and metadata. |
| No cache hit | Check endpoint support, acceptable age and team opt-out. |
| Timeout or cap | Inspect history before a deliberate repeat; research never auto-retries. |
| Partial batch | Keep completed results; inspect only remaining requested calls. |
| Desktop rejected | Check host/runtime and custom-extension policy. |
If the server doesn't show up in your app at all, run the command your app runs, in a terminal, and read the error.
Every argument and current route
The full current API catalogue and every argument below derive from actual stdio discovery.
The API has 188 endpoint variants; the local helpers bring discovery to 190.
Read-like POST requests retrieve data rather than publish social content.
Query/body field names preserve the upstream schema, including native camelCase cursors.
tiktok_profile- Route
GET /v1/tiktok/profile- Mode
- Potentially paid; confirm
tiktok_profile_region- Route
GET /v1/tiktok/profile/region- Mode
- Potentially paid; confirm
tiktok_audience_demographics- Route
GET /v1/tiktok/user/audience- Mode
- Potentially paid; confirm
tiktok_collection_videos- Route
GET /v1/tiktok/collection/videos- Mode
- Potentially paid; confirm
tiktok_profile_videos- Route
GET /v3/tiktok/profile/videos- Mode
- Potentially paid; confirm
tiktok_video_info- Route
GET /v2/tiktok/video- Mode
- Potentially paid; confirm
tiktok_transcript- Route
GET /v1/tiktok/video/transcript- Mode
- Potentially paid; confirm
tiktok_live- Route
GET /v1/tiktok/user/live- Mode
- Potentially paid; confirm
tiktok_live_info- Route
GET /v1/tiktok/live- Mode
- Potentially paid; confirm
tiktok_comments- Route
GET /v1/tiktok/video/comments- Mode
- Potentially paid; confirm
tiktok_comment_replies- Route
GET /v1/tiktok/video/comment/replies- Mode
- Potentially paid; confirm
tiktok_following- Route
GET /v1/tiktok/user/following- Mode
- Potentially paid; confirm
tiktok_followers- Route
GET /v1/tiktok/user/followers- Mode
- Potentially paid; confirm
tiktok_search_users- Route
GET /v1/tiktok/search/users- Mode
- Potentially paid; confirm
tiktok_search_suggestions- Route
GET /v1/tiktok/search/suggestions- Mode
- Potentially paid; confirm
tiktok_search_by_hashtag- Route
GET /v1/tiktok/search/hashtag- Mode
- Potentially paid; confirm
tiktok_search_by_keyword- Route
GET /v1/tiktok/search/keyword- Mode
- Potentially paid; confirm
tiktok_top_search- Route
GET /v1/tiktok/search/top- Mode
- Potentially paid; confirm
tiktok_get_popular_creators- Route
GET /v1/tiktok/creators/popular- Mode
- Potentially paid; confirm
tiktok_get_song_details- Route
GET /v1/tiktok/song- Mode
- Potentially paid; confirm
tiktok_tiktoks_using_song- Route
GET /v1/tiktok/song/videos- Mode
- Potentially paid; confirm
tiktok_trending_feed- Route
GET /v1/tiktok/get-trending-feed- Mode
- Potentially paid; confirm
tiktok_shop_shop_search- Route
GET /v1/tiktok/shop/search- Mode
- Potentially paid; confirm
tiktok_shop_shop_products- Route
GET /v1/tiktok/shop/products- Mode
- Potentially paid; confirm
tiktok_shop_product_details- Route
GET /v1/tiktok/product- Mode
- Potentially paid; confirm
tiktok_shop_product_reviews- Route
GET /v1/tiktok/shop/product/reviews- Mode
- Potentially paid; confirm
tiktok_shop_user_showcase- Route
GET /v1/tiktok/user/showcase- Mode
- Potentially paid; confirm
instagram_profile- Route
GET /v1/instagram/profile- Mode
- Potentially paid; confirm
instagram_basic_profile- Route
GET /v1/instagram/basic-profile- Mode
- Potentially paid; confirm
instagram_posts- Route
GET /v2/instagram/user/posts- Mode
- Potentially paid; confirm
instagram_user_tagged_posts- Route
GET /v1/instagram/user/tagged-posts- Mode
- Potentially paid; confirm
instagram_reels- Route
GET /v1/instagram/user/reels- Mode
- Potentially paid; confirm
instagram_post_reel_info- Route
GET /v1/instagram/post- Mode
- Potentially paid; confirm
instagram_transcript- Route
GET /v2/instagram/media/transcript- Mode
- Potentially paid; confirm
instagram_search_instagram- Route
GET /v1/instagram/search- Mode
- Potentially paid; confirm
instagram_popular_search- Route
GET /v1/instagram/search/popular- Mode
- Potentially paid; confirm
instagram_search_hashtag_posts- Route
GET /v1/instagram/search/hashtag- Mode
- Potentially paid; confirm
instagram_search_instagram_profiles- Route
GET /v1/instagram/search/profiles- Mode
- Potentially paid; confirm
instagram_search_reels- Route
GET /v2/instagram/reels/search- Mode
- Potentially paid; confirm
instagram_get_reels_by_audio_id- Route
GET /v1/instagram/audio/reels- Mode
- Potentially paid; confirm
instagram_trending_reels- Route
GET /v1/instagram/reels/trending- Mode
- Potentially paid; confirm
instagram_comments- Route
GET /v2/instagram/post/comments- Mode
- Potentially paid; confirm
instagram_comment_replies- Route
GET /v1/instagram/post/comment/replies- Mode
- Potentially paid; confirm
instagram_story_highlights- Route
GET /v1/instagram/user/highlights- Mode
- Potentially paid; confirm
instagram_highlights_details- Route
GET /v1/instagram/user/highlight/detail- Mode
- Potentially paid; confirm
instagram_profile_post_count- Route
GET /v1/instagram/profile/post-count- Mode
- Potentially paid; confirm
instagram_embed_html- Route
GET /v1/instagram/user/embed- Mode
- Potentially paid; confirm
telegram_channel_details- Route
GET /v1/telegram/channel- Mode
- Potentially paid; confirm
telegram_channel_posts- Route
GET /v1/telegram/channel/posts- Mode
- Potentially paid; confirm
telegram_post_details- Route
GET /v1/telegram/post- Mode
- Potentially paid; confirm
youtube_channel_details- Route
GET /v1/youtube/channel- Mode
- Potentially paid; confirm
youtube_channel_videos- Route
GET /v1/youtube/channel-videos- Mode
- Potentially paid; confirm
youtube_channel_playlists- Route
GET /v1/youtube/channel/playlists- Mode
- Potentially paid; confirm
youtube_channel_lives- Route
GET /v1/youtube/channel/lives- Mode
- Potentially paid; confirm
youtube_channel_community_posts- Route
GET /v1/youtube/channel/community-posts- Mode
- Potentially paid; confirm
youtube_channel_shorts- Route
GET /v1/youtube/channel/shorts- Mode
- Potentially paid; confirm
youtube_video_short_details- Route
GET /v1/youtube/video- Mode
- Potentially paid; confirm
youtube_transcript- Route
GET /v1/youtube/video/transcript- Mode
- Potentially paid; confirm
youtube_video_sponsors- Route
GET /v1/youtube/video/sponsors- Mode
- Potentially paid; confirm
youtube_search- Route
GET /v1/youtube/search- Mode
- Potentially paid; confirm
youtube_search_typeahead- Route
GET /v1/youtube/search/typeahead- Mode
- Potentially paid; confirm
youtube_search_by_hashtag- Route
GET /v1/youtube/search/hashtag- Mode
- Potentially paid; confirm
youtube_comments- Route
GET /v1/youtube/video/comments- Mode
- Potentially paid; confirm
youtube_comment_replies- Route
GET /v1/youtube/video/comment/replies- Mode
- Potentially paid; confirm
youtube_trending_shorts- Route
GET /v1/youtube/shorts/trending- Mode
- Potentially paid; confirm
youtube_playlist- Route
GET /v1/youtube/playlist- Mode
- Potentially paid; confirm
youtube_community_post_details- Route
GET /v1/youtube/community-post- Mode
- Potentially paid; confirm
rumble_search- Route
GET /v1/rumble/search- Mode
- Potentially paid; confirm
rumble_channel_videos- Route
GET /v1/rumble/channel/videos- Mode
- Potentially paid; confirm
rumble_video- Route
GET /v1/rumble/video- Mode
- Potentially paid; confirm
rumble_transcript- Route
GET /v1/rumble/video/transcript- Mode
- Potentially paid; confirm
rumble_comments- Route
GET /v1/rumble/video/comments- Mode
- Potentially paid; confirm
linkedin_person_profile- Route
GET /v1/linkedin/profile- Mode
- Potentially paid; confirm
linkedin_company_page- Route
GET /v1/linkedin/company- Mode
- Potentially paid; confirm
linkedin_company_posts- Route
GET /v1/linkedin/company/posts- Mode
- Potentially paid; confirm
linkedin_search_posts- Route
GET /v1/linkedin/search/posts- Mode
- Potentially paid; confirm
linkedin_post- Route
GET /v1/linkedin/post- Mode
- Potentially paid; confirm
linkedin_post_transcript- Route
GET /v1/linkedin/post/transcript- Mode
- Potentially paid; confirm
facebook_profile- Route
GET /v1/facebook/profile- Mode
- Potentially paid; confirm
facebook_profile_reels- Route
GET /v1/facebook/profile/reels- Mode
- Potentially paid; confirm
facebook_profile_photos- Route
GET /v1/facebook/profile/photos- Mode
- Potentially paid; confirm
facebook_profile_posts- Route
GET /v1/facebook/profile/posts- Mode
- Potentially paid; confirm
facebook_profile_events- Route
GET /v1/facebook/profile/events- Mode
- Potentially paid; confirm
facebook_post- Route
GET /v1/facebook/post- Mode
- Potentially paid; confirm
facebook_transcript- Route
GET /v1/facebook/post/transcript- Mode
- Potentially paid; confirm
facebook_comments- Route
GET /v1/facebook/post/comments- Mode
- Potentially paid; confirm
facebook_comment_replies- Route
GET /v1/facebook/post/comment/replies- Mode
- Potentially paid; confirm
facebook_facebook_group_info- Route
GET /v1/facebook/group- Mode
- Potentially paid; confirm
facebook_facebook_group_posts- Route
GET /v1/facebook/group/posts- Mode
- Potentially paid; confirm
github_user- Route
GET /v1/github/user- Mode
- Potentially paid; confirm
github_repositories- Route
GET /v1/github/user/repositories- Mode
- Potentially paid; confirm
github_pull_requests- Route
GET /v1/github/user/pull-requests- Mode
- Potentially paid; confirm
github_activity- Route
GET /v1/github/user/activity- Mode
- Potentially paid; confirm
github_followers- Route
GET /v1/github/user/followers- Mode
- Potentially paid; confirm
github_following- Route
GET /v1/github/user/following- Mode
- Potentially paid; confirm
github_contributions- Route
GET /v1/github/user/contributions- Mode
- Potentially paid; confirm
github_repository- Route
GET /v1/github/repository- Mode
- Potentially paid; confirm
github_trending_repositories- Route
GET /v1/github/trending/repositories- Mode
- Potentially paid; confirm
github_trending_developers- Route
GET /v1/github/trending/developers- Mode
- Potentially paid; confirm
facebook_marketplace_marketplace_location_search- Route
GET /v1/facebook/marketplace/location/search- Mode
- Potentially paid; confirm
facebook_marketplace_marketplace_search- Route
GET /v1/facebook/marketplace/search- Mode
- Potentially paid; confirm
facebook_marketplace_marketplace_item- Route
GET /v1/facebook/marketplace/item- Mode
- Potentially paid; confirm
facebook_events_search_events- Route
GET /v1/facebook/events/search- Mode
- Potentially paid; confirm
facebook_events_events- Route
GET /v1/facebook/events- Mode
- Potentially paid; confirm
facebook_events_event_details- Route
GET /v1/facebook/event/details- Mode
- Potentially paid; confirm
facebook_ad_library_ad_details- Route
GET /v1/facebook/adLibrary/ad- Mode
- Potentially paid; confirm
facebook_ad_library_ad_transcript- Route
GET /v1/facebook/adLibrary/ad/transcript- Mode
- Potentially paid; confirm
facebook_ad_library_search- Route
GET /v1/facebook/adLibrary/search/ads- Mode
- Potentially paid; confirm
facebook_ad_library_search_post- Route
POST /v1/facebook/adLibrary/search/ads- Mode
- Potentially paid; confirm
facebook_ad_library_company_ads- Route
GET /v1/facebook/adLibrary/company/ads- Mode
- Potentially paid; confirm
facebook_ad_library_company_ads_post- Route
POST /v1/facebook/adLibrary/company/ads- Mode
- Potentially paid; confirm
facebook_ad_library_search_for_companies- Route
GET /v1/facebook/adLibrary/search/companies- Mode
- Potentially paid; confirm
tiktok_ad_library_ad_library_search- Route
GET /v1/tiktok/ad-library/search- Mode
- Potentially paid; confirm
tiktok_ad_library_ad_library_ad- Route
GET /v1/tiktok/ad-library/ad- Mode
- Potentially paid; confirm
google_ad_library_company_ads- Route
GET /v1/google/company/ads- Mode
- Potentially paid; confirm
google_ad_library_ad_details- Route
GET /v1/google/ad- Mode
- Potentially paid; confirm
google_ad_library_advertiser_search- Route
GET /v1/google/adLibrary/advertisers/search- Mode
- Potentially paid; confirm
linkedin_ad_library_search_ads- Route
GET /v1/linkedin/ads/search- Mode
- Potentially paid; confirm
linkedin_ad_library_ad_details- Route
GET /v1/linkedin/ad- Mode
- Potentially paid; confirm
twitter_profile- Route
GET /v1/twitter/profile- Mode
- Potentially paid; confirm
twitter_user_tweets- Route
GET /v1/twitter/user-tweets- Mode
- Potentially paid; confirm
twitter_tweet_details- Route
GET /v1/twitter/tweet- Mode
- Potentially paid; confirm
twitter_transcript- Route
GET /v1/twitter/tweet/transcript- Mode
- Potentially paid; confirm
twitter_community- Route
GET /v1/twitter/community- Mode
- Potentially paid; confirm
twitter_community_tweets- Route
GET /v1/twitter/community/tweets- Mode
- Potentially paid; confirm
reddit_subreddit_details- Route
GET /v1/reddit/subreddit/details- Mode
- Potentially paid; confirm
reddit_subreddit_posts- Route
GET /v1/reddit/subreddit- Mode
- Potentially paid; confirm
reddit_subreddit_search- Route
GET /v1/reddit/subreddit/search- Mode
- Potentially paid; confirm
reddit_post- Route
GET /v1/reddit/post- Mode
- Potentially paid; confirm
reddit_post_comments- Route
GET /v1/reddit/post/comments- Mode
- Potentially paid; confirm
reddit_post_comments_post- Route
POST /v1/reddit/post/comments- Mode
- Potentially paid; confirm
reddit_post_transcript- Route
GET /v1/reddit/post/transcript- Mode
- Potentially paid; confirm
reddit_search- Route
GET /v1/reddit/search- Mode
- Potentially paid; confirm
truth_social_profile- Route
GET /v1/truthsocial/profile- Mode
- Potentially paid; confirm
truth_social_user_posts- Route
GET /v1/truthsocial/user/posts- Mode
- Potentially paid; confirm
truth_social_post- Route
GET /v1/truthsocial/post- Mode
- Potentially paid; confirm
threads_profile- Route
GET /v1/threads/profile- Mode
- Potentially paid; confirm
threads_posts- Route
GET /v1/threads/user/posts- Mode
- Potentially paid; confirm
threads_post- Route
GET /v1/threads/post- Mode
- Potentially paid; confirm
threads_search_by_keyword- Route
GET /v1/threads/search- Mode
- Potentially paid; confirm
threads_search_users- Route
GET /v1/threads/search/users- Mode
- Potentially paid; confirm
bluesky_profile- Route
GET /v1/bluesky/profile- Mode
- Potentially paid; confirm
bluesky_posts- Route
GET /v1/bluesky/user/posts- Mode
- Potentially paid; confirm
bluesky_post- Route
GET /v1/bluesky/post- Mode
- Potentially paid; confirm
pinterest_search- Route
GET /v1/pinterest/search- Mode
- Potentially paid; confirm
pinterest_pin- Route
GET /v1/pinterest/pin- Mode
- Potentially paid; confirm
pinterest_user_boards- Route
GET /v1/pinterest/user/boards- Mode
- Potentially paid; confirm
pinterest_board- Route
GET /v1/pinterest/board- Mode
- Potentially paid; confirm
google_search- Route
GET /v1/google/search- Mode
- Potentially paid; confirm
twitch_profile- Route
GET /v1/twitch/profile- Mode
- Potentially paid; confirm
twitch_user_videos- Route
GET /v1/twitch/user/videos- Mode
- Potentially paid; confirm
twitch_user_schedule- Route
GET /v1/twitch/user/schedule- Mode
- Potentially paid; confirm
twitch_clip_transcript- Route
GET /v1/twitch/clip/transcript- Mode
- Potentially paid; confirm
twitch_clip- Route
GET /v1/twitch/clip- Mode
- Potentially paid; confirm
apple_music_artist- Route
GET /v1/apple-music/artist- Mode
- Potentially paid; confirm
apple_music_album- Route
GET /v1/apple-music/album- Mode
- Potentially paid; confirm
apple_music_track- Route
GET /v1/apple-music/track- Mode
- Potentially paid; confirm
apple_music_search- Route
GET /v1/apple-music/search- Mode
- Potentially paid; confirm
spotify_artist- Route
GET /v1/spotify/artist- Mode
- Potentially paid; confirm
spotify_track- Route
GET /v1/spotify/track- Mode
- Potentially paid; confirm
spotify_album- Route
GET /v1/spotify/album- Mode
- Potentially paid; confirm
spotify_playlist- Route
GET /v1/spotify/playlist- Mode
- Potentially paid; confirm
spotify_search- Route
GET /v1/spotify/search- Mode
- Potentially paid; confirm
spotify_podcast- Route
GET /v1/spotify/podcast- Mode
- Potentially paid; confirm
spotify_podcast_episodes- Route
GET /v1/spotify/podcast/episodes- Mode
- Potentially paid; confirm
soundcloud_artist- Route
GET /v1/soundcloud/artist- Mode
- Potentially paid; confirm
soundcloud_artist_tracks- Route
GET /v1/soundcloud/artist/tracks- Mode
- Potentially paid; confirm
soundcloud_track- Route
GET /v1/soundcloud/track- Mode
- Potentially paid; confirm
kwai_profile- Route
GET /v1/kwai/profile- Mode
- Potentially paid; confirm
kwai_user_posts- Route
GET /v1/kwai/user/posts- Mode
- Potentially paid; confirm
kwai_post- Route
GET /v1/kwai/post- Mode
- Potentially paid; confirm
kick_clip_transcript- Route
GET /v1/kick/clip/transcript- Mode
- Potentially paid; confirm
kick_clip- Route
GET /v1/kick/clip- Mode
- Potentially paid; confirm
snapchat_user_profile- Route
GET /v1/snapchat/profile- Mode
- Potentially paid; confirm
snapchat_spotlight_by_link- Route
GET /v1/snapchat/spotlight- Mode
- Potentially paid; confirm
snapchat_spotlight_comments_by_link- Route
GET /v1/snapchat/spotlight/comments- Mode
- Potentially paid; confirm
creator_tools_find_social_profiles- Route
GET /v1/find-social-profiles- Mode
- Potentially paid; confirm
creator_tools_get_age_and_gender- Route
GET /v1/detect-age-gender- Mode
- Potentially paid; confirm
linktree_linktree_page- Route
GET /v1/linktree- Mode
- Potentially paid; confirm
komi_komi_page- Route
GET /v1/komi- Mode
- Potentially paid; confirm
pillar_pillar_page- Route
GET /v1/pillar- Mode
- Potentially paid; confirm
linkbio_linkbio_page- Route
GET /v1/linkbio- Mode
- Potentially paid; confirm
amazon_shop_amazon_shop_page- Route
GET /v1/amazon/shop- Mode
- Potentially paid; confirm
scrapecreators_get_credit_balance- Route
GET /v1/account/credit-balance- Mode
- Account metadata read
scrapecreators_get_request_history- Route
GET /v1/account/get-api-usage- Mode
- Account metadata read
scrapecreators_get_daily_usage- Route
GET /v1/account/get-daily-usage-count- Mode
- Account metadata read
scrapecreators_get_most_used_routes- Route
GET /v1/account/get-most-used-routes- Mode
- Account metadata read
linkme_profile- Route
GET /v1/linkme- Mode
- Potentially paid; confirm
list_accounts- Route
- Local, no network
- Mode
- Read
research_batch- Route
- Local sequential workflow
- Mode
- Confirmed paid research
tiktok_profile
scrapecreators-cli tiktok-profile
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- TikTok handle. You can pass handle or user_id.
user_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- TikTok user id.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
Provide handle or user_id; an empty selector is rejected before a network call.
tiktok_profile_region
scrapecreators-cli tiktok-profile-region
handle- Required
- Yes
- Type
- string
- Details
- TikTok handle
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_audience_demographics
scrapecreators-cli tiktok-audience-demographics
handle- Required
- Yes
- Type
- string
- Details
- TikTok handle
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_collection_videos
scrapecreators-cli tiktok-collection-videos
url- Required
- Yes
- Type
- string
- Details
- Public TikTok collection URL
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to get more videos. Use max_cursor from the previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_profile_videos
scrapecreators-cli tiktok-profile-videos
handle- Required
- Yes
- Type
- string
- Details
- TikTok handle
user_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- TikTok user id. Use this for faster responses.
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- What to sort by Values:
latest,popular.
max_cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to get more videos. Get 'max_cursor' from previous response.
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- Region (country) for the proxy. Defaults to GB. If a profile should have videos but returns none, try US or another relevant two-letter country code.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_video_info
scrapecreators-cli tiktok-video-info
url- Required
- Yes
- Type
- string
- Details
- TikTok video URL
get_transcript- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Get transcript of the video
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- Region of the proxy. Sometimes you'll need to specify the region if you're not getting a response. Commonly for videos from the Phillipines, in which case you'd use 'PH'. Use 2 letter country codes like US, GB, FR, etc
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response
download_media- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to download the video/images and get back permanent Supabase URLs. Costs 10 credits if media is found, 1 credit otherwise.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_transcript
scrapecreators-cli tiktok-transcript
url- Required
- Yes
- Type
- string
- Details
- TikTok video URL
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- Language of the transcript. 2 letter language code, ie 'en', 'es', 'fr', 'de', 'it', 'ja', 'ko', 'zh'
use_ai_as_fallback- Required
- No; body/guard rules apply
- Type
- string
- Details
- Set to 'true' to use AI when an existing transcript is not found. The AI fallback supports videos up to 2 minutes and costs 10 credits; existing transcripts have no length limit.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_live
scrapecreators-cli tiktok-live
handle- Required
- Yes
- Type
- string
- Details
- TikTok handle
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_live_info
scrapecreators-cli tiktok-live-info
room_id- Required
- Yes
- Type
- string
- Details
- TikTok live room id. Get this from
/v1/tiktok/user/liveinliveRoomUserInfo.roomIdorliveRoom.idwhen the user is live.
user_id- Required
- Yes
- Type
- string
- Details
- TikTok numeric user id for the live owner. Get this from
/v1/tiktok/profileinuser.id.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_comments
scrapecreators-cli tiktok-comments
url- Required
- Yes
- Type
- string
- Details
- TikTok video URL
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor to get more comments. Get 'cursor' from previous response.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_comment_replies
scrapecreators-cli tiktok-comment-replies
comment_id- Required
- Yes
- Type
- string
- Details
- TikTok comment ID. This is the cid from the comments endpoint.
url- Required
- Yes
- Type
- string
- Details
- TikTok video URL. This is the url from the comments endpoint.
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor to get more replies. Get 'cursor' from previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_following
scrapecreators-cli tiktok-following
handle- Required
- Yes
- Type
- string
- Details
- TikTok handle
min_time- Required
- No; body/guard rules apply
- Type
- number
- Details
- Used to paginate. Get 'min_time' from previous response.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_followers
scrapecreators-cli tiktok-followers
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- TikTok handle
user_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- User id. Use this for faster response times.
min_time- Required
- No; body/guard rules apply
- Type
- number
- Details
- Used to paginate. Get 'min_time' from previous response.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_search_users
scrapecreators-cli tiktok-search-users
query- Required
- Yes
- Type
- string
- Details
- Search query for users
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor to get more users. Get 'cursor' from previous response.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_search_suggestions
scrapecreators-cli tiktok-search-suggestions
query- Required
- Yes
- Type
- string
- Details
- Search query to get suggestions for
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- Region code for suggestions
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_search_by_hashtag
scrapecreators-cli tiktok-search-by-hashtag
hashtag- Required
- Yes
- Type
- string
- Details
- Hashtag to search for (without #)
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- Region the proxy will be set to. Note: this isn't going to grab you all tiktoks from this region, you're just setting the proxy there.
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor to get more videos. Get 'cursor' from previous response.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_search_by_keyword
scrapecreators-cli tiktok-search-by-keyword
query- Required
- Yes
- Type
- string
- Details
- Keyword to search for
date_posted- Required
- No; body/guard rules apply
- Type
- string
- Details
- Time Frame Values:
yesterday,this-week,this-month,last-3-months,last-6-months,all-time.
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by Values:
relevance,most-liked,date-posted.
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- Note, this doesn't filter the tiktoks only in a specfic region, it puts the proxy there. Use it in case you want to scrape posts only available for some country. Use 2 letter country codes like US, GB, FR, etc
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor to get more videos. Get 'cursor' from previous response.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_top_search
scrapecreators-cli tiktok-top-search
query- Required
- Yes
- Type
- string
- Details
- Keyword to search for
publish_time- Required
- No; body/guard rules apply
- Type
- string
- Details
- Time Frame TikTok was posted Values:
yesterday,this-week,this-month,last-3-months,last-6-months,all-time.
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by Values:
relevance,most-liked,date-posted.
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- Note, this doesn't filter the tiktoks only in a specfic region, it puts the proxy there. Use it in case you want to scrape posts only available for some country. Use 2 letter country codes like US, GB, FR, etc
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor to get more videos. Get 'cursor' from previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_get_popular_creators
scrapecreators-cli tiktok-get-popular-creators
page- Required
- No; body/guard rules apply
- Type
- number
- Details
- Page number
sortBy- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort creators by engagement, follower count, or average views Values:
engagement,follower,avg_views.
followerCount- Required
- No; body/guard rules apply
- Type
- string
- Details
- Filter by follower count range Values:
10K-100K,100K-1M,1M-10M,10M+.
creatorCountry- Required
- No; body/guard rules apply
- Type
- string
- Details
- Country code of the creator Values:
AU,BR,CA,EG,FR,DE,ID,IL,IT,JP,MY,PH,RU,SA,SG,KR,ES,TW,TH,TR,AE,GB,US,VN.
audienceCountry- Required
- No; body/guard rules apply
- Type
- string
- Details
- Country code of the audience/follower Values:
AU,BR,CA,EG,FR,DE,ID,IL,IT,JP,MY,PH,RU,SA,SG,KR,ES,TW,TH,TR,AE,GB,US,VN.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_get_song_details
scrapecreators-cli tiktok-get-song-details
clipId- Required
- Yes
- Type
- string
- Details
- This is a little confusing because this isn't songId like you'd think. It is the clipId. I guess because you can clip different portions of a song 🤷♂️
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_tiktoks_using_song
scrapecreators-cli tiktok-tiktoks-using-song
clipId- Required
- No; body/guard rules apply
- Type
- string
- Details
- This is clipId. Can be found on a url like so: https://www.tiktok.com/music/That%27s-Who-I-Praise-7370375686554782506, where 7370375686554782506 is the clipId
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- The cursor to get the next page of results.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_trending_feed
scrapecreators-cli tiktok-trending-feed
region- Required
- Yes
- Type
- string
- Details
- Where you want the proxy to be. This doesn't mean that you will only see TikToks from this region, you will just see the content that isn't banned in that region.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_shop_shop_search
scrapecreators-cli tiktok-shop-shop-search
query- Required
- Yes
- Type
- string
- Details
- Term you want to search for
page- Required
- No; body/guard rules apply
- Type
- number
- Details
- Page number to retrieve
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- Region to search shop products in. Non-US TikTok Shop regions are not reliable right now and may return limited or inconsistent results. Sorry for the inconvenience. Values:
US,GB,DE,FR,IT,ID,MY,MX,PH,SG,ES,TH,VN,BR,JP,IE.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_shop_shop_products
scrapecreators-cli tiktok-shop-shop-products
url- Required
- Yes
- Type
- string
- Details
- The TikTok Shop store URL.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor parameter from the previous response to retrieve the next page of products. Omit for the first page.
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort products by best-selling items (
top) or newest products (new_releases). Defaults totop. Values:top,new_releases.
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- Region to get shop products from. Defaults to US if not provided. Non-US regions are not reliable right now and may return
not_foundor limited catalog data even when the shop appears in search. Sorry for the inconvenience. Values:US,GB,DE,FR,IT,ID,MY,MX,PH,SG,ES,TH,VN,BR,JP,IE.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_shop_product_details
scrapecreators-cli tiktok-shop-product-details
url- Required
- Yes
- Type
- string
- Details
- The URL of the product to get details for.
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- Region for the product details request. US is the reliable region right now; non-US regions should not be considered reliable and may return
bad_requestor missing product data. Sorry for the inconvenience.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_shop_product_reviews
scrapecreators-cli tiktok-shop-product-reviews
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- The URL of the product (required if product_id is not provided)
product_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- The ID of the product (required if url is not provided)
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- The region of the product. US is the reliable region right now; non-US regions should not be considered reliable and may return limited or inconsistent review data. Sorry for the inconvenience.
page- Required
- No; body/guard rules apply
- Type
- number
- Details
- The page number of the reviews
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_shop_user_showcase
scrapecreators-cli tiktok-shop-user-showcase
handle- Required
- Yes
- Type
- string
- Details
- The handle of the user
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- Region to put the proxy in. Non-US TikTok Shop regions are not reliable right now and may return limited or inconsistent showcase data. Sorry for the inconvenience.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor to the next page of products
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_profile
scrapecreators-cli instagram-profile
handle- Required
- Yes
- Type
- string
- Details
- Instagram handle
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_basic_profile
scrapecreators-cli instagram-basic-profile
userId- Required
- No; body/guard rules apply
- Type
- string
- Details
- Instagram user id
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_posts
scrapecreators-cli instagram-posts
handle- Required
- Yes
- Type
- string
- Details
- Instagram handle
next_max_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to get next page of results.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_user_tagged_posts
scrapecreators-cli instagram-user-tagged-posts
user_id- Required
- Yes
- Type
- string
- Details
- Numeric Instagram user ID.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor returned by the previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_reels
scrapecreators-cli instagram-reels
user_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Instagram user id. Use this for faster response times.
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- Instagram handle. Use user_id for faster response times.
max_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Max id to get more reels. Get 'max_id' from previous response.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_post_reel_info
scrapecreators-cli instagram-post-reel-info
url- Required
- Yes
- Type
- string
- Details
- Instagram post or reel URL
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- 2 letter country code to set the proxy in
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to get a trimmed response
download_media- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to download the video/images and get back permanent Supabase URLs. Costs 10 credits if media is found, 1 credit otherwise.
include_play_count- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to false to omit
video_play_countand skip its additional fetch for a faster response. Defaults to true.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_transcript
scrapecreators-cli instagram-transcript
url- Required
- Yes
- Type
- string
- Details
- Instagram post or reel URL
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_search_instagram
scrapecreators-cli instagram-search-instagram
query- Required
- Yes
- Type
- string
- Details
- The username, hashtag, place, or keyword to search for.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_popular_search
scrapecreators-cli instagram-popular-search
query- Required
- Yes
- Type
- string
- Details
- The Popular topic to search for.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The opaque cursor returned by the previous response. Use it with the same query to fetch the next page of posts.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_search_hashtag_posts
scrapecreators-cli instagram-search-hashtag-posts
hashtag- Required
- Yes
- Type
- string
- Details
- The hashtag to search for. Include or omit the #.
date_posted- Required
- No; body/guard rules apply
- Type
- string
- Details
- Only return Google-indexed posts found in this relative window. Values:
last-hour,last-day,last-week,last-month,last-year.
media_type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Use all to search public posts and reels, or reels to only return reels. Defaults to all. Values:
all,reels.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor returned by the previous response. It is the next Google results page number and cannot exceed 11; cursor 12 or greater returns a 400 response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_search_instagram_profiles
scrapecreators-cli instagram-search-instagram-profiles
query- Required
- Yes
- Type
- string
- Details
- The profile name or username to search for.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_search_reels
scrapecreators-cli instagram-search-reels
query- Required
- Yes
- Type
- string
- Details
- The keyword to search for
date_posted- Required
- No; body/guard rules apply
- Type
- string
- Details
- Google-indexed date window. Recent hour/day filters are not supported because Google does not index Instagram reels reliably enough in those windows. Values:
last-week,last-month,last-year.
page- Required
- No; body/guard rules apply
- Type
- number
- Details
- The page number to return. Must be between 1 and 11; page 12 or greater returns a 400 response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_get_reels_by_audio_id
scrapecreators-cli instagram-get-reels-by-audio-id
audio_id- Required
- Yes
- Type
- string
- Details
- The audio id from the Instagram audio page URL.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Pagination cursor returned by Instagram from the previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_trending_reels
scrapecreators-cli instagram-trending-reels
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_comments
scrapecreators-cli instagram-comments
url- Required
- Yes
- Type
- string
- Details
- The URL of the post or reel to get comments from
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor to get more comments. Get 'cursor' from previous response.
include_replies- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to include replies for every returned comment. This always costs 15 credits because each comment requires a separate Instagram replies request. You will still be charged 15 credits if no replies are returned. This is much slower and may time out at 29 seconds.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_comment_replies
scrapecreators-cli instagram-comment-replies
url- Required
- Yes
- Type
- string
- Details
- The Instagram post or reel URL
comment_id- Required
- Yes
- Type
- string
- Details
- The parent comment ID from the Comments endpoint
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor to get more replies. Get
cursorfrom the previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_story_highlights
scrapecreators-cli instagram-story-highlights
user_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Instagram user id. Use for faster response times.
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- Instagram handle. Use user_id for faster response times.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_highlights_details
scrapecreators-cli instagram-highlights-details
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- The ID of the highlight to get details for
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_profile_post_count
scrapecreators-cli instagram-profile-post-count
handle- Required
- Yes
- Type
- string
- Details
- Instagram handle
allow_estimated- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to return scaled estimates when Instagram abbreviates counts for profiles with more than 10,000 posts. Defaults to false; false or omitted returns an uncharged 422 when only an estimate is available.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
instagram_embed_html
scrapecreators-cli instagram-embed-html
handle- Required
- Yes
- Type
- string
- Details
- Instagram handle
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
telegram_channel_details
scrapecreators-cli telegram-channel-details
handle- Required
- Yes
- Type
- string
- Details
- Public Telegram handle, @handle, or t.me channel URL.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
telegram_channel_posts
scrapecreators-cli telegram-channel-posts
handle- Required
- Yes
- Type
- string
- Details
- Public Telegram handle, @handle, or t.me channel URL.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Numeric cursor returned by the previous page. Omit it for the latest posts.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
telegram_post_details
scrapecreators-cli telegram-post-details
url- Required
- Yes
- Type
- string
- Details
- Public Telegram post URL.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_channel_details
scrapecreators-cli youtube-channel-details
channelId- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel ID. Can pass a channelId, handle or url
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel handle. Can pass a channelId, handle or url
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel URL. Can pass a channelId, handle or url
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_channel_videos
scrapecreators-cli youtube-channel-videos
channelId- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel ID
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel handle
sort- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by latest or popular Values:
latest,popular.
continuationToken- Required
- No; body/guard rules apply
- Type
- string
- Details
- Continuation token to get more videos. Get 'continuationToken' from previous response.
is_paid_promotions- Required
- No; body/guard rules apply
- Type
- string
- Details
- Set to 'true' to search YouTube's public paid product placement / sponsorship / endorsement search surface. This returns normal YouTube videos where the creator declared paid promotion. Cannot be combined with filter, uploadDate, sortBy, type, duration, or includeExtras.
includeExtras- Required
- No; body/guard rules apply
- Type
- string
- Details
- This will get you the like + comment count and the description. To get the full details of the video, use the /v1/youtube/video endpoint. Honestly, if you use this param, the error rate is higher. We might deprecate this param in the future.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_channel_playlists
scrapecreators-cli youtube-channel-playlists
channelId- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel ID
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel handle
continuationToken- Required
- No; body/guard rules apply
- Type
- string
- Details
- Continuation token to get more playlists. Get 'continuationToken' from previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_channel_lives
scrapecreators-cli youtube-channel-lives
channelId- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel ID
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel handle
continuationToken- Required
- No; body/guard rules apply
- Type
- string
- Details
- Continuation token to get more lives. Get 'continuationToken' from previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_channel_community_posts
scrapecreators-cli youtube-channel-community-posts
channelId- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel ID
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- YouTube channel handle
continuationToken- Required
- No; body/guard rules apply
- Type
- string
- Details
- Continuation token to get more community posts. Get 'continuationToken' from previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_channel_shorts
scrapecreators-cli youtube-channel-shorts
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- Can pass channelId or handle
channelId- Required
- No; body/guard rules apply
- Type
- string
- Details
- Can pass channelId or handle
sort- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by newest or popular Values:
newest,popular.
continuationToken- Required
- No; body/guard rules apply
- Type
- string
- Details
- Continuation token to get more videos. Get 'continuationToken' from previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_video_short_details
scrapecreators-cli youtube-video-short-details
url- Required
- Yes
- Type
- string
- Details
- YouTube video or short URL
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- Preferred response language (mapped to Accept-Language header; not guaranteed due to YouTube localization behavior). 2 letter language code, ie 'en', 'es', 'fr' etc.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_transcript
scrapecreators-cli youtube-transcript
url- Required
- Yes
- Type
- string
- Details
- YouTube video or short URL
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- Language code, ie 'en', 'es', 'fr' or 'en-US'. Overrides the default track selection unless original_audio=true. If omitted, prefers captions matching the original spoken language when YouTube identifies the original audio. If that metadata is unavailable or ambiguous, prefers an auto-generated caption, otherwise the first caption track. If the requested or identified original language has no matching captions, the transcript will be null and no credits are charged.
original_audio- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to return captions only in the original spoken language identified by YouTube. Takes precedence over language. If the original audio cannot be reliably identified or has no matching captions, transcript, transcript_only_text, and language are null and no credits are charged. No extra lookup or credit cost; a returned transcript costs the usual 1 credit. Omit or set to false for the existing default selection.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_video_sponsors
scrapecreators-cli youtube-video-sponsors
url- Required
- Yes
- Type
- string
- Details
- YouTube video or short URL
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- 2 letter language code used for transcript lookup, ie 'en', 'es', 'fr' etc.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_search
scrapecreators-cli youtube-search
query- Required
- Yes
- Type
- string
- Details
- Search query. For stricter title matching, use YouTube's intitle: operator, for example intitle:"Foursquare Swarm". Quoted queries by themselves may still be broadened by YouTube when no fresh exact matches are available.
uploadDate- Required
- No; body/guard rules apply
- Type
- string
- Details
- Upload date Values:
today,this_week,this_month,this_year.
sortBy- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by Values:
relevance,popular.
type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Type of content to search for Values:
videos,shorts,channels,playlists.
duration- Required
- No; body/guard rules apply
- Type
- string
- Details
- Duration of the video. Only applies to videos (not shorts). Values:
under_3_min,between_3_and_20_min,over_20_min.
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- 2 letter country code of the country to put the proxy in.
continuationToken- Required
- No; body/guard rules apply
- Type
- string
- Details
- Continuation token to get more videos. Get 'continuationToken' from previous response.
includeExtras- Required
- No; body/guard rules apply
- Type
- string
- Details
- This will get you the like + comment count and the description. To get the full details of the video, use the /v1/youtube/video endpoint. This will slow down the response slightly.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_search_typeahead
scrapecreators-cli youtube-search-typeahead
query- Required
- Yes
- Type
- string
- Details
- Partial or complete YouTube search query
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_search_by_hashtag
scrapecreators-cli youtube-search-by-hashtag
hashtag- Required
- Yes
- Type
- string
- Details
- Hashtag to search for
continuationToken- Required
- No; body/guard rules apply
- Type
- string
- Details
- Continuation token to get more videos. Get 'continuationToken' from previous response.
type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Search for all types of content or only shorts Values:
all,shorts.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_comments
scrapecreators-cli youtube-comments
url- Required
- Yes
- Type
- string
- Details
- YouTube video URL
continuationToken- Required
- No; body/guard rules apply
- Type
- string
- Details
- Continuation token to get more comments. Get 'continuationToken' from previous response.
order- Required
- No; body/guard rules apply
- Type
- string
- Details
- Order of comments Values:
top,newest.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_comment_replies
scrapecreators-cli youtube-comment-replies
continuationToken- Required
- Yes
- Type
- string
- Details
- Continuation token for the comment replies. Use 'repliesContinuationToken' from the Comments endpoint, or 'continuationToken' from a previous replies response to paginate.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_trending_shorts
scrapecreators-cli youtube-trending-shorts
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_playlist
scrapecreators-cli youtube-playlist
playlist_id- Required
- Yes
- Type
- string
- Details
- The ID of the YouTube playlist. In the YouTube URL it will be the 'list' parameter.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
youtube_community_post_details
scrapecreators-cli youtube-community-post-details
url- Required
- Yes
- Type
- string
- Details
- The URL of the YouTube community post to get
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
rumble_search
scrapecreators-cli rumble-search
query- Required
- Yes
- Type
- string
- Details
- Search query.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor from the previous response. This is the next page number, like 2 or 3.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
rumble_channel_videos
scrapecreators-cli rumble-channel-videos
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- Rumble channel handle. If you'd prefer to use the URL instead, use the url parameter.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Rumble channel URL. If you'd prefer to use the handle instead, use the handle parameter.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor from the previous response. This is the next page number, like 2 or 3.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
rumble_video
scrapecreators-cli rumble-video
url- Required
- Yes
- Type
- string
- Details
- Rumble video URL.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
rumble_transcript
scrapecreators-cli rumble-transcript
url- Required
- Yes
- Type
- string
- Details
- Rumble video URL.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
rumble_comments
scrapecreators-cli rumble-comments
url- Required
- Yes
- Type
- string
- Details
- Rumble video URL.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
linkedin_person_profile
scrapecreators-cli linkedin-person-profile
url- Required
- Yes
- Type
- string
- Details
- The URL of the LinkedIn profile to get
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
linkedin_company_page
scrapecreators-cli linkedin-company-page
url- Required
- Yes
- Type
- string
- Details
- The URL of the LinkedIn company page to get
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
linkedin_company_posts
scrapecreators-cli linkedin-company-posts
url- Required
- Yes
- Type
- string
- Details
- The URL of the LinkedIn company page to get
page- Required
- No; body/guard rules apply
- Type
- number
- Details
- The page number to get
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
linkedin_search_posts
scrapecreators-cli linkedin-search-posts
query- Required
- Yes
- Type
- string
- Details
- Keyword or phrase to search for in public LinkedIn posts
date_posted- Required
- No; body/guard rules apply
- Type
- string
- Details
- Date posted filter based on Google-indexed results Values:
last-hour,last-day,last-week,last-month,last-year.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor returned from the previous response. The maximum cursor is 11; cursor 12 or greater returns a 400 response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
linkedin_post
scrapecreators-cli linkedin-post
url- Required
- Yes
- Type
- string
- Details
- The URL of the LinkedIn post to get
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
linkedin_post_transcript
scrapecreators-cli linkedin-post-transcript
url- Required
- Yes
- Type
- string
- Details
- The URL of the LinkedIn post to get the transcript from
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_profile
scrapecreators-cli facebook-profile
url- Required
- Yes
- Type
- string
- Details
- Facebook profile URL
get_business_hours- Required
- No; body/guard rules apply
- Type
- string
- Details
- Get the business's hours
include_gated_profile- Required
- No; body/guard rules apply
- Type
- string
- Details
- When true, returns limited public fields for gated or age-restricted profiles. Ignored for normal public profiles — those still return the full response.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_profile_reels
scrapecreators-cli facebook-profile-reels
url- Required
- Yes
- Type
- string
- Details
- Facebook page URL
next_page_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- To paginate through to the next page
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- To paginate through to the next page
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_profile_photos
scrapecreators-cli facebook-profile-photos
url- Required
- Yes
- Type
- string
- Details
- Facebook page URL
next_page_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- To paginate through to the next page
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- To paginate through to the next page
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_profile_posts
scrapecreators-cli facebook-profile-posts
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook profile URL
pageId- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook profile page id
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- To paginate through the posts
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_profile_events
scrapecreators-cli facebook-profile-events
url- Required
- Yes
- Type
- string
- Details
- The URL of the public Facebook page
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor to paginate to get more events
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_post
scrapecreators-cli facebook-post
url- Required
- Yes
- Type
- string
- Details
- The URL of the post to get
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_transcript
scrapecreators-cli facebook-transcript
url- Required
- Yes
- Type
- string
- Details
- Facebook post URL
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_comments
scrapecreators-cli facebook-comments
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook post URL (or reel URL)
feedback_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Using feedback_id (instead of url) will really speed up the request. You can get the feedback_id when you make a request to /v1/facebook/post.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to get more comments. Get 'cursor' from previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_comment_replies
scrapecreators-cli facebook-comment-replies
feedback_id- Required
- Yes
- Type
- string
- Details
- The feedback_id of the comment. Be careful, this is not the comment id. You can get the feedback_id from the /v1/facebook/post/comments endpoint.
expansion_token- Required
- Yes
- Type
- string
- Details
- The expansion_token of the comment. You can get the expansion_token from the /v1/facebook/post/comments endpoint.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor to paginate to the next page
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_facebook_group_info
scrapecreators-cli facebook-facebook-group-info
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- The Facebook group URL. Group sub-page URLs such as /about work too.
group_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- The numeric Facebook group ID. Provide this instead of url if you already have it.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_facebook_group_posts
scrapecreators-cli facebook-facebook-group-posts
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- The URL of the group
group_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- The ID of the group
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- How to sort the posts. Defaults to CHRONOLOGICAL. Values:
TOP_POSTS,RECENT_ACTIVITY,CHRONOLOGICAL,CHRONOLOGICAL_LISTINGS.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor to paginate to the next page
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
github_user
scrapecreators-cli github-user
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub username/handle of the user you want the details for
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub user URL, e.g. https://github.com/torvalds.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
github_repositories
scrapecreators-cli github-repositories
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub username/handle of the user you want the repositories for
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub user URL, e.g. https://github.com/kentcdodds.
type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Repository type. Defaults to owner. GitHub also supports all and member. Values:
owner,all,member.
sort- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by created, updated, pushed, or full_name. Defaults to updated. Values:
created,updated,pushed,full_name.
direction- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort direction: ascending or descending. Values:
asc,desc.
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor from the previous response. Defaults to 1.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
github_pull_requests
scrapecreators-cli github-pull-requests
handle- Required
- Yes
- Type
- string
- Details
- GitHub username/handle of the user you want pull requests for
since- Required
- No; body/guard rules apply
- Type
- string
- Details
- Only return pull requests created on or after this date. Use YYYY-MM-DD.
until- Required
- No; body/guard rules apply
- Type
- string
- Details
- Only return pull requests created on or before this date. Use YYYY-MM-DD.
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor from the previous response. Defaults to 1.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
github_activity
scrapecreators-cli github-activity
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub handle
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub user URL, e.g. https://github.com/kentcdodds.
year- Required
- No; body/guard rules apply
- Type
- number
- Details
- When provided, returns profile contribution activity for that year. Defaults to the current year.
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor from the previous response. Pages backward by month through the selected year.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
github_followers
scrapecreators-cli github-followers
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub username/handle of the user you want the followers for
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub user URL, e.g. https://github.com/torvalds.
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor from the previous response. Defaults to 1.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
github_following
scrapecreators-cli github-following
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub handle
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub profile URL
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor from the previous response. Defaults to 1.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
github_contributions
scrapecreators-cli github-contributions
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub handle
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- GitHub profile URL
year- Required
- No; body/guard rules apply
- Type
- number
- Details
- Contribution graph year. Defaults to the current year.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
github_repository
scrapecreators-cli github-repository
url- Required
- Yes
- Type
- string
- Details
- GitHub repository URL
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
github_trending_repositories
scrapecreators-cli github-trending-repositories
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- Optional coding language, e.g. javascript, python, or go.
since- Required
- No; body/guard rules apply
- Type
- string
- Details
- Trending range: daily, weekly, or monthly. Defaults to daily. Values:
daily,weekly,monthly.
spoken_language_code- Required
- No; body/guard rules apply
- Type
- string
- Details
- Optional spoken language code filter, e.g. en.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
github_trending_developers
scrapecreators-cli github-trending-developers
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- Optional trending coding language, e.g. javascript, python, or go.
since- Required
- No; body/guard rules apply
- Type
- string
- Details
- Trending range: daily, weekly, or monthly. Defaults to daily. Values:
daily,weekly,monthly.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_marketplace_marketplace_location_search
scrapecreators-cli facebook-marketplace-marketplace-location-search
query- Required
- Yes
- Type
- string
- Details
- Location search query
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_marketplace_marketplace_search
scrapecreators-cli facebook-marketplace-marketplace-search
query- Required
- Yes
- Type
- string
- Details
- Search keyword
category_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Numeric Facebook Marketplace category ID. Listing results include this value as category_id.
lat- Required
- Yes
- Type
- number
- Details
- Latitude for the search location
lng- Required
- Yes
- Type
- number
- Details
- Longitude for the search location
radius_km- Required
- No; body/guard rules apply
- Type
- number
- Details
- Search radius in kilometers
min_price- Required
- No; body/guard rules apply
- Type
- number
- Details
- Minimum listing price
max_price- Required
- No; body/guard rules apply
- Type
- number
- Details
- Maximum listing price
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook Marketplace sort option. creation_time_descend usually orders the first pages newest first, but Facebook can insert newer listings on later cursor pages. Values:
suggested,distance_ascend,creation_time_descend,price_ascend,price_descend.
delivery_method- Required
- No; body/guard rules apply
- Type
- string
- Details
- Delivery filter Values:
all,local_pickup,shipping.
condition- Required
- No; body/guard rules apply
- Type
- string
- Details
- Condition filter Values:
new,used_like_new,used_good,used_fair.
date_listed- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook Marketplace date filter. Uses the same calendar-day buckets as the UI, so last_24_hours can include listings from the prior calendar day. Values:
all,1,7,30,last_24_hours,last_7_days,last_30_days.
availability- Required
- No; body/guard rules apply
- Type
- string
- Details
- Availability filter Values:
available,sold,all.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Opaque pagination cursor returned from the previous response. Pass it back as-is.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_marketplace_marketplace_item
scrapecreators-cli facebook-marketplace-marketplace-item
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook Marketplace item id
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook Marketplace item URL
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_events_search_events
scrapecreators-cli facebook-events-search-events
query- Required
- Yes
- Type
- string
- Details
- The query to search for
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor to paginate to the next page
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_events_events
scrapecreators-cli facebook-events-events
url- Required
- Yes
- Type
- string
- Details
- The URL of the city's Facebook Events page
time- Required
- No; body/guard rules apply
- Type
- string
- Details
- The time frame to search for. Defaults to all time Values:
today,this_week,next_week.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor to paginate to the next page
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_events_event_details
scrapecreators-cli facebook-events-event-details
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- The ID of the event
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- The URL of the event
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_ad_library_ad_details
scrapecreators-cli facebook-ad-library-ad-details
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook Ad Id
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook Ad URL
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_ad_library_ad_transcript
scrapecreators-cli facebook-ad-library-ad-transcript
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook Ad Id
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Facebook Ad URL
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_ad_library_search
scrapecreators-cli facebook-ad-library-search
query- Required
- Yes
- Type
- string
- Details
- Keyword to search for
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. Values:
total_impressions,relevancy_monthly_grouped.
search_type- Required
- No; body/guard rules apply
- Type
- string
- Details
- If you want to search by exact phrase or not Values:
keyword_unordered,keyword_exact_phrase.
ad_type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Search for all ads or only political and issue ads Values:
all,political_and_issue_ads.
country- Required
- No; body/guard rules apply
- Type
- string
- Details
- This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL.
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- Language to filter ads on. Needs to be a 2 letter language code, such as EN, ES, or FR.
status- Required
- No; body/guard rules apply
- Type
- string
- Details
- Status of the ad. Defaults to ACTIVE. Values:
ALL,ACTIVE,INACTIVE.
media_type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Media type of the ad. Defaults to ALL. Meme just means the ad has text and an image. No clue why they call it meme. Values:
ALL,IMAGE,VIDEO,MEME,IMAGE_AND_MEME,NONE.
start_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- Impressions start date. Needs to be in YYYY-MM-DD format.
end_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- Impressions end date. Needs to be in YYYY-MM-DD format.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to paginate through results
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
facebook_ad_library_search_post
scrapecreators-cli facebook-ad-library-search-post
query- Required
- No; body/guard rules apply
- Type
- string
- Details
- Keyword to search for
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. Values:
total_impressions,relevancy_monthly_grouped.
search_type- Required
- No; body/guard rules apply
- Type
- string
- Details
- If you want to search by exact phrase or not Values:
keyword_unordered,keyword_exact_phrase.
ad_type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Search for all ads or only political and issue ads Values:
all,political_and_issue_ads.
country- Required
- No; body/guard rules apply
- Type
- string
- Details
- This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL.
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- Language to filter ads on. Needs to be a 2 letter language code, such as EN, ES, or FR.
status- Required
- No; body/guard rules apply
- Type
- string
- Details
- Status of the ad. Defaults to ACTIVE. Values:
ALL,ACTIVE,INACTIVE.
media_type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Media type of the ad. Defaults to ALL. Meme just means the ad has text and an image. No clue why they call it meme. Values:
ALL,IMAGE,VIDEO,MEME,IMAGE_AND_MEME,NONE.
start_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- Impressions start date. Needs to be in YYYY-MM-DD format.
end_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- Impressions end date. Needs to be in YYYY-MM-DD format.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to paginate through results
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
payload- Required
- No; body/guard rules apply
- Type
- object
- Details
- Complete JSON request body instead of body flags. Preserves current endpoint fields and values.
payload_file- Required
- No; body/guard rules apply
- Type
- string
- Details
- Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
A JSON body is required; body flags, payload or payload_file are alternatives.
Body requires: query.
facebook_ad_library_company_ads
scrapecreators-cli facebook-ad-library-company-ads
pageId- Required
- No; body/guard rules apply
- Type
- string
- Details
- The companies ad library page id. You can get this with my Search For Companies Endpoint. Can either use this or companyName
companyName- Required
- No; body/guard rules apply
- Type
- string
- Details
- The name of the company. Can either use this or pageId
country- Required
- No; body/guard rules apply
- Type
- string
- Details
- This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL.
status- Required
- No; body/guard rules apply
- Type
- string
- Details
- Status of the ad. Defaults to ACTIVE. Values:
ALL,ACTIVE,INACTIVE.
media_type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Media type of the ad. Defaults to ALL. Meme refers to ads with image and text. Not sure why they call it meme. Values:
ALL,IMAGE,VIDEO,MEME,IMAGE_AND_MEME,NONE.
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- Language to filter ads on. Needs to be 2 letter language code, ie EN, ES, FR, etc
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. Values:
total_impressions,relevancy_monthly_grouped.
start_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- Start date to search for. Format: YYYY-MM-DD
end_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- End date to search for. Format: YYYY-MM-DD
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to paginate through results
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
Provide pageId or companyName in the applicable query/body; an empty selector is rejected locally.
facebook_ad_library_company_ads_post
scrapecreators-cli facebook-ad-library-company-ads-post
pageId- Required
- No; body/guard rules apply
- Type
- string
- Details
- The companies ad library page id. You can get this with my Search For Companies Endpoint. Can either use this or companyName
companyName- Required
- No; body/guard rules apply
- Type
- string
- Details
- The name of the company. Can either use this or pageId
country- Required
- No; body/guard rules apply
- Type
- string
- Details
- This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL.
status- Required
- No; body/guard rules apply
- Type
- string
- Details
- Status of the ad. Defaults to ACTIVE. Values:
ALL,ACTIVE,INACTIVE.
media_type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Media type of the ad. Defaults to ALL. Meme refers to ads with image and text. Not sure why they call it meme. Values:
ALL,IMAGE,VIDEO,MEME,IMAGE_AND_MEME,NONE.
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- Language to filter ads on. Needs to be 2 letter language code, ie EN, ES, FR, etc
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. Values:
total_impressions,relevancy_monthly_grouped.
start_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- Start date to search for. Format: YYYY-MM-DD
end_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- End date to search for. Format: YYYY-MM-DD
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to paginate through results
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
payload- Required
- No; body/guard rules apply
- Type
- object
- Details
- Complete JSON request body instead of body flags. Preserves current endpoint fields and values.
payload_file- Required
- No; body/guard rules apply
- Type
- string
- Details
- Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
A JSON body is required; body flags, payload or payload_file are alternatives.
Body requires: .
Provide pageId or companyName in the applicable query/body; an empty selector is rejected locally.
facebook_ad_library_search_for_companies
scrapecreators-cli facebook-ad-library-search-for-companies
query- Required
- Yes
- Type
- string
- Details
- Keyword to search for
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_ad_library_ad_library_search
scrapecreators-cli tiktok-ad-library-ad-library-search
query- Required
- No; body/guard rules apply
- Type
- string
- Details
- General ad search. Provide either query or advertiser_name, not both.
advertiser_name- Required
- No; body/guard rules apply
- Type
- string
- Details
- Advertiser name to resolve through TikTok's typeahead and search by advertiser entity. Falls back to TikTok's name search when no entity matches. Provide either advertiser_name or query, not both.
adv_biz_ids- Required
- No; body/guard rules apply
- Type
- string
- Details
- TikTok advertiser business ID from a See all ads link. Use it with advertiser_name to pin the exact advertiser. Required companion: advertiser_name; ID-only searches return 400 because TikTok ignores the ID without the name.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Opaque cursor returned from the previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
tiktok_ad_library_ad_library_ad
scrapecreators-cli tiktok-ad-library-ad-library-ad
ad_id- Required
- Yes
- Type
- string
- Details
- Creative Center Top Ads material ID or URL, or a public Ads Library ad ID or library.tiktok.com detail URL.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
google_ad_library_company_ads
scrapecreators-cli google-ad-library-company-ads
domain- Required
- No; body/guard rules apply
- Type
- string
- Details
- The domain of the company
advertiser_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- The advertiser id of the company
topic- Required
- No; body/guard rules apply
- Type
- string
- Details
- The topic to search for. If you search for 'political', you will also need to pass a 'region', like 'US' or 'AU' Values:
all,political.
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- The region to search for. Defaults to anywhere
start_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- Start date to search for. Format: YYYY-MM-DD
end_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- End date to search for. Format: YYYY-MM-DD
platform- Required
- No; body/guard rules apply
- Type
- string
- Details
- Platform to search for. Values:
google_maps,google_play,google_search,google_shopping,youtube.
format- Required
- No; body/guard rules apply
- Type
- string
- Details
- Ad format to search for. Values:
text,image,video.
get_ad_details- Required
- No; body/guard rules apply
- Type
- string
- Details
- Set to true to get the ad details. Will cost 25 credits.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to paginate through results
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
google_ad_library_ad_details
scrapecreators-cli google-ad-library-ad-details
url- Required
- Yes
- Type
- string
- Details
- The url of the ad
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
google_ad_library_advertiser_search
scrapecreators-cli google-ad-library-advertiser-search
query- Required
- Yes
- Type
- string
- Details
- The query to search for
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- 2-letter country code to search in. Defaults to US when omitted.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
linkedin_ad_library_search_ads
scrapecreators-cli linkedin-ad-library-search-ads
company- Required
- No; body/guard rules apply
- Type
- string
- Details
- The company name to search for. 'Microsoft' for example
keyword- Required
- No; body/guard rules apply
- Type
- string
- Details
- The keyword to search for
companyId- Required
- No; body/guard rules apply
- Type
- string
- Details
- The company id to search for
countries- Required
- No; body/guard rules apply
- Type
- string
- Details
- Comma separated list of countries. Example: US,CA,MX
startDate- Required
- No; body/guard rules apply
- Type
- string
- Details
- Start date in YYYY-MM-DD format. Must be used with endDate and cannot be earlier than the date one year ago.
endDate- Required
- No; body/guard rules apply
- Type
- string
- Details
- End date in YYYY-MM-DD format. Must be used with startDate and cannot be today or a future date.
paginationToken- Required
- No; body/guard rules apply
- Type
- string
- Details
- Pagination token to paginate through results
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
linkedin_ad_library_ad_details
scrapecreators-cli linkedin-ad-library-ad-details
url- Required
- Yes
- Type
- string
- Details
- The url of the ad
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitter_profile
scrapecreators-cli twitter-profile
handle- Required
- Yes
- Type
- string
- Details
- Twitter handle
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitter_user_tweets
scrapecreators-cli twitter-user-tweets
handle- Required
- Yes
- Type
- string
- Details
- Twitter handle
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitter_tweet_details
scrapecreators-cli twitter-tweet-details
url- Required
- Yes
- Type
- string
- Details
- Tweet URL
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitter_transcript
scrapecreators-cli twitter-transcript
url- Required
- Yes
- Type
- string
- Details
- Tweet URL
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitter_community
scrapecreators-cli twitter-community
url- Required
- Yes
- Type
- string
- Details
- Community URL
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitter_community_tweets
scrapecreators-cli twitter-community-tweets
url- Required
- Yes
- Type
- string
- Details
- Community URL
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
reddit_subreddit_details
scrapecreators-cli reddit-subreddit-details
subreddit- Required
- No; body/guard rules apply
- Type
- string
- Details
- Subreddit name. MUST be case sensitive. So 'AskReddit' not 'askreddit'.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Subreddit URL
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
reddit_subreddit_posts
scrapecreators-cli reddit-subreddit-posts
subreddit- Required
- Yes
- Type
- string
- Details
- Subreddit name
timeframe- Required
- No; body/guard rules apply
- Type
- string
- Details
- Timeframe to get posts from Values:
all,day,week,month,year.
sort- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort order Values:
best,hot,new,top,rising.
after- Required
- No; body/guard rules apply
- Type
- string
- Details
- After to get more posts. Get 'after' from previous response.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
reddit_subreddit_search
scrapecreators-cli reddit-subreddit-search
subreddit- Required
- Yes
- Type
- string
- Details
- Subreddit name (e.g. 'Fitness', not 'r/Fitness' or a full URL)
query- Required
- No; body/guard rules apply
- Type
- string
- Details
- Search query to find matching content
sort- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort order. For posts/media: relevance, hot, top, new, comments. For comments: relevance, top, new Values:
relevance,hot,top,new,comments.
timeframe- Required
- No; body/guard rules apply
- Type
- string
- Details
- Timeframe to filter results Values:
all,year,month,week,day,hour.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to get more results. Get 'cursor' from previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
reddit_post
scrapecreators-cli reddit-post
url- Required
- Yes
- Type
- string
- Details
- Reddit post URL
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
reddit_post_comments
scrapecreators-cli reddit-post-comments
url- Required
- Yes
- Type
- string
- Details
- Reddit post URL
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- One opaque cursor returned by the previous response to get more comments or replies. Do not combine multiple cursors.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
reddit_post_comments_post
scrapecreators-cli reddit-post-comments-post
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Reddit post URL
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- One opaque cursor returned by the previous response to get more comments or replies. Do not combine multiple cursors.
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
payload- Required
- No; body/guard rules apply
- Type
- object
- Details
- Complete JSON request body instead of body flags. Preserves current endpoint fields and values.
payload_file- Required
- No; body/guard rules apply
- Type
- string
- Details
- Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
A JSON body is required; body flags, payload or payload_file are alternatives.
Body requires: url.
reddit_post_transcript
scrapecreators-cli reddit-post-transcript
url- Required
- Yes
- Type
- string
- Details
- Reddit post URL or direct v.redd.it video URL
language- Required
- No; body/guard rules apply
- Type
- string
- Details
- 2 letter language code. Defaults to en.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
reddit_search
scrapecreators-cli reddit-search
query- Required
- Yes
- Type
- string
- Details
- Search query
filter- Required
- No; body/guard rules apply
- Type
- string
- Details
- Search posts or comments Values:
posts,comments.
sort- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by. Comment search supports relevance, new, and top; comment_count is for post search only. Values:
relevance,new,top,comment_count.
timeframe- Required
- No; body/guard rules apply
- Type
- string
- Details
- Post search timeframe Values:
all,day,week,month,year.
after- Required
- No; body/guard rules apply
- Type
- string
- Details
- Used to paginate to next page
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
truth_social_profile
scrapecreators-cli truth-social-profile
handle- Required
- Yes
- Type
- string
- Details
- Truth Social username
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
truth_social_user_posts
scrapecreators-cli truth-social-user-posts
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- Truth Social username
user_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Truth Social user id. Use this for faster response times. Trumps is 107780257626128497. It is the 'id' field in the profile endpoint.
next_max_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Used to paginate to next page
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
truth_social_post
scrapecreators-cli truth-social-post
url- Required
- Yes
- Type
- string
- Details
- Truth Social post URL
download_media- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true to download the attached video/images and get back permanent Supabase URLs. Costs 10 credits if media is found, 1 credit otherwise.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
threads_profile
scrapecreators-cli threads-profile
handle- Required
- Yes
- Type
- string
- Details
- Threads username
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
threads_posts
scrapecreators-cli threads-posts
handle- Required
- Yes
- Type
- string
- Details
- Threads username
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
threads_post
scrapecreators-cli threads-post
url- Required
- Yes
- Type
- string
- Details
- The URL of the post to get
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
threads_search_by_keyword
scrapecreators-cli threads-search-by-keyword
query- Required
- Yes
- Type
- string
- Details
- Keyword to search for
start_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- Start date to search for
end_date- Required
- No; body/guard rules apply
- Type
- string
- Details
- End date to search for
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
threads_search_users
scrapecreators-cli threads-search-users
query- Required
- Yes
- Type
- string
- Details
- Username to search for
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
bluesky_profile
scrapecreators-cli bluesky-profile
handle- Required
- Yes
- Type
- string
- Details
- Bluesky handle
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
bluesky_posts
scrapecreators-cli bluesky-posts
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- Bluesky handle
user_id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Bluesky 'did'. (For some reason Bluesky calls their user ids, 'did' for whatever reason)
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
bluesky_post
scrapecreators-cli bluesky-post
url- Required
- Yes
- Type
- string
- Details
- Bluesky post URL
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
pinterest_search
scrapecreators-cli pinterest-search
query- Required
- Yes
- Type
- string
- Details
- Search query
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
pinterest_pin
scrapecreators-cli pinterest-pin
url- Required
- Yes
- Type
- string
- Details
- Pinterest pin URL
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
pinterest_user_boards
scrapecreators-cli pinterest-user-boards
handle- Required
- Yes
- Type
- string
- Details
- The username of the user to get boards for. (e.g. broadstbullycom from https://www.pinterest.com/broadstbullycom/)
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
pinterest_board
scrapecreators-cli pinterest-board
url- Required
- Yes
- Type
- string
- Details
- The URL of the board to get
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- The cursor to get the next page of results
trim- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Set to true for a trimmed down version of the response
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
google_search
scrapecreators-cli google-search
query- Required
- Yes
- Type
- string
- Details
- Search query
region- Required
- No; body/guard rules apply
- Type
- string
- Details
- 2 letter country code, ie US, UK, CA, etc This will show results from that country
date_posted- Required
- No; body/guard rules apply
- Type
- string
- Details
- Date posted Values:
last-hour,last-day,last-week,last-month,last-year.
page- Required
- No; body/guard rules apply
- Type
- number
- Details
- Page number to retrieve. Must be between 1 and 11; page 12 or greater returns a 400 response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitch_profile
scrapecreators-cli twitch-profile
handle- Required
- Yes
- Type
- string
- Details
- Twitch handle
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitch_user_videos
scrapecreators-cli twitch-user-videos
handle- Required
- Yes
- Type
- string
- Details
- Twitch handle
filter_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- Filter by Values:
HIGHLIGHT,ARCHIVE,UPLOAD.
sort_by- Required
- No; body/guard rules apply
- Type
- string
- Details
- Sort by Values:
TIME,VIEWS.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitch_user_schedule
scrapecreators-cli twitch-user-schedule
handle- Required
- Yes
- Type
- string
- Details
- Twitch handle
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitch_clip_transcript
scrapecreators-cli twitch-clip-transcript
url- Required
- Yes
- Type
- string
- Details
- Twitch clip URL
use_ai_as_fallback- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Use AI transcription only when native captions are unavailable. Costs 10 credits when an AI transcript is returned. Defaults to false.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
twitch_clip
scrapecreators-cli twitch-clip
url- Required
- Yes
- Type
- string
- Details
- Twitch clip URL
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
apple_music_artist
scrapecreators-cli apple-music-artist
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Apple Music artist id. If you'd prefer to use the URL instead, you can use the url parameter instead.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Apple Music artist URL. If you'd prefer to use the id instead, you can use the id parameter instead.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
apple_music_album
scrapecreators-cli apple-music-album
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Apple Music album id. If you'd prefer to use the URL instead, you can use the url parameter instead.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Apple Music album URL. If you'd prefer to use the id instead, you can use the id parameter instead.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
apple_music_track
scrapecreators-cli apple-music-track
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Apple Music song id. Some songs have standalone song URLs; for album tracks, use the url parameter.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Apple Music song URL or album track URL.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
apple_music_search
scrapecreators-cli apple-music-search
query- Required
- Yes
- Type
- string
- Details
- Search query
type- Required
- No; body/guard rules apply
- Type
- string
- Details
- Result type to return. Use all, song, album, artist, playlist, station, music_video, or radio_episode.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
spotify_artist
scrapecreators-cli spotify-artist
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify artist id. If you'd prefer to use the URL instead, you can use the url parameter instead.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify artist URL. If you'd prefer to use the id instead, you can use the id parameter instead.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
spotify_track
scrapecreators-cli spotify-track
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify track id. If you'd prefer to use the URL instead, you can use the url parameter instead.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify song URL. If you'd prefer to use the id instead, you can use the id parameter instead.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
spotify_album
scrapecreators-cli spotify-album
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify album id. If you'd prefer to use the URL instead, you can use the url parameter instead.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify album URL. If you'd prefer to use the id instead, you can use the id parameter instead.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
spotify_playlist
scrapecreators-cli spotify-playlist
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify playlist id. If you'd prefer to use the URL instead, you can use the url parameter instead.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify playlist URL. If you'd prefer to use the id instead, you can use the id parameter instead.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor returned by the previous response. Omit it for the first page.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
spotify_search
scrapecreators-cli spotify-search
query- Required
- Yes
- Type
- string
- Details
- Search query
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
spotify_podcast
scrapecreators-cli spotify-podcast
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify podcast id. If you'd prefer to use the URL instead, you can use the url parameter instead.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify podcast URL. If you'd prefer to use the id instead, you can use the id parameter instead.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
spotify_podcast_episodes
scrapecreators-cli spotify-podcast-episodes
id- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify podcast id. If you'd prefer to use the URL instead, you can use the url parameter instead.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Spotify podcast URL. If you'd prefer to use the id instead, you can use the id parameter instead.
cursor- Required
- No; body/guard rules apply
- Type
- number
- Details
- Cursor returned by the previous response. Omit for the first page.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
soundcloud_artist
scrapecreators-cli soundcloud-artist
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- SoundCloud artist handle. If you'd prefer to use the URL instead, you can use the url parameter instead.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- SoundCloud artist URL. If you'd prefer to use the handle instead, you can use the handle parameter instead.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
soundcloud_artist_tracks
scrapecreators-cli soundcloud-artist-tracks
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- SoundCloud artist handle. If you'd prefer to use the URL instead, you can use the url parameter instead.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- SoundCloud artist tracks URL. If you'd prefer to use the handle instead, you can use the handle parameter instead.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor to get more tracks. Get 'cursor' from previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
soundcloud_track
scrapecreators-cli soundcloud-track
url- Required
- Yes
- Type
- string
- Details
- SoundCloud track URL.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
kwai_profile
scrapecreators-cli kwai-profile
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- Kwai profile handle. Use this or url.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Kwai profile URL. Use this or handle.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
kwai_user_posts
scrapecreators-cli kwai-user-posts
handle- Required
- No; body/guard rules apply
- Type
- string
- Details
- Kwai profile handle. Use this or url.
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Kwai profile URL. Use this or handle.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Cursor from the previous response for the next page
count- Required
- No; body/guard rules apply
- Type
- number
- Details
- Number of posts to return, max 50
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
kwai_post
scrapecreators-cli kwai-post
url- Required
- No; body/guard rules apply
- Type
- string
- Details
- Kwai post URL
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
kick_clip_transcript
scrapecreators-cli kick-clip-transcript
url- Required
- Yes
- Type
- string
- Details
- Kick clip URL
use_ai_as_fallback- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Use AI transcription only when native captions are unavailable. Costs 10 credits when an AI transcript is returned. Defaults to false.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
kick_clip
scrapecreators-cli kick-clip
url- Required
- Yes
- Type
- string
- Details
- Kick clip URL
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
snapchat_user_profile
scrapecreators-cli snapchat-user-profile
handle- Required
- Yes
- Type
- string
- Details
- Snapchat username
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
snapchat_spotlight_by_link
scrapecreators-cli snapchat-spotlight-by-link
url- Required
- Yes
- Type
- string
- Details
- Snapchat Spotlight URL.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
snapchat_spotlight_comments_by_link
scrapecreators-cli snapchat-spotlight-comments-by-link
url- Required
- Yes
- Type
- string
- Details
- Snapchat Spotlight URL.
cursor- Required
- No; body/guard rules apply
- Type
- string
- Details
- Pagination cursor from the previous response.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
creator_tools_find_social_profiles
scrapecreators-cli creator-tools-find-social-profiles
platform- Required
- Yes
- Type
- string
- Details
- Source social platform Values:
instagram,tiktok,youtube,x,twitter,facebook.
handle- Required
- Yes
- Type
- string
- Details
- Creator handle without a profile URL. A leading @ is optional.
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
creator_tools_get_age_and_gender
scrapecreators-cli creator-tools-get-age-and-gender
url- Required
- Yes
- Type
- string
- Details
- URL to users social profile
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
linktree_linktree_page
scrapecreators-cli linktree-linktree-page
url- Required
- Yes
- Type
- string
- Details
- URL to Linktree page
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
komi_komi_page
scrapecreators-cli komi-komi-page
url- Required
- Yes
- Type
- string
- Details
- URL to Komi page
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
pillar_pillar_page
scrapecreators-cli pillar-pillar-page
url- Required
- Yes
- Type
- string
- Details
- URL to Pillar page
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
linkbio_linkbio_page
scrapecreators-cli linkbio-linkbio-page
url- Required
- Yes
- Type
- string
- Details
- URL to Linkbio (lnk.bio) page
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
amazon_shop_amazon_shop_page
scrapecreators-cli amazon-shop-amazon-shop-page
url- Required
- Yes
- Type
- string
- Details
- URL to Amazon Shop page
pageToken- Required
- No; body/guard rules apply
- Type
- string
- Details
- Opaque page token returned by a previous response for the same shop URL. Pass it back unchanged and do not infer the response type from its prefix. A page can contain lists, videos, or both.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
scrapecreators_get_credit_balance
scrapecreators-cli scrapecreators-get-credit-balance
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
scrapecreators_get_request_history
scrapecreators-cli scrapecreators-get-request-history
page- Required
- No; body/guard rules apply
- Type
- string
- Details
- Page number for pagination (max 100)
endpoint- Required
- No; body/guard rules apply
- Type
- string
- Details
- Filter by endpoint name (partial match)
statusCode- Required
- No; body/guard rules apply
- Type
- string
- Details
- Filter by HTTP status code
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
scrapecreators_get_daily_usage
scrapecreators-cli scrapecreators-get-daily-usage
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
scrapecreators_get_most_used_routes
scrapecreators-cli scrapecreators-get-most-used-routes
start_time- Required
- No; body/guard rules apply
- Type
- string
- Details
- Start of time range (ISO 8601 format)
end_time- Required
- No; body/guard rules apply
- Type
- string
- Details
- End of time range (ISO 8601 format)
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
linkme_profile
scrapecreators-cli linkme-profile
url- Required
- Yes
- Type
- string
- Details
- Linkme profile URL
cache_max_age- Required
- No; body/guard rules apply
- Type
- string
- Details
- Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values:
1d,3d,7d,14d,30d.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- Named private ScrapeCreators account; selects credentials, not a remote account ID.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- Must be true for the specific approved credit-consuming research call.
list_accounts
scrapecreators-cli list-accounts
None
- Required
- No
- Type
- None
- Details
- Local helper, accepts no arguments
research_batch
scrapecreators-cli research-batch
requests- Required
- Yes
- Type
- array
- Details
- See the exact schema before calling. minItems:
1. maxItems:20. Items: object.
max_calls- Required
- Yes
- Type
- integer
- Details
- See the exact schema before calling. minimum:
1. maximum:20.
account- Required
- No; body/guard rules apply
- Type
- string
- Details
- See the exact schema before calling.
confirm- Required
- No; body/guard rules apply
- Type
- boolean
- Details
- See the exact schema before calling.
Each requests item requires tool and arguments, with no other fields. tool must be one of the 184 potentially paid API tools, never an account read or recursive batch.
Inner arguments cannot select account or confirm; the outer batch owns both.
Full nested schema and current allowed names: scrapecreators-cli schema research-batch.
Complete client, OS and desktop setup
Enter actual credentials only into private user settings.
INSTALL.md ships in npm.
Remote-only clients can use the official provider MCP with its supported authentication.
Codex
Codex is the current validation priority.
Private token paths must exist in the process or remote environment where the server runs.
codex mcp add scrapecreators -- npx -y @thenavidm/scrapecreators-mcp-cli@latest
codex mcp listAccount credentials must reach the server through private environment settings.
codex mcp add --env NAME=value stores values in your local config, so never commit that config or put secrets in a shared command.
In TOML, the equivalent server is:
[mcp_servers.scrapecreators]
command = "npx"
args = ["-y", "@thenavidm/scrapecreators-mcp-cli@latest"]
env_vars = ["SCRAPECREATORS_API_KEY", "SCRAPECREATORS_TOKEN_FILE", "SCRAPECREATORS_ACCOUNTS", "SCRAPECREATORS_DEFAULT_ACCOUNT", "SCRAPECREATORS_READ_ONLY", "SCRAPECREATORS_ALLOW_SPENDING"]env_vars forwards those names from the environment available to Codex.
If that environment does not contain them, configure private env settings locally.
Codex can also call the CLI directly with SKILL.md and --agent output.
Claude Code
For a user-scoped connection, after privately configuring credentials:
claude mcp add --scope user scrapecreators -- npx -y @thenavidm/scrapecreators-mcp-cli@latest
claude mcp listUse the client's private local environment settings for the account variable if they are not inherited.
Claude's -e NAME=value registration option writes values into its config; only use it locally through your secret manager, with no shared command transcript.
Never place credentials in a project .mcp.json.
Reconnect and ask Claude to verify credentials.
Alternatively install the CLI, make SKILL.md available to Claude, and use shell commands.
Registering both surfaces is optional.
Claude Desktop
Install the .mcpb extension
- Download
scrapecreators-2.0.0.mcpbfrom GitHub Releases. - In a supported Claude Desktop build, open Settings > Extensions > Advanced settings > Install Extension… and select it.
- Enter a private API key in the sensitive setting, or an absolute private token-file path. Leave the unused credential method empty. ScrapeCreators uses x-api-key authentication.
- Enable read-only if you want only the five local/account reads. Reconnect and ask for account verification.
The bundle includes production dependencies and no credentials.
Use a regular private token-only file if you prefer file-based credentials.
The manifest requires Node 22 or newer from a compatible host.
Organization policy may restrict custom extensions.
Manual bundle updates require installing the new version; no automatic directory updates are promised.
GUI installation remains unverified separately from archive/protocol checks.
Manual config
Open Settings > Developer > Edit Config, or use your platform's config file:
| OS | Typical config path |
|---|---|
| macOS | ~/Library/Application Support/Claude/claude_desktop_config.json |
| Windows | %APPDATA%\Claude\claude_desktop_config.json |
| Linux | ~/.config/Claude/claude_desktop_config.json; confirm the location through Edit Config in your installed build |
{
"mcpServers": {
"scrapecreators": {
"command": "npx",
"args": ["-y", "@thenavidm/scrapecreators-mcp-cli@latest"],
"env": {
"SCRAPECREATORS_API_KEY": "YOUR_PRIVATE_API_KEY",
"SCRAPECREATORS_TOKEN_FILE": ""
}
}
}
}Replace the placeholders only in your private file.
Merge the server entry into an existing mcpServers object instead of replacing other integrations.
Fully quit and reopen Claude Desktop.
Do not enable an extension and a manual entry with the same name; choose one route.
If a Windows launcher cannot execute npx directly, use "command": "cmd" with "args": ["/c", "npx", "-y", "@thenavidm/scrapecreators-mcp-cli@latest"].
An absolute node executable and installed dist/index.js path also avoids launcher/PATH problems.
Cursor
Use private user settings at ~/.cursor/mcp.json, or Settings > Tools & MCP. Cursor documents environment interpolation and envFile support.
{
"mcpServers": {
"scrapecreators": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@thenavidm/scrapecreators-mcp-cli@latest"],
"env": {
"SCRAPECREATORS_API_KEY": "${env:SCRAPECREATORS_API_KEY}",
"SCRAPECREATORS_TOKEN_FILE": "${env:SCRAPECREATORS_TOKEN_FILE}"
}
}
}
}The environment values must exist for the Cursor process.
If you use envFile, keep that file private and outside version control.
A project's .cursor/mcp.json must not contain actual credentials.
Reconnect the server after saving.
VS Code and Copilot
Use MCP: Open User Configuration. VS Code uses servers and secure inputs, rather than a mcpServers root:
{
"inputs": [
{"type": "promptString", "id": "scrapecreators-api-key", "description": "ScrapeCreators scoped API token (leave empty for a private token file)", "password": true},
{"type": "promptString", "id": "scrapecreators-token-file", "description": "Optional private token-file path (leave empty for scoped API token)"}
],
"servers": {
"scrapecreators": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@thenavidm/scrapecreators-mcp-cli@latest"],
"env": {
"SCRAPECREATORS_API_KEY": "${input:scrapecreators-api-key}",
"SCRAPECREATORS_TOKEN_FILE": "${input:scrapecreators-token-file}"
}
}
}
}Start ScrapeCreators through the MCP controls, approve trust if prompted, and enter credentials in the private input prompts.
Workspace .vscode/mcp.json may contain this placeholder-only structure, but never resolved secret values.
Remote development runs the server in the selected remote environment, so local file paths refer to that environment.
Windsurf
Open Cascade's MCP settings or edit the private user file ~/.codeium/windsurf/mcp_config.json.
Use the Claude Desktop manual mcpServers block above with your locally configured env values.
See Windsurf's current MCP documentation.
Restart or reconnect ScrapeCreators in Cascade; project files must not contain secrets.
Zed
Open Settings > AI > MCP Servers > Add Server > Add Local Server, or your user settings file. Zed uses context_servers:
{
"context_servers": {
"scrapecreators": {
"command": "npx",
"args": ["-y", "@thenavidm/scrapecreators-mcp-cli@latest"],
"env": {
"SCRAPECREATORS_API_KEY": "YOUR_PRIVATE_API_KEY",
"SCRAPECREATORS_TOKEN_FILE": ""
}
}
}
}Enter actual values only in private user settings.
Check the active-server indicator before prompting.
Do not wrap command and args inside a nested command object from older Zed examples.
Gemini CLI
Merge the Claude Desktop manual mcpServers block into your private ~/.gemini/settings.json.
Configure the private credential values locally, then restart Gemini CLI and inspect /mcp.
See Gemini CLI's MCP configuration.
Its project settings must not contain real credentials.
You can instead use the CLI from an agent shell.
Other local stdio clients use the same command and arguments, adapted to their config format.
A client that only accepts a remote MCP URL cannot connect directly: this package does not ship a public HTTP listener.
ChatGPT's remote connector setup is not a substitute for local stdio installation.
Docker
Build locally from the reviewed source; no prebuilt registry image is claimed:
git clone https://github.com/thenavidm/scrapecreators-mcp-cli.git
cd scrapecreators-mcp-cli
docker build -t scrapecreators-mcp-cli .
docker run --rm -i -e SCRAPECREATORS_API_KEY scrapecreators-mcp-cliCline and other local MCP clients
Use the client's Add MCP server flow with command npx, arguments -y and @thenavidm/scrapecreators-mcp-cli@latest, stdio transport, and private local SCRAPECREATORS_API_KEY or SCRAPECREATORS_TOKEN_FILE settings.
UI names depend on the installed client.
Reconnect and discover tools before an account call.
Browser-only clients need a remote HTTPS connector; use ScrapeCreators's official server rather than this local stdio command.
Command inputs, JSON and output
Tool names become dashed commands; underscores are accepted too.
Path parameter names follow the discovered schema, such as continuationToken → --continuation-token.
Body tools accept individual top-level flags, complete --payload JSON, or --payload-file pointing to a regular JSON body file up to 5 MB.
Do not mix those body routes.
Path/query flags remain separate.
Nested objects take JSON and array flags repeat once per item; a whole array is not a single item.
scrapecreators-cli instagram-profile --help
scrapecreators-cli schema reddit-post-comments-post
scrapecreators-cli youtube-comments --url "https://www.youtube.com/watch?v=VIDEO_ID" --continuation-token OPAQUE_TOKEN --confirm --agentIDs/cursors above are illustrative; use the selected public resource and cursor from its prior response.
Nullable fields require an actual JSON null inside payload; --field null is a string.
Nested values preserve current upstream constraints; unknown top-level body fields are refused.
Body-required fields are validated during execution even when the wrapper schema allows an alternative payload route.
Operations whose upstream request body is required need body flags or an explicit payload; a deliberately supplied empty object is sent as JSON, never omitted.
| Flag | Behavior |
|---|---|
| --help / schema COMMAND | Current argument help / full JSON Schema |
| --json | Structured JSON |
| --compact | One-line JSON |
| --agent | Compact JSON, no prompts or color |
| --select a,b.c | Keep selected fields, including nested objects/arrays |
| --no-color / --no-input | Noninteractive house flags |
| --yes | Never replaces paid-call confirmation |
| --confirm | Approve only the requested paid research |
| --account NAME | Select private local credentials |
| --payload JSON / --payload-file PATH | Complete request body, mutually exclusive with body flags |
| Exit | Meaning |
|---|---|
| 0 | Success |
| 2 | Invalid arguments or refused paid call |
| 3 | Resource not found |
| 4 | Authentication/permission failure |
| 5 | API/transport failure |
| 7 | Rate limit |
| 10 | Missing or invalid private configuration |
Results go to stdout, errors as JSON to stderr.
Selection changes local output, not the original API response or provider charge.
API success is not proof that public data is current, exhaustive or complete.
Official and community comparisons
- Surface
- @scrapecreators/cli 1.0.44; scrapecreators
- Capabilities and tradeoff
- 188 registry endpoint variants, JSON/CSV/table/Markdown, clean output, file output, interactive key setup, signup and agent-config helpers
- Surface
- https://api.scrapecreators.com/mcp
- Capabilities and tradeoff
- Provider-hosted public research with OAuth or x-api-key authentication; client approvals and provider maintenance apply
- Surface
- Agent workflows
- Capabilities and tradeoff
- Provider-authored research guidance; compare the relevant workflow before installing another wrapper
This owned package
- Surface
- Local stdio MCP, shared CLI, .mcpb
- Capabilities and tradeoff
- Mandatory approval for potentially paid research, private named accounts and prevalidated sequential batches capped at 20, stopping on first failure
- Surface
- Local stdio or hosted gateway
- Capabilities and tradeoff
- Its README documents four focused social/ad tools and gateway routing; hosted and standalone tool sets differ
- Surface
- Go CLI/MCP and local workflows
- Capabilities and tradeoff
- Its source documents transcript research and local workflow/configuration; no authenticated performance comparison was performed
Checked October 2, 2026.
The installed official 1.0.44 binary and source were reviewed.
Its registry has the same 188 endpoint variants represented by the current OpenAPI snapshot.
Headline platform/endpoint numbers in introductory docs are older; our two local helpers are not extra provider API coverage.
Official CSV/table/Markdown, --clean, --output and signup are useful advantages and are not claimed here.
A network-free fixture against the official CLI's real handler submits its 26-credit audience endpoint without a confirmation flag in noninteractive mode.
Its extra-credit warning is TTY-only.
Our equivalent schema refuses before fetch until confirm=true, and a disabled/read-only policy still refuses confirmed calls.
This is evidence about that CLI version, not a claim that official hosted MCP clients lack approval controls.
The official agent-config source writes Codex setup to ~/.codex/mcp.json; our instructions use the verified Codex config.toml/stdio registration.
The official balance helper references /v1/credit-balance, while the reviewed current schema uses /v1/account/credit-balance.
Compatibility of the older balance route was not tested with an account; no unsupported broken-route claim is made.
Named credential isolation and bounded batch validation give this owned implementation a useful case.
Neither 190 versus 188 tool names nor SEO demonstrates greater coverage, task quality or token efficiency.
Official hosted setup may be easier for remote-only clients.
Community README capabilities above were inspected, not authenticated or benchmarked.
No overall winner is declared.
Versions and migration
This package and desktop manifest
- Version / baseline
- 2.0.0
- Meaning
- Shared release version
Node
- Version / baseline
- 22+
- Meaning
- Manual CLI/MCP runtime
MCP TypeScript SDK
- Version / baseline
- 1.32.0
- Meaning
- Shared protocol bridge
API snapshot
- Version / baseline
- 2026-10-02; info 1.0.0, OpenAPI 3.1.0
- Meaning
- 188 reviewed operations; native route versions preserved
Official CLI baseline
- Version / baseline
- 1.0.44
- Meaning
- Reviewed current npm binary/source
Legacy source baseline
- Version / baseline
- 1.0.0
- Meaning
- 12 grouped MCP tools, 107 action routes; not a prior public npm claim
See CHANGELOG.md for the breaking grouped-action migration, source hashes and release history.
Full shared API discovery plus local helpers gives 190 tools, five reads and 185 confirmation-gated calls.
A tag/release/version is not live-account validation.
Fresh Codex task/token evidence and desktop GUI acceptance remain separately pending.
Updates and removal
npm install -g @thenavidm/scrapecreators-mcp-cli@latest
scrapecreators-cli --version
codex mcp remove scrapecreators
npm uninstall -g @thenavidm/scrapecreators-mcp-cliRead CHANGELOG.md before a major upgrade; pin a reviewed version for reproducible automation.
Install a newer desktop archive separately and restart clients to load updated code/key files.
Remove other client entries through their own settings.
Uninstalling does not revoke the API key, delete private exports/logs or undo consumed credits.
Revoke/rotate the key in the provider's API Keys area and remove private local settings separately.
Validation and remaining evidence
Typecheck, build and 27 behavior/shared-CLI tests pass.
Full stdio discovery returns 190 tools; read-only returns five.
All 185 potentially paid calls require confirmation, including GET.
The exact public npm package was installed anonymously, and the released desktop archive was downloaded separately.
Both expose all 190 tools and five in read-only mode; both pass secret scans.
GitHub CI covers Node 22/24 on Linux, macOS and Windows, and the tag release workflow published version 2.0.0.
Production dependency audit has zero findings.
Development packaging advisories are documented in SECURITY.md and excluded from runtime artifacts.
Provider account outcomes and desktop GUI installation remain separately unverified.
An isolated Codex 0.159.3 configuration check accepts the documented stdio registration and six forwarded environment variables.
Codex is the current setup and usage-measurement priority.
Fresh Codex standing-context and equivalent successful task measurements remain pending.
Claude Code is optional; its benchmarks are deferred.
No character estimates, borrowed measurements or tool-count savings are substituted.
More tools for creator research
Connect the tools needed for the requested workflow.
ScrapeCreators MCP Server & CLI FAQs
Official alternatives, public research, keys, credits, caching, batches, desktop setup and safeguards.
A local stdio server that lets a compatible AI client call public research and account metadata through validated structured schemas.
scrapecreators-cli runs the same handlers, schemas and approval guard as MCP.
Commands and help derive from real discovery.
Yes.
The provider has a hosted MCP, @scrapecreators/cli and research skills.
This guide compares them honestly.
Enforced paid-call confirmation, private named accounts and prevalidated bounded batches provide specific added workflows.
Tool count and SEO alone are not the case.
The AGPL wrapper is free software.
Provider API credits and account/service terms remain separate.
Sign in at app.scrapecreators.com and use API Keys.
Store the intended account/team key in private local settings or a protected key-only file.
Use private local settings instead.
Actual credentials must never appear in chats, issues, process arguments or shared project files.
No, it prints instructions.
The official CLI has its own interactive setup and device signup flow.
Yes.
INSTALL.md leads with verified local stdio/config.toml wiring or the CLI and shipped skill.
Claude Code is optional.
The versioned .mcpb bundles this same server and production dependencies for a compatible host.
GUI installation remains separately unverified.
Use the provider hosted MCP at api.scrapecreators.com/mcp with its supported authentication.
This local package does not expose a public relay.
A data lookup may consume credits.
Confirmation covers the specific paid research request even when it does not change social-platform content.
No. --agent and --yes do not supply --confirm, and read-only or disabled spending still refuses confirmed calls.
No.
It bounds submitted requests.
Endpoint prices, cache hits and remote outcomes determine actual consumption.
It validates all inputs before fetch, runs sequentially, stops at the first failure and keeps earlier outcomes.
It never automatically replays successful calls.
No.
Native endpoint cursors are manual.
Every further live page can consume credits and needs deliberate approval.
A supported provider cache hit costs zero, but a miss or team opt-out can require a charged live lookup.
Preserve cached_at and inspect actual response usage.
This release is public-data research and account metadata.
It does not log into social accounts, publish content or bypass private access.
The selected/original language track may be unavailable or unidentified.
Preserve the provider result rather than inventing missing words.
Fresh Codex matched-task and loading-mode usage measurements are pending.
No estimates, borrowed results or tool-count savings are claimed.
Navid Moazzez
AI business strategist & AI OS builder
Navid Moazzez helps creators and founders master AI and build their own AI Operating System (AI OS) to automate their business and life.
Navid.me is reader-supported. When you buy through links on this site, I may earn an affiliate commission. Learn more.
More MCP servers & CLIs
Facebook
Bluesky
Substack
Threads
Mastodon
Apple Podcasts
Telegram
Kit
Beehiiv
Related free tools
X
LinkedIn
Instagram
Pinterest
Free AI newsletterThe most actionable AI newsletter for founders
Every week, get proven AI strategies, curated tools, and step-by-step systems to grow your audience, create better content, and build a profitable creator business.
No fluff, no filler, no BS. Just five minutes each week that might level up your online business and life.
P.S. Sign up now to get free access to my ultimate AI tools guide for creators.
Loved by 10,000+ readers