> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Scrape Creators

The Scrape Creators connector lets your AI agent act in each user's Scrape Creators account. Each user connects their own Scrape Creators API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** API Key
**Categories:** Marketing, Search
**Tools:** 60: 60 read, 0 write, 0 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=SCRAPECREATORS)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Scrape Creators connection

   In **AgentKit > Connections**, create a Scrape Creators connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'scrapecreators'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Scrape Creators:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'scrapecreators_credit_balance_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "scrapecreators"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Scrape Creators:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="scrapecreators_credit_balance_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Scrape Creators credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'scrapecreators_bluesky_profile_get',
  toolInput: {
    handle: '<handle>',
  },
  connector: 'scrapecreators',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="scrapecreators_bluesky_profile_get",
    tool_input={
        "handle": "<handle>",
    },
    connection_name="scrapecreators",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `scrapecreators_bluesky_profile_get`

Get Bluesky Profile · Read-only

Retrieves a Bluesky user's public profile including handle, displayName, avatar, description, followersCount, followsCount, postsCount, createdAt, and verification status.
Use this for a Bluesky account's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, required): Bluesky handle. Example: espn.com.

Example input: `{"handle":"<handle>"}`

### `scrapecreators_credit_balance_get`

Get Credit Balance · Read-only

Get the number of API credits remaining on your Scrape Creators account.
Returns a creditCount field with the current balance.
Use this to check how many API credits remain before running large jobs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `scrapecreators_facebook_ad_library_ads_search`

Search Meta Ad Library · Read-only

Searches the Meta Ad Library by keyword and returns matching ads.
Each result includes ad_archive_id, page_name, is_active, publisher_platform, and a snapshot with body text, images, videos, and cta_text.
Use this to find ads by keyword. Use scrapecreators_facebook_ad_library_company_ads_list for one advertiser's ads.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): Keyword to search for. Example: running.
- `ad_type` (`string`, optional): Search for all ads or only political and issue ads. Example: all. One of: `all`, `political_and_issue_ads`.
- `country` (`string`, optional): This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. Example: ALL.
- `cursor` (`string`, optional): Cursor to paginate through results. Example: AQHRYLVDkoMkvGv7yK1rcce-vJmKiKv330R4v3j9KHSOaYvmF1bq1QkotG0rgW8Fkrj-.
- `end_date` (`string`, optional): Impressions end date. Needs to be in YYYY-MM-DD format. Example: 2025-02-16.
- `language` (`string`, optional): Language to filter ads on. Needs to be a 2 letter language code, such as EN, ES, or FR. Example: EN.
- `media_type` (`string`, optional): 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. Example: ALL. One of: `ALL`, `IMAGE`, `VIDEO`, `MEME`, `IMAGE_AND_MEME`, `NONE`.
- `search_type` (`string`, optional): If you want to search by exact phrase or not. Example: keyword_unordered. One of: `keyword_unordered`, `keyword_exact_phrase`.
- `sort_by` (`string`, optional): Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. Example: total_impressions. One of: `total_impressions`, `relevancy_monthly_grouped`.
- `start_date` (`string`, optional): Impressions start date. Needs to be in YYYY-MM-DD format. Example: 2025-01-05.
- `status` (`string`, optional): Status of the ad. Defaults to ACTIVE. Example: ACTIVE. One of: `ALL`, `ACTIVE`, `INACTIVE`.
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.

Example input: `{"query":"<query>"}`

### `scrapecreators_facebook_ad_library_companies_search`

Search Meta Ad Library Companies · Read-only

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.
Use this to find an advertiser's page ID before listing its ads.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): Keyword to search for. Example: nike.

Example input: `{"query":"<query>"}`

### `scrapecreators_facebook_ad_library_company_ads_list`

List Meta Ad Library Company Ads · Read-only

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.
Use this for one advertiser's ads. Use scrapecreators_facebook_ad_library_companies_search to find the page ID first.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_name` (`string`, optional): The name of the company. Can either use this or pageId. Example: Lululemon.
- `country` (`string`, optional): This can only be one country. It has to be the 2 letter code for the country. It defaults to ALL. Example: ALL.
- `cursor` (`string`, optional): Cursor to paginate through results. Example: AQHRBUAxNmFlxBVMFL6uTb1ICFsV65O4SqmPbcVZJhiveBpPS1hFHAmL6yCJcF760cXP.
- `end_date` (`string`, optional): End date to search for. Format: YYYY-MM-DD. Example: 2025-12-31.
- `language` (`string`, optional): Language to filter ads on. Needs to be 2 letter language code, ie EN, ES, FR, etc. Example: EN.
- `media_type` (`string`, optional): Media type of the ad. Defaults to ALL. Meme refers to ads with image and text. Not sure why they call it meme. Example: ALL. One of: `ALL`, `IMAGE`, `VIDEO`, `MEME`, `IMAGE_AND_MEME`, `NONE`.
- `page_id` (`string`, optional): The companies ad library page id. You can get this with my Search For Companies Endpoint. Can either use this or companyName. Example: 367152833370567.
- `sort_by` (`string`, optional): Sort by impressions (high to low), or Most Recent (relevancy_monthly_grouped). Defaults to impressions. Example: total_impressions. One of: `total_impressions`, `relevancy_monthly_grouped`.
- `start_date` (`string`, optional): Start date to search for. Format: YYYY-MM-DD. Example: 2025-01-01.
- `status` (`string`, optional): Status of the ad. Defaults to ACTIVE. Example: ACTIVE. One of: `ALL`, `ACTIVE`, `INACTIVE`.
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.

Example input: `{}`

