---
canonical_url: "https://docs.composio.dev/toolkits/scrapecreators"
markdown_url: "https://docs.composio.dev/toolkits/scrapecreators.md"
product: "platform"
version: null
last_updated: null
---

# ScrapeCreators

ScrapeCreators extracts public profiles, posts, videos, comments, ads, and other data from social media and content platforms.

- **Category:** social & creator data
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 71
- **Triggers:** 0
- **Slug:** `SCRAPECREATORS`
- **Version:** 20261014_02
- **Instant:** Supported on the latest version. Support varies by tool.

## Tools

### Find Creator Social Profiles

**Slug:** `SCRAPECREATORS_FIND_CREATOR_SOCIAL_PROFILES`

Discover and verify a creator's linked profiles across supported social platforms from one source handle. A live lookup costs 10 credits; use cache_max_age when stale results are acceptable.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Creator handle without a profile URL; a leading @ is optional. A live discovery costs 10 credits. |
| `platform` | string ("instagram" | "tiktok" | "youtube" | "x" | "twitter" | "facebook") | Yes | Source platform for the creator handle; x and twitter are accepted aliases. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit to perform a live 10-credit lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credit Balance

**Slug:** `SCRAPECREATORS_GET_CREDIT_BALANCE`

Return the connected ScrapeCreators account's remaining prepaid credit balance without consuming credits.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Facebook Ad

**Slug:** `SCRAPECREATORS_GET_FACEBOOK_AD`

Return creative, advertiser, platform, delivery, spend, reach, and active-period details for one Meta Ad Library ad. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public Meta Ad Library ad URL. Provide exactly one of url or ad_id. |
| `trim` | boolean | No | Return the smaller ad representation while retaining creative, advertiser, dates, reach, and spend. |
| `ad_id` | string | No | Meta Ad Library ad ID. Provide exactly one of ad_id or url. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Facebook Ad Transcript

**Slug:** `SCRAPECREATORS_GET_FACEBOOK_AD_TRANSCRIPT`

Retrieve any available native captions or AI transcript for one Meta Ad Library video ad; the transcript is null when the ad has no video or transcription is unavailable. Long-transcription opt-in uses higher usage pricing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public Meta Ad Library URL. Provide exactly one of url or ad_id. |
| `ad_id` | string | No | Meta Ad Library ad ID. Provide exactly one of ad_id or url. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits when available. |
| `allow_long_transcription` | boolean | No | Allow AI transcription without a fixed duration cap. Successful AI transcripts then cost 10 credits per started minute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Facebook Post

**Slug:** `SCRAPECREATORS_GET_FACEBOOK_POST`

Return content, author, media, engagement, and the feedback ID for one public Facebook post or reel. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public Facebook post or reel URL. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Facebook Profile

**Slug:** `SCRAPECREATORS_GET_FACEBOOK_PROFILE`

Return public identity, audience, contact, business, and Ad Library metadata for one Facebook profile or Page. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public Facebook profile or Page URL. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |
| `get_business_hours` | boolean | No | Include publicly listed business opening hours. |
| `include_gated_profile` | boolean | No | Return limited public fields when the profile is gated or age-restricted; normal public profiles still return full data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GitHub Repository

**Slug:** `SCRAPECREATORS_GET_GITHUB_REPOSITORY`

Return public metadata, ownership, popularity, language, topics, license, and activity for one GitHub repository. This lookup costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public GitHub repository URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GitHub User

**Slug:** `SCRAPECREATORS_GET_GITHUB_USER`

Return public identity, biography, organization, location, social links, and repository and follower counts for one GitHub user. This lookup costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public GitHub profile URL. Provide exactly one of url or handle. |
| `handle` | string | No | GitHub username. Provide exactly one of handle or url. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get GitHub User Contributions

**Slug:** `SCRAPECREATORS_GET_GITHUB_USER_CONTRIBUTIONS`

Return a GitHub user's public contribution graph for one year, including the annual total and daily counts and intensity levels. This lookup costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public GitHub profile URL. Provide exactly one of url or handle. |
| `year` | integer | No | Contribution graph year; omit for the current year. |
| `handle` | string | No | GitHub username. Provide exactly one of handle or url. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Google Ad

**Slug:** `SCRAPECREATORS_GET_GOOGLE_AD`

Return creative variations, advertiser, format, regions, impression estimates, and display dates for one Google Ads Transparency ad. Text fields are extracted with OCR and may contain inaccuracies. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public Google Ads Transparency ad URL. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Media Transcript

