ScrapeCreators MCP Server
Allows searching public ads through the Facebook Ad Library, with filters such as country and status.
Allows retrieving public Instagram profile data and recent posts via ScrapeCreators.
Allows retrieving public TikTok profile data, with TikTok audience demographics also noted as a paid endpoint.
Allows retrieving specific YouTube video transcripts while preserving track language.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@ScrapeCreators MCP Server can you fetch the Instagram profile for @nasa?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
ScrapeCreators MCP Server & CLI
ScrapeCreators MCP server and CLI for Codex and AI agents. 190 tools: five local/account reads and 185 potentially paid calls for public social profiles, posts, transcripts, comments, ads and bounded research.
One package provides local MCP, the same operations as task CLI commands, and a bundled desktop .mcpb extension.
Built and maintained by Navid Moazzez. Built on Slipway, which turns one definition of each tool into the MCP server and the CLI. Complete installation and private account setup are in INSTALL.md.
The terminal illustrates shipped public research tools with sample data. It is a presentation preview, not a verified live-account request.
You need a private ScrapeCreators API key and sufficient provider access/credits. This community product is maintained by Navid Media and preserves AGPL-3.0-or-later. ScrapeCreators already has an official CLI and hosted MCP; useful differences and limitations are compared below.
Two ways to use it
Command line
npm install -g @thenavidm/scrapecreators-mcp-cli@latest
scrapecreators-cli
scrapecreators-cli instagram-profile --help
scrapecreators-cli schema research-batch
scrapecreators-cli scrapecreators-get-credit-balance --agentConfigure private access before account calls. Potentially paid research requires --confirm; --yes and --agent do not authorize it.
MCP server, for your AI app
codex mcp add scrapecreators -- npx -y @thenavidm/scrapecreators-mcp-cli@latestThen ask: Check credit balance, then show the exact public-profile lookup before I approve the paid call. Full client/OS setup is in INSTALL.md.
Which one
Where you work | Surface |
Codex or another shell agent | Local MCP, shared CLI or both |
Desktop chat | Compatible local MCP/.mcpb host |
Scripts/CI | Shared task CLI or MCP client |
Remote-URL-only client | Official provider hosted MCP |
Related MCP server: Nilyo
Features
Capability | CLI | MCP |
Public profiles | instagram-profile / tiktok-profile | instagram_profile / tiktok_profile |
Video transcripts | youtube-transcript | youtube_transcript |
Public ads | facebook-ad-library-search-post | facebook_ad_library_search_post |
Account credit/history | scrapecreators-get-credit-balance | scrapecreators_get_credit_balance |
Exact bounded research | research-batch | research_batch |
Private account labels | list-accounts / --account | list_accounts / account |
Setup diagnosis | doctor / login | CLI utilities |
Contents
Number | Section | Covers |
1 | Practical research | |
2 | Both binaries and desktop | |
3 | Keys, credits and caching | |
4 | Clients and OS | |
5 | Doctor and first account read | |
6 | Schema-derived flags and scripting | |
7 | Measured evidence requirements | |
8 | All current tools and arguments | |
9 | Profiles, transcripts, ads and batch | |
10 | Opaque cursors and actual charges | |
11 | Named credentials | |
12 | Per-call approval and policies | |
13 | Shared handlers and schema sync | |
14 | Direct API and privacy | |
15 | Private credentials and tuning | |
16 | Upgrade and revoke | |
17 | Errors and remedies | |
18 | Official and community choices | |
19 | Release and migration history | |
20 | Accordion answers |
1. What you can ask it
Inspect a selected public creator profile and one page of recent posts.
Retrieve the specific YouTube transcript I approved, preserving track language.
Research matching public ads in the chosen country and status.
Compare a bounded set of public profiles in one named private account.
Check credit balance and account request history before repeating a failed lookup.
The current schema supplies 188 API operations across 37 groups. list_accounts is local; research_batch is a shared local workflow. Actual discovery gives 190 tools: five local/account reads and 185 potentially paid calls. Account metadata remains available in read-only mode; paid research requires explicit confirmation, even for GET.
ScrapeCreators already offers official MCP, CLI and research skills. This owned wrapper adds enforced paid-call approval, named private credentials and bounded prevalidated batches. Fixture/protocol validation is separate from live account outcomes, GUI installation and measured token evidence.
2. Quick install
npm install -g @thenavidm/scrapecreators-mcp-cli@latest
scrapecreators-cli --version
scrapecreators-cli login
scrapecreators-cli doctor
scrapecreators-cli toolsNode 22+ is required for manual CLI/MCP setup. Discovery, schemas and list_accounts work without a key. The scrapecreators-3.0.0.mcpb desktop archive bundles production dependencies for a compatible host. Full setup is in INSTALL.md.
After private environment configuration:
codex mcp add scrapecreators -- npx -y @thenavidm/scrapecreators-mcp-cli@latest
codex mcp list3. 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.
4. Connect your client
INSTALL.md retains the established client setup for Codex, Claude Code, Claude Desktop extension/manual config, Cursor, VS Code/Copilot, Windsurf, Zed, Gemini CLI, Cline, Docker and other stdio clients on macOS, Windows and Linux. Codex is the current priority; Claude Code is optional.
Use command npx with arguments -y, @thenavidm/scrapecreators-mcp-cli@latest, and private local credential settings. Remote-only clients can use the provider's official https://api.scrapecreators.com/mcp endpoint with its supported OAuth/API-key connection. This local package has no public HTTP relay.
The shipped SKILL.md guides a shell agent. Make it available through the client's supported skills location; npm installation alone does not register it. Client approval and confirm=true are separate: the guard requires approval for this specific paid action, not permission inferred from returned content.
5. Check it works
scrapecreators-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 --agent6. Output, flags and exit codes
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 and no prompts; never confirms a write |
--select a,b.c | Keep selected fields, including nested objects/arrays |
--no-color / --no-input | Noninteractive switches |
--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 |
1 | Unexpected error |
2 | Invalid arguments or refused paid call, an unknown command or a hidden write |
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.
7. MCP or CLI and token cost
MCP and CLI use the same schemas, validation and HTTP handlers: Slipway builds the MCP server, over stdio or --http, and the CLI from each tool's one definition; there is no second API implementation.
Measured on 2026-10-05 against 2.0.1, with Claude Code 2.1.286 on Claude Opus 5.5 (one short prompt with and without the server connected, the difference read from the API's own usage figures) and Codex 0.159.3 on gpt-6.1-sol:
Cost | 2.0.1 | 3.0.0 |
Claude Code, every tool loaded, every message | 89,024 | 88,384 |
Claude Code's default, tool search, every message | 3,223 | 3,224 |
| 1,326 | 1,392 |
Codex over the CLI, one task, median of five | 86,664 | 83,060 |
Codex over MCP, the same task, median of five | 76,914 | 48,790 |
The task was "find the command that gets a TikTok video's transcript, and the flags it requires". Every tool loaded costs less, while the list a client receives grows by an approval marker on the 185 paid tools, which Claude Code does not pass to the model. Over the CLI, every 3.0.0 run asked which, a 478-character answer, where every 2.0.1 run read the 13,019-character command list. Over MCP, four 3.0.0 runs answered after printing part of the tool list, against two 2.0.1 runs, so the median fell; where both printed the whole list, they read about the same, 76,914 and 77,022. SKILL.md costs 66 more because it says how approval works over MCP and what exit codes 1 and 2 cover.
Tool-list bytes or characters divided by four are not API usage, and no other offering was measured.
8. Every tool and argument
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.
Tool | Route | Mode |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Potentially paid; confirm |
|
| Account metadata read |
|
| Account metadata read |
|
| Account metadata read |
|
| Account metadata read |
|
| Potentially paid; confirm |
| Local, no network | Read |
| Local sequential workflow | Confirmed paid research |
tiktok_profile
scrapecreators-cli tiktok-profile
Argument | Required | Type | Details |
| No; body/guard rules apply | string | TikTok handle. You can pass handle or user_id. |
| No; body/guard rules apply | string | TikTok user id. |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
Provide handle or user_id; an empty selector is rejected before a network call.
tiktok_profile_region
scrapecreators-cli tiktok-profile-region
Argument | Required | Type | Details |
| Yes | string | TikTok handle |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_audience_demographics
scrapecreators-cli tiktok-audience-demographics
Argument | Required | Type | Details |
| Yes | string | TikTok handle |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_collection_videos
scrapecreators-cli tiktok-collection-videos
Argument | Required | Type | Details |
| Yes | string | Public TikTok collection URL |
| No; body/guard rules apply | string | Cursor to get more videos. Use max_cursor from the previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_profile_videos
scrapecreators-cli tiktok-profile-videos
Argument | Required | Type | Details |
| Yes | string | TikTok handle |
| No; body/guard rules apply | string | TikTok user id. Use this for faster responses. |
| No; body/guard rules apply | string | What to sort by Values: |
| No; body/guard rules apply | string | Cursor to get more videos. Get 'max_cursor' from previous response. |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_video_info
scrapecreators-cli tiktok-video-info
Argument | Required | Type | Details |
| Yes | string | TikTok video URL |
| No; body/guard rules apply | boolean | Get transcript of the video |
| No; body/guard rules apply | string | 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 |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response |
| No; body/guard rules apply | boolean | Set to true to download the video/images and get back permanent Supabase URLs. Costs 10 credits if media is found, 1 credit otherwise. |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_transcript
scrapecreators-cli tiktok-transcript
Argument | Required | Type | Details |
| Yes | string | TikTok video URL |
| No; body/guard rules apply | string | Language of the transcript. 2 letter language code, ie 'en', 'es', 'fr', 'de', 'it', 'ja', 'ko', 'zh' |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_live
scrapecreators-cli tiktok-live
Argument | Required | Type | Details |
| Yes | string | TikTok handle |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_live_info
scrapecreators-cli tiktok-live-info
Argument | Required | Type | Details |
| Yes | string | TikTok live room id. Get this from |
| Yes | string | TikTok numeric user id for the live owner. Get this from |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_comments
scrapecreators-cli tiktok-comments
Argument | Required | Type | Details |
| Yes | string | TikTok video URL |
| No; body/guard rules apply | number | Cursor to get more comments. Get 'cursor' from previous response. |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_comment_replies
scrapecreators-cli tiktok-comment-replies
Argument | Required | Type | Details |
| Yes | string | TikTok comment ID. This is the cid from the comments endpoint. |
| Yes | string | TikTok video URL. This is the url from the comments endpoint. |
| No; body/guard rules apply | number | Cursor to get more replies. Get 'cursor' from previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_following
scrapecreators-cli tiktok-following
Argument | Required | Type | Details |
| Yes | string | TikTok handle |
| No; body/guard rules apply | number | Used to paginate. Get 'min_time' from previous response. |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_followers
scrapecreators-cli tiktok-followers
Argument | Required | Type | Details |
| No; body/guard rules apply | string | TikTok handle |
| No; body/guard rules apply | string | User id. Use this for faster response times. |
| No; body/guard rules apply | number | Used to paginate. Get 'min_time' from previous response. |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_search_users
scrapecreators-cli tiktok-search-users
Argument | Required | Type | Details |
| Yes | string | Search query for users |
| No; body/guard rules apply | number | Cursor to get more users. Get 'cursor' from previous response. |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_search_suggestions
scrapecreators-cli tiktok-search-suggestions
Argument | Required | Type | Details |
| Yes | string | Search query to get suggestions for |
| No; body/guard rules apply | string | Region code for suggestions |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_search_by_hashtag
scrapecreators-cli tiktok-search-by-hashtag
Argument | Required | Type | Details |
| Yes | string | Hashtag to search for (without #) |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | number | Cursor to get more videos. Get 'cursor' from previous response. |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_search_by_keyword
scrapecreators-cli tiktok-search-by-keyword
Argument | Required | Type | Details |
| Yes | string | Keyword to search for |
| No; body/guard rules apply | string | Time Frame Values: |
| No; body/guard rules apply | string | Sort by Values: |
| No; body/guard rules apply | string | 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 |
| No; body/guard rules apply | number | Cursor to get more videos. Get 'cursor' from previous response. |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_top_search
scrapecreators-cli tiktok-top-search
Argument | Required | Type | Details |
| Yes | string | Keyword to search for |
| No; body/guard rules apply | string | Time Frame TikTok was posted Values: |
| No; body/guard rules apply | string | Sort by Values: |
| No; body/guard rules apply | string | 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 |
| No; body/guard rules apply | number | Cursor to get more videos. Get 'cursor' from previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_get_popular_creators
scrapecreators-cli tiktok-get-popular-creators
Argument | Required | Type | Details |
| No; body/guard rules apply | number | Page number |
| No; body/guard rules apply | string | Sort creators by engagement, follower count, or average views Values: |
| No; body/guard rules apply | string | Filter by follower count range Values: |
| No; body/guard rules apply | string | Country code of the creator Values: |
| No; body/guard rules apply | string | Country code of the audience/follower Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_get_song_details
scrapecreators-cli tiktok-get-song-details
Argument | Required | Type | Details |
| Yes | string | 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 🤷♂️ |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_tiktoks_using_song
scrapecreators-cli tiktok-tiktoks-using-song
Argument | Required | Type | Details |
| No; body/guard rules apply | string | 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 |
| No; body/guard rules apply | number | The cursor to get the next page of results. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_trending_feed
scrapecreators-cli tiktok-trending-feed
Argument | Required | Type | Details |
| Yes | string | 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. |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_shop_shop_search
scrapecreators-cli tiktok-shop-shop-search
Argument | Required | Type | Details |
| Yes | string | Term you want to search for |
| No; body/guard rules apply | number | Page number to retrieve |
| No; body/guard rules apply | string | 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: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_shop_shop_products
scrapecreators-cli tiktok-shop-shop-products
Argument | Required | Type | Details |
| Yes | string | The TikTok Shop store URL. |
| No; body/guard rules apply | string | Cursor parameter from the previous response to retrieve the next page of products. Omit for the first page. |
| No; body/guard rules apply | string | Sort products by best-selling items ( |
| No; body/guard rules apply | string | Region to get shop products from. Defaults to US if not provided. Non-US regions are not reliable right now and may return |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_shop_product_details
scrapecreators-cli tiktok-shop-product-details
Argument | Required | Type | Details |
| Yes | string | The URL of the product to get details for. |
| No; body/guard rules apply | string | Region for the product details request. US is the reliable region right now; non-US regions should not be considered reliable and may return |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_shop_product_reviews
scrapecreators-cli tiktok-shop-product-reviews
Argument | Required | Type | Details |
| No; body/guard rules apply | string | The URL of the product (required if product_id is not provided) |
| No; body/guard rules apply | string | The ID of the product (required if url is not provided) |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | number | The page number of the reviews |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_shop_user_showcase
scrapecreators-cli tiktok-shop-user-showcase
Argument | Required | Type | Details |
| Yes | string | The handle of the user |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | string | The cursor to the next page of products |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_profile
scrapecreators-cli instagram-profile
Argument | Required | Type | Details |
| Yes | string | Instagram handle |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_basic_profile
scrapecreators-cli instagram-basic-profile
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Instagram user id |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_posts
scrapecreators-cli instagram-posts
Argument | Required | Type | Details |
| Yes | string | Instagram handle |
| No; body/guard rules apply | string | Cursor to get next page of results. |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_user_tagged_posts
scrapecreators-cli instagram-user-tagged-posts
Argument | Required | Type | Details |
| Yes | string | Numeric Instagram user ID. |
| No; body/guard rules apply | string | Cursor returned by the previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_reels
scrapecreators-cli instagram-reels
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Instagram user id. Use this for faster response times. |
| No; body/guard rules apply | string | Instagram handle. Use user_id for faster response times. |
| No; body/guard rules apply | string | Max id to get more reels. Get 'max_id' from previous response. |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_post_reel_info
scrapecreators-cli instagram-post-reel-info
Argument | Required | Type | Details |
| Yes | string | Instagram post or reel URL |
| No; body/guard rules apply | string | 2 letter country code to set the proxy in |
| No; body/guard rules apply | boolean | Set to true to get a trimmed response |
| No; body/guard rules apply | boolean | Set to true to download the video/images and get back permanent Supabase URLs. Costs 10 credits if media is found, 1 credit otherwise. |
| No; body/guard rules apply | boolean | Set to false to omit |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_transcript
scrapecreators-cli instagram-transcript
Argument | Required | Type | Details |
| Yes | string | Instagram post or reel URL |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_search_instagram
scrapecreators-cli instagram-search-instagram
Argument | Required | Type | Details |
| Yes | string | The username, hashtag, place, or keyword to search for. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_popular_search
scrapecreators-cli instagram-popular-search
Argument | Required | Type | Details |
| Yes | string | The Popular topic to search for. |
| No; body/guard rules apply | string | The opaque cursor returned by the previous response. Use it with the same query to fetch the next page of posts. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_search_hashtag_posts
scrapecreators-cli instagram-search-hashtag-posts
Argument | Required | Type | Details |
| Yes | string | The hashtag to search for. Include or omit the #. |
| No; body/guard rules apply | string | Only return Google-indexed posts found in this relative window. Values: |
| No; body/guard rules apply | string | Use all to search public posts and reels, or reels to only return reels. Defaults to all. Values: |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_search_instagram_profiles
scrapecreators-cli instagram-search-instagram-profiles
Argument | Required | Type | Details |
| Yes | string | The profile name or username to search for. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_search_reels
scrapecreators-cli instagram-search-reels
Argument | Required | Type | Details |
| Yes | string | The keyword to search for |
| No; body/guard rules apply | string | Google-indexed date window. Recent hour/day filters are not supported because Google does not index Instagram reels reliably enough in those windows. Values: |
| No; body/guard rules apply | number | The page number to return. Must be between 1 and 11; page 12 or greater returns a 400 response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_get_reels_by_audio_id
scrapecreators-cli instagram-get-reels-by-audio-id
Argument | Required | Type | Details |
| Yes | string | The audio id from the Instagram audio page URL. |
| No; body/guard rules apply | string | Pagination cursor returned by Instagram from the previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_trending_reels
scrapecreators-cli instagram-trending-reels
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_comments
scrapecreators-cli instagram-comments
Argument | Required | Type | Details |
| Yes | string | The URL of the post or reel to get comments from |
| No; body/guard rules apply | string | The cursor to get more comments. Get 'cursor' from previous response. |
| No; body/guard rules apply | boolean | 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. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_comment_replies
scrapecreators-cli instagram-comment-replies
Argument | Required | Type | Details |
| Yes | string | The Instagram post or reel URL |
| Yes | string | The parent comment ID from the Comments endpoint |
| No; body/guard rules apply | string | The cursor to get more replies. Get |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_story_highlights
scrapecreators-cli instagram-story-highlights
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Instagram user id. Use for faster response times. |
| No; body/guard rules apply | string | Instagram handle. Use user_id for faster response times. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_highlights_details
scrapecreators-cli instagram-highlights-details
Argument | Required | Type | Details |
| No; body/guard rules apply | string | The ID of the highlight to get details for |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_profile_post_count
scrapecreators-cli instagram-profile-post-count
Argument | Required | Type | Details |
| Yes | string | Instagram handle |
| No; body/guard rules apply | boolean | 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. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
instagram_embed_html
scrapecreators-cli instagram-embed-html
Argument | Required | Type | Details |
| Yes | string | Instagram handle |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
telegram_channel_details
scrapecreators-cli telegram-channel-details
Argument | Required | Type | Details |
| Yes | string | Public Telegram handle, @handle, or t.me channel URL. |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
telegram_channel_posts
scrapecreators-cli telegram-channel-posts
Argument | Required | Type | Details |
| Yes | string | Public Telegram handle, @handle, or t.me channel URL. |
| No; body/guard rules apply | string | Numeric cursor returned by the previous page. Omit it for the latest posts. |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
telegram_post_details
scrapecreators-cli telegram-post-details
Argument | Required | Type | Details |
| Yes | string | Public Telegram post URL. |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_channel_details
scrapecreators-cli youtube-channel-details
Argument | Required | Type | Details |
| No; body/guard rules apply | string | YouTube channel ID. Can pass a channelId, handle or url |
| No; body/guard rules apply | string | YouTube channel handle. Can pass a channelId, handle or url |
| No; body/guard rules apply | string | YouTube channel URL. Can pass a channelId, handle or url |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_channel_videos
scrapecreators-cli youtube-channel-videos
Argument | Required | Type | Details |
| No; body/guard rules apply | string | YouTube channel ID |
| No; body/guard rules apply | string | YouTube channel handle |
| No; body/guard rules apply | string | Sort by latest or popular Values: |
| No; body/guard rules apply | string | Continuation token to get more videos. Get 'continuationToken' from previous response. |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_channel_playlists
scrapecreators-cli youtube-channel-playlists
Argument | Required | Type | Details |
| No; body/guard rules apply | string | YouTube channel ID |
| No; body/guard rules apply | string | YouTube channel handle |
| No; body/guard rules apply | string | Continuation token to get more playlists. Get 'continuationToken' from previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_channel_lives
scrapecreators-cli youtube-channel-lives
Argument | Required | Type | Details |
| No; body/guard rules apply | string | YouTube channel ID |
| No; body/guard rules apply | string | YouTube channel handle |
| No; body/guard rules apply | string | Continuation token to get more lives. Get 'continuationToken' from previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_channel_community_posts
scrapecreators-cli youtube-channel-community-posts
Argument | Required | Type | Details |
| No; body/guard rules apply | string | YouTube channel ID |
| No; body/guard rules apply | string | YouTube channel handle |
| No; body/guard rules apply | string | Continuation token to get more community posts. Get 'continuationToken' from previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_channel_shorts
scrapecreators-cli youtube-channel-shorts
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Can pass channelId or handle |
| No; body/guard rules apply | string | Can pass channelId or handle |
| No; body/guard rules apply | string | Sort by newest or popular Values: |
| No; body/guard rules apply | string | Continuation token to get more videos. Get 'continuationToken' from previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_video_short_details
scrapecreators-cli youtube-video-short-details
Argument | Required | Type | Details |
| Yes | string | YouTube video or short URL |
| No; body/guard rules apply | string | Preferred response language (mapped to Accept-Language header; not guaranteed due to YouTube localization behavior). 2 letter language code, ie 'en', 'es', 'fr' etc. |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_transcript
scrapecreators-cli youtube-transcript
Argument | Required | Type | Details |
| Yes | string | YouTube video or short URL |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | boolean | 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. |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_video_sponsors
scrapecreators-cli youtube-video-sponsors
Argument | Required | Type | Details |
| Yes | string | YouTube video or short URL |
| No; body/guard rules apply | string | 2 letter language code used for transcript lookup, ie 'en', 'es', 'fr' etc. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_search
scrapecreators-cli youtube-search
Argument | Required | Type | Details |
| Yes | string | 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. |
| No; body/guard rules apply | string | Upload date Values: |
| No; body/guard rules apply | string | Sort by Values: |
| No; body/guard rules apply | string | Type of content to search for Values: |
| No; body/guard rules apply | string | Duration of the video. Only applies to videos (not shorts). Values: |
| No; body/guard rules apply | string | 2 letter country code of the country to put the proxy in. |
| No; body/guard rules apply | string | Continuation token to get more videos. Get 'continuationToken' from previous response. |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_search_typeahead
scrapecreators-cli youtube-search-typeahead
Argument | Required | Type | Details |
| Yes | string | Partial or complete YouTube search query |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_search_by_hashtag
scrapecreators-cli youtube-search-by-hashtag
Argument | Required | Type | Details |
| Yes | string | Hashtag to search for |
| No; body/guard rules apply | string | Continuation token to get more videos. Get 'continuationToken' from previous response. |
| No; body/guard rules apply | string | Search for all types of content or only shorts Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_comments
scrapecreators-cli youtube-comments
Argument | Required | Type | Details |
| Yes | string | YouTube video URL |
| No; body/guard rules apply | string | Continuation token to get more comments. Get 'continuationToken' from previous response. |
| No; body/guard rules apply | string | Order of comments Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_comment_replies
scrapecreators-cli youtube-comment-replies
Argument | Required | Type | Details |
| Yes | string | Continuation token for the comment replies. Use 'repliesContinuationToken' from the Comments endpoint, or 'continuationToken' from a previous replies response to paginate. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_trending_shorts
scrapecreators-cli youtube-trending-shorts
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_playlist
scrapecreators-cli youtube-playlist
Argument | Required | Type | Details |
| Yes | string | The ID of the YouTube playlist. In the YouTube URL it will be the 'list' parameter. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
youtube_community_post_details
scrapecreators-cli youtube-community-post-details
Argument | Required | Type | Details |
| Yes | string | The URL of the YouTube community post to get |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
rumble_search
scrapecreators-cli rumble-search
Argument | Required | Type | Details |
| Yes | string | Search query. |
| No; body/guard rules apply | string | Cursor from the previous response. This is the next page number, like 2 or 3. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
rumble_channel_videos
scrapecreators-cli rumble-channel-videos
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Rumble channel handle. If you'd prefer to use the URL instead, use the url parameter. |
| No; body/guard rules apply | string | Rumble channel URL. If you'd prefer to use the handle instead, use the handle parameter. |
| No; body/guard rules apply | string | Cursor from the previous response. This is the next page number, like 2 or 3. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
rumble_video
scrapecreators-cli rumble-video
Argument | Required | Type | Details |
| Yes | string | Rumble video URL. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
rumble_transcript
scrapecreators-cli rumble-transcript
Argument | Required | Type | Details |
| Yes | string | Rumble video URL. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
rumble_comments
scrapecreators-cli rumble-comments
Argument | Required | Type | Details |
| Yes | string | Rumble video URL. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
linkedin_person_profile
scrapecreators-cli linkedin-person-profile
Argument | Required | Type | Details |
| Yes | string | The URL of the LinkedIn profile to get |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
linkedin_company_page
scrapecreators-cli linkedin-company-page
Argument | Required | Type | Details |
| Yes | string | The URL of the LinkedIn company page to get |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
linkedin_company_posts
scrapecreators-cli linkedin-company-posts
Argument | Required | Type | Details |
| Yes | string | The URL of the LinkedIn company page to get |
| No; body/guard rules apply | number | The page number to get |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
linkedin_search_posts
scrapecreators-cli linkedin-search-posts
Argument | Required | Type | Details |
| Yes | string | Keyword or phrase to search for in public LinkedIn posts |
| No; body/guard rules apply | string | Date posted filter based on Google-indexed results Values: |
| No; body/guard rules apply | string | The cursor returned from the previous response. The maximum cursor is 11; cursor 12 or greater returns a 400 response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
linkedin_post
scrapecreators-cli linkedin-post
Argument | Required | Type | Details |
| Yes | string | The URL of the LinkedIn post to get |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
linkedin_post_transcript
scrapecreators-cli linkedin-post-transcript
Argument | Required | Type | Details |
| Yes | string | The URL of the LinkedIn post to get the transcript from |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_profile
scrapecreators-cli facebook-profile
Argument | Required | Type | Details |
| Yes | string | Facebook profile URL |
| No; body/guard rules apply | string | Get the business's hours |
| No; body/guard rules apply | string | When true, returns limited public fields for gated or age-restricted profiles. Ignored for normal public profiles — those still return the full response. |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_profile_reels
scrapecreators-cli facebook-profile-reels
Argument | Required | Type | Details |
| Yes | string | Facebook page URL |
| No; body/guard rules apply | string | To paginate through to the next page |
| No; body/guard rules apply | string | To paginate through to the next page |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_profile_photos
scrapecreators-cli facebook-profile-photos
Argument | Required | Type | Details |
| Yes | string | Facebook page URL |
| No; body/guard rules apply | string | To paginate through to the next page |
| No; body/guard rules apply | string | To paginate through to the next page |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_profile_posts
scrapecreators-cli facebook-profile-posts
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Facebook profile URL |
| No; body/guard rules apply | string | Facebook profile page id |
| No; body/guard rules apply | string | To paginate through the posts |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_profile_events
scrapecreators-cli facebook-profile-events
Argument | Required | Type | Details |
| Yes | string | The URL of the public Facebook page |
| No; body/guard rules apply | string | The cursor to paginate to get more events |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_post
scrapecreators-cli facebook-post
Argument | Required | Type | Details |
| Yes | string | The URL of the post to get |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_transcript
scrapecreators-cli facebook-transcript
Argument | Required | Type | Details |
| Yes | string | Facebook post URL |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_comments
scrapecreators-cli facebook-comments
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Facebook post URL (or reel URL) |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | string | Cursor to get more comments. Get 'cursor' from previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_comment_replies
scrapecreators-cli facebook-comment-replies
Argument | Required | Type | Details |
| Yes | string | 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. |
| Yes | string | The expansion_token of the comment. You can get the expansion_token from the /v1/facebook/post/comments endpoint. |
| No; body/guard rules apply | string | The cursor to paginate to the next page |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_facebook_group_info
scrapecreators-cli facebook-facebook-group-info
Argument | Required | Type | Details |
| No; body/guard rules apply | string | The Facebook group URL. Group sub-page URLs such as /about work too. |
| No; body/guard rules apply | string | The numeric Facebook group ID. Provide this instead of url if you already have it. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_facebook_group_posts
scrapecreators-cli facebook-facebook-group-posts
Argument | Required | Type | Details |
| No; body/guard rules apply | string | The URL of the group |
| No; body/guard rules apply | string | The ID of the group |
| No; body/guard rules apply | string | How to sort the posts. Defaults to CHRONOLOGICAL. Values: |
| No; body/guard rules apply | string | The cursor to paginate to the next page |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
github_user
scrapecreators-cli github-user
Argument | Required | Type | Details |
| No; body/guard rules apply | string | GitHub username/handle of the user you want the details for |
| No; body/guard rules apply | string | GitHub user URL, e.g. https://github.com/torvalds. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
github_repositories
scrapecreators-cli github-repositories
Argument | Required | Type | Details |
| No; body/guard rules apply | string | GitHub username/handle of the user you want the repositories for |
| No; body/guard rules apply | string | GitHub user URL, e.g. https://github.com/kentcdodds. |
| No; body/guard rules apply | string | Repository type. Defaults to owner. GitHub also supports all and member. Values: |
| No; body/guard rules apply | string | Sort by created, updated, pushed, or full_name. Defaults to updated. Values: |
| No; body/guard rules apply | string | Sort direction: ascending or descending. Values: |
| No; body/guard rules apply | number | Cursor from the previous response. Defaults to 1. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
github_pull_requests
scrapecreators-cli github-pull-requests
Argument | Required | Type | Details |
| Yes | string | GitHub username/handle of the user you want pull requests for |
| No; body/guard rules apply | string | Only return pull requests created on or after this date. Use YYYY-MM-DD. |
| No; body/guard rules apply | string | Only return pull requests created on or before this date. Use YYYY-MM-DD. |
| No; body/guard rules apply | number | Cursor from the previous response. Defaults to 1. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
github_activity
scrapecreators-cli github-activity
Argument | Required | Type | Details |
| No; body/guard rules apply | string | GitHub handle |
| No; body/guard rules apply | string | GitHub user URL, e.g. https://github.com/kentcdodds. |
| No; body/guard rules apply | number | When provided, returns profile contribution activity for that year. Defaults to the current year. |
| No; body/guard rules apply | number | Cursor from the previous response. Pages backward by month through the selected year. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
github_followers
scrapecreators-cli github-followers
Argument | Required | Type | Details |
| No; body/guard rules apply | string | GitHub username/handle of the user you want the followers for |
| No; body/guard rules apply | string | GitHub user URL, e.g. https://github.com/torvalds. |
| No; body/guard rules apply | number | Cursor from the previous response. Defaults to 1. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
github_following
scrapecreators-cli github-following
Argument | Required | Type | Details |
| No; body/guard rules apply | string | GitHub handle |
| No; body/guard rules apply | string | GitHub profile URL |
| No; body/guard rules apply | number | Cursor from the previous response. Defaults to 1. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
github_contributions
scrapecreators-cli github-contributions
Argument | Required | Type | Details |
| No; body/guard rules apply | string | GitHub handle |
| No; body/guard rules apply | string | GitHub profile URL |
| No; body/guard rules apply | number | Contribution graph year. Defaults to the current year. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
github_repository
scrapecreators-cli github-repository
Argument | Required | Type | Details |
| Yes | string | GitHub repository URL |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
github_trending_repositories
scrapecreators-cli github-trending-repositories
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Optional coding language, e.g. javascript, python, or go. |
| No; body/guard rules apply | string | Trending range: daily, weekly, or monthly. Defaults to daily. Values: |
| No; body/guard rules apply | string | Optional spoken language code filter, e.g. en. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
github_trending_developers
scrapecreators-cli github-trending-developers
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Optional trending coding language, e.g. javascript, python, or go. |
| No; body/guard rules apply | string | Trending range: daily, weekly, or monthly. Defaults to daily. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_marketplace_marketplace_location_search
scrapecreators-cli facebook-marketplace-marketplace-location-search
Argument | Required | Type | Details |
| Yes | string | Location search query |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_marketplace_marketplace_search
scrapecreators-cli facebook-marketplace-marketplace-search
Argument | Required | Type | Details |
| Yes | string | Search keyword |
| No; body/guard rules apply | string | Numeric Facebook Marketplace category ID. Listing results include this value as category_id. |
| Yes | number | Latitude for the search location |
| Yes | number | Longitude for the search location |
| No; body/guard rules apply | number | Search radius in kilometers |
| No; body/guard rules apply | number | Minimum listing price |
| No; body/guard rules apply | number | Maximum listing price |
| No; body/guard rules apply | string | 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: |
| No; body/guard rules apply | string | Delivery filter Values: |
| No; body/guard rules apply | string | Condition filter Values: |
| No; body/guard rules apply | string | 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: |
| No; body/guard rules apply | string | Availability filter Values: |
| No; body/guard rules apply | string | Opaque pagination cursor returned from the previous response. Pass it back as-is. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_marketplace_marketplace_item
scrapecreators-cli facebook-marketplace-marketplace-item
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Facebook Marketplace item id |
| No; body/guard rules apply | string | Facebook Marketplace item URL |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_events_search_events
scrapecreators-cli facebook-events-search-events
Argument | Required | Type | Details |
| Yes | string | The query to search for |
| No; body/guard rules apply | string | The cursor to paginate to the next page |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_events_events
scrapecreators-cli facebook-events-events
Argument | Required | Type | Details |
| Yes | string | The URL of the city's Facebook Events page |
| No; body/guard rules apply | string | The time frame to search for. Defaults to all time Values: |
| No; body/guard rules apply | string | The cursor to paginate to the next page |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_events_event_details
scrapecreators-cli facebook-events-event-details
Argument | Required | Type | Details |
| No; body/guard rules apply | string | The ID of the event |
| No; body/guard rules apply | string | The URL of the event |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_ad_library_ad_details
scrapecreators-cli facebook-ad-library-ad-details
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Facebook Ad Id |
| No; body/guard rules apply | string | Facebook Ad URL |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_ad_library_ad_transcript
scrapecreators-cli facebook-ad-library-ad-transcript
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Facebook Ad Id |
| No; body/guard rules apply | string | Facebook Ad URL |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_ad_library_search
scrapecreators-cli facebook-ad-library-search
Argument | Required | Type | Details |
| Yes | string | Keyword to search for |
| No; body/guard rules apply | string | Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. Values: |
| No; body/guard rules apply | string | If you want to search by exact phrase or not Values: |
| No; body/guard rules apply | string | Search for all ads or only political and issue ads Values: |
| No; body/guard rules apply | string | This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. |
| No; body/guard rules apply | string | Language to filter ads on. Needs to be a 2 letter language code, such as EN, ES, or FR. |
| No; body/guard rules apply | string | Status of the ad. Defaults to ACTIVE. Values: |
| No; body/guard rules apply | string | 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: |
| No; body/guard rules apply | string | Impressions start date. Needs to be in YYYY-MM-DD format. |
| No; body/guard rules apply | string | Impressions end date. Needs to be in YYYY-MM-DD format. |
| No; body/guard rules apply | string | Cursor to paginate through results |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
facebook_ad_library_search_post
scrapecreators-cli facebook-ad-library-search-post
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Keyword to search for |
| No; body/guard rules apply | string | Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. Values: |
| No; body/guard rules apply | string | If you want to search by exact phrase or not Values: |
| No; body/guard rules apply | string | Search for all ads or only political and issue ads Values: |
| No; body/guard rules apply | string | This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. |
| No; body/guard rules apply | string | Language to filter ads on. Needs to be a 2 letter language code, such as EN, ES, or FR. |
| No; body/guard rules apply | string | Status of the ad. Defaults to ACTIVE. Values: |
| No; body/guard rules apply | string | 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: |
| No; body/guard rules apply | string | Impressions start date. Needs to be in YYYY-MM-DD format. |
| No; body/guard rules apply | string | Impressions end date. Needs to be in YYYY-MM-DD format. |
| No; body/guard rules apply | string | Cursor to paginate through results |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body/guard rules apply | object | Complete JSON request body instead of body flags. Preserves current endpoint fields and values. |
| No; body/guard rules apply | string | 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
Argument | Required | Type | Details |
| No; body/guard rules apply | string | The companies ad library page id. You can get this with my Search For Companies Endpoint. Can either use this or companyName |
| No; body/guard rules apply | string | The name of the company. Can either use this or pageId |
| No; body/guard rules apply | string | This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. |
| No; body/guard rules apply | string | Status of the ad. Defaults to ACTIVE. Values: |
| No; body/guard rules apply | string | Media type of the ad. Defaults to ALL. Meme refers to ads with image and text. Not sure why they call it meme. Values: |
| No; body/guard rules apply | string | Language to filter ads on. Needs to be 2 letter language code, ie EN, ES, FR, etc |
| No; body/guard rules apply | string | Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. Values: |
| No; body/guard rules apply | string | Start date to search for. Format: YYYY-MM-DD |
| No; body/guard rules apply | string | End date to search for. Format: YYYY-MM-DD |
| No; body/guard rules apply | string | Cursor to paginate through results |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
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
Argument | Required | Type | Details |
| No; body/guard rules apply | string | The companies ad library page id. You can get this with my Search For Companies Endpoint. Can either use this or companyName |
| No; body/guard rules apply | string | The name of the company. Can either use this or pageId |
| No; body/guard rules apply | string | This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. |
| No; body/guard rules apply | string | Status of the ad. Defaults to ACTIVE. Values: |
| No; body/guard rules apply | string | Media type of the ad. Defaults to ALL. Meme refers to ads with image and text. Not sure why they call it meme. Values: |
| No; body/guard rules apply | string | Language to filter ads on. Needs to be 2 letter language code, ie EN, ES, FR, etc |
| No; body/guard rules apply | string | Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. Values: |
| No; body/guard rules apply | string | Start date to search for. Format: YYYY-MM-DD |
| No; body/guard rules apply | string | End date to search for. Format: YYYY-MM-DD |
| No; body/guard rules apply | string | Cursor to paginate through results |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body/guard rules apply | object | Complete JSON request body instead of body flags. Preserves current endpoint fields and values. |
| No; body/guard rules apply | string | 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
Argument | Required | Type | Details |
| Yes | string | Keyword to search for |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_ad_library_ad_library_search
scrapecreators-cli tiktok-ad-library-ad-library-search
Argument | Required | Type | Details |
| No; body/guard rules apply | string | General ad search. Provide either query or advertiser_name, not both. |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | string | Opaque cursor returned from the previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
tiktok_ad_library_ad_library_ad
scrapecreators-cli tiktok-ad-library-ad-library-ad
Argument | Required | Type | Details |
| Yes | string | Creative Center Top Ads material ID or URL, or a public Ads Library ad ID or library.tiktok.com detail URL. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
google_ad_library_company_ads
scrapecreators-cli google-ad-library-company-ads
Argument | Required | Type | Details |
| No; body/guard rules apply | string | The domain of the company |
| No; body/guard rules apply | string | The advertiser id of the company |
| No; body/guard rules apply | string | The topic to search for. If you search for 'political', you will also need to pass a 'region', like 'US' or 'AU' Values: |
| No; body/guard rules apply | string | The region to search for. Defaults to anywhere |
| No; body/guard rules apply | string | Start date to search for. Format: YYYY-MM-DD |
| No; body/guard rules apply | string | End date to search for. Format: YYYY-MM-DD |
| No; body/guard rules apply | string | Platform to search for. Values: |
| No; body/guard rules apply | string | Ad format to search for. Values: |
| No; body/guard rules apply | string | Set to true to get the ad details. Will cost 25 credits. |
| No; body/guard rules apply | string | Cursor to paginate through results |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
google_ad_library_ad_details
scrapecreators-cli google-ad-library-ad-details
Argument | Required | Type | Details |
| Yes | string | The url of the ad |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
google_ad_library_advertiser_search
scrapecreators-cli google-ad-library-advertiser-search
Argument | Required | Type | Details |
| Yes | string | The query to search for |
| No; body/guard rules apply | string | 2-letter country code to search in. Defaults to US when omitted. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
linkedin_ad_library_search_ads
scrapecreators-cli linkedin-ad-library-search-ads
Argument | Required | Type | Details |
| No; body/guard rules apply | string | The company name to search for. 'Microsoft' for example |
| No; body/guard rules apply | string | The keyword to search for |
| No; body/guard rules apply | string | The company id to search for |
| No; body/guard rules apply | string | Comma separated list of countries. Example: US,CA,MX |
| No; body/guard rules apply | string | Start date in YYYY-MM-DD format. Must be used with endDate and cannot be earlier than the date one year ago. |
| No; body/guard rules apply | string | End date in YYYY-MM-DD format. Must be used with startDate and cannot be today or a future date. |
| No; body/guard rules apply | string | Pagination token to paginate through results |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
linkedin_ad_library_ad_details
scrapecreators-cli linkedin-ad-library-ad-details
Argument | Required | Type | Details |
| Yes | string | The url of the ad |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitter_profile
scrapecreators-cli twitter-profile
Argument | Required | Type | Details |
| Yes | string | Twitter handle |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitter_user_tweets
scrapecreators-cli twitter-user-tweets
Argument | Required | Type | Details |
| Yes | string | Twitter handle |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitter_tweet_details
scrapecreators-cli twitter-tweet-details
Argument | Required | Type | Details |
| Yes | string | Tweet URL |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitter_transcript
scrapecreators-cli twitter-transcript
Argument | Required | Type | Details |
| Yes | string | Tweet URL |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitter_community
scrapecreators-cli twitter-community
Argument | Required | Type | Details |
| Yes | string | Community URL |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitter_community_tweets
scrapecreators-cli twitter-community-tweets
Argument | Required | Type | Details |
| Yes | string | Community URL |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
reddit_subreddit_details
scrapecreators-cli reddit-subreddit-details
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Subreddit name. MUST be case sensitive. So 'AskReddit' not 'askreddit'. |
| No; body/guard rules apply | string | Subreddit URL |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
reddit_subreddit_posts
scrapecreators-cli reddit-subreddit-posts
Argument | Required | Type | Details |
| Yes | string | Subreddit name |
| No; body/guard rules apply | string | Timeframe to get posts from Values: |
| No; body/guard rules apply | string | Sort order Values: |
| No; body/guard rules apply | string | After to get more posts. Get 'after' from previous response. |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
reddit_subreddit_search
scrapecreators-cli reddit-subreddit-search
Argument | Required | Type | Details |
| Yes | string | Subreddit name (e.g. 'Fitness', not 'r/Fitness' or a full URL) |
| No; body/guard rules apply | string | Search query to find matching content |
| No; body/guard rules apply | string | Sort order. For posts/media: relevance, hot, top, new, comments. For comments: relevance, top, new Values: |
| No; body/guard rules apply | string | Timeframe to filter results Values: |
| No; body/guard rules apply | string | Cursor to get more results. Get 'cursor' from previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
reddit_post
scrapecreators-cli reddit-post
Argument | Required | Type | Details |
| Yes | string | Reddit post URL |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
reddit_post_comments
scrapecreators-cli reddit-post-comments
Argument | Required | Type | Details |
| Yes | string | Reddit post URL |
| No; body/guard rules apply | string | One opaque cursor returned by the previous response to get more comments or replies. Do not combine multiple cursors. |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
reddit_post_comments_post
scrapecreators-cli reddit-post-comments-post
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Reddit post URL |
| No; body/guard rules apply | string | One opaque cursor returned by the previous response to get more comments or replies. Do not combine multiple cursors. |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
| No; body/guard rules apply | object | Complete JSON request body instead of body flags. Preserves current endpoint fields and values. |
| No; body/guard rules apply | string | 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
Argument | Required | Type | Details |
| Yes | string | Reddit post URL or direct v.redd.it video URL |
| No; body/guard rules apply | string | 2 letter language code. Defaults to en. |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
reddit_search
scrapecreators-cli reddit-search
Argument | Required | Type | Details |
| Yes | string | Search query |
| No; body/guard rules apply | string | Search posts or comments Values: |
| No; body/guard rules apply | string | Sort by. Comment search supports relevance, new, and top; comment_count is for post search only. Values: |
| No; body/guard rules apply | string | Post search timeframe Values: |
| No; body/guard rules apply | string | Used to paginate to next page |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
truth_social_profile
scrapecreators-cli truth-social-profile
Argument | Required | Type | Details |
| Yes | string | Truth Social username |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
truth_social_user_posts
scrapecreators-cli truth-social-user-posts
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Truth Social username |
| No; body/guard rules apply | string | Truth Social user id. Use this for faster response times. Trumps is 107780257626128497. It is the 'id' field in the profile endpoint. |
| No; body/guard rules apply | string | Used to paginate to next page |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
truth_social_post
scrapecreators-cli truth-social-post
Argument | Required | Type | Details |
| Yes | string | Truth Social post URL |
| No; body/guard rules apply | boolean | 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. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
threads_profile
scrapecreators-cli threads-profile
Argument | Required | Type | Details |
| Yes | string | Threads username |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
threads_posts
scrapecreators-cli threads-posts
Argument | Required | Type | Details |
| Yes | string | Threads username |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
threads_post
scrapecreators-cli threads-post
Argument | Required | Type | Details |
| Yes | string | The URL of the post to get |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
threads_search_by_keyword
scrapecreators-cli threads-search-by-keyword
Argument | Required | Type | Details |
| Yes | string | Keyword to search for |
| No; body/guard rules apply | string | Start date to search for |
| No; body/guard rules apply | string | End date to search for |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
threads_search_users
scrapecreators-cli threads-search-users
Argument | Required | Type | Details |
| Yes | string | Username to search for |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
bluesky_profile
scrapecreators-cli bluesky-profile
Argument | Required | Type | Details |
| Yes | string | Bluesky handle |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
bluesky_posts
scrapecreators-cli bluesky-posts
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Bluesky handle |
| No; body/guard rules apply | string | Bluesky 'did'. (For some reason Bluesky calls their user ids, 'did' for whatever reason) |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
bluesky_post
scrapecreators-cli bluesky-post
Argument | Required | Type | Details |
| Yes | string | Bluesky post URL |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
pinterest_search
scrapecreators-cli pinterest-search
Argument | Required | Type | Details |
| Yes | string | Search query |
| No; body/guard rules apply | string | Cursor |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
pinterest_pin
scrapecreators-cli pinterest-pin
Argument | Required | Type | Details |
| Yes | string | Pinterest pin URL |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
pinterest_user_boards
scrapecreators-cli pinterest-user-boards
Argument | Required | Type | Details |
| Yes | string | The username of the user to get boards for. (e.g. broadstbullycom from https://www.pinterest.com/broadstbullycom/) |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
pinterest_board
scrapecreators-cli pinterest-board
Argument | Required | Type | Details |
| Yes | string | The URL of the board to get |
| No; body/guard rules apply | string | The cursor to get the next page of results |
| No; body/guard rules apply | boolean | Set to true for a trimmed down version of the response |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
google_search
scrapecreators-cli google-search
Argument | Required | Type | Details |
| Yes | string | Search query |
| No; body/guard rules apply | string | 2 letter country code, ie US, UK, CA, etc This will show results from that country |
| No; body/guard rules apply | string | Date posted Values: |
| No; body/guard rules apply | number | Page number to retrieve. Must be between 1 and 11; page 12 or greater returns a 400 response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitch_profile
scrapecreators-cli twitch-profile
Argument | Required | Type | Details |
| Yes | string | Twitch handle |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitch_user_videos
scrapecreators-cli twitch-user-videos
Argument | Required | Type | Details |
| Yes | string | Twitch handle |
| No; body/guard rules apply | string | Filter by Values: |
| No; body/guard rules apply | string | Sort by Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitch_user_schedule
scrapecreators-cli twitch-user-schedule
Argument | Required | Type | Details |
| Yes | string | Twitch handle |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitch_clip_transcript
scrapecreators-cli twitch-clip-transcript
Argument | Required | Type | Details |
| Yes | string | Twitch clip URL |
| No; body/guard rules apply | boolean | Use AI transcription only when native captions are unavailable. Costs 10 credits when an AI transcript is returned. Defaults to false. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
twitch_clip
scrapecreators-cli twitch-clip
Argument | Required | Type | Details |
| Yes | string | Twitch clip URL |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
apple_music_artist
scrapecreators-cli apple-music-artist
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Apple Music artist id. If you'd prefer to use the URL instead, you can use the url parameter instead. |
| No; body/guard rules apply | string | Apple Music artist URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
apple_music_album
scrapecreators-cli apple-music-album
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Apple Music album id. If you'd prefer to use the URL instead, you can use the url parameter instead. |
| No; body/guard rules apply | string | Apple Music album URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
apple_music_track
scrapecreators-cli apple-music-track
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Apple Music song id. Some songs have standalone song URLs; for album tracks, use the url parameter. |
| No; body/guard rules apply | string | Apple Music song URL or album track URL. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
apple_music_search
scrapecreators-cli apple-music-search
Argument | Required | Type | Details |
| Yes | string | Search query |
| No; body/guard rules apply | string | Result type to return. Use all, song, album, artist, playlist, station, music_video, or radio_episode. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
spotify_artist
scrapecreators-cli spotify-artist
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Spotify artist id. If you'd prefer to use the URL instead, you can use the url parameter instead. |
| No; body/guard rules apply | string | Spotify artist URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
spotify_track
scrapecreators-cli spotify-track
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Spotify track id. If you'd prefer to use the URL instead, you can use the url parameter instead. |
| No; body/guard rules apply | string | Spotify song URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
spotify_album
scrapecreators-cli spotify-album
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Spotify album id. If you'd prefer to use the URL instead, you can use the url parameter instead. |
| No; body/guard rules apply | string | Spotify album URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
spotify_playlist
scrapecreators-cli spotify-playlist
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Spotify playlist id. If you'd prefer to use the URL instead, you can use the url parameter instead. |
| No; body/guard rules apply | string | Spotify playlist URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
| No; body/guard rules apply | string | Cursor returned by the previous response. Omit it for the first page. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
spotify_search
scrapecreators-cli spotify-search
Argument | Required | Type | Details |
| Yes | string | Search query |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
spotify_podcast
scrapecreators-cli spotify-podcast
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Spotify podcast id. If you'd prefer to use the URL instead, you can use the url parameter instead. |
| No; body/guard rules apply | string | Spotify podcast URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
spotify_podcast_episodes
scrapecreators-cli spotify-podcast-episodes
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Spotify podcast id. If you'd prefer to use the URL instead, you can use the url parameter instead. |
| No; body/guard rules apply | string | Spotify podcast URL. If you'd prefer to use the id instead, you can use the id parameter instead. |
| No; body/guard rules apply | number | Cursor returned by the previous response. Omit for the first page. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
soundcloud_artist
scrapecreators-cli soundcloud-artist
Argument | Required | Type | Details |
| No; body/guard rules apply | string | SoundCloud artist handle. If you'd prefer to use the URL instead, you can use the url parameter instead. |
| No; body/guard rules apply | string | SoundCloud artist URL. If you'd prefer to use the handle instead, you can use the handle parameter instead. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
soundcloud_artist_tracks
scrapecreators-cli soundcloud-artist-tracks
Argument | Required | Type | Details |
| No; body/guard rules apply | string | SoundCloud artist handle. If you'd prefer to use the URL instead, you can use the url parameter instead. |
| No; body/guard rules apply | string | SoundCloud artist tracks URL. If you'd prefer to use the handle instead, you can use the handle parameter instead. |
| No; body/guard rules apply | string | Cursor to get more tracks. Get 'cursor' from previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
soundcloud_track
scrapecreators-cli soundcloud-track
Argument | Required | Type | Details |
| Yes | string | SoundCloud track URL. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
kwai_profile
scrapecreators-cli kwai-profile
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Kwai profile handle. Use this or url. |
| No; body/guard rules apply | string | Kwai profile URL. Use this or handle. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
kwai_user_posts
scrapecreators-cli kwai-user-posts
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Kwai profile handle. Use this or url. |
| No; body/guard rules apply | string | Kwai profile URL. Use this or handle. |
| No; body/guard rules apply | string | Cursor from the previous response for the next page |
| No; body/guard rules apply | number | Number of posts to return, max 50 |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
kwai_post
scrapecreators-cli kwai-post
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Kwai post URL |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
kick_clip_transcript
scrapecreators-cli kick-clip-transcript
Argument | Required | Type | Details |
| Yes | string | Kick clip URL |
| No; body/guard rules apply | boolean | Use AI transcription only when native captions are unavailable. Costs 10 credits when an AI transcript is returned. Defaults to false. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
kick_clip
scrapecreators-cli kick-clip
Argument | Required | Type | Details |
| Yes | string | Kick clip URL |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
snapchat_user_profile
scrapecreators-cli snapchat-user-profile
Argument | Required | Type | Details |
| Yes | string | Snapchat username |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
snapchat_spotlight_by_link
scrapecreators-cli snapchat-spotlight-by-link
Argument | Required | Type | Details |
| Yes | string | Snapchat Spotlight URL. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
snapchat_spotlight_comments_by_link
scrapecreators-cli snapchat-spotlight-comments-by-link
Argument | Required | Type | Details |
| Yes | string | Snapchat Spotlight URL. |
| No; body/guard rules apply | string | Pagination cursor from the previous response. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
creator_tools_find_social_profiles
scrapecreators-cli creator-tools-find-social-profiles
Argument | Required | Type | Details |
| Yes | string | Source social platform Values: |
| Yes | string | Creator handle without a profile URL. A leading @ is optional. |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
creator_tools_get_age_and_gender
scrapecreators-cli creator-tools-get-age-and-gender
Argument | Required | Type | Details |
| Yes | string | URL to users social profile |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
linktree_linktree_page
scrapecreators-cli linktree-linktree-page
Argument | Required | Type | Details |
| Yes | string | URL to Linktree page |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
komi_komi_page
scrapecreators-cli komi-komi-page
Argument | Required | Type | Details |
| Yes | string | URL to Komi page |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
pillar_pillar_page
scrapecreators-cli pillar-pillar-page
Argument | Required | Type | Details |
| Yes | string | URL to Pillar page |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
linkbio_linkbio_page
scrapecreators-cli linkbio-linkbio-page
Argument | Required | Type | Details |
| Yes | string | URL to Linkbio (lnk.bio) page |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
amazon_shop_amazon_shop_page
scrapecreators-cli amazon-shop-amazon-shop-page
Argument | Required | Type | Details |
| Yes | string | URL to Amazon Shop page |
| No; body/guard rules apply | string | 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. |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
scrapecreators_get_credit_balance
scrapecreators-cli scrapecreators-get-credit-balance
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
scrapecreators_get_request_history
scrapecreators-cli scrapecreators-get-request-history
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Page number for pagination (max 100) |
| No; body/guard rules apply | string | Filter by endpoint name (partial match) |
| No; body/guard rules apply | string | Filter by HTTP status code |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
scrapecreators_get_daily_usage
scrapecreators-cli scrapecreators-get-daily-usage
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
scrapecreators_get_most_used_routes
scrapecreators-cli scrapecreators-get-most-used-routes
Argument | Required | Type | Details |
| No; body/guard rules apply | string | Start of time range (ISO 8601 format) |
| No; body/guard rules apply | string | End of time range (ISO 8601 format) |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
linkme_profile
scrapecreators-cli linkme-profile
Argument | Required | Type | Details |
| Yes | string | Linkme profile URL |
| No; body/guard rules apply | string | Maximum acceptable provider-cache age; a miss may consume the normal endpoint credits. Values: |
| No; body/guard rules apply | string | Named private ScrapeCreators account; selects credentials, not a remote account ID. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
list_accounts
scrapecreators-cli list-accounts
Argument | Required | Type | Details |
None | No | None | Local helper, accepts no arguments |
research_batch
scrapecreators-cli research-batch
Argument | Required | Type | Details |
| Yes | array | See the exact schema before calling. minItems: |
| Yes | integer | See the exact schema before calling. minimum: |
| No; body/guard rules apply | string | See the exact schema before calling. |
| No; body/guard rules apply | boolean | Set true only when the user asked for exactly this action. |
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.
9. 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.
10. 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.
11. 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.
12. Approving paid research safely
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_DESTRUCTIVE=0, or its 2.0 name ALLOW_SPENDING=0, refuses confirmed paid calls too. Five local/account reads remain; account metadata can still be private.
Over MCP a person approves each paid call where the client can ask: Claude Code (2.1.246 and later) shows its own prompt, and a client that can show forms asks with an approval form whose one box starts unticked. Each approval is signed, bound to that exact call and works once. Where a client can do neither, the model's confirm=true counts. SCRAPECREATORS_CONFIRM=model makes confirm=true enough everywhere, for an agent with no person to ask.
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, the guard outcome and who approved it, then a done or failed line for each allowed call. 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.
13. How it works
src/tools/operations.json supplies the reviewed API route/schema catalogue. src/tools/index.ts builds shared tool definitions and adds local account/batch helpers. Slipway validates exact inputs, applies the spending guard and invokes the same handlers from the MCP server and the CLI. doctor/login are CLI utilities, not extra provider tools.
The HTTP client allows only the fixed provider origin, rejects redirects/encoded traversal, attaches the selected private x-api-key and preserves native query/body field names. It applies local pacing, response/body caps and account-only bounded rate-limit retries. No separate CLI API implementation is maintained.
npm run sync:api regenerates from the committed sanitized snapshot after checking its hash. The explicit --refresh mode downloads the current provider schema, strips all examples and records source hashes/date. Refresh is not an automatic dependency update: inspect routes, parameter semantics, paid classifications and breaking names, then run typecheck/build/tests, discovery, full documentation and release gates. API info version 1.0.0 is a document value, not evidence of an unchanged remote contract. Keep the checked date and snapshot hash with every release.
14. 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.
15. Environment variables
Private settings only; no automatic .env loader.
Variable | Default | Meaning |
SCRAPECREATORS_API_KEY | Empty | Private x-api-key credential |
SCRAPECREATORS_TOKEN_FILE | Empty | Regular private key-only file, max 64 KB; overrides env key |
SCRAPECREATORS_ACCOUNTS | Empty | Private JSON array of unique name/api_key/token_file profiles |
SCRAPECREATORS_DEFAULT_ACCOUNT | First profile | Default local credential label |
SCRAPECREATORS_READ_ONLY | 0 | Hide/refuse paid research; five reads remain |
SCRAPECREATORS_ALLOW_DESTRUCTIVE | 1 | 0 refuses potentially paid calls even when confirmed |
SCRAPECREATORS_ALLOW_SPENDING | 1 | 2.0's name for SCRAPECREATORS_ALLOW_DESTRUCTIVE, still read when that one is unset |
SCRAPECREATORS_AUDIT_LOG | Empty | Optional private guard-decision JSONL path |
SCRAPECREATORS_REQUEST_TIMEOUT_MS | 30000 | 100–300000 ms per request |
SCRAPECREATORS_MAX_RETRIES | 2 | 0–5; account metadata GET 429 only |
SCRAPECREATORS_MIN_REQUEST_INTERVAL_MS | 150 | 0–10000 ms local per-account/process pacing |
SCRAPECREATORS_CONFIRM | human | model lets confirm=true alone approve over MCP, for an agent with no person to ask |
SCRAPECREATORS_SURFACE | full | search lists three tools that find, describe and run the rest |
SCRAPECREATORS_TOOL_TIMEOUT_MS | Empty | Give up on any tool after this long |
SCRAPECREATORS_HTTP_PORT, SCRAPECREATORS_HTTP_HOST, SCRAPECREATORS_HTTP_TOKEN | 8787, 127.0.0.1, empty | For --http; any host but 127.0.0.1 needs the bearer token |
SCRAPECREATORS_HTTP_ALLOWED_ORIGINS | Empty | Comma-separated browser origins allowed to call --http; a page from any other site is refused |
SCRAPECREATORS_DEBUG | 0 | 1 prints debug lines on stderr |
16. 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.
17. Troubleshooting
Symptom | Check |
Command missing | Node 22+, npm prefix/PATH; npm.cmd if PowerShell policy requires |
No credentials, exit 10 | Intended private key/file and correct default account |
GUI key unavailable | Private GUI/client environment differs from terminal |
Key file refused | Regular nonsymlink, ≤64 KB, POSIX 0600 or private Windows ACL |
401/403 | Actual provider key, account/API status; no Bearer header |
Paid call refused, exit 2 | Exact --confirm plus READ_ONLY/ALLOW_DESTRUCTIVE policy |
Missing selector | Current required fields; TikTok handle/user_id, company pageId/companyName |
POST body rejected | Complete required body; payload/file versus body flags, not mixed |
First page only | Native cursor is manual; each next page needs approval |
Null transcript | Track/original language availability; preserve returned metadata |
Cache not used | Endpoint support, acceptable age and team cache opt-out |
Timeout, 429 or response cap | Inspect account history before resubmitting; paid calls do not retry |
Partial batch | Inspect completed outcomes, then select only deliberate remaining calls |
Desktop rejected | Compatible host/runtime and custom-extension policy |
Use doctor and actual schema/help first. Public issues include package/client/OS and a small synthetic example, never actual key values, private account usage or personal raw research output. Fixture/protocol success does not prove desktop GUI or account outcomes.
18. API coverage and comparisons
Offering | Surface | Capabilities and tradeoff |
@scrapecreators/cli 1.0.44; scrapecreators | 188 registry endpoint variants, JSON/CSV/table/Markdown, clean output, file output, interactive key setup, signup and agent-config helpers | |
Provider-hosted public research with OAuth or x-api-key authentication; client approvals and provider maintenance apply | ||
Agent workflows | Provider-authored research guidance; compare the relevant workflow before installing another wrapper | |
This owned package | Local stdio MCP, shared CLI, .mcpb | Mandatory approval for potentially paid research, private named accounts and prevalidated sequential batches capped at 20, stopping on first failure |
Local stdio or hosted gateway | Its README documents four focused social/ad tools and gateway routing; hosted and standalone tool sets differ | |
Go CLI/MCP and local workflows | 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.
19. Versions
Component | Version / baseline | Meaning |
This package and desktop manifest | 3.0.0 | Shared release version |
Node | 22+ | Manual CLI/MCP runtime |
Slipway | 0.1.20 | The MCP server and the CLI from one definition of each tool |
MCP TypeScript SDK, through Slipway | 2.3.0 | The MCP protocol and its transports |
API snapshot | 2026-10-02; info 1.0.0, OpenAPI 3.1.0 | 188 reviewed operations; native route versions preserved |
Official CLI baseline | 1.0.44 | Reviewed current npm binary/source |
Legacy source baseline | 1.0.0 | 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. Desktop GUI acceptance remains separately pending; section 7 has the measured token costs.
20. FAQ
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.
In Claude Code the CLI costs nothing until it is used, plus about 1,390 tokens for SKILL.md once, where the server costs about 3,220 tokens a message with tool search and 88,400 with every tool loaded. In Codex, finding the command that gets a TikTok video's transcript and its flags took a median of 83,060 input tokens over the CLI and 48,790 over MCP. Section 7 has how each was measured.
Questions
Open a sanitized issue with version/client/OS. Private reports use SECURITY.md.
About the author
Navid Moazzez is a leading AI business strategist, and the host of the AI Creator Summit, watched by 100,000+ creators. He helps creators and founders master AI and build their own AI Operating System (AI OS) to automate their business and life. He creates useful free tools, MCP servers and CLIs that creators and founders can use in their own workflows.
Links
Personal website: navid.me
Link in bio: navid.bio
Navid Media: navid.media
YouTube: @thenavidm and @thenavidai
X: @thenavidm
Instagram: @thenavidm
LinkedIn: thenavidm
Dependencies
Runtime: Slipway 0.1.20, which brings the MCP TypeScript SDK 2.3.0, plus Ajv 8.20.0 and ajv-formats 3.0.1. Development: TypeScript 7.0.2, Vitest 5.0.3, Vite 8.3.2 and MCPB 2.1.2. Exact versions are in package-lock.json; MIT notices remain in dependencies. Packaging tools are excluded from runtime bundles. See THIRD_PARTY_NOTICES.md and SECURITY.md for licensing and audit scope.
License
AGPL-3.0-or-later, preserving the existing wrapper license. See LICENSE, full AGPL text and THIRD_PARTY_NOTICES.md. Provider API/documentation/service terms remain separate.
© 2026 Navid Media. Made with ❤️ by Navid Moazzez.
Available Tools
190 toolsamazon_shop_amazon_shop_pageAmazon Shop pageA
Scrapes a creator's Amazon Shop page by URL, returning their storefront profile and product collections. The initial request also returns videos already embedded on the storefront page without requiring a pageToken. Videos include an id, title, thumbnail, and attached ASINs. Pass each returned pageToken back unchanged with the same shop URL. A paginated page can contain lists, videos, or both. Tokens are opaque: known values can begin with amzn1.ideas, amzn1.vse.video, or amzn1.shoppablemedia, but clients should not infer the response type from the prefix. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, pageToken.
apple_music_albumAlbumA
Retrieves public Apple Music album details, including title, artist, artwork, release info, tracks, and more by the artist. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, account, confirm.
apple_music_artistArtistA
Retrieves public Apple Music artist details, including artwork, editorial notes, top songs, albums, music videos, playlists, and related sections. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, account, confirm.
apple_music_searchSearchA
Searches Apple Music and returns public result sections for artists, albums, songs, playlists, stations, and music videos. Use type=song, album, artist, playlist, or all. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), type, account, confirm.
apple_music_trackTrackA
Retrieves public Apple Music song details by id or URL. Album track URLs with an i= song id are supported. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, account, confirm.
bluesky_postPostA
Fetches a single Bluesky post by URL, returning the post's record text, author info, embed content, replyCount, repostCount, likeCount, and quoteCount. Also includes a replies array with threaded reply posts. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
bluesky_postsPostsA
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. Supports pagination via cursor. Use user_id (the 'did') instead of handle for faster response times. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle, account, confirm, user_id.
bluesky_profileProfileA
Retrieves a Bluesky user's public profile including handle, displayName, avatar, description, followersCount, followsCount, postsCount, createdAt, and verification status. The associated field shows counts for lists, feed generators, and starter packs. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm.
creator_tools_find_social_profilesFind Social ProfilesA
Accepts a supported platform and creator handle, validates both using platform-specific rules, and constructs the canonical source profile URL internally. URLs are not accepted as handles. Supported platforms are Instagram, TikTok, YouTube, X/Twitter, and Facebook; X is accepted as an alias for Twitter. YouTube accepts handles and 24-character channel IDs. The endpoint returns social profiles explicitly linked from the source profile and expands recognized link-in-bio pages. It also re-scrapes up to three supported profiles explicitly linked by the source and follows up to three unique public website URLs declared by the source or those trusted profiles for one page, while preserving each declared path and query. Generic service-provider landing pages reached through parked or unconfigured branded-domain redirects are ignored so the provider's own footer links are not attributed to the creator. It also checks whether the same handle exists on the other supported platforms. All attempted same-handle URLs are returned in same_handle_candidate_urls even when they cannot be verified strongly enough for profiles. Same-handle accounts are included in profiles only when corroborated by a shared owner-controlled website or a reciprocal profile link; matching handles and display names alone are not identity proof. same_handle_match records supporting name evidence at 0.75 confidence, while shared_website and website_link use 0.9. A bounded Google search discovers alternate handles, but Google results are never returned without verification. At most two candidates per other supported platform, up to four total, are re-scraped through that platform's profile scraper. The endpoint may also follow up to two unique recognized link-in-bio URLs declared by the re-scraped Google candidates. The global two-page cap is applied after candidates whose returned handles do not match their Google URLs are rejected. Optional profile probes and page fetches make one attempt and receive the shared enrichment abort signal. A reciprocal source-profile link found there verifies the candidate, and the page's explicit cross-platform profiles can then expand the verified identity graph. Google URLs that re-scrape to the same returned platform handle are deduplicated. A different-handle candidate is accepted only when it links back to the source profile, or when its normalized display name matches and it declares the same owner-controlled public website; common multi-tenant profile and storefront hosts are excluded from shared-website identity evidence. Google discovery uses google_search_match at 0.6, exact names use display_name_match at 0.75, reciprocal links use 0.95, and cross-platform social links explicitly declared by a verified candidate use verified_profile_link at 0.95. Source-linked URLs and failures are returned in source_linked_profile_urls and failed_source_linked_profile_urls. Google candidate URLs, candidate-declared link-in-bio URLs, verified URLs, and failures are returned in google_candidate_urls, google_candidate_link_in_bio_urls, verified_google_candidate_urls, failed_google_candidate_urls, and failed_google_candidate_link_in_bio_urls. Results are deterministic and do not use AI. Mixed or unreachable enrichment results are reported through partial and the matching failure fields. If every declared link-in-bio page fails and no other enrichment finds a profile, the request returns an uncharged 503. A successful live lookup costs 10 credits. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), platform (required), account, confirm, +1 more.
creator_tools_get_age_and_genderGet Age and GenderA
Uses AI to analyze a creator's profile photo and estimate their age and gender. Returns ageRange with low and high bounds, gender, and a confidence score for the gender prediction. The profile photo must contain a clear, visible face for accurate results. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
facebook_ad_library_ad_detailsAd DetailsA
Retrieves detailed information about a specific Facebook ad by its ID or URL. Returns adArchiveID, pageName, isActive, startDate, endDate, and a snapshot containing body, images, videos, display_format, link_url, and cta_text. Regulated ads may also include source-dependent aaa_info using the structure shown below. Political and social issue delivery data is normalized to location_audience and age_country_gender_reach_breakdown. Political location_audience rows include reach, and political delivery values are fractional shares, so 0.08 means 8%. Regional transparency data may use absolute reach counts. For ads with multiple versions, the ad creative is found in the snapshot.cards array rather than snapshot.body. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, trim, account, +2 more.
facebook_ad_library_ad_transcriptAd TranscriptA
Retrieves a transcript for a single Facebook Ad Library video ad by ID or URL. If Facebook exposes captions, those are used. Otherwise we try to transcribe the public video URL. Credits are only deducted when transcript is returned. If the ad has no video or no transcript is available, transcript will be null and no credit is charged. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, account, confirm, +1 more.
facebook_ad_library_company_adsCompany AdsA
Fetches all ads currently running for a specific company from the Meta Ad Library. Each ad includes ad_archive_id, page_name, is_active, publisher_platform, and a snapshot with body, images, videos, and display_format. Supports filtering by country, media_type, date range, and language with cursor-based pagination. Both GET and POST are supported. If the cursor becomes too large after extensive pagination, use POST and send the same parameters in the JSON body. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: trim, cursor, pageId, status, +9 more.
facebook_ad_library_company_ads_postCompany AdsA
Fetches all ads currently running for a specific company from the Meta Ad Library. Each ad includes ad_archive_id, page_name, is_active, publisher_platform, and a snapshot with body, images, videos, and display_format. Supports filtering by country, media_type, date range, and language with cursor-based pagination. Both GET and POST are supported. If the cursor becomes too large after extensive pagination, use POST and send the same parameters in the JSON body. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: trim, cursor, pageId, status, +11 more.
facebook_ad_library_searchSearchA
Searches the Meta Ad Library by keyword and returns matching ads. Supports filtering by language with a 2-letter code such as EN or ES. Each result includes ad_archive_id, page_name, is_active, publisher_platform, and a snapshot with body text, images, videos, and cta_text. Both GET and POST are supported. Use GET for normal requests. If the cursor becomes too large after extensive pagination, use POST and send the same parameters in the JSON body. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), trim, cursor, status, +10 more.
facebook_ad_library_search_for_companiesSearch for CompaniesA
Searches for companies by name in the Meta Ad Library and returns their page IDs for use with other ad library endpoints. Each result includes page_id, name, category, likes, verification status, and Instagram details like ig_username and ig_followers. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), account, confirm.
facebook_ad_library_search_postSearchA
Searches the Meta Ad Library by keyword and returns matching ads. Supports filtering by language with a 2-letter code such as EN or ES. Each result includes ad_archive_id, page_name, is_active, publisher_platform, and a snapshot with body text, images, videos, and cta_text. Both GET and POST are supported. Use GET for normal requests. If the cursor becomes too large after extensive pagination, use POST and send the same parameters in the JSON body. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: trim, query, cursor, status, +12 more.
facebook_comment_repliesComment RepliesA
Get the replies to a comment. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: feedback_id (required), expansion_token (required), cursor, account, +1 more.
facebook_commentsCommentsA
Fetches comments from a Facebook post or reel with cursor-based pagination. Each comment includes id, text, created_at, reply_count, reaction_count, and author details with name and profile_picture. Passing a feedback_id instead of a url significantly speeds up the request. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, cursor, account, confirm, +1 more.
facebook_events_event_detailsEvent DetailsA
Get a specific event by its URL or id Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, account, confirm.
facebook_events_eventsEventsA
Get the events of a city. Check out this link for an example of where we are getting the data from. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), time, cursor, account, +1 more.
facebook_events_search_eventsSearch EventsA
Search for events by name. You can take a look at the page from Facebook we are getting the data from here Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), cursor, account, confirm.
facebook_facebook_group_infoFacebook Group InfoA
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. Provide either url or group_id. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, account, confirm, group_id.
facebook_facebook_group_postsFacebook Group PostsA
Fetches posts from a public Facebook group, limited to 3 posts per page due to API limitations. Each post includes id, text, url, reactionCount, commentCount, publishTime, videoDetails, and topComments. Results are chronological by default. Supports TOP_POSTS, RECENT_ACTIVITY, CHRONOLOGICAL, and CHRONOLOGICAL_LISTINGS with cursor-based pagination. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, cursor, account, confirm, +2 more.
facebook_marketplace_marketplace_itemMarketplace ItemA
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. Rental listings can include listing_date_text and availability_text from Facebook's Marketplace GraphQL response, for example 'Listed over a week ago' and 'Available now'. creation_time can still be null when Facebook does not expose an exact timestamp. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, account, confirm.
facebook_marketplace_marketplace_location_searchMarketplace Location SearchA
Searches Facebook Marketplace locations/cities and returns coordinates you can use with the Marketplace Search endpoint. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), account, confirm.
facebook_marketplace_marketplace_searchMarketplace SearchA
Searches Facebook Marketplace listings by keyword and lat/lng. Each page contains up to 24 listings. Each listing includes creation_time as an ISO 8601 UTC timestamp when Facebook exposes an exact listing timestamp, plus listing_date_text when available; either field can be null. Pass category_id to restrict results to the numeric Facebook Marketplace category ID returned on listing results. Supports pagination with the returned cursor. Pass the cursor value back as-is. The sort and date filters use the same values as Facebook's Marketplace UI. creation_time_descend usually orders the first pages newest first, but Facebook can insert newer listings on later cursor pages. date_listed uses Facebook's calendar-day buckets, so last_24_hours can include listings from the prior calendar day rather than enforcing an exact rolling 24-hour cutoff. For alerting/new-item workflows, continue paging while has_next_page is true and dedupe by listing id. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: lat (required), lng (required), query (required), cursor, +11 more.
facebook_postPostA
Retrieves a single public Facebook post or reel by URL. Returns post_id, like_count, comment_count, share_count, view_count, description, creation_time, and author details, including the author handle when Facebook exposes a vanity profile URL. For some reels, Facebook does not expose the same view count on the individual post page that it shows on the profile Reels grid. This value can be null or lower than the public Reels badge. If you need the public Reel badge count, call /v1/facebook/profile/reels with the author URL and match the reel by post_id. For video posts, includes video sd_url, hd_url, thumbnail, and length_in_second. Optionally fetches comments and transcript via get_comments and get_transcript parameters. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
facebook_profileProfileA
Retrieves public Facebook page details including category, address, email, phone, website, services, priceRange, rating, likeCount, talkingAboutCount, and followerCount. talkingAboutCount is nullable and only returned when Facebook exposes it publicly. Also returns adLibrary status with the page's ad activity and pageId. Optionally includes businessHours when get_business_hours is set to true. Contact fields come from the submitted public profile. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. If Facebook shows an 18+ content gate, the response is still 200 with account_status: "age-restricted" and isPrivate: true. If Facebook shows a private content gate, the response is still 200 with account_status: "private" and isPrivate: true. If the page is not found, the response is 404 with accountDoesNotExist: true and isPrivate: false. Set include_gated_profile=true to also return limited public fields (such as id, name, category, likeCount, profilePicSmall, and links) when a profile is gated or age-restricted. This option only affects gated/age-restricted profiles — public profiles still return the normal full response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age, +2 more.
facebook_profile_eventsProfile EventsA
Get the events of a public Facebook page Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), cursor, account, confirm.
facebook_profile_photosProfile PhotosA
Fetches photos from a public Facebook page with pagination support. Each photo includes photo_id, accessibility_caption, viewer_image with uri, height, and width, plus a thumbnail and direct url. Pagination requires passing both next_page_id and cursor from the previous response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), cursor, account, confirm, +1 more.
facebook_profile_postsProfile PostsA
Returns publicly visible Facebook profile posts, limited to 3 posts per page due to API limitations. Each post includes id, text, url, reactionCount, commentCount, publishTime, videoDetails with sdUrl, hdUrl, and thumbnailUrl, plus topComments. Accepts either a url or pageId parameter, where pageId is faster. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, cursor, pageId, account, +1 more.
facebook_profile_reelsProfile ReelsA
Fetches up to 10 reels per request from a public Facebook page. Each reel includes id, url, view_count, description, creation_time, video_url, thumbnail, play_time_in_ms, and music details. Pagination requires passing both next_page_id and cursor from the previous response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), cursor, account, confirm, +1 more.
facebook_transcriptTranscriptA
Extracts the transcript text from a Facebook video post or reel. Returns the transcript as a single text string with line breaks. Only works on videos under 2 minutes in length. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
github_activityActivityA
Retrieves GitHub profile contribution activity for a user from the public profile activity timeline. Defaults to the current year when year is not provided. Results come back one month at a time in the activity array. Pass cursor from the previous response to page backward through the year. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, year, cursor, handle, +2 more.
github_contributionsContributionsA
Retrieves the public GitHub contribution graph for a user and year, including total contributions and daily contribution counts/intensity. Pass github handle, or a full GitHub profile url. Defaults to the current year when year is not provided. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, year, handle, account, +1 more.
github_followersFollowersA
Retrieves public GitHub followers for a user. Each follower includes login, avatar, user URL, type, and GitHub IDs. Pass username, handle, or a full GitHub user url. Supports cursor pagination. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, cursor, handle, account, +1 more.
github_followingFollowingA
Retrieves public accounts followed by a GitHub user. Each account includes login, avatar, profile URL, type, and GitHub IDs. Pass username, handle, or a full GitHub profile url. Supports cursor pagination. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, cursor, handle, account, +1 more.
github_pull_requestsPull RequestsA
Searches public GitHub pull requests authored by a user using GitHub's public search index. Pass username, handle, or url. Optional since and until filters use YYYY-MM-DD created dates. Results include the PR title, repo, state, created_at, and url, sorted by newest created first. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), since, until, cursor, +2 more.
github_repositoriesRepositoriesA
Retrieves a user's public repositories with repo metadata like description, language, stars, forks, topics, license, visibility, default branch, and timestamps. Pass username, handle, or url. Supports pagination with cursor, plus GitHub's type, sort, and direction parameters. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, sort, type, cursor, +4 more.
github_repositoryRepositoryA
Retrieves public metadata for one GitHub repository, including owner, description, language, stars, forks, topics, license, visibility, default branch, open issues, and timestamps. Pass a full GitHub repository url. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
github_trending_developersTrending DevelopersA
Scrapes GitHub's public Trending developers page. Returns ranked developers with username, name, public profile URL, avatar, and the popular repository GitHub shows for that developer when available. Use language for paths like javascript or python and since for daily/weekly/monthly. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: since, account, confirm, language.
github_trending_repositoriesTrending RepositoriesA
Scrapes GitHub's public Trending repositories page. Returns ranked repositories with public URLs, descriptions, language, star/fork counts, stars for the selected range, and built-by users when GitHub shows them. Use language for paths like JavaScript or Python, since for daily/weekly/monthly, and spoken_language_code for GitHub's spoken language filter. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: since, account, confirm, language, +1 more.
github_userUserA
Retrieves public GitHub user details including name, bio, avatar, company, location, blog, follower counts, public repo counts, and account timestamps. Pass username, handle, or a full GitHub user url. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, handle, account, confirm.
google_ad_library_ad_detailsAd DetailsA
Retrieves detailed information about a specific Google ad including advertiserId, creativeId, format, firstShown, lastShown, and overallImpressions. When Google publishes political-ad transparency data, spend contains the currency and amount bounds, while targeting contains included and excluded age, gender, and location criteria. Targeted locations include their Google criterion ID, display name, full name, and country codes. Optional fields are null when Google does not publish them. Returns creativeRegions, regionStats with per-region impression data, and variations with destinationUrl, headline, description, and imageUrl. Text extraction uses OCR, so accuracy may vary. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
google_ad_library_advertiser_searchAdvertiser SearchA
Searches the Google Ad Transparency Library for advertisers by name. Returns a list of matching advertisers with their name, advertiser_id, and region, plus a list of associated website domains. Use the returned advertiser_id to look up a company's ads. Defaults to US when region is not passed, so pass a 2-letter country code like AU or CA when searching for advertisers in another region. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), region, account, confirm.
google_ad_library_company_adsCompany AdsA
Fetches public ads for a company from the Google Ad Transparency Library by domain or advertiser_id. Each ad includes advertiserId, creativeId, format, adUrl, advertiserName, domain, firstShown, and lastShown. Costs 25 credits per request when get_ad_details=true; without it, only advertiserId and creativeId are returned at 1 credit. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: topic, cursor, domain, format, +8 more.
google_searchSearchA
Performs a Google search and returns organic results with url, title, and description for each result. Supports an optional region parameter (2-letter country code) to get localized results from a specific country. Pages 1 through 11 are supported; requests for page 12 or greater return a 400 response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), page, region, account, +2 more.
instagram_basic_profileBasic ProfileA
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. Ideal for quick lookups or enrichment when you already have the numeric user ID. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: userId, account, confirm, cache_max_age.
instagram_comment_repliesComment RepliesA
Retrieves the public replies to a specific Instagram comment. Pass the post or reel URL and the parent comment's id from the Comments endpoint. Returns reply text, timestamps, engagement counts, parent comment ID, and user details. Paginate with cursor when has_more is true.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), comment_id (required), cursor, account, +1 more.
instagram_commentsCommentsA
Retrieves comments on a public Instagram post or reel. Each comment includes the comment text, creation timestamp, reply count when Instagram provides it, and commenter details such as username, user ID, verification status, and profile picture URL. child_comment_count can be null when Instagram does not expose the count publicly. Set include_replies=true to fetch the first page of replies for every returned comment. This adds replies, replies_cursor, and has_more_replies to each comment. This option always costs 15 credits because Scrape Creators makes a separate Instagram replies request for every comment in the response. It is possible that no replies are returned, but you will still be charged 15 credits because those reply lookups were performed. This option is much slower than a normal comments request and may time out at 29 seconds. Supports cursor-based pagination to load additional comment pages.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), cursor, account, confirm, +1 more.
instagram_embed_htmlEmbed HTMLA
Returns the raw HTML embed snippet for an Instagram user's profile widget. The response contains a single html string that can be inserted into a webpage to render an embeddable Instagram profile card. Requires the user's handle as input. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm.
instagram_get_reels_by_audio_idGet Reels By Audio IdA
Fetches the reels Instagram exposes for an audio page like instagram.com/reels/audio/{audio_id}/. Pass the audio_id from that URL. Use cursor from the previous response to request the next page when Instagram returns one. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: audio_id (required), cursor, account, confirm.
instagram_highlights_detailsHighlights DetailsA
Fetches the full contents of a specific Instagram story highlight album by its ID. Returns the highlight's cover image, title, user info, and an items array containing each story with its media type, image or video URLs, dimensions, timestamp, and sticker/interactive element data. Useful for archiving or analyzing individual highlight reels. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, account, confirm.
instagram_popular_searchPopular SearchA
Use this to explore an Instagram topic and the posts Instagram curates for it. It scrapes the public /popular/{query} page without requiring an Instagram login. The first page returns the topic title, numeric total media count, Instagram's generated description and sources, suggested terms, posts, and an opaque cursor. Pass that cursor with the same query to fetch more posts. Later pages return query, posts, cursor, and has_more only. For an exact hashtag through Google-indexed results, use /v1/instagram/search/hashtag. For reels only, use /v2/instagram/reels/search. Each successful request costs 1 credit. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), cursor, account, confirm.
instagram_post_reel_infoPost/Reel InfoA
Fetches detailed metadata for a single Instagram post or reel by shortcode or URL. Returns caption text, like count, comment count, video URL, video play count, video duration, display images, owner info, tagged users, carousel sidecar children when applicable, and the published time in data.xdt_shortcode_media.created_at as an ISO 8601 UTC date. The original Unix timestamp remains available in data.xdt_shortcode_media.taken_at_timestamp. Play counts are Instagram-only views and exclude cross-posted Facebook views. Set include_play_count=false to omit the play count and skip its additional fetch for a faster response.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), trim, region, account, +4 more.
instagram_postsPostsA
Returns a paginated feed of a user's public Instagram posts, including reels, photos, videos, and carousels. Each item includes media type, shortcode, caption text, like count, comment count, play count, video URLs, image URLs, tagged users, and the published time in items[].created_at as an ISO 8601 UTC date. The original Unix timestamp remains available in items[].taken_at. Play counts reflect Instagram-only views and exclude cross-posted Facebook views. Supports cursor-based pagination via next_max_id for scrolling through the full timeline.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), trim, account, confirm, +1 more.
instagram_profileProfileA
Retrieves comprehensive public Instagram profile information including biography, bio links, follower and following counts, verification status, and profile picture URLs. Also returns recent timeline posts with engagement metrics such as likes, comments, and video view counts, plus a list of related profiles. Useful for account overview, audience analysis, or discovering similar creators. Instagram may return media_count as null or return only the current post batch in edge_owner_to_timeline_media.count. Use Profile Post Count when you specifically need the total number of posts. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), trim, account, confirm, +1 more.
instagram_profile_post_countProfile Post CountA
Returns the post count shown on a public Instagram profile. Use this endpoint when Profile returns media_count as null or edge_owner_to_timeline_media.count contains only the current batch size. This endpoint makes a separate Instagram profile-page request so it does not add latency to the main Profile endpoint. Full values such as 12,345 Posts return the exact integer with is_estimated set to false. For profiles with more than 10,000 posts, Instagram may expose only a compact value such as 12K Posts or 1.2M Posts. Set allow_estimated=true to return the scaled integer with is_estimated set to true. Estimated counts are opt-in: when allow_estimated is omitted or false, the endpoint returns an uncharged 422 response explaining that exact precision is unavailable. If Instagram omits the count entirely, the endpoint returns an error without deducting a credit. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm, allow_estimated.
instagram_reelsReelsA
Returns a paginated list of a user's public Instagram reels (short-form videos). Each reel includes its shortcode, play count, like count, comment count, video versions with download URLs, thumbnail image, owner info, and the published time in items[].media.created_at as an ISO 8601 UTC date. With trim=true, use items[].created_at. The original Unix timestamp remains available as taken_at. Note that reel captions are not returned by this endpoint. Play counts are Instagram-only views and exclude cross-posted Facebook views. Supports cursor-based pagination via max_id; providing a user_id instead of a handle yields faster responses.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: trim, handle, max_id, account, +2 more.
instagram_search_hashtag_postsSearch Hashtag PostsA
Use this when you know the exact hashtag and want Google-indexed public Instagram posts or reels, optional date filters, and pagination. It returns post details such as caption, engagement, owner, and post time. Results are best-effort and not a complete Instagram-native hashtag feed. For an Instagram-curated topic page with generated context and suggested terms, use /v1/instagram/search/popular. Pass media_type=reels to only return reels. Cursors are limited to pages 1 through 11; cursor 12 or greater returns a 400 response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: hashtag (required), cursor, account, confirm, +2 more.
instagram_search_instagramSearch InstagramA
Use this for Instagram-native account, hashtag, or place lookup. It returns ranked users, hashtags, places, and keyword suggestions from Instagram itself. It is not Google-indexed, does not require an Instagram login, returns one page only, and does not return posts. For an Instagram-curated topic page with posts, use /v1/instagram/search/popular. For the same native account results in a profile-only response, use /v1/instagram/search/profiles. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), account, confirm.
instagram_search_instagram_profilesSearch Instagram ProfilesA
Use this for Instagram-native profile lookup. It returns every account in Instagram's first ranked native result set, then performs bounded best-effort enrichment for the first 10 accounts to preserve the previous profile fields such as biography, bio links, account flags, and follower/following/media counts. Results after the first 10 retain native ID, username, full name, verification status, profile photo, and URL, while unavailable detail fields are null or empty. It does not search Google-indexed bios or captions, Google title/description fields are null, and pagination is not supported. For users, hashtags, places, and keyword suggestions together, use /v1/instagram/search. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), account, confirm.
instagram_search_reelsSearch ReelsA
Use this when you only want Google-indexed Instagram reels matching a keyword or phrase, with optional date filters and pagination. It returns reel media, engagement, owner, location, and audio details. Results are best-effort rather than a complete Instagram-native search. For Instagram-curated topic posts, use /v1/instagram/search/popular. For an exact hashtag across posts and reels, use /v1/instagram/search/hashtag. Pages 1 through 11 are supported; page 12 or greater returns a 400 response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), page, account, confirm, +1 more.
instagram_story_highlightsStory HighlightsA
Lists all story highlight albums for an Instagram user. Each highlight includes its ID, title, cover thumbnail URL, and owner info with username and profile picture. Accepts either a user_id or handle; providing user_id yields faster responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle, account, confirm, user_id.
instagram_transcriptTranscriptA
Generates an AI-powered speech-to-text transcription for an Instagram video post or reel. The video must be under 2 minutes long. Returns a transcripts array with each item's shortcode and transcribed text; carousel posts produce one transcript per video slide. Expect 10-30 second response times, and null when no speech is detected. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
instagram_trending_reelsTrending ReelsA
Fetches trending reels from Instagram's public instagram.com/reels page. Instagram only gives a small batch at a time and the results can overlap, so call this endpoint over and over when you want more. Each call should return new-ish results, but expect some duplicates because that is how Instagram's reels page behaves too. Returns reels, an array of reel objects with shortcode, URL, caption, media URLs, engagement counts when Instagram exposes them, and user info.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: account, confirm.
instagram_user_tagged_postsUser Tagged PostsA
Returns up to 10 public posts per page from an Instagram user's Tagged tab. Each item is a flat post object with its shortcode, caption, media type, engagement counts, media URLs, and owner details. Keep passing the returned cursor to fetch additional pages until has_more is false. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: user_id (required), cursor, account, confirm.
kick_clipClipA
Fetches detailed data for a Kick clip by URL, including video, metadata, and channel info. Returns clip id, title, clip_url, thumbnail_url, video_url, view_count, likes_count, duration, privacy status, and is_mature flag. Also includes category details (name, slug), creator info (username), and channel info (username, profile_picture). Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
kick_clip_transcriptClip TranscriptA
Gets a transcript from a public Kick clip. The endpoint checks Kick's native captions first. Set use_ai_as_fallback to true to use AI transcription only when native captions are unavailable. Native transcripts cost 1 credit, AI transcripts cost 10 credits, and no credits are charged when no transcript is found. transcript_source is native, ai, or null. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, use_ai_as_fallback.
komi_komi_pageKomi pageA
Scrapes a Komi page by URL, extracting the creator's profile, social links, and featured content. Returns id, username, avatar, displayName, bio, and social accounts (instagram, tiktok, youtube, twitter, facebook, snapchat). Also includes links, an array of link and product objects each with id, url, title, type, thumbnail, and optional price and currency for products. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
kwai_postPostA
Fetches public Kwai post details including caption, media URLs, cover images, counts, author info, and music metadata. Uses Kwai's public web API endpoint, not HTML scraping. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, account, confirm.
kwai_profileProfileA
Fetches public Kwai profile data including username, bio, avatar, verification status, gender, and public counts. Uses Kwai's public web API endpoint, not HTML scraping. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, handle, account, confirm.
kwai_user_postsUser PostsA
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. Uses Kwai's public web API endpoint, not HTML scraping. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, count, cursor, handle, +2 more.
linkbio_linkbio_pageLinkbio pageA
Scrapes a Linkbio (lnk.bio) page by URL, extracting the creator's profile and all their links. Returns handle, id, social accounts (instagram, tiktok, youtube, twitter, whatsapp), email, website, and links — an array of link objects each with url and text. Contact fields come from the submitted public Linkbio page. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
linkedin_ad_library_ad_detailsAd DetailsA
Retrieves detailed information about a specific LinkedIn ad by URL. Returns id, description, headline, adType, advertiser, and targeting with language, location, and audience criteria. Also includes totalImpressions, impressionsByCountry, adDuration, startDate, and endDate. Date and impression fields are nullable when LinkedIn does not expose them on the public ad page. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
linkedin_ad_library_search_adsSearch AdsA
Searches the LinkedIn Ad Library by company name, keyword, or companyId with optional country and date filters. Custom date filtering requires both startDate and endDate. LinkedIn accepts dates from the date one year ago through yesterday. Each ad includes id, description, headline, adType, advertiser, targeting details, image or video URLs, totalImpressions, and impressionsByCountry. Date and impression fields are nullable when LinkedIn does not expose them on the public ad page. Supports pagination via paginationToken. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: account, company, confirm, endDate, +5 more.
linkedin_company_pageCompany PageA
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. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
linkedin_company_postsCompany PostsA
Retrieves paginated posts from a LinkedIn company page, including each post's URL, ID, publication date, and full text content. Supports page-based pagination up to a maximum of 7 pages due to a LinkedIn platform limitation. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), page, account, confirm.
linkedin_person_profilePerson's ProfileA
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. Only returns publicly available information visible in an incognito browser. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
linkedin_postPostA
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. For public feed posts, activityUrn and contentUrn expose LinkedIn's public activity and underlying share or ugcPost URNs when present; either can be null when LinkedIn does not expose it. Also includes related articles from the same author in moreArticles. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
linkedin_post_transcriptPost TranscriptA
Fetches the transcript from a LinkedIn post video when LinkedIn exposes one publicly. Returns null with transcriptNotAvailable when the post has no transcript, and only deducts credits when a transcript is returned. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
linkedin_search_postsSearch PostsA
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. Results depend on what Google has indexed, so this is best-effort and not a complete LinkedIn-native search. Use date_posted for recent posts and pass the returned cursor to fetch the next page. Cursors are limited to pages 1 through 11; cursor 12 or greater returns a 400 response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), cursor, account, confirm, +1 more.
linkme_profileProfileA
Retrieves a Linkme profile by URL, including identity, social links, and contact details. Returns profile with id, firstName, username, bio, profileVisitCount, profileImage, verifiedAccount, and isAmbassador flag. Also includes infoLinks (email addresses) and webLinks, an array of categorized social platform links (Spotify, Instagram, YouTube, Twitter, Facebook, and more) each with linkValue and faceValue. Contact fields come from the submitted public Linkme profile. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
linktree_linktree_pageLinktree pageA
Scrapes a Linktree page by URL, extracting the creator's profile and all their links. Returns id, username, profilePictureUrl, description, verticals, timezone, and links — an array of link objects each with id, type, title, and url. Also includes detected social accounts (instagram, tiktok, spotify, youtube, soundcloud, apple_music) and email_address. Contact fields come from the submitted public Linktree page. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
list_accountsList configured accountsARead-onlyIdempotent
List private account labels, default selection and configured token method. No credentials, token paths or account content; no network request.
Inputs: no named parameters.
pillar_pillar_pagePillar pageA
Scrapes a Pillar page by URL, extracting the creator's profile, social links, and products. Returns id, first_name, last_name, email, location, and social accounts (tiktok, spotify, twitter, youtube, facebook, linkedin, instagram, and more). Also includes links with click counts and products with title, price, description, and image. Contact fields come from the submitted public Pillar page. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
pinterest_boardBoardA
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. Supports pagination via cursor and a trim option for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), trim, cursor, account, +1 more.
pinterest_pinPinA
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. Supports a trim option for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), trim, account, confirm, +1 more.
pinterest_searchSearchA
Searches Pinterest for pins matching a query, returning results with id, url, title, description, images, link, domain, board info, and pinner details. Supports pagination via cursor and a trim option for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), trim, cursor, account, +1 more.
pinterest_user_boardsUser BoardsA
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. Supports pagination via cursor and a trim option for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), trim, account, confirm.
reddit_postPostA
Retrieves public Reddit post details by URL without fetching or returning comments. Returns the text post body in selftext when present, plus the title, author, subreddit, score, upvote ratio, comment count, timestamps, permalink, and post flags. Accepts canonical Reddit post URLs and Reddit mobile share URLs. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
reddit_post_commentsPost CommentsA
Retrieves comments and post details from a Reddit post by URL. Returns the post with title, author, score, ups, upvote_ratio, num_comments, and created_utc, plus a comments array where each comment includes author, body, body_html, score, created_utc, parent_id, permalink, and nested replies. Both GET and POST are supported. Use GET for normal requests. Pass one opaque cursor exactly as returned by more.cursor or replies.more.cursor to load the next page. Cursor batching and comma-separated cursor values are not supported. If an opaque cursor becomes too large after extensive pagination, use POST and send the same parameters in the JSON body. Supports cursor-based pagination for loading more comments and a trim parameter for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), trim, cursor, account, +1 more.
reddit_post_comments_postPost CommentsA
Retrieves comments and post details from a Reddit post by URL. Returns the post with title, author, score, ups, upvote_ratio, num_comments, and created_utc, plus a comments array where each comment includes author, body, body_html, score, created_utc, parent_id, permalink, and nested replies. Both GET and POST are supported. Use GET for normal requests. Pass one opaque cursor exactly as returned by more.cursor or replies.more.cursor to load the next page. Cursor batching and comma-separated cursor values are not supported. If an opaque cursor becomes too large after extensive pagination, use POST and send the same parameters in the JSON body. Supports cursor-based pagination for loading more comments and a trim parameter for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, trim, cursor, account, +3 more.
reddit_post_transcriptPost TranscriptA
Gets the transcript from a Reddit video post or direct v.redd.it URL when Reddit exposes a VTT caption file. Returns the raw WebVTT in raw_vtt plus a parsed plain-text transcript. If Reddit does not expose captions for the video, transcript is null and transcriptNotAvailable is true. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, language, +1 more.
reddit_searchSearchA
Searches across all of Reddit for posts or comments matching a query. Set filter to posts (the default) or comments. Post results include title, author, selftext, subreddit, score, ups, upvote_ratio, num_comments, created_utc, url, permalink, and is_video. Comment results include the matching body, author, votes, timestamps, comment URL, parent relationship, and post/subreddit context. Comment searches support relevance, new, and top sorting. Timeframe filtering applies to post searches. Pagination uses the after token, and trim returns a lighter response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), sort, trim, after, +4 more.
reddit_subreddit_detailsSubreddit DetailsA
Retrieves metadata about a subreddit by name or URL. The subreddit name must be case-sensitive. Returns display_name, description, subscribers, weekly_active_users, weekly_contributions, rules, icon_img, header_img, advertiser_category, submit_text, and created_at. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, account, confirm, subreddit, +1 more.
reddit_subreddit_postsSubreddit PostsA
Fetches posts from a subreddit with sorting and filtering options. Each post includes title, author, link_flair_text when Reddit exposes it, selftext, score, ups, upvote_ratio, num_comments, created_utc, url, permalink, subreddit_subscribers, and is_video. Supports sort (best, hot, new, top, rising), timeframe filtering, pagination via the after token, and a trim parameter for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: subreddit (required), sort, trim, after, +4 more.
reddit_subreddit_searchSubreddit SearchA
Searches within a specific subreddit for posts, comments, and media matching a query. Returns posts with title, votes, num_comments, url, and created_at; comments with author, body, votes, and parent post info; and media with title, media_type, image dimensions, and gallery_count. Supports sort, timeframe filtering, and cursor-based pagination. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: subreddit (required), sort, query, cursor, +3 more.
research_batchRun an approved bounded research batchA
Run up to 20 explicitly supplied research calls sequentially in one selected private account. Validates the whole batch before any network call, refuses account overrides/recursion and stops on the first failure. max_calls is a request bound, never a credit or billing guarantee. No automatic retry; completed outcomes are retained. Requires confirm=true for this exact batch.
Inputs: requests (required), max_calls (required), account, confirm.
rumble_channel_videosChannel VideosA
Gets videos from a Rumble channel by handle or URL. Returns channel metadata, videos, shorts, and a numeric cursor for the next page. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, cursor, handle, account, +1 more.
rumble_commentsCommentsA
Gets all top level comments for a Rumble video by URL. Returns comment text, author, createdAt, createdAtText, likeCount, dislikeCount, and replyCount when comment bodies are public. If Rumble requires sign-in to view the comments, this endpoint returns HTTP 403 with error forbidden and does not charge credits. This is different from a public video with no comments, which returns a successful empty comments array.
Sign-in-required response example:
{
"success": false,
"credits_remaining": 100,
"credits_charged": 0,
"error": "forbidden",
"errorStatus": 403,
"message": "Rumble requires you to sign in to view this video's comments"
}Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
rumble_searchSearchA
Searches Rumble videos by keyword. Returns matching videos and shorts with title, URL, thumbnail, channel, published date, viewCountText, viewCountInt, and a numeric cursor for the next page. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), cursor, account, confirm.
rumble_transcriptTranscriptA
Gets a Rumble video's transcript when captions are available. If Rumble does not expose captions for the video, transcript will be null and you will not be charged. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
rumble_videoVideoA
Gets Rumble video details by URL. Returns title, description, thumbnail, channel, publish date, view count, likes, dislikes, captions, and media metadata when available. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
scrapecreators_get_credit_balanceGet credit balanceBRead-onlyIdempotent
Returns the number of API credits remaining on your Scrape Creators account. The response contains a single creditCount field with your current balance. Account metadata read.
Inputs: account.
scrapecreators_get_daily_usageGet daily usageBRead-onlyIdempotent
Returns aggregated daily usage statistics for the last 30 days, including total credits consumed and number of requests per day. Account metadata read.
Inputs: account.
scrapecreators_get_most_used_routesGet most used routesARead-onlyIdempotent
Returns your top 20 most called API endpoints ranked by call count, along with total credits consumed per endpoint. Defaults to the last 24 hours. Supports custom time ranges up to 1 year. Account metadata read.
Inputs: account, end_time, start_time.
scrapecreators_get_request_historyGet request historyARead-onlyIdempotent
Returns a paginated list of your API requests, including the endpoint called, status code, credits used, and timestamp. Useful for debugging and monitoring your API usage. Supports filtering by endpoint name and status code. Account metadata read.
Inputs: page, account, endpoint, statusCode.
snapchat_spotlight_by_linkSpotlight by LinkA
Fetches public data for a Snapchat Spotlight video by URL. Returns the snap id, description, creator, engagement counts, thumbnail, and content URL when Snapchat exposes them publicly. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
snapchat_spotlight_comments_by_linkSpotlight Comments by LinkA
Fetches public comments from Snapchat's Spotlight comments API by URL. Returns the snap id, comments, a cursor for the next page, and hasMore. Pass the returned cursor back as the cursor param to load more comments. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), cursor, account, confirm.
snapchat_user_profileUser ProfileA
Retrieves a Snapchat user's public profile by handle, including identity, stories, and spotlight content. Returns userProfile with username, title, snapcodeImageUrl, subscriberCount, bio, and profilePictureUrl. Also includes highlightStoryMetadata with individual story snaps (mediaUrl, mediaType, thumbnailUrl) and spotlightStoryMetadata with video details and engagement stats (viewCount, shareCount, commentCount). Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm.
soundcloud_artistArtistA
Fetches detailed information about a SoundCloud artist by its handle or URL. Returns artist metadata including id, name, followers, etc Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, handle, account, confirm.
soundcloud_artist_tracksArtist TracksA
Fetches tracks/songs for a SoundCloud artist by handle or URL. Returns the artist profile, track list, and pagination info from SoundCloud. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, cursor, handle, account, +1 more.
soundcloud_trackTrackA
Fetches detailed information about a SoundCloud track/song by URL. Returns track title, plays, likes, reposts, comments, artwork, artist, and other SoundCloud metadata. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
spotify_albumAlbumA
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. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, account, confirm.
spotify_artistArtistA
Retrieves detailed information about a Spotify artist by their handle, including name, followers count, genres, and related artists. Accepts a handle as input and returns artist metadata such as id, name, followers, genres, and related artists. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, account, confirm.
spotify_playlistPlaylistA
Retrieves public Spotify playlist metadata and up to 50 tracks by playlist id or URL. For playlists with more tracks, pass the returned cursor into the next request until cursor is null. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, cursor, account, +1 more.
spotify_podcastPodcastA
Retrieves detailed information about a Spotify podcast by its id or URL. Spotify calls podcasts shows internally, so Spotify podcast URLs use /show/. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, account, confirm.
spotify_podcast_episodesPodcast EpisodesA
Returns episodes for a Spotify podcast. Pass the cursor returned by a response to get the next page. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, cursor, account, +1 more.
spotify_searchSearchA
Search Spotify for tracks, artists, albums, episodes, podcasts, and audiobooks. Use type=podcasts when you need podcast ids for the podcast endpoints. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), account, confirm.
spotify_trackTrackA
Retrieves detailed information about a Spotify track by its id or URL, including track metadata, artists, album info, duration, playability, and sharing details. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: id, url, account, confirm.
telegram_channel_detailsChannel DetailsA
Retrieves public Telegram channel or group metadata including its name, description, avatar, verification status, subscriber or member count, and public media counters. This endpoint uses Telegram's public web preview and does not use a logged-in Telegram account. Private channels, invite-only groups, numeric IDs, and channels with no public web preview are not supported. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm, cache_max_age.
telegram_channel_postsChannel PostsA
Retrieves one public web-preview page of Telegram posts with text, publish date, views, reactions when exposed, forwards, media previews, and link previews. Pass the returned cursor to fetch the previous page. Empty and terminal pages are not charged. Telegram does not expose every field on every public post, so reactions and downloadable media URLs can be absent. This endpoint does not support private or invite-only channels and groups. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), cursor, account, confirm, +1 more.
telegram_post_detailsPost DetailsA
Retrieves one public Telegram post with its text, publish date, views, reactions when exposed, forward source, media previews, and link preview. This endpoint uses Telegram's public post widget without a logged-in account. Private and invite-only posts are not supported. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
threads_postPostA
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. Also includes comments, threadItems, and relatedPosts arrays. threadItems contains public continuation posts by the original author and stays separate from comments. Supports a trim option for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), trim, account, confirm, +1 more.
threads_postsPostsA
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. Only the last 20-30 posts are publicly visible. Supports a trim option for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), trim, account, confirm.
threads_profileProfileA
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. Also indicates whether the account is a threads-only user via is_threads_only_user. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm, cache_max_age.
threads_search_by_keywordSearch by KeywordA
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. Supports optional start_date and end_date filters plus a trim option. Only 10 results are returned per request due to public API limitations. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), trim, account, confirm, +2 more.
threads_search_usersSearch UsersA
Searches for Threads users by username, returning matching profiles with username, full_name, profile_pic_url, is_verified, and pk. Useful for finding user accounts before fetching their profile or posts. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), account, confirm.
tiktok_ad_library_ad_library_adAd Library AdA
Fetches one TikTok ad by ID or URL. It first checks Creative Center Top Ads (ads.tiktok.com), then TikTok's public transparency Ads Library (library.tiktok.com) when the ID is not a Top Ads material. Both sources return the same response shape. Fields TikTok does not expose for a public Ads Library ad are null, empty, or false as appropriate. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: ad_id (required), account, confirm.
tiktok_ad_library_ad_library_searchAd Library SearchA
Searches TikTok's public Ads Library using either query for a general search or advertiser_name for advertiser-specific results. Advertiser-name searches resolve the name through TikTok's advertiser typeahead first, then search the selected advertiser entity and return adv_biz_ids on each ad. You can pass adv_biz_ids with advertiser_name to pin the exact advertiser shown in TikTok's See all ads link. TikTok requires the name with the ID and ignores an ID-only search, so provide exactly one of query or advertiser_name. If TikTok has no matching advertiser entity, the API falls back to TikTok's name search. Results are global, sorted by the latest shown date, support cursor pagination, and include a public TikTok Ads Library URL for each ad. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query, cursor, account, confirm, +2 more.
tiktok_audience_demographicsUser's Audience DemographicsA
Retrieves audience demographic data for a TikTok user, showing where their followers are located by country. Returns audienceLocations, an array of objects each containing country, countryCode, count, and percentage. Costs 26 credits per request.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm.
tiktok_collection_videosCollection VideosA
Fetches the videos saved in a public TikTok collection, which TikTok also calls a playlist. Pass the collection URL. Returns videos using TikTok's native web video object format, including id, desc, author, stats, and video. To fetch the next page, pass the previous response's max_cursor as cursor when has_more is true.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), cursor, account, confirm.
tiktok_comment_repliesComment RepliesA
Fetches replies to a specific TikTok comment by its ID. Returns comments, an array of comment objects each with text, user info, and create_time. Paginate with cursor from the previous response.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), comment_id (required), cursor, account, +1 more.
tiktok_commentsCommentsA
Fetches comments on a TikTok video by URL — useful for reading audience reactions, replies, and engagement. Returns comments, an array where each comment includes text, digg_count (likes), reply_comment_total, create_time, and a user object with the commenter's nickname and unique_id; also returns total comment count. Paginate with cursor from the previous response.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), trim, cursor, account, +1 more.
tiktok_followersFollowersA
Retrieves the follower list of a TikTok account by handle or user_id — useful for seeing who follows a creator or getting subscriber data. Returns followers, an array of user objects each with nickname, unique_id, uid, follower_count, following_count, and avatar URLs; also returns total follower count. Paginate with min_time from the previous response.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: trim, handle, account, confirm, +2 more.
tiktok_followingFollowingA
Retrieves the following list — accounts that a TikTok user follows — by their handle. Returns followings, an array of user objects each with nickname, unique_id, uid, follower_count, following_count, signature, and avatar URLs; also returns total count. Paginate with min_time from the previous response.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), trim, account, confirm, +1 more.
tiktok_get_popular_creatorsGet popular creatorsA
Discovers trending and popular TikTok creators, filterable by follower count range, creator country, and audience country. Returns creator_list, an array of creator objects each with nickname, unique_id, follower_count, likes_count, video_views, engagement_rate, and avatar URLs. Sortable by engagement, follower count, or average views.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: page, sortBy, account, confirm, +3 more.
tiktok_get_song_detailsGet Song DetailsA
Fetches detailed metadata for a specific TikTok sound or song by its clipId. Returns music_info with title, author, album, duration, user_count (number of videos using this sound), play_url, cover art, and artist details. Use the clipId from a sound URL or from the popular songs endpoint.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: clipId (required), account, confirm.
tiktok_liveLiveA
Checks if a TikTok user is currently live streaming and retrieves their live room details. Use the top-level is_live boolean instead of checking TikTok's numeric status values yourself. Also returns liveRoomUserInfo (nickname, avatar, followerCount, roomId) and liveRoom (title, startTime, status, liveRoomStats with enterCount and userCount, plus streamData with playback URLs in multiple qualities).
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm.
tiktok_live_infoLive InfoA
Gets curated room-level info for a TikTok live using TokAPI's live info endpoint. Use /v1/tiktok/user/live first to find the room_id. If you only have a TikTok handle and need the user's numeric id, use /v1/tiktok/profile first to get user.id. This endpoint is separate from /v1/tiktok/user/live because it uses a different upstream call and returns a smaller response with the most relevant fields: room_id, like_count, viewer_count, status, title, cover_url, and owner.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: room_id (required), user_id (required), account, confirm.
tiktok_profileProfileA
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. Returns a user object (display name, avatar URLs, bio/signature, verification status, bio link) and a stats object (followerCount, followingCount, heartCount/total likes, videoCount). This only returns profile metadata, not the user's actual videos or followers list.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle, account, confirm, user_id, +1 more.
tiktok_profile_regionProfile RegionA
Returns the TikTok region code for a public profile, like US for United States or MX for Mexico.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm.
tiktok_profile_videosProfile VideosA
Fetches videos posted by a TikTok user, sortable by latest or most popular — use this to get a creator's video feed or TikToks. Returns aweme_list, an array of video objects each containing aweme_id, desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count, collect_count/saves), and video (download URLs, duration, cover image). Paginate with max_cursor from the previous response. If a profile should have videos but returns none, try region=US or another relevant two-letter country code.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), trim, region, account, +4 more.
tiktok_search_by_hashtagSearch by HashtagA
Searches for TikTok videos under a specific hashtag — useful for finding content by topic or trend. Returns aweme_list, an array of video objects each with aweme_id, desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count), video info, and author details. Paginate with cursor from the previous response. TikTok may return duplicate results.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: hashtag (required), trim, cursor, region, +2 more.
tiktok_search_by_keywordSearch by KeywordA
Searches for TikTok videos by keyword or phrase — the general video search across all of TikTok. Returns search_item_list, an array of objects each containing aweme_info with aweme_id, desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count), video info, and author details. Paginate with cursor. TikTok may return duplicate results.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), trim, cursor, region, +4 more.
tiktok_search_suggestionsSearch SuggestionsA
Gets the autocomplete suggestions TikTok shows while someone is typing in search. Returns suggestions, a clean array of suggested search terms and the most useful metadata for each suggestion.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), region, account, confirm.
tiktok_search_usersSearch UsersA
Searches for TikTok users by keyword or name — useful for finding creators or accounts matching a query. Returns users, an array of objects each containing user_info (nickname, unique_id, signature/bio, follower_count, following_count, avatar) and associated items. Paginate with cursor from the previous response.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), trim, cursor, account, +1 more.
tiktok_shop_product_detailsProduct DetailsA
Fetches full details for a specific US TikTok Shop product by its URL, including stock levels and affiliate videos. Returns product_info with product_base (title, images, sold_count, price), skus (variants with exact stock counts plus TikTok's sku_name and gtin when available), and product_detail_review (product_rating, review_count, sample reviews). gtin contains gtin_type and gtin_code, or is null when TikTok does not provide a barcode. The response also includes shop_info (shop_name, shop_rating, followers_count) and related_videos (affiliate TikToks promoting the product). This endpoint currently supports the US region only.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), region, account, confirm.
tiktok_shop_product_reviewsProduct ReviewsA
Fetches customer reviews for a TikTok Shop product by URL or product_id. Returns product_reviews, an array of review objects each with rating, display_text, review_timestamp_fmt, review_user (name, avatar), and sku_specification (variant purchased); also returns total_reviews count and rating_distribution. Paginate with page.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, page, region, account, +2 more.
tiktok_shop_shop_productsShop ProductsA
Lists all products from a specific TikTok Shop store by its URL. Returns an array of product objects each with title, cover images, url, price info, sold_count, review_count, and rating. Paginate with cursor from the previous response; filter by region; use sort_by=top for best-selling products or sort_by=new_releases for newest products. Non-US shop catalog coverage depends on TikTok exposing that shop in the selected region, so some shops can return not_found outside the US even when they appear in shop search.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), cursor, region, account, +2 more.
tiktok_shop_shop_searchShop SearchA
Searches TikTok Shop for products matching a keyword query. Returns an array of product objects each with title, cover image, url (product page link), price, sold_count, review_count, rating, and shop_name. Paginate with page; filter by region.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), page, region, account, +1 more.
tiktok_shop_user_showcaseUser ShowcaseA
Fetches products featured in a TikTok user's public showcase — the products a creator promotes on their profile. Returns an array of product objects each with title, price, images, and shop details. Use POST request if pagination is cutting off too early. Just send the query params in the body. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), cursor, region, account, +1 more.
tiktok_tiktoks_using_songTikToks using SongA
Fetches TikTok videos that use a specific sound or song, identified by its clipId. Returns aweme_list, an array of video objects each with aweme_id, desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count), video info, and author details. Paginate with cursor from the previous response.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: clipId, cursor, account, confirm.
tiktok_top_searchTop SearchA
Searches TikTok's 'Top' results by query — returns both videos and photo carousels, unlike keyword search which only returns videos. Returns items, an array of objects each with id, desc (caption), content_type (video or photo carousel), statistics (play_count, digg_count/likes, comment_count, share_count), video info, and images for carousels. Paginate with cursor. TikTok may return duplicate results.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), cursor, region, account, +3 more.
tiktok_transcriptTranscriptA
Extracts existing transcripts, captions, or subtitles from a TikTok video by URL. Returns id, url, and transcript as a WEBVTT-formatted string with timestamped text segments. Existing transcripts work for videos of any length. Only the optional AI fallback is limited to videos up to 2 minutes and costs an additional 10 credits when use_ai_as_fallback=true.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, language, +1 more.
tiktok_trending_feedTrending FeedA
Fetches TikTok's trending/For You feed for a given region — useful for discovering viral content and what's currently popular. Returns aweme_list, an array of video objects each with aweme_id, desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count, collect_count), video (playback and download URLs, cover), author info, and image_post_info for photo carousels.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: region (required), trim, account, confirm.
tiktok_video_infoVideo InfoA
Fetches detailed data for a single TikTok video by URL, including its metadata, engagement stats, and optionally its transcript/captions. Returns aweme_detail with desc (caption), statistics (play_count, digg_count/likes, comment_count, share_count, collect_count), video URLs, author info, and music info; also returns transcript in WEBVTT format if get_transcript=true. For no-watermark video URLs, use aweme_detail.video.download_no_watermark_addr.url_list[0] when it exists. If it is missing and aweme_detail.video.has_watermark is false, use aweme_detail.video.play_addr.url_list[0] instead. If has_watermark is true and download_no_watermark_addr is missing, TikTok did not return a no-watermark URL for that video.
Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), trim, region, account, +4 more.
truth_social_postPostA
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. Set download_media=true to download attached images or video and return permanent Supabase URLs. Only posts from prominent public figures (e.g., Trump, Vance) are accessible without authentication. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, download_media.
truth_social_profileProfileA
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. Only prominent public figures (e.g., Trump, Vance) are accessible without authentication; most other accounts will not work. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm.
truth_social_user_postsUser PostsA
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. Supports pagination via next_max_id and a trim option for lighter responses. Only prominent public figures (e.g., Trump, Vance) are accessible without authentication. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: trim, handle, account, confirm, +2 more.
twitch_clipClipA
Fetches detailed data for a Twitch clip by URL, including metadata and direct video URLs. Returns clip 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. Also includes additional clips from the same broadcaster. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
twitch_clip_transcriptClip TranscriptA
Gets a transcript from a public Twitch clip. The endpoint checks Twitch's native captions first. Set use_ai_as_fallback to true to use AI transcription only when native captions are unavailable. Native transcripts cost 1 credit, AI transcripts cost 10 credits, and no credits are charged when no transcript is found. transcript_source is native, ai, or null. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, use_ai_as_fallback.
twitch_profileProfileA
Retrieves a Twitch user's public profile by handle, including identity, social links, and content. Returns id, handle, displayName, description, followers count, and linked social accounts (instagram, x, tiktok). Also includes allVideos with game info, duration, and view counts, featuredClips with clip metadata and thumbnails, and similarStreamers. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm, cache_max_age.
twitch_user_scheduleUser ScheduleA
Fetches a user's schedule by handle, returning a list of scheduled events with start time, end time, title, description, and thumbnail URL. Supports pagination via cursor and a trim option for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm.
twitch_user_videosUser VideosA
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. Supports pagination via cursor and a trim option for lighter responses. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm, sort_by, +1 more.
twitter_communityCommunityA
Retrieves details about a Twitter/X Community by URL. Returns the community name, description, rest_id, join_policy, created_at, member_count, rules, and creator_results with the creator's profile. Also includes members_facepile_results with avatar images of recent members. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
twitter_community_tweetsCommunity TweetsA
Fetches tweets posted within a Twitter/X Community by URL. Returns an array of tweets, each with id, full_text, view_count, favorite_count, retweet_count, reply_count, bookmark_count, quote_count, created_at, and source. Each tweet includes a user object with the author's name, screen_name, avatar, followers_count, and is_blue_verified status. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
twitter_profileProfileA
Retrieves a Twitter user's profile by handle, including account metadata and statistics. Returns name, screen_name, description, followers_count, friends_count, statuses_count, favourites_count, location, profile_image_url_https, and is_blue_verified. Also includes verification_info, tipjar_settings, highlights_info, and creator_subscriptions_count. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), account, confirm, cache_max_age.
twitter_transcriptTranscriptA
Extracts the transcript from a Twitter video tweet using AI-powered transcription. The video must be under 2 minutes long. Returns a success flag and the full transcript text. This endpoint is slower than others due to the AI processing step. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, cache_max_age.
twitter_tweet_detailsTweet DetailsA
Retrieves detailed information about a specific tweet by URL, including the author's profile and engagement metrics. Returns rest_id, full_text, views count, favorite_count, retweet_count, reply_count, bookmark_count, quote_count, created_at, source, and media entities. Supports a trim parameter for a lighter response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), trim, account, confirm, +1 more.
twitter_user_tweetsUser TweetsA
Fetches tweets from a Twitter user's profile by handle. Note: Twitter publicly returns only ~100 of the user's most popular tweets, not chronological or latest. Each tweet includes rest_id, full_text, views count, favorite_count, retweet_count, reply_count, bookmark_count, quote_count, created_at, media entities, and url. Supports a trim parameter for a lighter response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle (required), trim, account, confirm.
youtube_channel_community_postsChannel Community PostsA
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. Pass a handle or channelId for the first page, then pass continuationToken to page through more posts. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle, account, confirm, channelId, +1 more.
youtube_channel_detailsChannel DetailsA
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. Accepts a channelId, handle, or full channel URL as input. Returns channel metadata such as country, email, and external store links when available. Contact fields come from the submitted public profile. To request removal of your own information from Scrape Creators results, email support@scrapecreators.com with the profile URL. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url, handle, account, confirm, +2 more.
youtube_channel_livesChannel LivesA
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. Pass a handle or channelId for the first page, then pass continuationToken to page through more lives. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle, account, confirm, channelId, +1 more.
youtube_channel_playlistsChannel PlaylistsA
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. Pass a handle or channelId for the first page, then pass continuationToken to page through more playlists. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: handle, account, confirm, channelId, +1 more.
youtube_channel_shortsChannel ShortsA
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. publishDate is a full ISO 8601 timestamp with an offset when YouTube exposes the exact publish time; otherwise it is null. It does not return date-only strings. Supports sorting by newest or popular; use the continuationToken to page through all results. Returns data in the shorts array. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: sort, handle, account, confirm, +2 more.
youtube_channel_videosChannel VideosA
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. Supports sorting by latest or popular, and use the continuationToken to page through all results. Optionally include extras like like count, comment count, and descriptions for each video. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: sort, handle, account, confirm, +4 more.
youtube_comment_repliesComment RepliesA
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. Requires a continuationToken obtained from the 'repliesContinuationToken' field on comments returned by the Comments endpoint. Supports paginating through additional replies with the continuationToken returned in each response. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: continuationToken (required), account, confirm.
youtube_commentsCommentsA
Fetches comments and replies from a YouTube video, including each comment's text content, author details, like count, reply count, and publish date. Supports ordering by top or newest, and paginating with continuationToken. Limited to approximately 1,000 top comments or 7,000 newest comments. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), order, account, confirm, +1 more.
youtube_community_post_detailsCommunity Post DetailsA
Retrieves the full details of a YouTube community post, including its text content, attached images, like count, publish date, and associated channel info. Also returns a linked video if the post includes one. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm.
youtube_playlistPlaylistA
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. Accepts the playlist ID found in the 'list' URL parameter. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: playlist_id (required), account, confirm.
youtube_searchSearchA
Searches YouTube by keyword query and returns matching videos, channels, playlists, shorts, shelves, and live streams. Each video result includes title, URL, thumbnail, view count (views), publish date, duration, channel info, and badges. Supports filtering by upload date, sorting by relevance or popularity, and paginating with continuationToken. Set is_paid_promotions=true to search YouTube videos with the paid product placement / sponsorship disclosure. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), type, region, sortBy, +6 more.
youtube_search_by_hashtagSearch by HashtagA
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. Supports pagination via continuationToken and filtering to return all content types or only shorts. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: hashtag (required), type, account, confirm, +1 more.
youtube_search_typeaheadSearch TypeaheadA
Returns the live search suggestions YouTube displays while a user types. Each result includes the suggested text and whether it is a normal query or a channel. When YouTube returns a channel suggestion, the response also includes its public channel ID, handle, name, and thumbnail. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: query (required), account, confirm.
youtube_transcriptTranscriptA
Retrieves publicly available captions, subtitles, or transcripts from a YouTube video or Short. Returns both a timestamped transcript array with start/end times and a plain-text version in transcript_only_text. Supports specifying a language code. Videos of any length are supported when YouTube exposes public captions. This endpoint does not use the two-minute AI transcription fallback. If no matching caption track is available, the transcript fields return null. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, language, +2 more.
youtube_trending_shortsTrending ShortsA
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. Each subsequent call returns a fresh batch of different trending shorts. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: account, confirm.
youtube_video_short_detailsVideo/Short DetailsA
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). isPaidPromotion is true when YouTube marks the video as including paid promotion and false when it does not. Also returns related recommended videos in watchNextVideos and channel info for the uploader. When YouTube exposes its public Most replayed graph, most_replayed contains normalized graph buckets in markers and YouTube's highlighted ranges in ranges. The field is null when the graph is not available. YouTube says the graph may be unavailable when the channel has active strikes, the content is potentially inappropriate, the video is too new or has too few views, or its systems deem the video ineligible for another reason. YouTube does not publish fixed age or view-count thresholds. Age-restricted videos return 403 with message: "This video is age restricted" because Scrape Creators only uses the public logged-out YouTube source. Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, language, +1 more.
youtube_video_sponsorsVideo SponsorsA
Experimental endpoint. Checks a YouTube video for the paid-promotion disclosure and infers likely sponsors/promoted brands from the public description, description links, promo-code text, and transcript. YouTube tells us that a video contains paid promotion, but it does not always tell us the sponsor directly, so this endpoint returns suspected sponsors with confidence and evidence. This is inferred, not an official YouTube sponsor field. Feedback welcome: support@scrapecreators.com Potentially consumes paid API credits; requires confirm=true. Read-like POST requests do not publish to social platforms.
Inputs: url (required), account, confirm, language.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 190 tools
Many tools have overlapping purposes, especially within platforms: multiple search endpoints (tiktok_search_by_keyword, tiktok_top_search, tiktok_search_by_hashtag), duplicate GET/POST pairs with identical descriptions (facebook_ad_library_search vs search_post), and near-identical live endpoints (tiktok_live vs tiktok_live_info). Detailed descriptions mitigate some confusion, but the volume and similarity make misselection likely.
Most tools follow a snake_case platform_resource_action pattern, but there are inconsistencies: nested prefixes (facebook_facebook_group_info, tiktok_ad_library_ad_library_search), duplicate _post suffixes, and some tools without platform context (list_accounts, research_batch). Still, the convention is generally readable.
190 tools is far beyond the typical 3-15 range and represents an extreme mismatch for a single MCP server. While the domain spans many platforms, the count overwhelms an agent's ability to select appropriately.
The surface covers many platforms and operations (profiles, posts, comments, search, transcripts, ad libraries), but there are gaps such as missing Twitter search and Twitter follower/following endpoints. For a read-only scraping API, coverage is extensive though not exhaustive.
Maintenance
Related MCP Connectors
Discover, inspect and run 63,000+ agent tools from one balance. Pay per call, no subscriptions.
660+ data tools for agents: TikTok, Douyin, Instagram, YouTube, X, weather, GitHub. Pay per call.
30+ marketing data tools for AI agents: keywords, SERP, backlinks, AI visibility, app store & commerce intelligence, Reddit/LinkedIn/Facebook/YouTube research, web search, page extraction, site audit, image & video generation, one-shot marketing apps. Bring your own API key from supamarketers.com — per-tool pricing in Credits.
17 pay-per-call web, finance, legal and onchain tools for AI agents. USDC on Base via x402/MPP.
Related MCP Servers
AlicenseAqualityBmaintenanceEnables assistants to retrieve public TikTok, Instagram, and YouTube stats, profiles, recent posts, and YouTube transcripts through read-only tools.1024 npmMIT- AlicenseNot gradedqualityBmaintenanceConnects a user's existing LinkedIn, WhatsApp, Instagram, Telegram, email and calendar accounts to any MCP-compatible agent so it can search, read and act on them without browser automation, including outreach, messaging, inbox triage and event management. It provides 170+ intent-named tools with OAuth 2.1 authentication, per-provider pacing, and approval prompts before sends, posts or deletions.MIT

SocialToAI MCP Serverofficial
AlicenseNot gradedqualityCmaintenanceEnables AI tools to read publicly visible social media posts, comments, profiles, and trends from 18 platforms such as TikTok, Instagram, X, Reddit, YouTube, Xiaohongshu, and Weibo, on a prepaid pay-per-call basis where failed calls are free. Ships tools for search, trending, detail, comments, user profiles and posts, plus higher-level workflows like brand buzz, comment analysis, account watching, creator discovery, bulk link data, and viral finding.MIT- AlicenseAqualityCmaintenanceExposes a dynamically registered tool for each public social data endpoint, letting MCP clients like Claude, Cursor, and VS Code pull profiles, posts, comments, transcripts, and search results as clean typed JSON from nine platforms. Tool descriptions surface credit costs and returned fields upfront, with failed calls refunded, bounded results, and readable errors that never auto-retry.4250 npm3MIT