### `scrapecreators_facebook_group_posts_list`

List Facebook Group Posts · Read-only

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.
Use this for posts in a public group.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): The cursor to paginate to the next page. Example: AQHRBjJCelNvdGRjH8s2j-6...
- `group_id` (`string`, optional): The ID of the group. Example: 742354120555345.
- `sort_by` (`string`, optional): How to sort the posts. Defaults to CHRONOLOGICAL. Example: CHRONOLOGICAL. One of: `TOP_POSTS`, `RECENT_ACTIVITY`, `CHRONOLOGICAL`, `CHRONOLOGICAL_LISTINGS`.
- `url` (`string`, optional): The URL of the group. Example: https://www.facebook.com/groups/1270525996445602/.

Example input: `{}`

### `scrapecreators_facebook_post_comments_list`

List Facebook Post Comments · Read-only

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.
Use this for comments on a post or reel.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Cursor from the previous response to get more comments. Keep the same sort on every cursor page. Example: MToxNzU3MTA2NzYyOgF1P1VkxpkA9Ds4...
- `feedback_id` (`string`, optional): 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. Example: ZmVlZGJhY2s6MTQ0NzY1NjMyMzM4Mzg0OA==.
- `sort` (`string`, optional): Defaults to most_relevant, which can filter comments. Set sort=all to request Facebook's unfiltered view; this does not guarantee every counted comment is available. Example: most_relevant. One of: `most_relevant`, `all`.
- `url` (`string`, optional): Facebook post URL (or reel URL). Example: https://www.facebook.com/reel/753347914167361.

Example input: `{}`

### `scrapecreators_facebook_post_get`

Get Facebook Post · Read-only

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.
Use this for one post or reel by URL. Use scrapecreators_facebook_post_comments_list for its comments.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): The URL of the post to get. Example: https://www.facebook.com/reel/1535656380759655.
- `allow_long_transcription` (`boolean`, optional): Paid opt-in, enabled only by the literal query value 'true' (allow_long_transcription=true). Defaults to false when omitted; other values do not enable paid mode. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. This flag does not force AI and does not enable transcription or AI fallback by itself. Keep get_transcript=true or use_ai_as_fallback=true where required by the endpoint. Returned native captions still cost 1 credit on dedicated transcript routes, even for long videos with this flag; on detail routes they leave the base price unchanged. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. Example: true.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit; default short AI is included; allow_long_transcription=true adds 10 credits per started minute to the existing base cost). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `get_transcript` (`boolean`, optional): Transcription is opt-in via get_transcript=true. Default short AI (up to 120 seconds, inclusive) is included in the existing base endpoint price, with no extra AI fee. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. On detail routes, successful paid-mode AI costs are in addition to the existing base endpoint cost; media-download pricing is unchanged. Returned native captions leave the base endpoint price unchanged. Empty AI results and errors incur no AI fee; the base scrape fee still applies when the detail scrape succeeds. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. Example: true.

Example input: `{"url":"<url>"}`

### `scrapecreators_facebook_profile_get`

Get Facebook Profile · Read-only

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.
Use this for a page or profile's details. Use scrapecreators_facebook_profile_posts_list for its posts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): Facebook profile URL. Example: https://www.facebook.com/mantraindianfolsom.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `get_business_hours` (`string`, optional): Get the business's hours. Example: true.
- `include_gated_profile` (`string`, optional): When true, returns limited public fields for gated or age-restricted profiles. Ignored for normal public profiles — those still return the full response. Example: true.

Example input: `{"url":"<url>"}`

### `scrapecreators_facebook_profile_posts_list`

List Facebook Profile Posts · Read-only

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.
Use this for a page or profile's posts. Use scrapecreators_facebook_post_get for one post.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): To paginate through the posts. Example: Cg8Ob3JnYW5pY19jdXJzb3IJA...
- `page_id` (`string`, optional): Facebook profile page id. Example: 100063669491743.
- `url` (`string`, optional): Facebook profile URL. Example: https://www.facebook.com/pacemorby.

Example input: `{}`

### `scrapecreators_github_repository_get`

Get GitHub Repository · Read-only

Retrieves public metadata for one GitHub repository, including owner, description, language, stars, forks, topics, license, visibility, default branch, open issues, and timestamps.
Use this for one public repository.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): GitHub repository URL. Example: https://github.com/torvalds/linux.

Example input: `{"url":"<url>"}`

### `scrapecreators_github_user_get`

Get GitHub User · Read-only

Retrieves public GitHub user details including name, bio, avatar, company, location, blog, follower counts, public repo counts, and account timestamps.
Use this for a GitHub user's public profile. Use scrapecreators_github_repository_get for a repository.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, optional): GitHub username/handle of the user you want the details for. Example: torvalds.
- `url` (`string`, optional): GitHub user URL, e.g. https://github.com/torvalds. Example: https://github.com/torvalds.

Example input: `{}`

### `scrapecreators_google_ad_get`

Get Google Ad · Read-only

Retrieves detailed information about a specific Google ad including advertiserId, creativeId, format, firstShown, lastShown, and overallImpressions. firstShown can be null even when /v1/google/company/ads returns a date for the same ad; keep the company-list date when this field is null.
Use this for one ad's details by URL.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): The url of the ad. Example: https://adstransparency.google.com/advertiser/AR07541154843046445057/creative/CR17778900238552006657.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.

Example input: `{"url":"<url>"}`

### `scrapecreators_google_company_ads_list`

List Google Company Ads · Read-only

