Social Fetch

Official142 toolsLive

by social-freak-ltd

Public social-data API and live docs for AI coding agents.

Name: io.github.social-freak-ltd/socialfetch
Description: Public social-data API and live docs for AI coding agents.
Topics: ai-agents, claude-code, cursor, instagram, mcp, model-context-protocol, reddit, social-media, tiktok, twitter, vscode, web-data, windsurf, youtube, socialfetch
Readme excerpt:

🛠️ Key Features

Public API for fetching social-data to support model-context construction
Live documentation and API reference
MCP (Model Context Protocol) compatibility for agent integrations
Centered around real social-media and web-data sources
Central server URL guidance and integration docs

🚀 Use Cases

Enrich coding agents with current social-data streams
Build contextual model prompts from social feeds and web sources
Integrate MCP-based data retrieval into AI workflows
Reference API and docs for rapid integration

⚡ Developer Benefits

Clear MCP alignment for consistent model-context handling
Comprehensive docs, API references, and credits/billing info
Reusable endpoints to fetch social-data in real time
Open-source style repository guidance for contributors

⚠️ Limitations

Data source coverage limited to listed social-media and web-data topics
Readme excerpt indicates centralized server URL; verify endpoint availability
Potential rate limits and billing considerations not detailed here

Topics

ai-agentsclaude-codecursorinstagrammcpmodel-context-protocolredditsocial-mediatiktoktwittervscodeweb-datawindsurfyoutubesocialfetch

Captured live from the server via tools/list.

tiktok_profile_get

Get a TikTok profile by handle. Returns lookupStatus plus profile metrics (followers, posts/videoCount, privateAccount, accountCreatedAt).

Parameters1

handle

string

required

TikTok handle to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "TikTok handle to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_profile_videos_list

List videos from a TikTok profile by handle. Returns a list (use cursor when paginated).

Parameters6

