socialscrape-haystack 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,198 @@
1
+ {
2
+ "common": [{"description": "Smaller response: drops null fields and `extra`.", "name": "trim", "required": false, "type": "boolean"}, {"description": "Also return the platform's original object as `raw`.", "name": "raw", "required": false, "type": "boolean"}, {"description": "Serve a cached result fetched within this many days, for 0 credits. ScrapeCreators' `cache_max_age=7d` spelling is accepted too.", "maximum": 30, "minimum": 0, "name": "max_age_days", "required": false, "type": "number"}],
3
+ "endpoints": [
4
+ {"common": true, "credits": "1 credit", "description": "Name, avatar, subscribers, video and view counts, join date, country and linked links. Pass a `handle`, an `id` (channelId) or a channel `url`.", "example": {"handle": "NASA"}, "id": "youtube.channel", "one_of": [["handle", "id", "url"]], "paginated": false, "params": [{"description": "A handle (with or without @), a channel URL (youtube.com/@<name>, /channel/UC..., /c/<name>) or a UC channel id.", "name": "handle", "required": false, "type": "string"}, {"description": "Channel id (UC...).", "name": "id", "required": false, "type": "string"}, {"description": "Any channel URL (/@handle, /channel/UC..., /c/name).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}], "path": "/v1/youtube/channel", "platform": "youtube", "response": "Profile", "summary": "YouTube channel details", "title": "YouTube"},
5
+ {"common": true, "credits": "1 credit", "description": "A channel's uploads, newest first or most popular. Page with `cursor` (the continuationToken). The tab prints rounded views and \"9 days ago\" (both listed in `approximate`); `include_extras` swaps in exact views, likes, description and publish time, one extra request per video (about 2 s more a page).", "example": {"handle": "MrBeast", "sort": "popular"}, "id": "youtube.channel.videos", "one_of": [["handle", "id", "url"]], "paginated": true, "params": [{"description": "A handle (with or without @), a channel URL (youtube.com/@<name>, /channel/UC..., /c/<name>) or a UC channel id.", "name": "handle", "required": false, "type": "string"}, {"description": "Channel id (UC...).", "name": "id", "required": false, "type": "string"}, {"description": "Any channel URL (/@handle, /channel/UC..., /c/name).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"default": "latest", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["latest", "popular"], "name": "sort", "required": false, "type": "string"}, {"description": "Also fetch exact views, likes, description and publish time per video (slower, more errors). Comment counts come from the video endpoint.", "name": "include_extras", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/channel/videos", "platform": "youtube", "response": "ListPage[Post]", "summary": "YouTube channel videos", "title": "YouTube"},
6
+ {"common": true, "credits": "1 credit", "description": "YouTube's own channel search: videos, Shorts, lives and playlists of one channel that match `query`. Keep the same channel and query while paging.", "example": {"handle": "NASA", "query": "artemis"}, "id": "youtube.channel.search", "one_of": [["handle", "id", "url"]], "paginated": true, "params": [{"description": "A handle (with or without @), a channel URL (youtube.com/@<name>, /channel/UC..., /c/<name>) or a UC channel id.", "name": "handle", "required": false, "type": "string"}, {"description": "Channel id (UC...).", "name": "id", "required": false, "type": "string"}, {"description": "Any channel URL (/@handle, /channel/UC..., /c/name).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"description": "Keywords to search for inside the channel.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/channel/search", "platform": "youtube", "response": "ListPage[Post | Profile | Collection | Community]", "summary": "Search inside a YouTube channel", "title": "YouTube"},
7
+ {"common": true, "credits": "1 credit", "description": "Playlists from a channel's Playlists tab: id, title, thumbnail, video count and URL.", "example": {"handle": "NASA"}, "id": "youtube.channel.playlists", "one_of": [["handle", "id", "url"]], "paginated": true, "params": [{"description": "A handle (with or without @), a channel URL (youtube.com/@<name>, /channel/UC..., /c/<name>) or a UC channel id.", "name": "handle", "required": false, "type": "string"}, {"description": "Channel id (UC...).", "name": "id", "required": false, "type": "string"}, {"description": "Any channel URL (/@handle, /channel/UC..., /c/name).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/channel/playlists", "platform": "youtube", "response": "ListPage[Collection]", "summary": "YouTube channel playlists", "title": "YouTube"},
8
+ {"common": true, "credits": "1 credit", "description": "A channel's Shorts, newest first or most popular: id, title and view count. YouTube's Shorts tab shows rounded views (`approximate` lists `stats.views`) and no length or date; `include_extras` adds exact views, length, publish date, likes and the description.", "example": {"handle": "NASA"}, "id": "youtube.channel.shorts", "one_of": [["handle", "id", "url"]], "paginated": true, "params": [{"description": "A handle (with or without @), a channel URL (youtube.com/@<name>, /channel/UC..., /c/<name>) or a UC channel id.", "name": "handle", "required": false, "type": "string"}, {"description": "Channel id (UC...).", "name": "id", "required": false, "type": "string"}, {"description": "Any channel URL (/@handle, /channel/UC..., /c/name).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"default": "latest", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["latest", "popular"], "name": "sort", "required": false, "type": "string"}, {"description": "Also fetch exact views, length, publish date, likes and description per Short (slower, more errors).", "name": "include_extras", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/channel/shorts", "platform": "youtube", "response": "ListPage[Post]", "summary": "YouTube channel Shorts", "title": "YouTube"},
9
+ {"common": true, "credits": "1 credit", "description": "Live and past streams from a channel's Live tab. For a stream that is on air now, `stats.views` is the number watching, as YouTube's tab prints it.", "example": {"handle": "NASA"}, "id": "youtube.channel.lives", "one_of": [["handle", "id", "url"]], "paginated": true, "params": [{"description": "A handle (with or without @), a channel URL (youtube.com/@<name>, /channel/UC..., /c/<name>) or a UC channel id.", "name": "handle", "required": false, "type": "string"}, {"description": "Channel id (UC...).", "name": "id", "required": false, "type": "string"}, {"description": "Any channel URL (/@handle, /channel/UC..., /c/name).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/channel/lives", "platform": "youtube", "response": "ListPage[Post]", "summary": "YouTube channel live streams", "title": "YouTube"},
10
+ {"common": true, "credits": "1 credit", "description": "Posts from a channel's Posts tab: text, images, an attached video, likes and publish time.", "example": {"cursor": "4qmFsgKBARIYVUNMQV9EaVIxRmZLTnZqdVVwQkhteWxRGkxFZ1Z3YjNOMGM2b0RLQW9rVVRKb1ExSkdVWGRVYTJ4UFlXMW9UMVZxUWxkVlZrVjNUVVJHVkdKVk5VUlNWVVpDS0FyeUJnUUtBa29BmgIWYmFja3N0YWdlLWl0ZW0tc2VjdGlvbg%3D%3D", "handle": "NASA"}, "id": "youtube.channel.community_posts", "one_of": [["handle", "id", "url"]], "paginated": true, "params": [{"description": "A handle (with or without @), a channel URL (youtube.com/@<name>, /channel/UC..., /c/<name>) or a UC channel id.", "name": "handle", "required": false, "type": "string"}, {"description": "Channel id (UC...).", "name": "id", "required": false, "type": "string"}, {"description": "Any channel URL (/@handle, /channel/UC..., /c/name).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/channel/community-posts", "platform": "youtube", "response": "ListPage[Post]", "summary": "YouTube channel community posts", "title": "YouTube"},
11
+ {"common": true, "credits": "1 credit", "description": "Title, description, stats, duration, channel, thumbnails, chapters, caption tracks, the most-replayed segments, the links in the description, up to 20 related videos, the note YouTube shows on altered or generated media (`extra.ai_disclosure`) and whether YouTube marks it as paid promotion (`is_sponsored`, null when YouTube's player could not be read for this request). Views, likes and the publish time are exact; the comment and subscriber counts are the abbreviated figures YouTube shows, with the display text in `extra`. Works for Shorts and lives.", "example": {"id": "QP5Fs3AYuWE"}, "id": "youtube.video", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Video or Short URL (watch, youtu.be, shorts, live, embed).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"description": "11-character video id.", "name": "id", "required": false, "type": "string"}, {"description": "Preferred response language, 2 letters (en, es, fr). Not guaranteed: YouTube localises on its own.", "name": "language", "required": false, "type": "string"}], "path": "/v1/youtube/video", "platform": "youtube", "response": "Post", "summary": "YouTube video or Short details", "title": "YouTube"},
12
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "The video's own captions: the language you ask for (or the original audio's), typed by the uploader or recognised by YouTube (`source`), with the languages on offer. A video without captions answers transcript_unavailable and costs nothing; AI transcription of YouTube audio is not available yet.", "example": {"id": "dQw4w9WgXcQ", "language": "de"}, "id": "youtube.video.transcript", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Video or Short URL (watch, youtu.be, shorts, live, embed).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"description": "11-character video id.", "name": "id", "required": false, "type": "string"}, {"description": "Language code (\"en\", \"es\", \"en-US\"). Overrides the default track unless `original_audio` is set.", "name": "language", "required": false, "type": "string"}, {"description": "Only return captions in the video's original spoken language. Takes precedence over `language`.", "name": "original_audio", "required": false, "type": "boolean"}], "path": "/v1/youtube/video/transcript", "platform": "youtube", "response": "Transcript", "summary": "YouTube video transcript", "title": "YouTube"},
13
+ {"common": true, "credits": "1 credit", "description": "Experimental. Whether the video discloses paid promotion, and the suspected sponsors with confidence and evidence in `extra`, inferred from the public description, its links, promo codes and the transcript. An inference, not a statement from YouTube; `parent` is the video.", "example": {"id": "JsBZOcqZerk"}, "id": "youtube.video.sponsors", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Video or Short URL (watch, youtu.be, shorts, live, embed).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"description": "11-character video id.", "name": "id", "required": false, "type": "string"}, {"description": "2-letter language used for the transcript lookup.", "name": "language", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/video/sponsors", "platform": "youtube", "response": "ListPage[Advertiser]", "summary": "YouTube video sponsors", "title": "YouTube"},
14
+ {"common": true, "credits": "1 credit", "description": "Videos, channels, playlists, Shorts and live streams for a query. Shorts and live results are Posts of type `short` and `live`. For stricter title matching use YouTube's `intitle:` operator.", "example": {"query": "lofi hip hop", "type": "playlist"}, "id": "youtube.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Kind of result.", "enum": ["video", "channel", "playlist", "short", "live"], "name": "type", "required": false, "type": "string"}, {"description": "Upload date filter.", "enum": ["hour", "today", "week", "month", "year"], "name": "upload_date", "required": false, "type": "string"}, {"description": "Video length (videos only, not Shorts).", "enum": ["short", "medium", "long"], "name": "duration", "required": false, "type": "string"}, {"default": "relevance", "description": "Order of results. YouTube now answers `latest` and `rating` in relevance order, so they are refused with invalid_params; use `relevance` or `popular` (view count) and narrow with `upload_date`.", "enum": ["relevance", "latest", "popular", "rating"], "name": "sort", "required": false, "type": "string"}, {"description": "Also fetch likes, comment count and description per video (slightly slower).", "name": "include_extras", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/youtube/search", "platform": "youtube", "response": "ListPage[Post | Profile | Collection | Community]", "summary": "YouTube search", "title": "YouTube"},
15
+ {"common": true, "credits": "1 credit", "description": "The live suggestions YouTube shows while a user types. Channel suggestions carry the channel id, handle, name and thumbnail.", "example": {"query": "mr beast"}, "id": "youtube.search.typeahead", "one_of": [], "paginated": true, "params": [{"description": "Partial or complete search text.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/search/typeahead", "platform": "youtube", "response": "ListPage[Suggestion]", "summary": "YouTube search suggestions", "title": "YouTube"},
16
+ {"common": true, "credits": "1 credit", "description": "Videos (or Shorts) on a hashtag's page. The `all` tab holds about 30 videos and usually no next page; the `short` tab pages with `cursor`.", "example": {"hashtag": "minecraft"}, "id": "youtube.search.hashtag", "one_of": [], "paginated": true, "params": [{"description": "Hashtag, with or without #.", "name": "hashtag", "required": true, "type": "string"}, {"description": "Kind of result.", "enum": ["all", "short"], "name": "type", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/search/hashtag", "platform": "youtube", "response": "ListPage[Post]", "summary": "YouTube videos by hashtag", "title": "YouTube"},
17
+ {"common": true, "credits": "1 credit", "description": "Comments (about 1,000 top or 7,000 newest at most). Page with `cursor`.", "example": {"id": "dQw4w9WgXcQ", "sort": "latest"}, "id": "youtube.video.comments", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Video or Short URL (watch, youtu.be, shorts, live, embed).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"description": "11-character video id.", "name": "id", "required": false, "type": "string"}, {"default": "top", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["top", "latest"], "name": "sort", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/video/comments", "platform": "youtube", "response": "ListPage[Comment]", "summary": "YouTube video comments", "title": "YouTube"},
18
+ {"common": true, "credits": "1 credit", "description": "Replies to one comment. Pass the comment's replies cursor from the comments list as `cursor` The cursor alone is enough (ScrapeCreators' `continuationToken`); the handler rejects a call with no cursor.", "example": {"comment_id": "UgwPwTibxdgqCHZxktd4AaABAg", "cursor": "Eg0SC2RRdzR3OVdnWGNRGAYygwEaUBIaVWd3UHdUaWJ4ZGdxQ0haeGt0ZDRBYUFCQWciAggAKhhVQ3VBWEZrZ3N3MUw3eGFDZm5kNUpKT3cyC2RRdzR3OVdnWGNRQAFICoIBAggBQi9jb21tZW50LXJlcGxpZXMtaXRlbS1VZ3dQd1RpYnhkZ3FDSFp4a3RkNEFhQUJBZw%3D%3D", "id": "dQw4w9WgXcQ"}, "id": "youtube.video.comment.replies", "one_of": [], "paginated": true, "params": [{"description": "Video or Short URL (watch, youtu.be, shorts, live, embed).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"description": "11-character video id.", "name": "id", "required": false, "type": "string"}, {"description": "Id of the parent comment.", "name": "comment_id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/video/comment/replies", "platform": "youtube", "response": "ListPage[Comment]", "summary": "YouTube comment replies", "title": "YouTube"},
19
+ {"common": true, "credits": "1 credit", "description": "YouTube has no trending page; this is the Shorts feed (50 Shorts a page, different on each call, not a ranked chart), each with its title, channel, counts and date. Page with `cursor` for more.", "example": {"region": "US"}, "id": "youtube.shorts.trending", "one_of": [], "paginated": true, "params": [{"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/youtube/shorts/trending", "platform": "youtube", "response": "ListPage[Post]", "summary": "Trending YouTube Shorts", "title": "YouTube"},
20
+ {"common": true, "credits": "1 credit", "description": "The playlist's videos; `parent` is the playlist itself.", "example": {"id": "PL2aBZuCeDwlTxZeGRlKrWpLiX_W7jpt6p"}, "id": "youtube.playlist", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Playlist URL (list=...).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": false, "type": "url"}, {"description": "Playlist id (PL..., UU..., OL...).", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/youtube/playlist", "platform": "youtube", "response": "ListPage[Post]", "summary": "YouTube playlist videos", "title": "YouTube"},
21
+ {"common": true, "credits": "1 credit", "description": "", "example": {"url": "https://www.youtube.com/post/Ugkx-7xgRw-Uc9lRS3_2RvS2zASPTZOFtIlw"}, "id": "youtube.community_post", "one_of": [], "paginated": false, "params": [{"description": "Community post URL (/post/Ug... or /channel/.../community?lb=...).", "hosts": ["youtube.com", "youtu.be"], "name": "url", "required": true, "type": "url"}], "path": "/v1/youtube/community-post", "platform": "youtube", "response": "Post", "summary": "YouTube community post", "title": "YouTube"},
22
+ {"common": true, "credits": "1 credit", "description": "Public profile of a TikTok account: name, bio, bio link, verification and exact counts. Pass `handle` or the numeric user id as `id` (a secUid cannot be looked up).", "example": {"handle": "khaby.lame"}, "id": "tiktok.profile", "one_of": [["handle", "id"]], "paginated": false, "params": [{"description": "A username (with or without @), a profile or video URL (tiktok.com/@<name>) or the numeric user id.", "name": "handle", "required": false, "type": "string"}, {"description": "Numeric TikTok user id (a secUid cannot be looked up).", "name": "id", "required": false, "type": "string"}], "path": "/v1/tiktok/profile", "platform": "tiktok", "response": "Profile", "summary": "TikTok profile", "title": "TikTok"},
23
+ {"common": true, "credits": "1 credit", "description": "The country TikTok recorded for an account's newest video, as a two-letter code in `location` and `extra.region`, with the account's name, avatar and counts. It describes that one video, not the account: it is not the country the account registered with and may not be where the person lives, and a creator who travels, or posts through a VPN, can show another country (`extra.region_source` is `newest_video`, `extra.region_video_id` names the video). If the newest video has no country the next two are tried. An account with no videos, or none that carries a country, answers `not_found`; a private account answers `private`. Looked up by `handle` only.", "example": {"handle": "khaby.lame"}, "id": "tiktok.profile.region", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a profile or video URL (tiktok.com/@<name>).", "name": "handle", "required": true, "type": "string"}], "path": "/v1/tiktok/profile/region", "platform": "tiktok", "response": "Profile", "summary": "TikTok profile region", "title": "TikTok"},
24
+ {"common": true, "credits": "1 credit", "description": "An account's videos, newest first. How much you get depends on whether TikTok's full list answers, which comes and goes: it was open for about 15 minutes and then refused for at least the next 30 when we measured it, so plan for the shorter answer. When the list answers: 30 to a page with every count TikTok shows (plays, likes, comments, shares, saves), plus caption, hashtags, music, cover, duration, size and the play URL, and a `cursor` for the next page until `has_more` is false. When it refuses a first page asked by `handle`, the page comes from the account's embed page: about 10 videos, no `cursor`, `has_more` false because more cannot be fetched, play counts rounded to two significant digits (`approximate` lists `stats.views`) and no other counts. A numeric `id` and pages after the first need the list, so while TikTok refuses it they answer `upstream_blocked` at no charge; ask again later. `is_pinned` marks pinned videos (set `include_pinned` to false to drop them) and `parent` is the account. `sort=popular` is refused. A private account answers `private`, and an account whose creator limits its audience answers `age_restricted`. Even from the full list TikTok rounds views, likes, comments and shares to three significant digits; saves are exact.", "example": {"handle": "khaby.lame"}, "id": "tiktok.profile.videos", "one_of": [["handle", "id"]], "paginated": true, "params": [{"description": "A username (with or without @), a profile or video URL (tiktok.com/@<name>) or the numeric user id.", "name": "handle", "required": false, "type": "string"}, {"description": "Numeric TikTok user id (a secUid cannot be looked up).", "name": "id", "required": false, "type": "string"}, {"default": "latest", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["latest", "popular"], "name": "sort", "required": false, "type": "string"}, {"default": true, "description": "Set false to drop the pinned videos that can be told from the page order.", "name": "include_pinned", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/profile/videos", "platform": "tiktok", "response": "ListPage[Post]", "summary": "TikTok profile videos", "title": "TikTok"},
25
+ {"common": true, "credits": "1 credit", "description": "Videos saved in a public TikTok collection (also called a playlist).", "example": {"url": "https://www.tiktok.com/@kibblemaster808/collection/Want-to-go-7665668414573546258"}, "id": "tiktok.collection.videos", "one_of": [], "paginated": true, "params": [{"description": "Public collection URL (tiktok.com/@user/collection/<name>-<id>).", "hosts": ["tiktok.com"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/tiktok/collection/videos", "platform": "tiktok", "response": "ListPage[Post]", "summary": "TikTok collection videos", "title": "TikTok"},
26
+ {"common": true, "credits": "1 credit", "description": "Metadata and engagement stats of one video or photo slideshow. `get_transcript=true` adds the native captions in `extra.transcript`; for AI transcription use `/v1/tiktok/video/transcript`. TikTok gives views, likes, comments and shares rounded to three significant digits (22,026,689 views read as 22,000,000); saves are exact.", "example": {"url": "https://www.tiktok.com/@khaby.lame/video/7137423965982592302"}, "id": "tiktok.video", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Video URL (www.tiktok.com/@user/video/..., vm.tiktok.com/..., vt.tiktok.com/...).", "hosts": ["tiktok.com"], "name": "url", "required": false, "type": "url"}, {"description": "Numeric video id.", "name": "id", "required": false, "type": "string"}, {"description": "Include the video's native captions when it has them.", "name": "get_transcript", "required": false, "type": "boolean"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/video", "platform": "tiktok", "response": "Post", "summary": "TikTok video details", "title": "TikTok"},
27
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "TikTok's own captions when the video has them (the English track first, else the first one); AI transcription of the audio when it does not. `language` steers the AI transcription only.", "example": {"url": "https://www.tiktok.com/@nasa/video/7665075736742530317"}, "id": "tiktok.video.transcript", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Video URL (www.tiktok.com/@user/video/..., vm.tiktok.com/..., vt.tiktok.com/...).", "hosts": ["tiktok.com"], "name": "url", "required": false, "type": "url"}, {"description": "Numeric video id.", "name": "id", "required": false, "type": "string"}, {"description": "Preferred caption language (2-letter code: en, es, fr, de, it, ja, ko, zh).", "name": "language", "required": false, "type": "string"}, {"default": true, "description": "Transcribe the audio with AI when the video has no captions. Set false to get no transcript instead, and no AI charge.", "name": "ai_fallback", "required": false, "type": "boolean"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}], "path": "/v1/tiktok/video/transcript", "platform": "tiktok", "response": "Transcript", "summary": "TikTok video transcript", "title": "TikTok"},
28
+ {"common": true, "credits": "1 credit", "description": "Comments on a video, with the commenter and like and reply counts.", "example": {"url": "https://www.tiktok.com/@khaby.lame/video/7137423965982592302"}, "id": "tiktok.video.comments", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Video URL (www.tiktok.com/@user/video/..., vm.tiktok.com/..., vt.tiktok.com/...).", "hosts": ["tiktok.com"], "name": "url", "required": false, "type": "url"}, {"description": "Numeric video id.", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/tiktok/video/comments", "platform": "tiktok", "response": "ListPage[Comment]", "summary": "TikTok video comments", "title": "TikTok"},
29
+ {"common": true, "credits": "1 credit", "description": "", "example": {"comment_id": "7137510823549272878", "url": "https://www.tiktok.com/@khaby.lame/video/7137423965982592302"}, "id": "tiktok.video.comment.replies", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Video URL (www.tiktok.com/@user/video/..., vm.tiktok.com/..., vt.tiktok.com/...).", "hosts": ["tiktok.com"], "name": "url", "required": false, "type": "url"}, {"description": "Numeric video id.", "name": "id", "required": false, "type": "string"}, {"description": "TikTok comment id (the `cid` from the comments list).", "name": "comment_id", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/tiktok/video/comment/replies", "platform": "tiktok", "response": "ListPage[Comment]", "summary": "TikTok comment replies", "title": "TikTok"},
30
+ {"common": true, "credits": "1 credit", "description": "The accounts that follow a creator, newest follower first, each with its name, avatar, bio, verified flag and follower, following, video and like counts. A page holds 30 accounts; follow `cursor` for older followers. `parent` is the creator's profile, which carries the follower total. A private account answers `private`.", "example": {"handle": "khaby.lame"}, "id": "tiktok.profile.followers", "one_of": [["handle", "id"]], "paginated": true, "params": [{"description": "A username (with or without @), a profile or video URL (tiktok.com/@<name>) or the numeric user id.", "name": "handle", "required": false, "type": "string"}, {"description": "Numeric TikTok user id (a secUid cannot be looked up).", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/tiktok/profile/followers", "platform": "tiktok", "response": "ListPage[Profile]", "summary": "TikTok followers", "title": "TikTok"},
31
+ {"common": true, "credits": "1 credit", "description": "The accounts a creator follows, each with its name, avatar, bio, verified flag and follower, following, video and like counts. A page holds 30 accounts; follow `cursor` for more. `parent` is the creator's profile. A creator who hides the list, and a private account, answer `private` (TikTok lets a creator keep the list to themselves, so many large accounts do).", "example": {"handle": "nasa"}, "id": "tiktok.profile.following", "one_of": [["handle", "id"]], "paginated": true, "params": [{"description": "A username (with or without @), a profile or video URL (tiktok.com/@<name>) or the numeric user id.", "name": "handle", "required": false, "type": "string"}, {"description": "Numeric TikTok user id (a secUid cannot be looked up).", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/tiktok/profile/following", "platform": "tiktok", "response": "ListPage[Profile]", "summary": "TikTok following", "title": "TikTok"},
32
+ {"common": true, "credits": "1 credit", "description": "Accounts matching a search. TikTok gives 10 accounts for one request, so a page holds 10; follow `cursor` for more.", "example": {"query": "nasa"}, "id": "tiktok.search.users", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/tiktok/search/users", "platform": "tiktok", "response": "ListPage[Profile]", "summary": "TikTok user search", "title": "TikTok"},
33
+ {"common": true, "credits": "1 credit", "description": "The autocomplete suggestions TikTok shows while someone types in search.", "example": {"query": "dogs"}, "id": "tiktok.search.suggestions", "one_of": [], "paginated": true, "params": [{"description": "Partial or complete search text.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/search/suggestions", "platform": "tiktok", "response": "ListPage[Suggestion]", "summary": "TikTok search suggestions", "title": "TikTok"},
34
+ {"common": true, "credits": "1 credit", "description": "Video search across TikTok. TikTok ignores sort and date filters: `sort` other than `relevance` is refused, and `date_posted` drops videos older than the window from each page (pages can be short or empty; follow `has_more`). `region` is TikTok's region hint, not a proxy country. TikTok now asks for a login on keyword search: when it does, the list is the public videos under the hashtag of your query instead, which are not keyword matches, and `parent` is that hashtag with the explanation as its `description` and `extra.fallback` set to `hashtag`. TikTok gives views, likes, comments and shares rounded to three significant digits (22,026,689 views read as 22,000,000); saves are exact. A page holds up to 30 videos.", "example": {"date_posted": "week", "query": "nasa"}, "id": "tiktok.search.keyword", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"default": "relevance", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["relevance", "likes", "latest"], "name": "sort", "required": false, "type": "string"}, {"description": "Posted within.", "enum": ["any", "day", "week", "month", "three_months", "six_months"], "name": "date_posted", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/search/keyword", "platform": "tiktok", "response": "ListPage[Post]", "summary": "TikTok video search", "title": "TikTok"},
35
+ {"common": true, "credits": "1 credit", "description": "Videos under a hashtag, with the hashtag (its video and view counts) as `parent`. TikTok may return duplicates.", "example": {"hashtag": "booktok"}, "id": "tiktok.search.hashtag", "one_of": [], "paginated": true, "params": [{"description": "Hashtag, with or without #.", "name": "hashtag", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/search/hashtag", "platform": "tiktok", "response": "ListPage[Post]", "summary": "TikTok videos by hashtag", "title": "TikTok"},
36
+ {"common": true, "credits": "1 credit", "description": "TikTok's 'Top' tab: videos, photo carousels and a card of matching accounts (keyword search returns videos only). Same filter limits as keyword search: relevance order only; `publish_time` drops older items from each page. While TikTok asks for a login on search, the list is the public videos under the hashtag of your query (no accounts card), and `parent` is that hashtag with the explanation as its `description` and `extra.fallback` set to `hashtag`.", "example": {"query": "nasa"}, "id": "tiktok.search.top", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Posted within.", "enum": ["any", "day", "week", "month", "three_months", "six_months"], "name": "publish_time", "required": false, "type": "string"}, {"default": "relevance", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["relevance", "likes", "latest"], "name": "sort", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/search/top", "platform": "tiktok", "response": "ListPage[Post | Profile | Collection | Community]", "summary": "TikTok top search", "title": "TikTok"},
37
+ {"common": true, "credits": "1 credit", "description": "Videos from TikTok's Explore feed, the nearest public list to 'popular' (the Creative Center ranking behind ScrapeCreators' endpoint needs a login). `period` and `sort` are accepted for compatibility and not applied; `category` picks an Explore category.", "example": {"region": "US"}, "id": "tiktok.videos.popular", "one_of": [], "paginated": true, "params": [{"description": "Accepted for compatibility; the Explore feed has no time window.", "enum": ["7", "30"], "name": "period", "required": false, "type": "string"}, {"description": "Accepted for compatibility; not applied.", "enum": ["views", "likes", "comments", "shares"], "name": "sort", "required": false, "type": "string"}, {"description": "TikTok's numeric Explore category id (default 1).", "name": "category", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/videos/popular", "platform": "tiktok", "response": "ListPage[Post]", "summary": "Popular TikTok videos", "title": "TikTok"},
38
+ {"common": true, "credits": "1 credit", "description": "A sound by its clip id (the number at the end of a tiktok.com/music/... URL).", "example": {"id": "7016547803243022337"}, "id": "tiktok.song", "one_of": [["id", "url"]], "paginated": false, "params": [{"description": "Sound (music) id.", "name": "id", "required": false, "type": "string"}, {"description": "Sound URL (tiktok.com/music/...).", "hosts": ["tiktok.com"], "name": "url", "required": false, "type": "url"}], "path": "/v1/tiktok/song", "platform": "tiktok", "response": "Song", "summary": "TikTok song details", "title": "TikTok"},
39
+ {"common": true, "credits": "1 credit", "description": "Videos that use a sound, 20 to a page. TikTok gives views, likes, comments and shares rounded to three significant digits (22,026,689 views read as 22,000,000); saves are exact.", "example": {"id": "7016547803243022337"}, "id": "tiktok.song.videos", "one_of": [["id", "url"]], "paginated": true, "params": [{"description": "Sound (music) id.", "name": "id", "required": false, "type": "string"}, {"description": "Sound URL (tiktok.com/music/...).", "hosts": ["tiktok.com"], "name": "url", "required": false, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/tiktok/song/videos", "platform": "tiktok", "response": "ListPage[Post]", "summary": "TikTok videos using a song", "title": "TikTok"},
40
+ {"common": true, "credits": "1 credit", "description": "A For You feed: a handful of videos per call, different on every call (the feed is not stable, so pages can repeat).", "example": {"region": "US"}, "id": "tiktok.trending", "one_of": [], "paginated": true, "params": [{"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/trending", "platform": "tiktok", "response": "ListPage[Post]", "summary": "TikTok trending feed", "title": "TikTok"},
41
+ {"common": true, "credits": "1 credit", "description": "Whether the user is live now, with the room's details when they are.", "example": {"handle": "khaby.lame"}, "id": "tiktok.profile.live", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a profile or video URL (tiktok.com/@<name>).", "name": "handle", "required": true, "type": "string"}], "path": "/v1/tiktok/profile/live", "platform": "tiktok", "response": "LiveStream", "summary": "Is a TikTok user live", "title": "TikTok"},
42
+ {"common": true, "credits": "1 credit", "description": "Room-level info for a live. Find the room id with `/v1/tiktok/profile/live`.", "example": {"id": "7702259688670235405"}, "id": "tiktok.live", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Live URL (tiktok.com/@user/live).", "hosts": ["tiktok.com"], "name": "url", "required": false, "type": "url"}, {"description": "Live room id.", "name": "id", "required": false, "type": "string"}, {"description": "Numeric TikTok user id of the live's owner (`id` from the profile); speeds the lookup.", "name": "user_id", "required": false, "type": "string"}], "path": "/v1/tiktok/live", "platform": "tiktok", "response": "LiveStream", "summary": "TikTok live room info", "title": "TikTok"},
43
+ {"common": true, "credits": "1 credit", "description": "Biography, links, follower and following counts, the post count and account flags. Instagram's profile query leaves the post count out, so it is read from the profile's embed page beside it (`stats.posts`, exact, `approximate` empty); when that page cannot be read, or only gives an abbreviated figure, `stats.posts` is null and `profile/post-count` can estimate it. Private accounts answer the profile with `is_private` true and `status` \"private\". An account Instagram shows only to adults answers with `status` \"restricted\", `restriction` \"age\" and only what its page shows: handle, name, picture and the three counts.", "example": {"handle": "nasa"}, "id": "instagram.profile", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a profile URL (instagram.com/<name>).", "name": "handle", "required": true, "type": "string"}, {"default": true, "description": "Set false to skip the extra page read and leave `stats.posts` null.", "name": "include_post_count", "required": false, "type": "boolean"}], "path": "/v1/instagram/profile", "platform": "instagram", "response": "Profile", "summary": "Instagram profile", "title": "Instagram"},
44
+ {"common": true, "credits": "1 credit", "description": "A profile summary by numeric user id: username, name, biography, links, picture, verification, follower and following counts, account privacy. `stats.posts` is null (use `profile/post-count`). Instagram has no direct lookup by id, so the account is found through its newest post: an id whose account has no visible posts (private, empty or unknown) answers not_found.", "example": {"id": "528817151"}, "id": "instagram.basic_profile", "one_of": [], "paginated": false, "params": [{"description": "Numeric Instagram user id.", "name": "id", "required": true, "type": "string"}], "path": "/v1/instagram/basic-profile", "platform": "instagram", "response": "Profile", "summary": "Instagram profile by user id", "title": "Instagram"},
45
+ {"common": true, "credits": "1 credit", "description": "The profile with `stats.posts` filled in, for when `profile` returns it null. Read from the profile's embed page, which carries the exact count even above 10,000 posts (`approximate` empty); only if that page is unavailable does it fall back to the profile page, which abbreviates.", "example": {"handle": "nasa"}, "id": "instagram.profile.post_count", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a profile URL (instagram.com/<name>).", "name": "handle", "required": true, "type": "string"}, {"description": "Return a scaled estimate when Instagram abbreviates the count (profiles over 10,000 posts). Without it such a profile answers an unbilled error.", "name": "allow_estimated", "required": false, "type": "boolean"}], "path": "/v1/instagram/profile/post-count", "platform": "instagram", "response": "Profile", "summary": "Instagram profile post count", "title": "Instagram"},
46
+ {"common": true, "credits": "1 credit", "description": "A paged feed of public posts: photos, videos, carousels and reels, 12 a page. Instagram's feed query carries no counts, so rows have captions, times and media URLs and every count in `stats` null; `require_play_counts=true` adds the likes, comments and (for videos) views of every post from its embed page, which is slower. Look a profile up by `handle`; a numeric `id` has no lookup.", "example": {"handle": "nasa"}, "id": "instagram.profile.posts", "one_of": [["handle", "id"]], "paginated": true, "params": [{"description": "A username (with or without @) or a profile URL (instagram.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Numeric Instagram user id.", "name": "id", "required": false, "type": "string"}, {"description": "Add likes, comments and video views to every row (one extra page per post), and fail rather than return a video post whose play count is missing (a real 0 is fine).", "name": "require_play_counts", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/profile/posts", "platform": "instagram", "response": "ListPage[Post]", "summary": "Instagram profile posts", "title": "Instagram"},
47
+ {"common": true, "credits": "1 credit", "description": "A paged feed of the profile's public reels, 12 a page, with play, like and comment counts, caption, exact time, duration and video URL. `stats.views` is Instagram's play count (`extra.views_source` = plays). Look a profile up by `handle`.", "example": {"handle": "nasa"}, "id": "instagram.profile.reels", "one_of": [["handle", "id"]], "paginated": true, "params": [{"description": "A username (with or without @) or a profile URL (instagram.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Numeric Instagram user id.", "name": "id", "required": false, "type": "string"}, {"description": "Fail rather than return a reel whose play count is missing.", "name": "require_play_counts", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/profile/reels", "platform": "instagram", "response": "ListPage[Post]", "summary": "Instagram profile reels", "title": "Instagram"},
48
+ {"common": true, "credits": "1 credit", "description": "Caption, counts, media, owner, tagged users, co-authors, sound and carousel children of one post or reel. For videos `stats.views` is the view count of the post's embed page (`extra.views_source` = embed_views), which differs from the play count of the reels tab.", "example": {"url": "https://www.instagram.com/reel/DfF3eqGSKKc/"}, "id": "instagram.post", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Post or reel URL (/p/..., /reel/..., /tv/...).", "hosts": ["instagram.com", "instagr.am"], "name": "url", "required": false, "type": "url"}, {"description": "Shortcode or numeric media id.", "name": "id", "required": false, "type": "string"}, {"default": true, "description": "Set false to skip the extra fetch for the video view count and answer faster.", "name": "include_play_count", "required": false, "type": "boolean"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/instagram/post", "platform": "instagram", "response": "Post", "summary": "Instagram post or reel details", "title": "Instagram"},
49
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "AI transcription of a reel or video post (Instagram has no public captions). The post's video file is read from its public embed page and transcribed on the shared speech boxes at the transcript price (1 credit up to 2 minutes, then 5 per started minute of the whole video). Photos and carousels without a video answer transcript_unavailable, which is free.", "example": {"url": "https://www.instagram.com/reel/C8rKmYvsrck/"}, "id": "instagram.post.transcript", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Post or reel URL (/p/..., /reel/..., /tv/...).", "hosts": ["instagram.com", "instagr.am"], "name": "url", "required": false, "type": "url"}, {"description": "Shortcode or numeric media id.", "name": "id", "required": false, "type": "string"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}], "path": "/v1/instagram/post/transcript", "platform": "instagram", "response": "Transcript", "summary": "Instagram reel transcript", "title": "Instagram"},
50
+ {"common": true, "credits": "1 credit", "description": "The first page of a post's comments (about 14, in Instagram's own order), with each comment's likes; reply counts are null (Instagram sends them empty). Instagram offers no way to the next page, so `has_more` is always false and the total is in the post's `stats.comments`. `include_replies` is accepted and ignored: replies are not available.", "example": {"url": "https://www.instagram.com/reel/DfF3eqGSKKc/"}, "id": "instagram.post.comments", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Post or reel URL (/p/..., /reel/..., /tv/...).", "hosts": ["instagram.com", "instagr.am"], "name": "url", "required": false, "type": "url"}, {"description": "Shortcode or numeric media id.", "name": "id", "required": false, "type": "string"}, {"description": "Accepted for compatibility; replies are not available, so it changes nothing.", "name": "include_replies", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/post/comments", "platform": "instagram", "response": "ListPage[Comment]", "summary": "Instagram post comments", "title": "Instagram"},
51
+ {"common": true, "credits": "1 credit", "description": "Instagram's own hashtag search for the words: the hashtags that start with them, in Instagram's order, about 50 in one page with no cursor. Each carries its id, `url` and post count (`extra.post_count`, and `extra.post_count_label`, the rounded label Instagram prints; small tags read `100+`). An unusual word answers an empty list. Accounts, places and keyword suggestions are not in the answer. For a hashtag's posts use `search/hashtag`; for accounts `search/profiles`.", "example": {"query": "nike"}, "id": "instagram.search", "one_of": [], "paginated": true, "params": [{"description": "The word or start of a word to find hashtags for, with or without #.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/search", "platform": "instagram", "response": "ListPage[Suggestion]", "summary": "Instagram hashtag suggestions", "title": "Instagram"},
52
+ {"common": true, "credits": "1 credit", "description": "Explore a topic through Instagram's public Popular search: the reels it curates for a keyword, about 50 to 70 over 5 or 6 pages (health and finance terms are thin; some single words have none). Rows carry the caption, author, time and duration; Instagram sends no counts here, so every count in `stats` is null. No `parent`. Pass the cursor back with the same query.", "example": {"query": "basketball"}, "id": "instagram.search.popular", "one_of": [], "paginated": true, "params": [{"description": "The Popular topic to look up.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/search/popular", "platform": "instagram", "response": "ListPage[Post]", "summary": "Instagram popular topic", "title": "Instagram"},
53
+ {"common": true, "credits": "1 credit", "description": "Public posts and reels for an exact hashtag that a web search has indexed (DuckDuckGo's results, not Google's), best effort and not a complete hashtag feed. The cursor is the next results page and cannot go past 11. Each result is read through the Instagram post endpoint for caption, author, media and counts (`enrich`, on by default; a post that no longer exists is dropped). `date_posted` takes day, week, month or year. When the search provider asks for human verification on every try the call fails and can be retried.", "example": {"enrich": false, "hashtag": "baking"}, "id": "instagram.search.hashtag", "one_of": [], "paginated": true, "params": [{"description": "The hashtag, with or without #.", "name": "hashtag", "required": true, "type": "string"}, {"description": "Only posts found in this window.", "enum": ["day", "week", "month", "year"], "name": "date_posted", "required": false, "type": "string"}, {"description": "Posts and reels, or reels only.", "enum": ["all", "reels"], "name": "media_type", "required": false, "type": "string"}, {"default": true, "description": "Read each post for its full caption, author, media and counts (on by default). Off returns only what the search result states, much cheaper and faster.", "name": "enrich", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/search/hashtag", "platform": "instagram", "response": "ListPage[Post]", "summary": "Instagram posts by hashtag", "title": "Instagram"},
54
+ {"common": true, "credits": "1 credit", "description": "Accounts for a name or keyword, from the Instagram pages a web search has indexed (DuckDuckGo's results, not Google's and not Instagram's own ranking), best effort and not a complete list. Each result states the account's name and rounded follower, following and post counts (`approximate`). The first 10 on a page are then read through the Instagram profile endpoint for exact counts, bio, links and picture (`enrich`, on by default; an account that no longer exists is dropped). The cursor is the next results page and cannot go past 11. When the search provider is busy or asks for human verification on every try the call fails, costs nothing and can be retried. Look an exact username up with `profile`.", "example": {"query": "fitness coach"}, "id": "instagram.search.profiles", "one_of": [], "paginated": true, "params": [{"description": "Profile name, username or keywords.", "name": "query", "required": true, "type": "string"}, {"default": true, "description": "Read the first 10 accounts of a page for exact counts, bio, links and picture (on by default). Off returns only what the search result states, much cheaper and faster.", "name": "enrich", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/search/profiles", "platform": "instagram", "response": "ListPage[Profile]", "summary": "Instagram profile search", "title": "Instagram"},
55
+ {"common": true, "credits": "1 credit", "description": "Reels for a keyword or phrase from Instagram's public Popular search (the same source as `search/popular`; it is not search-indexed), about 50 to 70 over 5 or 6 pages. `date_posted` is accepted for compatibility and not applied: Popular search has no date filter.", "example": {"query": "sourdough"}, "id": "instagram.search.reels", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Accepted for compatibility; not applied (no date filter upstream).", "enum": ["week", "month", "year"], "name": "date_posted", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/search/reels", "platform": "instagram", "response": "ListPage[Post]", "summary": "Instagram reel search", "title": "Instagram"},
56
+ {"common": true, "credits": "1 credit", "description": "Reels from Instagram's Reels feed, 8 a page, with like and comment counts (the feed carries no play counts), caption, author and video URL. The feed is whatever Instagram serves from the engine's region, so it changes from call to call.", "example": {}, "id": "instagram.reels.trending", "one_of": [], "paginated": true, "params": [{"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/reels/trending", "platform": "instagram", "response": "ListPage[Post]", "summary": "Instagram trending reels", "title": "Instagram"},
57
+ {"common": true, "credits": "1 credit", "description": "The profile's highlight albums: id, title, cover and owner. Look a profile up by `handle`; a numeric `id` has no lookup.", "example": {"handle": "nasa"}, "id": "instagram.profile.highlights", "one_of": [["handle", "id"]], "paginated": true, "params": [{"description": "A username (with or without @) or a profile URL (instagram.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Numeric Instagram user id.", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/profile/highlights", "platform": "instagram", "response": "ListPage[Collection]", "summary": "Instagram story highlights", "title": "Instagram"},
58
+ {"common": true, "credits": "1 credit", "description": "The stories in one highlight; `parent` is the highlight.", "example": {"id": "18195781759377100"}, "id": "instagram.highlight", "one_of": [], "paginated": true, "params": [{"description": "Highlight id (from profile/highlights) or a /stories/highlights/ URL.", "name": "id", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/highlight", "platform": "instagram", "response": "ListPage[Post]", "summary": "Instagram highlight stories", "title": "Instagram"},
59
+ {"common": true, "credits": "1 credit", "description": "The reels that use one sound, from the data behind instagram.com/reels/audio/<id>/: 12 a page with play, like and comment counts, caption, author, time, duration and video URL; `parent` is the sound (a licensed track or a creator's original audio, with how many reels use it in `stats.uses`). Works for the id in the audio page's URL.", "example": {"id": "1392969992841787"}, "id": "instagram.song.reels", "one_of": [], "paginated": true, "params": [{"description": "Audio id from the audio page URL (instagram.com/reels/audio/<id>/).", "name": "id", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/instagram/song/reels", "platform": "instagram", "response": "ListPage[Post]", "summary": "Instagram reels using a song", "title": "Instagram"},
60
+ {"common": true, "credits": "1 credit", "description": "The profile's embed document (what Instagram serves at /<handle>/embed/): HTML in `html`, with the follower and post counts it carries in `extra`.", "example": {"handle": "nasa"}, "id": "instagram.profile.embed", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a profile URL (instagram.com/<name>).", "name": "handle", "required": true, "type": "string"}], "path": "/v1/instagram/profile/embed", "platform": "instagram", "response": "Embed", "summary": "Instagram profile embed HTML", "title": "Instagram"},
61
+ {"common": true, "credits": "1 credit", "description": "Name, description, icon, banner, and weekly visitors and contributions in `extra`. Reddit does not show the subscriber count, so `member_count` is empty.", "example": {"subreddit": "python"}, "id": "reddit.subreddit.details", "one_of": [["subreddit", "url"]], "paginated": false, "params": [{"description": "A subreddit name (python, r/python) or a subreddit URL (reddit.com/r/<name>, any page of it).", "name": "subreddit", "required": false, "type": "string"}, {"description": "Subreddit URL (reddit.com/r/<name>).", "hosts": ["reddit.com", "redd.it"], "name": "url", "required": false, "type": "url"}], "path": "/v1/reddit/subreddit/details", "platform": "reddit", "response": "Community", "summary": "Subreddit details", "title": "Reddit"},
62
+ {"common": true, "credits": "1 credit", "description": "Posts in a subreddit; `parent` is the subreddit. The cursor is Reddit's `after` token.", "example": {"subreddit": "python"}, "id": "reddit.subreddit.posts", "one_of": [], "paginated": true, "params": [{"description": "A subreddit name (python, r/python) or a subreddit URL (reddit.com/r/<name>, any page of it).", "name": "subreddit", "required": true, "type": "string"}, {"default": "hot", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["hot", "new", "top", "rising", "controversial", "best"], "name": "sort", "required": false, "type": "string"}, {"description": "Window for top/controversial sorts.", "enum": ["hour", "day", "week", "month", "year", "all"], "name": "timeframe", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/reddit/subreddit/posts", "platform": "reddit", "response": "ListPage[Post]", "summary": "Subreddit posts", "title": "Reddit"},
63
+ {"common": true, "credits": "1 credit", "description": "Reddit's own search inside one subreddit, in the order you pick (relevance, hot, top, new or most comments), over a timeframe if you give one. A page gives about 25 posts with title, author, subreddit, date, score and comment count, and the post's body text and media. The cursor continues the same search. If Reddit's search is not answering, the posts come from DuckDuckGo's index instead, in its order, and each post's `extra.source` says `duckduckgo`.", "example": {"query": "asyncio", "subreddit": "python"}, "id": "reddit.subreddit.search", "one_of": [], "paginated": true, "params": [{"description": "A subreddit name (python, r/python) or a subreddit URL (reddit.com/r/<name>, any page of it).", "name": "subreddit", "required": true, "type": "string"}, {"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"default": "relevance", "description": "Reddit's search order: relevance, hot, top, new, or most comments.", "enum": ["relevance", "hot", "top", "new", "comments"], "name": "sort", "required": false, "type": "string"}, {"description": "Keep only the posts from this window.", "enum": ["hour", "day", "week", "month", "year", "all"], "name": "timeframe", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/reddit/subreddit/search", "platform": "reddit", "response": "ListPage[Post]", "summary": "Search within a subreddit", "title": "Reddit"},
64
+ {"common": true, "credits": "1 credit", "description": "One post without its comments: title, body text, author, subreddit, score, upvote ratio, counts and flags. Accepts canonical URLs and mobile share URLs.", "example": {"url": "https://www.reddit.com/r/webscraping/comments/1q6pxwn/just_started_web_scraping_is_this_a_good_start/"}, "id": "reddit.post", "one_of": [], "paginated": false, "params": [{"description": "Post URL (reddit.com/r/.../comments/..., redd.it/..., mobile share links).", "hosts": ["reddit.com", "redd.it"], "name": "url", "required": true, "type": "url"}], "path": "/v1/reddit/post", "platform": "reddit", "response": "Post", "summary": "Reddit post", "title": "Reddit"},
65
+ {"common": true, "credits": "1 credit", "description": "The post's comment tree, flattened in display order (replies carry parent_id); on the first page `parent` is the post. Replies Reddit folds away stay folded.", "example": {"url": "https://www.reddit.com/r/webscraping/comments/1q6pxwn/just_started_web_scraping_is_this_a_good_start/"}, "id": "reddit.post.comments", "one_of": [], "paginated": true, "params": [{"description": "Post URL (reddit.com/r/.../comments/..., redd.it/..., mobile share links).", "hosts": ["reddit.com", "redd.it"], "name": "url", "required": true, "type": "url"}, {"default": "confidence", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["confidence", "top", "new", "controversial", "old", "qa"], "name": "sort", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/reddit/post/comments", "platform": "reddit", "response": "ListPage[Comment]", "summary": "Reddit post comments", "title": "Reddit"},
66
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "The transcript of a Reddit video post or v.redd.it link: Reddit's own automatic captions when it has them, otherwise AI transcription of the audio.", "example": {"url": "https://www.reddit.com/r/interestingasfuck/comments/1xl30t2/a_bird_watches_a_man_fish_he_offers_it_his_catch/"}, "id": "reddit.post.transcript", "one_of": [], "paginated": false, "params": [{"description": "Post URL or a direct v.redd.it video URL.", "hosts": ["reddit.com", "redd.it"], "name": "url", "required": true, "type": "url"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}, {"description": "2-letter language. Captions in another language are skipped for AI transcription in this one; by default whatever Reddit has.", "name": "language", "required": false, "type": "string"}], "path": "/v1/reddit/post/transcript", "platform": "reddit", "response": "Transcript", "summary": "Reddit video post transcript", "title": "Reddit"},
67
+ {"common": true, "credits": "1 credit", "description": "Reddit's own search across all of Reddit, in the order you pick (relevance, hot, top, new or most comments), over a timeframe if you give one. A page gives about 25 posts with title, author, subreddit, date, score and comment count, and the post's body text and media. The cursor continues the same search. Posts only: comment search is not available. If Reddit's search is not answering, the posts come from DuckDuckGo's index instead, in its order, and each post's `extra.source` says `duckduckgo`.", "example": {"query": "mechanical keyboard"}, "id": "reddit.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"default": "relevance", "description": "Reddit's search order: relevance, hot, top, new, or most comments.", "enum": ["relevance", "hot", "top", "new", "comments"], "name": "sort", "required": false, "type": "string"}, {"description": "Keep only the posts from this window.", "enum": ["hour", "day", "week", "month", "year", "all"], "name": "timeframe", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/reddit/search", "platform": "reddit", "response": "ListPage[Post]", "summary": "Reddit search", "title": "Reddit"},
68
+ {"common": true, "credits": "1 credit", "description": "", "example": {"handle": "bsky.app"}, "id": "bluesky.profile", "one_of": [], "paginated": false, "params": [{"description": "A handle (alice.bsky.social, with or without @), a DID (did:plc:...) or a profile or post URL (bsky.app/profile/<handle>).", "name": "handle", "required": true, "type": "string"}], "path": "/v1/bluesky/profile", "platform": "bluesky", "response": "Profile", "summary": "Bluesky profile", "title": "Bluesky"},
69
+ {"common": true, "credits": "1 credit", "description": "A paged feed of the user's posts, 30 a page, replies left out. Reposts are included and marked in `extra.is_repost`, with the original author as author; `reposts=false` leaves them out, so a page can hold fewer than 30. Pass the DID (ScrapeCreators' `user_id`) for faster lookups.", "example": {"handle": "bsky.app", "reposts": false}, "id": "bluesky.profile.posts", "one_of": [], "paginated": true, "params": [{"description": "A handle (alice.bsky.social, with or without @), a DID (did:plc:...) or a profile or post URL (bsky.app/profile/<handle>).", "name": "handle", "required": true, "type": "string"}, {"default": true, "description": "Set false to leave out the posts the account reposted.", "name": "reposts", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/bluesky/profile/posts", "platform": "bluesky", "response": "ListPage[Post]", "summary": "Bluesky profile posts", "title": "Bluesky"},
70
+ {"common": true, "credits": "1 credit", "description": "The post with its embed content and counts, and its threaded replies in `extra.replies`.", "example": {"url": "https://bsky.app/profile/espn.com/post/3lqdfq7fkvm2g"}, "id": "bluesky.post", "one_of": [], "paginated": false, "params": [{"description": "Post URL (bsky.app/profile/<handle>/post/<rkey>).", "hosts": ["bsky.app"], "name": "url", "required": true, "type": "url"}], "path": "/v1/bluesky/post", "platform": "bluesky", "response": "Post", "summary": "Bluesky post", "title": "Bluesky"},
71
+ {"common": true, "credits": "1 credit", "description": "", "example": {"handle": "zuck"}, "id": "threads.profile", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a profile or post URL (threads.net/@<name>).", "name": "handle", "required": true, "type": "string"}], "path": "/v1/threads/profile", "platform": "threads", "response": "Profile", "summary": "Threads profile", "title": "Threads"},
72
+ {"common": true, "credits": "1 credit", "description": "The most recent posts, newest first, about 15 per page. Threads shows only the latest 20 to 30 posts of a profile, so paging runs out early.", "example": {"handle": "zuck"}, "id": "threads.profile.posts", "one_of": [], "paginated": true, "params": [{"description": "A username (with or without @) or a profile or post URL (threads.net/@<name>).", "name": "handle", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/threads/profile/posts", "platform": "threads", "response": "ListPage[Post]", "summary": "Threads profile posts", "title": "Threads"},
73
+ {"common": true, "credits": "1 credit", "description": "The post with its counts and media, and its top replies in `extra.replies`.", "example": {"url": "https://www.threads.com/@zuck/post/DeZtp-TkQHh"}, "id": "threads.post", "one_of": [], "paginated": false, "params": [{"description": "Post URL (threads.net/@user/post/...).", "hosts": ["threads.net", "threads.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/threads/post", "platform": "threads", "response": "Post", "summary": "Threads post", "title": "Threads"},
74
+ {"common": true, "credits": "1 credit", "description": "Posts matching a keyword: one page of about 15 to 20 results, no paging. `start_date` and `end_date` filter the page by post date (Threads does not apply them itself).", "example": {"query": "basketball"}, "id": "threads.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Only posts from this date (YYYY-MM-DD).", "name": "start_date", "required": false, "type": "string"}, {"description": "Only posts up to this date (YYYY-MM-DD).", "name": "end_date", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/threads/search", "platform": "threads", "response": "ListPage[Post]", "summary": "Threads post search", "title": "Threads"},
75
+ {"common": true, "credits": "1 credit", "description": "Accounts matching a query, best match first: handle, name, avatar and verified flag, up to 10.", "example": {"query": "nasa"}, "id": "threads.search.users", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/threads/search/users", "platform": "threads", "response": "ListPage[Profile]", "summary": "Threads user search", "title": "Threads"},
76
+ {"common": true, "credits": "1 credit", "description": "Public profile of a Truth Social account. Accounts that do not exist answer not_found.", "example": {"handle": "realDonaldTrump"}, "id": "truthsocial.profile", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a profile or post URL (truthsocial.com/@<name>).", "name": "handle", "required": true, "type": "string"}], "path": "/v1/truthsocial/profile", "platform": "truthsocial", "response": "Profile", "summary": "Truth Social profile", "title": "Truth Social"},
77
+ {"common": true, "credits": "1 credit", "description": "A paged list of the account's own posts (ReTruths are left out), newest first. A numeric `id` (the profile's id) saves a lookup call.", "example": {"handle": "realDonaldTrump"}, "id": "truthsocial.profile.posts", "one_of": [["handle", "id"]], "paginated": true, "params": [{"description": "A username (with or without @) or a profile or post URL (truthsocial.com/@<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Truth Social user id (the `id` from the profile).", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/truthsocial/profile/posts", "platform": "truthsocial", "response": "ListPage[Post]", "summary": "Truth Social profile posts", "title": "Truth Social"},
78
+ {"common": true, "credits": "1 credit", "description": "", "example": {"url": "https://truthsocial.com/@realDonaldTrump/117526232618166329"}, "id": "truthsocial.post", "one_of": [], "paginated": false, "params": [{"description": "Post URL (truthsocial.com/@user/<id>).", "hosts": ["truthsocial.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/truthsocial/post", "platform": "truthsocial", "response": "Post", "summary": "Truth Social post", "title": "Truth Social"},
79
+ {"common": true, "credits": "1 credit", "description": "Pins matching a keyword, about 24 per page. Search pins carry opaque ids (e1_...), so their `url` is the pin page but the pin endpoint cannot look the id up again.", "example": {"query": "living room ideas"}, "id": "pinterest.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/pinterest/search", "platform": "pinterest", "response": "ListPage[Post]", "summary": "Pinterest pin search", "title": "Pinterest"},
80
+ {"common": true, "credits": "1 credit", "description": "One pin: title, description, outbound link, board, pinner, saves, reactions and image or video. Needs the numeric pin id in the URL; pin.it short links are followed.", "example": {"url": "https://www.pinterest.com/pin/36662184461578355/"}, "id": "pinterest.pin", "one_of": [], "paginated": false, "params": [{"description": "Pin URL (pinterest.com/pin/..., pin.it/...).", "hosts": ["pinterest.com", "pin.it", "pinterest.co.uk", "pinterest.ca", "pinterest.com.au", "pinterest.de", "pinterest.fr"], "name": "url", "required": true, "type": "url"}], "path": "/v1/pinterest/pin", "platform": "pinterest", "response": "Post", "summary": "Pinterest pin", "title": "Pinterest"},
81
+ {"common": true, "credits": "1 credit", "description": "", "example": {"handle": "pinterest"}, "id": "pinterest.profile.boards", "one_of": [], "paginated": true, "params": [{"description": "A username (with or without @) or a profile or board URL (pinterest.com/<name>).", "name": "handle", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/pinterest/profile/boards", "platform": "pinterest", "response": "ListPage[Collection]", "summary": "Pinterest user boards", "title": "Pinterest"},
82
+ {"common": true, "credits": "1 credit", "description": "The board's pins, 25 per page; `parent` is the board. Pinterest hands out a bookmark for the next page on some boards and none on others (a 183-pin board stops after its first 25), so follow `cursor` while `has_more` is true and expect large boards to come back partial.", "example": {"url": "https://www.pinterest.com/pinterest/holiday-decor-ideas/"}, "id": "pinterest.board", "one_of": [], "paginated": true, "params": [{"description": "Board URL (pinterest.com/<user>/<board>/).", "hosts": ["pinterest.com", "pin.it", "pinterest.co.uk", "pinterest.ca", "pinterest.com.au", "pinterest.de", "pinterest.fr"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/pinterest/board", "platform": "pinterest", "response": "ListPage[Post]", "summary": "Pinterest board pins", "title": "Pinterest"},
83
+ {"common": true, "credits": "1 credit", "description": "Pins for an ideas topic. `parent` is the topic with its `search_count` and related `refinements` (first page only: they come from the ideas page).", "example": {"url": "https://www.pinterest.com/ideas/how-to-stop-leash-pulling/894604313079/"}, "id": "pinterest.topic", "one_of": [], "paginated": true, "params": [{"description": "Topic URL (pinterest.com/ideas/<topic>/<id>/).", "hosts": ["pinterest.com", "pin.it", "pinterest.co.uk", "pinterest.ca", "pinterest.com.au", "pinterest.de", "pinterest.fr"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/pinterest/topic", "platform": "pinterest", "response": "ListPage[Post]", "summary": "Pinterest topic pins", "title": "Pinterest"},
84
+ {"common": true, "credits": "1 credit", "description": "", "example": {"handle": "shroud"}, "id": "twitch.profile", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a channel URL (twitch.tv/<name>).", "name": "handle", "required": true, "type": "string"}], "path": "/v1/twitch/profile", "platform": "twitch", "response": "Profile", "summary": "Twitch channel", "title": "Twitch"},
85
+ {"common": true, "credits": "1 credit", "description": "A channel's videos (up to 100): id, title, views, game, duration and thumbnails.", "example": {"handle": "shroud", "limit": 10, "sort": "views", "type": "highlight"}, "id": "twitch.user.videos", "one_of": [], "paginated": true, "params": [{"description": "A username (with or without @) or a channel URL (twitch.tv/<name>).", "name": "handle", "required": true, "type": "string"}, {"description": "Kind of video.", "enum": ["highlight", "archive", "upload"], "name": "type", "required": false, "type": "string"}, {"description": "Order of results. Changing it restarts the cursor chain.", "enum": ["time", "views"], "name": "sort", "required": false, "type": "string"}, {"description": "How many videos to return, up to 100 (Twitch allows no paging past the first 100 without a browser session, so the response has no cursor).", "maximum": 100, "minimum": 1, "name": "limit", "required": false, "type": "integer"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/twitch/user/videos", "platform": "twitch", "response": "ListPage[Post]", "summary": "Twitch user videos", "title": "Twitch"},
86
+ {"common": true, "credits": "1 credit", "description": "A channel's scheduled streams: start and end time, title, categories and whether a stream is cancelled.", "example": {"handle": "emongg"}, "id": "twitch.user.schedule", "one_of": [], "paginated": true, "params": [{"description": "A username (with or without @) or a channel URL (twitch.tv/<name>).", "name": "handle", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/twitch/user/schedule", "platform": "twitch", "response": "ListPage[Event]", "summary": "Twitch stream schedule", "title": "Twitch"},
87
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "Native captions when the clip has them; AI transcription of the clip's audio when it does not.", "example": {"url": "https://www.twitch.tv/mish/clip/WrongMagnificentTomatoCorgiDerp-C720OEMqocSPbrqA"}, "id": "twitch.clip.transcript", "one_of": [], "paginated": false, "params": [{"description": "Clip URL (clips.twitch.tv/... or twitch.tv/<user>/clip/...).", "hosts": ["twitch.tv"], "name": "url", "required": true, "type": "url"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}, {"default": true, "description": "Transcribe the audio with AI when the clip has no captions. Set false to get no transcript instead, and no AI charge.", "name": "ai_fallback", "required": false, "type": "boolean"}], "path": "/v1/twitch/clip/transcript", "platform": "twitch", "response": "Transcript", "summary": "Twitch clip transcript", "title": "Twitch"},
88
+ {"common": true, "credits": "1 credit", "description": "", "example": {"url": "https://www.twitch.tv/mish/clip/WrongMagnificentTomatoCorgiDerp-C720OEMqocSPbrqA"}, "id": "twitch.clip", "one_of": [], "paginated": false, "params": [{"description": "Clip URL (clips.twitch.tv/... or twitch.tv/<user>/clip/...).", "hosts": ["twitch.tv"], "name": "url", "required": true, "type": "url"}], "path": "/v1/twitch/clip", "platform": "twitch", "response": "Post", "summary": "Twitch clip", "title": "Twitch"},
89
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "Kick clips carry no caption track, so this is AI transcription of the clip's audio (flat 1 credit for clips of up to two minutes). With ai_fallback=false nothing is transcribed and nothing is charged.", "example": {"url": "https://kick.com/xqc/clips/clip_01JGJHB6CEVFCQRYTVPM8DW892"}, "id": "kick.clip.transcript", "one_of": [], "paginated": false, "params": [{"description": "Clip URL (kick.com/<user>/clips/clip_...).", "hosts": ["kick.com"], "name": "url", "required": true, "type": "url"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}, {"default": true, "description": "Transcribe the audio with AI when the clip has no captions. Set false to get no transcript instead, and no AI charge.", "name": "ai_fallback", "required": false, "type": "boolean"}], "path": "/v1/kick/clip/transcript", "platform": "kick", "response": "Transcript", "summary": "Kick clip transcript", "title": "Kick"},
90
+ {"common": true, "credits": "1 credit", "description": "", "example": {"url": "https://kick.com/xqc/clips/clip_01JGJHB6CEVFCQRYTVPM8DW892"}, "id": "kick.clip", "one_of": [], "paginated": false, "params": [{"description": "Clip URL (kick.com/<user>/clips/clip_...).", "hosts": ["kick.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/kick/clip", "platform": "kick", "response": "Post", "summary": "Kick clip", "title": "Kick"},
91
+ {"common": true, "credits": "1 credit", "description": "A public profile (snapchat.com/add/<handle>): name, bio, subscribers, public stories where shown.", "example": {"handle": "zane"}, "id": "snapchat.profile", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a profile URL (snapchat.com/add/<name>, snapchat.com/@<name>).", "name": "handle", "required": true, "type": "string"}], "path": "/v1/snapchat/profile", "platform": "snapchat", "response": "Profile", "summary": "Snapchat public profile", "title": "Snapchat"},
92
+ {"common": true, "credits": "1 credit", "description": "One public Spotlight video by link: id, description, creator, engagement counts, length to the millisecond, thumbnail and content URL, where Snapchat shows them.", "example": {"url": "https://www.snapchat.com/@jack.scalise/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYb3djZ3FqY2VhAZXDhShdAZXDhPWfAAAAAQ"}, "id": "snapchat.spotlight", "one_of": [], "paginated": false, "params": [{"description": "Spotlight URL (snapchat.com/@user/spotlight/...).", "hosts": ["snapchat.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/snapchat/spotlight", "platform": "snapchat", "response": "Post", "summary": "Snapchat Spotlight video", "title": "Snapchat"},
93
+ {"common": true, "credits": "1 credit", "description": "Public comments on a Spotlight video; `parent` is the video. Pass the cursor back for more.", "example": {"url": "https://www.snapchat.com/@jack.scalise/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYb3djZ3FqY2VhAZXDhShdAZXDhPWfAAAAAQ"}, "id": "snapchat.spotlight.comments", "one_of": [], "paginated": true, "params": [{"description": "Spotlight URL (snapchat.com/@user/spotlight/...).", "hosts": ["snapchat.com"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/snapchat/spotlight/comments", "platform": "snapchat", "response": "ListPage[Comment]", "summary": "Snapchat Spotlight comments", "title": "Snapchat"},
94
+ {"common": true, "credits": "1 credit", "description": "A Linktree page: the creator's name, bio, avatar, every link in page order and the social accounts it points to. Product and group links carry their type, thumbnail and price in `extra.link_details`; a published email is in `extra.emails` and `socials`. Pass the page `url` or just the `handle`.", "example": {"url": "https://linktr.ee/miguelangeles"}, "id": "linktree", "one_of": [["url", "handle"]], "paginated": false, "params": [{"description": "Linktree page URL.", "hosts": ["linktr.ee"], "name": "url", "required": false, "type": "url"}, {"description": "A username (with or without @) or a page URL (linktr.ee/<name>).", "name": "handle", "required": false, "type": "string"}], "path": "/v1/linktree", "platform": "linktree", "response": "LinkPage", "summary": "Linktree page", "title": "Linktree"},
95
+ {"common": true, "credits": "1 credit", "description": "A Komi page: the creator's name, bio, avatar, every link in page order and the social accounts it points to. Hidden modules are left out; products carry their price in `extra.link_details`. Pass the page `url` or just the `handle`.", "example": {"url": "https://kimkardashian.komi.io/"}, "id": "komi", "one_of": [["url", "handle"]], "paginated": false, "params": [{"description": "Komi page URL.", "hosts": ["komi.io"], "name": "url", "required": false, "type": "url"}, {"description": "A username (with or without @) or a page URL (komi.io/<name>).", "name": "handle", "required": false, "type": "string"}], "path": "/v1/komi", "platform": "komi", "response": "LinkPage", "summary": "Komi page", "title": "Komi"},
96
+ {"common": true, "credits": "1 credit", "description": "A Pillar page: the creator's name, bio, avatar, every link in page order and the social accounts it points to. Links and products are listed together; the email is the one the creator shows on the page. Pass the page `url` or just the `handle`.", "example": {"url": "https://pillar.io/angelstrife"}, "id": "pillar", "one_of": [["url", "handle"]], "paginated": false, "params": [{"description": "Pillar page URL.", "hosts": ["pillar.io"], "name": "url", "required": false, "type": "url"}, {"description": "A username (with or without @) or a page URL (pillar.io/<name>).", "name": "handle", "required": false, "type": "string"}], "path": "/v1/pillar", "platform": "pillar", "response": "LinkPage", "summary": "Pillar page", "title": "Pillar"},
97
+ {"common": true, "credits": "1 credit", "description": "A Lnk.Bio page: the creator's name, bio, avatar, every link in page order and the social accounts it points to. Lnk.Bio only serves browser-like clients, so this one is slower. Pass the page `url` or just the `handle`.", "example": {"url": "https://lnk.bio/msjennafischer"}, "id": "linkbio", "one_of": [["url", "handle"]], "paginated": false, "params": [{"description": "Lnk.Bio page URL.", "hosts": ["lnk.bio"], "name": "url", "required": false, "type": "url"}, {"description": "A username (with or without @) or a page URL (lnk.bio/<name>).", "name": "handle", "required": false, "type": "string"}], "path": "/v1/linkbio", "platform": "linkbio", "response": "LinkPage", "summary": "Lnk.Bio page", "title": "Lnk.Bio"},
98
+ {"common": true, "credits": "1 credit", "description": "A Linkme page: the creator's name, bio, avatar, every link in page order and the social accounts it points to. Contact emails come from the page's contact section. Pass the page `url` or just the `handle`.", "example": {"url": "https://link.me/danucd"}, "id": "linkme", "one_of": [["url", "handle"]], "paginated": false, "params": [{"description": "Linkme page URL.", "hosts": ["link.me"], "name": "url", "required": false, "type": "url"}, {"description": "A username (with or without @) or a page URL (link.me/<name>).", "name": "handle", "required": false, "type": "string"}], "path": "/v1/linkme", "platform": "linkme", "response": "LinkPage", "summary": "Linkme page", "title": "Linkme"},
99
+ {"common": true, "credits": "1 credit", "description": "The social profiles a creator links from their own bio, links section or link-in-bio page, each as a profile with its platform and URL; `extra.evidence` lists the pages that say so and `extra.confidence` is 1.0 for a link on the profile itself, 0.9 for one a link-in-bio page or a linked profile declares. Links the creator published are followed; a network they did not link is tried under the same handle and kept only when that profile links back to one already found (0.95, evidence profile_links_back) or shows the same display name (0.8, same_handle_same_name). A handle match alone is dropped. Pass a `platform` and a bare `handle` (a leading @ is optional; YouTube also takes a channel id), or a profile `url`.", "example": {"handle": "MrBeast", "platform": "youtube"}, "id": "creators.social_profiles", "one_of": [["url", "handle"]], "paginated": true, "params": [{"description": "Profile URL on any supported platform.", "hosts": ["youtube.com", "tiktok.com", "instagram.com", "x.com", "twitter.com", "twitch.tv", "facebook.com", "linktr.ee", "komi.io", "pillar.io", "lnk.bio", "link.me"], "name": "url", "required": false, "type": "url"}, {"description": "Handle without a profile URL; needs `platform`.", "name": "handle", "required": false, "type": "string"}, {"description": "Platform of `handle`.", "enum": ["youtube", "tiktok", "instagram", "twitter", "twitch", "facebook"], "name": "platform", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/creators/social-profiles", "platform": "creators", "response": "ListPage[Profile]", "summary": "Find a creator's other social profiles", "title": "Creator contact details"},
100
+ {"common": true, "credits": "1 credit", "description": "Email addresses a creator published themselves, each with the URLs where it was seen (`extra.email_sources`, each typed social_profile, link_in_bio, linked_profile or website_page). Reads the creator's bio and links, the link-in-bio pages they link (Linktree, Komi, Pillar, Lnk.Bio, Linkme and other link hubs), the profiles they link, and up to three websites they declare (homepage and contact pages, robots.txt honoured). Addresses are never guessed or checked by sending mail; `kind` is business, management or personal when the address itself says so. Profiles under the same handle are read too, and a link-in-bio page under it counts when its icons name the creator. `extra.partial` is true when a page failed or was skipped, so an empty result is then not proof that no address exists; an address on a profile or page under a different handle that nothing links to cannot be found. Pass a `platform` and `handle`, or a profile `url`.", "example": {"handle": "miguelangeles", "platform": "instagram"}, "id": "creators.emails", "one_of": [["url", "handle"]], "paginated": false, "params": [{"description": "Profile URL on any supported platform.", "hosts": ["youtube.com", "tiktok.com", "instagram.com", "x.com", "twitter.com", "twitch.tv", "facebook.com", "linktr.ee", "komi.io", "pillar.io", "lnk.bio", "link.me"], "name": "url", "required": false, "type": "url"}, {"description": "Handle; needs `platform`.", "name": "handle", "required": false, "type": "string"}, {"description": "Platform of `handle`.", "enum": ["youtube", "tiktok", "instagram", "twitter", "twitch", "facebook"], "name": "platform", "required": false, "type": "string"}], "path": "/v1/creators/emails", "platform": "creators", "response": "CreatorEmails", "summary": "Find a creator's public emails", "title": "Creator contact details"},
101
+ {"common": true, "credits": "1 credit", "description": "Search the Meta Ad Library by keyword. `region` is the one country to search (ALL for every country). Also available as POST with a JSON body, for cursors too long for a URL.", "example": {"cursor": "eyJrIjoiZmJhZHMiLCJjIjoiQVFIVHR6TWN1R1ZGekcxSF85UzBpNjN5VTVMYjFzZHFDZmZaRjRYeHRHS205dXlVNG1BTUpkT2F3VEg1YUM4VWdvV2EifQ", "query": "nike", "region": "US"}, "id": "facebook.ad_library.search", "one_of": [], "paginated": true, "params": [{"description": "Keyword to search for.", "name": "query", "required": true, "type": "string"}, {"description": "Order of results: `impressions` is most impressions first (ScrapeCreators' default), `newest` is most recent. Changing it restarts the cursor chain.", "enum": ["relevance", "impressions", "newest"], "name": "sort", "required": false, "type": "string"}, {"default": "any_words", "description": "Match any of the words, or the exact phrase.", "enum": ["any_words", "exact_phrase"], "name": "match", "required": false, "type": "string"}, {"default": "all", "description": "All ads, or only political and issue ads.", "enum": ["all", "political"], "name": "ad_type", "required": false, "type": "string"}, {"description": "Only ads in this language, a 2-letter code (EN, ES, FR).", "name": "language", "required": false, "type": "string"}, {"default": "active", "description": "Ad status.", "enum": ["active", "inactive", "all"], "name": "status", "required": false, "type": "string"}, {"description": "Creative type. `meme` is Meta's word for text on an image.", "enum": ["all", "image", "video", "meme", "image_and_meme", "none"], "name": "media_type", "required": false, "type": "string"}, {"description": "Impressions window start, YYYY-MM-DD.", "name": "start_date", "required": false, "type": "string"}, {"description": "Impressions window end, YYYY-MM-DD.", "name": "end_date", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/facebook/ad-library/search", "platform": "facebook", "response": "ListPage[Ad]", "summary": "Facebook Ad Library search", "title": "Facebook"},
102
+ {"common": true, "credits": "1 credit", "description": "The ads a company runs, by Ad Library page id or by company name. Also available as POST with a JSON body.", "example": {"cursor": "eyJrIjoiZmJhZHMiLCJjIjoiQVFIVEZfamZkd1hQZjYwUk9Ld3A0Qk1QeGlCM1BiN2pxYkc3dEtlbEhXSmJMc3hnb29XbnFjbWRnUUJCMEJ0Y3RGcW8iLCJwIjoiMTUwODcwMjM0NDQifQ", "id": "15087023444", "region": "US"}, "id": "facebook.ad_library.company.ads", "one_of": [["id", "company_name"]], "paginated": true, "params": [{"description": "Ad Library page id of the advertiser (from advertiser search).", "name": "id", "required": false, "type": "string"}, {"description": "Advertiser name (resolved to a page id).", "name": "company_name", "required": false, "type": "string"}, {"default": "active", "description": "Ad status.", "enum": ["active", "inactive", "all"], "name": "status", "required": false, "type": "string"}, {"description": "Creative type. `meme` is Meta's word for text on an image.", "enum": ["all", "image", "video", "meme", "image_and_meme", "none"], "name": "media_type", "required": false, "type": "string"}, {"description": "Only ads in this language, a 2-letter code (EN, ES, FR).", "name": "language", "required": false, "type": "string"}, {"description": "Order of results: `impressions` is most impressions first (ScrapeCreators' default), `newest` is most recent. Changing it restarts the cursor chain.", "enum": ["relevance", "impressions", "newest"], "name": "sort", "required": false, "type": "string"}, {"description": "Impressions window start, YYYY-MM-DD.", "name": "start_date", "required": false, "type": "string"}, {"description": "Impressions window end, YYYY-MM-DD.", "name": "end_date", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/facebook/ad-library/company/ads", "platform": "facebook", "response": "ListPage[Ad]", "summary": "Facebook Ad Library ads by page", "title": "Facebook"},
103
+ {"common": true, "credits": "1 credit", "description": "One ad by id or URL: page, status, dates and the snapshot (text, images, videos, format, link, call to action). Regulated ads add their transparency data in `extra`.", "example": {"id": "352695862528588"}, "id": "facebook.ad_library.ad", "one_of": [["id", "url"]], "paginated": false, "params": [{"description": "Ad id in the library.", "name": "id", "required": false, "type": "string"}, {"description": "Ad Library URL (facebook.com/ads/library/?id=...).", "hosts": ["facebook.com"], "name": "url", "required": false, "type": "url"}, {"description": "Accepted for compatibility. A video ad's transcript is its own call, `ad/transcript` (AI transcription, metered); this flag only adds a pointer to it in `extra.transcript_hint`.", "name": "get_transcript", "required": false, "type": "boolean"}], "path": "/v1/facebook/ad-library/ad", "platform": "facebook", "response": "Ad", "summary": "Facebook Ad Library ad details", "title": "Facebook"},
104
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "Transcript of a video ad. Ad Library videos carry no caption tracks, so this is always AI transcription of the audio, billed by the length of the audio. An ad with no video answers an unbilled error.", "example": {"id": "352695862528588"}, "id": "facebook.ad_library.ad.transcript", "one_of": [["id", "url"]], "paginated": false, "params": [{"description": "Ad id in the library.", "name": "id", "required": false, "type": "string"}, {"description": "Ad Library URL (facebook.com/ads/library/?id=...).", "hosts": ["facebook.com"], "name": "url", "required": false, "type": "url"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}], "path": "/v1/facebook/ad-library/ad/transcript", "platform": "facebook", "response": "Transcript", "summary": "Facebook Ad Library ad transcript", "title": "Facebook"},
105
+ {"common": true, "credits": "1 credit", "description": "Advertisers matching a name: Ad Library page id, category, likes, verification and Instagram details. Use the page id with `company/ads`. Meta closes its advertiser typeahead, so these are the pages behind the ads a search for the name returns (up to 10, name matches first), each completed from the ad-details query; `ad_count` is not available.", "example": {"query": "nike"}, "id": "facebook.ad_library.search.companies", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/ad-library/search/companies", "platform": "facebook", "response": "ListPage[Advertiser]", "summary": "Facebook Ad Library advertiser search", "title": "Facebook"},
106
+ {"common": true, "credits": "1 credit", "description": "", "example": {"query": "nike", "region": "US"}, "id": "google.ad_library.advertisers.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/google/ad-library/advertisers/search", "platform": "google", "response": "ListPage[Advertiser]", "summary": "Google Ads Transparency advertiser search", "title": "Google"},
107
+ {"common": true, "credits": "1 credit", "description": "An advertiser's public ads by advertiser id or website domain: ids, previews and first and last shown dates when Google gives them.", "example": {"id": "AR16735076323512287233", "platform": "youtube", "region": "US"}, "id": "google.ad_library.company.ads", "one_of": [["id", "domain"]], "paginated": true, "params": [{"description": "Advertiser id (AR...).", "name": "id", "required": false, "type": "string"}, {"description": "Advertiser's website domain.", "name": "domain", "required": false, "type": "string"}, {"description": "All ads or political ads. Political needs a `region`.", "enum": ["all", "political"], "name": "topic", "required": false, "type": "string"}, {"description": "Where the ad ran.", "enum": ["google_maps", "google_play", "google_search", "google_shopping", "youtube"], "name": "platform", "required": false, "type": "string"}, {"description": "Creative format.", "enum": ["all", "text", "image", "video"], "name": "format", "required": false, "type": "string"}, {"description": "Ads shown from this date, YYYY-MM-DD.", "name": "start_date", "required": false, "type": "string"}, {"description": "Ads shown up to this date, YYYY-MM-DD.", "name": "end_date", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/google/ad-library/company/ads", "platform": "google", "response": "ListPage[Ad]", "summary": "Google Ads Transparency ads by advertiser", "title": "Google"},
108
+ {"common": true, "credits": "1 credit", "description": "", "example": {"url": "https://adstransparency.google.com/advertiser/AR16735076323512287233/creative/CR17814369753519620097"}, "id": "google.ad_library.ad", "one_of": [], "paginated": false, "params": [{"description": "Creative URL (adstransparency.google.com/advertiser/AR.../creative/CR...).", "hosts": ["adstransparency.google.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/google/ad-library/ad", "platform": "google", "response": "Ad", "summary": "Google Ads Transparency ad details", "title": "Google"},
109
+ {"common": true, "credits": "1 credit", "description": "Search the LinkedIn Ad Library by company name, company id or keyword (give at least one). Custom dates need both `start_date` and `end_date`, within the past year and ending yesterday at the latest. `countries` is a comma-separated list; the cursor is LinkedIn's pagination token.", "example": {"company": "Microsoft"}, "id": "linkedin.ad_library.search", "one_of": [], "paginated": true, "params": [{"description": "Keyword to search for.", "name": "query", "required": false, "type": "string"}, {"description": "Advertiser name.", "name": "company", "required": false, "type": "string"}, {"description": "LinkedIn company id: the number in linkedin.com/company/<id>.", "name": "company_id", "required": false, "type": "string"}, {"description": "Comma-separated 2-letter countries, \"US,CA,MX\".", "name": "countries", "required": false, "type": "string"}, {"description": "Start date, YYYY-MM-DD. Use with `end_date`.", "name": "start_date", "required": false, "type": "string"}, {"description": "End date, YYYY-MM-DD. Use with `start_date`.", "name": "end_date", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/linkedin/ad-library/search", "platform": "linkedin", "response": "ListPage[Ad]", "summary": "LinkedIn Ad Library search", "title": "LinkedIn"},
110
+ {"common": true, "credits": "1 credit", "description": "", "example": {"id": "1662766106"}, "id": "linkedin.ad_library.ad", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Ad URL (linkedin.com/ad-library/detail/...).", "hosts": ["linkedin.com"], "name": "url", "required": false, "type": "url"}, {"description": "Ad id in the library.", "name": "id", "required": false, "type": "string"}], "path": "/v1/linkedin/ad-library/ad", "platform": "linkedin", "response": "Ad", "summary": "LinkedIn Ad Library ad details", "title": "LinkedIn"},
111
+ {"common": true, "credits": "1 credit", "description": "Search TikTok's public Ads Library by keyword (`query`, or a quoted \"exact phrase\") or by advertiser (`advertiser_name`, resolved through TikTok's typeahead). Give one of the two. The library is TikTok's European commercial-content library: it lists ads shown in the EU, EEA, UK and Switzerland, 12 per page, newest shown first. `region` is one of those countries (default all).", "example": {"end_date": "2026-10-29", "query": "\"free trial\"", "start_date": "2026-10-22"}, "id": "tiktok.ad_library.search", "one_of": [["query", "advertiser_name"]], "paginated": true, "params": [{"description": "General ad search.", "name": "query", "required": false, "type": "string"}, {"description": "Advertiser name to resolve and search by advertiser entity.", "name": "advertiser_name", "required": false, "type": "string"}, {"description": "TikTok advertiser business id from a See all ads link; pins the exact advertiser. Only works together with `advertiser_name`.", "name": "adv_biz_ids", "required": false, "type": "string"}, {"description": "Ads shown from this date, YYYY-MM-DD (default: a year before `end_date`).", "name": "start_date", "required": false, "type": "string"}, {"description": "Ads shown up to this date, YYYY-MM-DD (default: today).", "name": "end_date", "required": false, "type": "string"}, {"description": "The same window as `start_date` in Unix seconds (milliseconds also work). Give it with `end_time`; it wins over the dates.", "name": "start_time", "required": false, "type": "string"}, {"description": "Upper bound of the window in Unix seconds; give it with `start_time`.", "name": "end_time", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/ad-library/search", "platform": "tiktok", "response": "ListPage[Ad]", "summary": "TikTok Ad Library search", "title": "TikTok"},
112
+ {"common": true, "credits": "1 credit", "description": "One ad from TikTok's European Ads Library: the creative, the advertiser (business id, registry country) and the targeting with impressions by region, age and gender, as the library shows them.", "example": {"id": "1879687389944914"}, "id": "tiktok.ad_library.ad", "one_of": [["id", "url"]], "paginated": false, "params": [{"description": "Ad id in the library.", "name": "id", "required": false, "type": "string"}, {"description": "Ad URL (library.tiktok.com/ads/detail/?ad_id=...).", "hosts": ["library.tiktok.com", "tiktok.com"], "name": "url", "required": false, "type": "url"}], "path": "/v1/tiktok/ad-library/ad", "platform": "tiktok", "response": "Ad", "summary": "TikTok Ad Library ad details", "title": "TikTok"},
113
+ {"common": true, "credits": "1 credit", "description": "Public posts found through a web search engine (DuckDuckGo, restricted to x.com), then read like `tweet` through X's public post widget, so views, retweet and bookmark counts are missing. This is engine-indexed discovery, not X's own search (which needs a login): coverage is incomplete, recent posts can be missing and the order is the engine's. Deleted, protected and unreachable posts are left out. Cursor pages 1 to 11.", "example": {"query": "ai agents"}, "id": "twitter.search.posts", "one_of": [], "paginated": true, "params": [{"description": "Keyword or phrase to look for in public X posts.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/twitter/search/posts", "platform": "twitter", "response": "ListPage[Post]", "summary": "X post search", "title": "X (Twitter)"},
114
+ {"common": true, "credits": "1 credit", "description": "Account details: bio, links, avatar, banner, followers, following, post count and verification. X no longer shows the account's likes or listed counts, so `stats.likes` is empty. If X will not serve the profile page, the account is read from its public timeline widget instead (`extra.source` is `syndication`): no birthdate, verification reason or highlights, and it needs the account to have posts of its own. Suspended accounts answer removed, unknown ones not_found.", "example": {"handle": "NASA"}, "id": "twitter.profile", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a profile or post URL (x.com/<name>, twitter.com/<name>).", "name": "handle", "required": true, "type": "string"}], "path": "/v1/twitter/profile", "platform": "twitter", "response": "Profile", "summary": "X profile", "title": "X (Twitter)"},
115
+ {"common": true, "credits": "1 credit", "description": "Posts of an account: about 20 popular posts and reposts, or, when X's public timeline widget is rate limited, the 5 newest original posts. X offers no way to page further, so there is no next-page cursor.", "example": {"handle": "NASA"}, "id": "twitter.profile.tweets", "one_of": [], "paginated": true, "params": [{"description": "A username (with or without @) or a profile or post URL (x.com/<name>, twitter.com/<name>).", "name": "handle", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/twitter/profile/tweets", "platform": "twitter", "response": "ListPage[Post]", "summary": "X profile posts", "title": "X (Twitter)"},
116
+ {"common": true, "credits": "1 credit", "description": "One public post with its counts, media and, for a quote post, the quoted post (`extra.quoted_post`). If X will not serve the post page, the answer comes from X's public post widget instead and views, retweet and bookmark counts are missing (`extra.source_shape` is `syndication`).", "example": {"url": "https://x.com/jack/status/20"}, "id": "twitter.tweet", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Post URL (x.com/<user>/status/<id>).", "hosts": ["x.com", "twitter.com"], "name": "url", "required": false, "type": "url"}, {"description": "Post id.", "name": "id", "required": false, "type": "string"}], "path": "/v1/twitter/tweet", "platform": "twitter", "response": "Post", "summary": "X post details", "title": "X (Twitter)"},
117
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "AI transcription of the video in a post. Videos over 2 minutes need allow_long_transcription=true and cost 5 credits per started minute of the whole video. Posts without video, and animated GIFs, answer transcript_unavailable (free).", "example": {"url": "https://x.com/coinbase/status/2066970874016645585"}, "id": "twitter.tweet.transcript", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Post URL (x.com/<user>/status/<id>).", "hosts": ["x.com", "twitter.com"], "name": "url", "required": false, "type": "url"}, {"description": "Post id.", "name": "id", "required": false, "type": "string"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}], "path": "/v1/twitter/tweet/transcript", "platform": "twitter", "response": "Transcript", "summary": "X video transcript", "title": "X (Twitter)"},
118
+ {"common": true, "credits": "1 credit", "description": "A public X community: name, description, banner, member count, creation date, creator, join policy, rules and a few member handles (`extra`). Unknown communities answer not_found.", "example": {"id": "1926186499399139650"}, "id": "twitter.community", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Community URL (x.com/i/communities/<id>).", "hosts": ["x.com", "twitter.com"], "name": "url", "required": false, "type": "url"}, {"description": "Community id.", "name": "id", "required": false, "type": "string"}], "path": "/v1/twitter/community", "platform": "twitter", "response": "Community", "summary": "X community", "title": "X (Twitter)"},
119
+ {"common": true, "credits": "1 credit", "description": "The 20 most-liked posts of a public X community, which is all X shows. X offers no way to page further, so there is no next-page cursor and newer posts are not reachable. The community itself is returned as `parent`.", "example": {"id": "1926186499399139650"}, "id": "twitter.community.tweets", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Community URL (x.com/i/communities/<id>).", "hosts": ["x.com", "twitter.com"], "name": "url", "required": false, "type": "url"}, {"description": "Community id.", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/twitter/community/tweets", "platform": "twitter", "response": "ListPage[Post]", "summary": "X community posts", "title": "X (Twitter)"},
120
+ {"common": true, "credits": "1 credit", "description": "A public page: category, address, email, phone, website, services, price range, rating, likes and followers (`talking_about` only when Facebook shows it), plus its ad library page id.", "example": {"url": "https://www.facebook.com/NASA"}, "id": "facebook.profile", "one_of": [], "paginated": false, "params": [{"description": "Profile or page URL.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": true, "type": "url"}, {"description": "Include the business hours.", "name": "get_business_hours", "required": false, "type": "boolean"}, {"description": "Return limited public fields for gated or age-restricted pages. Ignored for normal public pages.", "name": "include_gated_profile", "required": false, "type": "boolean"}], "path": "/v1/facebook/profile", "platform": "facebook", "response": "Profile", "summary": "Facebook profile or page", "title": "Facebook"},
121
+ {"common": true, "credits": "1 credit", "description": "Public posts of a page, 3 a page: text, reactions, comments, time, video URLs and top comments.", "example": {"url": "https://www.facebook.com/NASA"}, "id": "facebook.profile.posts", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Profile or page URL.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": false, "type": "url"}, {"description": "The profile or page id, as `profile` returns it in `id`.", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/profile/posts", "platform": "facebook", "response": "ListPage[Post]", "summary": "Facebook profile posts", "title": "Facebook"},
122
+ {"common": true, "credits": "1 credit", "description": "Up to 10 reels a page: id, URL, view count (Facebook's rounded public badge, so 27K becomes 27000), description, time, video URL, duration and music. For exact counts, call `post` per reel.", "example": {"url": "https://www.facebook.com/nike"}, "id": "facebook.profile.reels", "one_of": [], "paginated": true, "params": [{"description": "Profile or page URL.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/profile/reels", "platform": "facebook", "response": "ListPage[Post]", "summary": "Facebook profile reels", "title": "Facebook"},
123
+ {"common": true, "credits": "1 credit", "description": "Photos from a page's Photos tab (type \"image\"): id, caption, image URL and size. The cursor carries both of ScrapeCreators' paging values (`next_page_id` and `cursor`).", "example": {"cursor": "eyJrIjoicGhvdG9zIiwiY29sIjoiWVhCd1gyTnZiR3hsWTNScGIyNDZjR1ppYVdRd00yNUtURUo0ZGs1U01WZzVTRTVFUkZseFp6aERNamN5UVdKWmRFcHJlbUpuZW5OMFEzbE9hR1pFVldOR05rNUtlRTQwVFdoSFIyNWpkRmszV1dsNE5VUmFiMFJRV1RoclJIbFdibEZpVEcxaE9UVm5jVGRTUms0NFRtUnMiLCJhZnRlciI6IkFRSFR4Tl81dXUtMGFtdDR5NzRYM0hQbGVncy1CSVI4X21MVUxRQnk3dFM3OXQtLWVBb2d1dnZXMGRhU0ZnMElXd1FZUHRUMHVVeHN5cWRmeVFXSktwM2ZudyIsInUiOiJodHRwczovL3d3dy5mYWNlYm9vay5jb20vTkFTQSJ9", "url": "https://www.facebook.com/NASA"}, "id": "facebook.profile.photos", "one_of": [], "paginated": true, "params": [{"description": "Profile or page URL.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/profile/photos", "platform": "facebook", "response": "ListPage[Post]", "summary": "Facebook profile photos", "title": "Facebook"},
124
+ {"common": true, "credits": "1 credit", "description": "Public events of a page.", "example": {"url": "https://www.facebook.com/brickyardoldtown"}, "id": "facebook.profile.events", "one_of": [], "paginated": true, "params": [{"description": "Profile or page URL.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/profile/events", "platform": "facebook", "response": "ListPage[Event]", "summary": "Facebook page events", "title": "Facebook"},
125
+ {"common": true, "credits": "1 credit", "description": "Facebook's own video search: matching videos and reels in Facebook's ranking. Not exhaustive; can take several seconds. Keep the query unchanged while paging.", "example": {"query": "nasa"}, "id": "facebook.search.videos", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/search/videos", "platform": "facebook", "response": "ListPage[Post]", "summary": "Facebook video search", "title": "Facebook"},
126
+ {"common": true, "credits": "1 credit", "description": "One public post or reel: text, counts, reactions, media and the `feedback_id` that makes `post/comments` faster. Call it per reel for exact like, comment and view counts (Facebook shows no share count on a video page; `profile/posts` has it).", "example": {"url": "https://www.facebook.com/reel/2166091230582141/"}, "id": "facebook.post", "one_of": [], "paginated": false, "params": [{"description": "Post, video or reel URL.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": true, "type": "url"}, {"description": "Include the video's existing captions in `extra.transcript` (none if it has none; `post/transcript` also transcribes the audio with AI).", "name": "get_transcript", "required": false, "type": "boolean"}], "path": "/v1/facebook/post", "platform": "facebook", "response": "Post", "summary": "Facebook post details", "title": "Facebook"},
127
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "Transcript of a video post or reel: existing captions first, otherwise AI transcription of the audio.", "example": {"url": "https://www.facebook.com/reel/1803909017420449/"}, "id": "facebook.post.transcript", "one_of": [], "paginated": false, "params": [{"description": "Post, video or reel URL.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": true, "type": "url"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}], "path": "/v1/facebook/post/transcript", "platform": "facebook", "response": "Transcript", "summary": "Facebook video transcript", "title": "Facebook"},
128
+ {"common": true, "credits": "1 credit", "description": "Comments on a post or reel: text, time, reply and reaction counts, author and attachments. `sort` is top (Facebook's ranking, the default), newest or oldest.", "example": {"url": "https://www.facebook.com/reel/2166091230582141/"}, "id": "facebook.post.comments", "one_of": [["feedback_id", "url"]], "paginated": true, "params": [{"description": "Post, video or reel URL.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": false, "type": "url"}, {"default": "top", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["top", "newest", "oldest"], "name": "sort", "required": false, "type": "string"}, {"description": "The post's feedback id (from `post`); using it instead of `url` makes the request much faster.", "name": "feedback_id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/post/comments", "platform": "facebook", "response": "ListPage[Comment]", "summary": "Facebook post comments", "title": "Facebook"},
129
+ {"common": true, "credits": "1 credit", "description": "Replies to one comment. Either the post `url` and the parent `comment_id`, or the comment's `feedback_id` and `expansion_token` as the comments list returns them (both are needed).", "example": {"comment_id": "2082653245809386", "url": "https://www.facebook.com/reel/2166091230582141/"}, "id": "facebook.post.comment.replies", "one_of": [["feedback_id", "url"]], "paginated": true, "params": [{"description": "Post, video or reel URL.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": false, "type": "url"}, {"description": "Id of the parent comment.", "name": "comment_id", "required": false, "type": "string"}, {"description": "The comment's feedback id (not the comment id), from `post/comments`.", "name": "feedback_id", "required": false, "type": "string"}, {"description": "The comment's expansion token, from `post/comments`.", "name": "expansion_token", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/post/comment/replies", "platform": "facebook", "response": "ListPage[Comment]", "summary": "Facebook comment replies", "title": "Facebook"},
130
+ {"common": true, "credits": "1 credit", "description": "What a public group's About page shows: description, privacy, member and activity counts, categories, admins and moderators where shown, history and rules.", "example": {"url": "https://www.facebook.com/groups/366190054572553"}, "id": "facebook.group", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Public group URL (facebook.com/groups/...). Sub-pages such as /about work too.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": false, "type": "url"}, {"description": "Numeric group id; use it instead of `url` if you have it.", "name": "id", "required": false, "type": "string"}], "path": "/v1/facebook/group", "platform": "facebook", "response": "Community", "summary": "Facebook public group", "title": "Facebook"},
131
+ {"common": true, "credits": "1 credit", "description": "Posts of a public group, 3 a page, chronological by default.", "example": {"url": "https://www.facebook.com/groups/366190054572553"}, "id": "facebook.group.posts", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Public group URL (facebook.com/groups/...). Sub-pages such as /about work too.", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": false, "type": "url"}, {"description": "Numeric group id; use it instead of `url` if you have it.", "name": "id", "required": false, "type": "string"}, {"default": "chronological", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["chronological", "top", "recent_activity", "chronological_listings"], "name": "sort", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/group/posts", "platform": "facebook", "response": "ListPage[Post]", "summary": "Facebook public group posts", "title": "Facebook"},
132
+ {"common": true, "credits": "1 credit", "description": "Marketplace cities and areas matching a name, with the coordinates to pass to `marketplace/search` as `lat` and `lng`.", "example": {"query": "Austin"}, "id": "facebook.marketplace.location.search", "one_of": [], "paginated": true, "params": [{"description": "City or area name.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/marketplace/location/search", "platform": "facebook", "response": "ListPage[Location]", "summary": "Facebook Marketplace location search", "title": "Facebook"},
133
+ {"common": true, "credits": "1 credit", "description": "Search Marketplace by keyword, or browse a category without a keyword. Needs a place: `lat` and `lng` (see `marketplace/location/search`) or a `location` name. About 24 listings a page; keep the inputs unchanged while paging and de-duplicate by listing id.", "example": {"cursor": "eyJrIjoibWFya2V0IiwibGF0IjozMC4yNjcyLCJsbmciOi05Ny43NDMxLCJhZnRlciI6IntcInBnXCI6MCxcImIyY1wiOntcImJyXCI6XCJcIixcIml0XCI6MCxcImhtc3JcIjpmYWxzZSxcInRiaVwiOjB9LFwiYzJjXCI6e1wiYnJcIjpcIkFicGxreFpHQmZ2R0M1a1ZXbV81Q1F2RFdUdTNRSm9sMnI4NmJtZG1yNEdrZW1PTVFXemdJTERXbHNJSTlBaU92WGdWRFoyLVFvZDRlNDdSNFFDM2Zjd2JvRUNyWjBKTXJxVm9jckNxUGJMdjVXV3U2NDJOS25zR1pCMEVkNl9kaE5NTWgxeXNUbXhrSzYxeWxFQmFIUnRkNTdZX0dxY3hkTVdUTFgtaXh6NE5BNkNGVUtoTlZzQUN1SXZIQXFleHA4OFdnWXZ2VE5OYTJ1YzJXMHo1Y3E1SC1NZmlrR291MmpIQjM3YXRobm9rclo5UTlVTmlpNmtqME5tNTRuNTJUUF83cUJ5UkowdWhVWDVtUWh3Y0pqdWoxdjBGWjQwVU1iLVdXTnNNUUNWVFlKYkM0ZXhrWFVEb0xES0YxVG8wdmFTajhoVVpyOWxhZ0c2ZTJBN212Z196eFpBdWJ4ODRLQUhpTmxrNFliQ3pFZXhsSFdVbmdlQk1QVFlIUkhVQ19Ucm9mZ204NG5GLTRodGxzbXNFdWpsTmd0VEtMbkxfVmQ5OFVLZXpHS0tzbnVnT1lsZUdJbmVoZV9oTE5XdGFvb2Y4dDBEc2hVc0NIbWFLNFFTNUxXNWhraFZaRXlsN0lVT1JWVWxYbFpqQnlaMHBYM3RmT0NaU2twaUwtRzdKelJhU0FqR1U0QlBXd2xZM2hpR2U0dDE3Y1NwZS1Na1BWZmR6cTJnRXlzazV5TlRZckg5QUN4ZlE0R01CMW9kaWs4c1wiLFwiaXRcIjoxMyxcInJwYnJcIjpcIlwiLFwicnBoclwiOmZhbHNlLFwicm1oclwiOmZhbHNlLFwic3NpXCI6ZmFsc2UsXCJzc2NvXCI6MCxcInNzcGlcIjpbXCI0MDAzNzA0OTI1OTIyNjcxMFwiLFwiMzkyNzgxODM4NzUxNTgxNjlcIixcIjI5NDQxMzYxMjQyMTE1NDA5XCIsXCIyODg5NDQ1NjgyNjkxMzc5NFwiLFwiMjgxOTkwNTUzOTk3NzIwNjNcIixcIjI4ODM5MDQ1Mjk1Njk2ODI3XCIsXCIyNzkzMzM1NzU2NjMwNDQ2MlwiLFwiMjg3MDk2ODY3NjUzNTk1ODVcIixcIjI4MzcwODkxMTQ1OTMwNjExXCIsXCIyODM0NzQ3NDUxODIwNDYzMVwiLFwiMjg2MDk0NzE0ODIwMTY3OTRcIixcIjI4MzUxMzkxOTExMjE3MzI5XCIsXCIyODI4MjM5ODM2NDY5ODc1OVwiXX0sXCJpcnJcIjpmYWxzZSxcInNlcnBfY3RhXCI6ZmFsc2UsXCJydWlcIjpbXSxcIm1waWRcIjpbXSxcInNzaWNcIjowLFwidWJwXCI6bnVsbCxcIm5jcm5kXCI6MCxcImlyc3JcIjpmYWxzZSxcImJtcHJcIjpbXSxcImJtcGVpZFwiOltdLFwibm1ibXBcIjpmYWxzZSxcInNrcnJcIjpmYWxzZSxcImlvb3VyXCI6ZmFsc2UsXCJpc2VcIjpmYWxzZSxcInNtc19jdXJzb3JcIjp7XCJwYWdlX2luZGV4XCI6MCxcImJsZW5kZWRfYWRfaW5kZXhcIjowLFwib3JnYW5pY3Nfc2luY2VfbGFzdF9hZFwiOjAsXCJwYWdlX29yZ2FuaWNfY291bnRcIjowLFwiYmxlbmRlZF9vcmdhbmljX2luZGV4XCI6MCxcInJldHVybmVkX2FkX2luZGV4XCI6MCxcInRvdGFsX2luZGV4XCI6MH19In0", "lat": 30.2672, "lng": -97.7431, "query": "bike"}, "id": "facebook.marketplace.search", "one_of": [["lat", "location"]], "paginated": true, "params": [{"description": "Search keyword. Required unless `category_id` is given.", "name": "query", "required": false, "type": "string"}, {"description": "City or area to search around (\"Austin, TX\").", "name": "location", "required": false, "type": "string"}, {"description": "Latitude of the search centre.", "name": "lat", "required": false, "type": "number"}, {"description": "Longitude of the search centre.", "name": "lng", "required": false, "type": "number"}, {"description": "Marketplace category id. Without a keyword only these browse: Antiques 393860164117441, Appliances 678754142233400, Bicycles 1658310421102081, Boats 712638205822882, Electronics 1792291877663080, Furniture 1583634935226685, Garden 800089866739547, Household 1569171756675761, Tools 1670493229902393, Trailers 655837954899686, Vehicles 807311116002614 (or 546583916084032). Other ids need a keyword.", "name": "category_id", "required": false, "type": "string"}, {"description": "Search radius in km.", "name": "radius_km", "required": false, "type": "number"}, {"description": "Lowest listing price.", "name": "min_price", "required": false, "type": "number"}, {"description": "Highest listing price.", "name": "max_price", "required": false, "type": "number"}, {"description": "Order of results. Changing it restarts the cursor chain.", "enum": ["relevance", "distance", "newest", "price_low", "price_high"], "name": "sort", "required": false, "type": "string"}, {"description": "Delivery filter.", "enum": ["all", "local_pickup", "shipping"], "name": "delivery_method", "required": false, "type": "string"}, {"description": "Condition filter.", "enum": ["new", "used_like_new", "used_good", "used_fair"], "name": "condition", "required": false, "type": "string"}, {"description": "Listed within. Uses the UI's calendar-day buckets.", "enum": ["all", "day", "week", "month"], "name": "date_listed", "required": false, "type": "string"}, {"description": "Availability filter.", "enum": ["available", "sold", "all"], "name": "availability", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/marketplace/search", "platform": "facebook", "response": "ListPage[Product]", "summary": "Facebook Marketplace search", "title": "Facebook"},
134
+ {"common": true, "credits": "1 credit", "description": "One listing: title, description, price, location, condition, photos, seller and availability flags.", "example": {"id": "1114608241188932"}, "id": "facebook.marketplace.item", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Listing URL (facebook.com/marketplace/item/<id>).", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": false, "type": "url"}, {"description": "Listing id.", "name": "id", "required": false, "type": "string"}], "path": "/v1/facebook/marketplace/item", "platform": "facebook", "response": "Product", "summary": "Facebook Marketplace listing", "title": "Facebook"},
135
+ {"common": true, "credits": "1 credit", "description": "Events matching a name or description, as facebook.com/events/search shows them (about 7 on the first page). There is no place filter: `location` is searched as words after the query.", "example": {"query": "jazz jam"}, "id": "facebook.events.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "City or area to search around (\"Austin, TX\").", "name": "location", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/events/search", "platform": "facebook", "response": "ListPage[Event]", "summary": "Facebook Events search", "title": "Facebook"},
136
+ {"common": true, "credits": "1 credit", "description": "The events Facebook lists for a city, from its public explore page.", "example": {"url": "https://www.facebook.com/events/explore/saint-petersburg-florida/111326725552547"}, "id": "facebook.events", "one_of": [], "paginated": true, "params": [{"description": "City events page (facebook.com/events/explore/<city>/<id>).", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": true, "type": "url"}, {"description": "Time frame; default all time.", "enum": ["today", "this_week", "next_week"], "name": "time", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/facebook/events", "platform": "facebook", "response": "ListPage[Event]", "summary": "Facebook city events", "title": "Facebook"},
137
+ {"common": true, "credits": "1 credit", "description": "", "example": {"id": "437638146356948"}, "id": "facebook.event", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Event URL (facebook.com/events/<id>).", "hosts": ["facebook.com", "fb.com", "fb.watch"], "name": "url", "required": false, "type": "url"}, {"description": "Event id.", "name": "id", "required": false, "type": "string"}], "path": "/v1/facebook/event", "platform": "facebook", "response": "Event", "summary": "Facebook event details", "title": "Facebook"},
138
+ {"common": true, "credits": "1 credit", "description": "What LinkedIn shows on a profile page: name, headline, location, about, followers, experience, education, skills, courses, recommendations, articles, recent public posts and similar profiles. LinkedIn sometimes turns requests away: those answer `upstream_blocked` (free) and are worth retrying. A member who hides the public profile looks the same as a refused request, so a profile that keeps answering `upstream_blocked` may have no public page.", "example": {"url": "https://www.linkedin.com/in/williamhgates"}, "id": "linkedin.profile", "one_of": [], "paginated": false, "params": [{"description": "Profile URL (linkedin.com/in/<slug>).", "hosts": ["linkedin.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/linkedin/profile", "platform": "linkedin", "response": "Profile", "summary": "LinkedIn public person profile", "title": "LinkedIn"},
139
+ {"common": true, "credits": "1 credit", "description": "A company page: description, website, industry, size, headquarters, specialties, locations, followers, employee count, affiliated and similar pages.", "example": {"url": "https://www.linkedin.com/company/microsoft"}, "id": "linkedin.company", "one_of": [], "paginated": false, "params": [{"description": "Company page URL (linkedin.com/company/<slug>).", "hosts": ["linkedin.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/linkedin/company", "platform": "linkedin", "response": "Profile", "summary": "LinkedIn company page", "title": "LinkedIn"},
140
+ {"common": true, "credits": "1 credit", "description": "The latest public posts and reposts on a company page (up to 10): URL, id, date, full text, media, reactions and comment counts. LinkedIn shows only this block; the posts tab and later pages need a login, so the cursor is always null.", "example": {"url": "https://www.linkedin.com/company/microsoft"}, "id": "linkedin.company.posts", "one_of": [], "paginated": true, "params": [{"description": "Company page URL (linkedin.com/company/<slug>).", "hosts": ["linkedin.com"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/linkedin/company/posts", "platform": "linkedin", "response": "ListPage[Post]", "summary": "LinkedIn company posts", "title": "LinkedIn"},
141
+ {"common": true, "credits": "1 credit", "description": "Public LinkedIn posts and Pulse articles that a web search has indexed for a query (DuckDuckGo's results, not Google's), best effort and not a complete search (LinkedIn's own search needs a login). The cursor is the next results page and cannot go past 11. Each result is read like `linkedin/post` for the full text, author, date and counts (`enrich`, on by default; a post LinkedIn no longer shows is dropped). `date_posted` takes day, week, month or year. When the search provider asks for human verification on every try the call fails and can be retried.", "example": {"enrich": false, "query": "customer success playbook"}, "id": "linkedin.search.posts", "one_of": [], "paginated": true, "params": [{"description": "Keyword or phrase to look for in public LinkedIn posts.", "name": "query", "required": true, "type": "string"}, {"description": "Only posts found in this window.", "enum": ["day", "week", "month", "year"], "name": "date_posted", "required": false, "type": "string"}, {"default": true, "description": "Read each post for its full text, author, date and counts (on by default). Off returns only what the search result states, much cheaper and faster.", "name": "enrich", "required": false, "type": "boolean"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/linkedin/search/posts", "platform": "linkedin", "response": "ListPage[Post]", "summary": "LinkedIn post search", "title": "LinkedIn"},
142
+ {"common": true, "credits": "1 credit", "description": "A public post: full text, author, date, reactions and comment counts, media (video, images, shared article) and the top public comments. Also reads /feed/update/urn:li:activity:... and Pulse (/pulse/...) article URLs.", "example": {"url": "https://www.linkedin.com/posts/jeffweiner08_seeing-lots-of-content-about-dolly-parton-activity-7499148115615350784-j-4g"}, "id": "linkedin.post", "one_of": [], "paginated": false, "params": [{"description": "Post URL (linkedin.com/posts/... or /feed/update/urn:li:activity:...).", "hosts": ["linkedin.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/linkedin/post", "platform": "linkedin", "response": "Post", "summary": "LinkedIn public post", "title": "LinkedIn"},
143
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "The transcript of a post's video when LinkedIn shows one; otherwise AI transcription of the video's audio.", "example": {"url": "https://www.linkedin.com/feed/update/urn:li:activity:7520503284458147840"}, "id": "linkedin.post.transcript", "one_of": [], "paginated": false, "params": [{"description": "Post URL (linkedin.com/posts/...).", "hosts": ["linkedin.com"], "name": "url", "required": true, "type": "url"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}], "path": "/v1/linkedin/post/transcript", "platform": "linkedin", "response": "Transcript", "summary": "LinkedIn post video transcript", "title": "LinkedIn"},
144
+ {"common": true, "credits": "1 credit", "description": "Products matching a search, each with price, rating, sold count and shop. Pages of 20 by cursor; TikTok decides how deep a query goes (past 40 results when it has them). US catalogue only.", "example": {"cursor": "eyJxIjoid2F0ZXIgYm90dGxlIiwibyI6MjAsInB0IjoiMjAyNjEwMzAwMTUzNTgzOTBGN0E3ODNCMURFNzJGODNGNiJ9", "query": "water bottle", "region": "US"}, "id": "tiktok.shop.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/shop/search", "platform": "tiktok", "response": "ListPage[Product]", "summary": "TikTok Shop product search", "title": "TikTok"},
145
+ {"common": true, "credits": "1 credit", "description": "Every product of one shop; `parent` is the shop's profile (first page). 20 products a page in TikTok's own order, which puts a shop's best sellers first. `sort=new_releases` reads the whole catalogue (up to 120 products) and orders it newest first by product id, so it ignores the cursor and returns one page. US catalogue only.", "example": {"url": "https://www.tiktok.com/shop/store/goli-nutrition/7495794203056835079"}, "id": "tiktok.shop.products", "one_of": [], "paginated": true, "params": [{"description": "Shop URL (tiktok.com/shop/store/<name>/<id>).", "hosts": ["tiktok.com"], "name": "url", "required": true, "type": "url"}, {"default": "top", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["top", "new_releases"], "name": "sort", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/shop/products", "platform": "tiktok", "response": "ListPage[Product]", "summary": "TikTok Shop products of a shop", "title": "TikTok"},
146
+ {"common": true, "credits": "1 credit", "description": "One product with its SKUs and stock levels (in `extra`), rating, rating spread, specifications and shipping. US catalogue only. TikTok sometimes treats an exit as a crawler; the request is retried on fresh exits and answers `upstream_blocked` (free) if all three are refused.", "example": {"id": "1729527313880355335"}, "id": "tiktok.shop.product", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Product URL (tiktok.com/shop/pdp/...).", "hosts": ["tiktok.com"], "name": "url", "required": false, "type": "url"}, {"description": "Product id.", "name": "id", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/shop/product", "platform": "tiktok", "response": "Product", "summary": "TikTok Shop product details", "title": "TikTok"},
147
+ {"common": true, "credits": "1 credit", "description": "Customer reviews of a product, newest first: rating, text, photos, the reviewer's masked name and the variant bought. 5 a page. The first page is always available; later pages depend on TikTok accepting the exit and answer `upstream_blocked` (free) when it does not.", "example": {"id": "1729527313880355335"}, "id": "tiktok.shop.product.reviews", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Product URL (tiktok.com/shop/pdp/...).", "hosts": ["tiktok.com"], "name": "url", "required": false, "type": "url"}, {"description": "Product id.", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/tiktok/shop/product/reviews", "platform": "tiktok", "response": "ListPage[Review]", "summary": "TikTok Shop product reviews", "title": "TikTok"},
148
+ {"common": true, "credits": "1 credit", "description": "Products featured on an Amazon creator storefront, each ASIN once, with the lists, photos and videos that feature it in `extra.posts`. The first page carries the creator's trending picks (with prices) and `parent`: the creator's profile with socials, curations and the lists, each with its item count and a preview of its first ASINs (`preview_asins`); from the second page on, the ASINs previewed in list tiles are returned as products, since the lists are not repeated. A storefront page gives an ASIN, an image and, for trending picks, a price; it gives no product title. 20 posts a page. Creator storefronts only (amazon.com/shop/<name>); brand stores (amazon.com/stores/...) are not supported. The creator's affiliate tags are removed from every URL.", "example": {"url": "https://www.amazon.com/shop/sydneydelrey"}, "id": "amazon.shop", "one_of": [], "paginated": true, "params": [{"description": "Storefront URL (amazon.com/shop/<name>).", "hosts": ["amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.com.au", "amzn.to"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/amazon/shop", "platform": "amazon", "response": "ListPage[Product]", "summary": "Amazon storefront products", "title": "Amazon"},
149
+ {"common": true, "credits": "1 credit", "description": "Followers, monthly listeners, world rank, popularity, top cities, bio, links, top tracks, the whole discography (up to 500 albums, 500 singles and 500 compilations, in `extra`), music videos (the first 100), related artists and playlists. Spotify has no handles: `id` is the 22 character id.", "example": {"id": "06HL4z0CvFAxyc27GXpf02"}, "id": "spotify.artist", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Spotify artist URL.", "hosts": ["open.spotify.com", "spotify.com", "spotify.link"], "name": "url", "required": false, "type": "url"}, {"description": "Spotify artist id.", "name": "id", "required": false, "type": "string"}], "path": "/v1/spotify/artist", "platform": "spotify", "response": "Profile", "summary": "Spotify artist", "title": "Spotify"},
150
+ {"common": true, "credits": "1 credit", "description": "The album with its tracks (up to 200), label, copyright, release date and popularity (0 to 100, in `extra`).", "example": {"id": "5AEDGbliTTfjOB8TSm1sxt"}, "id": "spotify.album", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Spotify album URL.", "hosts": ["open.spotify.com", "spotify.com", "spotify.link"], "name": "url", "required": false, "type": "url"}, {"description": "Spotify album id.", "name": "id", "required": false, "type": "string"}], "path": "/v1/spotify/album", "platform": "spotify", "response": "Album", "summary": "Spotify album", "title": "Spotify"},
151
+ {"common": true, "credits": "1 credit", "description": "Title, artists, album, duration, lifetime play count, popularity (0 to 100, in `extra`) and the 30 second preview URL.", "example": {"id": "4cOdK2wGLETKBW3PvgPWqT"}, "id": "spotify.track", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Spotify track URL.", "hosts": ["open.spotify.com", "spotify.com", "spotify.link"], "name": "url", "required": false, "type": "url"}, {"description": "Spotify track id.", "name": "id", "required": false, "type": "string"}], "path": "/v1/spotify/track", "platform": "spotify", "response": "Song", "summary": "Spotify track", "title": "Spotify"},
152
+ {"common": true, "credits": "1 credit", "description": "A show's details (kind \"podcast\").", "example": {"id": "4rOoJ6Egrf8K2IrywzwOMk"}, "id": "spotify.podcast", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Spotify show URL.", "hosts": ["open.spotify.com", "spotify.com", "spotify.link"], "name": "url", "required": false, "type": "url"}, {"description": "Spotify show id.", "name": "id", "required": false, "type": "string"}], "path": "/v1/spotify/podcast", "platform": "spotify", "response": "Collection", "summary": "Spotify podcast", "title": "Spotify"},
153
+ {"common": true, "credits": "1 credit", "description": "A public playlist's tracks, 50 a page; `parent` is the playlist. Pass the cursor back until it is null.", "example": {"id": "37i9dQZF1DX4UtSsGT1Sbe"}, "id": "spotify.playlist", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Spotify playlist URL.", "hosts": ["open.spotify.com", "spotify.com", "spotify.link"], "name": "url", "required": false, "type": "url"}, {"description": "Spotify playlist id.", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/spotify/playlist", "platform": "spotify", "response": "ListPage[Song]", "summary": "Spotify playlist", "title": "Spotify"},
154
+ {"common": true, "credits": "1 credit", "description": "A show's episodes, 100 a page, in the order Spotify lists them (type \"episode\"); an episode Spotify withholds comes back as a stub with `status` \"restricted\"; `parent` is the show. Pass the cursor back until it is null.", "example": {"id": "4rOoJ6Egrf8K2IrywzwOMk"}, "id": "spotify.podcast.episodes", "one_of": [["url", "id"]], "paginated": true, "params": [{"description": "Spotify show URL.", "hosts": ["open.spotify.com", "spotify.com", "spotify.link"], "name": "url", "required": false, "type": "url"}, {"description": "Spotify show id.", "name": "id", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/spotify/podcast/episodes", "platform": "spotify", "response": "ListPage[Post]", "summary": "Spotify podcast episodes", "title": "Spotify"},
155
+ {"common": true, "credits": "1 credit", "description": "Tracks, artists, albums, playlists, podcasts, episodes, audiobooks, genres and users. Without `type` every kind is returned, 10 of each; with `type`, 20 of that kind. Use `type=show` to find podcast ids. Episodes come back as songs with `extra.type` \"episode\", audiobooks as collections with `extra.type` \"audiobook\", genres as collections of kind \"topic\" with `extra.type` \"genre\", users as profiles with `extra.type` \"user\". Results follow the country of the server's IP; `region` is accepted but does not change them.", "example": {"query": "taylor swift"}, "id": "spotify.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Kind of result.", "enum": ["track", "album", "artist", "playlist", "show", "episode", "audiobook", "genre", "user"], "name": "type", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/spotify/search", "platform": "spotify", "response": "ListPage[Song | Album | Profile | Collection]", "summary": "Spotify search", "title": "Spotify"},
156
+ {"common": true, "credits": "1 credit", "description": "Bio, origin, genres, top songs (20), albums (100), singles (100), music videos (50), playlists (50), similar artists (20) and the latest release. `view` with `offset` pages one of those lists; `extra.next_offsets` says where each list continues. Apple Music shows no follower or listener counts, so `stats` is empty. `region` is the storefront (default us); a URL carries its own.", "example": {"id": "159260351"}, "id": "apple_music.artist", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Apple Music artist URL.", "hosts": ["music.apple.com"], "name": "url", "required": false, "type": "url"}, {"description": "Apple Music artist id.", "name": "id", "required": false, "type": "string"}, {"description": "Page one list of the artist instead of the first page of each.", "enum": ["top-songs", "full-albums", "singles", "music-videos", "playlists", "similar-artists"], "name": "view", "required": false, "type": "string"}, {"description": "Start of the `view` list; use the `next_offsets` value from the previous answer.", "minimum": 0, "name": "offset", "required": false, "type": "integer"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/apple-music/artist", "platform": "apple_music", "response": "Profile", "summary": "Apple Music artist", "title": "Apple Music"},
157
+ {"common": true, "credits": "1 credit", "description": "The album with its tracks, label, UPC, copyright and editorial notes.", "example": {"id": "1468058165"}, "id": "apple_music.album", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Apple Music album URL.", "hosts": ["music.apple.com"], "name": "url", "required": false, "type": "url"}, {"description": "Apple Music album id.", "name": "id", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/apple-music/album", "platform": "apple_music", "response": "Album", "summary": "Apple Music album", "title": "Apple Music"},
158
+ {"common": true, "credits": "1 credit", "description": "Title, artists, album, duration, ISRC, composer and the 30 second preview. A track link on an album page ends in `?i=<song id>`; that id is the song's.", "example": {"id": "1468058169"}, "id": "apple_music.track", "one_of": [["url", "id"]], "paginated": false, "params": [{"description": "Apple Music song URL.", "hosts": ["music.apple.com"], "name": "url", "required": false, "type": "url"}, {"description": "Apple Music song id.", "name": "id", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/apple-music/track", "platform": "apple_music", "response": "Song", "summary": "Apple Music track", "title": "Apple Music"},
159
+ {"common": true, "credits": "1 credit", "description": "Public results for artists, albums, songs, playlists, stations and music videos. Without `type` every section is returned, 8 of each; with `type`, 25 of that kind. Music videos come back as songs with `extra.type` \"music_video\", playlists and stations as collections. `radio_episode` is not offered by Apple's public catalog search and answers invalid_params.", "example": {"query": "taylor swift"}, "id": "apple_music.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Kind of result; `all` returns every section.", "enum": ["all", "song", "album", "artist", "playlist", "station", "music_video", "radio_episode"], "name": "type", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}, {"description": "Two-letter country code (ISO 3166-1) for results that vary by country.", "name": "region", "required": false, "type": "string"}], "path": "/v1/apple-music/search", "platform": "apple_music", "response": "ListPage[Song | Album | Profile | Collection]", "summary": "Apple Music search", "title": "Apple Music"},
160
+ {"common": true, "credits": "1 credit", "description": "Followers, track count, bio, location, avatar, banner and the social links the artist lists.", "example": {"handle": "flume"}, "id": "soundcloud.artist", "one_of": [["url", "handle"]], "paginated": false, "params": [{"description": "Artist URL (soundcloud.com/<user>).", "hosts": ["soundcloud.com", "on.soundcloud.com"], "name": "url", "required": false, "type": "url"}, {"description": "A username (with or without @) or a profile URL (soundcloud.com/<name>).", "name": "handle", "required": false, "type": "string"}], "path": "/v1/soundcloud/artist", "platform": "soundcloud", "response": "Profile", "summary": "SoundCloud artist", "title": "SoundCloud"},
161
+ {"common": true, "credits": "1 credit", "description": "An artist's tracks, newest first, 20 or a few more a page (private or blocked tracks are left out and the page is topped up to at least 20 while more exist); `parent` is the artist. Pass the cursor back until it is null.", "example": {"handle": "flume"}, "id": "soundcloud.artist.tracks", "one_of": [["url", "handle"]], "paginated": true, "params": [{"description": "Artist URL (soundcloud.com/<user>).", "hosts": ["soundcloud.com", "on.soundcloud.com"], "name": "url", "required": false, "type": "url"}, {"description": "A username (with or without @) or a profile URL (soundcloud.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/soundcloud/artist/tracks", "platform": "soundcloud", "response": "ListPage[Song]", "summary": "SoundCloud artist tracks", "title": "SoundCloud"},
162
+ {"common": true, "credits": "1 credit", "description": "Title, artist, duration, play, like and comment counts, genre, license, ISRC and release date.", "example": {"url": "https://soundcloud.com/flume/all-of-the-worlds"}, "id": "soundcloud.track", "one_of": [], "paginated": false, "params": [{"description": "Track URL (soundcloud.com/<user>/<track>).", "hosts": ["soundcloud.com", "on.soundcloud.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/soundcloud/track", "platform": "soundcloud", "response": "Song", "summary": "SoundCloud track", "title": "SoundCloud"},
163
+ {"common": true, "credits": "1 credit", "description": "", "example": {"handle": "torvalds"}, "id": "github.user", "one_of": [["handle", "url"]], "paginated": false, "params": [{"description": "A username (with or without @) or a profile or repository URL (github.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Profile URL (github.com/<user>).", "hosts": ["github.com"], "name": "url", "required": false, "type": "url"}], "path": "/v1/github/user", "platform": "github", "response": "Profile", "summary": "GitHub user", "title": "GitHub"},
164
+ {"common": true, "credits": "1 credit", "description": "A user's public repositories with description, language, stars, forks, topics, license and dates, 30 a page. `type` and `direction` pass straight through to GitHub. `watchers` is empty on list items: GitHub sends the real watcher count only with a single repository (`github.repository`); the `watchers_count` in a list is the star count, so it is not copied.", "example": {"handle": "torvalds"}, "id": "github.user.repositories", "one_of": [["handle", "url"]], "paginated": true, "params": [{"description": "A username (with or without @) or a profile or repository URL (github.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Profile URL (github.com/<user>).", "hosts": ["github.com"], "name": "url", "required": false, "type": "url"}, {"default": "owner", "description": "Repository type.", "enum": ["owner", "all", "member"], "name": "type", "required": false, "type": "string"}, {"default": "updated", "description": "Order of results. Changing it restarts the cursor chain.", "enum": ["updated", "created", "pushed", "full_name"], "name": "sort", "required": false, "type": "string"}, {"description": "Sort direction.", "enum": ["asc", "desc"], "name": "direction", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/github/user/repositories", "platform": "github", "response": "ListPage[Repo]", "summary": "GitHub user repositories", "title": "GitHub"},
165
+ {"common": true, "credits": "1 credit", "description": "", "example": {"repo": "torvalds/linux"}, "id": "github.repository", "one_of": [["url", "repo"]], "paginated": false, "params": [{"description": "Repository URL (github.com/<owner>/<repo>).", "hosts": ["github.com"], "name": "url", "required": false, "type": "url"}, {"description": "\"owner/name\" or a repository URL (github.com/<owner>/<name>, any page of it).", "name": "repo", "required": false, "type": "string"}], "path": "/v1/github/repository", "platform": "github", "response": "Repo", "summary": "GitHub repository", "title": "GitHub"},
166
+ {"common": true, "credits": "1 credit", "description": "", "example": {"handle": "torvalds"}, "id": "github.user.followers", "one_of": [["handle", "url"]], "paginated": true, "params": [{"description": "A username (with or without @) or a profile or repository URL (github.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Profile URL (github.com/<user>).", "hosts": ["github.com"], "name": "url", "required": false, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/github/user/followers", "platform": "github", "response": "ListPage[Profile]", "summary": "GitHub followers", "title": "GitHub"},
167
+ {"common": true, "credits": "1 credit", "description": "", "example": {"handle": "kentcdodds"}, "id": "github.user.following", "one_of": [["handle", "url"]], "paginated": true, "params": [{"description": "A username (with or without @) or a profile or repository URL (github.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Profile URL (github.com/<user>).", "hosts": ["github.com"], "name": "url", "required": false, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/github/user/following", "platform": "github", "response": "ListPage[Profile]", "summary": "GitHub following", "title": "GitHub"},
168
+ {"common": true, "credits": "1 credit", "description": "The public contribution graph for one year: the total and a count per day.", "example": {"handle": "torvalds", "year": 2025}, "id": "github.user.contributions", "one_of": [["handle", "url"]], "paginated": false, "params": [{"description": "A username (with or without @) or a profile or repository URL (github.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Profile URL (github.com/<user>).", "hosts": ["github.com"], "name": "url", "required": false, "type": "url"}, {"description": "Calendar year (2008 onward); default the current year.", "maximum": 2100, "minimum": 2008, "name": "year", "required": false, "type": "integer"}], "path": "/v1/github/user/contributions", "platform": "github", "response": "Contributions", "summary": "GitHub contribution calendar", "title": "GitHub"},
169
+ {"common": true, "credits": "1 credit", "description": "The profile's contribution activity timeline (commits, repositories created, pull requests, issues, reviews), one month a page, newest month first, paging backward through the year.", "example": {"cursor": "7", "handle": "gaearon", "year": 2025}, "id": "github.user.activity", "one_of": [["handle", "url"]], "paginated": true, "params": [{"description": "A username (with or without @) or a profile or repository URL (github.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Profile URL (github.com/<user>).", "hosts": ["github.com"], "name": "url", "required": false, "type": "url"}, {"description": "Calendar year (2008 onward); default the current year.", "maximum": 2100, "minimum": 2008, "name": "year", "required": false, "type": "integer"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/github/user/activity", "platform": "github", "response": "ListPage[Activity]", "summary": "GitHub public activity", "title": "GitHub"},
170
+ {"common": true, "credits": "1 credit", "description": "Public pull requests the user authored, newest first, from GitHub's public search index, which serves at most the first 1,000 results of any search.", "example": {"handle": "torvalds"}, "id": "github.user.pull_requests", "one_of": [["handle", "url"]], "paginated": true, "params": [{"description": "A username (with or without @) or a profile or repository URL (github.com/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Profile URL (github.com/<user>).", "hosts": ["github.com"], "name": "url", "required": false, "type": "url"}, {"default": "all", "description": "PR state.", "enum": ["open", "closed", "merged", "all"], "name": "state", "required": false, "type": "string"}, {"description": "Only pull requests created on or after this date (YYYY-MM-DD).", "name": "since", "required": false, "type": "string"}, {"description": "Only pull requests created on or before this date (YYYY-MM-DD).", "name": "until", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/github/user/pull-requests", "platform": "github", "response": "ListPage[PullRequest]", "summary": "GitHub pull requests by a user", "title": "GitHub"},
171
+ {"common": true, "credits": "1 credit", "description": "GitHub's public Trending page: ranked repositories with description, language, stars, forks, stars gained in the range and the users who built them. `watchers` is empty on trending items; the Trending page does not show it (`github.repository` returns it).", "example": {"language": "python", "since": "weekly"}, "id": "github.trending.repositories", "one_of": [], "paginated": true, "params": [{"description": "Coding language, e.g. javascript, python, go.", "name": "language", "required": false, "type": "string"}, {"default": "daily", "description": "Trending range.", "enum": ["daily", "weekly", "monthly"], "name": "since", "required": false, "type": "string"}, {"description": "Spoken language filter, e.g. en.", "name": "spoken_language_code", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/github/trending/repositories", "platform": "github", "response": "ListPage[Repo]", "summary": "GitHub trending repositories", "title": "GitHub"},
172
+ {"common": true, "credits": "1 credit", "description": "GitHub's public Trending developers page: ranked users with name, avatar and the popular repository GitHub shows for them (in `extra`).", "example": {"language": "python", "since": "weekly"}, "id": "github.trending.developers", "one_of": [], "paginated": true, "params": [{"description": "Coding language, e.g. javascript, python, go.", "name": "language", "required": false, "type": "string"}, {"default": "daily", "description": "Trending range.", "enum": ["daily", "weekly", "monthly"], "name": "since", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/github/trending/developers", "platform": "github", "response": "ListPage[Profile]", "summary": "GitHub trending developers", "title": "GitHub"},
173
+ {"common": true, "credits": "1 credit", "description": "A public profile: name, bio, avatar, verification, counts of posts, likes, followers and following. Kwai's follower figure is unreliable (the official Brazil account reports 1), so treat it with care.", "example": {"handle": "KwaiBrasilOficial"}, "id": "kwai.profile", "one_of": [["url", "handle"]], "paginated": false, "params": [{"description": "Profile URL (kwai.com/@<user>).", "hosts": ["kwai.com"], "name": "url", "required": false, "type": "url"}, {"description": "A username (with or without @) or a profile or post URL (kwai.com/@<name>).", "name": "handle", "required": false, "type": "string"}], "path": "/v1/kwai/profile", "platform": "kwai", "response": "Profile", "summary": "Kwai profile", "title": "Kwai"},
174
+ {"common": true, "credits": "1 credit", "description": "A user's public posts: caption, media URLs, covers, counts and author. Pass the cursor back for more.", "example": {"handle": "KwaiBrasilOficial", "limit": 10}, "id": "kwai.profile.posts", "one_of": [["url", "handle"]], "paginated": true, "params": [{"description": "Profile URL (kwai.com/@<user>).", "hosts": ["kwai.com"], "name": "url", "required": false, "type": "url"}, {"description": "A username (with or without @) or a profile or post URL (kwai.com/@<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Number of posts per page, at most 50.", "maximum": 50, "minimum": 1, "name": "limit", "required": false, "type": "integer"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/kwai/profile/posts", "platform": "kwai", "response": "ListPage[Post]", "summary": "Kwai profile posts", "title": "Kwai"},
175
+ {"common": true, "credits": "1 credit", "description": "", "example": {"url": "https://www.kwai.com/@KwaiBrasilOficial/video/5193363430624671876"}, "id": "kwai.post", "one_of": [], "paginated": false, "params": [{"description": "Post URL (kwai.com/@<user>/video/<id>; the /photo/<id> form works too).", "hosts": ["kwai.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/kwai/post", "platform": "kwai", "response": "Post", "summary": "Kwai post", "title": "Kwai"},
176
+ {"common": true, "credits": "1 credit", "description": "One video by link: title, description, channel, views, likes, comment count, duration, publish time, thumbnail, media URLs and caption languages. Embed links (rumble.com/embed/v...) work too.", "example": {"url": "https://rumble.com/v79xhhm-discovery-why-glenn-wants-israel-to-sue-the-new-york-times.html"}, "id": "rumble.video", "one_of": [], "paginated": false, "params": [{"description": "Video URL (rumble.com/v...-title.html).", "hosts": ["rumble.com"], "name": "url", "required": true, "type": "url"}], "path": "/v1/rumble/video", "platform": "rumble", "response": "Post", "summary": "Rumble video details", "title": "Rumble"},
177
+ {"common": true, "credits": "1 credit", "description": "A channel's videos (shorts are marked `type: short`) with the channel details in `parent`. Pass the cursor back for the next page of about 25.", "example": {"handle": "CuteCats223"}, "id": "rumble.channel.videos", "one_of": [["handle", "url"]], "paginated": true, "params": [{"description": "A channel handle, c/<name> or user/<name>, or a channel URL (rumble.com/c/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Channel URL (rumble.com/c/<handle> or rumble.com/user/<handle>).", "hosts": ["rumble.com"], "name": "url", "required": false, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/rumble/channel/videos", "platform": "rumble", "response": "ListPage[Post]", "summary": "Rumble channel videos", "title": "Rumble"},
178
+ {"common": true, "credits": "1 credit", "description": "Search Rumble videos. Each result has the title, channel, views, likes, duration, publish time and thumbnail; pass the cursor back for the next page of about 25.", "example": {"query": "funny cats"}, "id": "rumble.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Order of results. Changing it restarts the cursor chain.", "enum": ["relevance", "views", "latest"], "name": "sort", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/rumble/search", "platform": "rumble", "response": "ListPage[Post]", "summary": "Rumble search", "title": "Rumble"},
179
+ {"common": true, "credits": "1 credit", "description": "The comments on a video in one page, in Rumble's own order, with likes, dislikes and reply counts. Replies come after the comment they answer, with `parent_id` set. Videos whose comments Rumble shows only to signed-in users answer `private`. `parent` is the video.", "example": {"url": "https://rumble.com/v79xhhm-discovery-why-glenn-wants-israel-to-sue-the-new-york-times.html"}, "id": "rumble.video.comments", "one_of": [], "paginated": true, "params": [{"description": "Video URL (rumble.com/v...-title.html).", "hosts": ["rumble.com"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/rumble/video/comments", "platform": "rumble", "response": "ListPage[Comment]", "summary": "Rumble video comments", "title": "Rumble"},
180
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "Captions when Rumble has them (its own auto captions count as captions); AI transcription of the audio when it does not.", "example": {"url": "https://rumble.com/v79xhhm-discovery-why-glenn-wants-israel-to-sue-the-new-york-times.html"}, "id": "rumble.video.transcript", "one_of": [], "paginated": false, "params": [{"description": "Video URL (rumble.com/v...-title.html).", "hosts": ["rumble.com"], "name": "url", "required": true, "type": "url"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}], "path": "/v1/rumble/video/transcript", "platform": "rumble", "response": "Transcript", "summary": "Rumble video transcript", "title": "Rumble"},
181
+ {"common": true, "credits": "1 credit", "description": "Name, description, avatar, verification, member count and media counters of a public channel or group, read from Telegram's public web preview (no Telegram account). Private and invite-only chats are not supported.", "example": {"handle": "durov"}, "id": "telegram.channel", "one_of": [["handle", "url"]], "paginated": false, "params": [{"description": "A channel username (with or without @) or a channel or post URL (t.me/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Channel URL (t.me/<name>).", "hosts": ["t.me", "telegram.me"], "name": "url", "required": false, "type": "url"}], "path": "/v1/telegram/channel", "platform": "telegram", "response": "Community", "summary": "Telegram public channel", "title": "Telegram"},
182
+ {"common": true, "credits": "1 credit", "description": "One web-preview page of posts: text, date, views, reactions, forwards and media previews. The cursor (a post number) fetches the previous page.", "example": {"handle": "durov"}, "id": "telegram.channel.posts", "one_of": [["handle", "url"]], "paginated": true, "params": [{"description": "A channel username (with or without @) or a channel or post URL (t.me/<name>).", "name": "handle", "required": false, "type": "string"}, {"description": "Channel URL (t.me/<name>).", "hosts": ["t.me", "telegram.me"], "name": "url", "required": false, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/telegram/channel/posts", "platform": "telegram", "response": "ListPage[Post]", "summary": "Telegram public channel posts", "title": "Telegram"},
183
+ {"common": true, "credits": "1 credit", "description": "One public post by URL: text, date, views, reactions, forward source, media and link previews.", "example": {"url": "https://t.me/durov/543"}, "id": "telegram.post", "one_of": [], "paginated": false, "params": [{"description": "Post URL (t.me/<channel>/<number>).", "hosts": ["t.me", "telegram.me"], "name": "url", "required": true, "type": "url"}], "path": "/v1/telegram/post", "platform": "telegram", "response": "Post", "summary": "Telegram public post", "title": "Telegram"},
184
+ {"common": true, "credits": "1 credit", "description": "Organic web search results with URL, title, description, displayed URL and, when the page prints one, its date. The results come from Yahoo Japan's search (search.yahoo.co.jp), not from google.com: the order, some URLs and some snippets differ from Google's own page. Measured against stored real Google first pages for 18 searches, 5.5 of 8.7 URLs on average were also on Google's page (63%, from 2 to 8; the first result was the same on 12 of 22 tries). Organic results only: no ads, answer boxes or related searches. `date_posted` takes hour, day, week, month or year. The cursor is the next page, 1 to 10 of about 10 results each; `page` works as the cursor. There is no region or language option, and searches for places near you follow our servers' location, not yours. When the search provider refuses every try the call fails and can be retried.", "example": {"query": "social media api"}, "id": "google.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Only results from this window.", "enum": ["hour", "day", "week", "month", "year"], "name": "date_posted", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/google/search", "platform": "google", "response": "ListPage[SearchResult]", "summary": "Google-style web search results", "title": "Google"},
185
+ {"common": true, "credits": "1 credit", "description": "A public Cosmos profile: bio, links and follower counts.", "example": {"handle": "design"}, "id": "cosmos.profile", "one_of": [], "paginated": false, "params": [{"description": "A username (with or without @) or a profile URL (cosmos.so/<name>).", "name": "handle", "required": true, "type": "string"}], "path": "/v1/cosmos/profile", "platform": "cosmos", "response": "Profile", "summary": "Cosmos profile", "title": "Cosmos"},
186
+ {"common": true, "credits": "1 credit", "description": "The public posts saved to a profile. Keep the cursor unchanged and stop when `has_more` is false.", "example": {"handle": "design"}, "id": "cosmos.profile.posts", "one_of": [], "paginated": true, "params": [{"description": "A username (with or without @) or a profile URL (cosmos.so/<name>).", "name": "handle", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/cosmos/profile/posts", "platform": "cosmos", "response": "ListPage[Post]", "summary": "Cosmos profile posts", "title": "Cosmos"},
187
+ {"common": true, "credits": "1 credit", "description": "The public collections a user owns. Keep the cursor unchanged and stop when `has_more` is false.", "example": {"handle": "design"}, "id": "cosmos.profile.collections", "one_of": [], "paginated": true, "params": [{"description": "A username (with or without @) or a profile URL (cosmos.so/<name>).", "name": "handle", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/cosmos/profile/collections", "platform": "cosmos", "response": "ListPage[Collection]", "summary": "Cosmos profile collections", "title": "Cosmos"},
188
+ {"common": true, "credits": "1 credit", "description": "A public Cosmos post: media URLs, captions, source links and the save count.", "example": {"url": "https://www.cosmos.so/e/2107587668"}, "id": "cosmos.post", "one_of": [], "paginated": false, "params": [{"description": "Public post URL (cosmos.so/e/<id>).", "hosts": ["cosmos.so"], "name": "url", "required": true, "type": "url"}], "path": "/v1/cosmos/post", "platform": "cosmos", "response": "Post", "summary": "Cosmos post", "title": "Cosmos"},
189
+ {"common": true, "credits": "1 credit", "description": "A public collection: owner, description, cover, counts and its public subcollections (in `extra`).", "example": {"url": "https://www.cosmos.so/design/the-best-band-posters"}, "id": "cosmos.collection", "one_of": [], "paginated": false, "params": [{"description": "Public collection URL (cosmos.so/<user>/<collection>).", "hosts": ["cosmos.so"], "name": "url", "required": true, "type": "url"}], "path": "/v1/cosmos/collection", "platform": "cosmos", "response": "Collection", "summary": "Cosmos collection", "title": "Cosmos"},
190
+ {"common": true, "credits": "1 credit", "description": "Public posts saved to a collection; `parent` is the collection.", "example": {"url": "https://www.cosmos.so/design/the-best-band-posters"}, "id": "cosmos.collection.posts", "one_of": [], "paginated": true, "params": [{"description": "Public collection URL (cosmos.so/<user>/<collection>).", "hosts": ["cosmos.so"], "name": "url", "required": true, "type": "url"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/cosmos/collection/posts", "platform": "cosmos", "response": "ListPage[Post]", "summary": "Cosmos collection posts", "title": "Cosmos"},
191
+ {"common": true, "credits": "1 credit", "description": "Search public Cosmos posts by keyword. Cosmos may return related posts without an exact match.", "example": {"query": "architecture"}, "id": "cosmos.search", "one_of": [], "paginated": true, "params": [{"description": "Search terms.", "name": "query", "required": true, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/cosmos/search", "platform": "cosmos", "response": "ListPage[Post]", "summary": "Cosmos search", "title": "Cosmos"},
192
+ {"common": true, "credits": "1 credit for captions; AI transcription 1 up to 2 minutes, then 5 per started minute of the whole video", "description": "Detects the platform from the URL and runs its transcript endpoint: YouTube, TikTok, Instagram, X, Facebook, LinkedIn, Reddit, Twitch clips, Kick clips and Rumble. Same price, same cache.", "example": {"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"}, "id": "transcript", "one_of": [], "paginated": false, "params": [{"description": "Video URL on any supported platform.", "hosts": ["youtube.com", "youtu.be", "tiktok.com", "instagram.com", "instagr.am", "x.com", "twitter.com", "rumble.com", "twitch.tv", "kick.com", "facebook.com", "fb.com", "fb.watch", "linkedin.com", "reddit.com", "redd.it"], "name": "url", "required": true, "type": "url"}, {"description": "Preferred caption language (BCP 47).", "name": "language", "required": false, "type": "string"}, {"description": "Transcribe audio past 2 minutes with AI, at 5 credits per started minute of the whole video. Without it a longer video answers invalid_params naming the cost, which is free.", "name": "allow_long_transcription", "required": false, "type": "boolean"}], "path": "/v1/transcript", "platform": "transcript", "response": "Transcript", "summary": "Transcript from any video URL", "title": "Transcript from any URL"},
193
+ {"common": false, "credits": "Free", "description": "The credits left for the team behind the key. Free.", "example": {}, "id": "account.credits", "one_of": [], "paginated": false, "params": [], "path": "/v1/account/credits", "platform": "account", "response": "CreditBalance", "summary": "Credit balance", "title": "Account"},
194
+ {"common": false, "credits": "Free", "description": "The team's past API requests, newest first: endpoint, status, credits charged and time. Free. The cursor is the page number (at most 100 pages).", "example": {}, "id": "account.usage", "one_of": [], "paginated": true, "params": [{"description": "Only requests whose path contains this text, \"/v1/tiktok/profile\".", "name": "endpoint", "required": false, "type": "string"}, {"description": "Only requests that answered this HTTP status.", "name": "status", "required": false, "type": "integer"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/account/usage", "platform": "account", "response": "ListPage[RequestLogEntry]", "summary": "Request history", "title": "Account"},
195
+ {"common": false, "credits": "Free", "description": "Requests and credits charged per day for the last 30 days. Free.", "example": {}, "id": "account.usage.daily", "one_of": [], "paginated": true, "params": [{"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/account/usage/daily", "platform": "account", "response": "ListPage[UsageStat]", "summary": "Daily usage", "title": "Account"},
196
+ {"common": false, "credits": "Free", "description": "The team's 20 most called endpoints with requests and credits charged each. Defaults to the last 24 hours; custom ranges up to one year. Free.", "example": {}, "id": "account.usage.routes", "one_of": [], "paginated": true, "params": [{"description": "Start of the range, ISO 8601.", "name": "start_time", "required": false, "type": "string"}, {"description": "End of the range, ISO 8601.", "name": "end_time", "required": false, "type": "string"}, {"description": "Opaque cursor from the previous page; pass it back unchanged.", "name": "cursor", "required": false, "type": "string"}], "path": "/v1/account/usage/routes", "platform": "account", "response": "ListPage[UsageStat]", "summary": "Most used endpoints", "title": "Account"}
197
+ ]
198
+ }