List an advertiser's public ads in the Google Ads Transparency Center by domain or advertiser ID.
Returns the ads with advertiser ID, creative ID, format, first and last shown dates, plus a cursor for the next page.
Use this for one advertiser's ads in the Google Ads Transparency Center. Use scrapecreators_google_ad_get for one ad.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `advertiser_id` (`string`, optional): The advertiser id of the company. Example: AR01614014350098432001.
- `cursor` (`string`, optional): Cursor to paginate through results. Example: CgoAP7znOo9RPjf%2FEhD5utgx8m75NrTTbU0AAAAAGgn8%2BJyW%2BJQK40A%3D.
- `domain` (`string`, optional): The domain of the company. Example: lululemon.com.
- `end_date` (`string`, optional): End date to search for. Format: YYYY-MM-DD. Example: 2025-08-11.
- `format` (`string`, optional): Ad format to search for. Example: video. One of: `text`, `image`, `video`.
- `get_ad_details` (`string`, optional): Set to true to get the ad details. Will cost 25 credits. Example: false.
- `platform` (`string`, optional): Platform to search for. Example: youtube. One of: `google_maps`, `google_play`, `google_search`, `google_shopping`, `youtube`.
- `region` (`string`, optional): The region to search for. Defaults to anywhere. Example: US.
- `start_date` (`string`, optional): Start date to search for. Format: YYYY-MM-DD. Example: 2025-08-01.
- `topic` (`string`, optional): The topic to search for. If you search for 'political', you will also need to pass a 'region', like 'US' or 'AU'. Example: all. One of: `all`, `political`.

Example input: `{}`

### `scrapecreators_google_search`

Search Google · Read-only

Performs a Google search and returns organic results with url, title, and description for each result.
Use this for Google web search results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): Search query. Example: news.
- `date_posted` (`string`, optional): Date posted. Example: last-hour. One of: `last-hour`, `last-day`, `last-week`, `last-month`, `last-year`.
- `page` (`integer`, optional): Page number to retrieve. Must be between 1 and 11; page 12 or greater returns a 400 response. Example: 1.
- `region` (`string`, optional): 2 letter country code, ie US, UK, CA, etc This will show results from that country. Example: US.

Example input: `{"query":"<query>"}`

### `scrapecreators_instagram_media_transcript_get`

Get Instagram Media Transcript · Read-only

Generates AI speech-to-text for an Instagram video post or reel.
Returns a transcripts array containing each video's id, shortcode, and text; no speech can produce null entries.
Use this for what is said in a reel or video post. Use scrapecreators_instagram_post_get for its metadata.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): Instagram post or reel URL. Example: https://www.instagram.com/reel/DJmA7SusiPb/.
- `allow_long_transcription` (`boolean`, optional): Paid opt-in, enabled only by the literal query value 'true' (allow_long_transcription=true). Defaults to false when omitted; other values do not enable paid mode. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. This flag does not force AI and does not enable transcription or AI fallback by itself. Keep get_transcript=true or use_ai_as_fallback=true where required by the endpoint. Returned native captions still cost 1 credit on dedicated transcript routes, even for long videos with this flag; on detail routes they leave the base price unchanged. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. Example: true.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (By default, successful AI up to 120 seconds costs a flat 1 credit per request; over 120 seconds requires allow_long_transcription=true, which bills ALL successful AI at 10 credits per started minute, including short videos; empty AI results and errors cost 0 credits). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.

Example input: `{"url":"<url>"}`

### `scrapecreators_instagram_post_comments_list`

List Instagram Post Comments · Read-only

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.
Use this for comments on a post or reel.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): The URL of the post or reel to get comments from. Example: https://www.instagram.com/reel/DOq6eV6iIgD.
- `cursor` (`string`, optional): The cursor to get more comments. Get 'cursor' from previous response. Example: eyJjYWNoZWRfY29tbWVud...
- `include_replies` (`boolean`, optional): Set to true to include replies for every returned comment. Costs 15 credits when comments are returned, even if no replies are found; successful pages with no comments cost 0 credits. This is much slower and may time out at 29 seconds. Example: true.

Example input: `{"url":"<url>"}`

### `scrapecreators_instagram_post_get`

Get Instagram Post · Read-only

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.
Use this for one post or reel by URL. Use scrapecreators_instagram_post_comments_list for its comments.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): Instagram post or reel URL. Example: https://www.instagram.com/p/DJmA7SusiPb/.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `download_media` (`boolean`, optional): Set to true to download the video/images and get back permanent Supabase URLs. Costs 10 credits if media is found, 1 credit otherwise. Example: true.
- `include_play_count` (`boolean`, optional): Set to false to omit video_play_count and skip its additional fetch for a faster response. Defaults to true. Example: true.
- `region` (`string`, optional): 2 letter country code to set the proxy in. Example: US.
- `trim` (`boolean`, optional): Set to true to get a trimmed response. Example: true.

Example input: `{"url":"<url>"}`

### `scrapecreators_instagram_profile_get`

Get Instagram Profile · Read-only

Fetch a public Instagram profile by handle, with its bio, follower and following counts, and recent posts.
Returns the user object with profile details, counts and the latest posts; the call can be slow because it makes several requests to Instagram.
Use this for a profile's bio, stats and recent posts. Use scrapecreators_instagram_user_posts_list to page through all posts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, required): Instagram handle. Example: jane.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `trim` (`boolean`, optional): Set to true to get a trimmed response. Example: true.

Example input: `{"handle":"<handle>"}`

### `scrapecreators_instagram_profiles_search`

Search Instagram Profiles · Read-only