**Slug:** `SCRAPECREATORS_GET_INSTAGRAM_MEDIA_TRANSCRIPT`

Transcribe speech from an Instagram video or reel under two minutes, returning one transcript per video slide when applicable. A live transcription costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public Instagram post or reel URL containing video under two minutes. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live transcription that may take 10-30 seconds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Post

**Slug:** `SCRAPECREATORS_GET_INSTAGRAM_POST`

Return detailed metadata and engagement for one Instagram post or reel. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public Instagram post or reel URL. |
| `trim` | boolean | No | Return the provider's smaller response while retaining core post fields. |
| `region` | string | No | Optional two-letter proxy country code. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live scrape. |
| `include_play_count` | boolean | No | Include the Instagram video play count. Set false to skip the extra fetch and reduce latency. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Instagram Profile

**Slug:** `SCRAPECREATORS_GET_INSTAGRAM_PROFILE`

Return public identity, biography, verification, links, and account statistics for one Instagram profile; this does not return the post feed. A live scrape costs 1 credit, while an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return the provider's smaller profile response while retaining core identity and statistics. |
| `handle` | string | Yes | Instagram handle without a profile URL. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Ad

**Slug:** `SCRAPECREATORS_GET_LINKEDIN_AD`

Return advertiser, creative, destination, targeting, impressions, and run dates for one public LinkedIn ad. Date and impression data may be null when LinkedIn does not expose them. This request costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public LinkedIn Ad Library ad URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Company

**Slug:** `SCRAPECREATORS_GET_LINKEDIN_COMPANY`

Return public company identity, industry, workforce, funding, headquarters, specialties, and website data from LinkedIn. The lookup costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public LinkedIn company Page URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Post

**Slug:** `SCRAPECREATORS_GET_LINKEDIN_POST`

Return content, author, publication date, engagement, and embedded comments for one public LinkedIn post or article. The lookup costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public LinkedIn post or article URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Profile

**Slug:** `SCRAPECREATORS_GET_LINKEDIN_PROFILE`

Return public professional identity, experience, education, activity, and audience data for one LinkedIn person profile. The lookup costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public LinkedIn person profile URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reddit Post

**Slug:** `SCRAPECREATORS_GET_REDDIT_POST`

Return content, author, community, score, flags, media URL, and comment count for one public Reddit post. This lookup costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public Reddit post URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reddit Subreddit

**Slug:** `SCRAPECREATORS_GET_REDDIT_SUBREDDIT`

Return public metadata, rules, audience size, and activity statistics for one subreddit. A live lookup costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public subreddit URL. Provide exactly one of url or subreddit. |
| `subreddit` | string | No | Case-sensitive subreddit name, such as AskReddit. Provide exactly one of subreddit or url. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Threads Post

**Slug:** `SCRAPECREATORS_GET_THREADS_POST`

Return content, author, media, engagement, comments, and related context for one public Threads post. A live scrape costs 1 credit, while an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public Threads post URL. |
| `trim` | boolean | No | Return the provider's smaller response while retaining the post and comments. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Threads Profile

**Slug:** `SCRAPECREATORS_GET_THREADS_PROFILE`

Return public identity, biography, links, verification, privacy, and follower data for one Threads profile. A live scrape costs 1 credit, while an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Threads username without a profile URL. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get TikTok Ad

**Slug:** `SCRAPECREATORS_GET_TIKTOK_AD`

