{ "product": "Social Fetch", "generatedFrom": [ "OpenAPI", "public-api-endpoint-metadata", "docs-operation-urls.json", "sdk-method-docs.ts" ], "docs": { "llmsTxtUrl": "https://www.socialfetch.dev/llms.txt", "llmsJsonUrl": "https://www.socialfetch.dev/llms.json", "docsHomeMarkdownUrl": "https://www.socialfetch.dev/docs.mdx", "quickstartMarkdownUrl": "https://www.socialfetch.dev/docs/quickstart.mdx", "sdkMarkdownUrl": "https://www.socialfetch.dev/docs/sdk.mdx", "sdkReferenceMarkdownUrl": "https://www.socialfetch.dev/docs/sdk-reference.mdx", "chooseEndpointMarkdownUrl": "https://www.socialfetch.dev/docs/choose-endpoint.mdx", "capabilityMatrixMarkdownUrl": "https://www.socialfetch.dev/docs/capability-matrix.mdx", "apiIndexMarkdownUrl": "https://www.socialfetch.dev/docs/api.mdx", "errorsMarkdownUrl": "https://www.socialfetch.dev/docs/errors.mdx", "creditsMarkdownUrl": "https://www.socialfetch.dev/docs/credits.mdx", "integrationsMarkdownUrl": "https://www.socialfetch.dev/docs/integrations.mdx", "integrationsN8nMarkdownUrl": "https://www.socialfetch.dev/docs/integrations/n8n.mdx", "openApiUrl": "https://www.socialfetch.dev/openapi.json" }, "counts": { "documentedOperations": 111, "sdkWrappedOperations": 111, "httpOnlyOperations": 0 }, "operations": [ { "method": "GET", "path": "/v1/tiktok/profiles/{handle}", "summary": "Get TikTok profile", "tag": "TikTok", "operationId": "tiktok.profile.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/profiles/handle/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getProfile", "signature": "client.tiktok.getProfile({ handle })", "clientCall": "client.tiktok.getProfile({ handle })" }, "parameterNames": [ "handle" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "TikTok handle to look up, with or without a leading @." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "private", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/profiles/{handle}/videos", "summary": "List TikTok profile videos", "tag": "TikTok", "operationId": "tiktok.profile.videos.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/profiles/handle/videos/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/videos/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/videos/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getProfileVideos", "signature": "client.tiktok.getProfileVideos({ handle, sortBy?, cursor?, userId?, region?, trim? })", "clientCall": "client.tiktok.getProfileVideos({ handle, cursor? })" }, "parameterNames": [ "handle", "sortBy", "cursor", "userId", "region", "trim" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "TikTok handle whose videos should be listed." }, { "name": "userId", "location": "query", "required": false, "type": "string", "description": "Optional TikTok user id to speed up the request." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [ "latest", "popular" ], "orderingHint": "Supported sort options: latest, popular.", "supportsTrim": true, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.videos` array can mean no videos in the selected sort window, a private profile, or other cases—there is no `lookupStatus` field on this route.", "disambiguation": "Call `GET /v1/tiktok/profiles/{handle}` when you need explicit `lookupStatus` including `private` or `not_found` before interpreting an empty video list." } }, { "method": "GET", "path": "/v1/tiktok/profiles/{handle}/followers", "summary": "List TikTok profile followers", "tag": "TikTok", "operationId": "tiktok.profile.followers.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/profiles/handle/followers/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/followers/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/followers/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getProfileFollowers", "signature": "client.tiktok.getProfileFollowers({ handle, cursor?, userId?, trim? })", "clientCall": "client.tiktok.getProfileFollowers({ handle, cursor? })" }, "parameterNames": [ "handle", "cursor", "userId", "trim" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "TikTok handle whose followers should be listed." }, { "name": "userId", "location": "query", "required": false, "type": "string", "description": "Optional TikTok user id to speed up the request." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "hidden", "private", "not_found" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.followers` array with `lookupStatus: \"found\"` means the profile resolved but this page returned no followers (for example a zero-follower account).", "disambiguation": "Use `lookupStatus` to distinguish found, hidden, private, and not_found. Call `GET /v1/tiktok/profiles/{handle}` when you need full profile details." } }, { "method": "GET", "path": "/v1/tiktok/profiles/{handle}/following", "summary": "List TikTok profile following", "tag": "TikTok", "operationId": "tiktok.profile.following.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/profiles/handle/following/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/following/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/following/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getProfileFollowing", "signature": "client.tiktok.getProfileFollowing({ handle, cursor?, trim? })", "clientCall": "client.tiktok.getProfileFollowing({ handle, cursor? })" }, "parameterNames": [ "handle", "cursor", "trim" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "TikTok handle whose following list should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "hidden", "private", "not_found" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.accounts` array with `lookupStatus: \"found\"` means the profile resolved but this page returned no accounts (for example the profile follows nobody).", "disambiguation": "Use `lookupStatus` to distinguish found, hidden, private, and not_found. Call `GET /v1/tiktok/profiles/{handle}` when you need full profile details." } }, { "method": "GET", "path": "/v1/tiktok/profiles/{handle}/region", "summary": "Get TikTok profile region", "tag": "TikTok", "operationId": "tiktok.profile.region.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/profiles/handle/region/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/region/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/region/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getProfileRegion", "signature": "client.tiktok.getProfileRegion({ handle })", "clientCall": "client.tiktok.getProfileRegion({ handle })" }, "parameterNames": [ "handle" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "TikTok handle to look up, with or without a leading @." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/profiles/{handle}/live", "summary": "Get TikTok live stream", "tag": "TikTok", "operationId": "tiktok.profile.live.check", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/profiles/handle/live/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/live/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/live/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getProfileLive", "signature": "client.tiktok.getProfileLive({ handle })", "clientCall": "client.tiktok.getProfileLive({ handle })" }, "parameterNames": [ "handle" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "TikTok handle to look up, with or without a leading @." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/users/search", "summary": "Search TikTok users", "tag": "TikTok", "operationId": "tiktok.users.search", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/users/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/users/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/users/search/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "searchUsers", "signature": "client.tiktok.searchUsers({ query, cursor? })", "clientCall": "client.tiktok.searchUsers({ query })" }, "parameterNames": [ "query", "cursor" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/search", "summary": "Search TikTok videos", "tag": "TikTok", "operationId": "tiktok.search.videos.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/search/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "searchVideos", "signature": "client.tiktok.searchVideos({ query, datePosted?, sortBy?, region?, cursor?, trim? })", "clientCall": "client.tiktok.searchVideos({ query: \"web scraping\" })" }, "parameterNames": [ "query", "datePosted", "sortBy", "region", "cursor", "trim" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [ "relevance", "most-liked", "date-posted" ], "orderingHint": "Supported sort options: relevance, most-liked, date-posted.", "supportsTrim": true, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/search/hashtags", "summary": "Search TikTok by hashtag", "tag": "TikTok", "operationId": "tiktok.search.hashtag.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/search/hashtags/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/search/hashtags/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/search/hashtags/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "searchHashtags", "signature": "client.tiktok.searchHashtags({ hashtag, region?, cursor?, trim? })", "clientCall": "client.tiktok.searchHashtags({ hashtag: \"fyp\" })" }, "parameterNames": [ "hashtag", "region", "cursor", "trim" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false, "agentHints": { "disambiguation": "Use `data.page.hasMore` and `data.page.nextCursor` for pagination. Repeat the same hashtag and filters when requesting the next page." } }, { "method": "GET", "path": "/v1/tiktok/videos", "summary": "Get TikTok video", "tag": "TikTok", "operationId": "tiktok.video.get", "requiresApiKey": true, "creditsNote": "1 credit base, +10 with `downloadMedia`. Up to 11 credits max.", "docsPathname": "/docs/api/v1/tiktok/videos/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/videos/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/videos/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getVideo", "signature": "client.tiktok.getVideo({ url, region?, trim?, downloadMedia? })", "clientCall": "client.tiktok.getVideo({ url })" }, "parameterNames": [ "url", "region", "trim", "downloadMedia", "getTranscript" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the video or photo post." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": true }, { "method": "GET", "path": "/v1/tiktok/videos/comments", "summary": "List TikTok video comments", "tag": "TikTok", "operationId": "tiktok.video.comments.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/videos/comments/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/videos/comments/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/videos/comments/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getVideoComments", "signature": "client.tiktok.getVideoComments({ url, cursor?, trim? })", "clientCall": "client.tiktok.getVideoComments({ url })" }, "parameterNames": [ "url", "cursor", "trim" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the TikTok video whose comments should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/videos/transcript", "summary": "Get TikTok video transcript", "tag": "TikTok", "operationId": "tiktok.video.transcript.get", "requiresApiKey": true, "creditsNote": "1 credit base, +10 with `useAiFallback`. Up to 11 credits max.", "docsPathname": "/docs/api/v1/tiktok/videos/transcript/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/videos/transcript/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/videos/transcript/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getVideoTranscript", "signature": "client.tiktok.getVideoTranscript({ url, language?, useAiFallback? })", "clientCall": "client.tiktok.getVideoTranscript({ url })" }, "parameterNames": [ "url", "language", "useAiFallback" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the TikTok video whose transcript should be returned." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/feed/trending", "summary": "List TikTok trending feed", "tag": "TikTok", "operationId": "tiktok.feed.trending.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/feed/trending/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/feed/trending/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/feed/trending/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "listTrendingFeed", "signature": "client.tiktok.listTrendingFeed({ region, trim? })", "clientCall": "client.tiktok.listTrendingFeed({ region: 'US' })" }, "parameterNames": [ "region", "trim" ], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.items` array means no trending posts were available for that request.", "disambiguation": "Repeat the same request for a fresh trending batch. New and overlapping posts are both possible. No cursor or page parameters." } }, { "method": "GET", "path": "/v1/tiktok/shop/products/search", "summary": "Search TikTok Shop products", "tag": "TikTok", "operationId": "tiktok.shop.products.search", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/shop/products/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/shop/products/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/shop/products/search/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "searchShopProducts", "signature": "client.tiktok.searchShopProducts({ query, page?, region? })", "clientCall": "client.tiktok.searchShopProducts({ query })" }, "parameterNames": [ "query", "page", "region" ], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/shop/products", "summary": "List TikTok Shop store products", "tag": "TikTok", "operationId": "tiktok.shop.products.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/shop/products/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/shop/products/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/shop/products/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "listShopProducts", "signature": "client.tiktok.listShopProducts({ url, cursor?, region? })", "clientCall": "client.tiktok.listShopProducts({ url })" }, "parameterNames": [ "url", "cursor", "region" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Public TikTok Shop store URL whose products should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/products", "summary": "Get TikTok Shop product", "tag": "TikTok", "operationId": "tiktok.product.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/products/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/products/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/products/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getProduct", "signature": "client.tiktok.getProduct({ url, region? })", "clientCall": "client.tiktok.getProduct({ url })" }, "parameterNames": [ "url", "region" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Public TikTok Shop product detail page URL for the product to retrieve." } ], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/products/reviews", "summary": "List TikTok Shop product reviews", "tag": "TikTok", "operationId": "tiktok.product.reviews.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/products/reviews/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/products/reviews/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/products/reviews/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getProductReviews", "signature": "client.tiktok.getProductReviews({ url?, productId?, region?, page? })", "clientCall": "client.tiktok.getProductReviews({ url: 'https://www.tiktok.com/shop/pdp/...' })" }, "parameterNames": [ "url", "productId", "region", "page" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": false, "type": "string", "description": "Public TikTok Shop product detail page URL for the product whose reviews should be listed." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/tiktok/profiles/{handle}/showcase-products", "summary": "List TikTok profile showcase products", "tag": "TikTok", "operationId": "tiktok.profile.showcaseProducts.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/tiktok/profiles/handle/showcase-products/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/showcase-products/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/showcase-products/get.mdx", "sdkMethod": { "resource": "tiktok", "methodName": "getProfileShowcaseProducts", "signature": "client.tiktok.getProfileShowcaseProducts({ handle, cursor?, region? })", "clientCall": "client.tiktok.getProfileShowcaseProducts({ handle, cursor? })" }, "parameterNames": [ "handle", "cursor", "region" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "TikTok handle whose profile showcase products should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.products` array can mean no showcased products, a private profile, or other cases—there is no `lookupStatus` field on this route.", "disambiguation": "Call `GET /v1/tiktok/profiles/{handle}` when you need explicit profile lookup status before interpreting an empty showcase list." } }, { "method": "GET", "path": "/v1/facebook/profiles", "summary": "Get Facebook profile", "tag": "Facebook", "operationId": "facebook.profile.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/profiles/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/profiles/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/profiles/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "getProfile", "signature": "client.facebook.getProfile({ url, includeBusinessHours? })", "clientCall": "client.facebook.getProfile({ url, includeBusinessHours? })" }, "parameterNames": [ "url", "includeBusinessHours" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Facebook public profile or page URL to look up." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "private", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/profiles/posts", "summary": "List Facebook profile posts", "tag": "Facebook", "operationId": "facebook.profile.posts.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/profiles/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/profiles/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/profiles/posts/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "getProfilePosts", "signature": "client.facebook.getProfilePosts({ url?, pageId?, cursor? })", "clientCall": "client.facebook.getProfilePosts({ url?, pageId?, cursor? })" }, "parameterNames": [ "url", "pageId", "cursor" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": false, "type": "string", "description": "Full public Facebook profile or page URL." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.posts` page with `hasMore: false` can represent no public posts, restricted visibility, or an unresolvable URL or id—there is no `lookupStatus` field on this route.", "disambiguation": "Call `GET /v1/facebook/profiles` first when you need `found` / `private` / `not_found` before interpreting an empty posts page." } }, { "method": "GET", "path": "/v1/facebook/profiles/reels", "summary": "List Facebook profile reels", "tag": "Facebook", "operationId": "facebook.profile.reels.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/profiles/reels/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/profiles/reels/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/profiles/reels/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "getProfileReels", "signature": "client.facebook.getProfileReels({ url, cursor? })", "clientCall": "client.facebook.getProfileReels({ url })" }, "parameterNames": [ "url", "cursor" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Public Facebook profile or page URL whose reels should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/profiles/photos", "summary": "List Facebook profile photos", "tag": "Facebook", "operationId": "facebook.profile.photos.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/profiles/photos/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/profiles/photos/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/profiles/photos/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "getProfilePhotos", "signature": "client.facebook.getProfilePhotos({ url, cursor? })", "clientCall": "client.facebook.getProfilePhotos({ url })" }, "parameterNames": [ "url", "cursor" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Public Facebook profile or page URL whose photos should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/posts", "summary": "Get Facebook post or reel", "tag": "Facebook", "operationId": "facebook.post.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/posts/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "getPost", "signature": "client.facebook.getPost({ url, includeComments?, includeTranscript? })", "clientCall": "client.facebook.getPost({ url })" }, "parameterNames": [ "url", "includeComments", "includeTranscript" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Public permalink to the Facebook post or reel." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/posts/comments", "summary": "List Facebook post or reel comments", "tag": "Facebook", "operationId": "facebook.post.comments.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/posts/comments/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/posts/comments/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/posts/comments/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "getPostComments", "signature": "client.facebook.getPostComments({ url?, cursor?, feedbackId? })", "clientCall": "client.facebook.getPostComments({ url })" }, "parameterNames": [ "url", "cursor", "feedbackId" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": false, "type": "string", "description": "Link to the Facebook post or reel whose comments should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/posts/transcript", "summary": "Get Facebook post transcript", "tag": "Facebook", "operationId": "facebook.post.transcript.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/posts/transcript/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/posts/transcript/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/posts/transcript/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "getPostTranscript", "signature": "client.facebook.getPostTranscript({ url })", "clientCall": "client.facebook.getPostTranscript({ url })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the Facebook post or reel whose transcript should be returned." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found", "lookup_failed" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/groups/posts", "summary": "List Facebook group posts", "tag": "Facebook", "operationId": "facebook.group.posts.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/groups/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/groups/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/groups/posts/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "listGroupPosts", "signature": "client.facebook.listGroupPosts({ url, sortBy?, cursor? })", "clientCall": "client.facebook.listGroupPosts({ url, sortBy?, cursor? })" }, "parameterNames": [ "url", "sortBy", "cursor" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Public Facebook group URL whose posts should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [ "top", "recentActivity", "chronological", "chronologicalListings" ], "orderingHint": "Supported sort options: top, recentActivity, chronological, chronologicalListings.", "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/marketplace/items", "summary": "Get Facebook Marketplace item", "tag": "Facebook", "operationId": "facebook.marketplace.item.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/marketplace/items/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/marketplace/items/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/marketplace/items/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "getMarketplaceItem", "signature": "client.facebook.getMarketplaceItem({ itemId?, url? })", "clientCall": "client.facebook.getMarketplaceItem({ itemId: \"1656586118821988\" })" }, "parameterNames": [ "itemId", "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": false, "type": "string", "description": "Public Facebook Marketplace item URL." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/marketplace/locations/search", "summary": "Search Facebook Marketplace locations", "tag": "Facebook", "operationId": "facebook.marketplace.locations.search", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/marketplace/locations/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/marketplace/locations/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/marketplace/locations/search/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "searchMarketplaceLocations", "signature": "client.facebook.searchMarketplaceLocations({ query })", "clientCall": "client.facebook.searchMarketplaceLocations({ query: \"Austin\" })" }, "parameterNames": [ "query" ], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/marketplace/search", "summary": "Search Facebook Marketplace listings", "tag": "Facebook", "operationId": "facebook.marketplace.search.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/marketplace/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/marketplace/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/marketplace/search/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "searchMarketplace", "signature": "client.facebook.searchMarketplace({ query, lat, lng, sortBy?, deliveryMethod?, cursor?, ... })", "clientCall": "client.facebook.searchMarketplace({ query: \"bike\", lat: 30.2677, lng: -97.7475 })" }, "parameterNames": [ "query", "lat", "lng", "radiusKm", "minPrice", "maxPrice", "count", "sortBy", "deliveryMethod", "condition", "dateListed", "availability", "cursor" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [ "suggested", "distanceAscend", "creationTimeDescend", "priceAscend", "priceDescend" ], "orderingHint": "Supported sort options: suggested, distanceAscend, creationTimeDescend, priceAscend, priceDescend.", "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/ad-library/ads", "summary": "Get Facebook Ad Library ad", "tag": "Facebook", "operationId": "facebook.adLibrary.ad.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/ad-library/ads/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/ad-library/ads/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/ad-library/ads/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "getAdLibraryAd", "signature": "client.facebook.getAdLibraryAd({ adId?, url?, includeTranscript?, trim? })", "clientCall": "client.facebook.getAdLibraryAd({ adId: \"902134546059754\", includeTranscript: true })" }, "parameterNames": [ "adId", "url", "includeTranscript", "trim" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": false, "type": "string", "description": "Public Facebook Ad Library URL for the ad." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/ad-library/ads/search", "summary": "Search Facebook Ad Library ads", "tag": "Facebook", "operationId": "facebook.adLibrary.ads.search.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/ad-library/ads/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/ad-library/ads/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/ad-library/ads/search/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "searchAdLibraryAds", "signature": "client.facebook.searchAdLibraryAds({ query, sortBy?, searchType?, adType?, country?, status?, mediaType?, startDate?, endDate?, cursor?, trim? })", "clientCall": "client.facebook.searchAdLibraryAds({ query: \"running\", mediaType: \"video\" })" }, "parameterNames": [ "query", "sortBy", "searchType", "adType", "country", "status", "mediaType", "startDate", "endDate", "cursor", "trim" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [ "impressions", "most-recent" ], "orderingHint": "Supported sort options: impressions, most-recent.", "supportsTrim": true, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/ad-library/companies/ads", "summary": "List Facebook company ads", "tag": "Facebook", "operationId": "facebook.company.ads.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/ad-library/companies/ads/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/ad-library/companies/ads/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/ad-library/companies/ads/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "listCompanyAds", "signature": "client.facebook.listCompanyAds({ pageId?, companyName?, country?, status?, mediaType?, language?, sortBy?, startDate?, endDate?, cursor? })", "clientCall": "client.facebook.listCompanyAds({ pageId: '367152833370567' })" }, "parameterNames": [ "pageId", "companyName", "country", "status", "mediaType", "language", "sortBy", "startDate", "endDate", "cursor" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [ "impressions", "most-recent" ], "orderingHint": "Supported sort options: impressions, most-recent.", "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/facebook/ad-library/companies/search", "summary": "Search Facebook ad library companies", "tag": "Facebook", "operationId": "facebook.adLibrary.companies.search", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/facebook/ad-library/companies/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/ad-library/companies/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/facebook/ad-library/companies/search/get.mdx", "sdkMethod": { "resource": "facebook", "methodName": "searchAdLibraryCompanies", "signature": "client.facebook.searchAdLibraryCompanies({ query })", "clientCall": "client.facebook.searchAdLibraryCompanies({ query: \"nike\" })" }, "parameterNames": [ "query" ], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/instagram/profiles/{handle}", "summary": "Get Instagram profile", "tag": "Instagram", "operationId": "instagram.profile.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/instagram/profiles/handle/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/profiles/handle/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/profiles/handle/get.mdx", "sdkMethod": { "resource": "instagram", "methodName": "getProfile", "signature": "client.instagram.getProfile({ handle })", "clientCall": "client.instagram.getProfile({ handle })" }, "parameterNames": [ "handle" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "Instagram handle to look up, with or without a leading @." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "private", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/instagram/profiles/{userId}/basic", "summary": "Get Instagram basic profile", "tag": "Instagram", "operationId": "instagram.profile.basic.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/instagram/profiles/userid/basic/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/profiles/userid/basic/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/profiles/userid/basic/get.mdx", "sdkMethod": { "resource": "instagram", "methodName": "getBasicProfile", "signature": "client.instagram.getBasicProfile({ userId })", "clientCall": "client.instagram.getBasicProfile({ userId })" }, "parameterNames": [ "userId" ], "acceptedIdentifiers": [ { "name": "userId", "location": "path", "required": true, "type": "string", "description": "Instagram numeric user id to look up." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "private", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/instagram/profiles/{handle}/posts", "summary": "List Instagram profile posts", "tag": "Instagram", "operationId": "instagram.profile.posts.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/instagram/profiles/handle/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/profiles/handle/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/profiles/handle/posts/get.mdx", "sdkMethod": { "resource": "instagram", "methodName": "getProfilePosts", "signature": "client.instagram.getProfilePosts({ handle, cursor? })", "clientCall": "client.instagram.getProfilePosts({ handle, cursor? })" }, "parameterNames": [ "handle", "cursor" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "Instagram handle whose posts should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "private", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "When `lookupStatus` is `found`, an empty `data.posts` page with `hasMore: false` can still mean a public profile with no posts in range. When `lookupStatus` is `private` or `not_found`, posts will be empty by design.", "disambiguation": "Use `data.lookupStatus` for the domain outcome; call `GET /v1/instagram/profiles/{handle}` when you need full profile cards and related fields." } }, { "method": "GET", "path": "/v1/instagram/profiles/{handle}/reels", "summary": "List Instagram profile reels", "tag": "Instagram", "operationId": "instagram.profile.reels.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/instagram/profiles/handle/reels/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/profiles/handle/reels/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/profiles/handle/reels/get.mdx", "sdkMethod": { "resource": "instagram", "methodName": "getProfileReels", "signature": "client.instagram.getProfileReels({ handle, cursor? })", "clientCall": "client.instagram.getProfileReels({ handle, cursor? })" }, "parameterNames": [ "handle", "cursor" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "Instagram handle whose reels should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "When `lookupStatus` is `found`, an empty `data.reels` page with `hasMore: false` can mean a public profile with no reels in range. When `lookupStatus` is `not_found`, reels will be empty by design.", "disambiguation": "Use `data.lookupStatus` for the domain outcome; call `GET /v1/instagram/profiles/{handle}` when you need full profile cards and related fields." } }, { "method": "GET", "path": "/v1/instagram/profiles/{handle}/highlights", "summary": "List Instagram profile highlights", "tag": "Instagram", "operationId": "instagram.profile.highlights.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/instagram/profiles/handle/highlights/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/profiles/handle/highlights/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/profiles/handle/highlights/get.mdx", "sdkMethod": { "resource": "instagram", "methodName": "getProfileHighlights", "signature": "client.instagram.getProfileHighlights({ handle })", "clientCall": "client.instagram.getProfileHighlights({ handle })" }, "parameterNames": [ "handle" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "Instagram handle whose story highlight albums should be listed." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "When `lookupStatus` is `found`, an empty `data.highlights` list can mean the profile has no visible story highlight albums. When `lookupStatus` is `not_found`, highlights will be empty by design.", "disambiguation": "Use `data.lookupStatus` for the domain outcome; call `GET /v1/instagram/profiles/{handle}` when you need full profile cards and related fields." } }, { "method": "GET", "path": "/v1/instagram/highlights/{highlightId}", "summary": "Get Instagram highlight", "tag": "Instagram", "operationId": "instagram.highlight.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/instagram/highlights/highlightid/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/highlights/highlightid/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/highlights/highlightid/get.mdx", "sdkMethod": { "resource": "instagram", "methodName": "getHighlight", "signature": "client.instagram.getHighlight({ highlightId })", "clientCall": "client.instagram.getHighlight({ highlightId })" }, "parameterNames": [ "highlightId" ], "acceptedIdentifiers": [], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/instagram/posts", "summary": "Get Instagram post or reel", "tag": "Instagram", "operationId": "instagram.post.get", "requiresApiKey": true, "creditsNote": "1 credit base, +10 with `downloadMedia`. Up to 11 credits max.", "docsPathname": "/docs/api/v1/instagram/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/posts/get.mdx", "sdkMethod": { "resource": "instagram", "methodName": "getPost", "signature": "client.instagram.getPost({ url, region?, trim?, downloadMedia? })", "clientCall": "client.instagram.getPost({ url })" }, "parameterNames": [ "url", "region", "trim", "downloadMedia" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the post or reel." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found", "restricted" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": true }, { "method": "GET", "path": "/v1/instagram/posts/comments", "summary": "List Instagram post or reel comments", "tag": "Instagram", "operationId": "instagram.post.comments.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/instagram/posts/comments/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/posts/comments/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/posts/comments/get.mdx", "sdkMethod": { "resource": "instagram", "methodName": "getPostComments", "signature": "client.instagram.getPostComments({ url, cursor? })", "clientCall": "client.instagram.getPostComments({ url })" }, "parameterNames": [ "url", "cursor" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the Instagram post or reel whose comments should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/instagram/posts/transcript", "summary": "Get Instagram post transcript", "tag": "Instagram", "operationId": "instagram.post.transcript.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/instagram/posts/transcript/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/posts/transcript/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/posts/transcript/get.mdx", "sdkMethod": { "resource": "instagram", "methodName": "getPostTranscript", "signature": "client.instagram.getPostTranscript({ url })", "clientCall": "client.instagram.getPostTranscript({ url })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the Instagram post or Reel whose transcript should be returned." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/instagram/search/reels", "summary": "Search Instagram Reels", "tag": "Instagram", "operationId": "instagram.search.reels.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/instagram/search/reels/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/search/reels/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/instagram/search/reels/get.mdx", "sdkMethod": { "resource": "instagram", "methodName": "searchReels", "signature": "client.instagram.searchReels({ query, datePosted?, page? })", "clientCall": "client.instagram.searchReels({ query: \"dogs\" })" }, "parameterNames": [ "query", "datePosted", "page" ], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/linkedin/profiles", "summary": "Get LinkedIn profiles", "tag": "LinkedIn", "operationId": "linkedin.profile.get", "requiresApiKey": true, "creditsNote": "2 credits per profile URL requested. Up to 50 profiles per request (100 credits max).", "docsPathname": "/docs/api/v1/linkedin/profiles/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/profiles/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/profiles/get.mdx", "sdkMethod": { "resource": "linkedin", "methodName": "getProfiles", "signature": "client.linkedin.getProfiles({ urls }) or client.linkedin.getProfile({ url })", "clientCall": "client.linkedin.getProfiles({ urls })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "array", "description": "LinkedIn profile URL." } ], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/linkedin/profiles/posts", "summary": "List LinkedIn profile posts", "tag": "LinkedIn", "operationId": "linkedin.profiles.posts.list", "requiresApiKey": true, "creditsNote": "2 credits per returned record. Up to 200 per request (400 credits max). `limit` defaults to 10.", "docsPathname": "/docs/api/v1/linkedin/profiles/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/profiles/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/profiles/posts/get.mdx", "sdkMethod": { "resource": "linkedin", "methodName": "listProfilePosts", "signature": "client.linkedin.listProfilePosts({ url, startDate?, endDate?, onlyAuthoredPosts? })", "clientCall": "client.linkedin.listProfilePosts({ url })" }, "parameterNames": [ "url", "startDate", "endDate", "onlyAuthoredPosts", "limit" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "LinkedIn profile URL or vanity handle whose public posts should be listed." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/linkedin/people/search", "summary": "Search LinkedIn people", "tag": "LinkedIn", "operationId": "linkedin.people.search.list", "requiresApiKey": true, "creditsNote": "2 credits per returned record. Up to 50 per request (100 credits max).", "docsPathname": "/docs/api/v1/linkedin/people/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/people/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/people/search/get.mdx", "sdkMethod": { "resource": "linkedin", "methodName": "searchPeople", "signature": "client.linkedin.searchPeople({ firstName?, lastName? })", "clientCall": "client.linkedin.searchPeople({ firstName: \"James\", lastName: \"Smith\" })" }, "parameterNames": [ "firstName", "lastName" ], "acceptedIdentifiers": [], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "This search usually takes around one and a half minutes to complete, so expect a longer wait than most endpoints." } }, { "method": "GET", "path": "/v1/linkedin/organizations", "summary": "Get LinkedIn organization page", "tag": "LinkedIn", "operationId": "linkedin.organization.get", "requiresApiKey": true, "creditsNote": "2 credits per organization URL requested. Up to 50 organizations per request (100 credits max).", "docsPathname": "/docs/api/v1/linkedin/organizations/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/organizations/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/organizations/get.mdx", "sdkMethod": { "resource": "linkedin", "methodName": "getOrganizations", "signature": "client.linkedin.getOrganizations({ urls }) or client.linkedin.getOrganization({ url })", "clientCall": "client.linkedin.getOrganizations({ urls })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "array", "description": "LinkedIn organization page URL." } ], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "This endpoint covers company, school, and other LinkedIn organization pages. If you only need a standard company page lookup, the Company page endpoint may be a better fit." } }, { "method": "GET", "path": "/v1/linkedin/companies", "summary": "Get LinkedIn company page", "tag": "LinkedIn", "operationId": "linkedin.company.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/linkedin/companies/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/companies/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/companies/get.mdx", "sdkMethod": { "resource": "linkedin", "methodName": "getCompany", "signature": "client.linkedin.getCompany({ url })", "clientCall": "client.linkedin.getCompany({ url })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "LinkedIn company page URL for this lookup. School and organization-guest pages are not supported; use `GET /v1/linkedin/organizations`." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "This endpoint is for LinkedIn company pages only. If you have a school URL or another organization page type, use the Organization page endpoint instead." } }, { "method": "GET", "path": "/v1/linkedin/companies/posts", "summary": "List LinkedIn company posts", "tag": "LinkedIn", "operationId": "linkedin.company.posts.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/linkedin/companies/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/companies/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/companies/posts/get.mdx", "sdkMethod": { "resource": "linkedin", "methodName": "listCompanyPosts", "signature": "client.linkedin.listCompanyPosts({ url, page? })", "clientCall": "client.linkedin.listCompanyPosts({ url })" }, "parameterNames": [ "url", "page" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "LinkedIn company page URL or slug whose posts should be listed." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "This endpoint is for LinkedIn company pages only. If you have a school URL or another organization page type, use the Organization page endpoint instead." } }, { "method": "GET", "path": "/v1/linkedin/posts", "summary": "Get LinkedIn post or article", "tag": "LinkedIn", "operationId": "linkedin.post.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/linkedin/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/posts/get.mdx", "sdkMethod": { "resource": "linkedin", "methodName": "getPost", "signature": "client.linkedin.getPost({ url })", "clientCall": "client.linkedin.getPost({ url })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Public permalink to the post or article." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/linkedin/jobs", "summary": "Get LinkedIn jobs", "tag": "LinkedIn", "operationId": "linkedin.jobs.get", "requiresApiKey": true, "creditsNote": "2 credits per job URL requested. Up to 50 jobs per request (100 credits max).", "docsPathname": "/docs/api/v1/linkedin/jobs/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/jobs/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/jobs/get.mdx", "sdkMethod": { "resource": "linkedin", "methodName": "getJobs", "signature": "client.linkedin.getJobs({ urls })", "clientCall": "client.linkedin.getJobs({ urls })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "array", "description": "LinkedIn job posting URL to look up." } ], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/linkedin/jobs/search", "summary": "Search LinkedIn jobs", "tag": "LinkedIn", "operationId": "linkedin.jobs.search.list", "requiresApiKey": true, "creditsNote": "2 credits per returned record. Up to 1000 per request (2000 credits max). `limit` defaults to 10.", "docsPathname": "/docs/api/v1/linkedin/jobs/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/jobs/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/linkedin/jobs/search/get.mdx", "sdkMethod": { "resource": "linkedin", "methodName": "searchJobs", "signature": "client.linkedin.searchJobs({ keyword, location, country?, timeRange?, jobType?, experienceLevel?, remote?, company?, locationRadius? })", "clientCall": "client.linkedin.searchJobs({ keyword })" }, "parameterNames": [ "keyword", "location", "country", "timeRange", "jobType", "experienceLevel", "remote", "company", "locationRadius", "limit" ], "acceptedIdentifiers": [], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "This search usually takes around one and a half minutes." } }, { "method": "GET", "path": "/v1/youtube/channel", "summary": "Get YouTube channel", "tag": "YouTube", "operationId": "youtube.channel.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/channel/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/channel/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/channel/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "getChannel", "signature": "client.youtube.getChannel({ channelId?, handle?, url? })", "clientCall": "client.youtube.getChannel({ handle })" }, "parameterNames": [ "channelId", "handle", "url" ], "acceptedIdentifiers": [ { "name": "handle", "location": "query", "required": false, "type": "string", "description": "Optional YouTube channel handle for the request." }, { "name": "url", "location": "query", "required": false, "type": "string", "description": "Optional YouTube channel URL for the request." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/youtube/channels/videos", "summary": "List YouTube channel videos", "tag": "YouTube", "operationId": "youtube.channel.videos.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/channels/videos/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/channels/videos/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/channels/videos/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "getChannelVideos", "signature": "client.youtube.getChannelVideos({ channelId?, handle?, sortBy?, cursor?, includeExtras? })", "clientCall": "client.youtube.getChannelVideos({ handle })" }, "parameterNames": [ "channelId", "handle", "sortBy", "cursor", "includeExtras" ], "acceptedIdentifiers": [ { "name": "handle", "location": "query", "required": false, "type": "string", "description": "Optional YouTube channel handle for the request." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [ "latest", "popular" ], "orderingHint": "Supported sort options: latest, popular.", "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.videos` array can still mean `data.lookupStatus: \"found\"` when the channel resolves but the returned page has no videos.", "disambiguation": "Use `data.lookupStatus` to distinguish a resolved empty result from `not_found`." } }, { "method": "GET", "path": "/v1/youtube/channels/shorts", "summary": "List YouTube channel shorts", "tag": "YouTube", "operationId": "youtube.channel.shorts.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/channels/shorts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/channels/shorts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/channels/shorts/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "getChannelShorts", "signature": "client.youtube.getChannelShorts({ channelId?, handle?, sortBy?, cursor? })", "clientCall": "client.youtube.getChannelShorts({ handle })" }, "parameterNames": [ "channelId", "handle", "sortBy", "cursor" ], "acceptedIdentifiers": [ { "name": "handle", "location": "query", "required": false, "type": "string", "description": "Optional YouTube channel handle for the request." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [ "latest", "popular" ], "orderingHint": "Supported sort options: latest, popular.", "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.shorts` array can still mean `data.lookupStatus: \"found\"` when the channel resolves but the returned page has no Shorts.", "disambiguation": "Use `data.lookupStatus` to distinguish a resolved empty result from `not_found`." } }, { "method": "GET", "path": "/v1/youtube/playlists", "summary": "Get YouTube playlist", "tag": "YouTube", "operationId": "youtube.playlist.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/playlists/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/playlists/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/playlists/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "getPlaylist", "signature": "client.youtube.getPlaylist({ playlistId })", "clientCall": "client.youtube.getPlaylist({ playlistId: \"PLP32wGpgzmIlInfgKVFfCwVsxgGqZNIiS\" })" }, "parameterNames": [ "playlistId" ], "acceptedIdentifiers": [ { "name": "playlistId", "location": "query", "required": true, "type": "string", "description": "YouTube playlist id, or a YouTube playlist URL (the `list` query value is used when present)." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.videos` array with `data.lookupStatus: \"found\"` means the playlist resolved but returned no videos in the response.", "disambiguation": "Use `data.lookupStatus` to distinguish a resolved playlist from `not_found`." } }, { "method": "GET", "path": "/v1/youtube/community-posts", "summary": "Get YouTube community post", "tag": "YouTube", "operationId": "youtube.community.post.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/community-posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/community-posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/community-posts/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "getCommunityPost", "signature": "client.youtube.getCommunityPost({ url })", "clientCall": "client.youtube.getCommunityPost({ url: \"https://www.youtube.com/post/Ugkxvj2KoApYAXoqLWnKVr6zZe5JjeHrQeP8\" })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Public YouTube community post URL." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "Use `data.lookupStatus` to distinguish a resolved community post from `not_found`." } }, { "method": "GET", "path": "/v1/youtube/search", "summary": "Search YouTube", "tag": "YouTube", "operationId": "youtube.search.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/search/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "search", "signature": "client.youtube.search({ query, uploadDate?, sortBy?, type?, duration?, region?, cursor?, includeExtras? })", "clientCall": "client.youtube.search({ query: \"running\" })" }, "parameterNames": [ "query", "uploadDate", "sortBy", "type", "duration", "region", "cursor", "includeExtras" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [ "relevance", "popular" ], "orderingHint": "Supported sort options: relevance, popular.", "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "Use `data.page.hasMore` and `data.page.nextCursor` for pagination rather than inferring completion from bucket sizes alone." } }, { "method": "GET", "path": "/v1/youtube/search/hashtags", "summary": "Search YouTube by hashtag", "tag": "YouTube", "operationId": "youtube.search.hashtag.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/search/hashtags/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/search/hashtags/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/search/hashtags/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "searchHashtag", "signature": "client.youtube.searchHashtag({ hashtag, type?, cursor? })", "clientCall": "client.youtube.searchHashtag({ hashtag: \"funny\" })" }, "parameterNames": [ "hashtag", "type", "cursor" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "Use `data.page.hasMore` and `data.page.nextCursor` for pagination rather than inferring completion from result count alone." } }, { "method": "GET", "path": "/v1/youtube/shorts/trending", "summary": "List trending YouTube Shorts", "tag": "YouTube", "operationId": "youtube.shorts.trending.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/shorts/trending/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/shorts/trending/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/shorts/trending/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "getTrendingShorts", "signature": "client.youtube.getTrendingShorts()", "clientCall": "client.youtube.getTrendingShorts()" }, "parameterNames": [], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.shorts` array means no trending Shorts were available for that call (you normally receive about 48 when the feed is populated).", "disambiguation": "Typically returns about 48 trending Shorts per call. Repeat the same request for another fresh batch (new and overlapping Shorts are both possible). No cursor or page parameters." } }, { "method": "GET", "path": "/v1/youtube/videos", "summary": "Get YouTube video", "tag": "YouTube", "operationId": "youtube.video.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/videos/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/videos/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/videos/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "getVideo", "signature": "client.youtube.getVideo({ url, language? })", "clientCall": "client.youtube.getVideo({ url })" }, "parameterNames": [ "url", "language" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the YouTube video. Shorts URLs are also supported." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/youtube/videos/comments", "summary": "List YouTube video comments", "tag": "YouTube", "operationId": "youtube.video.comments.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/videos/comments/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/videos/comments/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/videos/comments/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "getVideoComments", "signature": "client.youtube.getVideoComments({ url, cursor?, order? })", "clientCall": "client.youtube.getVideoComments({ url, order: \"top\" })" }, "parameterNames": [ "url", "cursor", "order" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the YouTube video whose comments should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/youtube/videos/comments/replies", "summary": "List YouTube comment replies", "tag": "YouTube", "operationId": "youtube.video.comments.replies.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/videos/comments/replies/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/videos/comments/replies/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/videos/comments/replies/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "getVideoCommentReplies", "signature": "client.youtube.getVideoCommentReplies({ cursor })", "clientCall": "client.youtube.getVideoCommentReplies({ cursor: comment.repliesCursor })" }, "parameterNames": [ "cursor" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/youtube/videos/transcript", "summary": "Get YouTube video transcript", "tag": "YouTube", "operationId": "youtube.video.transcript.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/youtube/videos/transcript/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/videos/transcript/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/youtube/videos/transcript/get.mdx", "sdkMethod": { "resource": "youtube", "methodName": "getVideoTranscript", "signature": "client.youtube.getVideoTranscript({ url, language? })", "clientCall": "client.youtube.getVideoTranscript({ url })" }, "parameterNames": [ "url", "language" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the YouTube video whose transcript should be returned." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found", "lookup_failed" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/twitter/profiles/{handle}", "summary": "Get Twitter profile", "tag": "Twitter", "operationId": "twitter.profile.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/twitter/profiles/handle/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/profiles/handle/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/profiles/handle/get.mdx", "sdkMethod": { "resource": "twitter", "methodName": "getProfile", "signature": "client.twitter.getProfile({ handle })", "clientCall": "client.twitter.getProfile({ handle })" }, "parameterNames": [ "handle" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "X handle to look up, with or without a leading @." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "private", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/twitter/profiles/{handle}/tweets", "summary": "List Twitter profile tweets", "tag": "Twitter", "operationId": "twitter.profile.tweets.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/twitter/profiles/handle/tweets/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/profiles/handle/tweets/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/profiles/handle/tweets/get.mdx", "sdkMethod": { "resource": "twitter", "methodName": "getProfileTweets", "signature": "client.twitter.getProfileTweets({ handle, trim? })", "clientCall": "client.twitter.getProfileTweets({ handle, trim? })" }, "parameterNames": [ "handle", "trim" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "X handle to look up, with or without a leading @." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.tweets` array can occur with `lookupStatus: \"found\"` (no popular public tweets in this window) or `lookupStatus: \"not_found\"` (handle did not resolve).", "disambiguation": "Call `GET /v1/twitter/profiles/{handle}` when you must distinguish `private` from `not_found` before interpreting an empty tweet list." } }, { "method": "GET", "path": "/v1/twitter/tweets", "summary": "Get Twitter tweet", "tag": "Twitter", "operationId": "twitter.tweet.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/twitter/tweets/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/tweets/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/tweets/get.mdx", "sdkMethod": { "resource": "twitter", "methodName": "getTweet", "signature": "client.twitter.getTweet({ url, trim? })", "clientCall": "client.twitter.getTweet({ url })" }, "parameterNames": [ "url", "trim" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Tweet permalink or identifier." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/twitter/tweets/replies", "summary": "List Twitter tweet replies", "tag": "Twitter", "operationId": "twitter.tweet.replies.list", "requiresApiKey": true, "creditsNote": "2 credits per successful request.", "docsPathname": "/docs/api/v1/twitter/tweets/replies/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/tweets/replies/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/tweets/replies/get.mdx", "sdkMethod": { "resource": "twitter", "methodName": "listTweetReplies", "signature": "client.twitter.listTweetReplies({ url, cursor? })", "clientCall": "client.twitter.listTweetReplies({ url })" }, "parameterNames": [ "url", "cursor" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Tweet permalink or identifier." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/twitter/tweets/transcript", "summary": "Get Twitter tweet transcript", "tag": "Twitter", "operationId": "twitter.tweet.transcript.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/twitter/tweets/transcript/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/tweets/transcript/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/tweets/transcript/get.mdx", "sdkMethod": { "resource": "twitter", "methodName": "getTweetTranscript", "signature": "client.twitter.getTweetTranscript({ url })", "clientCall": "client.twitter.getTweetTranscript({ url })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Tweet permalink or identifier." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found", "lookup_failed" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "For video tweets only. Responses can take longer than typical lookups. Videos longer than about two minutes cannot be transcribed." } }, { "method": "GET", "path": "/v1/twitter/search", "summary": "Search Twitter posts", "tag": "Twitter", "operationId": "twitter.search.list", "requiresApiKey": true, "creditsNote": "2 credits per successful request.", "docsPathname": "/docs/api/v1/twitter/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/search/get.mdx", "sdkMethod": { "resource": "twitter", "methodName": "search", "signature": "client.twitter.search({ query, section?, minRetweets?, minLikes?, minReplies?, limit?, startDate?, endDate?, language?, cursor? })", "clientCall": "client.twitter.search({ query })" }, "parameterNames": [ "query", "section", "minRetweets", "minLikes", "minReplies", "limit", "startDate", "endDate", "language", "cursor" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/twitter/hashtags", "summary": "Search Twitter by hashtag", "tag": "Twitter", "operationId": "twitter.hashtag.list", "requiresApiKey": true, "creditsNote": "2 credits per successful request.", "docsPathname": "/docs/api/v1/twitter/hashtags/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/hashtags/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/hashtags/get.mdx", "sdkMethod": { "resource": "twitter", "methodName": "searchHashtags", "signature": "client.twitter.searchHashtags({ hashtag, section?, limit?, cursor? })", "clientCall": "client.twitter.searchHashtags({ hashtag: \"python\" })" }, "parameterNames": [ "hashtag", "section", "limit", "cursor" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/twitter/communities", "summary": "Get Twitter community", "tag": "Twitter", "operationId": "twitter.community.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/twitter/communities/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/communities/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/communities/get.mdx", "sdkMethod": { "resource": "twitter", "methodName": "getCommunity", "signature": "client.twitter.getCommunity({ url })", "clientCall": "client.twitter.getCommunity({ url })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Community URL to look up." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/twitter/communities/tweets", "summary": "List Twitter community tweets", "tag": "Twitter", "operationId": "twitter.community.tweets.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/twitter/communities/tweets/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/communities/tweets/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/twitter/communities/tweets/get.mdx", "sdkMethod": { "resource": "twitter", "methodName": "getCommunityTweets", "signature": "client.twitter.getCommunityTweets({ url })", "clientCall": "client.twitter.getCommunityTweets({ url })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Community URL to look up." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/whoami", "summary": "Whoami", "tag": "Auth", "operationId": "auth.whoami", "requiresApiKey": true, "docsPathname": "/docs/api/v1/whoami", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/whoami", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/whoami.mdx", "sdkMethod": { "resource": "auth", "methodName": "whoami", "signature": "client.auth.whoami()", "clientCall": "client.auth.whoami()" }, "parameterNames": [], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/balance", "summary": "Get account balance", "tag": "Auth", "operationId": "billing.balance.get", "requiresApiKey": true, "docsPathname": "/docs/api/v1/balance", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/balance", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/balance.mdx", "sdkMethod": { "resource": "billing", "methodName": "getBalance", "signature": "client.billing.getBalance()", "clientCall": "client.billing.getBalance()" }, "parameterNames": [], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/health", "summary": "Health check", "tag": "System", "operationId": "system.health", "requiresApiKey": false, "docsPathname": "/docs/api/health/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/health/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/health/get.mdx", "sdkMethod": { "resource": "client", "methodName": "health", "signature": "client.health()", "clientCall": "client.health()" }, "parameterNames": [], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/telegram/channels/{handle}", "summary": "Get Telegram channel", "tag": "Telegram", "operationId": "telegram.channel.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/telegram/channels/handle/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/telegram/channels/handle/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/telegram/channels/handle/get.mdx", "sdkMethod": { "resource": "telegram", "methodName": "getChannel", "signature": "client.telegram.getChannel({ handle: \"durov\" })", "clientCall": "client.telegram.getChannel({ handle: \"durov\" })" }, "parameterNames": [ "handle" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "Telegram public username (channel or group), with or without leading @." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found", "restricted" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/telegram/channels/{handle}/posts", "summary": "List Telegram channel posts", "tag": "Telegram", "operationId": "telegram.channel_posts.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/telegram/channels/handle/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/telegram/channels/handle/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/telegram/channels/handle/posts/get.mdx", "sdkMethod": { "resource": "telegram", "methodName": "getChannelPosts", "signature": "client.telegram.getChannelPosts({ handle: \"durov\", cursor? })", "clientCall": "client.telegram.getChannelPosts({ handle: \"durov\" })" }, "parameterNames": [ "handle", "cursor" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "Telegram public username (channel or group), with or without leading @." } ], "pagination": { "style": "cursor", "parameter": "cursor" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found", "restricted" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/telegram/channels/{handle}/posts/{postId}", "summary": "Get Telegram channel post", "tag": "Telegram", "operationId": "telegram.channel_post.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/telegram/channels/handle/posts/postid/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/telegram/channels/handle/posts/postid/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/telegram/channels/handle/posts/postid/get.mdx", "sdkMethod": { "resource": "telegram", "methodName": "getChannelPost", "signature": "client.telegram.getChannelPost({ handle: \"Premiumoji\", postId: \"93\" })", "clientCall": "client.telegram.getChannelPost({ handle: \"Premiumoji\", postId: \"93\" })" }, "parameterNames": [ "handle", "postId" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "Telegram public username (channel or group), with or without leading @." }, { "name": "postId", "location": "path", "required": true, "type": "string", "description": "Numeric Telegram channel post ID from the public URL." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found", "restricted" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/threads/profiles/{handle}", "summary": "Get Threads profile", "tag": "Threads", "operationId": "threads.profile.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/threads/profiles/handle/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/threads/profiles/handle/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/threads/profiles/handle/get.mdx", "sdkMethod": { "resource": "threads", "methodName": "getProfile", "signature": "client.threads.getProfile({ handle })", "clientCall": "client.threads.getProfile({ handle })" }, "parameterNames": [ "handle" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "Threads handle to look up, with or without a leading @." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "private", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/threads/profiles/{handle}/posts", "summary": "List Threads profile posts", "tag": "Threads", "operationId": "threads.profile.posts.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/threads/profiles/handle/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/threads/profiles/handle/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/threads/profiles/handle/posts/get.mdx", "sdkMethod": { "resource": "threads", "methodName": "getProfilePosts", "signature": "client.threads.getProfilePosts({ handle, trim? })", "clientCall": "client.threads.getProfilePosts({ handle, trim? })" }, "parameterNames": [ "handle", "trim" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "Threads handle whose posts should be listed." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.posts` array can occur with `lookupStatus: \"found\"` (no posts in this response) or `lookupStatus: \"not_found\"` (handle did not resolve).", "disambiguation": "Call `GET /v1/threads/profiles/{handle}` when you must distinguish `private` from `not_found` before interpreting an empty post list." } }, { "method": "GET", "path": "/v1/threads/search", "summary": "Search Threads posts", "tag": "Threads", "operationId": "threads.search.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/threads/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/threads/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/threads/search/get.mdx", "sdkMethod": { "resource": "threads", "methodName": "search", "signature": "client.threads.search({ query, startDate?, endDate?, trim? })", "clientCall": "client.threads.search({ query })" }, "parameterNames": [ "query", "startDate", "endDate", "trim" ], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/threads/posts", "summary": "Get Threads post", "tag": "Threads", "operationId": "threads.post.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/threads/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/threads/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/threads/posts/get.mdx", "sdkMethod": { "resource": "threads", "methodName": "getPost", "signature": "client.threads.getPost({ url, trim? })", "clientCall": "client.threads.getPost({ url })" }, "parameterNames": [ "url", "trim" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the Threads post." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/threads/users/search", "summary": "Search Threads users", "tag": "Threads", "operationId": "threads.users.search", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/threads/users/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/threads/users/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/threads/users/search/get.mdx", "sdkMethod": { "resource": "threads", "methodName": "searchUsers", "signature": "client.threads.searchUsers({ query })", "clientCall": "client.threads.searchUsers({ query })" }, "parameterNames": [ "query" ], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/reddit/subreddits", "summary": "Get Reddit subreddit", "tag": "Reddit", "operationId": "reddit.subreddit.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/reddit/subreddits/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/reddit/subreddits/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/reddit/subreddits/get.mdx", "sdkMethod": { "resource": "reddit", "methodName": "getSubreddit", "signature": "client.reddit.getSubreddit({ subreddit } | { url }) — subreddit names are case-sensitive", "clientCall": "client.reddit.getSubreddit({ subreddit: \"AbsoluteUnits\" })" }, "parameterNames": [ "subreddit", "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": false, "type": "string", "description": "Optional subreddit URL for the request." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/reddit/search", "summary": "Search Reddit posts", "tag": "Reddit", "operationId": "reddit.search.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/reddit/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/reddit/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/reddit/search/get.mdx", "sdkMethod": { "resource": "reddit", "methodName": "search", "signature": "client.reddit.search({ query, sortBy?, timeframe?, cursor?, trim? })", "clientCall": "client.reddit.search({ query: \"webscraping\" })" }, "parameterNames": [ "query", "sortBy", "timeframe", "cursor", "trim" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [ "relevance", "new", "top" ], "orderingHint": "Supported sort options: relevance, new, top.", "supportsTrim": true, "supportsMediaDownload": false, "agentHints": { "disambiguation": "Use `data.page.hasMore` and `data.page.nextCursor` for pagination rather than inferring completion from `data.totalResults` alone." } }, { "method": "GET", "path": "/v1/rumble/search", "summary": "Search Rumble", "tag": "Rumble", "operationId": "rumble.search.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/rumble/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/rumble/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/rumble/search/get.mdx", "sdkMethod": { "resource": "rumble", "methodName": "search", "signature": "client.rumble.search({ query, cursor? })", "clientCall": "client.rumble.search({ query: \"breaking news\" })" }, "parameterNames": [ "query", "cursor" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "Use `data.page.hasMore` and `data.page.nextCursor` for pagination rather than inferring completion from `data.totalResults` alone." } }, { "method": "GET", "path": "/v1/rumble/channels/videos", "summary": "List Rumble channel videos", "tag": "Rumble", "operationId": "rumble.channel.videos.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/rumble/channels/videos/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/rumble/channels/videos/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/rumble/channels/videos/get.mdx", "sdkMethod": { "resource": "rumble", "methodName": "listChannelVideos", "signature": "client.rumble.listChannelVideos({ url, cursor? })", "clientCall": "client.rumble.listChannelVideos({ url: \"https://rumble.com/c/StevenCrowder\" })" }, "parameterNames": [ "url", "cursor" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the Rumble channel." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/rumble/videos", "summary": "Get Rumble video", "tag": "Rumble", "operationId": "rumble.video.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/rumble/videos/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/rumble/videos/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/rumble/videos/get.mdx", "sdkMethod": { "resource": "rumble", "methodName": "getVideo", "signature": "client.rumble.getVideo({ url })", "clientCall": "client.rumble.getVideo({ url: \"https://rumble.com/v79xhhm-discovery-why-glenn-wants-israel-to-sue-the-new-york-times.html\" })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the Rumble video." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/rumble/videos/transcript", "summary": "Get Rumble video transcript", "tag": "Rumble", "operationId": "rumble.video.transcript.get", "requiresApiKey": true, "creditsNote": "1 credit when a transcript is found; no charge when captions are unavailable.", "docsPathname": "/docs/api/v1/rumble/videos/transcript/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/rumble/videos/transcript/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/rumble/videos/transcript/get.mdx", "sdkMethod": { "resource": "rumble", "methodName": "getVideoTranscript", "signature": "client.rumble.getVideoTranscript({ url })", "clientCall": "client.rumble.getVideoTranscript({ url: \"https://rumble.com/v79xhhm-discovery-why-glenn-wants-israel-to-sue-the-new-york-times.html\" })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the Rumble video." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found", "lookup_failed" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/rumble/videos/comments", "summary": "List Rumble video comments", "tag": "Rumble", "operationId": "rumble.video.comments.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/rumble/videos/comments/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/rumble/videos/comments/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/rumble/videos/comments/get.mdx", "sdkMethod": { "resource": "rumble", "methodName": "listVideoComments", "signature": "client.rumble.listVideoComments({ url })", "clientCall": "client.rumble.listVideoComments({ url: \"https://rumble.com/v792vns-the-splc-is-a-deceitful-and-poisonous-group.-but-was-their-behavior-crimina.html\" })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the Rumble video." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/reddit/subreddits/{subreddit}/posts", "summary": "List Reddit subreddit posts", "tag": "Reddit", "operationId": "reddit.subreddit.posts.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/reddit/subreddits/subreddit/posts/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/reddit/subreddits/subreddit/posts/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/reddit/subreddits/subreddit/posts/get.mdx", "sdkMethod": { "resource": "reddit", "methodName": "listSubredditPosts", "signature": "client.reddit.listSubredditPosts({ subreddit, sort?, timeframe?, cursor? }) — subreddit is case-sensitive", "clientCall": "client.reddit.listSubredditPosts({ subreddit: \"AskReddit\", sort: \"hot\" })" }, "parameterNames": [ "subreddit", "sort", "timeframe", "cursor" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/reddit/subreddits/search", "summary": "Search Reddit subreddit", "tag": "Reddit", "operationId": "reddit.subreddit.search.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/reddit/subreddits/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/reddit/subreddits/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/reddit/subreddits/search/get.mdx", "sdkMethod": { "resource": "reddit", "methodName": "searchSubreddit", "signature": "client.reddit.searchSubreddit({ subreddit, query?, sort?, timeframe?, cursor? }) — subreddit is case-sensitive", "clientCall": "client.reddit.searchSubreddit({ subreddit: \"Fitness\", query: \"push ups\" })" }, "parameterNames": [ "subreddit", "query", "sort", "timeframe", "cursor" ], "acceptedIdentifiers": [], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "Use `data.page.hasMore` and `data.page.nextCursor` for pagination rather than inferring completion from `data.totalResults` alone." } }, { "method": "GET", "path": "/v1/reddit/posts/comments", "summary": "List Reddit post comments", "tag": "Reddit", "operationId": "reddit.post.comments.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/reddit/posts/comments/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/reddit/posts/comments/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/reddit/posts/comments/get.mdx", "sdkMethod": { "resource": "reddit", "methodName": "listPostComments", "signature": "client.reddit.listPostComments({ url, cursor?, trim? })", "clientCall": "client.reddit.listPostComments({ url: \"https://www.reddit.com/r/gadgets/comments/1tgimff/example/\" })" }, "parameterNames": [ "url", "cursor", "trim" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Link to the Reddit post whose comments should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": true, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/github/profiles/{handle}", "summary": "Get GitHub profile", "tag": "GitHub", "operationId": "github.profile.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/github/profiles/handle/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/get.mdx", "sdkMethod": { "resource": "github", "methodName": "getProfile", "signature": "client.github.getProfile({ handle })", "clientCall": "client.github.getProfile({ handle })" }, "parameterNames": [ "handle" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "GitHub username to look up, with or without a leading @." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/github/profiles/{handle}/repositories", "summary": "List GitHub profile repositories", "tag": "GitHub", "operationId": "github.profile.repositories.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/github/profiles/handle/repositories/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/repositories/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/repositories/get.mdx", "sdkMethod": { "resource": "github", "methodName": "listProfileRepositories", "signature": "client.github.listProfileRepositories({ handle, cursor?, type?, sort?, direction? })", "clientCall": "client.github.listProfileRepositories({ handle: 'torvalds' })" }, "parameterNames": [ "handle", "cursor", "type", "sort", "direction" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "GitHub username whose public repositories should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.repositories` array with `lookupStatus: \"found\"` means the profile resolved but this page returned no repositories." } }, { "method": "GET", "path": "/v1/github/repositories", "summary": "Get GitHub repository", "tag": "GitHub", "operationId": "github.repositories.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/github/repositories/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/github/repositories/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/github/repositories/get.mdx", "sdkMethod": { "resource": "github", "methodName": "getRepository", "signature": "client.github.getRepository({ url })", "clientCall": "client.github.getRepository({ url: 'https://github.com/torvalds/linux' })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Full public GitHub repository URL." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "Use this endpoint for one repository when you have a full `owner/repo` URL. To list every public repository for a user, use the profile repositories list endpoint instead." } }, { "method": "GET", "path": "/v1/github/profiles/{handle}/activity", "summary": "List GitHub profile activity", "tag": "GitHub", "operationId": "github.profile.activity.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/github/profiles/handle/activity/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/activity/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/activity/get.mdx", "sdkMethod": { "resource": "github", "methodName": "listProfileActivity", "signature": "client.github.listProfileActivity({ handle, year?, cursor? })", "clientCall": "client.github.listProfileActivity({ handle: 'torvalds' })" }, "parameterNames": [ "handle", "year", "cursor" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "GitHub username whose public activity timeline should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "This endpoint returns one month of public contribution activity per request. Keep the same `year` on follow-up calls and pass `data.page.nextCursor` as `cursor` to page backward through the year." } }, { "method": "GET", "path": "/v1/github/profiles/{handle}/followers", "summary": "List GitHub profile followers", "tag": "GitHub", "operationId": "github.profile.followers.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/github/profiles/handle/followers/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/followers/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/followers/get.mdx", "sdkMethod": { "resource": "github", "methodName": "listProfileFollowers", "signature": "client.github.listProfileFollowers({ handle, cursor? })", "clientCall": "client.github.listProfileFollowers({ handle: 'torvalds' })" }, "parameterNames": [ "handle", "cursor" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "GitHub username whose followers should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.followers` array with `lookupStatus: \"found\"` means the profile resolved but this page returned no followers.", "disambiguation": "Use `lookupStatus` to distinguish found and not_found. Call `GET /v1/github/profiles/{handle}` when you need full profile details." } }, { "method": "GET", "path": "/v1/github/profiles/{handle}/following", "summary": "List GitHub profile following", "tag": "GitHub", "operationId": "github.profile.following.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/github/profiles/handle/following/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/following/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/following/get.mdx", "sdkMethod": { "resource": "github", "methodName": "listProfileFollowing", "signature": "client.github.listProfileFollowing({ handle, cursor? })", "clientCall": "client.github.listProfileFollowing({ handle: 'torvalds' })" }, "parameterNames": [ "handle", "cursor" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "GitHub username whose following list should be listed." } ], "pagination": { "style": "cursor", "parameter": "cursor", "nextCursorPath": "data.page.nextCursor", "hasMorePath": "data.page.hasMore" }, "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.following` array with `lookupStatus: \"found\"` means the profile resolved but this page returned no accounts (for example the profile follows nobody).", "disambiguation": "Use `lookupStatus` to distinguish found and not_found. Call `GET /v1/github/profiles/{handle}` when you need full profile details." } }, { "method": "GET", "path": "/v1/github/profiles/{handle}/contributions", "summary": "Get GitHub contribution graph", "tag": "GitHub", "operationId": "github.profile.contributions.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/github/profiles/handle/contributions/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/contributions/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/github/profiles/handle/contributions/get.mdx", "sdkMethod": { "resource": "github", "methodName": "getProfileContributions", "signature": "client.github.getProfileContributions({ handle, year? })", "clientCall": "client.github.getProfileContributions({ handle: 'torvalds' })" }, "parameterNames": [ "handle", "year" ], "acceptedIdentifiers": [ { "name": "handle", "location": "path", "required": true, "type": "string", "description": "GitHub username to look up, with or without a leading @." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "disambiguation": "Optional `year` defaults to the current calendar year when omitted. Contribution counts reflect public GitHub activity for that year." } }, { "method": "GET", "path": "/v1/github/trending/repositories", "summary": "List trending GitHub repositories", "tag": "GitHub", "operationId": "github.trending.repositories.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/github/trending/repositories/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/github/trending/repositories/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/github/trending/repositories/get.mdx", "sdkMethod": { "resource": "github", "methodName": "listTrendingRepositories", "signature": "client.github.listTrendingRepositories({ language?, since?, spokenLanguageCode? })", "clientCall": "client.github.listTrendingRepositories({ language: 'javascript', since: 'daily' })" }, "parameterNames": [ "language", "since", "spokenLanguageCode" ], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.repositories` array means GitHub returned no trending repositories for the selected filters.", "disambiguation": "Use `since` (`daily`, `weekly`, `monthly`) and optional `language` / `spokenLanguageCode` to narrow results. For trending developers instead of repositories, use the trending developers endpoint." } }, { "method": "GET", "path": "/v1/github/trending/developers", "summary": "List trending GitHub developers", "tag": "GitHub", "operationId": "github.trending.developers.list", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/github/trending/developers/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/github/trending/developers/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/github/trending/developers/get.mdx", "sdkMethod": { "resource": "github", "methodName": "listTrendingDevelopers", "signature": "client.github.listTrendingDevelopers({ language?, since? })", "clientCall": "client.github.listTrendingDevelopers({ language: 'javascript', since: 'daily' })" }, "parameterNames": [ "language", "since" ], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false, "agentHints": { "emptyResults": "An empty `data.developers` array means GitHub returned no trending developers for the selected filters.", "disambiguation": "Use `since` (`daily`, `weekly`, `monthly`) and optional `language` to narrow results. Each developer may include `popularRepository` when GitHub highlights one. For trending repositories instead of developers, use the trending repositories endpoint." } }, { "method": "GET", "path": "/v1/spotify/artist", "summary": "Get Spotify artist", "tag": "Spotify", "operationId": "spotify.artist.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/spotify/artist/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/spotify/artist/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/spotify/artist/get.mdx", "sdkMethod": { "resource": "spotify", "methodName": "getArtist", "signature": "client.spotify.getArtist({ artistId?, url? })", "clientCall": "client.spotify.getArtist({ artistId: \"1uNFoZAHBGtllmzznpCI3s\" })" }, "parameterNames": [ "artistId", "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": false, "type": "string", "description": "Optional Spotify artist URL for the request." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/spotify/album", "summary": "Get Spotify album", "tag": "Spotify", "operationId": "spotify.album.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/spotify/album/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/spotify/album/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/spotify/album/get.mdx", "sdkMethod": { "resource": "spotify", "methodName": "getAlbum", "signature": "client.spotify.getAlbum({ albumId?, url? })", "clientCall": "client.spotify.getAlbum({ albumId: \"0pgrg7phBbnwGJ2HBEl9EG\" })" }, "parameterNames": [ "albumId", "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": false, "type": "string", "description": "Optional Spotify album URL for the request." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/spotify/track", "summary": "Get Spotify track", "tag": "Spotify", "operationId": "spotify.track.get", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/spotify/track/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/spotify/track/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/spotify/track/get.mdx", "sdkMethod": { "resource": "spotify", "methodName": "getTrack", "signature": "client.spotify.getTrack({ trackId?, url? })", "clientCall": "client.spotify.getTrack({ trackId: \"1ITJflybJsfarsUtiBvkfK\" })" }, "parameterNames": [ "trackId", "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": false, "type": "string", "description": "Optional Spotify track URL for the request." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "not_found" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/web/search", "summary": "Search the web", "tag": "Web", "operationId": "web.search.run", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/web/search/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/web/search/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/web/search/get.mdx", "sdkMethod": { "resource": "web", "methodName": "search", "signature": "client.web.search({ query: \"Social media scraping API\", region: \"US\" })", "clientCall": "client.web.search({ query: \"Social media scraping API\", region: \"US\" })" }, "parameterNames": [ "query", "region", "datePosted", "page" ], "acceptedIdentifiers": [], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/web/markdown", "summary": "Generate web page markdown", "tag": "Web", "operationId": "web.markdown.generate", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/web/markdown/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/web/markdown/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/web/markdown/get.mdx", "sdkMethod": { "resource": "web", "methodName": "getMarkdown", "signature": "client.web.getMarkdown({ url: \"https://www.socialfetch.dev/\" })", "clientCall": "client.web.getMarkdown({ url: \"https://www.socialfetch.dev/\" })" }, "parameterNames": [ "url", "filter", "query", "cacheMode" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Web page URL to fetch." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "restricted" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/web/ask", "summary": "Ask a question about a web page", "tag": "Web", "operationId": "web.ask.run", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/web/ask/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/web/ask/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/web/ask/get.mdx", "sdkMethod": { "resource": "web", "methodName": "ask", "signature": "client.web.ask({ url: \"https://www.socialfetch.dev/\", q: \"What is this page about?\" })", "clientCall": "client.web.ask({ url: \"https://www.socialfetch.dev/\", q: \"What is this page about?\" })" }, "parameterNames": [ "url", "q" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Web page URL to fetch." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "restricted" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/web/html", "summary": "Generate web page HTML", "tag": "Web", "operationId": "web.html.generate", "requiresApiKey": true, "creditsNote": "1 credit per successful request.", "docsPathname": "/docs/api/v1/web/html/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/web/html/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/web/html/get.mdx", "sdkMethod": { "resource": "web", "methodName": "getHtml", "signature": "client.web.getHtml({ url: \"https://www.socialfetch.dev/\" })", "clientCall": "client.web.getHtml({ url: \"https://www.socialfetch.dev/\" })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "string", "description": "Web page URL to fetch." } ], "outcome": { "fieldPath": "data.lookupStatus", "values": [ "found", "restricted" ] }, "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false }, { "method": "GET", "path": "/v1/web/crawl", "summary": "Crawl web pages", "tag": "Web", "operationId": "web.crawl.run", "requiresApiKey": true, "creditsNote": "1 credit per URL requested. Up to 5 URLs per request (5 credits max).", "docsPathname": "/docs/api/v1/web/crawl/get", "docsHtmlUrl": "https://www.socialfetch.dev/docs/api/v1/web/crawl/get", "docsMarkdownUrl": "https://www.socialfetch.dev/docs/api/v1/web/crawl/get.mdx", "sdkMethod": { "resource": "web", "methodName": "crawl", "signature": "client.web.crawl({ urls: [\"https://www.socialfetch.dev/\"] })", "clientCall": "client.web.crawl({ urls: [\"https://www.socialfetch.dev/\"] })" }, "parameterNames": [ "url" ], "acceptedIdentifiers": [ { "name": "url", "location": "query", "required": true, "type": "array", "description": "URLs to crawl. Repeat the `url` query parameter for multiple pages (max 5)." } ], "sortByValues": [], "supportsTrim": false, "supportsMediaDownload": false } ] }