Captapi is an MCP server published by io.github.CDCStream, hosted at api.captapi.com. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 179 tools, including youtube_transcript, youtube_audio_transcript, youtube_summarize, youtube_video_details, youtube_comments.
Public social media data: profiles, posts, comments, transcripts and ad libraries, 30+ platforms.
10 connections through 5 shared values. Tap any node.
Inferred from the host name and headers: what a server runs on, not who runs it.
YouTube's published captions with timestamps — not speech-to-text. Flat 1 credit; 404 is free. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
None yet. Changes appear after a server's second daily check.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
| language | string | Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. |
{
"name": "youtube_transcript",
"description": "YouTube's published captions with timestamps — not speech-to-text. Flat 1 credit; 404 is free. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Preferred caption language as an ISO code, e.g. \"en\". Defaults to auto-detect."
}
},
"additionalProperties": false
}
}Speech-to-text for YouTube audio. Use it when a video has no captions — or when you want a transcript of what was actually spoken rather than YouTube's published captions. Priced per started minute of audio. Costs 2 credits/min of audio. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. |
| maxCredits | integer | Refuse before STT when estimatedCredits would exceed this (400 cost_exceeds_max, 0 credits). The estimate is on every success and, when the extract miss is retryable, as estimatedCreditsIfRetried. |
{
"name": "youtube_audio_transcript",
"description": "Speech-to-text for YouTube audio. Use it when a video has no captions — or when you want a transcript of what was actually spoken rather than YouTube's published captions. Priced per started minute of audio. Costs 2 credits/min of audio. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Preferred caption language as an ISO code, e.g. \"en\". Defaults to auto-detect."
},
"maxCredits": {
"type": "integer",
"minimum": 1,
"description": "Refuse before STT when estimatedCredits would exceed this (400 cost_exceeds_max, 0 credits). The estimate is on every success and, when the extract miss is retryable, as estimatedCreditsIfRetried."
}
},
"additionalProperties": false
}
}AI summary from YouTube's published captions — same source as /transcript. Flat 3 credits; caption-miss 404 is free. Costs 3 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. |
{
"name": "youtube_summarize",
"description": "AI summary from YouTube's published captions — same source as /transcript. Flat 3 credits; caption-miss 404 is free. Costs 3 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Preferred caption language as an ISO code, e.g. \"en\". Defaults to auto-detect."
}
},
"additionalProperties": false
}
}YouTube video metadata + stats. Always includes degraded / degradedReason — retry when degraded is true. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_video_details",
"description": "YouTube video metadata + stats. Always includes degraded / degradedReason — retry when degraded is true. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Get comments on any YouTube video — text, author, likes, and truncated publishedTimeApprox from the relative label, with cursor pagination (nextCursor + hasMore). Flat 2 credits per call; 0 when the video has comments turned off (commentsDisabled: true). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_comments",
"description": "Get comments on any YouTube video — text, author, likes, and truncated publishedTimeApprox from the relative label, with cursor pagination (nextCursor + hasMore). Flat 2 credits per call; 0 when the video has comments turned off (commentsDisabled: true). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}YouTube channel stats — ISO country, createdAt date-only, real banner or null, quote-aware SEO tags, absolute links. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_channel_details",
"description": "YouTube channel stats — ISO country, createdAt date-only, real banner or null, quote-aware SEO tags, absolute links. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}YouTube search with cursor pagination — typed hits, ids, canonical URLs, filters (2 credits/page, 0 when a page finds nothing). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Search query or keywords (min 2 characters). |
| type | string | all | videos | shorts | channels | playlists. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| region | string | ISO country code for localized results (default US). |
| sortBy | string | relevance | views (alias: popular→views). date and rating answer 400 SORT_NOT_SUPPORTED: YouTube no longer orders search by upload date (use uploadDate) or by rating. With type=shorts only relevance is supported. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| duration | string | any | under_4 | 4_20 | over_20. Applies to long-form videos (not Shorts). |
| uploadDate | string | any | today | this_week | this_month | this_year. |
{
"name": "youtube_search",
"description": "YouTube search with cursor pagination — typed hits, ids, canonical URLs, filters (2 credits/page, 0 when a page finds nothing). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Search query or keywords (min 2 characters)."
},
"type": {
"type": "string",
"description": "all | videos | shorts | channels | playlists."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"region": {
"type": "string",
"description": "ISO country code for localized results (default US)."
},
"sortBy": {
"type": "string",
"description": "relevance | views (alias: popular→views). date and rating answer 400 SORT_NOT_SUPPORTED: YouTube no longer orders search by upload date (use uploadDate) or by rating. With type=shorts only relevance is supported."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"duration": {
"type": "string",
"description": "any | under_4 | 4_20 | over_20. Applies to long-form videos (not Shorts)."
},
"uploadDate": {
"type": "string",
"description": "any | today | this_week | this_month | this_year."
}
},
"additionalProperties": false
}
}Channel uploads with cursor pagination — exact publishedAt from reel_item_watch (same as channel-shorts). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| fast | boolean | Set true to use YouTube RSS for faster results with less detailed metadata. Leave false when viewCount/duration quality matters. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_channel_videos",
"description": "Channel uploads with cursor pagination — exact publishedAt from reel_item_watch (same as channel-shorts). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"fast": {
"type": "boolean",
"description": "Set true to use YouTube RSS for faster results with less detailed metadata. Leave false when viewCount/duration quality matters."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Paginated playlist contents — cursor/nextCursor/hasMore, same row shape as channel-videos. Flat 2 credits/page. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | YouTube playlist URL, e.g. https://youtube.com/playlist?list=ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| fast | boolean | Set true to use YouTube RSS for faster results with less detailed metadata. Leave false when viewCount/duration quality matters. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_playlist_videos",
"description": "Paginated playlist contents — cursor/nextCursor/hasMore, same row shape as channel-videos. Flat 2 credits/page. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "YouTube playlist URL, e.g. https://youtube.com/playlist?list=ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"fast": {
"type": "boolean",
"description": "Set true to use YouTube RSS for faster results with less detailed metadata. Leave false when viewCount/duration quality matters."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Playlist metadata only — title, channel{}, totalVideos, thumbnailUrl. No videos[]. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | YouTube playlist URL, e.g. https://youtube.com/playlist?list=ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_playlist",
"description": "Playlist metadata only — title, channel{}, totalVideos, thumbnailUrl. No videos[]. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "YouTube playlist URL, e.g. https://youtube.com/playlist?list=ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Transcript for a YouTube Short — rejects long-form videos (≤3 min only). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID (≤3 min). Long-form videos return HTTP 422 — use the matching /v1/youtube/… endpoint instead. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn t… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. |
{
"name": "youtube_shorts_transcript",
"description": "Transcript for a YouTube Short — rejects long-form videos (≤3 min only). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID (≤3 min). Long-form videos return HTTP 422 — use the matching /v1/youtube/… endpoint instead. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Preferred caption language as an ISO code, e.g. \"en\". Defaults to auto-detect."
}
},
"additionalProperties": false
}
}AI summary of a YouTube Short — rejects long-form videos (≤3 min only). Costs 3 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID (≤3 min). Long-form videos return HTTP 422 — use the matching /v1/youtube/… endpoint instead. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn t… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. |
{
"name": "youtube_shorts_summarize",
"description": "AI summary of a YouTube Short — rejects long-form videos (≤3 min only). Costs 3 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID (≤3 min). Long-form videos return HTTP 422 — use the matching /v1/youtube/… endpoint instead. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Preferred caption language as an ISO code, e.g. \"en\". Defaults to auto-detect."
}
},
"additionalProperties": false
}
}YouTube Short metadata — same schema as Video Details, with isShort:true; long-form videos get HTTP 422. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID (≤3 min). Long-form videos return HTTP 422 — use the matching /v1/youtube/… endpoint instead. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn t… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_shorts_details",
"description": "YouTube Short metadata — same schema as Video Details, with isShort:true; long-form videos get HTTP 422. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID (≤3 min). Long-form videos return HTTP 422 — use the matching /v1/youtube/… endpoint instead. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Comments on a YouTube Short — rejects long-form videos (≤3 min only). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID (≤3 min). Long-form videos return HTTP 422 — use the matching /v1/youtube/… endpoint instead. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn t… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_shorts_comments",
"description": "Comments on a YouTube Short — rejects long-form videos (≤3 min only). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube Shorts URL, e.g. https://youtube.com/shorts/ID (≤3 min). Long-form videos return HTTP 422 — use the matching /v1/youtube/… endpoint instead. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Channel Shorts with cursor pagination — same row shape as channel-videos (exact publishedAt). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_channel_shorts",
"description": "Channel Shorts with cursor pagination — same row shape as channel-videos (exact publishedAt). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}YouTube Shorts recommendation sequence — fixed window per call (no cursor), not a global chart. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q | string | Optional topic seed for the Shorts recommendation sequence. Omit (or pass trending/shorts) for the default reel feed — not a keyword search. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 100). Returns a single window; use limit to size it. No cursor. Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_trending_shorts",
"description": "YouTube Shorts recommendation sequence — fixed window per call (no cursor), not a global chart. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"q": {
"type": "string",
"description": "Optional topic seed for the Shorts recommendation sequence. Omit (or pass trending/shorts) for the default reel feed — not a keyword search."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 100). Returns a single window; use limit to size it. No cursor. Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Channel Live tab only — liveStatus per row; 0 credits when hasLiveTab is false. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits when hasLiveTab is true; 0 credits when hasLiveTab is false. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_channel_streams",
"description": "Channel Live tab only — liveStatus per row; 0 credits when hasLiveTab is false. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits when hasLiveTab is true; 0 credits when hasLiveTab is false."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~10 credits (limit 10; 1/result). Videos from youtube.com/hashtag/{name} — nested channel{}, viewCountIsApproximate. Not keyword search. Costs ~10 credits (1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Hashtag with or without the # (min 2 characters). One token — spaces are 400 HASHTAG_HAS_SPACES. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 200). Returns a single window; use limit to size it. No cursor. Billed per result. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_hashtag_search",
"description": "Default ~10 credits (limit 10; 1/result). Videos from youtube.com/hashtag/{name} — nested channel{}, viewCountIsApproximate. Not keyword search. Costs ~10 credits (1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Hashtag with or without the # (min 2 characters). One token — spaces are 400 HASHTAG_HAS_SPACES."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 200). Returns a single window; use limit to size it. No cursor. Billed per result."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Replies under a top-level comment — parentReplyCount + cursor. Nested reply ids return 404. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| commentId * | string | ID of the parent (top-level) comment to fetch replies for — from the comments endpoint. Legacy alias: comment_id. |
{
"name": "youtube_comment_replies",
"description": "Replies under a top-level comment — parentReplyCount + cursor. Nested reply ids return 404. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url",
"commentId"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"commentId": {
"type": "string",
"description": "ID of the parent (top-level) comment to fetch replies for — from the comments endpoint. Legacy alias: comment_id."
}
},
"additionalProperties": false
}
}Channel playlists with cursor pagination — id, title, totalVideos, thumbnailUrl. Flat 2 credits/page. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_channel_playlists",
"description": "Channel playlists with cursor pagination — id, title, totalVideos, thumbnailUrl. Flat 2 credits/page. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Community posts — channel{}, publishedTimeApprox, likeCountIsApproximate, linkedVideos[], cursor (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 1 credit per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_community_posts",
"description": "Community posts — channel{}, publishedTimeApprox, likeCountIsApproximate, linkedVideos[], cursor (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "YouTube channel URL, @handle, bare handle, or UC... channel ID, e.g. https://youtube.com/@handle or @mkbhd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 1 credit per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}One community post — list schema + commentCount trio + isEdited. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | YouTube community post URL (/post/Ugkx… or /community?lb=). Trailing whitespace is stripped. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "youtube_community_post_details",
"description": "One community post — list schema + commentCount trio + isEdited. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "YouTube community post URL (/post/Ugkx… or /community?lb=). Trailing whitespace is stripped. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}SponsorBlock community segments — free while the CC BY-NC-SA commercial-use exception is pending. Costs 0 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| minVotes | integer | Minimum SponsorBlock votes to keep a segment. Default 0 (drops community-rejected votes < 0). |
| categories | string | Comma-separated categories. Default sponsor,selfpromo,interaction. Also intro,outro,preview,music_offtopic,poi_highlight,filler. |
{
"name": "youtube_video_sponsors",
"description": "SponsorBlock community segments — free while the CC BY-NC-SA commercial-use exception is pending. Costs 0 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public YouTube video URL, e.g. https://youtube.com/watch?v=ID. Not a TikTok/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"minVotes": {
"type": "integer",
"minimum": 1,
"description": "Minimum SponsorBlock votes to keep a segment. Default 0 (drops community-rejected votes < 0)."
},
"categories": {
"type": "string",
"description": "Comma-separated categories. Default sponsor,selfpromo,interaction. Also intro,outro,preview,music_offtopic,poi_highlight,filler."
}
},
"additionalProperties": false
}
}Transcript Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public TikTok video or photo-carousel URL, e.g. https://www.tiktok.com/@khaby.lame/video/7646812028874673439 or https://www.tiktok.com/@user/photo/ID (the url channel-posts returns for mediaType photo). Not a YouTube/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do no… |
| cache | boolean | Serve from the 24h shared cache when available (0 credits on hit). Default true — set false to always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. |
{
"name": "tiktok_transcript",
"description": "Transcript Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public TikTok video or photo-carousel URL, e.g. https://www.tiktok.com/@khaby.lame/video/7646812028874673439 or https://www.tiktok.com/@user/photo/ID (the url channel-posts returns for mediaType photo). Not a YouTube/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Serve from the 24h shared cache when available (0 credits on hit). Default true — set false to always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Preferred caption language as an ISO code, e.g. \"en\". Defaults to auto-detect."
}
},
"additionalProperties": false
}
}Summarizer Costs 4 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public TikTok video or photo-carousel URL, e.g. https://www.tiktok.com/@khaby.lame/video/7646812028874673439 or https://www.tiktok.com/@user/photo/ID (the url channel-posts returns for mediaType photo). Not a YouTube/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do no… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | ISO code, e.g. "tr": pins the speech language and sets the summary output language. Defaults to auto-detect + English summary. |
{
"name": "tiktok_summarize",
"description": "Summarizer Costs 4 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public TikTok video or photo-carousel URL, e.g. https://www.tiktok.com/@khaby.lame/video/7646812028874673439 or https://www.tiktok.com/@user/photo/ID (the url channel-posts returns for mediaType photo). Not a YouTube/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "ISO code, e.g. \"tr\": pins the speech language and sets the summary output language. Defaults to auto-detect + English summary."
}
},
"additionalProperties": false
}
}Get everything about one TikTok video from its URL — caption, view/like/comment/share/save counts, creator, sound, hashtags, and thumbnail. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public TikTok video or photo-carousel URL, e.g. https://www.tiktok.com/@khaby.lame/video/7646812028874673439 or https://www.tiktok.com/@user/photo/ID (the url channel-posts returns for mediaType photo). Not a YouTube/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do no… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_video_details",
"description": "Get everything about one TikTok video from its URL — caption, view/like/comment/share/save counts, creator, sound, hashtags, and thumbnail. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public TikTok video or photo-carousel URL, e.g. https://www.tiktok.com/@khaby.lame/video/7646812028874673439 or https://www.tiktok.com/@user/photo/ID (the url channel-posts returns for mediaType photo). Not a YouTube/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}TikTok comments — clean schema plus authorName, stable authorId/authorSecUid and commentLanguage for listening loops. Unresolvable videos are 404 at 0 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public TikTok video or photo-carousel URL, e.g. https://www.tiktok.com/@khaby.lame/video/7646812028874673439 or https://www.tiktok.com/@user/photo/ID (the url channel-posts returns for mediaType photo). Not a YouTube/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do no… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (a numeric offset, e.g. 50). A null nextCursor means the end of the comments. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_comments",
"description": "TikTok comments — clean schema plus authorName, stable authorId/authorSecUid and commentLanguage for listening loops. Unresolvable videos are 404 at 0 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public TikTok video or photo-carousel URL, e.g. https://www.tiktok.com/@khaby.lame/video/7646812028874673439 or https://www.tiktok.com/@user/photo/ID (the url channel-posts returns for mediaType photo). Not a YouTube/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (a numeric offset, e.g. 50). A null nextCursor means the end of the comments."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Resolve a TikTok @handle to id + secUid — createTime, ttSeller, bioLink, decoded privacy flags. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| raw | boolean | Set true to include TikTok's upstream user/statsV2 blob under raw, plus createTimeUnix (unix twin of createTime). Default false — curated fields only. |
| url * | string | TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "tiktok_channel_details",
"description": "Resolve a TikTok @handle to id + secUid — createTime, ttSeller, bioLink, decoded privacy flags. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"raw": {
"type": "boolean",
"description": "Set true to include TikTok's upstream user/statsV2 blob under raw, plus createTimeUnix (unix twin of createTime). Default false — curated fields only."
},
"url": {
"type": "string",
"description": "TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Find out where a TikTok creator is likely based and what language they use — country, language, stable ids, and core profile stats. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| raw | boolean | Set true to include TikTok's upstream user/statsV2 blob under raw. Default false — curated fields only. |
| url * | string | TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 7d response cache (0 credits on hit). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "tiktok_profile_region",
"description": "Find out where a TikTok creator is likely based and what language they use — country, language, stable ids, and core profile stats. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"raw": {
"type": "boolean",
"description": "Set true to include TikTok's upstream user/statsV2 blob under raw. Default false — curated fields only."
},
"url": {
"type": "string",
"description": "TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 7d response cache (0 credits on hit). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Audience country + language mix for a TikTok creator — engagement sample, not a follower census. Costs 3 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| videos | integer | How many recent videos to sample comments from: 12 (default, 3 credits), 30 (5 credits), or 60 (8 credits). |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| countriesLimit | integer | Max countries in audienceLocations; remainder folds into other{count,percentage}. Omit for the full list (other is omitted when unused). |
{
"name": "tiktok_audience_demographics",
"description": "Audience country + language mix for a TikTok creator — engagement sample, not a follower census. Costs 3 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"videos": {
"type": "integer",
"minimum": 1,
"description": "How many recent videos to sample comments from: 12 (default, 3 credits), 30 (5 credits), or 60 (8 credits)."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"countriesLimit": {
"type": "integer",
"minimum": 1,
"description": "Max countries in audienceLocations; remainder folds into other{count,percentage}. Omit for the full list (other is omitted when unused)."
}
},
"additionalProperties": false
}
}Get the autocomplete terms TikTok suggests in its search bar for a keyword — the real phrases people search, ranked, so you can find trending queries and long-tail keyword ideas. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Seed keyword to expand into autocomplete suggestions, e.g. skincare. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 100). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country code that localizes the suggestions to a market, e.g. US, GB, DE. Default US. |
| language | string | Interface language for the suggestions, e.g. en-US or de-DE. Default en-US. |
{
"name": "tiktok_search_suggestions",
"description": "Get the autocomplete terms TikTok suggests in its search bar for a keyword — the real phrases people search, ranked, so you can find trending queries and long-tail keyword ideas. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Seed keyword to expand into autocomplete suggestions, e.g. skincare."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 100). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country code that localizes the suggestions to a market, e.g. US, GB, DE. Default US."
},
"language": {
"type": "string",
"description": "Interface language for the suggestions, e.g. en-US or de-DE. Default en-US."
}
},
"additionalProperties": false
}
}Latest videos from a TikTok profile, cursor-paginated, with isPinned, caption mention text and brand signals (promoCodes, brandMentions). Flat 2 credits; failures are 0 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | How many of the creator's latest videos to return on this page (default 20, max 200). Newest first. Flat 2 credits per successful call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (TikTok's max_cursor timestamp, e.g. 1783614676000). A null nextCursor means the end of the list. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_channel_posts",
"description": "Latest videos from a TikTok profile, cursor-paginated, with isPinned, caption mention text and brand signals (promoCodes, brandMentions). Flat 2 credits; failures are 0 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "How many of the creator's latest videos to return on this page (default 20, max 200). Newest first. Flat 2 credits per successful call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (TikTok's max_cursor timestamp, e.g. 1783614676000). A null nextCursor means the end of the list."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Replies under a TikTok comment — same authorId/authorSecUid/commentLanguage shape as comments. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public TikTok video or photo-carousel URL, e.g. https://www.tiktok.com/@khaby.lame/video/7646812028874673439 or https://www.tiktok.com/@user/photo/ID (the url channel-posts returns for mediaType photo). Not a YouTube/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do no… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value from the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| commentId * | string | ID of the parent (top-level) comment to fetch replies for — from the comments endpoint. Legacy alias: comment_id. |
{
"name": "tiktok_comment_replies",
"description": "Replies under a TikTok comment — same authorId/authorSecUid/commentLanguage shape as comments. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url",
"commentId"
],
"properties": {
"url": {
"type": "string",
"description": "Public TikTok video or photo-carousel URL, e.g. https://www.tiktok.com/@khaby.lame/video/7646812028874673439 or https://www.tiktok.com/@user/photo/ID (the url channel-posts returns for mediaType photo). Not a YouTube/Instagram/Facebook URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value from the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"commentId": {
"type": "string",
"description": "ID of the parent (top-level) comment to fetch replies for — from the comments endpoint. Legacy alias: comment_id."
}
},
"additionalProperties": false
}
}List a TikTok user's followers — id, secUid, createTime, region, language, cursor pagination. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 1 credit per call. |
| cursor | string | Pagination cursor (TikTok minCursor). Leave empty for the first page; then pass nextCursor from the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_user_followers",
"description": "List a TikTok user's followers — id, secUid, createTime, region, language, cursor pagination. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 1 credit per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor (TikTok minCursor). Leave empty for the first page; then pass nextCursor from the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}List who a TikTok user follows — id, secUid, createTime, region, language, cursor pagination. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 1 credit per call. |
| cursor | string | Pagination cursor (TikTok minCursor). Leave empty for the first page; then pass nextCursor from the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_user_followings",
"description": "List who a TikTok user follows — id, secUid, createTime, region, language, cursor pagination. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 1 credit per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor (TikTok minCursor). Leave empty for the first page; then pass nextCursor from the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}List TikTok videos that use a specific sound — caption, author, exact engagement, canonical hashtags, and mentions, with cursor pagination. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok music/sound URL, e.g. https://tiktok.com/music/name-ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Most videos to return (default 20, 1–50; outside that range is a 400). TikTok serves this feed in short pages, so a call can return fewer than limit with a nextCursor to continue. Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. hasMore is true only when nextCursor is present. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_music_posts",
"description": "List TikTok videos that use a specific sound — caption, author, exact engagement, canonical hashtags, and mentions, with cursor pagination. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok music/sound URL, e.g. https://tiktok.com/music/name-ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Most videos to return (default 20, 1–50; outside that range is a 400). TikTok serves this feed in short pages, so a call can return fewer than limit with a nextCursor to continue. Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. hasMore is true only when nextCursor is present."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}TikTok Top/General search — videos and photo carousels when TikTok includes them, with contentType + images[]. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Search query or keywords (min 2 characters). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. |
| cursor | integer | Pagination cursor. Leave 0 for the first page; then pass nextCursor from the previous response. TikTok may return duplicates across pages. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_top_search",
"description": "TikTok Top/General search — videos and photo carousels when TikTok includes them, with contentType + images[]. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Search query or keywords (min 2 characters)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call."
},
"cursor": {
"type": "integer",
"minimum": 1,
"description": "Pagination cursor. Leave 0 for the first page; then pass nextCursor from the previous response. TikTok may return duplicates across pages."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~7 credits (limit 10; 0.7/result). Videos from TikTok's /tag/{name} challenge feed — not keyword or username search. Cursor + hasMore. Costs ~7 credits (0.7/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Single hashtag token for the /tag/{name} challenge feed, with or without # (min 2). Spaces are 400 — use /v1/tiktok/top-search for a keyword query. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 100). Billed per result. |
| cursor | integer | Pagination offset. Leave at 0 (or omit) for the first page; then pass the nextCursor value returned in the previous response. A null nextCursor means the end of the results. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| region | string | Two-letter ISO 3166-1 country code. Default US. Accepted for compatibility; does not filter results by country. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_search_by_hashtag",
"description": "Default ~7 credits (limit 10; 0.7/result). Videos from TikTok's /tag/{name} challenge feed — not keyword or username search. Cursor + hasMore. Costs ~7 credits (0.7/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Single hashtag token for the /tag/{name} challenge feed, with or without # (min 2). Spaces are 400 — use /v1/tiktok/top-search for a keyword query."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 100). Billed per result."
},
"cursor": {
"type": "integer",
"minimum": 1,
"description": "Pagination offset. Leave at 0 (or omit) for the first page; then pass the nextCursor value returned in the previous response. A null nextCursor means the end of the results."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"region": {
"type": "string",
"description": "Two-letter ISO 3166-1 country code. Default US. Accepted for compatibility; does not filter results by country."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Find TikTok creators by keyword — distinct authors ranking for the query, id + secUid, per-counter isApproximate flags, cursor pagination. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Search query matched against usernames, display names and bios (min 2 characters). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 100). Flat 1 credit per call. |
| cursor | string | Pagination cursor. Omit (or pass 0) for the first page; then pass the nextCursor value from the previous response verbatim — it carries the search session, not just an offset. A null nextCursor means the end of the results. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_search_users",
"description": "Find TikTok creators by keyword — distinct authors ranking for the query, id + secUid, per-counter isApproximate flags, cursor pagination. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Search query matched against usernames, display names and bios (min 2 characters)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 100). Flat 1 credit per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Omit (or pass 0) for the first page; then pass the nextCursor value from the previous response verbatim — it carries the search session, not just an offset. A null nextCursor means the end of the results."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}TikTok sound metadata — usageCount, artists[{id,secUid,handle}], audio{bpm,loudness,beats}, commerce rights (1 credit; 2 via the fallback path). Costs 1 credit (2 via fallback path). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok music/sound URL, e.g. https://tiktok.com/music/name-ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_song_details",
"description": "TikTok sound metadata — usageCount, artists[{id,secUid,handle}], audio{bpm,loudness,beats}, commerce rights (1 credit; 2 via the fallback path). Costs 1 credit (2 via fallback path). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok music/sound URL, e.g. https://tiktok.com/music/name-ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}For You by default; pass orderBy/period/page for Creative Center popular videos (like/hot/comment/repost) with totalCount. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| page | integer | Creative Center page (default 1). page>1 triggers chart mode. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| period | integer | Lookback days: 7, 30, or 120 (180→120). Triggers chart mode. Every returned publishedAt is inside this window — a For You fallthrough is filtered the same way. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country (default US). For You: region-availability hint. Creative Center mode: chart market. |
| orderBy | string | Creative Center sort: hot (views), like, comment, or repost. Unknown values are 400. vv/views/plays are aliases of hot — the response echoes the public name. Setting this (or period / page>1) switches from For You to the popular-videos chart. On a For You fallthrough the same sort is applied locally… |
| countryCode | string | Alias of country. Wins when both are set. |
{
"name": "tiktok_trending_feed",
"description": "For You by default; pass orderBy/period/page for Creative Center popular videos (like/hot/comment/repost) with totalCount. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": 1,
"description": "Creative Center page (default 1). page>1 triggers chart mode."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"period": {
"type": "integer",
"minimum": 1,
"description": "Lookback days: 7, 30, or 120 (180→120). Triggers chart mode. Every returned publishedAt is inside this window — a For You fallthrough is filtered the same way."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country (default US). For You: region-availability hint. Creative Center mode: chart market."
},
"orderBy": {
"type": "string",
"description": "Creative Center sort: hot (views), like, comment, or repost. Unknown values are 400. vv/views/plays are aliases of hot — the response echoes the public name. Setting this (or period / page>1) switches from For You to the popular-videos chart. On a For You fallthrough the same sort is applied locally."
},
"countryCode": {
"type": "string",
"description": "Alias of country. Wins when both are set."
}
},
"additionalProperties": false
}
}Related TikTok hashtags — Creative Center chart when it answers (asOf = the chart's data date, stale when over 3 days old), otherwise a disclosed niche fallback. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| page | integer | Creative Center page (default 1). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 100). Flat 2 credits per call. |
| query | string | Optional niche seed for co-occurrence + challenge/detail enrich. Omit, or pass trending, to try the Creative Center chart (10s cap); a miss falls through to related tags for fyp (source=niche_fallback) and opens a chart circuit for that country/period/page/industry. Later calls with the same chart p… |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| period | integer | Lookback days: 7, 30, or 120 (180→120). Default 7. |
| sortBy | string | Chart sort: popular (default). |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country for the Creative Center chart. Default US. |
| industryId | string | Optional Creative Center industry_id. |
| newOnBoard | boolean | Only hashtags newly on the Top 100. |
{
"name": "tiktok_popular_hashtags",
"description": "Related TikTok hashtags — Creative Center chart when it answers (asOf = the chart's data date, stale when over 3 days old), otherwise a disclosed niche fallback. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": 1,
"description": "Creative Center page (default 1)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 100). Flat 2 credits per call."
},
"query": {
"type": "string",
"description": "Optional niche seed for co-occurrence + challenge/detail enrich. Omit, or pass trending, to try the Creative Center chart (10s cap); a miss falls through to related tags for fyp (source=niche_fallback) and opens a chart circuit for that country/period/page/industry. Later calls with the same chart parameters skip the chart (chartStatus=skipped_circuit_open) until the cooldown expires. Any other value skips the chart."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"period": {
"type": "integer",
"minimum": 1,
"description": "Lookback days: 7, 30, or 120 (180→120). Default 7."
},
"sortBy": {
"type": "string",
"description": "Chart sort: popular (default)."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country for the Creative Center chart. Default US."
},
"industryId": {
"type": "string",
"description": "Optional Creative Center industry_id."
},
"newOnBoard": {
"type": "boolean",
"description": "Only hashtags newly on the Top 100."
}
},
"additionalProperties": false
}
}Check whether a TikTok creator is live right now and get the stream URLs (CMAF/DASH + FLV, HLS when TikTok exposes it) — one GET with an @handle, 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_live",
"description": "Check whether a TikTok creator is live right now and get the stream URLs (CMAF/DASH + FLV, HLS when TikTok exposes it) — one GET with an @handle, 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Identical to TikTok Live (isLive, creator.id/secUid, streamQualities hls/cmaf). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_live_info",
"description": "Identical to TikTok Live (isLive, creator.id/secUid, streamQualities hls/cmaf). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok profile URL, @handle, or username, e.g. https://tiktok.com/@username. Not a YouTube channel URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Creative Center creators + createTime / bioLinkRisk / ttSeller hydrate for partnership vetting. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| page | integer | Creative Center page (default 1). |
| sort | string | follower, engagement, or popularity. Default follower. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| limit | integer | Max items to return (default 20, max 100). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country code. Default US. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
| follower_count | string | Optional range on the For You ranking: 10k-100k, 100k-1m, 1m-10m, >10m. |
{
"name": "tiktok_popular_creators",
"description": "Creative Center creators + createTime / bioLinkRisk / ttSeller hydrate for partnership vetting. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": 1,
"description": "Creative Center page (default 1)."
},
"sort": {
"type": "string",
"description": "follower, engagement, or popularity. Default follower."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 100). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country code. Default US."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
},
"follower_count": {
"type": "string",
"description": "Optional range on the For You ranking: 10k-100k, 100k-1m, 1m-10m, >10m."
}
},
"additionalProperties": false
}
}Turn any Instagram Reel's speech into text — the full transcript plus timestamped segments, ready for search, subtitles, or AI pipelines. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Instagram Reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. |
{
"name": "instagram_transcript",
"description": "Turn any Instagram Reel's speech into text — the full transcript plus timestamped segments, ready for search, subtitles, or AI pipelines. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Instagram Reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Preferred caption language as an ISO code, e.g. \"en\". Defaults to auto-detect."
}
},
"additionalProperties": false
}
}Get an AI summary of any Instagram Reel — a short paragraph plus key points, without watching the video. Costs 4 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Instagram Reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | ISO code, e.g. "tr": pins the speech language and sets the summary output language. Defaults to auto-detect + English summary. |
{
"name": "instagram_summarize",
"description": "Get an AI summary of any Instagram Reel — a short paragraph plus key points, without watching the video. Costs 4 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Instagram Reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "ISO code, e.g. \"tr\": pins the speech language and sets the summary output language. Defaults to auto-detect + English summary."
}
},
"additionalProperties": false
}
}Get an Instagram post, Reel or carousel — caption, publish date, likes, comments, views, media URLs, author, per-slide children, and promo codes / disclosure words from the caption. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Instagram post or reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "instagram_details",
"description": "Get an Instagram post, Reel or carousel — caption, publish date, likes, comments, views, media URLs, author, per-slide children, and promo codes / disclosure words from the caption. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Instagram post or reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~9 credits (limit 10; 0.9/result). Session-paged Instagram comments — a logged-out 2-row preview of a larger thread is 503 SESSION_UNAVAILABLE at 0 credits. Costs ~9 credits (0.9/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Instagram post or reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| sort | string | Comment order: popular (Instagram's ranking, the default when omitted) or recent (newest first). recent is served by one fetch path only, so it fails over less. The order is kept in nextCursor — pass the same sort on every page; a different one is 400. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 500). Billed per result. |
| cursor | string | Pagination cursor from the previous nextCursor ({mediaPk}:{minId}). Omit on the first page. hasMore is true when nextCursor is set, or when more exist and cannot be paged (nextCursor null + truncatedReason). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| minLength | integer | Leave out comments shorter than this many characters (1–500; e.g. 3 drops single emojis). Billed on the comments returned. |
{
"name": "instagram_comments",
"description": "Default ~9 credits (limit 10; 0.9/result). Session-paged Instagram comments — a logged-out 2-row preview of a larger thread is 503 SESSION_UNAVAILABLE at 0 credits. Costs ~9 credits (0.9/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Instagram post or reel URL, e.g. https://instagram.com/reel/ID/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"sort": {
"type": "string",
"description": "Comment order: popular (Instagram's ranking, the default when omitted) or recent (newest first). recent is served by one fetch path only, so it fails over less. The order is kept in nextCursor — pass the same sort on every page; a different one is 400."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 500). Billed per result."
},
"cursor": {
"type": "string",
"description": "Pagination cursor from the previous nextCursor ({mediaPk}:{minId}). Omit on the first page. hasMore is true when nextCursor is set, or when more exist and cannot be paged (nextCursor null + truncatedReason)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"minLength": {
"type": "integer",
"minimum": 1,
"description": "Leave out comments shorter than this many characters (1–500; e.g. 3 drops single emojis). Billed on the comments returned."
}
},
"additionalProperties": false
}
}Instagram profile stats — fixed key set (null fillers), fbid, bioLinks, isBusinessAccount, approx flags. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Instagram profile URL, @handle, or username, e.g. https://instagram.com/username/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "instagram_channel_details",
"description": "Instagram profile stats — fixed key set (null fillers), fbid, bioLinks, isBusinessAccount, approx flags. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Instagram profile URL, @handle, or username, e.g. https://instagram.com/username/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Default ~3 credits (limit 10; 0.3/result). Latest posts from a public Instagram profile — carousel children[], mediaCount, isPinned, caption promo codes, user{} in one call. Costs ~3 credits (0.3/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Instagram profile URL, @handle, or username, e.g. https://instagram.com/username/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 200). Billed per result. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (e.g. 3937014945555313553_1697296). A null nextCursor means the end of the list. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "instagram_channel_posts",
"description": "Default ~3 credits (limit 10; 0.3/result). Latest posts from a public Instagram profile — carousel children[], mediaCount, isPinned, caption promo codes, user{} in one call. Costs ~3 credits (0.3/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Instagram profile URL, @handle, or username, e.g. https://instagram.com/username/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 200). Billed per result."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (e.g. 3937014945555313553_1697296). A null nextCursor means the end of the list."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~3 credits (limit 10; 0.3/result). Latest Reels from a public Instagram profile — isPinned, optional since date filter, pass userId to skip resolve; ceil(n×0.3) credits; nextCursor + hasMore. Costs ~3 credits (0.3/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url | string | Instagram profile URL, @handle, or username. Omit when userId is set. The URL platform must match this endpoint's platform. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 200). Billed per result. |
| since | string | Only Reels published on or after this ISO date or datetime (e.g. 2026-10-01 or 2026-10-01T00:00:00Z; no offset means UTC). Pinned Reels older than since are left out without ending the list; once a page reaches an older non-pinned Reel, hasMore is false. Reels with no known date are left out. Billed… |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass nextCursor from the previous response (clips:{userId}:{opaque} on the native Reels path, or legacy {mediaId}_{userId}). Stop when hasMore is false. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| userId | string | Instagram numeric user ID (e.g. 173560420). Skips handle→ID resolve (legacy sequential WPI alone could cost ~80s). Prefer when you already have the ID from basic-profile or profile-search. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "instagram_channel_reels",
"description": "Default ~3 credits (limit 10; 0.3/result). Latest Reels from a public Instagram profile — isPinned, optional since date filter, pass userId to skip resolve; ceil(n×0.3) credits; nextCursor + hasMore. Costs ~3 credits (0.3/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Instagram profile URL, @handle, or username. Omit when userId is set. The URL platform must match this endpoint's platform."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 200). Billed per result."
},
"since": {
"type": "string",
"description": "Only Reels published on or after this ISO date or datetime (e.g. 2026-10-01 or 2026-10-01T00:00:00Z; no offset means UTC). Pinned Reels older than since are left out without ending the list; once a page reaches an older non-pinned Reel, hasMore is false. Reels with no known date are left out. Billed on the returned Reels."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass nextCursor from the previous response (clips:{userId}:{opaque} on the native Reels path, or legacy {mediaId}_{userId}). Stop when hasMore is false."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"userId": {
"type": "string",
"description": "Instagram numeric user ID (e.g. 173560420). Skips handle→ID resolve (legacy sequential WPI alone could cost ~80s). Prefer when you already have the ID from basic-profile or profile-search."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Native tag feed first, slower fallback paths on a miss. Max 50. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Hashtag without the # (min 2 characters). One token — spaces are 400 HASHTAG_HAS_SPACES. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 50). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| datePosted | string | last_24_hours | last_week | last_month | last_year (aliases: today, this_week, this_month, this_year). |
{
"name": "instagram_reels_search",
"description": "Native tag feed first, slower fallback paths on a miss. Max 50. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Hashtag without the # (min 2 characters). One token — spaces are 400 HASHTAG_HAS_SPACES."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 50). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"datePosted": {
"type": "string",
"description": "last_24_hours | last_week | last_month | last_year (aliases: today, this_week, this_month, this_year)."
}
},
"additionalProperties": false
}
}Cache-first trending Reels. Feed outage → labelled country hashtag-clips stand-in (listing field), never a silent swap. Max 50. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Successful calls bill even on cache hits.
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Default true (cache-first): serve the per-country response cache when present (TTL 4 hours). Every successful call costs 2 credits — including cache hits. Set false to force a live scrape (measured miss 45–75s, hard-capped at 110s). Raise client timeouts above 90s — n8n/Make defaults will fail a mis… |
| limit | integer | Max items to return (default 10, max 50). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Country for Reels localization — full name or ISO code (e.g. 'United States', 'US', 'Turkey', 'TR'). Default United States. Unsupported values return 400 with supportedCountries[]. |
{
"name": "instagram_trending_reels",
"description": "Cache-first trending Reels. Feed outage → labelled country hashtag-clips stand-in (listing field), never a silent swap. Max 50. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Successful calls bill even on cache hits.",
"inputSchema": {
"type": "object",
"properties": {
"cache": {
"type": "boolean",
"description": "Default true (cache-first): serve the per-country response cache when present (TTL 4 hours). Every successful call costs 2 credits — including cache hits. Set false to force a live scrape (measured miss 45–75s, hard-capped at 110s). Raise client timeouts above 90s — n8n/Make defaults will fail a miss. The fresh result still refreshes the cache."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 50). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Country for Reels localization — full name or ISO code (e.g. 'United States', 'US', 'Turkey', 'TR'). Default United States. Unsupported values return 400 with supportedCountries[]."
}
},
"additionalProperties": false
}
}Posts that tag an Instagram account — author verified/avatar when available, staleFeed when Instagram only exposes an archive. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Instagram profile URL, @handle, or username, e.g. https://instagram.com/username/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 1 credit per call. |
| cursor | string | Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "instagram_tagged_posts",
"description": "Posts that tag an Instagram account — author verified/avatar when available, staleFeed when Instagram only exposes an archive. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Instagram profile URL, @handle, or username, e.g. https://instagram.com/username/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 1 credit per call."
},
"cursor": {
"type": "string",
"description": "Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~14 credits (limit 10; 1.4/result). Is this Instagram sound trending? Reels that use it + isTrendingInClips / trendRank / rich music{}. Costs ~14 credits (1.4/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 200). Billed per result. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| audioId * | string | Instagram audio/music ID or full audio URL, e.g. 27919946310946207. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "instagram_reels_by_audio_id",
"description": "Default ~14 credits (limit 10; 1.4/result). Is this Instagram sound trending? Reels that use it + isTrendingInClips / trendRank / rich music{}. Costs ~14 credits (1.4/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"audioId"
],
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 200). Billed per result."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"audioId": {
"type": "string",
"description": "Instagram audio/music ID or full audio URL, e.g. 27919946310946207."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Hashtag Explore: native grid first, fallback path only on miss. Max 50. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Hashtag without the # (min 2 characters). One token — spaces are 400 HASHTAG_HAS_SPACES. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 50). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| mediaType | string | all (default) or reels — return only Reels/clips when set to reels. |
{
"name": "instagram_hashtag_search",
"description": "Hashtag Explore: native grid first, fallback path only on miss. Max 50. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Hashtag without the # (min 2 characters). One token — spaces are 400 HASHTAG_HAS_SPACES."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 50). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"mediaType": {
"type": "string",
"description": "all (default) or reels — return only Reels/clips when set to reels."
}
},
"additionalProperties": false
}
}Resolve a brand or @handle to one public Instagram profile — or search accounts by free text (mode=search). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Account name, @handle, or profile URL to resolve (min 2 characters). A leading _, accents (misión → mision), spaces and URL query strings (?igsh=…) are stripped. A q with no usable username characters is 400 BAD_REQUEST. Not a niche keyword search. |
| cache | boolean | Serve from the 24h shared cache when available (0 credits on hit). Default true — set false to always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "instagram_profile_search",
"description": "Resolve a brand or @handle to one public Instagram profile — or search accounts by free text (mode=search). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Account name, @handle, or profile URL to resolve (min 2 characters). A leading _, accents (misión → mision), spaces and URL query strings (?igsh=…) are stripped. A q with no usable username characters is 400 BAD_REQUEST. Not a niche keyword search."
},
"cache": {
"type": "boolean",
"description": "Serve from the 24h shared cache when available (0 credits on hit). Default true — set false to always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Classic Instagram embed snippet — blockquote.instagram-media + embed.js. Drop html into your page. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Instagram post, reel, or profile URL (or @handle), e.g. https://instagram.com/reel/ID/ or https://instagram.com/username/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumb… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "instagram_embed",
"description": "Classic Instagram embed snippet — blockquote.instagram-media + embed.js. Drop html into your page. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Instagram post, reel, or profile URL (or @handle), e.g. https://instagram.com/reel/ID/ or https://instagram.com/username/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Persistent Story Highlight albums for a public profile — id, title, cover, owner. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url | string | Instagram profile URL, @handle, or username. Omit when userId is set. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| userId | string | Numeric Instagram user ID. Prefer when known — skips handle→ID resolve. When only userId is set we reverse-resolve the username so the WPI / profile-HTML shelf can still run. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "instagram_highlights",
"description": "Persistent Story Highlight albums for a public profile — id, title, cover, owner. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Instagram profile URL, @handle, or username. Omit when userId is set."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"userId": {
"type": "string",
"description": "Numeric Instagram user ID. Prefer when known — skips handle→ID resolve. When only userId is set we reverse-resolve the username so the WPI / profile-HTML shelf can still run."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Items inside one Instagram Story Highlight album — media URLs, type, takenAt. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| id * | string | Highlight id from /v1/instagram/highlights (with or without highlight: prefix). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "instagram_highlights_details",
"description": "Items inside one Instagram Story Highlight album — media URLs, type, takenAt. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Highlight id from /v1/instagram/highlights (with or without highlight: prefix)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Instagram profile by user ID or @handle — camelCase schema aligned with Channel Details (followers, externalUrl, businessAddress). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| userId * | string | Instagram numeric pk (e.g. 13460080 — the id field on this endpoint), or a profile URL / @handle / username. A Facebook/Graph fbid (17-digit 17841…) is 400 WRONG_ID_TYPE. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "instagram_basic_profile",
"description": "Instagram profile by user ID or @handle — camelCase schema aligned with Channel Details (followers, externalUrl, businessAddress). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"userId"
],
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"userId": {
"type": "string",
"description": "Instagram numeric pk (e.g. 13460080 — the id field on this endpoint), or a profile URL / @handle / username. A Facebook/Graph fbid (17-digit 17841…) is 400 WRONG_ID_TYPE."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Facebook post or Reel — caption, engagement + engagementAvailable, author id, video{} playback, and music when Facebook exposes them. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public Facebook video or post URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_details",
"description": "Facebook post or Reel — caption, engagement + engagementAvailable, author id, video{} playback, and music when Facebook exposes them. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public Facebook video or post URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Summarizer Costs 4 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public Facebook video or post URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_summarize",
"description": "Summarizer Costs 4 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public Facebook video or post URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Facebook post comments with reactionCount, reactions.like when mixed, author.id (pfbid), and replyCount. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url | string | Facebook post or Reel URL. Omit when feedbackId is set. The URL platform must match this endpoint's platform. A page/profile URL also works: Facebook renders the page's most recent post first, so you get that post's comments (each comment's url names the actual post). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| feedbackId | string | Post feedback id from /v1/facebook/details (base64 feedback:POSTID). Prefer when you already have it — also accepts feedback_id. |
{
"name": "facebook_comments",
"description": "Facebook post comments with reactionCount, reactions.like when mixed, author.id (pfbid), and replyCount. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Facebook post or Reel URL. Omit when feedbackId is set. The URL platform must match this endpoint's platform. A page/profile URL also works: Facebook renders the page's most recent post first, so you get that post's comments (each comment's url names the actual post)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"feedbackId": {
"type": "string",
"description": "Post feedback id from /v1/facebook/details (base64 feedback:POSTID). Prefer when you already have it — also accepts feedback_id."
}
},
"additionalProperties": false
}
}Facebook page profile — likes vs followers (distinct), talkingAbout, category, website, and public email. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Facebook page URL, @handle, or page name, e.g. https://facebook.com/PageName. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_page_details",
"description": "Facebook page profile — likes vs followers (distinct), talkingAbout, category, website, and public email. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Facebook page URL, @handle, or page name, e.g. https://facebook.com/PageName. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Latest posts and Reels from a Facebook page — likes, comments, views, shares + engagementAvailable; 60s deadline, failures 0 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Facebook profile/page URL, @handle, or page name. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 4, max 4). The logged-out listing hop is ~23–29s typical, hard-capped at 40s. Each hydrate is typically 6–10s (can be ~100ms when listing already carried the post) and is capped at 12s. The next-item fit check uses that 12s cap, not the typical 6–10s, so a call cannot ex… |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_profile_posts",
"description": "Latest posts and Reels from a Facebook page — likes, comments, views, shares + engagementAvailable; 60s deadline, failures 0 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Facebook profile/page URL, @handle, or page name. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 4, max 4). The logged-out listing hop is ~23–29s typical, hard-capped at 40s. Each hydrate is typically 6–10s (can be ~100ms when listing already carried the post) and is capped at 12s. The next-item fit check uses that 12s cap, not the typical 6–10s, so a call cannot exceed 60s. The loop stops when the next item would miss the 60s deadline and returns what it has (truncatedReason=hydrate-budget | deadline). Asking for 20 cannot return 20 inside that ceiling. Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Latest Facebook page Reels — views (grid play count fallback), likes, comments, shares + engagementAvailable; newest-first. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Facebook profile/page URL, @handle, or page name. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_profile_reels",
"description": "Latest Facebook page Reels — views (grid play count fallback), likes, comments, shares + engagementAvailable; newest-first. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Facebook profile/page URL, @handle, or page name. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~10 credits (limit 10; 1/result). Newest posts from a public Facebook group — caption, author, engagement, sortBy; 1 credit per post. Costs ~10 credits (1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public Facebook group URL, e.g. https://facebook.com/groups/ID. Must contain /groups/ — profile/page URLs are a definitive 400 (use /v1/facebook/profile-posts for those). The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Faceb… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max posts to return (default 10, max 200; up to 80 per call — above that you get 80 with truncatedReason per-call-cap). Billed 1 credit per returned post, minimum 2. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| sortBy | string | TOP_POSTS | RECENT_ACTIVITY | CHRONOLOGICAL (default) | CHRONOLOGICAL_LISTINGS. Maps to Facebook sorting_setting. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_group_posts",
"description": "Default ~10 credits (limit 10; 1/result). Newest posts from a public Facebook group — caption, author, engagement, sortBy; 1 credit per post. Costs ~10 credits (1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public Facebook group URL, e.g. https://facebook.com/groups/ID. Must contain /groups/ — profile/page URLs are a definitive 400 (use /v1/facebook/profile-posts for those). The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max posts to return (default 10, max 200; up to 80 per call — above that you get 80 with truncatedReason per-call-cap). Billed 1 credit per returned post, minimum 2."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"sortBy": {
"type": "string",
"description": "TOP_POSTS | RECENT_ACTIVITY | CHRONOLOGICAL (default) | CHRONOLOGICAL_LISTINGS. Maps to Facebook sorting_setting."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Comment Replies Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Facebook post URL the comment belongs to. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| commentId * | string | ID of the parent (top-level) comment to fetch replies for — from the comments endpoint. Legacy alias: comment_id. |
{
"name": "facebook_comment_replies",
"description": "Comment Replies Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url",
"commentId"
],
"properties": {
"url": {
"type": "string",
"description": "Facebook post URL the comment belongs to. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"commentId": {
"type": "string",
"description": "ID of the parent (top-level) comment to fetch replies for — from the comments endpoint. Legacy alias: comment_id."
}
},
"additionalProperties": false
}
}Photo grid from a Facebook Page — full image URL plus accessibilityCaption (alt-text, not a post caption). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Facebook profile/page URL, @handle, or page name. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). The public /photos grid is a single SSR batch (often ~8) — retrievableCount is that batch, not a promise Facebook will fill limit. Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_profile_photos",
"description": "Photo grid from a Facebook Page — full image URL plus accessibilityCaption (alt-text, not a post caption). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Facebook profile/page URL, @handle, or page name. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). The public /photos grid is a single SSR batch (often ~8) — retrievableCount is that batch, not a promise Facebook will fill limit. Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}One tweet as JSON — text, author (followers), likes/replies/retweets/quotes, media, ISO publishedAt. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public tweet URL, e.g. https://x.com/user/status/ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "twitter_tweet_details",
"description": "One tweet as JSON — text, author (followers), likes/replies/retweets/quotes, media, ISO publishedAt. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public tweet URL, e.g. https://x.com/user/status/ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Tweet text as a transcript — timingSource none (not speech-to-text). Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public tweet URL, e.g. https://x.com/user/status/ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "twitter_transcript",
"description": "Tweet text as a transcript — timingSource none (not speech-to-text). Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public tweet URL, e.g. https://x.com/user/status/ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}X profile: verified + blue/legacy/identity, displayName, avatar/banner, tipjar→contact{}, expanded website. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Twitter/X profile URL or @handle, e.g. https://x.com/username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to use the 24-hour profile cache (0 credits on hit). Default false — always fetch fresh. Prefer cacheMaxAge for 1d–30d. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "twitter_profile",
"description": "X profile: verified + blue/legacy/identity, displayName, avatar/banner, tipjar→contact{}, expanded website. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Twitter/X profile URL or @handle, e.g. https://x.com/username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to use the 24-hour profile cache (0 credits on hit). Default false — always fetch fresh. Prefer cacheMaxAge for 1d–30d."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Most popular public tweets from a Twitter/X profile (~100 cap) — not chronological. Text, author, engagement, hashtags, media. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Twitter/X profile URL or @handle. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max tweets to return (default 20, max 200). Twitter's public surface usually caps around ~100 most popular posts — not chronological latest. Flat 2 credits per call. |
| cursor | string | nextCursor from a previous response (an offset into the embed window). Omit for the first page. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "twitter_user_tweets",
"description": "Most popular public tweets from a Twitter/X profile (~100 cap) — not chronological. Text, author, engagement, hashtags, media. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Twitter/X profile URL or @handle. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max tweets to return (default 20, max 200). Twitter's public surface usually caps around ~100 most popular posts — not chronological latest. Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "nextCursor from a previous response (an offset into the embed window). Omit for the first page."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}X Community metadata — ISO createdAt, flat creator handle, isNsfw + bannerImage, rules[]. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | X community URL (x.com/i/communities/ID) or community ID — not a tweet/status URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "twitter_community",
"description": "X Community metadata — ISO createdAt, flat creator handle, isNsfw + bannerImage, rules[]. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "X community URL (x.com/i/communities/ID) or community ID — not a tweet/status URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Posts in an X Community — same 6-metric tweet shape as search. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | X community URL (x.com/i/communities/ID) or community ID — not a tweet/status URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 25, max 200). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "twitter_community_tweets",
"description": "Posts in an X Community — same 6-metric tweet shape as search. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "X community URL (x.com/i/communities/ID) or community ID — not a tweet/status URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 25, max 200). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}List posts from a subreddit with sort, timeframe, and cursor pagination — title, score, upvote ratio, flair, and more. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Subreddit URL, r/name, or bare name, e.g. r/technology. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| sort | string | Feed sort: best, hot, new (default), top, or rising. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 25, max 200). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| timeframe | string | For sort=top: hour, day (default), week, month, year, or all. |
{
"name": "reddit_subreddit_posts",
"description": "List posts from a subreddit with sort, timeframe, and cursor pagination — title, score, upvote ratio, flair, and more. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Subreddit URL, r/name, or bare name, e.g. r/technology. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"sort": {
"type": "string",
"description": "Feed sort: best, hot, new (default), top, or rising."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 25, max 200). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"timeframe": {
"type": "string",
"description": "For sort=top: hour, day (default), week, month, year, or all."
}
},
"additionalProperties": false
}
}Get a Reddit post — title, body, score, comments count, subreddit, and author as structured JSON. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Reddit post URL, e.g. https://reddit.com/r/sub/comments/ID/... The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "reddit_post_details",
"description": "Get a Reddit post — title, body, score, comments count, subreddit, and author as structured JSON. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Reddit post URL, e.g. https://reddit.com/r/sub/comments/ID/... The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Flat Reddit comment threads with depth/parentId and the parent post in one call. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Reddit post URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "reddit_post_comments",
"description": "Flat Reddit comment threads with depth/parentId and the parent post in one call. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Reddit post URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Written post text — title, body and top comments. Not a speech transcript. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Reddit post URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 200). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "reddit_post_transcript",
"description": "Written post text — title, body and top comments. Not a speech transcript. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Reddit post URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 200). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Reddit site-wide post search — sort + timeframe + cursor, score/upvoteRatio, authorFullname. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Keyword or phrase to search Reddit posts site-wide (min 2 characters). |
| sort | string | relevance (default) | new | top | hot | comments (alias: comment_count). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 25, max 200). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| timeframe | string | For sort=top or comments: hour | day | week | month | year | all (default all). |
{
"name": "reddit_search",
"description": "Reddit site-wide post search — sort + timeframe + cursor, score/upvoteRatio, authorFullname. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Keyword or phrase to search Reddit posts site-wide (min 2 characters)."
},
"sort": {
"type": "string",
"description": "relevance (default) | new | top | hot | comments (alias: comment_count)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 25, max 200). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"timeframe": {
"type": "string",
"description": "For sort=top or comments: hour | day | week | month | year | all (default all)."
}
},
"additionalProperties": false
}
}Subreddit card — id (t5_…), weekly visitors and contributions, rules[], ISO createdAt. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Subreddit URL, r/name, or bare name (case-insensitive), e.g. r/technology or AskReddit. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "reddit_subreddit_details",
"description": "Subreddit card — id (t5_…), weekly visitors and contributions, rules[], ISO createdAt. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Subreddit URL, r/name, or bare name (case-insensitive), e.g. r/technology or AskReddit. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Search posts inside one subreddit — not subreddit discovery. Same sort/timeframe as site-wide Search. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Keywords or search query (min 2 characters). |
| url * | string | Subreddit URL, r/name, or bare name, e.g. r/technology. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| sort | string | relevance (default) | new | top | hot | comments (alias: comment_count). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 25, max 200). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| timeframe | string | For sort=top or comments: hour | day | week | month | year | all (default all). |
{
"name": "reddit_subreddit_search",
"description": "Search posts inside one subreddit — not subreddit discovery. Same sort/timeframe as site-wide Search. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url",
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Keywords or search query (min 2 characters)."
},
"url": {
"type": "string",
"description": "Subreddit URL, r/name, or bare name, e.g. r/technology. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"sort": {
"type": "string",
"description": "relevance (default) | new | top | hot | comments (alias: comment_count)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 25, max 200). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"timeframe": {
"type": "string",
"description": "For sort=top or comments: hour | day | week | month | year | all (default all)."
}
},
"additionalProperties": false
}
}Threads profile — displayName, isPrivate, bioLinks (Meta verified), isThreadsOnlyUser, transparencyLabel, bioFragments, HD avatars (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Threads profile URL or @handle, e.g. https://threads.net/@username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "threads_profile",
"description": "Threads profile — displayName, isPrivate, bioLinks (Meta verified), isThreadsOnlyUser, transparencyLabel, bioFragments, HD avatars (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Threads profile URL or @handle, e.g. https://threads.net/@username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Recent Threads posts — engagement{views,likes,replies,reposts,quotes}, threadId/isReply. Flat 2 credits. source + timings. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Threads profile URL or @handle. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 100). Threads exposes only a short window of recent public posts on this surface. limit caps what you receive; it cannot increase what Threads returns. Flat 2 credits on every successful call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "threads_user_posts",
"description": "Recent Threads posts — engagement{views,likes,replies,reposts,quotes}, threadId/isReply. Flat 2 credits. source + timings. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Threads profile URL or @handle. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 100). Threads exposes only a short window of recent public posts on this surface. limit caps what you receive; it cannot increase what Threads returns. Flat 2 credits on every successful call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Threads post — engagement (views when exposed), comments[], suggestedPosts[], threadId/isReply. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Threads post URL, e.g. https://threads.net/@user/post/CODE. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "threads_post_details",
"description": "Threads post — engagement (views when exposed), comments[], suggestedPosts[], threadId/isReply. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Threads post URL, e.g. https://threads.net/@user/post/CODE. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Threads keyword search — posts with engagement + media. orderBy relevant | post_dated | engagement. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Keyword or phrase to search public Threads posts (min 2 characters). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 25, max 200). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| orderBy | string | Sort the fetched page: relevant (default, Meta Top / similar to query), post_dated (newest publishedAt first), or engagement (likes+replies+reposts+quotes+views). Unknown values are 400. |
{
"name": "threads_search",
"description": "Threads keyword search — posts with engagement + media. orderBy relevant | post_dated | engagement. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Keyword or phrase to search public Threads posts (min 2 characters)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 25, max 200). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"orderBy": {
"type": "string",
"description": "Sort the fetched page: relevant (default, Meta Top / similar to query), post_dated (newest publishedAt first), or engagement (likes+replies+reposts+quotes+views). Unknown values are 400."
}
},
"additionalProperties": false
}
}Threads user discovery from keyword search — id, handle, avatar, verified. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Keyword to find Threads users / creators (min 2 characters). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 100). Flat 1 credit per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "threads_search_users",
"description": "Threads user discovery from keyword search — id, handle, avatar, verified. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Keyword to find Threads users / creators (min 2 characters)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 100). Flat 1 credit per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Bluesky profile — handle, did, bio, counts, banner, verification{}, labels[], and associated{} (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Bluesky profile URL, @handle, or handle, e.g. bsky.app/profile/handle. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "bluesky_profile",
"description": "Bluesky profile — handle, did, bio, counts, banner, verification{}, labels[], and associated{} (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Bluesky profile URL, @handle, or handle, e.g. bsky.app/profile/handle. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Default ~1 credits (limit 10; 0.1/result). Author feed — posts and reposts (isRepost marked), quote/external/images embeds, opaque cursor. Costs ~1 credits (0.1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Bluesky profile URL, @handle, or handle, e.g. https://bsky.app/profile/handle.bsky.social. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 100). Billed per result. |
| cursor | string | Opaque pagination cursor from the previous nextCursor. Leave empty for the first page. Do not invent a cursor from publishedAt — the feed is ordered by feed time (reposts sort by repost time). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| filter | string | Bluesky getAuthorFeed filter: posts_with_replies (default), posts_no_replies, posts_with_media, posts_and_author_threads, or posts_with_video. Controls replies/media/threads — not reposts. Use includeReposts=false to drop reposts. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| includeReposts | boolean | When false, omit repost rows (reasonRepost). Default true — reposts are included and marked with isRepost / repostedBy / repostedAt. |
{
"name": "bluesky_user_posts",
"description": "Default ~1 credits (limit 10; 0.1/result). Author feed — posts and reposts (isRepost marked), quote/external/images embeds, opaque cursor. Costs ~1 credits (0.1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Bluesky profile URL, @handle, or handle, e.g. https://bsky.app/profile/handle.bsky.social. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 100). Billed per result."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor from the previous nextCursor. Leave empty for the first page. Do not invent a cursor from publishedAt — the feed is ordered by feed time (reposts sort by repost time)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"filter": {
"type": "string",
"description": "Bluesky getAuthorFeed filter: posts_with_replies (default), posts_no_replies, posts_with_media, posts_and_author_threads, or posts_with_video. Controls replies/media/threads — not reposts. Use includeReposts=false to drop reposts."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"includeReposts": {
"type": "boolean",
"description": "When false, omit repost rows (reasonRepost). Default true — reposts are included and marked with isRepost / repostedBy / repostedAt."
}
},
"additionalProperties": false
}
}Post thread via getPostThread — nested replies[], facet links/mentions/hashtags, rich author (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Bluesky post URL, e.g. https://bsky.app/profile/handle/post/RKEY. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| depth | integer | Reply nesting levels under the post (0 = post only with no replies[], default 1, max 6). Maps to Bluesky getPostThread depth. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "bluesky_post_details",
"description": "Post thread via getPostThread — nested replies[], facet links/mentions/hashtags, rich author (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Bluesky post URL, e.g. https://bsky.app/profile/handle/post/RKEY. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"depth": {
"type": "integer",
"minimum": 1,
"description": "Reply nesting levels under the post (0 = post only with no replies[], default 1, max 6). Maps to Bluesky getPostThread depth."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Get a Pinterest pin — title, description, link, board, origin creator, and engagement as structured JSON. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Pinterest pin URL, e.g. https://pinterest.com/pin/ID/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "pinterest_pin_details",
"description": "Get a Pinterest pin — title, description, link, board, origin creator, and engagement as structured JSON. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Pinterest pin URL, e.g. https://pinterest.com/pin/ID/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~5 credits (limit 10; 0.5/result). Pins from a Pinterest profile — offset cursor, pidgets window ~100. Costs ~5 credits (0.5/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Pinterest profile URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 200). Billed per result. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 25). A null nextCursor means the end of the retrievable window (pidgets ~100). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "pinterest_user_pins",
"description": "Default ~5 credits (limit 10; 0.5/result). Pins from a Pinterest profile — offset cursor, pidgets window ~100. Costs ~5 credits (0.5/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Pinterest profile URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 200). Billed per result."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 25). A null nextCursor means the end of the retrievable window (pidgets ~100)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Keyword pin search — offset cursor, search window 40, flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Keywords or search query (min 2 characters). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 25, max 200). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 25). A null nextCursor means the end of the search window (max 40). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "pinterest_search",
"description": "Keyword pin search — offset cursor, search window 40, flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Keywords or search query (min 2 characters)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 25, max 200). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 25). A null nextCursor means the end of the search window (max 40)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~5 credits (limit 10; 0.5/result). Pins on a Pinterest board — saves, imageOriginal, destinationUrl, top-level author. ~0.5 credits/pin. Costs ~5 credits (0.5/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Pinterest board URL (.../username/board-name/), not a /pin/ URL. Example: https://www.pinterest.com/potterybarn/rustic-lodge-lookbook/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pint… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 200). Billed per result. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 25). A null nextCursor means the end of the retrievable window (pidgets ~100). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "pinterest_board",
"description": "Default ~5 credits (limit 10; 0.5/result). Pins on a Pinterest board — saves, imageOriginal, destinationUrl, top-level author. ~0.5 credits/pin. Costs ~5 credits (0.5/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Pinterest board URL (.../username/board-name/), not a /pin/ URL. Example: https://www.pinterest.com/potterybarn/rustic-lodge-lookbook/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 200). Billed per result."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 25). A null nextCursor means the end of the retrievable window (pidgets ~100)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~5 credits (limit 10; 0.5/result). Boards on a Pinterest profile — pinCount, coverImage (474x), privacy, sections. Board followers when scoped. Costs ~5 credits (0.5/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Pinterest profile URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 200). Billed per result. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 25). A null nextCursor means the end of the retrievable window (max 200). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "pinterest_user_boards",
"description": "Default ~5 credits (limit 10; 0.5/result). Boards on a Pinterest profile — pinCount, coverImage (474x), privacy, sections. Board followers when scoped. Costs ~5 credits (0.5/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Pinterest profile URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 200). Billed per result."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 25). A null nextCursor means the end of the retrievable window (max 200)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Public LinkedIn person profile — what a logged-out visitor sees: name, headline, location, about. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | LinkedIn profile URL, e.g. https://www.linkedin.com/in/paul-martin-a5aa98. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "linkedin_profile",
"description": "Public LinkedIn person profile — what a logged-out visitor sees: name, headline, location, about. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "LinkedIn profile URL, e.g. https://www.linkedin.com/in/paul-martin-a5aa98. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Company page for B2B intel — specialties, similarPages, employeeCount, founded, slogan, cover. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | LinkedIn company URL, e.g. https://www.linkedin.com/company/shopify. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "linkedin_company",
"description": "Company page for B2B intel — specialties, similarPages, employeeCount, founded, slogan, cover. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "LinkedIn company URL, e.g. https://www.linkedin.com/company/shopify. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Get a LinkedIn post — text, author, reactions, and comments count as structured JSON. When LinkedIn hides the post behind its sign-in prompt the call fails with 502 at 0 credits. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | LinkedIn post or activity URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "linkedin_post_details",
"description": "Get a LinkedIn post — text, author, reactions, and comments count as structured JSON. When LinkedIn hides the post behind its sign-in prompt the call fails with 502 at 0 credits. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "LinkedIn post or activity URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}LinkedIn post text as a transcript — paragraph segments, timingSource none. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | LinkedIn post or activity URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "linkedin_post_transcript",
"description": "LinkedIn post text as a transcript — paragraph segments, timingSource none. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "LinkedIn post or activity URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}The recent posts a company page shows logged-out visitors (about 10), with engagement{likes,comments}. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | LinkedIn company URL, e.g. https://linkedin.com/company/slug. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 100). Only the ~10 posts the public page shows are available. Flat 1 credit. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 5). A null nextCursor means the end of the list. Only the recent posts LinkedIn shows logged-out visitors (about 10) are available. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "linkedin_company_posts",
"description": "The recent posts a company page shows logged-out visitors (about 10), with engagement{likes,comments}. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "LinkedIn company URL, e.g. https://linkedin.com/company/slug. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 100). Only the ~10 posts the public page shows are available. Flat 1 credit."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 5). A null nextCursor means the end of the list. Only the recent posts LinkedIn shows logged-out visitors (about 10) are available."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~8 credits (limit 10; 0.8/result). Keyword search of public LinkedIn posts — offset cursor, ceiling 50. Costs ~8 credits (0.8/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Search query or keywords (min 2 characters). |
| sort | string | relevance (default, search-engine rank — dates can span years) or date (found posts newest first). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 50). Billed per result. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 10). A null nextCursor means the end of the list (max 50 posts). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "linkedin_search_posts",
"description": "Default ~8 credits (limit 10; 0.8/result). Keyword search of public LinkedIn posts — offset cursor, ceiling 50. Costs ~8 credits (0.8/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Search query or keywords (min 2 characters)."
},
"sort": {
"type": "string",
"description": "relevance (default, search-engine rank — dates can span years) or date (found posts newest first)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 50). Billed per result."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response (numeric offset, e.g. 10). A null nextCursor means the end of the list (max 50 posts)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Rumble video metadata — uniform streams[] with rendition meta, captions[], audioStreams. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Rumble video URL, e.g. https://rumble.com/vXXXX-title.html. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "rumble_video_details",
"description": "Rumble video metadata — uniform streams[] with rendition meta, captions[], audioStreams. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Rumble video URL, e.g. https://rumble.com/vXXXX-title.html. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Rumble published captions as timed segments — parses the .vtt from video-details (not speech-to-text). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Rumble video URL, e.g. https://rumble.com/vXXXX-title.html. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | Preferred caption language as an ISO code, e.g. "en". Defaults to auto-detect. |
{
"name": "rumble_video_transcript",
"description": "Rumble published captions as timed segments — parses the .vtt from video-details (not speech-to-text). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Rumble video URL, e.g. https://rumble.com/vXXXX-title.html. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Preferred caption language as an ISO code, e.g. \"en\". Defaults to auto-detect."
}
},
"additionalProperties": false
}
}Default ~6 credits (limit 10; 0.6/result). Rumble channel uploads — lean streams[{url,type}]; call video-details for rendition meta. Costs ~6 credits (0.6/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Rumble channel or user URL, e.g. https://rumble.com/c/name or https://rumble.com/user/name. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 200). Billed per result. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "rumble_channel_videos",
"description": "Default ~6 credits (limit 10; 0.6/result). Rumble channel uploads — lean streams[{url,type}]; call video-details for rendition meta. Costs ~6 credits (0.6/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Rumble channel or user URL, e.g. https://rumble.com/c/name or https://rumble.com/user/name. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 200). Billed per result."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~6 credits (limit 10; 0.6/result). Rumble keyword search — same video card shape as channel-videos (type, durationSeconds + durationText, UTC publishedAt). Costs ~6 credits (0.6/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Keywords or search query (min 2 characters). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 200). Billed per result. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "rumble_search",
"description": "Default ~6 credits (limit 10; 0.6/result). Rumble keyword search — same video card shape as channel-videos (type, durationSeconds + durationText, UTC publishedAt). Costs ~6 credits (0.6/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Keywords or search query (min 2 characters)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 200). Billed per result."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Rumble top-level comments — publishedAt ISO-8601 UTC from title= on the comment time link. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Rumble video URL, e.g. https://rumble.com/vXXXX-title.html. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 50, max 500). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "rumble_comments",
"description": "Rumble top-level comments — publishedAt ISO-8601 UTC from title= on the comment time link. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Rumble video URL, e.g. https://rumble.com/vXXXX-title.html. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 50, max 500). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}TikTok Shop keyword search — priced products with rating/reviews, typed discount, seller id. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Product search query (min 2 characters), e.g. phone case. |
| sort | string | Order of the returned page: relevance (default, search order), price_asc, price_desc, rating, reviews, discount. Sorts only the products in this response, not TikTok's whole catalog. Products without the value come last. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 10). Flat 2 credits per call. |
| cursor | string | Leave empty for the first page; then pass nextCursor from the previous response (e.g. 10). Each page is a separate call at the same price. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| region | string | Two-letter market region for the search (default US). Echoed on the response as data.region — not a creator home country. Native search is a SERP window (not TikTok's full catalog); compare requested to serpHits / windowMax. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_shop_search",
"description": "TikTok Shop keyword search — priced products with rating/reviews, typed discount, seller id. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Product search query (min 2 characters), e.g. phone case."
},
"sort": {
"type": "string",
"description": "Order of the returned page: relevance (default, search order), price_asc, price_desc, rating, reviews, discount. Sorts only the products in this response, not TikTok's whole catalog. Products without the value come last."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 10). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Leave empty for the first page; then pass nextCursor from the previous response (e.g. 10). Each page is a separate call at the same price."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"region": {
"type": "string",
"description": "Two-letter market region for the search (default US). Echoed on the response as data.region — not a creator home country. Native search is a SERP window (not TikTok's full catalog); compare requested to serpHits / windowMax."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Store catalog with shopInfo (sold/followers/rating) + products priced with sold, rating, typed discount. Costs 2 credits (fallback: 2.8/product, min 2). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok Shop store URL with numeric shop id, e.g. https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079. A slug-only /shop/store/{name} URL is a definitive 400 — TikTok's catalog SSR is keyed by shop id. Get the full URL from /v1/tiktok-shop/user-showcase or a product's seller.url. The… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). 2 credits when served natively (limit ≤ 30); above 30, or when the native page misses, the fallback path bills 2.8 credits per product returned, rounded up, minimum 2. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| region | string | Two-letter market region (default US). Non-US coverage depends on TikTok exposing that shop in the selected region — empty results outside the US are often a platform limit, not a Captapi bug. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_shop_products",
"description": "Store catalog with shopInfo (sold/followers/rating) + products priced with sold, rating, typed discount. Costs 2 credits (fallback: 2.8/product, min 2). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok Shop store URL with numeric shop id, e.g. https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079. A slug-only /shop/store/{name} URL is a definitive 400 — TikTok's catalog SSR is keyed by shop id. Get the full URL from /v1/tiktok-shop/user-showcase or a product's seller.url. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). 2 credits when served natively (limit ≤ 30); above 30, or when the native page misses, the fallback path bills 2.8 credits per product returned, rounded up, minimum 2."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"region": {
"type": "string",
"description": "Two-letter market region (default US). Non-US coverage depends on TikTok exposing that shop in the selected region — empty results outside the US are often a platform limit, not a Captapi bug."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}PDP — price (sku_min when guest min is *), sold vs stock, seller id/url, images[]. Unresolved URL is 404 at 0 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok Shop product URL, e.g. https://shop.tiktok.com/view/product/1731410956394792439?region=BR or https://www.tiktok.com/shop/pdp/1731098552908944370. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| region | string | Two-letter market region (default US). A region= or oec_region= query on the product URL wins over this default so a BR share URL is not fetched as US. Echoed as data.region. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_shop_product_details",
"description": "PDP — price (sku_min when guest min is *), sold vs stock, seller id/url, images[]. Unresolved URL is 404 at 0 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok Shop product URL, e.g. https://shop.tiktok.com/view/product/1731410956394792439?region=BR or https://www.tiktok.com/shop/pdp/1731098552908944370. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"region": {
"type": "string",
"description": "Two-letter market region (default US). A region= or oec_region= query on the product URL wins over this default so a BR share URL is not fetched as US. Echoed as data.region."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~18 credits (limit 20; 0.9/result). TikTok Shop product reviews — star rating, text, SKU variant, verified purchase, country, and review photos. Costs ~18 credits (0.9/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok Shop product URL, e.g. https://www.tiktok.com/shop/pdp/1731962298839634826. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| sort | string | Order of the returned page: leave empty for TikTok's order, or recent (newest first by createdAt). Sorts only the reviews in this response, not the product's whole review set. Reviews without a date come last. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Billed per result. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| rating | string | Only return reviews with these star ratings: a comma-separated list of values 1-5 (e.g. rating=1,2 for negative reviews). You pay only for the reviews returned. Any other value is a 400 INVALID_PARAMETER. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "tiktok_shop_product_reviews",
"description": "Default ~18 credits (limit 20; 0.9/result). TikTok Shop product reviews — star rating, text, SKU variant, verified purchase, country, and review photos. Costs ~18 credits (0.9/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok Shop product URL, e.g. https://www.tiktok.com/shop/pdp/1731962298839634826. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"sort": {
"type": "string",
"description": "Order of the returned page: leave empty for TikTok's order, or recent (newest first by createdAt). Sorts only the reviews in this response, not the product's whole review set. Reviews without a date come last."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Billed per result."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"rating": {
"type": "string",
"description": "Only return reviews with these star ratings: a comma-separated list of values 1-5 (e.g. rating=1,2 for negative reviews). You pay only for the reviews returned. Any other value is a 400 INVALID_PARAMETER."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~23 credits (limit 10; 2.25/result). Creator Shop showcase — affiliate shelf products with per-product sold, rating, typed discount, and seller name/url. Costs ~23 credits (2.25/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 200). Billed per result. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| username * | string | TikTok username, @handle, or profile URL, e.g. jeffreestar or https://www.tiktok.com/@jeffreestar. |
{
"name": "tiktok_shop_user_showcase",
"description": "Default ~23 credits (limit 10; 2.25/result). Creator Shop showcase — affiliate shelf products with per-product sold, rating, typed discount, and seller name/url. Costs ~23 credits (2.25/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"username"
],
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 200). Billed per result."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"username": {
"type": "string",
"description": "TikTok username, @handle, or profile URL, e.g. jeffreestar or https://www.tiktok.com/@jeffreestar."
}
},
"additionalProperties": false
}
}Search Marketplace by keyword + city — filters, isLocal/shipsOutsideRadius, opaque cursor (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Product or keyword to search Facebook Marketplace for. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | How many listings to return (1–200). Flat 2 credits when details=false; details=true billed as 2 + 2 per listing. |
| cursor | string | Opaque pagination cursor from a previous nextCursor. A cursor this endpoint did not issue is 400 INVALID_CURSOR. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| sortBy | string | suggested | distance | creation_time | price_ascend | price_descend. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| details | boolean | When true, adds description/condition/coordinates/full photo gallery/seller/distanceMiles — billed as 2 + 2 credits per enriched listing (listings the 90s deadline did not reach ship as search cards with truncatedReason=enrich_deadline and are not billed the extra 2). Default false → flat 2 credits;… |
| category | string | Top-level category slug, e.g. electronics. |
| location | string | Alias of searchLocation. Prefer searchLocation. Either one is required. |
| maxPrice | integer | Maximum price in local currency units. |
| minPrice | integer | Minimum price in local currency units. |
| condition | string | new, like_new, good, fair (comma-separated ok). |
| radiusMiles | integer | Radius in miles: 1,2,5,10,20,40,60,80,100,250,500. Does not exclude nationwide shipped inventory. |
| availability | string | available | sold | all. |
| deliveryMethod | string | local_pickup | shipping | all. Shipped listings can appear nationwide outside radiusMiles — use local_pickup for nearby-only; rows expose isLocal / shipsOutsideRadius. |
| searchLocation * | string | Search-origin city or place name, e.g. 'Austin, TX'. Required — there is no default city. Echoed on the envelope and inside filters. Not listings[].location. Names that don't resolve to a real place are a definitive 400 UNKNOWN_LOCATION (Facebook would otherwise silently search an unrelated metro) —… |
| daysSinceListed | string | Facebook calendar-day recency: 1 = since the start of yesterday (not a rolling 24 hours), 7, or 30. |
{
"name": "facebook_marketplace_search",
"description": "Search Marketplace by keyword + city — filters, isLocal/shipsOutsideRadius, opaque cursor (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q",
"searchLocation"
],
"properties": {
"q": {
"type": "string",
"description": "Product or keyword to search Facebook Marketplace for."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "How many listings to return (1–200). Flat 2 credits when details=false; details=true billed as 2 + 2 per listing."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor from a previous nextCursor. A cursor this endpoint did not issue is 400 INVALID_CURSOR."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"sortBy": {
"type": "string",
"description": "suggested | distance | creation_time | price_ascend | price_descend."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"details": {
"type": "boolean",
"description": "When true, adds description/condition/coordinates/full photo gallery/seller/distanceMiles — billed as 2 + 2 credits per enriched listing (listings the 90s deadline did not reach ship as search cards with truncatedReason=enrich_deadline and are not billed the extra 2). Default false → flat 2 credits; cover photo is still in image."
},
"category": {
"type": "string",
"description": "Top-level category slug, e.g. electronics."
},
"location": {
"type": "string",
"description": "Alias of searchLocation. Prefer searchLocation. Either one is required."
},
"maxPrice": {
"type": "integer",
"minimum": 1,
"description": "Maximum price in local currency units."
},
"minPrice": {
"type": "integer",
"minimum": 1,
"description": "Minimum price in local currency units."
},
"condition": {
"type": "string",
"description": "new, like_new, good, fair (comma-separated ok)."
},
"radiusMiles": {
"type": "integer",
"minimum": 1,
"description": "Radius in miles: 1,2,5,10,20,40,60,80,100,250,500. Does not exclude nationwide shipped inventory."
},
"availability": {
"type": "string",
"description": "available | sold | all."
},
"deliveryMethod": {
"type": "string",
"description": "local_pickup | shipping | all. Shipped listings can appear nationwide outside radiusMiles — use local_pickup for nearby-only; rows expose isLocal / shipsOutsideRadius."
},
"searchLocation": {
"type": "string",
"description": "Search-origin city or place name, e.g. 'Austin, TX'. Required — there is no default city. Echoed on the envelope and inside filters. Not listings[].location. Names that don't resolve to a real place are a definitive 400 UNKNOWN_LOCATION (Facebook would otherwise silently search an unrelated metro) — /v1/facebook/marketplace-location-search finds valid ones."
},
"daysSinceListed": {
"type": "string",
"description": "Facebook calendar-day recency: 1 = since the start of yesterday (not a rolling 24 hours), 7, or 30."
}
},
"additionalProperties": false
}
}Disambiguate city names into Marketplace hubs — id + lat/lng. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | City/place query. Bare names like 'Austin' may return multiple candidates (TX/MN/IN); include a state for a single hit (e.g. 'Austin, TX'). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 50). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_marketplace_location_search",
"description": "Disambiguate city names into Marketplace hubs — id + lat/lng. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "City/place query. Bare names like 'Austin' may return multiple candidates (TX/MN/IN); include a state for a single hit (e.g. 'Austin, TX')."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 50). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Marketplace listing — title, priceAmount, status, seller{}, condition, coords (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Facebook Marketplace item URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_marketplace_item",
"description": "Marketplace listing — title, priceAmount, status, seller{}, condition, coords (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Facebook Marketplace item URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Search Facebook events by topic and city — local startDate/timezone, venue. 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Topic keyword, e.g. 'comedy'. Pair with location for city-scoped results. |
| to | string | Inclusive local start date filter YYYY-MM-DD. |
| from | string | Inclusive local start date filter YYYY-MM-DD. Use for upcoming-only windows — Facebook/SERP may return past events. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. Response `source` is native or extended (fetch path — not a price change). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| location | string | City/place geo filter (e.g. London). Matches timezone, location.city, or coords near the city — not a title substring. |
| upcoming | boolean | When true and from is omitted, sets from to today's UTC date so past events are dropped. |
{
"name": "facebook_event_search",
"description": "Search Facebook events by topic and city — local startDate/timezone, venue. 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Topic keyword, e.g. 'comedy'. Pair with location for city-scoped results."
},
"to": {
"type": "string",
"description": "Inclusive local start date filter YYYY-MM-DD."
},
"from": {
"type": "string",
"description": "Inclusive local start date filter YYYY-MM-DD. Use for upcoming-only windows — Facebook/SERP may return past events."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call. Response `source` is native or extended (fetch path — not a price change)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"location": {
"type": "string",
"description": "City/place geo filter (e.g. London). Matches timezone, location.city, or coords near the city — not a title substring."
},
"upcoming": {
"type": "boolean",
"description": "When true and from is omitted, sets from to today's UTC date so past events are dropped."
}
},
"additionalProperties": false
}
}Get a Facebook event — title, local start/end, timezone, place, host id, and attendance when exposed. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Facebook event URL, e.g. https://facebook.com/events/ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_event_details",
"description": "Get a Facebook event — title, local start/end, timezone, place, host id, and attendance when exposed. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Facebook event URL, e.g. https://facebook.com/events/ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}List a Facebook Page's events — local startDate, timezone, venue. 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Facebook profile/page URL, @handle, or page name. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. Response `source` is native or extended (fetch path — not a price change). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_profile_events",
"description": "List a Facebook Page's events — local startDate, timezone, venue. 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Facebook profile/page URL, @handle, or page name. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call. Response `source` is native or extended (fetch path — not a price change)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Search Meta Ad Library by keyword — active/inactive, media type, date range, platforms, cursor, and spend/impressions when Meta publishes them. Each ad has creativeHash + landingDomain; dedupe=true merges repeats. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Keyword, brand, or advertiser to search Meta Ad Library (min 2 characters). |
| trim | boolean | When true, omit cards/images/videos typed arrays (media[] stays). Captapi payloads are already lean vs Meta nested snapshots. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. |
| cursor | string | Pagination cursor from a previous nextCursor. Pages through the current Meta HTML result batch. |
| dedupe | boolean | When true, ads with the same creativeHash (same copy, headline and landing domain) collapse into one row, the first in library order, with duplicateIds[] (every ad id in the group) and duplicateCount (group size). Duplicates are merged only among the ads this request fetched (retrievableCount). Ads … |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| status | string | Ad delivery status: ACTIVE (default), INACTIVE, or ALL. Use ACTIVE for "what are they running now?". |
| ad_type | string | all (default) or political_and_issue_ads. Spend/impressions are typically only filled for political/issue ads. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country code (e.g. US, GB, DE), or ALL for every country (Meta's own value). Default US. For inactive ads prefer ALL: a single-country search can list far fewer inactive ads than ALL. Other non-ISO codes are a definitive 400 INVALID_COUNTRY — Meta would otherwise ignore the code and s… |
| sort_by | string | Meta sort mode: total_impressions or relevancy_monthly_grouped. |
| end_date | string | Only ads shown (delivered) on or before this date (YYYY-MM-DD). |
| platforms | string | Comma-separated publisher platforms to keep: FACEBOOK, INSTAGRAM, MESSENGER, AUDIENCE_NETWORK, THREADS. |
| media_type | string | Creative filter: ALL (default), IMAGE, VIDEO, MEME, IMAGE_AND_MEME, or NONE. |
| start_date | string | Only ads shown (delivered) on or after this date (YYYY-MM-DD). Delivery-date window, not a start-date filter: an ad that started earlier but was still running in the range is included. |
| search_type | string | keyword_unordered (default) or keyword_exact_phrase. |
{
"name": "facebook_ad_library_search",
"description": "Search Meta Ad Library by keyword — active/inactive, media type, date range, platforms, cursor, and spend/impressions when Meta publishes them. Each ad has creativeHash + landingDomain; dedupe=true merges repeats. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Keyword, brand, or advertiser to search Meta Ad Library (min 2 characters)."
},
"trim": {
"type": "boolean",
"description": "When true, omit cards/images/videos typed arrays (media[] stays). Captapi payloads are already lean vs Meta nested snapshots."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor from a previous nextCursor. Pages through the current Meta HTML result batch."
},
"dedupe": {
"type": "boolean",
"description": "When true, ads with the same creativeHash (same copy, headline and landing domain) collapse into one row, the first in library order, with duplicateIds[] (every ad id in the group) and duplicateCount (group size). Duplicates are merged only among the ads this request fetched (retrievableCount). Ads from another request or from library pages past this batch are not compared, so the same creative can appear again there. Default false: every ad is its own row and no duplicate fields are added. Same price."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"status": {
"type": "string",
"description": "Ad delivery status: ACTIVE (default), INACTIVE, or ALL. Use ACTIVE for \"what are they running now?\"."
},
"ad_type": {
"type": "string",
"description": "all (default) or political_and_issue_ads. Spend/impressions are typically only filled for political/issue ads."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country code (e.g. US, GB, DE), or ALL for every country (Meta's own value). Default US. For inactive ads prefer ALL: a single-country search can list far fewer inactive ads than ALL. Other non-ISO codes are a definitive 400 INVALID_COUNTRY — Meta would otherwise ignore the code and search globally while echoing it back as if the filter worked."
},
"sort_by": {
"type": "string",
"description": "Meta sort mode: total_impressions or relevancy_monthly_grouped."
},
"end_date": {
"type": "string",
"description": "Only ads shown (delivered) on or before this date (YYYY-MM-DD)."
},
"platforms": {
"type": "string",
"description": "Comma-separated publisher platforms to keep: FACEBOOK, INSTAGRAM, MESSENGER, AUDIENCE_NETWORK, THREADS."
},
"media_type": {
"type": "string",
"description": "Creative filter: ALL (default), IMAGE, VIDEO, MEME, IMAGE_AND_MEME, or NONE."
},
"start_date": {
"type": "string",
"description": "Only ads shown (delivered) on or after this date (YYYY-MM-DD). Delivery-date window, not a start-date filter: an ad that started earlier but was still running in the range is included."
},
"search_type": {
"type": "string",
"description": "keyword_unordered (default) or keyword_exact_phrase."
}
},
"additionalProperties": false
}
}Ads for one Meta page — active by default, Meta's top-by-impressions order, sort_by and date window, same envelope as /facebook/search. Each ad has creativeHash + landingDomain; dedupe=true merges repeats. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | pageId from /search-companies (preferred), libraryUrl, vanity page URL (facebook.com/nike/), or Ad Library URL with view_all_page_id. Do not pass profileId from facebook.com/{digits}/ when it differs from pageId. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, … |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call on the native path; the extended fallback bills per returned ad. |
| cursor | string | Pagination cursor from a previous nextCursor. Pages through the current Meta HTML result batch. |
| dedupe | boolean | When true, ads with the same creativeHash (same copy, headline and landing domain) collapse into one row, the first in library order, with duplicateIds[] (every ad id in the group) and duplicateCount (group size). Duplicates are merged only among the ads this request fetched (retrievableCount). Ads … |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| status | string | Ad delivery status: ACTIVE (default), INACTIVE, or ALL. Use ACTIVE for "what are they running now?". |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country code, or ALL for every country (Meta's own value). Default US. For inactive ads prefer ALL: a single-country search can list far fewer inactive ads than ALL. Other non-ISO codes are a definitive 400 INVALID_COUNTRY. |
| sort_by | string | Meta sort mode: total_impressions or relevancy_monthly_grouped. Omit for Meta's default ranking (top ads by impressions first). |
| end_date | string | Only ads shown (delivered) on or before this date (YYYY-MM-DD). |
| start_date | string | Only ads shown (delivered) on or after this date (YYYY-MM-DD). Delivery-date window, not a start-date filter: an ad that started earlier but was still running in the range is included. |
{
"name": "facebook_ad_library_company_ads",
"description": "Ads for one Meta page — active by default, Meta's top-by-impressions order, sort_by and date window, same envelope as /facebook/search. Each ad has creativeHash + landingDomain; dedupe=true merges repeats. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "pageId from /search-companies (preferred), libraryUrl, vanity page URL (facebook.com/nike/), or Ad Library URL with view_all_page_id. Do not pass profileId from facebook.com/{digits}/ when it differs from pageId. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call on the native path; the extended fallback bills per returned ad."
},
"cursor": {
"type": "string",
"description": "Pagination cursor from a previous nextCursor. Pages through the current Meta HTML result batch."
},
"dedupe": {
"type": "boolean",
"description": "When true, ads with the same creativeHash (same copy, headline and landing domain) collapse into one row, the first in library order, with duplicateIds[] (every ad id in the group) and duplicateCount (group size). Duplicates are merged only among the ads this request fetched (retrievableCount). Ads from another request or from library pages past this batch are not compared, so the same creative can appear again there. Default false: every ad is its own row and no duplicate fields are added. Same price."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"status": {
"type": "string",
"description": "Ad delivery status: ACTIVE (default), INACTIVE, or ALL. Use ACTIVE for \"what are they running now?\"."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country code, or ALL for every country (Meta's own value). Default US. For inactive ads prefer ALL: a single-country search can list far fewer inactive ads than ALL. Other non-ISO codes are a definitive 400 INVALID_COUNTRY."
},
"sort_by": {
"type": "string",
"description": "Meta sort mode: total_impressions or relevancy_monthly_grouped. Omit for Meta's default ranking (top ads by impressions first)."
},
"end_date": {
"type": "string",
"description": "Only ads shown (delivered) on or before this date (YYYY-MM-DD)."
},
"start_date": {
"type": "string",
"description": "Only ads shown (delivered) on or after this date (YYYY-MM-DD). Delivery-date window, not a start-date filter: an ad that started earlier but was still running in the range is included."
}
},
"additionalProperties": false
}
}Find Meta Ad Library pages by brand — name-matched, pageId for company-ads (not profileId). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Company or brand name to search for (min 2 characters). Name-matched — off-brand pages are dropped. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country code. Default US. Non-ISO codes are a definitive 400 INVALID_COUNTRY. |
{
"name": "facebook_ad_library_search_companies",
"description": "Find Meta Ad Library pages by brand — name-matched, pageId for company-ads (not profileId). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Company or brand name to search for (min 2 characters). Name-matched — off-brand pages are dropped."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country code. Default US. Non-ISO codes are a definitive 400 INVALID_COUNTRY."
}
},
"additionalProperties": false
}
}One Meta ad by ID — same creative as search (creativeHash, landingDomain included), plus EU transparency data for EU-delivered ads. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Meta Ad Library ad URL or ad ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_ad_library_ad_details",
"description": "One Meta ad by ID — same creative as search (creativeHash, landingDomain included), plus EU transparency data for EU-delivered ads. Flat 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Meta Ad Library ad URL or ad ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Speech transcript of a Meta video ad, with the ad's written copy. Music-only ads return speechDetected false. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Meta Ad Library ad URL or ad ID of a video ad. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "facebook_ad_library_ad_transcript",
"description": "Speech transcript of a Meta video ad, with the ad's written copy. Music-only ads return speechDetected false. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Meta Ad Library ad URL or ad ID of a video ad. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Search TikTok Commercial Content Library — relevance-filtered, uniform null schema (2 credits native, 5 via fallback). Costs 2 credits (5 via fallback path). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Keyword or advertiser to search TikTok Commercial Content Library (min 2 characters). |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Does not change the price: 2 credits native, 5 via the fallback path, 0 when empty. |
| match | string | Keyword token mode: "any" (default, OR whole-word) or "all" (AND). hair ≠ wheelchair. Literal hits lead; already-fetched SERP ads fill behind them up to limit (matchedFrom [] = ranked fill). Empty results are free. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country code (e.g. GB, DE, FR). Default GB. TikTok's Commercial Content Library only covers the EU/EEA, the UK and Switzerland (32 countries) — other codes (US, SA, …) return 400 UNSUPPORTED_REGION with the supported list; TikTok has no ad-library data for them. |
{
"name": "tiktok_ad_library_search",
"description": "Search TikTok Commercial Content Library — relevance-filtered, uniform null schema (2 credits native, 5 via fallback). Costs 2 credits (5 via fallback path). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Keyword or advertiser to search TikTok Commercial Content Library (min 2 characters)."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Does not change the price: 2 credits native, 5 via the fallback path, 0 when empty."
},
"match": {
"type": "string",
"description": "Keyword token mode: \"any\" (default, OR whole-word) or \"all\" (AND). hair ≠ wheelchair. Literal hits lead; already-fetched SERP ads fill behind them up to limit (matchedFrom [] = ranked fill). Empty results are free."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country code (e.g. GB, DE, FR). Default GB. TikTok's Commercial Content Library only covers the EU/EEA, the UK and Switzerland (32 countries) — other codes (US, SA, …) return 400 UNSUPPORTED_REGION with the supported list; TikTok has no ad-library data for them."
}
},
"additionalProperties": false
}
}TikTok Creative Center Top Ads — one ~20-row leaderboard page, not a library search (flat 2; ~1/ad on the fallback path). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q | string | Optional keyword that ranks the one ~20-row leaderboard page — not a library search. Case-insensitive whole-word hits on title/brandName/industry/objective (hair ≠ wheelchair) come first; the rest of TikTok's keyword-ranked page follows as fill (matchedFrom [] on those ads, rankedFill in the envelop… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 20). One Creative Center leaderboard page is ~20 rows; limit only trims that pool — it cannot scan more candidates. Flat 2 credits on the native path; the fallback path ~1 credit per returned ad (min 2). |
| match | string | Keyword token mode: "any" (default, OR) or "all" (AND). Zero whole-word hits still return TikTok's keyword-ranked page as matchBasis=ranked (literalMatches=0). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| period | integer | Lookback window in days: 7, 30, or 180. Default 30. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country code. Default US. Non-ISO codes are a definitive 400 INVALID_COUNTRY (Creative Center used to quietly return an empty leaderboard for them). |
| orderBy | string | Sort: for_you, likes, ctr, impressions, or cost. Default for_you. |
| adFormat | string | Optional format filter: spark or non_spark. Served only by the extended fetcher — while it is disabled, adFormat returns 503 filter_unavailable (retryable false, not billed). Omit adFormat for the native leaderboard. |
| industry | string | Optional industry key or label from Creative Center. |
| objective | string | Optional campaign objective (e.g. Traffic, Conversion, Reach). |
{
"name": "tiktok_ad_library_top_ads",
"description": "TikTok Creative Center Top Ads — one ~20-row leaderboard page, not a library search (flat 2; ~1/ad on the fallback path). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"q": {
"type": "string",
"description": "Optional keyword that ranks the one ~20-row leaderboard page — not a library search. Case-insensitive whole-word hits on title/brandName/industry/objective (hair ≠ wheelchair) come first; the rest of TikTok's keyword-ranked page follows as fill (matchedFrom [] on those ads, rankedFill in the envelope). There is no tags field. advertiser.name is often null in the default US market. Envelope candidatesScanned is the pre-filter pool size. For a known advertiser, use /tiktok/ad-details by ad id."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 20). One Creative Center leaderboard page is ~20 rows; limit only trims that pool — it cannot scan more candidates. Flat 2 credits on the native path; the fallback path ~1 credit per returned ad (min 2)."
},
"match": {
"type": "string",
"description": "Keyword token mode: \"any\" (default, OR) or \"all\" (AND). Zero whole-word hits still return TikTok's keyword-ranked page as matchBasis=ranked (literalMatches=0)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"period": {
"type": "integer",
"minimum": 1,
"description": "Lookback window in days: 7, 30, or 180. Default 30."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country code. Default US. Non-ISO codes are a definitive 400 INVALID_COUNTRY (Creative Center used to quietly return an empty leaderboard for them)."
},
"orderBy": {
"type": "string",
"description": "Sort: for_you, likes, ctr, impressions, or cost. Default for_you."
},
"adFormat": {
"type": "string",
"description": "Optional format filter: spark or non_spark. Served only by the extended fetcher — while it is disabled, adFormat returns 503 filter_unavailable (retryable false, not billed). Omit adFormat for the native leaderboard."
},
"industry": {
"type": "string",
"description": "Optional industry key or label from Creative Center."
},
"objective": {
"type": "string",
"description": "Optional campaign objective (e.g. Traffic, Conversion, Reach)."
}
},
"additionalProperties": false
}
}One TikTok Commercial Content Library ad by ID — calendar-day dates, always 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | TikTok Ad Library URL or numeric ad ID. Inputs with no extractable numeric ID are a definitive 400. An ID TikTok's library positively reports as nonexistent is a definitive 404 AD_NOT_FOUND (ads outside the EU/EEA+UK+CH never enter the library, and entries expire one year after last impression). The… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country code. Default GB. Only EU/EEA + UK + CH are covered by TikTok's library; other codes return 400 UNSUPPORTED_REGION. |
{
"name": "tiktok_ad_library_ad_details",
"description": "One TikTok Commercial Content Library ad by ID — calendar-day dates, always 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "TikTok Ad Library URL or numeric ad ID. Inputs with no extractable numeric ID are a definitive 400. An ID TikTok's library positively reports as nonexistent is a definitive 404 AD_NOT_FOUND (ads outside the EU/EEA+UK+CH never enter the library, and entries expire one year after last impression). The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country code. Default GB. Only EU/EEA + UK + CH are covered by TikTok's library; other codes return 400 UNSUPPORTED_REGION."
}
},
"additionalProperties": false
}
}Google publishes spend and impression ranges only for election ads; commercial advertisers omit both. isActive is true when lastShown is within 7 UTC days. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| sort | string | Client-side sort: last_shown (recent activity first) or first_shown. Default is ATC order. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). Flat 2 credits when results are returned; 0 credits when totalReturned is 0. |
| topic | string | Only "all" is supported (commercial ATC). Google publishes spend and impression ranges only for election ads; commercial advertisers omit both. isActive is true when lastShown is within 7 UTC days. |
| cursor | string | Pagination cursor from nextCursor. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| region | string | Alias for country. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country / region code (soft filter). Default US. Alias: region. Non-ISO codes are a definitive 400 INVALID_COUNTRY. |
| end_date | string | YYYY-MM-DD — keep creatives whose shown window overlaps this end. |
| advertiser * | string | Advertiser name, domain (e.g. nike.com), or Google advertiser ID (AR…). Prefer AR… from advertiser-search. |
| start_date | string | YYYY-MM-DD — keep creatives whose shown window overlaps this start. |
{
"name": "google_ad_library_company_ads",
"description": "Google publishes spend and impression ranges only for election ads; commercial advertisers omit both. isActive is true when lastShown is within 7 UTC days. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"advertiser"
],
"properties": {
"sort": {
"type": "string",
"description": "Client-side sort: last_shown (recent activity first) or first_shown. Default is ATC order."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). Flat 2 credits when results are returned; 0 credits when totalReturned is 0."
},
"topic": {
"type": "string",
"description": "Only \"all\" is supported (commercial ATC). Google publishes spend and impression ranges only for election ads; commercial advertisers omit both. isActive is true when lastShown is within 7 UTC days."
},
"cursor": {
"type": "string",
"description": "Pagination cursor from nextCursor."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"region": {
"type": "string",
"description": "Alias for country."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country / region code (soft filter). Default US. Alias: region. Non-ISO codes are a definitive 400 INVALID_COUNTRY."
},
"end_date": {
"type": "string",
"description": "YYYY-MM-DD — keep creatives whose shown window overlaps this end."
},
"advertiser": {
"type": "string",
"description": "Advertiser name, domain (e.g. nike.com), or Google advertiser ID (AR…). Prefer AR… from advertiser-search."
},
"start_date": {
"type": "string",
"description": "YYYY-MM-DD — keep creatives whose shown window overlaps this start."
}
},
"additionalProperties": false
}
}Google publishes spend and impression ranges only for election ads; commercial advertisers omit both. isActive is true when lastShown is within 7 UTC days. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country code. Default US. Non-ISO codes are a definitive 400 INVALID_COUNTRY. |
| creative_id * | string | Google Ads Transparency URL containing AR... advertiser and CR... creative IDs. A creative that does not exist under the advertiser is a definitive 404 AD_NOT_FOUND (upstream answered) — 503 is reserved for actual transport failures. |
{
"name": "google_ad_library_ad_details",
"description": "Google publishes spend and impression ranges only for election ads; commercial advertisers omit both. isActive is true when lastShown is within 7 UTC days. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"creative_id"
],
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country code. Default US. Non-ISO codes are a definitive 400 INVALID_COUNTRY."
},
"creative_id": {
"type": "string",
"description": "Google Ads Transparency URL containing AR... advertiser and CR... creative IDs. A creative that does not exist under the advertiser is a definitive 404 AD_NOT_FOUND (upstream answered) — 503 is reserved for actual transport failures."
}
},
"additionalProperties": false
}
}Find Google Ads Transparency AR… entities — ranked multi-result (1 credit when found; empty is free). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Brand, domain, or advertiser name (min 2 characters). Expanded + ranked so US prefers Inc. over SRL. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 50). Flat 1 credit when results are returned; 0 credits when totalReturned is 0. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| country | string | Two-letter ISO country code used for ranking (e.g. US). Default US. Non-ISO codes are a definitive 400 INVALID_COUNTRY. |
{
"name": "google_ad_library_advertiser_search",
"description": "Find Google Ads Transparency AR… entities — ranked multi-result (1 credit when found; empty is free). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Brand, domain, or advertiser name (min 2 characters). Expanded + ranked so US prefers Inc. over SRL."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 50). Flat 1 credit when results are returned; 0 credits when totalReturned is 0."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"country": {
"type": "string",
"description": "Two-letter ISO country code used for ranking (e.g. US). Default US. Non-ISO codes are a definitive 400 INVALID_COUNTRY."
}
},
"additionalProperties": false
}
}LinkedIn publishes run dates, impressions and targeting only on a subset of creatives. Search is the SERP card; source is native. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q | string | Advertiser / account owner name (min 2 when used). Provide q/company, keyword, or companyId. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 200). One LinkedIn SERP page is ~25 cards — when limit is higher, further pages are pulled automatically within the request's time budget, so limit=50 fills to 50 when LinkedIn has the ads (hasMore + nextCursor cover the rest). Flat 2 credits per call on the nati… |
| cursor | string | Pagination token from paginationToken / nextCursor. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| company | string | Alias of q — advertiser / account owner name. |
| country | string | Single ISO country code. Default US. Ignored when countries is set. Non-ISO codes are a definitive 400 INVALID_COUNTRY — LinkedIn would otherwise answer an empty result set as if the filter worked. |
| endDate | string | Custom range end YYYY-MM-DD (use with startDate). |
| keyword | string | Optional keyword filter on ad creative copy. Whole-word hits are ordered first; already-fetched SERP cards without a literal hit fill behind them up to limit (matchedFrom [] = ranked fill). |
| companyId | string | LinkedIn numeric company id for exact advertiser match. |
| countries | string | Comma-separated ISO country codes (e.g. US,CA,MX). Each code is validated — non-ISO codes are a 400 INVALID_COUNTRY. |
| startDate | string | Custom range start YYYY-MM-DD (use with endDate). |
| paginationToken | string | Alias of cursor. |
{
"name": "linkedin_ad_library_search_ads",
"description": "LinkedIn publishes run dates, impressions and targeting only on a subset of creatives. Search is the SERP card; source is native. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"q": {
"type": "string",
"description": "Advertiser / account owner name (min 2 when used). Provide q/company, keyword, or companyId."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 200). One LinkedIn SERP page is ~25 cards — when limit is higher, further pages are pulled automatically within the request's time budget, so limit=50 fills to 50 when LinkedIn has the ads (hasMore + nextCursor cover the rest). Flat 2 credits per call on the native path; the extended fallback bills ~3.5 credits per returned ad. Response `source` is native or extended so you can see which price applied."
},
"cursor": {
"type": "string",
"description": "Pagination token from paginationToken / nextCursor."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"company": {
"type": "string",
"description": "Alias of q — advertiser / account owner name."
},
"country": {
"type": "string",
"description": "Single ISO country code. Default US. Ignored when countries is set. Non-ISO codes are a definitive 400 INVALID_COUNTRY — LinkedIn would otherwise answer an empty result set as if the filter worked."
},
"endDate": {
"type": "string",
"description": "Custom range end YYYY-MM-DD (use with startDate)."
},
"keyword": {
"type": "string",
"description": "Optional keyword filter on ad creative copy. Whole-word hits are ordered first; already-fetched SERP cards without a literal hit fill behind them up to limit (matchedFrom [] = ranked fill)."
},
"companyId": {
"type": "string",
"description": "LinkedIn numeric company id for exact advertiser match."
},
"countries": {
"type": "string",
"description": "Comma-separated ISO country codes (e.g. US,CA,MX). Each code is validated — non-ISO codes are a 400 INVALID_COUNTRY."
},
"startDate": {
"type": "string",
"description": "Custom range start YYYY-MM-DD (use with endDate)."
},
"paginationToken": {
"type": "string",
"description": "Alias of cursor."
}
},
"additionalProperties": false
}
}One LinkedIn Ad Library ad by ID. LinkedIn withholds Ran-from / impressions / targeting on most creatives — those keys are omitted, not 404. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | LinkedIn Ad Library URL or numeric ad ID (also accepts urn:li:sponsoredCreative:ID). Inputs that are neither numeric nor an ad-library detail URL are a definitive 400. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "linkedin_ad_library_ad_details",
"description": "One LinkedIn Ad Library ad by ID. LinkedIn withholds Ran-from / impressions / targeting on most creatives — those keys are omitted, not 404. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "LinkedIn Ad Library URL or numeric ad ID (also accepts urn:li:sponsoredCreative:ID). Inputs that are neither numeric nor an ad-library detail URL are a definitive 400. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Third-party seller storefronts (/sp?seller= / /s?me=) — ASIN + canonical /dp URLs, price, badges. Not influencer /shop/{handle}. Costs 1 credit per 16 products (default limit 20 = 2). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Amazon seller storefront URL (/sp?seller=… or /s?me=…) or raw seller ID. Not influencer /shop/<handle> pages. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max products to include (default 20, max 200; 0 = seller metadata only). Billed per 16-product storefront page: ceil(limit / 16) credits, minimum 1 — the default 20 costs 2. |
| cursor | string | Pagination cursor from nextCursor (page or page:offset). Leave empty for the first page. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| marketplace | string | Amazon marketplace code. Default US. |
{
"name": "amazon_shop_page",
"description": "Third-party seller storefronts (/sp?seller= / /s?me=) — ASIN + canonical /dp URLs, price, badges. Not influencer /shop/{handle}. Costs 1 credit per 16 products (default limit 20 = 2). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Amazon seller storefront URL (/sp?seller=… or /s?me=…) or raw seller ID. Not influencer /shop/<handle> pages. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max products to include (default 20, max 200; 0 = seller metadata only). Billed per 16-product storefront page: ceil(limit / 16) credits, minimum 1 — the default 20 costs 2."
},
"cursor": {
"type": "string",
"description": "Pagination cursor from nextCursor (page or page:offset). Leave empty for the first page."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"marketplace": {
"type": "string",
"description": "Amazon marketplace code. Default US."
}
},
"additionalProperties": false
}
}GitHub public profile — login, type User|Organization, email when public, followers (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| username * | string | GitHub username or profile URL, e.g. getify or https://github.com/getify. |
{
"name": "github_user",
"description": "GitHub public profile — login, type User|Organization, email when public, followers (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"username"
],
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"username": {
"type": "string",
"description": "GitHub username or profile URL, e.g. getify or https://github.com/getify."
}
},
"additionalProperties": false
}
}Default ~4 credits (limit 10; 0.4/result). List a user's repos with sort/direction/type — opaque Link cursor (~0.4/repo). Costs ~4 credits (0.4/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| sort | string | created | updated | pushed | full_name (default updated). Not stars — GitHub's user-repos API has no stars sort. Echoed as data.sort. |
| type | string | owner (default) | member | all — affiliation filter. Echoed as data.type. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 100). Billed per result. |
| cursor | string | Opaque cursor from a previous nextCursor (GitHub Link page=). Not a bare page number. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| username * | string | GitHub username or profile URL, e.g. torvalds. |
| direction | string | asc or desc (default desc). Echoed as data.direction. |
{
"name": "github_repositories",
"description": "Default ~4 credits (limit 10; 0.4/result). List a user's repos with sort/direction/type — opaque Link cursor (~0.4/repo). Costs ~4 credits (0.4/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"username"
],
"properties": {
"sort": {
"type": "string",
"description": "created | updated | pushed | full_name (default updated). Not stars — GitHub's user-repos API has no stars sort. Echoed as data.sort."
},
"type": {
"type": "string",
"description": "owner (default) | member | all — affiliation filter. Echoed as data.type."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 100). Billed per result."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from a previous nextCursor (GitHub Link page=). Not a bare page number."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"username": {
"type": "string",
"description": "GitHub username or profile URL, e.g. torvalds."
},
"direction": {
"type": "string",
"description": "asc or desc (default desc). Echoed as data.direction."
}
},
"additionalProperties": false
}
}Default ~4 credits (limit 10; 0.4/result). List repo PRs — draft, labels, author{}, head/base, opaque Link cursor (state echoed). Costs ~4 credits (0.4/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| repo * | string | Repository URL or owner/name, e.g. vercel/next.js. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 100). Billed per result. |
| state | string | open (API default), closed, or all. Echoed as data.state. Docs example uses closed so mergedAt is visible. |
| cursor | string | Opaque cursor from a previous nextCursor (GitHub Link page=). Not a bare page number. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "github_pull_requests",
"description": "Default ~4 credits (limit 10; 0.4/result). List repo PRs — draft, labels, author{}, head/base, opaque Link cursor (state echoed). Costs ~4 credits (0.4/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"repo"
],
"properties": {
"repo": {
"type": "string",
"description": "Repository URL or owner/name, e.g. vercel/next.js."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 100). Billed per result."
},
"state": {
"type": "string",
"description": "open (API default), closed, or all. Echoed as data.state. Docs example uses closed so mergedAt is visible."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from a previous nextCursor (GitHub Link page=). Not a bare page number."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~4 credits (limit 10; 0.4/result). Public events with typed payload (Push commits/ref, PR/issue action) — 90-event ceiling. Costs ~4 credits (0.4/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 10, max 90). Billed per result. |
| cursor | string | Opaque cursor from a previous nextCursor. Pagination stops after GitHub's 90-event public activity ceiling. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| username * | string | GitHub username or profile URL, e.g. getify. |
{
"name": "github_activity",
"description": "Default ~4 credits (limit 10; 0.4/result). Public events with typed payload (Push commits/ref, PR/issue action) — 90-event ceiling. Costs ~4 credits (0.4/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"username"
],
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 10, max 90). Billed per result."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from a previous nextCursor. Pagination stops after GitHub's 90-event public activity ceiling."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"username": {
"type": "string",
"description": "GitHub username or profile URL, e.g. getify."
}
},
"additionalProperties": false
}
}Default ~3 credits (limit 30; 0.1/result). Follower cards {id, login, type, url, avatar} — ~0.1/row; large accounts are expensive to page fully. Costs ~3 credits (0.1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 30, max 100). Billed per result. |
| cursor | string | Opaque cursor from a previous nextCursor (GitHub Link page=). Not a bare page number. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| username * | string | GitHub username or profile URL, e.g. getify. |
{
"name": "github_followers",
"description": "Default ~3 credits (limit 30; 0.1/result). Follower cards {id, login, type, url, avatar} — ~0.1/row; large accounts are expensive to page fully. Costs ~3 credits (0.1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"username"
],
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 30, max 100). Billed per result."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from a previous nextCursor (GitHub Link page=). Not a bare page number."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"username": {
"type": "string",
"description": "GitHub username or profile URL, e.g. getify."
}
},
"additionalProperties": false
}
}Default ~3 credits (limit 30; 0.1/result). Accounts a user follows — same card and ~0.1/row pricing as followers. Costs ~3 credits (0.1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 30, max 100). Billed per result. |
| cursor | string | Opaque cursor from a previous nextCursor (GitHub Link page=). Not a bare page number. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| username * | string | GitHub username or profile URL, e.g. getify. |
{
"name": "github_following",
"description": "Default ~3 credits (limit 30; 0.1/result). Accounts a user follows — same card and ~0.1/row pricing as followers. Costs ~3 credits (0.1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"username"
],
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 30, max 100). Billed per result."
},
"cursor": {
"type": "string",
"description": "Opaque cursor from a previous nextCursor (GitHub Link page=). Not a bare page number."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"username": {
"type": "string",
"description": "GitHub username or profile URL, e.g. getify."
}
},
"additionalProperties": false
}
}GitHub contribution graph — sorted days[], currentStreak (today grace), longestStreak (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| username * | string | GitHub username or profile URL, e.g. getify or https://github.com/getify. |
{
"name": "github_contributions",
"description": "GitHub contribution graph — sorted days[], currentStreak (today grace), longestStreak (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"username"
],
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"username": {
"type": "string",
"description": "GitHub username or profile URL, e.g. getify or https://github.com/getify."
}
},
"additionalProperties": false
}
}GitHub repo — stars, real watchers (subscribers), openIssuesAndPrs, license, parent when fork (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| repo * | string | Repository URL or owner/name, e.g. torvalds/linux or https://github.com/torvalds/linux. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "github_repository",
"description": "GitHub repo — stars, real watchers (subscribers), openIssuesAndPrs, license, parent when fork (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"repo"
],
"properties": {
"repo": {
"type": "string",
"description": "Repository URL or owner/name, e.g. torvalds/linux or https://github.com/torvalds/linux."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}github.com/trending — repos ranked by starsGained (daily|weekly|monthly), not all-time stars (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 25, max 100). Flat 2 credits per call. |
| since | string | Trending window: daily (default), weekly, or monthly — matches github.com/trending?since=. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | Optional programming-language slug (e.g. python, typescript) → /trending/{language}. |
{
"name": "github_trending_repositories",
"description": "github.com/trending — repos ranked by starsGained (daily|weekly|monthly), not all-time stars (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 25, max 100). Flat 2 credits per call."
},
"since": {
"type": "string",
"description": "Trending window: daily (default), weekly, or monthly — matches github.com/trending?since=."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Optional programming-language slug (e.g. python, typescript) → /trending/{language}."
}
},
"additionalProperties": false
}
}github.com/trending/developers — windowed ranks with popularRepo + followers (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 25, max 100). Flat 2 credits per call. |
| since | string | Trending window: daily (default), weekly, or monthly — matches github.com/trending/developers?since=. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | Optional programming-language slug → /trending/developers/{language}. |
{
"name": "github_trending_developers",
"description": "github.com/trending/developers — windowed ranks with popularRepo + followers (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 25, max 100). Flat 2 credits per call."
},
"since": {
"type": "string",
"description": "Trending window: daily (default), weekly, or monthly — matches github.com/trending/developers?since=."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Optional programming-language slug → /trending/developers/{language}."
}
},
"additionalProperties": false
}
}Twitch channel — handle + displayName, socials[], topClips, schedule preview, stream only when live (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Twitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "twitch_profile",
"description": "Twitch channel — handle + displayName, socials[], topClips, schedule preview, stream only when live (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Twitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Twitch channel VODs — lean rows, video-id cursor, filter/sort, top-level broadcaster{} (flat 2). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Twitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 100). Flat 2 credits per call. Hard ceiling: first 100 matching videos only — deeper history is not available (windowMax=100). |
| cursor | string | Pagination cursor = last video id from the previous nextCursor. Leave empty for the first page. Pages the first 100 matching videos only (not a raw offset). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| sortBy | string | TIME (default, newest first) or VIEWS. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| filterBy | string | ARCHIVE | HIGHLIGHT | UPLOAD. Omit for all types — there is no default filter (unset filterBy is omitted, not null). |
{
"name": "twitch_user_videos",
"description": "Twitch channel VODs — lean rows, video-id cursor, filter/sort, top-level broadcaster{} (flat 2). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Twitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 100). Flat 2 credits per call. Hard ceiling: first 100 matching videos only — deeper history is not available (windowMax=100)."
},
"cursor": {
"type": "string",
"description": "Pagination cursor = last video id from the previous nextCursor. Leave empty for the first page. Pages the first 100 matching videos only (not a raw offset)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"sortBy": {
"type": "string",
"description": "TIME (default, newest first) or VIEWS."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"filterBy": {
"type": "string",
"description": "ARCHIVE | HIGHLIGHT | UPLOAD. Omit for all types — there is no default filter (unset filterBy is omitted, not null)."
}
},
"additionalProperties": false
}
}Twitch channel schedule — startAt/endAt, title, game, isRecurring (0 credits when empty). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Twitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max schedule segments to return (default 50, max 100). Flat 1 credit per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "twitch_user_schedule",
"description": "Twitch channel schedule — startAt/endAt, title, game, isRecurring (0 credits when empty). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Twitch channel URL or username, e.g. https://www.twitch.tv/shroud. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max schedule segments to return (default 50, max 100). Flat 1 credit per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Twitch clip — curator vs channel, signedVideoUrl, unwrapped token, relatedClips (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Twitch clip URL (clips.twitch.tv/<slug> or twitch.tv/<channel>/clip/<slug>). The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "twitch_clip",
"description": "Twitch clip — curator vs channel, signedVideoUrl, unwrapped token, relatedClips (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Twitch clip URL (clips.twitch.tv/<slug> or twitch.tv/<channel>/clip/<slug>). The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Spotify artist — followers, monthlyListeners, worldRank, topCities, topTracks with playCount, concerts, and related artists (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| raw | boolean | Include the upstream GraphQL payload as data.raw. Default false — omit unless you need fields not in the normalized shape (~80% of the old response body). |
| url * | string | Spotify URL, URI, or ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "spotify_artist",
"description": "Spotify artist — followers, monthlyListeners, worldRank, topCities, topTracks with playCount, concerts, and related artists (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"raw": {
"type": "boolean",
"description": "Include the upstream GraphQL payload as data.raw. Default false — omit unless you need fields not in the normalized shape (~80% of the old response body)."
},
"url": {
"type": "string",
"description": "Spotify URL, URI, or ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Spotify track — playCount, joinable artists[]/album{}, explicit, releaseDate (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| raw | boolean | Include the upstream GraphQL payload as data.raw. Default false — getTrack embeds bulky artist discography. |
| url * | string | Spotify URL, URI, or ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "spotify_track",
"description": "Spotify track — playCount, joinable artists[]/album{}, explicit, releaseDate (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"raw": {
"type": "boolean",
"description": "Include the upstream GraphQL payload as data.raw. Default false — getTrack embeds bulky artist discography."
},
"url": {
"type": "string",
"description": "Spotify URL, URI, or ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Spotify album — tracks[] with playCount, joinable artists[], releaseDate, explicit (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| raw | boolean | Include the upstream GraphQL payload as data.raw. Default false — omit unless you need fields not in the normalized shape. |
| url * | string | Spotify URL, URI, or ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "spotify_album",
"description": "Spotify album — tracks[] with playCount, joinable artists[], releaseDate, explicit (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"raw": {
"type": "boolean",
"description": "Include the upstream GraphQL payload as data.raw. Default false — omit unless you need fields not in the normalized shape."
},
"url": {
"type": "string",
"description": "Spotify URL, URI, or ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Search Spotify — canonical spotify: URIs, explicit, fetchedAt (flat 2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Search term (min 2 chars). |
| raw | boolean | Include per-result upstream payload as results[].raw. Default false. Pathfinder GraphQL vs fallback-path shapes differ — see FAQ. |
| type | string | Result kind: tracks (default), albums, artists, podcasts, or episodes. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 50). Flat 2 credits per call. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "spotify_search",
"description": "Search Spotify — canonical spotify: URIs, explicit, fetchedAt (flat 2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Search term (min 2 chars)."
},
"raw": {
"type": "boolean",
"description": "Include per-result upstream payload as results[].raw. Default false. Pathfinder GraphQL vs fallback-path shapes differ — see FAQ."
},
"type": {
"type": "string",
"description": "Result kind: tracks (default), albums, artists, podcasts, or episodes."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 50). Flat 2 credits per call."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Spotify podcast show — publisher, rating, topics, explicit flag, and totalEpisodes as clean JSON. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Spotify show/podcast URL, URI, or ID (e.g. https://open.spotify.com/show/…). Not an artist URL. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "spotify_podcast",
"description": "Spotify podcast show — publisher, rating, topics, explicit flag, and totalEpisodes as clean JSON. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Spotify show/podcast URL, URI, or ID (e.g. https://open.spotify.com/show/…). Not an artist URL."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Podcast episode archive — previewUrl, releaseDate, explicit, cursor pagination (flat 2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| raw | boolean | Include slimmed per-episode upstream payload as episodes[].raw. Default false. visualIdentity / playedState / podcastV2 are never included. |
| url * | string | Spotify show/podcast URL, URI, or ID (e.g. https://open.spotify.com/show/…). Not an artist URL. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 50). Flat 2 credits per call. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "spotify_podcast_episodes",
"description": "Podcast episode archive — previewUrl, releaseDate, explicit, cursor pagination (flat 2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"raw": {
"type": "boolean",
"description": "Include slimmed per-episode upstream payload as episodes[].raw. Default false. visualIdentity / playedState / podcastV2 are never included."
},
"url": {
"type": "string",
"description": "Spotify show/podcast URL, URI, or ID (e.g. https://open.spotify.com/show/…). Not an artist URL."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 50). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}SoundCloud artist — handle + name, subscriptionTier, externalLinks, verified (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | SoundCloud artist profile URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "soundcloud_artist",
"description": "SoundCloud artist — handle + name, subscriptionTier, externalLinks, verified (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "SoundCloud artist profile URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Artist track list — opaque cursor, native-window when the api-v2 page ends (2 credits; empty is 0). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | SoundCloud artist profile URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max items to return (default 20, max 100). Flat 2 credits per call. |
| cursor | string | Opaque pagination cursor from the previous nextCursor. Leave empty for the first page. Do not edit or invent values. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "soundcloud_artist_tracks",
"description": "Artist track list — opaque cursor, native-window when the api-v2 page ends (2 credits; empty is 0). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "SoundCloud artist profile URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max items to return (default 20, max 100). Flat 2 credits per call."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor from the previous nextCursor. Leave empty for the first page. Do not edit or invent values."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}SoundCloud track — plays/likes/license, tags[], nested artist{}, streamUrl when streamable (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | SoundCloud track URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "soundcloud_track",
"description": "SoundCloud track — plays/likes/license, tags[], nested artist{}, streamUrl when streamable (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "SoundCloud track URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Link-in-bio → creator graph: typed links, socialAccounts{} that feed TikTok/Instagram/Spotify/SoundCloud, email, verticals. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Linktree profile URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "linktree_page",
"description": "Link-in-bio → creator graph: typed links, socialAccounts{} that feed TikTok/Instagram/Spotify/SoundCloud, email, verticals. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Linktree profile URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Snapchat profile — stable identity card, millisecond timestamps, mediaType image/video (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Snapchat username or profile URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "snapchat_user_profile",
"description": "Snapchat profile — stable identity card, millisecond timestamps, mediaType image/video (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Snapchat username or profile URL. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Prominent public Truth Social profiles — isPrivate/bot/group, CP-F counts, avatar/banner. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Truth Social profile URL or @username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "truth_social_profile",
"description": "Prominent public Truth Social profiles — isPrivate/bot/group, CP-F counts, avatar/banner. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Truth Social profile URL or @username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Recent Truths — same post mapper as /post (links, card, reblog/quote, mentions). 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Truth Social profile URL or @username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max posts to return (default 20, max 80). Truth Social's statuses page is ~20 items — a full page returns nextCursor. On the extended path hasMore can be true with nextCursor null (truncatedReason=single_page_only). Flat 2 credits. |
| cursor | string | Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "truth_social_user_posts",
"description": "Recent Truths — same post mapper as /post (links, card, reblog/quote, mentions). 2 credits. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Truth Social profile URL or @username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max posts to return (default 20, max 80). Truth Social's statuses page is ~20 items — a full page returns nextCursor. On the extended path hasMore can be true with nextCursor null (truncatedReason=single_page_only). Flat 2 credits."
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Leave empty for the first page; then pass the nextCursor value returned in the previous response."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}One Truth — text, links[], card, reblog/quote chain, media.meta, externalVideoId. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Truth Social post URL or post ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "truth_social_post",
"description": "One Truth — text, links[], card, reblog/quote chain, media.meta, externalVideoId. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Truth Social post URL or post ID. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Get a Kick clip, or a channel's recent clips — 7d clip cache. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Kick clip URL for one enriched clip (e.g. https://kick.com/{channel}/clips/clip_…), or channel input for recent clips[]: kick.com/{name}, kick.com/@{name}, @{name}, or {name}. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to … |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| limit | integer | Channel mode only — max recent clips to return (default 20, max 100). Ignored when url is a clip. Flat 1 credit. No cursor — one response holds up to limit clips. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "kick_clip",
"description": "Get a Kick clip, or a channel's recent clips — 7d clip cache. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Kick clip URL for one enriched clip (e.g. https://kick.com/{channel}/clips/clip_…), or channel input for recent clips[]: kick.com/{name}, kick.com/@{name}, @{name}, or {name}. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Channel mode only — max recent clips to return (default 20, max 100). Ignored when url is a clip. Flat 1 credit. No cursor — one response holds up to limit clips."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Plan, subscription vs top-up credits, monthly quota, and renewsAt — 0 credits. Costs 0 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "account_balance",
"description": "Plan, subscription vs top-up credits, monthly quota, and renewsAt — 0 credits. Costs 0 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Recent API requests for your key — requestId, status, credits, cacheHit (0 credits). Costs 0 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Max rows to return (default 50, max 500). Free — does not consume credits. |
| since | string | Inclusive lower bound on createdAt (ISO date or datetime). |
| until | string | Exclusive upper bound on createdAt (ISO date or datetime). |
| cursor | string | Pagination cursor from nextCursor (createdAt of the last row). Leave empty for the first page. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| endpoint | string | Exact Captapi path filter, e.g. /v1/instagram/basic-profile. |
| statusCode | integer | Filter by HTTP status code (e.g. 500). |
{
"name": "account_request_history",
"description": "Recent API requests for your key — requestId, status, credits, cacheHit (0 credits). Costs 0 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max rows to return (default 50, max 500). Free — does not consume credits."
},
"since": {
"type": "string",
"description": "Inclusive lower bound on createdAt (ISO date or datetime)."
},
"until": {
"type": "string",
"description": "Exclusive upper bound on createdAt (ISO date or datetime)."
},
"cursor": {
"type": "string",
"description": "Pagination cursor from nextCursor (createdAt of the last row). Leave empty for the first page."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"endpoint": {
"type": "string",
"description": "Exact Captapi path filter, e.g. /v1/instagram/basic-profile."
},
"statusCode": {
"type": "integer",
"minimum": 1,
"description": "Filter by HTTP status code (e.g. 500)."
}
},
"additionalProperties": false
}
}Day-by-day credit usage for spend monitoring (0 credits). Costs 0 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| days | integer | Number of days to include (default 30, max 365). |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "account_daily_usage",
"description": "Day-by-day credit usage for spend monitoring (0 credits). Costs 0 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"days": {
"type": "integer",
"minimum": 1,
"description": "Number of days to include (default 30, max 365)."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Ranked list of which Captapi routes your key calls most (0 credits). Costs 0 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| days | integer | Number of days to include (default 30, max 365). |
| limit | integer | Max rows to return (default 20, max 100). Free — does not consume credits. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "account_most_used_routes",
"description": "Ranked list of which Captapi routes your key calls most (0 credits). Costs 0 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"properties": {
"days": {
"type": "integer",
"minimum": 1,
"description": "Number of days to include (default 30, max 365)."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max rows to return (default 20, max 100). Free — does not consume credits."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Unified metrics for one post, video, or reel — platform auto-detected (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Public post/video/reel URL from one of 11 platforms: YouTube, TikTok, Instagram, Facebook, X, Reddit, Threads, Bluesky, Pinterest, LinkedIn, or Rumble. Platform is auto-detected — cross-platform URLs are expected here (unlike single-platform endpoints). Not in scope: Kwai, Twitch, Spotify, Snapchat,… |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "analytics_post",
"description": "Unified metrics for one post, video, or reel — platform auto-detected (1 credit). Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Public post/video/reel URL from one of 11 platforms: YouTube, TikTok, Instagram, Facebook, X, Reddit, Threads, Bluesky, Pinterest, LinkedIn, or Rumble. Platform is auto-detected — cross-platform URLs are expected here (unlike single-platform endpoints). Not in scope: Kwai, Twitch, Spotify, Snapchat, and other Captapi platforms."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Compare unified metrics across up to 10 URLs — each row is the analytics/post object (1 credit/resolved URL). Costs 1 credit/url. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| urls * | string | Comma-separated post/video/reel URLs (up to 10), any mix of the same 11 platforms as Post Analytics. Example: a TikTok URL and a YouTube URL in one call. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "analytics_compare",
"description": "Compare unified metrics across up to 10 URLs — each row is the analytics/post object (1 credit/resolved URL). Costs 1 credit/url. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"urls"
],
"properties": {
"urls": {
"type": "string",
"description": "Comma-separated post/video/reel URLs (up to 10), any mix of the same 11 platforms as Post Analytics. Example: a TikTok URL and a YouTube URL in one call."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}AI transcription of an uploaded file — 1 credit/min; noSpeech=true and 0 credits when there is no speech. Costs 1 credit/min. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| file * | string | Video or audio file (multipart form field — use -F file=@path, not a query string). Max 200MB / 60 minutes. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | ISO-639-1 language hint, e.g. "en" or "tr". Omit to auto-detect. |
| translate | boolean | When true, translate speech to English. Default false. |
| timestampGranularity | string | segment (default) or word — word-level timings when the transcription model exposes them. |
{
"name": "video_transcript",
"description": "AI transcription of an uploaded file — 1 credit/min; noSpeech=true and 0 credits when there is no speech. Costs 1 credit/min. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"description": "Video or audio file (multipart form field — use -F file=@path, not a query string). Max 200MB / 60 minutes."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "ISO-639-1 language hint, e.g. \"en\" or \"tr\". Omit to auto-detect."
},
"translate": {
"type": "boolean",
"description": "When true, translate speech to English. Default false."
},
"timestampGranularity": {
"type": "string",
"description": "segment (default) or word — word-level timings when the transcription model exposes them."
}
},
"additionalProperties": false
}
}AI transcription + summary of an uploaded file — transcript included; 1 credit/min + 1. Costs 1 credit/min +1. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| file * | string | Video or audio file (multipart form field — use -F file=@path, not a query string). Max 200MB / 60 minutes. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | ISO-639-1 language hint, e.g. "en" or "tr". Omit to auto-detect. |
| translate | boolean | When true, translate speech to English before summarizing. Default false. |
| timestampGranularity | string | segment (default) or word. |
{
"name": "video_summarize",
"description": "AI transcription + summary of an uploaded file — transcript included; 1 credit/min + 1. Costs 1 credit/min +1. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"description": "Video or audio file (multipart form field — use -F file=@path, not a query string). Max 200MB / 60 minutes."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "ISO-639-1 language hint, e.g. \"en\" or \"tr\". Omit to auto-detect."
},
"translate": {
"type": "boolean",
"description": "When true, translate speech to English before summarizing. Default false."
},
"timestampGranularity": {
"type": "string",
"description": "segment (default) or word."
}
},
"additionalProperties": false
}
}Fetch Kwai profile — display name, bio, counts, and verification as structured JSON. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Kwai profile URL or @handle, e.g. https://www.kwai.com/@topfilmeseseriesnatv. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "kwai_profile",
"description": "Fetch Kwai profile — display name, bio, counts, and verification as structured JSON. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Kwai profile URL or @handle, e.g. https://www.kwai.com/@topfilmeseseriesnatv. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Default ~10 credits (limit 10; 1/result). Kwai profile posts — caption ("" when none), engagement, mp4 + transcript (~1 credit/post). Costs ~10 credits (1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Kwai profile URL or @handle, e.g. https://www.kwai.com/@topfilmeseseriesnatv. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max posts to return (1–200). Default 10. ~1 credit per post returned (min 2). |
| cursor | string | Opaque pagination cursor from the previous nextCursor. Pages within posts from one profile fetch. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "kwai_user_posts",
"description": "Default ~10 credits (limit 10; 1/result). Kwai profile posts — caption (\"\" when none), engagement, mp4 + transcript (~1 credit/post). Costs ~10 credits (1/result). Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Kwai profile URL or @handle, e.g. https://www.kwai.com/@topfilmeseseriesnatv. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max posts to return (1–200). Default 10. ~1 credit per post returned (min 2)."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor from the previous nextCursor. Pages within posts from one profile fetch."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Single Kwai video — caption ("" when none), hashtags[], author, mp4 (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Kwai video URL, e.g. https://www.kwai.com/@topfilmeseseriesnatv/video/5240932700689736196. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "kwai_post",
"description": "Single Kwai video — caption (\"\" when none), hashtags[], author, mp4 (2 credits). Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Kwai video URL, e.g. https://www.kwai.com/@topfilmeseseriesnatv/video/5240932700689736196. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Komi link-in-bio → identity, socials{} (incl. website), content LINK/PRODUCT rows with price/currency. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Komi page URL or username, e.g. https://komi.io/kimkardashian or https://kimkardashian.komi.io/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "komi_page",
"description": "Komi link-in-bio → identity, socials{} (incl. website), content LINK/PRODUCT rows with price/currency. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Komi page URL or username, e.g. https://komi.io/kimkardashian or https://kimkardashian.komi.io/. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Pillar link-in-bio → identity, socials{}, links[] with per-link clicks, products[]. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Pillar page URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "pillar_page",
"description": "Pillar link-in-bio → identity, socials{}, links[] with per-link clicks, products[]. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Pillar page URL or username. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}lnk.bio → id, socials{}, titled links[], website/email/whatsapp, other[]. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Linkbio (lnk.bio) page URL or username, e.g. https://lnk.bio/charlidamelio. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "linkbio_page",
"description": "lnk.bio → id, socials{}, titled links[], website/email/whatsapp, other[]. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Linkbio (lnk.bio) page URL or username, e.g. https://lnk.bio/charlidamelio. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Linkme profile → bio, profileVisitCount, featured links, webLinks, email/infoLinks, stripeStatus. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Linkme profile URL or username, e.g. https://link.me/danucd or danucd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble. |
| cache | boolean | Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| cacheMaxAge | string | Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL. |
{
"name": "linkme_profile",
"description": "Linkme profile → bio, profileVisitCount, featured links, webLinks, email/infoLinks, stripeStatus. Flat 1 credit. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Linkme profile URL or username, e.g. https://link.me/danucd or danucd. The URL platform must match this endpoint's platform. Do not pass cross-platform URLs, e.g. YouTube to TikTok, Instagram to Facebook, LinkedIn to X/Twitter, or Pinterest to Rumble."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the response cache (default TTL). Default false — always fetch fresh. Prefer cacheMaxAge when you need 1d–30d freshness control."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"cacheMaxAge": {
"type": "string",
"description": "Max age of a cached response: 1d, 3d, 7d, 14d, or 30d. When set, enables caching with that TTL."
}
},
"additionalProperties": false
}
}Local businesses from a Maps search — name, address, phone, website, rating, hours, place id. Flat 2 credits. Add enrich=contacts for role emails and socials from each website. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| q * | string | Keyword, for example plumber or coffee. Min 2 characters. |
| cache | boolean | Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh. |
| limit | integer | Max businesses to return (default 20, max 100). Not a page cursor — there is no next page. Flat 2 credits per call; zero businesses is 0 credits. |
| enrich | string | Set to contacts to add a contacts object (role emails, E.164 phones, social profiles, contactPageUrl, blockedByRobots) to each business that has a website. limit is at most 50 with enrich=contacts. +1 credit per distinct domain where contacts are found; 0 for the rest. Omit for the plain search. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
| language | string | Language code, for example en. Default en. |
| location | string | Place name: City, Country or City, Region, Country — for example Austin, TX, Istanbul, Turkey, Paris, France, or a country such as Germany. Case, accents, US state codes, and country aliases (USA, UK, Turkey) are handled. A city name shared by several places (Paris) returns 400 with suggestions. Whe… |
| locationCode | integer | Numeric place code, used only when location is omitted. Default 2840 (United States). |
{
"name": "google_maps_business_search",
"description": "Local businesses from a Maps search — name, address, phone, website, rating, hours, place id. Flat 2 credits. Add enrich=contacts for role emails and socials from each website. Costs 2 credits. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string",
"description": "Keyword, for example plumber or coffee. Min 2 characters."
},
"cache": {
"type": "boolean",
"description": "Set true to serve from the 24h response cache (0 credits on hit). Default false — always fetch fresh."
},
"limit": {
"type": "integer",
"minimum": 1,
"description": "Max businesses to return (default 20, max 100). Not a page cursor — there is no next page. Flat 2 credits per call; zero businesses is 0 credits."
},
"enrich": {
"type": "string",
"description": "Set to contacts to add a contacts object (role emails, E.164 phones, social profiles, contactPageUrl, blockedByRobots) to each business that has a website. limit is at most 50 with enrich=contacts. +1 credit per distinct domain where contacts are found; 0 for the rest. Omit for the plain search."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
},
"language": {
"type": "string",
"description": "Language code, for example en. Default en."
},
"location": {
"type": "string",
"description": "Place name: City, Country or City, Region, Country — for example Austin, TX, Istanbul, Turkey, Paris, France, or a country such as Germany. Case, accents, US state codes, and country aliases (USA, UK, Turkey) are handled. A city name shared by several places (Paris) returns 400 with suggestions. When set, the locationCode parameter is ignored."
},
"locationCode": {
"type": "integer",
"minimum": 1,
"description": "Numeric place code, used only when location is omitted. Default 2840 (United States)."
}
},
"additionalProperties": false
}
}Business website → role emails, E.164 phones, social profiles. 1 credit when something is found, 0 when not. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).
| Parameter | Type | Description |
|---|---|---|
| url * | string | Business website or bare domain, for example https://atxfamilydental.com or atxfamilydental.com (https:// is added). Social profile URLs are not accepted here. |
| cache | boolean | Set true to use the 24h cache (0 credits on hit). Default false. |
| fields | string | Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price. |
| compact | boolean | Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body. |
{
"name": "website_contacts",
"description": "Business website → role emails, E.164 phones, social profiles. 1 credit when something is found, 0 when not. Costs 1 credit. Empty results and failures are never charged. Pass cache=true for a free 24h cache hit (default always fresh).",
"inputSchema": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "Business website or bare domain, for example https://atxfamilydental.com or atxfamilydental.com (https:// is added). Social profile URLs are not accepted here."
},
"cache": {
"type": "boolean",
"description": "Set true to use the 24h cache (0 credits on hit). Default false."
},
"fields": {
"type": "string",
"description": "Optional comma-separated keys to keep on each result row (or on the object for single-item tools), e.g. id,url,publishedAt,engagement. Pagination keys are always kept. Does not change the price."
},
"compact": {
"type": "boolean",
"default": true,
"description": "Default true here: drop signed media URLs (video, image, avatar links and their expiry stamps) to keep the response small. Ids, permalinks, dates, text and metrics stay. On Threads, Facebook, Meta Ad Library and TikTok Shop tools request timings are dropped too. Pass false for the full body."
}
},
"additionalProperties": false
}
}Captapi exposes structured data from 32 platforms — YouTube, TikTok, Instagram, Facebook, X/Twitter, Reddit, Threads, Bluesky, Pinterest, LinkedIn, Rumble, Twitch, Spotify, GitHub, TikTok Shop, ad libraries, link-in-bio pages and more (179 tools: transcripts, AI summaries, comments, stats, search). Authenticate by sending your Captapi API key in the 'Authorization: Bearer capt_live_...' header, or sign in with OAuth when your client asks. Create a key at https://captapi.com/dashboard/api-keys. Each tool maps 1:1 to a REST endpoint and costs credits (cached results are free, failed calls are never charged).
Names, descriptions and schemas were written by the server and are shown as data.
Shared addresses on big platforms (Cloudflare, Vercel and the like) put unrelated servers together; those are marked shared_infrastructure. A match is a pivot, not a link between operators.