Return creative, advertiser, objective, landing-page, performance, audience, and video details for one TikTok ad. The lookup costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ad_id` | string | Yes | TikTok Creative Center material ID, public Ads Library ad ID, or corresponding public detail URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get TikTok Profile

**Slug:** `SCRAPECREATORS_GET_TIKTOK_PROFILE`

Return public identity, bio, verification, and account statistics for one TikTok creator; this does not return the creator's video feed. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | No | TikTok handle. Provide exactly one of handle or user_id. |
| `user_id` | string | No | TikTok numeric user ID. Provide exactly one of user_id or handle. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get TikTok Video

**Slug:** `SCRAPECREATORS_GET_TIKTOK_VIDEO`

Return metadata, engagement, author, music, and media URLs for one TikTok video. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public TikTok video URL. |
| `trim` | boolean | No | Return the provider's smaller response while retaining core video details. |
| `region` | string | No | Two-letter proxy country code to use when the default region cannot retrieve the video. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get TikTok Video Transcript

**Slug:** `SCRAPECREATORS_GET_TIKTOK_VIDEO_TRANSCRIPT`

Extract a timestamped WEBVTT transcript from a TikTok video under two minutes. A native-caption lookup costs 1 credit; optional AI fallback adds 10 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public TikTok video URL for a video under two minutes. |
| `language` | string | No | Preferred two-letter transcript language code, such as en or es. |
| `use_ai_as_fallback` | boolean | No | If true, use AI when native captions are unavailable. This adds 10 credits and only supports videos under two minutes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Twitter Profile

**Slug:** `SCRAPECREATORS_GET_TWITTER_PROFILE`

Return public identity, biography, verification, audience, business, and subscription metadata for one X/Twitter account. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | X/Twitter handle without a profile URL. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Twitter Tweet

**Slug:** `SCRAPECREATORS_GET_TWITTER_TWEET`

Return content, author, media, views, and engagement for one public X/Twitter post. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public X/Twitter post URL. |
| `trim` | boolean | No | Return the provider's smaller tweet representation while retaining core content and engagement. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Twitter Tweet Transcript

**Slug:** `SCRAPECREATORS_GET_TWITTER_TWEET_TRANSCRIPT`

Return the available transcript for a video under two minutes attached to one public X/Twitter post. Longer videos are unsupported. A live lookup costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public X/Twitter post URL containing a video under two minutes. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get YouTube Channel

**Slug:** `SCRAPECREATORS_GET_YOUTUBE_CHANNEL`

Return public profile, subscriber and view statistics, tags, country, and linked accounts for one YouTube channel. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public YouTube channel URL. Provide exactly one of url, channel_id, or handle. |
| `handle` | string | No | YouTube channel handle. Provide exactly one of handle, channel_id, or url. |
| `channel_id` | string | No | YouTube channel ID. Provide exactly one of channel_id, handle, or url. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get YouTube Video

**Slug:** `SCRAPECREATORS_GET_YOUTUBE_VIDEO`

Return metadata, engagement, chapters, creator, paid-promotion status, and caption-track availability for one YouTube video or Short. A live scrape costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public YouTube video or Short URL. |
| `language` | string | No | Preferred two-letter response language; YouTube localization may not honor it exactly. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get YouTube Video Transcript

**Slug:** `SCRAPECREATORS_GET_YOUTUBE_VIDEO_TRANSCRIPT`

Return timestamped and plain-text public captions for a YouTube video or Short, including long videos when captions exist. A live lookup costs 1 credit; an eligible cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public YouTube video or Short URL. |
| `language` | string | No | Preferred two-letter caption language code. Transcript fields are null if no matching public track exists. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live 1-credit lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Amazon Shop Products

**Slug:** `SCRAPECREATORS_LIST_AMAZON_SHOP_PRODUCTS`

Return one page of a creator's Amazon Shop storefront collections, shoppable videos, trending products, and curations. Each page costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public Amazon Shop storefront URL; required on the first page. |
| `next_cursor` | string | No | Opaque cursor returned by the previous shop page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List API Request History

**Slug:** `SCRAPECREATORS_LIST_API_REQUEST_HISTORY`

Return one page of the connected account's API request history, optionally filtered by a partial endpoint match or HTTP response status code. Each row shows the platform request's credits and cache status: live scrapes can consume route-specific credits while cache hits can cost zero. These account analytics do not initiate a platform scrape or accept cache_max_age. ScrapeCreators documents no fixed per-minute limit and recommends fewer than 500 concurrent requests. Reading this account report costs zero credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | One-based request-history page string to return (1-100). |
| `endpoint` | string | No | Return only requests whose API endpoint partially matches this value. |
| `status_code` | string | No | HTTP response status-code string used to filter request history. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Daily Usage

**Slug:** `SCRAPECREATORS_LIST_DAILY_USAGE`

List daily credit totals and request counts for the connected account. ScrapeCreators fixes the reporting range to the last 30 days and accepts no request parameters. This account report does not initiate a platform scrape or accept cache_max_age, and reading it costs zero credits.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Facebook Company Ads

**Slug:** `SCRAPECREATORS_LIST_FACEBOOK_COMPANY_ADS`

Return one page of Meta Ad Library ads for a company or Page with delivery, status, media, language, date, and sort filters. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return a smaller ad representation while retaining core creative and delivery fields. |
| `status` | string ("ALL" | "ACTIVE" | "INACTIVE") | No | Filter by current ad status. |
| `country` | string | No | Single two-letter country code, or ALL for all countries. |
| `page_id` | string | No | Meta Ad Library Page ID. Provide exactly one of page_id or company_name. |
| `sort_by` | string ("total_impressions" | "relevancy_monthly_grouped") | No | Sort by highest impressions or most recent monthly relevance. |
| `end_date` | string | No | Latest impression date in YYYY-MM-DD format. |
| `language` | string | No | Optional two-letter uppercase ad language code. |
| `media_type` | string ("ALL" | "IMAGE" | "VIDEO" | "MEME" | "IMAGE_AND_MEME" | "NONE") | No | Filter by Meta's media classification. |
| `start_date` | string | No | Earliest impression date in YYYY-MM-DD format. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |
| `company_name` | string | No | Company name. Provide exactly one of company_name or page_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Facebook Post Comments

**Slug:** `SCRAPECREATORS_LIST_FACEBOOK_POST_COMMENTS`

Return one page of comments on a Facebook post or reel, accepting its URL or the faster feedback ID. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public Facebook post or reel URL. Provide exactly one of url or feedback_id on the first page. |
| `feedback_id` | string | No | Feedback ID returned by GET_FACEBOOK_POST. Provide exactly one of feedback_id or url; feedback_id is much faster when known. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Facebook Profile Photos

**Slug:** `SCRAPECREATORS_LIST_FACEBOOK_PROFILE_PHOTOS`

Return one page of public photos from a Facebook profile or Page. To continue, send the same URL with both continuation values returned by the previous page. Each page costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public Facebook profile or Page URL. |
| `next_cursor` | string | No | Cursor returned in next_cursor by the previous page. Provide it together with next_page_id, or omit both for the first page. |
| `next_page_id` | string | No | Page identifier returned by the previous page. Provide it together with next_cursor, or omit both for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Facebook Profile Posts

**Slug:** `SCRAPECREATORS_LIST_FACEBOOK_PROFILE_POSTS`

Return one page of up to three public posts from a Facebook profile or Page with a cursor for the next page. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public Facebook profile or Page URL. Provide exactly one of url or page_id on the first page. |
| `page_id` | string | No | Facebook Page ID. Provide exactly one of page_id or url on the first page; page_id is faster when known. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List GitHub Trending Repositories

**Slug:** `SCRAPECREATORS_LIST_GITHUB_TRENDING_REPOSITORIES`

Return GitHub's current trending repositories filtered by programming language, period, and optional spoken language. This request costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | string ("daily" | "weekly" | "monthly") | No | Trending measurement period. |
| `language` | string | No | Optional programming language slug, such as javascript, python, or go. |
| `spoken_language_code` | string | No | Optional spoken-language code, such as en. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List GitHub User Activity

**Slug:** `SCRAPECREATORS_LIST_GITHUB_USER_ACTIVITY`

Return one month page of a GitHub user's public contribution activity for a selected year. Pages move backward by month, and each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public GitHub profile URL. Provide exactly one of url or handle on the first page. |
| `year` | integer | No | Contribution year; omit for the current year. |
| `handle` | string | No | GitHub username. Provide exactly one of handle or url on the first page. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; pages backward by month. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List GitHub User Pull Requests

**Slug:** `SCRAPECREATORS_LIST_GITHUB_USER_PULL_REQUESTS`

Return one page of a GitHub user's public pull requests, sorted newest first, with optional creation-date filters and a cursor for the next page. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `since` | string | No | Only include pull requests created on or after this YYYY-MM-DD date. |
| `until` | string | No | Only include pull requests created on or before this YYYY-MM-DD date. |
| `handle` | string | Yes | GitHub username whose public pull requests to list. |
| `next_cursor` | string | No | Cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List GitHub User Repositories

**Slug:** `SCRAPECREATORS_LIST_GITHUB_USER_REPOSITORIES`

Return one page of repositories associated with a GitHub user, filtered by ownership and sort order, with a cursor for the next page. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public GitHub profile URL. Provide exactly one of url or handle on the first page. |
| `handle` | string | No | GitHub username. Provide exactly one of handle or url on the first page. |
| `sort_by` | string ("created" | "updated" | "pushed" | "full_name") | No | Repository field used for ordering. |
| `direction` | string ("asc" | "desc") | No | Ascending or descending sort direction. |
| `next_cursor` | string | No | Cursor returned by the previous page; omit for the first page. |
| `repository_type` | string ("owner" | "all" | "member") | No | Include owned repositories, all associated repositories, or membership repositories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Google Company Ads

**Slug:** `SCRAPECREATORS_LIST_GOOGLE_COMPANY_ADS`

Return one page of Google Ads Transparency creatives for a company. The default get_ad_details=false request costs 1 credit. Setting get_ad_details=true costs exactly 25 credits per request and must be explicitly requested.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `topic` | string ("all" | "political") | No | Search all ads or political ads; political ads require region. |
| `domain` | string | No | Company domain. Provide exactly one of domain or advertiser_id on the first page. |
| `region` | string | No | Uppercase two-letter region code; required when topic is political. |
| `end_date` | string | No | Latest display date in YYYY-MM-DD format. |
| `platform` | string ("google_maps" | "google_play" | "google_search" | "google_shopping" | "youtube") | No | Limit ads to one Google surface. |
| `ad_format` | string ("text" | "image" | "video") | No | Limit ads to one creative format. |
| `start_date` | string | No | Earliest display date in YYYY-MM-DD format. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |
| `advertiser_id` | string | No | Google Ads Transparency advertiser ID. Provide exactly one of advertiser_id or domain on the first page. |
| `get_ad_details` | boolean | No | If true, expand every ad's details. This costs exactly 25 credits per request instead of 1 credit. Leave false unless bulk detail expansion is explicitly required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Instagram Post Comments

**Slug:** `SCRAPECREATORS_LIST_INSTAGRAM_POST_COMMENTS`

Return one page of comments on an Instagram post or reel. Reply expansion defaults to false. Enabling it always costs 15 credits even if no replies are found, is much slower, and may time out near 29 seconds.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public Instagram post or reel URL whose comments to list. |
| `next_cursor` | string | No | Opaque cursor returned by the previous comment page; omit for the first page. |
| `include_replies` | boolean | No | If true, fetch the first reply page for every returned comment. This always costs 15 credits even if no replies are found, is much slower, and may time out near 29 seconds. Defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Instagram User Posts

**Slug:** `SCRAPECREATORS_LIST_INSTAGRAM_USER_POSTS`

Return one page of a public Instagram user's posts, reels, photos, videos, and carousels with a cursor for the next page. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return the provider's smaller response while retaining core post fields. |
| `handle` | string | Yes | Instagram handle whose public content feed to list. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Instagram User Reels

**Slug:** `SCRAPECREATORS_LIST_INSTAGRAM_USER_REELS`

Return one page of a public Instagram user's reels by user ID or handle with an opaque continuation cursor. Each page costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return the provider's smaller response while retaining core reel fields. |
| `handle` | string | No | Instagram handle to use when the numeric user ID is unavailable. Provide user_id or handle on the first page. |
| `user_id` | string | No | Instagram numeric user ID; preferred because it is faster than handle lookup. Provide user_id or handle on the first page. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List LinkedIn Company Posts

**Slug:** `SCRAPECREATORS_LIST_LINKEDIN_COMPANY_POSTS`

Return one numeric page of public posts from a LinkedIn company Page. LinkedIn limits this endpoint to pages 1 through 7, each costing 1 credit; the provider returns no next-page metadata.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public LinkedIn company Page URL. |
| `page` | integer | No | One-based page number to retrieve (1-7). The provider returns no next-page metadata, and each page costs 1 credit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Most Used Routes

**Slug:** `SCRAPECREATORS_LIST_MOST_USED_ROUTES`

Return the account's top 20 API routes ranked by call count, with total credits consumed by calls to each route. The report defaults to the last 24 hours and accepts a custom time range of at most one year. It reports platform charging but does not initiate a platform scrape or accept cache_max_age, and reading the report costs zero credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | string | No | Optional end of the usage window as an ISO 8601 timestamp. May be supplied without start_time. |
| `start_time` | string | No | Optional start of the usage window as an ISO 8601 timestamp. May be supplied without end_time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Reddit Post Comments

**Slug:** `SCRAPECREATORS_LIST_REDDIT_POST_COMMENTS`

Return one page of public comments or replies for a Reddit post. The tool queues every independent continuation branch while sending only one provider cursor per request. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public Reddit post URL. |
| `trim` | boolean | No | Return the smaller comment representation while retaining text, authors, votes, timestamps, depth, and replies. |
| `next_cursor` | string | No | Opaque cursor returned by this tool's previous response. Pass it unchanged and never combine multiple cursors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Reddit Subreddit Posts

**Slug:** `SCRAPECREATORS_LIST_REDDIT_SUBREDDIT_POSTS`

Return one page of posts from a subreddit with sort and timeframe controls and an opaque cursor for the next page. A live page costs 1 credit; a cache hit costs 0 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("best" | "hot" | "new" | "top" | "rising") | No | Reddit listing order. |
| `trim` | boolean | No | Return the smaller post representation while retaining core content and engagement. |
| `subreddit` | string | Yes | Subreddit name without the r/ prefix. |
| `timeframe` | string ("all" | "day" | "week" | "month" | "year") | No | Time range for top posts. Set only when sort is top; omit for all other sorts. |
| `next_cursor` | string | No | Opaque after token returned by the previous page; omit for the first page. |
| `cache_max_age` | string ("1d" | "3d" | "7d" | "14d" | "30d") | No | Return a cache entry this age or newer for 0 credits; omit for a live scrape. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Threads User Posts

**Slug:** `SCRAPECREATORS_LIST_THREADS_USER_POSTS`

Return the currently public recent posts for one Threads profile in a single response. Threads exposes only about the latest 20 to 30 posts and this endpoint provides no pagination. Each request costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return the provider's smaller post representation while retaining core content and engagement. |
| `handle` | string | Yes | Threads username whose public posts to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List TikTok Profile Videos

**Slug:** `SCRAPECREATORS_LIST_TIKTOK_PROFILE_VIDEOS`

Return one page of a TikTok creator's posted videos, sorted by latest or popularity, with a cursor for the next page. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return the provider's smaller response while retaining core video fields. |
| `handle` | string | No | TikTok handle whose posted videos to list. |
| `region` | string | No | Two-letter proxy country code. The provider defaults to GB; try the creator's region if an expected feed is empty. |
| `sort_by` | string ("latest" | "popular") | No | Order videos by newest first or most popular first. |
| `user_id` | string | No | TikTok numeric user ID for faster responses when already known. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List TikTok Video Comments

**Slug:** `SCRAPECREATORS_LIST_TIKTOK_VIDEO_COMMENTS`

Return one page of public comments for a TikTok video or slideshow URL with an opaque continuation cursor. Each page costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public TikTok video or slideshow URL; required on the first page. |
| `trim` | boolean | No | Return the provider's concise comment representation. |
| `next_cursor` | string | No | Opaque continuation cursor from the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Twitter User Tweets

**Slug:** `SCRAPECREATORS_LIST_TWITTER_USER_TWEETS`

Return the public tweets currently exposed for one X/Twitter account in a single response. X/Twitter typically exposes roughly 100 popular tweets, not a chronological or complete history. The request costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return the provider's smaller tweet representation while retaining content, author, media, dates, and engagement. |
| `handle` | string | Yes | X/Twitter handle whose public tweets to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List YouTube Channel Videos

**Slug:** `SCRAPECREATORS_LIST_YOUTUBE_CHANNEL_VIDEOS`

Return one page of videos uploaded by a YouTube channel, sorted by latest or popularity, with an opaque cursor for the next page. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("latest" | "popular") | No | Order videos by newest first or most popular first. |
| `handle` | string | No | YouTube channel handle. Provide exactly one of handle or channel_id. |
| `channel_id` | string | No | YouTube channel ID. Provide exactly one of channel_id or handle. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |
| `paid_promotions_only` | boolean | No | If true, use YouTube's public paid-promotion search surface. Do not supply sort with this option. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List YouTube Video Comments

**Slug:** `SCRAPECREATORS_LIST_YOUTUBE_VIDEO_COMMENTS`

Return one ordered page of public comments on a YouTube video or Short, with an opaque cursor for the next comment page. Each page costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public YouTube video or Short URL; required on the first page. |
| `order` | string ("top" | "newest") | No | Order comments by top ranking or newest first. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Facebook Ad Library

**Slug:** `SCRAPECREATORS_SEARCH_FACEBOOK_AD_LIBRARY`

Search Meta's public Ad Library by keyword with country, language, status, media, date, and political-ad filters, returning one page and an opaque cursor. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return a smaller response while retaining ad identity, creative, delivery, and advertiser fields. |
| `query` | string | No | Keyword or phrase to search for in public Meta Ad Library ads. |
| `status` | string ("ALL" | "ACTIVE" | "INACTIVE") | No | Filter by current ad status. |
| `ad_type` | string ("all" | "political_and_issue_ads") | No | Search all ads or only political and issue ads. |
| `country` | string | No | Single uppercase two-letter country code, or ALL for all countries. |
| `sort_by` | string ("total_impressions" | "relevancy_monthly_grouped") | No | Sort by highest impressions or most recent monthly relevance. |
| `end_date` | string | No | Latest impression date in YYYY-MM-DD format. |
| `language` | string | No | Optional uppercase two-letter ad language code. |
| `media_type` | string ("ALL" | "IMAGE" | "VIDEO" | "MEME" | "IMAGE_AND_MEME" | "NONE") | No | Filter by the media classification used by Meta Ad Library. |
| `start_date` | string | No | Earliest impression date in YYYY-MM-DD format. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |
| `search_type` | string ("keyword_unordered" | "keyword_exact_phrase") | No | Match query terms in any order or as an exact phrase. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Facebook Videos

**Slug:** `SCRAPECREATORS_SEARCH_FACEBOOK_VIDEOS`

Search Facebook's native public video and Reel index by keyword, returning one ranked page and an opaque continuation cursor. Each page costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Keyword or phrase to search for in Facebook's public video index. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Google Advertisers

**Slug:** `SCRAPECREATORS_SEARCH_GOOGLE_ADVERTISERS`

Search Google Ads Transparency advertisers by name or keyword in one country. Returns advertiser IDs and associated domains for subsequent company-ad searches. Each search costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Advertiser name or keyword to search for. |
| `region` | string | No | Uppercase two-letter country code used for the search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Google Web

**Slug:** `SCRAPECREATORS_SEARCH_GOOGLE_WEB`

Search Google organic web results by query with optional country, recency, and page filters. Supports pages 1 through 11. Each request costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Result page from 1 through 11. |
| `query` | string | Yes | Google web search query. |
| `region` | string | No | Uppercase two-letter country code for localized results. |
| `date_posted` | string ("last-hour" | "last-day" | "last-week" | "last-month" | "last-year") | No | Restrict results to the last hour, day, week, month, or year. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Instagram

**Slug:** `SCRAPECREATORS_SEARCH_INSTAGRAM`

Search Instagram-native users, hashtags, places, and keyword suggestions by query. Returns one ranked page and does not return posts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Username, hashtag, place, or keyword to search for on Instagram. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Instagram Profiles

**Slug:** `SCRAPECREATORS_SEARCH_INSTAGRAM_PROFILES`

Search Instagram's native ranked profile results by profile name or username, returning the complete first result set without posts or pagination. Each request costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Profile name or username to search for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Instagram Reels

**Slug:** `SCRAPECREATORS_SEARCH_INSTAGRAM_REELS`

Search Google-indexed public Instagram reels by keyword and optional recency, returning one page and a bounded continuation cursor. Results are best-effort rather than a complete Instagram-native index. Each page costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Keyword or phrase to search for in Google-indexed Instagram reels. |
| `date_posted` | string ("last-week" | "last-month" | "last-year") | No | Limit results by Google-indexed posting recency. |
| `next_cursor` | string | No | Opaque continuation cursor from the previous page; omit for the first page. Search supports at most 11 pages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Ads

**Slug:** `SCRAPECREATORS_SEARCH_LINKEDIN_ADS`

Search LinkedIn's public Ad Library by company, company ID, or keyword with country and date filters, returning one page and an opaque cursor. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company` | string | No | Company name to search for. Provide company, company_id, or keyword for the first page. |
| `keyword` | string | No | Ad keyword to search for. Provide keyword, company, or company_id for the first page. |
| `end_date` | string | No | End date in YYYY-MM-DD. Must be paired with start_date and earlier than today. |
| `countries` | array | No | Uppercase two-letter country codes to filter. |
| `company_id` | string | No | LinkedIn company ID. Provide company_id, company, or keyword for the first page. |
| `start_date` | string | No | Start date in YYYY-MM-DD. Must be paired with end_date and no earlier than one year ago. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Posts