Search Instagram profiles by name or keyword using Instagram's own profile search.
Returns matching accounts with username, full name, profile picture and verification status.
Use this to find accounts by name or keyword. Use scrapecreators_instagram_profile_get when you know the handle.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): The profile name or username to search for. Example: fitness coach.

Example input: `{"query":"<query>"}`

### `scrapecreators_instagram_reels_search`

Search Instagram Reels · Read-only

Search Google-indexed Instagram reels matching a keyword or phrase, with optional date filters and pagination.
Returns matching reels with their URL, caption and owner details.
Use this to find reels by keyword. Use scrapecreators_instagram_profile_get when you know the account.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): The keyword to search for. Example: dogs.
- `date_posted` (`string`, optional): Google-indexed date window. Recent hour/day filters are not supported because Google does not index Instagram reels reliably enough in those windows. Example: last-week. One of: `last-week`, `last-month`, `last-year`.
- `page` (`integer`, optional): The page number to return. Must be between 1 and 11; page 12 or greater returns a 400 response. Example: 1.

Example input: `{"query":"<query>"}`

### `scrapecreators_instagram_user_posts_list`

List Instagram User Posts · Read-only

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.
Use this to page through a user's posts. Use scrapecreators_instagram_user_reels_list for reels only.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, required): Instagram handle. Example: nike.
- `next_max_id` (`string`, optional): Cursor to get next page of results. Example: 3512345678901234567_123456789.
- `require_play_counts` (`boolean`, optional): Only the literal query value 'true' enables this check. It requires play_count on each returned video post; a real 0 is valid. It does not require ig_play_count or view counts, or counts on photos. If a required play_count is missing or null, the request returns an error without charging credits instead of a paid partial success. With the default false, counts remain best-effort: usable posts are still billable even with missing play counts. Retrying does not guarantee that Instagram will return the missing counts. Why counts can be missing (https://scrapecreators.com/blog/instagram-play-counts-missing). Example: true.
- `trim` (`boolean`, optional): Set to true to get a trimmed response. Example: true.

Example input: `{"handle":"<handle>"}`

### `scrapecreators_instagram_user_reels_list`

List Instagram User Reels · Read-only

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.
Use this for a user's reels. Use scrapecreators_instagram_user_posts_list for all posts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, optional): Instagram handle. Use user_id for faster response times. Example: jane.
- `max_id` (`string`, optional): Max id to get more reels. Get 'max_id' from previous response. Example: QVFCVzNnS2lI...==.
- `require_play_counts` (`boolean`, optional): Only the literal query value 'true' enables this check. It requires a numeric, nonnegative play_count on every returned Reel, in both full responses (items[].media.play_count) and trim=true responses (items[].play_count); a real 0 is valid. A missing, null, nonnumeric or negative play_count returns HTTP 503 without charging credits instead of a paid partial success. It does not require ig_play_count or view counts. With the default false, counts remain best-effort: usable reels are still billable even with missing play counts. This checks presence and numeric validity; it does not guarantee count accuracy or agreement with Instagram Insights. Retrying does not guarantee that Instagram will return the missing counts. Why counts can be missing (https://scrapecreators.com/blog/instagram-play-counts-missing). Example: true.
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.
- `user_id` (`string`, optional): Instagram user id. Use this for faster response times. Example: 21393171.

Example input: `{}`

### `scrapecreators_linkedin_ads_search`

Search LinkedIn Ads · Read-only

Searches the LinkedIn Ad Library by company name, keyword, or companyId with optional country and date filters.
Each ad includes id, description, headline, adType, advertiser, targeting details, image or video URLs, totalImpressions, and impressionsByCountry.
Use this to find ads in the LinkedIn Ad Library by company or keyword.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company` (`string`, optional): The company name to search for. 'Microsoft' for example. Example: microsoft.
- `company_id` (`string`, optional): The company id to search for. Example: 157238.
- `countries` (`string`, optional): Comma separated list of countries. Example: US,CA,MX.
- `end_date` (`string`, optional): End date in YYYY-MM-DD format. Must be used with startDate and cannot be today or a future date. Example: 2026-09-01.
- `keyword` (`string`, optional): The keyword to search for. Example: scraping.
- `pagination_token` (`string`, optional): Pagination token to paginate through results. Example: 640547184-1743616612000.
- `start_date` (`string`, optional): Start date in YYYY-MM-DD format. Must be used with endDate and cannot be earlier than the date one year ago. Example: 2026-01-01.

Example input: `{}`

### `scrapecreators_linkedin_company_get`

Get LinkedIn Company · Read-only

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.
Use this for a company page. Use scrapecreators_linkedin_company_posts_list for its posts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): The URL of the LinkedIn company page to get. Example: https://linkedin.com/company/shopify.

Example input: `{"url":"<url>"}`

### `scrapecreators_linkedin_company_posts_list`

List LinkedIn Company Posts · Read-only

Retrieves paginated posts from a LinkedIn company or school page, including each post's URL, ID, publication date, and full text content.
Use this for a company's posts. Use scrapecreators_linkedin_post_get for one post.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): The LinkedIn company (/company/) or school (/school/) page URL, for example https://www.linkedin.com/school/oxfordsbs/. Example: https://linkedin.com/company/shopify.
- `page` (`integer`, optional): The page number to get. Example: 1.

Example input: `{"url":"<url>"}`

### `scrapecreators_linkedin_post_get`

Get LinkedIn Post · Read-only

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.
Each comment includes nullable datePublished (the exact source timestamp, never estimated from age), publishedTimeAgo (how long ago the comment was published), urn (the full comment URN), id (the comment's numeric suffix as a string), and reactionCount (the source count, including 0).
Use this for one post by URL.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): The URL of the LinkedIn post to get. Example: https://www.linkedin.com/pulse/being-father-has-made-me-better-leader-vice-versa-austen-allred/.

Example input: `{"url":"<url>"}`

### `scrapecreators_linkedin_profile_get`

Get LinkedIn Profile · Read-only

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.
Use this for a person's public profile. Use scrapecreators_linkedin_company_get for a company page.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): The URL of the LinkedIn profile to get. Example: https://www.linkedin.com/in/parrsam/.

Example input: `{"url":"<url>"}`

### `scrapecreators_linktree_get`

Get Linktree Page · Read-only

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.
Use this to read the links on a Linktree page.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): URL to Linktree page. Example: https://linktr.ee/miguelangeles.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.

Example input: `{"url":"<url>"}`

### `scrapecreators_pinterest_search`

Search Pinterest · Read-only

Searches Pinterest for pins matching a query, returning results with id, url, title, description, images, link, domain, board info, and pinner details.
Use this to find pins by keyword.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): Search query. Example: Italian Pot Roast.
- `cursor` (`string`, optional): Cursor. Example: Y2JVSG81V2sxcmNHRlpWM1J...
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.

Example input: `{"query":"<query>"}`

### `scrapecreators_reddit_post_comments_list`

List Reddit Post Comments · Read-only

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.
Use this for a post and its comments.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): Reddit post URL. Example: https://www.reddit.com/r/AskReddit/comments/ablzuq/people_who_havent_pooped_in_2019_yet_why_are_you/.
- `cursor` (`string`, optional): One opaque cursor returned by the previous response to get more comments or replies. Do not combine multiple cursors. Example: opaque_cursor_returned_by_previous_response.
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.

Example input: `{"url":"<url>"}`

### `scrapecreators_reddit_search`

Search Reddit · Read-only

Search posts or comments across all of Reddit by keyword.
Returns matching posts or comments with title or body, author, subreddit, score and URL, plus an after token for the next page.
Use this to search posts across Reddit. Use scrapecreators_reddit_subreddit_posts_list for one subreddit.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): Search query. Example: running shoes.
- `after` (`string`, optional): Used to paginate to next page. Example: t3_1i8z28z.
- `filter` (`string`, optional): Search posts or comments. Example: posts. One of: `posts`, `comments`.
- `sort` (`string`, optional): Sort by. Comment search supports relevance, new, and top; comment_count is for post search only. Example: relevance. One of: `relevance`, `new`, `top`, `comment_count`.
- `timeframe` (`string`, optional): Post search timeframe. Example: all. One of: `all`, `day`, `week`, `month`, `year`.
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.

Example input: `{"query":"<query>"}`

### `scrapecreators_reddit_subreddit_details_get`

Get Subreddit Details · Read-only

Retrieves metadata about a subreddit by name or URL.
Returns display_name, description, weekly_active_users, weekly_contributions, rules, icon_img, header_img, advertiser_category, submit_text, and created_at.
Use this for a subreddit's description and stats. Use scrapecreators_reddit_subreddit_posts_list for its posts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `subreddit` (`string`, optional): Subreddit name. MUST be case sensitive. So 'AskReddit' not 'askreddit'. Example: AskReddit.
- `url` (`string`, optional): Subreddit URL. Example: https://www.reddit.com/r/AbsoluteUnits/.

Example input: `{}`

### `scrapecreators_reddit_subreddit_posts_list`

List Subreddit Posts · Read-only

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.
Use this for posts in a subreddit. Use scrapecreators_reddit_search to search all of Reddit.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `subreddit` (`string`, required): Subreddit name. Example: AskReddit.
- `after` (`string`, optional): After to get more posts. Get 'after' from previous response. Example: t3_1234567890.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `sort` (`string`, optional): Sort order. Example: best. One of: `best`, `hot`, `new`, `top`, `rising`.
- `timeframe` (`string`, optional): Timeframe to get posts from. Example: all. One of: `all`, `day`, `week`, `month`, `year`.
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.

Example input: `{"subreddit":"<subreddit>"}`

### `scrapecreators_social_profiles_find`

Find Social Profiles · Read-only

Find a creator's profiles on other social platforms from one platform and handle.
Returns the source profile URL and the linked accounts found on other platforms.
Use this to find a creator's accounts on other platforms from one handle or URL.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, required): Creator handle without a profile URL. A leading @ is optional. Example: creator.
- `platform` (`string`, required): Source social platform. Example: instagram. One of: `instagram`, `tiktok`, `youtube`, `x`, `twitter`, `facebook`.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (10 credits). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.

Example input: `{"handle":"<handle>","platform":"instagram"}`

### `scrapecreators_threads_profile_get`

Get Threads Profile · Read-only

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.
Use this for a Threads account's details. Use scrapecreators_threads_user_posts_list for its posts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, required): Threads username. Example: trendspider.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.

Example input: `{"handle":"<handle>"}`

### `scrapecreators_threads_user_posts_list`

List Threads User Posts · Read-only

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.
Use this for a Threads account's posts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, required): Threads username. Example: trendspider.
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.

Example input: `{"handle":"<handle>"}`

### `scrapecreators_tiktok_hashtag_search`

Search TikTok Videos by Hashtag · Read-only

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.
Use this for videos under one hashtag. Use scrapecreators_tiktok_keyword_search for free-text search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `hashtag` (`string`, required): Hashtag to search for (without #). Example: fitness.
- `cursor` (`number`, optional): Cursor to get more videos. Get 'cursor' from previous response. Example: 10.
- `region` (`string`, optional): 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. Example: US.
- `trim` (`boolean`, optional): Set to true to get a trimmed response. Example: true.

Example input: `{"hashtag":"<hashtag>"}`

### `scrapecreators_tiktok_keyword_search`

Search TikTok Videos by Keyword · Read-only

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.
Use this to find videos by keyword. Use scrapecreators_tiktok_hashtag_search for a hashtag.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): Keyword to search for. Example: running shoes.
- `cursor` (`number`, optional): Cursor to get more videos. Get 'cursor' from previous response. Example: 10.
- `date_posted` (`string`, optional): Time Frame. Example: all-time. One of: `yesterday`, `this-week`, `this-month`, `last-3-months`, `last-6-months`, `all-time`.
- `region` (`string`, optional): 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. Example: US.
- `sort_by` (`string`, optional): Sort by. Example: relevance. One of: `relevance`, `most-liked`, `date-posted`.
- `trim` (`boolean`, optional): Set to true to get a trimmed response. Example: true.

Example input: `{"query":"<query>"}`

### `scrapecreators_tiktok_profile_get`

Get TikTok Profile · Read-only

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).
Use this for a creator's bio and stats. Use scrapecreators_tiktok_profile_videos_list for their videos.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `handle` (`string`, optional): TikTok handle. You can pass handle or user_id. Example: stoolpresidente.
- `user_id` (`string`, optional): TikTok user id. Example: 6659752019493208069.

Example input: `{}`

### `scrapecreators_tiktok_profile_videos_list`

List TikTok Profile Videos · Read-only

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).
Use this for a creator's video feed. Use scrapecreators_tiktok_video_get for one video's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, required): TikTok handle. Example: stoolpresidente.
- `include_pinned` (`boolean`, optional): Whether to include pinned posts. Defaults to true. Set to false to exclude posts marked as pinned, including with trim=true. Keep this value unchanged while paginating. Filtering can produce shorter or empty pages; follow has_more and max_cursor. Successful pages still cost 1 credit, including empty results. Example: true.
- `max_cursor` (`string`, optional): Cursor to get more videos. Get 'max_cursor' from previous response. Example: 1734562353000.
- `region` (`string`, optional): Country code passed to the profile-feed source. Defaults to US. If a profile should have videos but returns none, try another relevant two-letter country code. Changing this value does not guarantee that region-restricted posts will appear. Example: US.
- `sort_by` (`string`, optional): What to sort by. Example: latest. One of: `latest`, `popular`.
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.
- `user_id` (`string`, optional): TikTok user id. Use this for faster responses. Example: 6659752019493208069.

Example input: `{"handle":"<handle>"}`

### `scrapecreators_tiktok_shop_search`

Search TikTok Shop Products · Read-only

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.
Use this to find TikTok Shop products by keyword.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): Term you want to search for. Example: shoes.
- `page` (`integer`, optional): Page number to retrieve. Example: 1.
- `region` (`string`, optional): 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. Example: US. One of: `US`, `GB`, `DE`, `FR`, `IT`, `ID`, `MY`, `MX`, `PH`, `SG`, `ES`, `TH`, `VN`, `BR`, `JP`, `IE`.

Example input: `{"query":"<query>"}`

### `scrapecreators_tiktok_trending_feed_get`

Get TikTok Trending Feed · Read-only

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.
Use this for what is trending now. Use the search tools for a specific topic.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `region` (`string`, required): 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. Example: US.
- `trim` (`boolean`, optional): Set to true to get a trimmed response. Example: false.

Example input: `{"region":"<region>"}`

### `scrapecreators_tiktok_users_search`

Search TikTok Users · Read-only

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.
Use this to find creator accounts by name. Use scrapecreators_tiktok_keyword_search to find videos.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): Search query for users. Example: running shoes.
- `cursor` (`number`, optional): Cursor to get more users. Get 'cursor' from previous response. Example: 10.
- `trim` (`boolean`, optional): Set to true to get a trimmed response. Example: true.

Example input: `{"query":"<query>"}`

### `scrapecreators_tiktok_video_comments_list`

List TikTok Video Comments · Read-only

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.
Use this for comments on a video. Use scrapecreators_tiktok_video_get for the video itself.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): TikTok video URL. Example: https://www.tiktok.com/@stoolpresidente/video/7499229683859426602.
- `cursor` (`number`, optional): Cursor to get more comments. Get 'cursor' from previous response. Example: 20.
- `trim` (`boolean`, optional): Set to true to get a trimmed response. Example: true.

Example input: `{"url":"<url>"}`

### `scrapecreators_tiktok_video_get`

Get TikTok Video · Read-only

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.
Use this for one video by URL. Use scrapecreators_tiktok_video_transcript_get for its spoken text.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): TikTok video or photo/slideshow URL. Example: https://www.tiktok.com/@randomspamvideos25/video/7251387037834595630.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `download_media` (`boolean`, optional): Set to true to download the video/images and get back permanent Supabase URLs. Costs 10 credits if media is found, 1 credit otherwise. Example: true.
- `get_transcript` (`boolean`, optional): Native captions are opt-in via get_transcript=true and are included in the existing base endpoint price. This detail endpoint does not use AI transcription or an AI fallback; missing captions return no transcript. For AI fallback, use /v1/tiktok/video/transcript. Example: true.
- `region` (`string`, optional): Two-letter country code passed to the primary post source. Defaults to US. Try the creator's country if a post is unavailable. This does not guarantee a matching browser/proxy country or complete retrieval; the fallback source does not receive this parameter. Example: US.
- `trim` (`boolean`, optional): Set to true to get a trimmed response. Example: true.

Example input: `{"url":"<url>"}`

### `scrapecreators_tiktok_video_transcript_get`

Get TikTok Video Transcript · Read-only

Extracts existing transcripts, captions, or subtitles from a TikTok video by URL.
Returns id, url, and transcript (native captions are WEBVTT-formatted; AI fallback returns text).
Use this for what is said in a video. Use scrapecreators_tiktok_video_get for its stats and metadata.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): TikTok video URL. Example: https://www.tiktok.com/@stoolpresidente/video/7499229683859426602.
- `allow_long_transcription` (`boolean`, optional): Paid opt-in, enabled only by the literal query value 'true' (allow_long_transcription=true). Defaults to false when omitted; other values do not enable paid mode. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. This flag does not force AI and does not enable transcription or AI fallback by itself. Keep get_transcript=true or use_ai_as_fallback=true where required by the endpoint. Returned native captions still cost 1 credit on dedicated transcript routes, even for long videos with this flag; on detail routes they leave the base price unchanged. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. Example: true.
- `language` (`string`, optional): Language of the transcript. 2 letter language code, ie 'en', 'es', 'fr', 'de', 'it', 'ja', 'ko', 'zh'. Example: en.
- `use_ai_as_fallback` (`string`, optional): Set to 'true' to use paid AI only when existing captions are unavailable. Defaults to false. By default, successful AI transcription of videos up to 120 seconds (two minutes, inclusive) costs a flat 1 credit per request. Over 120 seconds, videos cannot be AI-transcribed by default. Set allow_long_transcription=true to opt into paid AI with no fixed duration cap: ALL successful AI transcriptions in this mode cost 10 credits per started minute, including short videos: 10 * ceil(duration_seconds / 60). For example, 177 seconds costs 30 credits and an opted-in 60 seconds costs 10 credits. Empty AI results and errors cost 0 credits for AI transcription. These routes remain synchronous. Allow at least 30 seconds on your client. Paid long transcription can exceed resource limits or timeouts, so successful transcription of long videos is not guaranteed. Example: false.

Example input: `{"url":"<url>"}`

### `scrapecreators_twitter_posts_search`

Search X Posts · Read-only

Finds public X/Twitter post URLs through Google Search, then returns their details using the same public post scraper as /v1/twitter/tweet.
Each post uses the existing tweet response fields, including rest_id, legacy.full_text, legacy.created_at, engagement counts, author and media when available, plus a canonical url.
Use this to find posts by keyword. Use scrapecreators_twitter_user_tweets_list for one account.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): Keyword or phrase to search for in Google-indexed public X/Twitter posts. Example: ai agents.
- `cursor` (`string`, optional): Pass the cursor returned by the previous response. Supported page cursors are 1 through 11. A null response cursor means there are no more pages. Example: 2.

Example input: `{"query":"<query>"}`

### `scrapecreators_twitter_profile_get`

Get X Profile · Read-only

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.
Use this for an X (Twitter) account's details. Use scrapecreators_twitter_user_tweets_list for its posts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, required): Twitter handle. Example: Austen.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.

Example input: `{"handle":"<handle>"}`

### `scrapecreators_twitter_tweet_get`

Get X Post · Read-only

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.
Use this for one post by URL.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): Tweet URL. Example: https://x.com/elonmusk/status/1867306569584447662.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.

Example input: `{"url":"<url>"}`

### `scrapecreators_twitter_user_tweets_list`

List X User Posts · Read-only

Fetches tweets from a Twitter user's profile by handle.
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.
Use this for an account's recent posts. Use scrapecreators_twitter_tweet_get for one post.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, required): Twitter handle. Example: levelsio.
- `trim` (`boolean`, optional): Set to true for a trimmed down version of the response. Example: false.

Example input: `{"handle":"<handle>"}`

### `scrapecreators_youtube_channel_get`

Get YouTube Channel · Read-only

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.
Returns channel metadata such as country, email, and external store links when available.
Use this for a channel's details and stats. Use scrapecreators_youtube_channel_videos_list for its videos.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `channel_id` (`string`, optional): YouTube channel ID. Can pass a channelId, handle or url. Example: UC-9-kyTW8ZkZNDHQJ6FgpwQ.
- `handle` (`string`, optional): YouTube channel handle. Can pass a channelId, handle or url. Example: ThePatMcAfeeShow.
- `url` (`string`, optional): YouTube channel URL. Can pass a channelId, handle or url. Example: https://www.youtube.com/@ThePatMcAfeeShow.

Example input: `{}`

### `scrapecreators_youtube_channel_search`

Search YouTube Channel · Read-only

Search the videos of one YouTube channel with YouTube's native channel search.
Returns the matching videos with title, URL, thumbnail and views, plus a continuation token; every page costs 1 credit, even with no matches.
Use this to search inside one channel. Use scrapecreators_youtube_search to search all of YouTube.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `handle` (`string`, required): YouTube channel handle, with or without @. Example: NASA.
- `query` (`string`, required): Keywords to search within this channel. Example: artemis.
- `continuation_token` (`string`, optional): Token from the previous response. Keep the same handle and query; stop when the token is null. Example: 4qmFsgKrCBIYVUNYNk9RM0RrY3NiWU5FNkg4dVFRdVZB.

Example input: `{"handle":"<handle>","query":"<query>"}`

### `scrapecreators_youtube_channel_shorts_list`

List YouTube Channel Shorts · Read-only

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.
Returns data in the shorts array.
Use this for a channel's shorts. Use scrapecreators_youtube_channel_videos_list for long-form videos.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_id` (`string`, optional): Can pass channelId or handle. Example: UC-9-kyTW8ZkZNDHQJ6FgpwQ.
- `continuation_token` (`string`, optional): Continuation token to get more videos. Get 'continuationToken' from previous response. Example: 4qmFsgKrCBIYVUNkRkpXVWE0M3NtUm00SXBIQnB.
- `handle` (`string`, optional): Can pass channelId or handle. Example: starterstory.
- `sort` (`string`, optional): Sort by newest or popular. Example: newest. One of: `newest`, `popular`.

Example input: `{}`

### `scrapecreators_youtube_channel_videos_list`

List YouTube Channel Videos · Read-only

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.
Use this for a channel's long-form videos. Use scrapecreators_youtube_channel_shorts_list for shorts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `channel_id` (`string`, optional): YouTube channel ID. Example: UC-9-kyTW8ZkZNDHQJ6FgpwQ.
- `continuation_token` (`string`, optional): Continuation token to get more videos. Get 'continuationToken' from previous response. Example: 4qmFsgKrCBIYVUNkRkpXVWE0M3NtUm00SXBIQnB.
- `handle` (`string`, optional): YouTube channel handle. Example: ThePatMcAfeeShow.
- `include_extras` (`string`, optional): 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. Example: false.
- `sort` (`string`, optional): Sort by latest or popular. Example: latest. One of: `latest`, `popular`.

Example input: `{}`

### `scrapecreators_youtube_playlist_get`

Get YouTube Playlist · Read-only

Get a page of videos in a YouTube playlist.
Returns each video's title, URL, thumbnail, duration and channel, plus a continuation token; each page costs 1 credit.
Use this for the videos in a playlist.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `playlist_id` (`string`, required): The ID of the YouTube playlist. In the YouTube URL it will be the 'list' parameter. Example: PLP32wGpgzmIlInfgKVFfCwVsxgGqZNIiS.
- `continuation_token` (`string`, optional): Token from the previous response to get the next page. Omit for the first page. Stop when the returned continuationToken is null. Example: 4qmFsgKrCBIYVUNYNk9RM0RrY3NiWU5FNkg4dVFRdVZB.

Example input: `{"playlist_id":"<playlist_id>"}`

### `scrapecreators_youtube_search`

Search YouTube · Read-only

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.
Use this to find videos, shorts, channels or playlists by keyword. Use scrapecreators_youtube_channel_search to search inside one channel.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): 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. Example: running shoes.
- `continuation_token` (`string`, optional): Continuation token to get more videos. Get 'continuationToken' from previous response. Example: 4qmFsgKrCBIYVUNkRkpXVWE0M3NtUm00SXBIQnB.
- `duration` (`string`, optional): Duration of the video. Only applies to videos (not shorts). Example: under_3_min. One of: `under_3_min`, `between_3_and_20_min`, `over_20_min`.
- `include_extras` (`string`, optional): 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.*. Example: false.
- `region` (`string`, optional): 2 letter country code of the country to put the proxy in. Example: US.
- `sort_by` (`string`, optional): Sort by. Example: relevance. One of: `relevance`, `popular`.
- `type` (`string`, optional): Type of content to search for. Example: videos. One of: `videos`, `shorts`, `channels`, `playlists`.
- `upload_date` (`string`, optional): Upload date. Example: today. One of: `today`, `this_week`, `this_month`, `this_year`.

Example input: `{"query":"<query>"}`

### `scrapecreators_youtube_video_comments_list`

List YouTube Video Comments · Read-only

Fetches comments and replies from a YouTube video, including each comment's text content, author details, like count, reply count, and publish date. publishedTime is a best-effort ISO timestamp calculated from YouTube's relative label, not an exact source timestamp.
Use this for comments on a video.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): YouTube video URL. Example: https://www.youtube.com/watch?v=dQw4w9WgXcQ.
- `continuation_token` (`string`, optional): Continuation token to get more comments. Get 'continuationToken' from previous response. Example: 4qmFsgKrCBIYVUNkRkpXVWE0M3NtUm00SXBIQnB.
- `order` (`string`, optional): Order of comments. Example: top. One of: `top`, `newest`.