handle	string	required	TikTok handle whose videos should be listed.
sortBy	string	optional	Optional sort order for the returned TikTok videos.
cursor	string	optional	Pagination cursor returned by a previous response.
userId	string	optional	Optional TikTok user id to speed up the request.
region	string	optional	Optional ISO 3166-1 country code for the request.
trim	boolean	optional	Optional flag for a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "TikTok handle whose videos should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "sortBy": {
      "description": "Optional sort order for the returned TikTok videos.",
      "type": "string",
      "enum": [
        "latest",
        "popular"
      ]
    },
    "cursor": {
      "description": "Pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "userId": {
      "description": "Optional TikTok user id to speed up the request.",
      "type": "string",
      "minLength": 1
    },
    "region": {
      "description": "Optional ISO 3166-1 country code for the request.",
      "type": "string"
    },
    "trim": {
      "description": "Optional flag for a smaller response with fewer fields.",
      "type": "boolean"
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_profile_followers_list

List followers of a TikTok profile by handle. Returns a list (use cursor when paginated).

Parameters4

handle	string	required	TikTok handle whose followers should be listed.
cursor	string	optional	Pagination cursor returned by a previous response.
userId	string	optional	Optional TikTok user id to speed up the request.
trim	any	optional	Optional flag for a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "TikTok handle whose followers should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "cursor": {
      "description": "Pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "userId": {
      "description": "Optional TikTok user id to speed up the request.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "Optional flag for a smaller response with fewer fields.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_profile_following_list

List accounts followed by a TikTok profile by handle. Returns a list (use cursor when paginated).

Parameters3

handle	string	required	TikTok handle whose following list should be listed.
cursor	string	optional	Pagination cursor returned by a previous response.
trim	boolean	optional	Optional flag for a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "TikTok handle whose following list should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "cursor": {
      "description": "Pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "Optional flag for a smaller response with fewer fields.",
      "type": "boolean"
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_profile_region_get

Get the region code reported for a TikTok profile by handle.

Parameters1

handle

string

required

TikTok handle to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "TikTok handle to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_profile_audience_get

Get audience location demographics for a TikTok profile by handle.

Parameters1

handle

string

required

TikTok handle to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "TikTok handle to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_profile_live_check

Check whether a TikTok creator is currently live by handle.

Parameters1

handle

string

required

TikTok handle to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "TikTok handle to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_users_search

Search TikTok users by keyword. Discover real handles before profile gets; avoid inventing usernames.

Parameters2

query	string	required	Search query text for TikTok users.
cursor	string	optional	Opaque pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for TikTok users."
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_search_videos_list

Search TikTok videos by keyword. Returns a list (use cursor when paginated).

Parameters6

query	string	required	Search query text for TikTok videos.
datePosted	string	optional	Optional upload date filter for video results.
sortBy	string	optional	Optional sort order for search results.
region	string	optional	Optional two-letter ISO 3166-1 country code for localized search results.
cursor	string	optional	Opaque pagination cursor returned by a previous response.
trim	boolean	optional	When true, returns a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for TikTok videos."
    },
    "datePosted": {
      "type": "string",
      "enum": [
        "yesterday",
        "this-week",
        "this-month",
        "last-3-months",
        "last-6-months",
        "all-time"
      ],
      "description": "Optional upload date filter for video results."
    },
    "sortBy": {
      "type": "string",
      "enum": [
        "relevance",
        "most-liked",
        "date-posted"
      ],
      "description": "Optional sort order for search results."
    },
    "region": {
      "description": "Optional two-letter ISO 3166-1 country code for localized search results.",
      "type": "string"
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer fields.",
      "type": "boolean"
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_search_hashtag_list

Search TikTok videos by hashtag (not free-text keyword — use tiktok.search.videos.list for that). Returns a list (use cursor when paginated).

Parameters4

hashtag	string	required	Hashtag to search for. A leading # is optional.
region	string	optional	Optional ISO 3166-1 country code for the request. This sets the proxy region and does not filter results to that country only.
cursor	string	optional	Pagination cursor returned by a previous response.
trim	boolean	required	Whether to request a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "hashtag": {
      "description": "Hashtag to search for. A leading # is optional.",
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "region": {
      "description": "Optional ISO 3166-1 country code for the request. This sets the proxy region and does not filter results to that country only.",
      "type": "string"
    },
    "cursor": {
      "description": "Pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "Whether to request a smaller response with fewer fields.",
      "type": "boolean"
    }
  },
  "required": [
    "hashtag",
    "trim"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_video_get

Get a single TikTok video by URL. Author is identity-only (no follower counts) — use tiktok_profile_get for metrics. Credits: 1 (+downloadMedia add-on).

Parameters5

url	string	required	Link to the video or photo post.
region	string	optional	Optional ISO 3166-1 country code used to route the request when needed.
trim	any	optional	When true, returns a smaller response with fewer fields.
downloadMedia	any	optional	When true, includes hosted CDN URLs in `downloads` when available. Adds 10 credits (11 total with the base lookup) on successful lookups, even if `downloads` is empty.
getTranscript	any	optional	When true, includes the video transcript (WEBVTT) in `transcript` when one is available.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the video or photo post."
    },
    "region": {
      "description": "Optional ISO 3166-1 country code used to route the request when needed.",
      "type": "string"
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer fields.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "downloadMedia": {
      "description": "When true, includes hosted CDN URLs in `downloads` when available. Adds 10 credits (11 total with the base lookup) on successful lookups, even if `downloads` is empty.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "getTranscript": {
      "description": "When true, includes the video transcript (WEBVTT) in `transcript` when one is available.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_video_comments_list

List comments on a TikTok video by URL. Returns a list (use cursor when paginated).

Parameters3

url	string	required	Link to the TikTok video whose comments should be listed.
cursor	string	optional	Opaque cursor from a previous response to fetch the next page.
trim	any	optional	When true, returns a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the TikTok video whose comments should be listed."
    },
    "cursor": {
      "description": "Opaque cursor from a previous response to fetch the next page.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer fields.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_video_comments_replies_list

List replies to a TikTok video comment. Accepts a comment id. Returns a list (use cursor when paginated).

Parameters3

commentId	string	required	Parent comment id from List TikTok video comments (`data.comments[].id`).
url	string	required	Link to the TikTok video that contains the parent comment.
cursor	string	optional	Opaque cursor from a previous response to fetch the next page.

Raw schema

{
  "type": "object",
  "properties": {
    "commentId": {
      "type": "string",
      "minLength": 1,
      "description": "Parent comment id from List TikTok video comments (`data.comments[].id`)."
    },
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the TikTok video that contains the parent comment."
    },
    "cursor": {
      "description": "Opaque cursor from a previous response to fetch the next page.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "commentId",
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_video_transcript_get

Get the spoken transcript for a TikTok video by URL.

Parameters3

url	string	required	Link to the TikTok video whose transcript should be returned.
language	string	optional	Optional two-letter language code to request a transcript in a specific language when available.
useAiFallback	any	optional	When true, uses Social Fetch's AI fallback when a transcript is not otherwise available. Adds 10 credits on completed lookups (11 total with the base lookup).

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "pattern": "^https:\\/\\/",
      "description": "Link to the TikTok video whose transcript should be returned."
    },
    "language": {
      "description": "Optional two-letter language code to request a transcript in a specific language when available.",
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "useAiFallback": {
      "description": "When true, uses Social Fetch's AI fallback when a transcript is not otherwise available. Adds 10 credits on completed lookups (11 total with the base lookup).",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_feed_trending_list

List currently trending TikTok posts for a region. Returns a list (use cursor when paginated).

Parameters2

region	string	required	Two-letter ISO 3166-1 country code for the request.
trim	any	optional	When true, requests a smaller response with fewer optional fields.

Raw schema

{
  "type": "object",
  "properties": {
    "region": {
      "description": "Two-letter ISO 3166-1 country code for the request.",
      "type": "string"
    },
    "trim": {
      "description": "When true, requests a smaller response with fewer optional fields.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "region"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_song_get

Get details for a TikTok song or sound by id.

Parameters1

string

required

TikTok song or sound id. Use the trailing id from a music page URL, or `music.id` from a video lookup.

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "TikTok song or sound id. Use the trailing id from a music page URL, or `music.id` from a video lookup."
    }
  },
  "required": [
    "id"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_music_videos_list

List TikTok videos that use a specific music clip. Accepts a clip id. Returns a list (use cursor when paginated).

Parameters2

clipId	string	required	TikTok music clip id whose videos should be listed.
cursor	string	optional	Pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "clipId": {
      "type": "string",
      "minLength": 1,
      "description": "TikTok music clip id whose videos should be listed."
    },
    "cursor": {
      "description": "Pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "clipId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_shop_products_search

Search products in TikTok Shop by keyword. Returns a list (use cursor when paginated).

Parameters3

query	string	required	Search query text for TikTok Shop products.
page	any	optional	1-based results page number. Omit to request the first page. Pagination is page-based.
region	string	optional	Optional country or region code for the product search catalog.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for TikTok Shop products."
    },
    "page": {
      "description": "1-based results page number. Omit to request the first page. Pagination is page-based.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "region": {
      "description": "Optional country or region code for the product search catalog.",
      "type": "string",
      "enum": [
        "US",
        "GB",
        "DE",
        "FR",
        "IT",
        "ID",
        "MY",
        "MX",
        "PH",
        "SG",
        "ES",
        "TH",
        "VN",
        "BR",
        "JP",
        "IE"
      ]
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_shop_products_list

List products in a TikTok Shop store by shop id or URL. Returns a list (use cursor when paginated).

Parameters3

url	string	required	Public TikTok Shop store URL whose products should be listed.
cursor	string	optional	Pagination cursor from a previous response. Omit to request the first page.
region	string	optional	Optional region code for the shop catalog. When omitted, the default catalog region is US.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public TikTok Shop store URL whose products should be listed."
    },
    "cursor": {
      "description": "Pagination cursor from a previous response. Omit to request the first page.",
      "type": "string",
      "minLength": 1,
      "maxLength": 8192
    },
    "region": {
      "description": "Optional region code for the shop catalog. When omitted, the default catalog region is US.",
      "type": "string",
      "enum": [
        "US",
        "GB",
        "DE",
        "FR",
        "IT",
        "ID",
        "MY",
        "MX",
        "PH",
        "SG",
        "ES",
        "TH",
        "VN",
        "BR",
        "JP",
        "IE"
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_product_get

Get details for a TikTok Shop product by product id. Accepts a product page URL.

Parameters2

url	string	required	Public TikTok Shop product detail page URL for the product to retrieve.
region	string	optional	Optional country or region code for the product catalog. When omitted, the default catalog region applies.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public TikTok Shop product detail page URL for the product to retrieve."
    },
    "region": {
      "description": "Optional country or region code for the product catalog. When omitted, the default catalog region applies.",
      "type": "string",
      "enum": [
        "US",
        "GB",
        "DE",
        "FR",
        "IT",
        "ID",
        "MY",
        "MX",
        "PH",
        "SG",
        "ES",
        "TH",
        "VN",
        "BR",
        "JP",
        "IE"
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_product_reviews_list

List buyer reviews for a TikTok Shop product by product id. Returns a list (use cursor when paginated).

Parameters4

url	string	optional	Public TikTok Shop product detail page URL for the product whose reviews should be listed.
productId	string	optional	TikTok Shop product identifier. Provide this instead of `url` when you already know the product id.
region	string	optional	Optional country or region code for the product review catalog. When omitted, the default catalog region applies.
page	any	optional	1-based review page number. Omit to request the first page.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "Public TikTok Shop product detail page URL for the product whose reviews should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "productId": {
      "type": "string",
      "minLength": 1,
      "description": "TikTok Shop product identifier. Provide this instead of `url` when you already know the product id."
    },
    "region": {
      "description": "Optional country or region code for the product review catalog. When omitted, the default catalog region applies.",
      "type": "string",
      "enum": [
        "US",
        "GB",
        "DE",
        "FR",
        "IT",
        "ID",
        "MY",
        "MX",
        "PH",
        "SG",
        "ES",
        "TH",
        "VN",
        "BR",
        "JP",
        "IE"
      ]
    },
    "page": {
      "description": "1-based review page number. Omit to request the first page.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_profile_showcaseProducts_list

List products featured on a creator's TikTok showcase by handle. Returns a list (use cursor when paginated).

Parameters3

handle	string	required	TikTok handle whose profile showcase products should be listed.
cursor	string	optional	Pagination cursor returned by a previous response.
region	string	optional	Optional ISO 3166-1 country code for the request.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "TikTok handle whose profile showcase products should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "cursor": {
      "description": "Pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "region": {
      "description": "Optional ISO 3166-1 country code for the request.",
      "type": "string"
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_adLibrary_ad_get

Get a single TikTok Ad Library or Top Ads creative by ad id or public ad URL.

Parameters2

adId	string	optional	TikTok Ad Library or Top Ads ad id.
url	string	optional	Public TikTok Ad Library or Top Ads detail URL for the ad.

Raw schema

{
  "type": "object",
  "properties": {
    "adId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "TikTok Ad Library or Top Ads ad id."
    },
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public TikTok Ad Library or Top Ads detail URL for the ad."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

tiktok_adLibrary_ads_search_get

Search TikTok Top Ads by keyword and filters, or search the public Ads Library by advertiser name. Returns a list (use cursor when paginated).

Parameters12

region	string	optional	Country code for Top Ads results. Defaults to US when omitted.
period	string	optional	Time window in days for Top Ads.
query	string	optional	Optional keyword to search ad titles and content.
advertiserName	string	optional	Search the public TikTok Ads Library by advertiser name. When set, results come from the public Ads Library instead of Top Ads.
orderBy	string	optional	Sort metric for Top Ads. Defaults to for-you when omitted.
industry	string	optional	Industry filter for Top Ads.
objective	string	optional	Campaign objective filter for Top Ads.
duration	string	optional	Video duration filter for Top Ads.
likes	string	optional	Likes percentile filter for Top Ads.
adFormat	string	optional	Ad format filter for Top Ads.
adLanguage	string	optional	Ad language filter for Top Ads.
cursor	string	optional	Opaque pagination cursor from a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "region": {
      "type": "string",
      "enum": [
        "DZ",
        "AR",
        "AU",
        "AT",
        "AZ",
        "BH",
        "BD",
        "BY",
        "BE",
        "BO",
        "BR",
        "BG",
        "KH",
        "CA",
        "CL",
        "CO",
        "CR",
        "HR",
        "CY",
        "CZ",
        "DK",
        "DO",
        "EC",
        "EG",
        "EE",
        "FI",
        "FR",
        "DE",
        "GR",
        "GT",
        "JO",
        "HU",
        "ID",
        "IQ",
        "IE",
        "IL",
        "IT",
        "JP",
        "KZ",
        "KE",
        "KW",
        "LV",
        "LB",
        "MY",
        "MX",
        "MA",
        "NL",
        "NZ",
        "NG",
        "NO",
        "OM",
        "PK",
        "PA",
        "PY",
        "PE",
        "PH",
        "PL",
        "PT",
        "PR",
        "QA",
        "LT",
        "RO",
        "SA",
        "RS",
        "SG",
        "SK",
        "SI",
        "ZA",
        "KR",
        "ES",
        "LK",
        "SE",
        "CH",
        "TW",
        "TH",
        "TR",
        "AE",
        "GB",
        "US",
        "UY",
        "VN"
      ],
      "description": "Country code for Top Ads results. Defaults to US when omitted."
    },
    "period": {
      "type": "string",
      "enum": [
        "7",
        "30",
        "180"
      ],
      "description": "Time window in days for Top Ads."
    },
    "query": {
      "description": "Optional keyword to search ad titles and content.",
      "type": "string",
      "maxLength": 4096
    },
    "advertiserName": {
      "description": "Search the public TikTok Ads Library by advertiser name. When set, results come from the public Ads Library instead of Top Ads.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "orderBy": {
      "type": "string",
      "enum": [
        "for-you",
        "impression",
        "play-2s-rate",
        "play-6s-rate",
        "cvr",
        "ctr",
        "like"
      ],
      "description": "Sort metric for Top Ads. Defaults to for-you when omitted."
    },
    "industry": {
      "type": "string",
      "enum": [
        "apparel-accessories",
        "appliances",
        "apps",
        "baby-kids-maternity",
        "beauty-personal-care",
        "business-services",
        "ecommerce-non-app",
        "education",
        "financial-services",
        "food-beverage",
        "games",
        "health",
        "home-improvement",
        "household-products",
        "life-services",
        "news-entertainment",
        "pets",
        "sports-outdoor",
        "tech-electronics",
        "travel",
        "vehicle-transportation"
      ],
      "description": "Industry filter for Top Ads."
    },
    "objective": {
      "type": "string",
      "enum": [
        "app-installs",
        "conversions",
        "lead-generation",
        "product-sales",
        "reach",
        "traffic",
        "video-views"
      ],
      "description": "Campaign objective filter for Top Ads."
    },
    "duration": {
      "type": "string",
      "enum": [
        "under-10s",
        "10-20s",
        "20-30s",
        "30-40s",
        "40-50s",
        "over-50s"
      ],
      "description": "Video duration filter for Top Ads."
    },
    "likes": {
      "type": "string",
      "enum": [
        "top-1-20",
        "top-21-40",
        "top-41-60",
        "top-61-80",
        "top-81-100"
      ],
      "description": "Likes percentile filter for Top Ads."
    },
    "adFormat": {
      "type": "string",
      "enum": [
        "spark-ads",
        "non-spark-ads"
      ],
      "description": "Ad format filter for Top Ads."
    },
    "adLanguage": {
      "type": "string",
      "enum": [
        "en",
        "es",
        "ar",
        "vi",
        "th",
        "de",
        "id",
        "pt",
        "fr",
        "ms",
        "nl",
        "ja",
        "it",
        "ro",
        "zh-Hant",
        "ko"
      ],
      "description": "Ad language filter for Top Ads."
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitter_profile_get

Get an X (Twitter) profile by handle. Returns lookupStatus plus follower/tweet metrics and account age signals.

Parameters1

handle

string

required

X handle to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "X handle to look up, with or without a leading @.",
      "type": "string"
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitter_profile_tweets_list

List tweets from an X profile by handle. Returns a list (use cursor when paginated).

Parameters5

handle	string	required	X handle to look up, with or without a leading @.
limit	any	optional	Optional page size. Defaults to 40 when omitted. Maximum supported value is 100.
cursor	string	optional	Opaque pagination cursor returned by a previous response.
includeReplies	any	optional	Optional: include reply tweets in the returned list. Defaults to false.
includePinned	any	optional	Optional: include pinned tweets on the first page. Defaults to false.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "X handle to look up, with or without a leading @.",
      "type": "string"
    },
    "limit": {
      "description": "Optional page size. Defaults to 40 when omitted. Maximum supported value is 100.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "includeReplies": {
      "description": "Optional: include reply tweets in the returned list. Defaults to false.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "includePinned": {
      "description": "Optional: include pinned tweets on the first page. Defaults to false.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitter_tweet_get

Get a single tweet by URL. Author includes profile metrics when not trimmed. Warning: trim=true omits author. Credits: 1.

Parameters2

url	string	required	Tweet permalink or identifier.
trim	boolean	optional	Optional: omit author profile and tweet `core` for a smaller response.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Tweet permalink or identifier."
    },
    "trim": {
      "description": "Optional: omit author profile and tweet `core` for a smaller response.",
      "type": "boolean"
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitter_tweet_replies_list

List replies to a tweet by URL. Returns a list (use cursor when paginated).

Parameters2

url	string	required	Tweet permalink or identifier.
cursor	string	optional	Opaque pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Tweet permalink or identifier."
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitter_tweet_transcript_get

Get the transcript for a video tweet by URL.

Parameters1

url

string

required

Tweet permalink or identifier.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Tweet permalink or identifier."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitter_search_list

Search X posts by keyword. Returns a list (use cursor when paginated).

Parameters10

query	string	required	Search query text to run against public posts on X.
section	string	optional	Optional search section filter. Omit to use the default `top` section.
minRetweets	any	optional	Optional minimum retweet count filter.
minLikes	any	optional	Optional minimum like count filter.
minReplies	any	optional	Optional minimum reply count filter.
limit	any	optional	Optional page size. Maximum supported value is 20.
startDate	string	optional	Optional start date filter in YYYY-MM-DD format.
endDate	string	optional	Optional end date filter in YYYY-MM-DD format.
language	string	optional	Optional language filter.
cursor	string	optional	Opaque pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text to run against public posts on X."
    },
    "section": {
      "description": "Optional search section filter. Omit to use the default `top` section.",
      "type": "string",
      "enum": [
        "top",
        "latest",
        "people",
        "photos",
        "videos"
      ]
    },
    "minRetweets": {
      "description": "Optional minimum retweet count filter.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "minLikes": {
      "description": "Optional minimum like count filter.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "minReplies": {
      "description": "Optional minimum reply count filter.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "limit": {
      "description": "Optional page size. Maximum supported value is 20.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "startDate": {
      "description": "Optional start date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "endDate": {
      "description": "Optional end date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "language": {
      "description": "Optional language filter.",
      "type": "string",
      "enum": [
        "en",
        "es",
        "fr",
        "de",
        "it",
        "pt",
        "ru",
        "zh",
        "ja",
        "ko",
        "ar",
        "bg",
        "hr",
        "cs",
        "da",
        "nl",
        "et",
        "fi",
        "el",
        "hu",
        "id",
        "ga",
        "lv",
        "lt",
        "no",
        "pl",
        "ro",
        "sk",
        "sl",
        "sv",
        "tr",
        "uk",
        "vi",
        "cy",
        "zu"
      ]
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitter_hashtag_list

Search X posts by hashtag (not free-text keyword — use twitter.search.list for that). Returns a list (use cursor when paginated).

Parameters4

hashtag	string	required	Hashtag to search for.
section	string	optional	Optional section filter for the hashtag feed. Omit to use the default `top` section.
limit	any	optional	Optional page size. Maximum supported value is 20.
cursor	string	optional	Opaque pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "hashtag": {
      "description": "Hashtag to search for.",
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "section": {
      "description": "Optional section filter for the hashtag feed. Omit to use the default `top` section.",
      "type": "string",
      "enum": [
        "top",
        "latest",
        "people",
        "photos",
        "videos"
      ]
    },
    "limit": {
      "description": "Optional page size. Maximum supported value is 20.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "hashtag"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitter_community_get

Get details for an X community by community id or URL.

Parameters1

url

string

required

Community URL to look up.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Community URL to look up."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitter_community_tweets_list

List tweets from an X community by community id or URL. Returns a list (use cursor when paginated).

Parameters1

url

string

required

Community URL to look up.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Community URL to look up."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

telegram_channel_get

Get metadata for a public Telegram channel or group by username.

Parameters1

handle

string

required

Telegram public username (channel or group), with or without leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Telegram public username (channel or group), with or without leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

telegram_channel_posts_get

List recent posts from a public Telegram channel. Groups are not supported. Accepts a handle. Returns a list (use cursor when paginated).

Parameters2

handle	string	required	Telegram public username (channel or group), with or without leading @.
cursor	string	optional	Opaque pagination cursor from a previous response. Omit for the first page.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Telegram public username (channel or group), with or without leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response. Omit for the first page.",
      "type": "string"
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

telegram_channel_post_get

Get a single public post from a Telegram channel by handle and post ID. Groups are not supported.

Parameters2

handle	string	required	Telegram public username (channel or group), with or without leading @.
postId	string	required	Numeric Telegram channel post ID from the public URL.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "type": "string",
      "minLength": 1,
      "description": "Telegram public username (channel or group), with or without leading @."
    },
    "postId": {
      "type": "string",
      "maxLength": 20,
      "pattern": "^\\d+$",
      "description": "Numeric Telegram channel post ID from the public URL."
    }
  },
  "required": [
    "handle",
    "postId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_profile_get

Get a Facebook profile or Page by URL or username.

Parameters2

url	string	required	Facebook public profile or page URL to look up.
includeBusinessHours	boolean	optional	Optional: include structured business hours in the response when available.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Facebook public profile or page URL to look up."
    },
    "includeBusinessHours": {
      "description": "Optional: include structured business hours in the response when available.",
      "type": "boolean"
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_profile_posts_list

List posts from a Facebook profile or Page. Accepts a profile URL or page id. Returns a list (use cursor when paginated).

Parameters3

url	string	optional	Full public Facebook profile or page URL.
pageId	string	optional	Facebook page or profile id when you have it instead of a full URL.
cursor	string	optional	Opaque pagination cursor from a previous response (`data.page.nextCursor`).

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "Full public Facebook profile or page URL.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "pageId": {
      "description": "Facebook page or profile id when you have it instead of a full URL.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response (`data.page.nextCursor`).",
      "type": "string",
      "minLength": 1
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_profile_reels_list

List Reels from a Facebook profile or Page. Accepts a profile or page URL. Returns a list (use cursor when paginated).

Parameters2

url	string	required	Public Facebook profile or page URL whose reels should be listed.
cursor	string	optional	Opaque pagination cursor from a previous response (`data.page.nextCursor`).

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public Facebook profile or page URL whose reels should be listed."
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response (`data.page.nextCursor`).",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_profile_photos_list

List photos from a Facebook profile or Page. Accepts a profile or page URL. Returns a list (use cursor when paginated).

Parameters2

url	string	required	Public Facebook profile or page URL whose photos should be listed.
cursor	string	optional	Opaque pagination cursor from a previous response (`data.page.nextCursor`).

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public Facebook profile or page URL whose photos should be listed."
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response (`data.page.nextCursor`).",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_post_get

Get a Facebook post or Reel by URL.

Parameters3

url	string	required	Public permalink to the Facebook post or reel.
includeComments	any	optional	When true, includes a sample of top-level comments when available.
includeTranscript	any	optional	When true, includes a plain-text transcript when available for the video.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public permalink to the Facebook post or reel."
    },
    "includeComments": {
      "description": "When true, includes a sample of top-level comments when available.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "includeTranscript": {
      "description": "When true, includes a plain-text transcript when available for the video.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_post_comments_list

List comments on a Facebook post or Reel by URL. Returns a list (use cursor when paginated).

Parameters3

url	string	optional	Link to the Facebook post or reel whose comments should be listed.
cursor	string	optional	Opaque cursor from a previous response to fetch the next page.
feedbackId	string	optional	Optional Facebook feedback identifier for the target post; when available it can improve lookup performance.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Facebook post or reel whose comments should be listed."
    },
    "cursor": {
      "description": "Opaque cursor from a previous response to fetch the next page.",
      "type": "string",
      "minLength": 1
    },
    "feedbackId": {
      "description": "Optional Facebook feedback identifier for the target post; when available it can improve lookup performance.",
      "type": "string",
      "minLength": 1
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_post_comments_replies_list

List replies to a Facebook comment. Accepts a from post comments. Returns a list (use cursor when paginated).

Parameters1

cursor

string

required

Comment `repliesCursor` from post comments, or `page.nextCursor` to paginate replies.

Raw schema

{
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string",
      "minLength": 1,
      "description": "Comment `repliesCursor` from post comments, or `page.nextCursor` to paginate replies."
    }
  },
  "required": [
    "cursor"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_post_transcript_get

Get the transcript for a Facebook post or Reel by URL.

Parameters1

url

string

required

Link to the Facebook post or reel whose transcript should be returned.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Facebook post or reel whose transcript should be returned."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_group_posts_list

List posts from a Facebook group by group URL. Returns a list (use cursor when paginated).

Parameters3

url	string	required	Public Facebook group URL whose posts should be listed.
sortBy	string	optional	Optional sort order for the returned posts.
cursor	string	optional	Opaque pagination cursor from a previous response (`data.page.nextCursor`).

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public Facebook group URL whose posts should be listed."
    },
    "sortBy": {
      "description": "Optional sort order for the returned posts.",
      "type": "string",
      "enum": [
        "top",
        "recentActivity",
        "chronological",
        "chronologicalListings"
      ]
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response (`data.page.nextCursor`).",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_marketplace_item_get

Get details for a Facebook Marketplace listing by item URL.

Parameters2

itemId	string	optional	Facebook Marketplace item identifier. Provide this instead of url when you already know the item id.
url	string	optional	Public Facebook Marketplace item URL.

Raw schema

{
  "type": "object",
  "properties": {
    "itemId": {
      "description": "Facebook Marketplace item identifier. Provide this instead of url when you already know the item id.",
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "url": {
      "description": "Public Facebook Marketplace item URL.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_marketplace_locations_search

Search Facebook Marketplace locations to obtain coordinates for listing search. Accepts a city or place name. Returns a list (use cursor when paginated).

Parameters1

query

string

required

City or place name to search for Facebook Marketplace locations.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "City or place name to search for Facebook Marketplace locations."
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_marketplace_search_list

Search Facebook Marketplace listings by keyword near a latitude and longitude. Returns a list (use cursor when paginated).

Parameters13

query	string	required	Search query text for marketplace listings.
lat	any	required	Latitude for the marketplace search location.
lng	any	required	Longitude for the marketplace search location.
radiusKm	any	optional	Optional search radius in kilometers.
minPrice	any	optional	Optional minimum listing price.
maxPrice	any	optional	Optional maximum listing price.
count	any	optional	Optional number of listings to return.
sortBy	string	optional	Optional sort order for marketplace listings.
deliveryMethod	string	optional	Optional delivery method filter for marketplace listings.
condition	string	optional	Optional item condition filter for marketplace listings.
dateListed	string	optional	Optional date-listed filter for marketplace listings.
availability	string	optional	Optional availability filter for marketplace listings.
cursor	string	optional	Opaque pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for marketplace listings."
    },
    "lat": {
      "description": "Latitude for the marketplace search location.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "lng": {
      "description": "Longitude for the marketplace search location.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "radiusKm": {
      "description": "Optional search radius in kilometers.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "minPrice": {
      "description": "Optional minimum listing price.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "maxPrice": {
      "description": "Optional maximum listing price.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "count": {
      "description": "Optional number of listings to return.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "sortBy": {
      "type": "string",
      "enum": [
        "suggested",
        "distanceAscend",
        "creationTimeDescend",
        "priceAscend",
        "priceDescend"
      ],
      "description": "Optional sort order for marketplace listings."
    },
    "deliveryMethod": {
      "type": "string",
      "enum": [
        "all",
        "localPickup",
        "shipping"
      ],
      "description": "Optional delivery method filter for marketplace listings."
    },
    "condition": {
      "type": "string",
      "enum": [
        "new",
        "usedLikeNew",
        "usedGood",
        "usedFair"
      ],
      "description": "Optional item condition filter for marketplace listings."
    },
    "dateListed": {
      "type": "string",
      "enum": [
        "1",
        "7",
        "30",
        "all",
        "last24Hours",
        "last7Days",
        "last30Days"
      ],
      "description": "Optional date-listed filter for marketplace listings."
    },
    "availability": {
      "type": "string",
      "enum": [
        "available",
        "sold",
        "all"
      ],
      "description": "Optional availability filter for marketplace listings."
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "query",
    "lat",
    "lng"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_adLibrary_ad_get

Get a single Facebook Ad Library ad by archive id or public Ad Library URL.

Parameters4

adId	string	optional	Facebook Ad Library archive id for the ad.
url	string	optional	Public Facebook Ad Library URL for the ad.
includeTranscript	any	optional	When true, includes a plain-text transcript when available for the ad video.
trim	any	optional	When true, requests a smaller payload before normalization.

Raw schema

{
  "type": "object",
  "properties": {
    "adId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Facebook Ad Library archive id for the ad."
    },
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public Facebook Ad Library URL for the ad."
    },
    "includeTranscript": {
      "description": "When true, includes a plain-text transcript when available for the ad video.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "trim": {
      "description": "When true, requests a smaller payload before normalization.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_adLibrary_ads_search_get

Search Facebook Ad Library ads by keyword and filters. Returns a list (use cursor when paginated).

Parameters11

query	string	required	Search query text for Facebook Ad Library ads.
sortBy	string	optional	Optional sort order for returned ads.
searchType	string	optional	Optional keyword matching mode for the search query.
adType	string	optional	Optional filter for all ads or political and issue ads.
country	string	optional	Optional country code filter. Use ALL to search all countries.
status	string	optional	Optional ad status filter.
mediaType	string	optional	Optional creative media filter.
startDate	string	optional	Optional start date filter in YYYY-MM-DD format.
endDate	string	optional	Optional end date filter in YYYY-MM-DD format.
cursor	string	optional	Opaque pagination cursor from a previous response.
trim	boolean	optional	When true, returns a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Search query text for Facebook Ad Library ads."
    },
    "sortBy": {
      "type": "string",
      "enum": [
        "impressions",
        "most-recent"
      ],
      "description": "Optional sort order for returned ads."
    },
    "searchType": {
      "type": "string",
      "enum": [
        "keyword-unordered",
        "exact-phrase"
      ],
      "description": "Optional keyword matching mode for the search query."
    },
    "adType": {
      "type": "string",
      "enum": [
        "all",
        "political-and-issue"
      ],
      "description": "Optional filter for all ads or political and issue ads."
    },
    "country": {
      "description": "Optional country code filter. Use ALL to search all countries.",
      "type": "string",
      "minLength": 2,
      "maxLength": 3
    },
    "status": {
      "type": "string",
      "enum": [
        "all",
        "active",
        "inactive"
      ],
      "description": "Optional ad status filter."
    },
    "mediaType": {
      "type": "string",
      "enum": [
        "all",
        "image",
        "video",
        "meme",
        "image-and-meme",
        "none"
      ],
      "description": "Optional creative media filter."
    },
    "startDate": {
      "description": "Optional start date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "endDate": {
      "description": "Optional end date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer fields.",
      "type": "boolean"
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_company_ads_list

List ads a company or Page is running in the Facebook Ad Library. Accepts a page id or company name. Returns a list (use cursor when paginated).

Parameters10

pageId	string	optional	Facebook page id when you have it instead of a company name.
companyName	string	optional	Company or page name to search when you do not have a page id.
country	string	optional	Optional country code filter. Use ALL to search all countries.
status	string	optional	Optional ad status filter.
mediaType	string	optional	Optional creative media filter.
language	string	optional	Optional language code filter.
sortBy	string	optional	Optional sort order for returned ads.
startDate	string	optional	Optional start date filter in YYYY-MM-DD format.
endDate	string	optional	Optional end date filter in YYYY-MM-DD format.
cursor	string	optional	Opaque pagination cursor from a previous response (`data.page.nextCursor`).

Raw schema

{
  "type": "object",
  "properties": {
    "pageId": {
      "description": "Facebook page id when you have it instead of a company name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "companyName": {
      "description": "Company or page name to search when you do not have a page id.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "country": {
      "description": "Optional country code filter. Use ALL to search all countries.",
      "type": "string",
      "minLength": 2,
      "maxLength": 3
    },
    "status": {
      "description": "Optional ad status filter.",
      "type": "string",
      "enum": [
        "all",
        "active",
        "inactive"
      ]
    },
    "mediaType": {
      "description": "Optional creative media filter.",
      "type": "string",
      "enum": [
        "all",
        "image",
        "video",
        "meme",
        "image-and-meme",
        "none"
      ]
    },
    "language": {
      "description": "Optional language code filter.",
      "type": "string",
      "minLength": 2,
      "maxLength": 8
    },
    "sortBy": {
      "description": "Optional sort order for returned ads.",
      "type": "string",
      "enum": [
        "impressions",
        "most-recent"
      ]
    },
    "startDate": {
      "description": "Optional start date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "endDate": {
      "description": "Optional end date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response (`data.page.nextCursor`).",
      "type": "string",
      "minLength": 1
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

facebook_adLibrary_companies_search

Search Facebook Ad Library companies / advertisers by name. Accepts a company name. Returns a list (use cursor when paginated).

Parameters1

query

string

required

Search query text for Facebook ad library companies.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for Facebook ad library companies."
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

google_company_ads_list

List ads a company or advertiser is running in Google Ad Transparency. Accepts a domain or advertiser id. Returns a list (use cursor when paginated).

Parameters9

domain	string	optional	Company domain when you do not have an advertiser id.
advertiserId	string	optional	Google Ad Transparency advertiser id when you have it instead of a domain.
topic	string	optional	Optional topic filter. When `political`, `region` is required.
region	string	optional	Optional region filter as a two-letter country code.
startDate	string	optional	Optional start date filter in YYYY-MM-DD format.
endDate	string	optional	Optional end date filter in YYYY-MM-DD format.
platform	string	optional	Optional Google surface filter.
format	string	optional	Optional creative format filter.
cursor	string	optional	Opaque pagination cursor from a previous response (`data.page.nextCursor`).

Raw schema

{
  "type": "object",
  "properties": {
    "domain": {
      "description": "Company domain when you do not have an advertiser id.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "advertiserId": {
      "description": "Google Ad Transparency advertiser id when you have it instead of a domain.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "topic": {
      "description": "Optional topic filter. When `political`, `region` is required.",
      "type": "string",
      "enum": [
        "all",
        "political"
      ]
    },
    "region": {
      "description": "Optional region filter as a two-letter country code.",
      "type": "string"
    },
    "startDate": {
      "description": "Optional start date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "endDate": {
      "description": "Optional end date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "platform": {
      "description": "Optional Google surface filter.",
      "type": "string",
      "enum": [
        "google_maps",
        "google_play",
        "google_search",
        "google_shopping",
        "youtube"
      ]
    },
    "format": {
      "description": "Optional creative format filter.",
      "type": "string",
      "enum": [
        "text",
        "image",
        "video"
      ]
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response (`data.page.nextCursor`).",
      "type": "string",
      "minLength": 1
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

google_adLibrary_ad_get

Get a single Google Ad Transparency creative by public Ad Transparency URL.

Parameters1

url

string

required

Public Google Ad Transparency URL for the creative.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public Google Ad Transparency URL for the creative."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

google_adLibrary_advertisers_search

Search Google Ad Transparency advertisers by name. Accepts a advertiser name. Returns a list (use cursor when paginated).

Parameters2

query	string	required	Search query text for Google Ad Transparency advertisers.
region	string	optional	Optional two-letter country code to search in. Defaults to US when omitted.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for Google Ad Transparency advertisers."
    },
    "region": {
      "description": "Optional two-letter country code to search in. Defaults to US when omitted.",
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_profile_get

Get a full Instagram profile by handle (bio, counts, and related fields). Returns lookupStatus plus follower/post metrics and privacy flags.

Parameters1

handle

string

required

Instagram handle to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Instagram handle to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_profile_basic_get

Get a lightweight Instagram profile by numeric user ID when you already have the id — prefer instagram.profile.get for handle lookups.

Parameters1

userId

string

required

Instagram numeric user id to look up.

Raw schema

{
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 32,
      "pattern": "^\\d+$",
      "description": "Instagram numeric user id to look up."
    }
  },
  "required": [
    "userId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_profile_posts_list

List posts from an Instagram profile by handle. Returns a list (use cursor when paginated).

Parameters2

handle	string	required	Instagram handle whose posts should be listed.
cursor	string	optional	Opaque pagination cursor from a previous response (`data.page.nextCursor`).

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Instagram handle whose posts should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response (`data.page.nextCursor`).",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_profile_reels_list

List Reels from an Instagram profile by handle. Returns a list (use cursor when paginated).

Parameters2

handle	string	required	Instagram handle whose reels should be listed.
cursor	string	optional	Opaque pagination cursor from a previous response (`data.page.nextCursor`).

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Instagram handle whose reels should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response (`data.page.nextCursor`).",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_profile_highlights_list

List story highlight albums for an Instagram profile by handle. Returns a list (use cursor when paginated).

Parameters1

handle

string

required

Instagram handle whose story highlight albums should be listed.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Instagram handle whose story highlight albums should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_highlight_get

Get stories inside a saved Instagram highlight by highlight id.

Parameters1

highlightId

string

required

Numeric Instagram highlight id from a highlight URL.

Raw schema

{
  "type": "object",
  "properties": {
    "highlightId": {
      "type": "string",
      "pattern": "^\\d+$",
      "description": "Numeric Instagram highlight id from a highlight URL."
    }
  },
  "required": [
    "highlightId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_post_get

Get a single Instagram post or Reel by URL. Author is under owner (not author); timestamps use takenAt.

Parameters4

url	string	required	Link to the post or reel.
region	string	optional	Optional ISO 3166-1 country code for request routing.
trim	any	optional	When true, returns a smaller response with fewer fields.
downloadMedia	any	optional	When true, returns permanent CDN URLs for media in `downloads`. Adds 10 credits (11 total including the base lookup).

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the post or reel."
    },
    "region": {
      "description": "Optional ISO 3166-1 country code for request routing.",
      "type": "string"
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer fields.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "downloadMedia": {
      "description": "When true, returns permanent CDN URLs for media in `downloads`. Adds 10 credits (11 total including the base lookup).",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_post_comments_list

List comments on an Instagram post or Reel by URL. Returns a list (use cursor when paginated).

Parameters2

url	string	required	Link to the Instagram post or reel whose comments should be listed.
cursor	string	optional	Opaque cursor from a previous response to fetch the next page.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Instagram post or reel whose comments should be listed."
    },
    "cursor": {
      "description": "Opaque cursor from a previous response to fetch the next page.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_post_transcript_get

Get the spoken transcript for an Instagram post or Reel by URL.

Parameters1

url

string

required

Link to the Instagram post or Reel whose transcript should be returned.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Instagram post or Reel whose transcript should be returned."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_search_profiles_list

Search Instagram profiles by keyword. Returns a list (use cursor when paginated).

Parameters2

query	string	required	Search query text for Instagram profiles.
cursor	string	optional	Opaque pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for Instagram profiles."
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_search_reels_list

Search Instagram Reels by keyword (optional date filters and page-based pagination). Returns a list (use cursor when paginated).

Parameters3

query	string	required	Search query text for Instagram Reels.
datePosted	string	optional	Optional filter for when matching reels were posted.
page	any	optional	1-based results page number. Omit to request the first page. Pagination is page-based.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for Instagram Reels."
    },
    "datePosted": {
      "type": "string",
      "enum": [
        "last-hour",
        "last-day",
        "last-week",
        "last-month",
        "last-year"
      ],
      "description": "Optional filter for when matching reels were posted."
    },
    "page": {
      "description": "1-based results page number. Omit to request the first page. Pagination is page-based.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_search_hashtag_list

Search public Instagram posts and Reels by hashtag. Returns a list (use cursor when paginated).

Parameters4

hashtag	string	required	Hashtag to search for. A leading # is optional.
datePosted	string	optional	Optional filter for when matching posts were posted.
mediaType	string	optional	Content filter. Use all for posts and Reels, or reels for Reels only. Defaults to all.
cursor	string	optional	Pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "hashtag": {
      "description": "Hashtag to search for. A leading # is optional.",
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "datePosted": {
      "type": "string",
      "enum": [
        "last-hour",
        "last-day",
        "last-week",
        "last-month",
        "last-year"
      ],
      "description": "Optional filter for when matching posts were posted."
    },
    "mediaType": {
      "type": "string",
      "enum": [
        "all",
        "reels"
      ],
      "description": "Content filter. Use all for posts and Reels, or reels for Reels only. Defaults to all."
    },
    "cursor": {
      "description": "Pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "hashtag"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

instagram_reels_trending_list

List currently trending Instagram Reels. Returns a list (use cursor when paginated).

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

pinterest_search_pins_list

Search public Pinterest pins by keyword. Returns a list (use cursor when paginated).

Parameters3

query	string	required	Search query text for Pinterest pins.
cursor	string	optional	Opaque pagination cursor returned by a previous response.
trim	any	optional	When true, returns a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for Pinterest pins."
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer fields.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

pinterest_pin_get

Fetch a public Pinterest pin by URL.

Parameters2

url	string	required	Link to the Pinterest pin.
trim	any	optional	When true, returns a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Pinterest pin."
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer fields.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

pinterest_profile_boards_list

List public boards for a Pinterest profile. Accepts a handle. Returns a list (use cursor when paginated).

Parameters3

handle	string	required	Pinterest username whose boards should be listed.
cursor	string	optional	Opaque pagination cursor returned by a previous response.
trim	any	optional	When true, returns a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Pinterest username whose boards should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer fields.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

pinterest_board_pins_list

List public pins on a Pinterest board by URL. Returns a list (use cursor when paginated).

Parameters3

url	string	required	Link to the Pinterest board.
cursor	string	optional	Opaque pagination cursor returned by a previous response.
trim	any	optional	When true, returns a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Pinterest board."
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer fields.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

threads_profile_get

Get a Threads profile for a creator or account. Accepts a handle.

Parameters1

handle

string

required

Threads handle to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Threads handle to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

bluesky_profile_get

Get a Bluesky profile for a creator or account. Accepts a handle.

Parameters1

handle

string

required

Bluesky handle to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Bluesky handle to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 253
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

bluesky_profile_posts_list

List posts from a Bluesky profile by handle. Returns a list (use cursor when paginated).

Parameters3

handle	string	required	Bluesky handle whose posts should be listed.
cursor	string	optional	Pagination cursor returned by a previous response.
userId	string	optional	Optional Bluesky user id to speed up the request.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Bluesky handle whose posts should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 253
    },
    "cursor": {
      "description": "Pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "userId": {
      "description": "Optional Bluesky user id to speed up the request.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

bluesky_post_get

Get a single Bluesky post by URL.

Parameters1

url

string

required

Link to the Bluesky post.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Bluesky post."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

threads_profile_posts_list

List posts from a Threads profile by handle. Returns a list (use cursor when paginated).

Parameters2

handle	string	required	Threads handle whose posts should be listed.
trim	boolean	optional	When true, returns a smaller response with fewer post fields when available.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Threads handle whose posts should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer post fields when available.",
      "type": "boolean"
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

threads_search_list

Search Threads posts by keyword. Returns a list (use cursor when paginated).

Parameters4

query	string	required	Search query text for public Threads posts.
startDate	string	optional	Optional start date filter in YYYY-MM-DD format.
endDate	string	optional	Optional end date filter in YYYY-MM-DD format.
trim	any	optional	Whether to request a smaller response shape when available.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for public Threads posts."
    },
    "startDate": {
      "description": "Optional start date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "endDate": {
      "description": "Optional end date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "trim": {
      "description": "Whether to request a smaller response shape when available.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

threads_post_get

Get a single Threads post by URL.

Parameters2

url	string	required	Link to the Threads post.
trim	any	optional	When true, returns a smaller response with fewer fields.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Threads post."
    },
    "trim": {
      "description": "When true, returns a smaller response with fewer fields.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

threads_users_search

Search Threads users by keyword. Returns a list (use cursor when paginated).

Parameters1

query

string

required

Search query text for Threads users.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for Threads users."
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_profile_get

Get LinkedIn person profiles by URL or handle. Returns a list (use cursor when paginated).

Parameters1

url

array

required

LinkedIn profile URL.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "LinkedIn profile URL.",
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 4096,
        "description": "LinkedIn profile URL, vanity handle, `@handle`, or `in/{handle}` path."
      }
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_profiles_posts_list

List posts from a LinkedIn person profile. Accepts a profile URL. Returns a list (use cursor when paginated).

Parameters5

url	string	required	LinkedIn profile URL or vanity handle whose public posts should be listed.
startDate	string	optional	Optional start of the date range for posts to include.
endDate	string	optional	Optional end of the date range for posts to include.
onlyAuthoredPosts	any	optional	When true, return only posts created by the profile owner.
limit	any	optional	Maximum posts to return (default 10).

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "LinkedIn profile URL or vanity handle whose public posts should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "startDate": {
      "description": "Optional start of the date range for posts to include.",
      "type": "string",
      "minLength": 1
    },
    "endDate": {
      "description": "Optional end of the date range for posts to include.",
      "type": "string",
      "minLength": 1
    },
    "onlyAuthoredPosts": {
      "description": "When true, return only posts created by the profile owner.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "limit": {
      "description": "Maximum posts to return (default 10).",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_people_search_list

Search LinkedIn people by first and/or last name. Returns a list (use cursor when paginated).

Parameters2

firstName	string	optional	First name filter. At least one of `firstName` or `lastName` is required.
lastName	string	optional	Last name filter. At least one of `firstName` or `lastName` is required.

Raw schema

{
  "type": "object",
  "properties": {
    "firstName": {
      "description": "First name filter. At least one of `firstName` or `lastName` is required.",
      "type": "string",
      "maxLength": 128
    },
    "lastName": {
      "description": "Last name filter. At least one of `firstName` or `lastName` is required.",
      "type": "string",
      "maxLength": 128
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_organization_get

Look up LinkedIn company, school, or organization pages by URL (broader than linkedin.company.get). Returns a list (use cursor when paginated).

Parameters1

url

array

required

LinkedIn organization page URL.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "LinkedIn organization page URL.",
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 4096,
        "description": "LinkedIn organization page URL with a `/company/`, `/school/`, or `/organization-guest/company/` path."
      }
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_company_get

Get a LinkedIn company page by company URL — use linkedin.organization.get for schools and mixed organization URLs.

Parameters1

url

string

required

LinkedIn company page URL for this lookup. School and organization-guest pages are not supported; use `GET /v1/linkedin/organizations`.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "LinkedIn company page URL for this lookup. School and organization-guest pages are not supported; use `GET /v1/linkedin/organizations`.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_company_posts_list

List posts from a LinkedIn company page. Accepts a company URL. Returns a list (use cursor when paginated).

Parameters2

url	string	required	LinkedIn company page URL or slug whose posts should be listed.
page	any	optional	1-based results page number. Pagination is page-based; at most 7 pages can be requested for a given company.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "LinkedIn company page URL or slug whose posts should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "page": {
      "description": "1-based results page number. Pagination is page-based; at most 7 pages can be requested for a given company.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_post_get

Get a LinkedIn post or article by URL.

Parameters1

url

string

required

Public permalink to the post or article.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public permalink to the post or article."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_post_transcript_get

Get the transcript for a LinkedIn post video by URL.

Parameters1

url

string

required

Link to the LinkedIn post whose video transcript should be returned.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the LinkedIn post whose video transcript should be returned."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_posts_search_list

Search public LinkedIn posts by keyword. Returns a list (use cursor when paginated).

Parameters3

query	string	required	Keyword or phrase to search for in public LinkedIn posts.
datePosted	string	optional	Optional filter for how recently matching posts were published.
cursor	string	optional	Opaque pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Keyword or phrase to search for in public LinkedIn posts."
    },
    "datePosted": {
      "type": "string",
      "enum": [
        "last-hour",
        "last-day",
        "last-week",
        "last-month",
        "last-year"
      ],
      "description": "Optional filter for how recently matching posts were published."
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_adLibrary_ad_get

Get a LinkedIn Ad Library ad by ad id or Ad Library URL.

Parameters2

adId	string	optional	LinkedIn Ad Library id for the ad.
url	string	optional	Public LinkedIn Ad Library URL for the ad.

Raw schema

{
  "type": "object",
  "properties": {
    "adId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "LinkedIn Ad Library id for the ad."
    },
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public LinkedIn Ad Library URL for the ad."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_adLibrary_ads_search_list

Search LinkedIn Ad Library ads by company, keyword, or company id. Returns a list (use cursor when paginated).

Parameters7

company	string	optional	Company name to search for in the LinkedIn Ad Library.
keyword	string	optional	Keyword or phrase to search for in LinkedIn Ad Library ads.
companyId	string	optional	LinkedIn company id to search for in the Ad Library.
countries	string	optional	Optional comma-separated list of country codes (for example US,CA,MX).
startDate	string	optional	Optional start date filter in YYYY-MM-DD format.
endDate	string	optional	Optional end date filter in YYYY-MM-DD format.
cursor	string	optional	Opaque pagination cursor from a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "company": {
      "description": "Company name to search for in the LinkedIn Ad Library.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "keyword": {
      "description": "Keyword or phrase to search for in LinkedIn Ad Library ads.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "companyId": {
      "description": "LinkedIn company id to search for in the Ad Library.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "countries": {
      "description": "Optional comma-separated list of country codes (for example US,CA,MX).",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "startDate": {
      "description": "Optional start date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "endDate": {
      "description": "Optional end date filter in YYYY-MM-DD format.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_jobs_get

Get LinkedIn job postings by job URL. Returns a list (use cursor when paginated).

Parameters1

url

array

required

LinkedIn job posting URL to look up.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "LinkedIn job posting URL to look up.",
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 4096,
        "description": "Full LinkedIn job posting URL. Must include `/jobs/view/`."
      }
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

linkedin_jobs_search_list

Search LinkedIn jobs by keyword and filters. Returns a list (use cursor when paginated).

Parameters10

keyword	string	required	Search keyword for LinkedIn job listings.
location	string	required	Location label for the search.
country	string	optional	Optional ISO 3166-1 country code.
timeRange	string	optional	Optional time range filter for when jobs were posted.
jobType	string	optional	Optional job type filter.
experienceLevel	string	optional	Optional experience level filter.
remote	string	optional	Optional work arrangement filter.
company	string	optional	Optional company name filter.
locationRadius	string	optional	Optional location radius filter.
limit	any	optional	Maximum job listings to return (default 10).

Raw schema

{
  "type": "object",
  "properties": {
    "keyword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search keyword for LinkedIn job listings."
    },
    "location": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256,
      "description": "Location label for the search."
    },
    "country": {
      "description": "Optional ISO 3166-1 country code.",
      "type": "string"
    },
    "timeRange": {
      "description": "Optional time range filter for when jobs were posted.",
      "type": "string",
      "enum": [
        "any",
        "past-month",
        "past-week",
        "past-24-hours"
      ]
    },
    "jobType": {
      "description": "Optional job type filter.",
      "type": "string",
      "enum": [
        "full-time",
        "part-time",
        "contract",
        "temporary",
        "volunteer"
      ]
    },
    "experienceLevel": {
      "description": "Optional experience level filter.",
      "type": "string",
      "enum": [
        "internship",
        "entry-level",
        "associate",
        "mid-senior-level",
        "director",
        "executive"
      ]
    },
    "remote": {
      "description": "Optional work arrangement filter.",
      "type": "string",
      "enum": [
        "on-site",
        "remote",
        "hybrid"
      ]
    },
    "company": {
      "description": "Optional company name filter.",
      "type": "string",
      "maxLength": 256
    },
    "locationRadius": {
      "description": "Optional location radius filter.",
      "type": "string",
      "enum": [
        "exact-location",
        "5-miles",
        "10-miles",
        "25-miles",
        "50-miles"
      ]
    },
    "limit": {
      "description": "Maximum job listings to return (default 10).",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    }
  },
  "required": [
    "keyword",
    "location"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

reddit_subreddit_get

Get details for a Reddit community (subreddit). Accepts a name (case-sensitive) or URL.

Parameters2

subreddit	string	optional	Subreddit name, optional `r/` prefix, or Reddit subreddit URL. Must match Reddit's exact casing.
url	string	optional	Optional subreddit URL for the request.

Raw schema

{
  "type": "object",
  "properties": {
    "subreddit": {
      "description": "Subreddit name, optional `r/` prefix, or Reddit subreddit URL. Must match Reddit's exact casing.",
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "url": {
      "description": "Optional subreddit URL for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

reddit_subreddit_posts_list

List posts from a specific subreddit. Accepts a case-sensitive subreddit name (r/ prefix and subreddit URLs accepted). Returns a list (use cursor when paginated).

Parameters4

subreddit	string	required	Subreddit name, optional `r/` prefix, or Reddit subreddit URL. Must match Reddit's exact casing. Lists posts for this subreddit.
sort	string	optional	Optional sort order for the returned posts.
timeframe	string	optional	Optional timeframe used with time-based sort orders.
cursor	string	optional	Opaque pagination cursor from a previous response (`data.page.nextCursor`).

Raw schema

{
  "type": "object",
  "properties": {
    "subreddit": {
      "description": "Subreddit name, optional `r/` prefix, or Reddit subreddit URL. Must match Reddit's exact casing. Lists posts for this subreddit.",
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "sort": {
      "description": "Optional sort order for the returned posts.",
      "type": "string",
      "enum": [
        "best",
        "hot",
        "new",
        "top",
        "rising"
      ]
    },
    "timeframe": {
      "description": "Optional timeframe used with time-based sort orders.",
      "type": "string",
      "enum": [
        "all",
        "day",
        "week",
        "month",
        "year"
      ]
    },
    "cursor": {
      "description": "Opaque pagination cursor from a previous response (`data.page.nextCursor`).",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "subreddit"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

reddit_subreddit_search_list

Search posts within one subreddit (not site-wide — use reddit.search.list for that). Accepts a case-sensitive subreddit name (r/ prefix and subreddit URLs accepted) and query. Returns a list (use cursor when paginated).

Parameters5

subreddit	string	required	Subreddit name, optional `r/` prefix, or Reddit subreddit URL. Must match Reddit's exact casing. Searches posts within this subreddit.
query	string	optional	Search text to match against public subreddit posts.
sort	string	optional	Optional sort order for search results. Defaults to relevance when omitted.
timeframe	string	optional	Optional time range filter for search results. Defaults to all when omitted.
cursor	string	optional	Opaque pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "subreddit": {
      "description": "Subreddit name, optional `r/` prefix, or Reddit subreddit URL. Must match Reddit's exact casing. Searches posts within this subreddit.",
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "query": {
      "description": "Search text to match against public subreddit posts.",
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    },
    "sort": {
      "type": "string",
      "enum": [
        "relevance",
        "hot",
        "top",
        "new",
        "comments"
      ],
      "description": "Optional sort order for search results. Defaults to relevance when omitted."
    },
    "timeframe": {
      "type": "string",
      "enum": [
        "all",
        "year",
        "month",
        "week",
        "day",
        "hour"
      ],
      "description": "Optional time range filter for search results. Defaults to all when omitted."
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "subreddit"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

reddit_post_comments_list

List comments on a Reddit post by URL. Returns a list (use cursor when paginated).

Parameters3

url	string	required	Link to the Reddit post whose comments should be listed.
cursor	string	optional	Opaque cursor from a previous response to fetch another page of comments or replies.
trim	any	optional	When true, requests a lighter response shape when available.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Reddit post whose comments should be listed."
    },
    "cursor": {
      "description": "Opaque cursor from a previous response to fetch another page of comments or replies.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "When true, requests a lighter response shape when available.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

reddit_post_transcript_get

Get captions transcript for a Reddit video post. Accepts a post or video URL.

Parameters2

url	string	required	Link to the Reddit post or direct hosted video URL whose transcript should be returned.
language	string	optional	Optional ISO 639-1 language code (two letters) to prefer when multiple caption tracks exist.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Reddit post or direct hosted video URL whose transcript should be returned."
    },
    "language": {
      "description": "Optional ISO 639-1 language code (two letters) to prefer when multiple caption tracks exist.",
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

reddit_search_list

Search Reddit posts across Reddit by keyword. Returns a list (use cursor when paginated).

Parameters5

query	string	required	Search query text for public Reddit posts.
sortBy	string	optional	Optional sort order for search results.
timeframe	string	optional	Optional time range filter for search results.
cursor	string	optional	Opaque pagination cursor returned by a previous response.
trim	any	optional	Whether to request a smaller response shape when available.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for public Reddit posts."
    },
    "sortBy": {
      "type": "string",
      "enum": [
        "relevance",
        "new",
        "top"
      ],
      "description": "Optional sort order for search results."
    },
    "timeframe": {
      "type": "string",
      "enum": [
        "all",
        "day",
        "week",
        "month",
        "year"
      ],
      "description": "Optional time range filter for search results."
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "trim": {
      "description": "Whether to request a smaller response shape when available.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "boolean"
        }
      ]
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

rumble_search_list

Search Rumble for videos and Shorts by keyword. Returns a list (use cursor when paginated).

Parameters2

query	string	required	Search query text for Rumble content.
cursor	string	optional	Page number from a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for Rumble content."
    },
    "cursor": {
      "description": "Page number from a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

rumble_channel_videos_list

List videos and Shorts from a Rumble channel. Accepts a channel URL. Returns a list (use cursor when paginated).

Parameters2

url	string	required	Link to the Rumble channel.
cursor	string	optional	Page number from a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Rumble channel."
    },
    "cursor": {
      "description": "Page number from a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

rumble_video_get

Get metadata for a Rumble video by URL.

Parameters1

url

string

required

Link to the Rumble video.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Rumble video."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

rumble_video_transcript_get

Get captions for a Rumble video when available. Accepts a video URL.

Parameters1

url

string

required

Link to the Rumble video.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Rumble video."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

rumble_video_comments_list

List top-level comments on a Rumble video. Accepts a video URL. Returns a list (use cursor when paginated).

Parameters1

url

string

required

Link to the Rumble video.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Rumble video."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitch_profile_get

Get a Twitch profile for a channel by handle.

Parameters1

handle

string

required

Twitch handle to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Twitch handle to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitch_profile_videos_list

List videos from a Twitch channel by handle. Returns a list (use cursor when paginated).

Parameters3

handle	string	required	Twitch handle to look up, with or without a leading @.
filterBy	string	optional	Optional filter for video type.
sortBy	string	optional	Optional sort order.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Twitch handle to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "filterBy": {
      "description": "Optional filter for video type.",
      "type": "string",
      "enum": [
        "highlight",
        "archive",
        "upload"
      ]
    },
    "sortBy": {
      "description": "Optional sort order.",
      "type": "string",
      "enum": [
        "time",
        "views"
      ]
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitch_profile_schedule_get

Get the stream schedule for a Twitch channel by handle.

Parameters1

handle

string

required

Twitch handle to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "Twitch handle to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

twitch_clip_get

Get metadata and playback URLs for a Twitch clip by URL.

Parameters1

url

string

required

Link to the Twitch clip.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the Twitch clip."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

github_profile_get

Get a GitHub profile for a user or organization. Accepts a username.

Parameters1

handle

string

required

GitHub username to look up, with or without a leading @.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "GitHub username to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 39
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

github_profile_repositories_list

List repositories for a GitHub user or organization. Accepts a username. Returns a list (use cursor when paginated).

Parameters5

handle	string	required	GitHub username whose public repositories should be listed.
cursor	string	optional	Pagination cursor returned by a previous response.
type	string	optional	Repository type filter. Defaults to owner.
sort	string	optional	Sort field for repositories.
direction	string	optional	Sort direction.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "GitHub username whose public repositories should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 39
    },
    "cursor": {
      "description": "Pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "type": {
      "description": "Repository type filter. Defaults to owner.",
      "type": "string",
      "enum": [
        "owner",
        "all",
        "member"
      ]
    },
    "sort": {
      "description": "Sort field for repositories.",
      "type": "string",
      "enum": [
        "created",
        "updated",
        "pushed",
        "full_name"
      ]
    },
    "direction": {
      "description": "Sort direction.",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

github_repositories_get

Get a single GitHub repository by URL.

Parameters1

url

string

required

Full public GitHub repository URL.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Full public GitHub repository URL."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

github_profile_activity_list

List recent public activity for a GitHub profile, one month per request. Accepts a username. Returns a list (use cursor when paginated).

Parameters3

handle	string	required	GitHub username whose public activity timeline should be listed.
year	any	optional	Calendar year to read activity for. Defaults to the current year when omitted.
cursor	string	optional	Pagination cursor from a previous response (`data.page.nextCursor`). Pages backward one month at a time through the selected year.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "GitHub username whose public activity timeline should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 39
    },
    "year": {
      "description": "Calendar year to read activity for. Defaults to the current year when omitted.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "cursor": {
      "description": "Pagination cursor from a previous response (`data.page.nextCursor`). Pages backward one month at a time through the selected year.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

github_profile_followers_list

List followers for a GitHub profile. Accepts a username. Returns a list (use cursor when paginated).

Parameters2

handle	string	required	GitHub username whose followers should be listed.
cursor	string	optional	Pagination cursor from a previous response (numeric page index as a string).

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "GitHub username whose followers should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 39
    },
    "cursor": {
      "description": "Pagination cursor from a previous response (numeric page index as a string).",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

github_profile_following_list

List accounts a GitHub profile follows. Accepts a username. Returns a list (use cursor when paginated).

Parameters2

handle	string	required	GitHub username whose following list should be listed.
cursor	string	optional	Pagination cursor from a previous response (numeric page index as a string).

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "GitHub username whose following list should be listed.",
      "type": "string",
      "minLength": 1,
      "maxLength": 39
    },
    "cursor": {
      "description": "Pagination cursor from a previous response (numeric page index as a string).",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

github_profile_contributions_get

Get the contribution graph for a GitHub profile for a given year. Accepts a username.

Parameters2

handle	string	required	GitHub username to look up, with or without a leading @.
year	any	optional	Calendar year for the contribution graph. Defaults to the current year when omitted.

Raw schema

{
  "type": "object",
  "properties": {
    "handle": {
      "description": "GitHub username to look up, with or without a leading @.",
      "type": "string",
      "minLength": 1,
      "maxLength": 39
    },
    "year": {
      "description": "Calendar year for the contribution graph. Defaults to the current year when omitted.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    }
  },
  "required": [
    "handle"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

github_trending_repositories_list

List trending GitHub repositories for a language and time window. Returns a list (use cursor when paginated).

Parameters3

language	string	optional	Optional coding language filter.
since	string	optional	Trending time window. Defaults to daily when omitted.
spokenLanguageCode	string	optional	Optional spoken language code filter.

Raw schema

{
  "type": "object",
  "properties": {
    "language": {
      "description": "Optional coding language filter.",
      "type": "string",
      "minLength": 1
    },
    "since": {
      "description": "Trending time window. Defaults to daily when omitted.",
      "type": "string",
      "enum": [
        "daily",
        "weekly",
        "monthly"
      ]
    },
    "spokenLanguageCode": {
      "description": "Optional spoken language code filter.",
      "type": "string",
      "minLength": 1
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

github_trending_developers_list

List trending GitHub developers for a language and time window. Returns a list (use cursor when paginated).

Parameters2

language	string	optional	Optional trending coding language filter.
since	string	optional	Trending time window. Defaults to daily when omitted.

Raw schema

{
  "type": "object",
  "properties": {
    "language": {
      "description": "Optional trending coding language filter.",
      "type": "string",
      "minLength": 1
    },
    "since": {
      "description": "Trending time window. Defaults to daily when omitted.",
      "type": "string",
      "enum": [
        "daily",
        "weekly",
        "monthly"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

spotify_artist_get

Get a Spotify artist by id or profile URL.

Parameters2

artistId	string	optional	Optional Spotify artist id for the request.
url	string	optional	Optional Spotify artist URL for the request.

Raw schema

{
  "type": "object",
  "properties": {
    "artistId": {
      "description": "Optional Spotify artist id for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "url": {
      "description": "Optional Spotify artist URL for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

spotify_album_get

Get a Spotify album by id or album URL.

Parameters2

albumId	string	optional	Optional Spotify album id for the request.
url	string	optional	Optional Spotify album URL for the request.

Raw schema

{
  "type": "object",
  "properties": {
    "albumId": {
      "description": "Optional Spotify album id for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "url": {
      "description": "Optional Spotify album URL for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

spotify_track_get

Get a Spotify track by id or track URL.

Parameters2

trackId	string	optional	Optional Spotify track id for the request.
url	string	optional	Optional Spotify track URL for the request.

Raw schema

{
  "type": "object",
  "properties": {
    "trackId": {
      "description": "Optional Spotify track id for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "url": {
      "description": "Optional Spotify track URL for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_channel_get

Get YouTube channel details by channel id, handle, or URL. Returns channel metrics and identifiers for snapshot baselines.

Parameters3

channelId	string	optional	Optional YouTube channel id for the request.
handle	string	optional	Optional YouTube channel handle for the request.
url	string	optional	Optional YouTube channel URL for the request.

Raw schema

{
  "type": "object",
  "properties": {
    "channelId": {
      "description": "Optional YouTube channel id for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "handle": {
      "description": "Optional YouTube channel handle for the request.",
      "type": "string"
    },
    "url": {
      "description": "Optional YouTube channel URL for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_channel_videos_list

List long-form videos from a YouTube channel (not Shorts — use youtube.channel.shorts.list). Accepts a channel id or handle. Returns a list (use cursor when paginated).

Parameters5

channelId	string	optional	Optional YouTube channel id for the request.
handle	string	optional	Optional YouTube channel handle for the request.
sortBy	string	optional	Optional sort order for the returned YouTube videos.
cursor	string	optional	Opaque pagination cursor returned by a previous response.
includeExtras	boolean	optional	Optional flag to include richer per-video metadata when available.

Raw schema

{
  "type": "object",
  "properties": {
    "channelId": {
      "description": "Optional YouTube channel id for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "handle": {
      "description": "Optional YouTube channel handle for the request.",
      "type": "string"
    },
    "sortBy": {
      "description": "Optional sort order for the returned YouTube videos.",
      "type": "string",
      "enum": [
        "latest",
        "popular"
      ]
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "includeExtras": {
      "description": "Optional flag to include richer per-video metadata when available.",
      "type": "boolean"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_channel_shorts_list

List Shorts from a YouTube channel (not long-form videos). Accepts a channel id or handle. Returns a list (use cursor when paginated).

Parameters4

channelId	string	optional	Optional YouTube channel id for the request.
handle	string	optional	Optional YouTube channel handle for the request.
sortBy	string	optional	Optional sort order for the returned YouTube Shorts.
cursor	string	optional	Opaque pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "channelId": {
      "description": "Optional YouTube channel id for the request.",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    },
    "handle": {
      "description": "Optional YouTube channel handle for the request.",
      "type": "string"
    },
    "sortBy": {
      "description": "Optional sort order for the returned YouTube Shorts.",
      "type": "string",
      "enum": [
        "latest",
        "popular"
      ]
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_playlist_get

Get a YouTube playlist by playlist id.

Parameters1

playlistId

string

required

YouTube playlist id, or a YouTube playlist URL (the `list` query value is used when present).

Raw schema

{
  "type": "object",
  "properties": {
    "playlistId": {
      "description": "YouTube playlist id, or a YouTube playlist URL (the `list` query value is used when present).",
      "type": "string",
      "minLength": 1,
      "maxLength": 4096
    }
  },
  "required": [
    "playlistId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_community_post_get

Get a YouTube community post by URL.

Parameters1

url

string

required

Public YouTube community post URL.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Public YouTube community post URL."
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_search_list

Search YouTube videos, channels, and playlists by keyword. Returns a list (use cursor when paginated).

Parameters8

query	string	required	Search query text for YouTube content.
uploadDate	string	optional	Optional upload date filter for video results.
sortBy	string	optional	Optional sort order for search results.
type	string	optional	Optional content type filter for search results.
duration	string	optional	Optional duration filter for video results. Applies to videos, not shorts.
region	string	optional	Optional ISO 3166-1 country code for localized search results.
cursor	string	optional	Opaque pagination cursor returned by a previous response.
includeExtras	boolean	optional	When true, returns richer per-video metadata when available. May increase response time.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Search query text for YouTube content."
    },
    "uploadDate": {
      "type": "string",
      "enum": [
        "today",
        "this_week",
        "this_month",
        "this_year"
      ],
      "description": "Optional upload date filter for video results."
    },
    "sortBy": {
      "type": "string",
      "enum": [
        "relevance",
        "popular"
      ],
      "description": "Optional sort order for search results."
    },
    "type": {
      "type": "string",
      "enum": [
        "videos",
        "shorts",
        "channels",
        "playlists"
      ],
      "description": "Optional content type filter for search results."
    },
    "duration": {
      "type": "string",
      "enum": [
        "under_3_min",
        "between_3_and_20_min",
        "over_20_min"
      ],
      "description": "Optional duration filter for video results. Applies to videos, not shorts."
    },
    "region": {
      "description": "Optional ISO 3166-1 country code for localized search results.",
      "type": "string"
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    },
    "includeExtras": {
      "description": "When true, returns richer per-video metadata when available. May increase response time.",
      "type": "boolean"
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_search_hashtag_list

Search YouTube content by hashtag. Returns a list (use cursor when paginated).

Parameters3

hashtag	string	required	Hashtag to search for. A leading # is optional.
type	string	optional	Optional content filter.
cursor	string	optional	Opaque pagination cursor returned by a previous response.

Raw schema

{
  "type": "object",
  "properties": {
    "hashtag": {
      "description": "Hashtag to search for. A leading # is optional.",
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "type": {
      "type": "string",
      "enum": [
        "all",
        "shorts"
      ],
      "description": "Optional content filter."
    },
    "cursor": {
      "description": "Opaque pagination cursor returned by a previous response.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "hashtag"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_shorts_trending_list

List currently trending YouTube Shorts. Returns a list (use cursor when paginated).

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_video_get

Get a single YouTube video by URL. Channel lives under channel (not author); publish time is publishedAt.

Parameters2

url	string	required	Link to the YouTube video. Shorts URLs are also supported.
language	string	optional	Optional preferred language for returned text when the source supports localization.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the YouTube video. Shorts URLs are also supported."
    },
    "language": {
      "description": "Optional preferred language for returned text when the source supports localization.",
      "type": "string",
      "minLength": 2,
      "maxLength": 16
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_video_comments_list

List comments on a YouTube video by URL. Returns a list (use cursor when paginated).

Parameters3

url	string	required	Link to the YouTube video whose comments should be listed.
cursor	string	optional	Opaque cursor from a previous response to fetch the next page.
order	string	optional	Comment sort order. `top` returns highest-ranked comments; `newest` returns the most recent comments.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the YouTube video whose comments should be listed."
    },
    "cursor": {
      "description": "Opaque cursor from a previous response to fetch the next page.",
      "type": "string",
      "minLength": 1
    },
    "order": {
      "description": "Comment sort order. `top` returns highest-ranked comments; `newest` returns the most recent comments.",
      "type": "string",
      "enum": [
        "top",
        "newest"
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_video_comments_replies_list

List replies to a YouTube comment. Accepts a from video comments. Returns a list (use cursor when paginated).

Parameters1

cursor

string

required

Comment `repliesCursor` from Video Comments endpoint, or `page.nextCursor` to paginate replies.

Raw schema

{
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string",
      "minLength": 1,
      "description": "Comment `repliesCursor` from Video Comments endpoint, or `page.nextCursor` to paginate replies."
    }
  },
  "required": [
    "cursor"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

youtube_video_transcript_get

Get the transcript for a YouTube video by URL.

Parameters2

url	string	required	Link to the YouTube video whose transcript should be returned.
language	string	optional	Optional ISO 639-1 language code (two letters) to prefer when multiple transcripts exist.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Link to the YouTube video whose transcript should be returned."
    },
    "language": {
      "description": "Optional ISO 639-1 language code (two letters) to prefer when multiple transcripts exist.",
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

web_search_run

Search the public web and return ranked organic results with snippets. Accepts a query. Returns a list (use cursor when paginated).

Parameters4

query	string	required	Search query text to run against the public web.
region	string	optional	ISO 3166-1 country code for localized results (e.g. US, GB, CA).
datePosted	string	optional	Optional filter by when results were posted.
page	any	optional	Page number (1-based). Defaults to 1 when omitted.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500,
      "description": "Search query text to run against the public web."
    },
    "region": {
      "description": "ISO 3166-1 country code for localized results (e.g. US, GB, CA).",
      "type": "string"
    },
    "datePosted": {
      "description": "Optional filter by when results were posted.",
      "type": "string",
      "enum": [
        "last-hour",
        "last-day",
        "last-week",
        "last-month",
        "last-year"
      ]
    },
    "page": {
      "description": "Page number (1-based). Defaults to 1 when omitted.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

web_markdown_generate

Convert a web page URL into clean markdown.

Parameters4

url	string	required	Web page URL to fetch.
filter	string	optional	Content filter strategy for markdown extraction.
query	string	optional	Optional query string used by the bm25 filter to rank relevant content.
cacheMode	string	optional	Cache behavior. Defaults to enabled.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "Web page URL to fetch.",
      "type": "string",
      "minLength": 1,
      "maxLength": 2083
    },
    "filter": {
      "default": "fit",
      "description": "Content filter strategy for markdown extraction.",
      "type": "string",
      "enum": [
        "fit",
        "raw",
        "bm25"
      ]
    },
    "query": {
      "description": "Optional query string used by the bm25 filter to rank relevant content.",
      "type": "string",
      "maxLength": 500
    },
    "cacheMode": {
      "default": "enabled",
      "description": "Cache behavior. Defaults to enabled.",
      "type": "string",
      "enum": [
        "enabled",
        "bypass",
        "write_only"
      ]
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

web_ask_run

Ask a natural-language question about a specific web page and get an LLM-generated answer. Accepts a URL.

Parameters2

url	string	required	Web page URL to fetch.
q	string	required	Natural-language question to answer about the page content.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "Web page URL to fetch.",
      "type": "string",
      "minLength": 1,
      "maxLength": 2083
    },
    "q": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500,
      "description": "Natural-language question to answer about the page content."
    }
  },
  "required": [
    "url",
    "q"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

web_html_generate

Fetch cleaned HTML for a web page URL.

Parameters1

url

string

required

Web page URL to fetch.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "Web page URL to fetch.",
      "type": "string",
      "minLength": 1,
      "maxLength": 2083
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

web_crawl_run

Crawl a small set of web pages synchronously. Accepts a URLs. Returns a list (use cursor when paginated).

Parameters1

url

array

required

URLs to crawl. Repeat the `url` query parameter for multiple pages (max 5).

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "description": "URLs to crawl. Repeat the `url` query parameter for multiple pages (max 5).",
      "minItems": 1,
      "maxItems": 5,
      "type": "array",
      "items": {
        "description": "Web page URL to fetch.",
        "type": "string",
        "minLength": 1,
        "maxLength": 2083
      }
    }
  },
  "required": [
    "url"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

nl_ask_post

Route a natural-language social-data question to the right lookup when you do not yet know the typed tool — prefer typed tools once the operation is known. Accepts a natural-language query.

Parameters1

query

string

required

Natural-language question to route to a public API lookup.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500,
      "description": "Natural-language question to route to a public API lookup."
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

auth_whoami

Get the authenticated API account for this session.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

billing_balance_get

Get remaining credit balance before running large batches of metered tools.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

docs_search

Search SocialFetch docs for API/SDK questions. For response fields use docs_read (defaults to outline). For cross-platform author/timestamp naming, search `field crosswalk` or read /product/ask-ai/field-crosswalk.

Parameters3

query	string	required	Natural-language description of what to find in SocialFetch docs (at least 2 characters).
limit	integer	optional	Maximum number of docs results to return.
currentDocsPathname	string	optional	Optional current SocialFetch docs pathname, such as /docs/sdk or /product/guides/..., to boost nearby results.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Natural-language description of what to find in SocialFetch docs (at least 2 characters)."
    },
    "limit": {
      "description": "Maximum number of docs results to return.",
      "default": 5,
      "type": "integer",
      "minimum": 1,
      "maximum": 10
    },
    "currentDocsPathname": {
      "description": "Optional current SocialFetch docs pathname, such as /docs/sdk or /product/guides/..., to boost nearby results.",
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

docs_read

Read a corpus page by docsPathname from docs_search. Defaults to mode=outline (compact field digest). Pass mode=full for Examples/SDK snippets. Accepts /docs/... and /product/... pathnames (including /product/ask-ai/field-crosswalk).

Parameters2

docsPathname	string	required	Corpus pathname from docs_search, e.g. /docs/api/v1/tiktok/videos/get or /product/ask-ai/field-crosswalk. Trailing .mdx accepted.
mode	string	optional	outline (default) = compact params/credits/field digest. full = complete page including Examples.

Raw schema

{
  "type": "object",
  "properties": {
    "docsPathname": {
      "type": "string",
      "minLength": 1,
      "description": "Corpus pathname from docs_search, e.g. /docs/api/v1/tiktok/videos/get or /product/ask-ai/field-crosswalk. Trailing .mdx accepted."
    },
    "mode": {
      "default": "outline",
      "description": "outline (default) = compact params/credits/field digest. full = complete page including Examples.",
      "type": "string",
      "enum": [
        "outline",
        "full"
      ]
    }
  },
  "required": [
    "docsPathname"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

README.md8 KBView on GitHub

Social Fetch MCP

Let your coding agent fetch real social media and web data while it builds.

Documentation | API reference | Credits & billing

Server URL: https://api.socialfetch.dev/mcp

What Is This?

Social Fetch MCP connects Cursor, VS Code, Claude, Windsurf, and other MCP clients to the Social Fetch API. Once installed, your agent can look up creators, fetch posts, search platforms, read web pages, check your balance, and read the Social Fetch docs from inside your editor.

Use it when you want your agent to answer questions like:

"Find this TikTok creator and add their latest videos to my app."
"Pull the transcript for this YouTube video and summarize the sponsorships."
"Fetch this Instagram post, inspect the response shape, and wire it into my backend."
"Read the Social Fetch docs and choose the right endpoint for Reddit search."

The MCP server itself is hosted by Social Fetch:

text

https://api.socialfetch.dev/mcp

There is no local server to clone, build, or run from this repository. Clients connect to the hosted Streamable HTTP endpoint and authenticate with OAuth in the browser.

Why Use It?

Agents are better when they can work with the same API your app uses. This gives them a direct, authenticated route to Social Fetch instead of making you bounce between docs, dashboards, scripts, and pasted JSON.

Less setup: call Social Fetch tools directly from your agent.
Better answers: the agent can search and read the live docs before choosing an endpoint.
Real data in the loop: test with TikTok, Instagram, YouTube, X/Twitter, Reddit, Spotify, web, and more from inside your editor.
No API keys in editor config: sign in once with OAuth.
Same API everywhere: MCP tools map to the public REST API, SDK, and docs.

What You Can Fetch

Social Fetch MCP exposes endpoint tools for:

TikTok, Instagram, YouTube, X/Twitter, Telegram, Facebook, Threads, LinkedIn, Reddit, and Spotify data.
Profiles, posts, videos, comments, transcripts, search results, and platform-specific metadata.
Web markdown generation and AI-assisted web page questions.
Account identity and credit balance.
Social Fetch docs through docs_search and docs_read.

Endpoint tools are metered like the REST API. Docs tools, auth_whoami, and billing_balance_get do not consume lookup credits.

Requirements

A Social Fetch account.
Credits for metered API routes.
An MCP client with remote Streamable HTTP support and OAuth, such as Cursor, VS Code, Claude Code, Claude Desktop, or MCP Inspector.

One-Click Install

Install in Cursor
Install in VS Code
Install in Windsurf
Open the hosted install page

Complete the OAuth browser flow after installing. If a one-click link does nothing - your editor is not installed, blocks custom URL schemes, or has no handler - use the manual setup below.

Manual Setup

Cursor

Add this to ~/.cursor/mcp.json or a project .cursor/mcp.json:

json

{
  "mcpServers": {
    "socialfetch": {
      "url": "https://api.socialfetch.dev/mcp"
    }
  }
}

Restart Cursor, open MCP settings, and complete the OAuth browser flow when prompted.

VS Code

Add this to settings.json:

json

{
  "mcp": {
    "servers": {
      "socialfetch": {
        "url": "https://api.socialfetch.dev/mcp"
      }
    }
  }
}

Claude Code

bash

claude mcp add --transport http socialfetch https://api.socialfetch.dev/mcp

Then run /mcp and authenticate Social Fetch to finish the OAuth flow.

Claude Desktop

Add a custom remote MCP connector with this URL:

text

https://api.socialfetch.dev/mcp

Authorize Social Fetch when Claude prompts you.

stdio-only Clients

If your client only supports stdio MCP servers, bridge to the hosted server with mcp-remote:

bash

npx mcp-remote https://api.socialfetch.dev/mcp

Point your client at the stdio process that command starts.

Authentication

Social Fetch MCP uses OAuth 2.1. Your MCP client handles the flow:

The client opens Social Fetch sign-in in your browser.
You sign in or create an account and approve access.
The client receives an access token and sends it with each MCP request.

Do not paste a Social Fetch API key into MCP config. Credits are charged to the signed-in account, just like REST API requests.

Tools

tools/list exposes endpoint tools plus docs tools.

Endpoint tool names match API operation IDs with dots replaced by underscores:

Tool name	API operation
`tiktok_profile_get`	`tiktok.profile.get`
`instagram_post_get`	`instagram.post.get`
`web_markdown_generate`	`web.markdown.generate`
`auth_whoami`	`auth.whoami`
`billing_balance_get`	`billing.balance.get`

Each endpoint tool's arguments mirror the matching API route parameters. See the API reference for the full endpoint catalog, argument schemas, response shapes, and pricing.

Two docs tools are also available:

Tool name	Purpose
`docs_search`	Search Social Fetch docs across API, SDK, auth, errors, credits, and integrations.
`docs_read`	Read a full docs page as markdown by pathname, such as `/docs/sdk`.

Recommended agent prompt:

Use the Social Fetch MCP docs to add TikTok profile lookup to this app with the TypeScript SDK.

Example: TikTok Profile

In Cursor, MCP Inspector, or another MCP client, call tiktok_profile_get with:

json

{ "handle": "nike" }

The result contains the same data and meta envelope returned by the REST API. Check meta.creditsCharged and meta.requestId after metered calls.

Troubleshooting

Symptom	What to check
`401` on every call	Reconnect the server and complete OAuth again. Your token may be missing or expired.
OAuth redirect loop	Finish signing in at Social Fetch, then approve access to return to your client.
`402` responses	Your account is out of credits for the metered route. Top up in Credits & billing.
No tools listed	Reconnect the server. If it persists, restart your MCP client.
Client only supports stdio	Use `npx mcp-remote https://api.socialfetch.dev/mcp`.

Repository Contents

server.json - MCP Registry metadata for the hosted remote server.
examples/ - Copy-paste MCP client configuration snippets.
assets/socialfetch-mark.svg - Local copy of the Social Fetch mark (also served at https://api.socialfetch.dev/mcp/icon.svg).

The implementation lives in Social Fetch's private API service, not in this public listing repository.

License

MIT (c) Social Freak Ltd

Install

Tools (142)

tiktok_profile_gettiktok_profile_videos_listtiktok_profile_followers_listtiktok_profile_following_listtiktok_profile_region_gettiktok_profile_audience_gettiktok_profile_live_checktiktok_users_search

Remote endpoint

Streamable HTTP

Hosted server - connect over the network, no local install.

url

https://api.socialfetch.dev/mcp

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "socialfetch": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://api.socialfetch.dev/mcp"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.