**Slug:** `SCRAPECREATORS_SEARCH_LINKEDIN_POSTS`

Search Google-indexed public LinkedIn posts by keyword and optional recency, returning one page and a bounded continuation cursor. Results are best-effort rather than a complete LinkedIn-native index. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Keyword or phrase to search for in public LinkedIn posts. |
| `date_posted` | string ("last-hour" | "last-day" | "last-week" | "last-month" | "last-year") | No | Limit results by Google-indexed posting recency. |
| `next_cursor` | string | No | Bounded continuation cursor from the previous page; omit for the first page. Search supports at most 11 pages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Reddit

**Slug:** `SCRAPECREATORS_SEARCH_REDDIT`

Search Reddit posts or comments by keyword with type, sort, and timeframe filters, returning one page and a continuation cursor. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string ("relevance" | "new" | "top" | "comment_count") | No | Result order; comment_count is valid only for post search. |
| `trim` | boolean | No | Return the provider's smaller result representation while retaining core content and engagement. |
| `query` | string | Yes | Keyword or phrase to search across Reddit. |
| `timeframe` | string ("all" | "day" | "week" | "month" | "year") | No | Post-search time range. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |
| `result_type` | string ("posts" | "comments") | No | Search posts or comments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Threads Posts

**Slug:** `SCRAPECREATORS_SEARCH_THREADS_POSTS`