Example input: `{"url":"<url>"}`

### `scrapecreators_youtube_video_get`

Get YouTube Video · Read-only

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.
Each card has section, title, subtitle, secondarySubtitle, image, videoId, channelId, playlistId and musicCredits.
Use this for one video or short by URL. Use scrapecreators_youtube_video_transcript_get for its spoken text.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): YouTube video or short URL. Example: https://youtu.be/gTCi7PaOPLY.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `language` (`string`, optional): Preferred response language (mapped to Accept-Language header; not guaranteed due to YouTube localization behavior). 2 letter language code, ie 'en', 'es', 'fr' etc. Example: en.

Example input: `{"url":"<url>"}`

### `scrapecreators_youtube_video_transcript_get`

Get YouTube Video Transcript · Read-only

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.
Use this for what is said in a video. Use scrapecreators_youtube_video_get for its stats and metadata.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): YouTube video or short URL. Example: https://www.youtube.com/watch?v=bjVIDXPP7Uk.
- `cache_max_age` (`string`, optional): If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). See the Caching page for details. (https://docs.scrapecreators.com/caching). Example: 7d. One of: `1d`, `3d`, `7d`, `14d`, `30d`.
- `language` (`string`, optional): 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. Example: en.
- `original_audio` (`boolean`, optional): 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. Example: true.

Example input: `{"url":"<url>"}`

## Related

Other Marketing connectors ([all 190](/agentkit/connectors/?category=marketing)):

- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twitter / X](/agentkit/connectors/twitteroauth/): Scalekit connector, OAuth, 92 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