Search public Threads posts by keyword and optional inclusive date range, returning the provider's single, non-pageable result set. The provider may return more than 10 posts. Each request costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return a smaller post representation while retaining core content and engagement. |
| `query` | string | Yes | Keyword or phrase to search for in public Threads posts. |
| `end_date` | string | No | Latest result date in YYYY-MM-DD format. |
| `start_date` | string | No | Earliest result date in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search TikTok Ad Library

**Slug:** `SCRAPECREATORS_SEARCH_TIKTOK_AD_LIBRARY`

Search TikTok's public ad library by general query or advertiser name, returning one page and an opaque cursor. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | General ad search query. Provide exactly one of query or advertiser_name on the first page. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |
| `advertiser_name` | string | No | Advertiser name resolved through TikTok typeahead. Provide exactly one of advertiser_name or query on the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search TikTok by Hashtag

**Slug:** `SCRAPECREATORS_SEARCH_TIKTOK_BY_HASHTAG`

Search public TikTok videos by hashtag with an optional proxy region, returning one page and an opaque continuation cursor. TikTok may return duplicates. Each page costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return the provider's smaller representation with core video fields. |
| `region` | string | No | Two-letter proxy country code. This selects the proxy location and does not restrict results to that country. |
| `hashtag` | string | No | Hashtag without the leading #; required on the first page. |
| `next_cursor` | string | No | Opaque continuation cursor from the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search TikTok by Keyword

**Slug:** `SCRAPECREATORS_SEARCH_TIKTOK_BY_KEYWORD`

Search public TikTok videos by keyword with publication-time, sort, and proxy region options, returning one page and an opaque continuation cursor. TikTok may return duplicates. Each page costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return the provider's smaller representation with core video fields. |
| `query` | string | No | Keyword or phrase to search for; required on the first page. |
| `region` | string | No | Two-letter proxy country code. This selects the proxy location and does not restrict results to that country. |
| `sort_by` | string ("relevance" | "most-liked" | "date-posted") | No | Sort results by relevance, likes, or publication date. |
| `date_posted` | string ("yesterday" | "this-week" | "this-month" | "last-3-months" | "last-6-months" | "all-time") | No | Restrict results by publication time. |
| `next_cursor` | string | No | Opaque continuation cursor from the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search TikTok Users

**Slug:** `SCRAPECREATORS_SEARCH_TIKTOK_USERS`

Search TikTok user profiles by keyword, creator name, or handle, returning one page of normalized account records and a continuation cursor. Each page costs 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `trim` | boolean | No | Return the provider's smaller, flat user records. |
| `query` | string | No | Keyword, creator name, or TikTok handle to search for. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search YouTube

**Slug:** `SCRAPECREATORS_SEARCH_YOUTUBE`

Search YouTube for videos, Shorts, channels, or playlists with date, popularity, duration, and region filters, returning one page and a continuation cursor. Each page costs 1 credit.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per charged API credit. Credits vary by endpoint; cached results use no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | YouTube search query; use intitle:"phrase" for stricter title matching. |
| `region` | string | No | Two-letter proxy country code for regionalized results. |
| `sort_by` | string ("relevance" | "popular") | No | Order results by relevance or popularity. |
| `duration` | string ("under_3_min" | "between_3_and_20_min" | "over_20_min") | No | Video duration filter; valid only when content_type is omitted or videos. |
| `next_cursor` | string | No | Opaque continuation token from the previous page; omit for the first page. |
| `upload_date` | string ("today" | "this_week" | "this_month" | "this_year") | No | Restrict results by upload recency. |
| `content_type` | string ("videos" | "shorts" | "channels" | "playlists") | No | Limit results to videos, Shorts, channels, or playlists. |
| `include_extras` | boolean | No | Include like count, comment count, and descriptions; this slightly slows the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
